Orfeo Toolbox  3.16
Public Types | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::LineCell< TCellInterface > Class Template Reference

#include <itkLineCell.h>

+ Inheritance diagram for itk::LineCell< TCellInterface >:
+ Collaboration diagram for itk::LineCell< TCellInterface >:

Public Types

enum  {
  NumberOfPoints = 2,
  NumberOfVertices = 2,
  CellDimension = 1
}
 
typedef VertexType::SelfAutoPointer VertexAutoPointer
 
typedef VertexCell
< TCellInterface > 
VertexType
 

Public Member Functions

 LineCell ()
 
 ~LineCell ()
 
virtual bool GetBoundaryFeature (int dimension, CellFeatureIdentifier, CellAutoPointer &)
 
virtual unsigned int GetDimension (void) const
 
virtual const char * GetNameOfClass () const
 
virtual CellFeatureCount GetNumberOfBoundaryFeatures (int dimension) const
 
virtual unsigned int GetNumberOfPoints (void) const
 
virtual CellFeatureCount GetNumberOfVertices (void) const
 
virtual CellGeometry GetType (void) const
 
virtual bool GetVertex (CellFeatureIdentifier, VertexAutoPointer &)
 
 itkCellCommonTypedefs (LineCell)
 
 itkCellInheritedTypedefs (TCellInterface)
 
 itkCellVisitMacro (Superclass::LINE_CELL)
 
virtual void MakeCopy (CellAutoPointer &) const
 
virtual PointIdIterator PointIdsBegin (void)
 
virtual PointIdConstIterator PointIdsBegin (void) const
 
virtual PointIdIterator PointIdsEnd (void)
 
virtual PointIdConstIterator PointIdsEnd (void) const
 
virtual void SetPointId (int localId, PointIdentifier)
 
virtual void SetPointIds (PointIdConstIterator first)
 
virtual void SetPointIds (PointIdConstIterator first, PointIdConstIterator last)
 

Protected Attributes

PointIdentifier m_PointIds [NumberOfPoints]
 

Private Member Functions

 LineCell (const Self &)
 
void operator= (const Self &)
 

Detailed Description

template<typename TCellInterface>
class itk::LineCell< TCellInterface >

LineCell represents a line segment for a Mesh.

Template parameters for LineCell:

TPixelType = The type associated with a point, cell, or boundary for use in storing its data.

TCellTraits = Type information of mesh containing cell.

Definition at line 42 of file itkLineCell.h.

Member Typedef Documentation

template<typename TCellInterface >
typedef VertexType::SelfAutoPointer itk::LineCell< TCellInterface >::VertexAutoPointer

Definition at line 54 of file itkLineCell.h.

template<typename TCellInterface >
typedef VertexCell< TCellInterface > itk::LineCell< TCellInterface >::VertexType

The type of boundary for this lines's vertices.

Definition at line 50 of file itkLineCell.h.

Member Enumeration Documentation

template<typename TCellInterface >
anonymous enum

Line-specific topology numbers.

Enumerator
NumberOfPoints 
NumberOfVertices 
CellDimension 

Definition at line 57 of file itkLineCell.h.

Constructor & Destructor Documentation

template<typename TCellInterface >
itk::LineCell< TCellInterface >::LineCell ( )
inline

Definition at line 85 of file itkLineCell.h.

template<typename TCellInterface >
itk::LineCell< TCellInterface >::~LineCell ( )
inline

Definition at line 92 of file itkLineCell.h.

template<typename TCellInterface >
itk::LineCell< TCellInterface >::LineCell ( const Self &  )
private

Member Function Documentation

template<typename TCellInterface >
bool itk::LineCell< TCellInterface >::GetBoundaryFeature ( int  dimension,
CellFeatureIdentifier  featureId,
CellAutoPointer &  cellPointer 
)
virtual

Standard CellInterface: Get the boundary feature of the given dimension specified by the given cell feature Id. The Id can range from 0 to GetNumberOfBoundaryFeatures(dimension)-1.

Definition at line 89 of file itkLineCell.txx.

References itk::TransferAutoPointer().

template<typename TCellInterface >
unsigned int itk::LineCell< TCellInterface >::GetDimension ( void  ) const
virtual

Standard CellInterface: Get the topological dimension of this cell.

Definition at line 45 of file itkLineCell.txx.

template<typename TCellInterface >
virtual const char* itk::LineCell< TCellInterface >::GetNameOfClass ( ) const
virtual

Standard part of every itk Object.

template<typename TCellInterface >
LineCell< TCellInterface >::CellFeatureCount itk::LineCell< TCellInterface >::GetNumberOfBoundaryFeatures ( int  dimension) const
virtual

