ITK  5.4.0
Insight Toolkit
Public Member Functions | Static Public Attributes | Protected Attributes | List of all members
itk::VertexCell< TCellInterface > Class Template Reference

#include <itkVertexCell.h>

Detailed Description

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

Represents a single vertex for a Mesh.

Template Parameters
TPixelTypeThe type associated with a point, cell, or boundary for use in storing its data.
TCellTraitsType information of mesh containing cell.
Examples
Examples/DataRepresentation/Mesh/MeshCellsIteration.cxx, Examples/DataRepresentation/Mesh/MeshCellVisitor.cxx, Examples/DataRepresentation/Mesh/MeshCellVisitor2.cxx, Examples/DataRepresentation/Mesh/MeshKComplex.cxx, and Examples/DataRepresentation/Mesh/MeshPolyLine.cxx.

Definition at line 42 of file itkVertexCell.h.

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

Public Member Functions

bool EvaluatePosition (CoordRepType *, PointsContainer *, CoordRepType *, CoordRepType[], double *, InterpolationWeightType *) override
 
bool GetBoundaryFeature (int dimension, CellFeatureIdentifier, CellAutoPointer &) override
 
unsigned int GetDimension () const override
 
const char * GetNameOfClass () const override
 
CellFeatureCount GetNumberOfBoundaryFeatures (int dimension) const override
 
unsigned int GetNumberOfPoints () const override
 
virtual PointIdentifier GetPointId ()
 
 itkCellVisitMacro (CellGeometryEnum::VERTEX_CELL)
 
PointIdConstIterator PointIdsBegin () const override
 
PointIdIterator PointIdsBegin () override
 
PointIdConstIterator PointIdsEnd () const override
 
PointIdIterator PointIdsEnd () override
 
void SetPointId (int localId, PointIdentifier) override
 
virtual void SetPointId (PointIdentifier)
 
void SetPointIds (PointIdConstIterator first) override
 
void SetPointIds (PointIdConstIterator first, PointIdConstIterator last) override
 
 VertexCell ()=default
 
 ~VertexCell () override=default
 
 itkCellCommonTypedefs (VertexCell)
 
 itkCellInheritedTypedefs (TCellInterface)
 
CellGeometryEnum GetType () const override
 
void MakeCopy (CellAutoPointer &) const override
 

Static Public Attributes

static constexpr unsigned int CellDimension = 0
 
static constexpr unsigned int NumberOfPoints = 1
 

Protected Attributes

std::array< PointIdentifier, NumberOfPointsm_PointIds
 

Constructor & Destructor Documentation

◆ VertexCell()

template<typename TCellInterface >
itk::VertexCell< TCellInterface >::VertexCell ( )
default

◆ ~VertexCell()

template<typename TCellInterface >
itk::VertexCell< TCellInterface >::~VertexCell ( )
overridedefault

Member Function Documentation

◆ EvaluatePosition()

template<typename TCellInterface >
bool itk::VertexCell< TCellInterface >::EvaluatePosition ( CoordRepType *  ,
PointsContainer *  ,
CoordRepType *  ,
CoordRepType  [],
double *  ,
InterpolationWeightType *   
)
override

Evaluate the position of a given point

◆ GetBoundaryFeature()

template<typename TCellInterface >
bool itk::VertexCell< TCellInterface >::GetBoundaryFeature ( int  dimension,
CellFeatureIdentifier  ,
CellAutoPointer &   
)
override

A vertex has no boundary entities. Just return null.

◆ GetDimension()

template<typename TCellInterface >
unsigned int itk::VertexCell< TCellInterface >::GetDimension ( ) const
override

Get the topological dimension of this cell.

◆ GetNameOfClass()

template<typename TCellInterface >
const char* itk::VertexCell< TCellInterface >::GetNameOfClass ( ) const
override

Standard part of every itk Object.

◆ GetNumberOfBoundaryFeatures()

template<typename TCellInterface >
CellFeatureCount itk::VertexCell< TCellInterface >::GetNumberOfBoundaryFeatures ( int  dimension) const
override