Standard CellInterface: Get the number of boundary entities of the given dimension.

Definition at line 70 of file itkLineCell.txx.

template<typename TCellInterface >
unsigned int itk::LineCell< TCellInterface >::GetNumberOfPoints ( void  ) const
virtual

Standard CellInterface: Get the number of points required to define the cell.

Definition at line 57 of file itkLineCell.txx.

template<typename TCellInterface >
LineCell< TCellInterface >::CellFeatureCount itk::LineCell< TCellInterface >::GetNumberOfVertices ( void  ) const
virtual

Line-specific interface.

Line-specific: Get the number of vertices for this line.

Definition at line 234 of file itkLineCell.txx.

template<typename TCellInterface >
virtual CellGeometry itk::LineCell< TCellInterface >::GetType ( void  ) const
inlinevirtual

Implement the standard CellInterface.

Definition at line 62 of file itkLineCell.h.

template<typename TCellInterface >
bool itk::LineCell< TCellInterface >::GetVertex ( CellFeatureIdentifier  vertexId,
VertexAutoPointer vertexPointer 
)
virtual

Line-specific: Get the vertex specified by the given cell feature Id. The Id can range from 0 to GetNumberOfVertices()-1.

Definition at line 248 of file itkLineCell.txx.

References itk::VertexCell< TCellInterface >::SetPointId().

template<typename TCellInterface >
itk::LineCell< TCellInterface >::itkCellCommonTypedefs ( LineCell< TCellInterface >  )

Standard class typedefs.

template<typename TCellInterface >
itk::LineCell< TCellInterface >::itkCellInheritedTypedefs ( TCellInterface  )
template<typename TCellInterface >
itk::LineCell< TCellInterface >::itkCellVisitMacro ( Superclass::LINE_CELL  )

Visitor interface

template<typename TCellInterface >
void itk::LineCell< TCellInterface >::MakeCopy ( CellAutoPointer &  cellPointer) const
virtual

Standard CellInterface:

Definition at line 30 of file itkLineCell.txx.

template<typename TCellInterface >
void itk::LineCell< TCellInterface >::operator= ( const Self &  )
private
template<typename TCellInterface >
LineCell< TCellInterface >::PointIdIterator itk::LineCell< TCellInterface >::PointIdsBegin ( void  )
virtual

Standard CellInterface: Get a begin iterator to the list of point identifiers used by the cell.

Definition at line 180 of file itkLineCell.txx.

template<typename TCellInterface >
LineCell< TCellInterface >::PointIdConstIterator itk::LineCell< TCellInterface >::PointIdsBegin ( void  ) const
virtual

Standard CellInterface: Get a const begin iterator to the list of point identifiers used by the cell.

Definition at line 194 of file itkLineCell.txx.

template<typename TCellInterface >
LineCell< TCellInterface >::PointIdIterator itk::LineCell< TCellInterface >::PointIdsEnd ( void  )
virtual

Standard CellInterface: Get an end iterator to the list of point identifiers used by the cell.

Definition at line 207 of file itkLineCell.txx.

template<typename TCellInterface >
LineCell< TCellInterface >::PointIdConstIterator itk::LineCell< TCellInterface >::PointIdsEnd ( void  ) const
virtual

Standard CellInterface: Get a const end iterator to the list of point identifiers used by the cell.

Definition at line 221 of file itkLineCell.txx.

template<typename TCellInterface >
void itk::LineCell< TCellInterface >::SetPointId ( int  localId,
PointIdentifier  ptId 
)
virtual
template<typename TCellInterface >
void itk::LineCell< TCellInterface >::SetPointIds ( PointIdConstIterator  first)
virtual

Standard CellInterface: Set the point id list used by the cell. It is assumed that the given iterator can be incremented and safely de-referenced enough times to get all the point ids needed by the cell.

Definition at line 128 of file itkLineCell.txx.

template<typename TCellInterface >
void itk::LineCell< TCellInterface >::SetPointIds ( PointIdConstIterator  first,
PointIdConstIterator  last 
)
virtual

Standard CellInterface: Set the point id list used by the cell. It is assumed that the range of iterators [first, last) contains the correct number of points needed to define the cell. The position *last is NOT referenced, so it can safely be one beyond the end of an array or other container.

Definition at line 148 of file itkLineCell.txx.

Member Data Documentation

template<typename TCellInterface >
PointIdentifier itk::LineCell< TCellInterface >::m_PointIds[NumberOfPoints]
protected

Store number of points needed for a line segment.

Definition at line 96 of file itkLineCell.h.


The documentation for this class was generated from the following files:

Generated at Sun May 19 2013 02:06:00 for Orfeo Toolbox with doxygen 1.8.3.1