A vertex has no boundary entities of any dimension.

◆ GetNumberOfPoints()

template<typename TCellInterface >
unsigned int itk::VertexCell< TCellInterface >::GetNumberOfPoints ( ) const
override

Get the number of points required to define the cell.

◆ GetPointId()

template<typename TCellInterface >
virtual PointIdentifier itk::VertexCell< TCellInterface >::GetPointId ( )
virtual

Get the identifier of the point defining the vertex.

◆ GetType()

template<typename TCellInterface >
CellGeometryEnum itk::VertexCell< TCellInterface >::GetType ( ) const
inlineoverride

Implement the standard CellInterface.

Definition at line 63 of file itkVertexCell.h.

References itk::CommonEnums::VERTEX_CELL.

◆ itkCellCommonTypedefs()

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

Standard class type aliases.

◆ itkCellInheritedTypedefs()

template<typename TCellInterface >
itk::VertexCell< TCellInterface >::itkCellInheritedTypedefs ( TCellInterface  )

Standard class type aliases.

◆ itkCellVisitMacro()

template<typename TCellInterface >
itk::VertexCell< TCellInterface >::itkCellVisitMacro ( CellGeometryEnum::VERTEX_CELL  )

Cell visitor interface

◆ MakeCopy()

template<typename TCellInterface >
void itk::VertexCell< TCellInterface >::MakeCopy ( CellAutoPointer &  ) const
override

Implement the standard CellInterface.

◆ PointIdsBegin() [1/2]

template<typename TCellInterface >
PointIdConstIterator itk::VertexCell< TCellInterface >::PointIdsBegin ( ) const
override

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

◆ PointIdsBegin() [2/2]

template<typename TCellInterface >
PointIdIterator itk::VertexCell< TCellInterface >::PointIdsBegin ( )
override

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

◆ PointIdsEnd() [1/2]

template<typename TCellInterface >
PointIdConstIterator itk::VertexCell< TCellInterface >::PointIdsEnd ( ) const
override

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

◆ PointIdsEnd() [2/2]

template<typename TCellInterface >
PointIdIterator itk::VertexCell< TCellInterface >::PointIdsEnd ( )
override

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

◆ SetPointId() [1/2]

template<typename TCellInterface >
void itk::VertexCell< TCellInterface >::SetPointId ( int  localId,
PointIdentifier   
)
override

Set an individual point identifier in the cell.

◆ SetPointId() [2/2]

template<typename TCellInterface >
virtual void itk::VertexCell< TCellInterface >::SetPointId ( PointIdentifier  )
virtual

Set the identifier of the point defining the vertex.

◆ SetPointIds() [1/2]

template<typename TCellInterface >
void itk::VertexCell< TCellInterface >::SetPointIds ( PointIdConstIterator  first)
override

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.

◆ SetPointIds() [2/2]

template<typename TCellInterface >
void itk::VertexCell< TCellInterface >::SetPointIds ( PointIdConstIterator  first,
PointIdConstIterator  last 
)
override

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.

Member Data Documentation

◆ CellDimension

template<typename TCellInterface >
constexpr unsigned int itk::VertexCell< TCellInterface >::CellDimension = 0
staticconstexpr

Definition at line 57 of file itkVertexCell.h.

◆ m_PointIds

template<typename TCellInterface >
std::array<PointIdentifier, NumberOfPoints> itk::VertexCell< TCellInterface >::m_PointIds
protected
Initial value:
{ MakeFilled<std::array<PointIdentifier, NumberOfPoints>>(

Store the number of points needed for a vertex.

Definition at line 150 of file itkVertexCell.h.

◆ NumberOfPoints

template<typename TCellInterface >
constexpr unsigned int itk::VertexCell< TCellInterface >::NumberOfPoints = 1
staticconstexpr

Vertex-specific topology numbers.

Definition at line 56 of file itkVertexCell.h.


The documentation for this class was generated from the following file:
itk::NumericTraits::max
static constexpr T max(const T &)
Definition: itkNumericTraits.h:168