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

#include <itkLineCell.h>

Detailed Description

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

Represents a line segment for a Mesh.

LineCell represents a line segment for a Mesh.

Template parameters for LineCell:

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/Mesh2.cxx, Examples/DataRepresentation/Mesh/Mesh3.cxx, Examples/DataRepresentation/Mesh/MeshCellsIteration.cxx, Examples/DataRepresentation/Mesh/MeshCellVisitor.cxx, Examples/DataRepresentation/Mesh/MeshCellVisitor2.cxx, Examples/DataRepresentation/Mesh/MeshKComplex.cxx, Examples/DataRepresentation/Mesh/MeshPolyLine.cxx, Examples/DataRepresentation/Mesh/MeshTraits.cxx, SphinxExamples/src/Core/Mesh/AccessDataInCells/Code.cxx, SphinxExamples/src/Core/Mesh/AddPointsAndEdges/Code.cxx, SphinxExamples/src/Core/Mesh/ConvertMeshToUnstructeredGrid/Code.cxx, and SphinxExamples/src/Core/Mesh/WriteMeshToVTP/Code.cxx.

Definition at line 45 of file itkLineCell.h.

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

Public Types

using VertexAutoPointer = typename VertexType::SelfAutoPointer
 
using VertexType = VertexCell< TCellInterface >
 

Public Member Functions

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

Static Public Attributes

static constexpr unsigned int CellDimension = 1
 
static constexpr unsigned int NumberOfPoints = 2
 
static constexpr unsigned int NumberOfVertices = 2
 

Protected Attributes

std::array< PointIdentifier, NumberOfPointsm_PointIds
 

Member Typedef Documentation

◆ VertexAutoPointer

template<typename TCellInterface >
using itk::LineCell< TCellInterface >::VertexAutoPointer = typename VertexType::SelfAutoPointer

Definition at line 60 of file itkLineCell.h.

◆ VertexType

template<typename TCellInterface >
using itk::LineCell< TCellInterface >::VertexType = VertexCell<TCellInterface>

The type of boundary for this lines's vertices.

Definition at line 59 of file itkLineCell.h.

Constructor & Destructor Documentation

◆ LineCell()

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

◆ ~LineCell()

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

Member Function Documentation

◆ GetBoundaryFeature()

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

◆ GetDimension()

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

◆ GetNumberOfBoundaryFeatures()

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

◆ GetNumberOfPoints()

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

◆ GetNumberOfVertices()

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

Line-specific interface.

◆ GetType()

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

Implement the standard CellInterface.

Definition at line 69 of file itkLineCell.h.

References itk::CommonEnums::LINE_CELL.

◆ GetVertex()

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

◆ itkCellCommonTypedefs()

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

Standard class type aliases.

◆ itkCellInheritedTypedefs()

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

Standard class type aliases.

◆ itkCellVisitMacro()

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

Visitor interface

◆ itkOverrideGetNameOfClassMacro()

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

Standard part of every itk Object.

◆ MakeCopy()

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

Implement the standard CellInterface.

◆ PointIdsBegin() [1/2]

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

◆ PointIdsBegin() [2/2]

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

◆ PointIdsEnd() [1/2]

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

◆ PointIdsEnd() [2/2]

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

◆ SetPointId()

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

◆ SetPointIds() [1/2]

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

◆ SetPointIds() [2/2]

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

Member Data Documentation

◆ CellDimension

template<typename TCellInterface >
constexpr unsigned int itk::LineCell< TCellInterface >::CellDimension = 1
staticconstexpr

Definition at line 65 of file itkLineCell.h.

◆ m_PointIds

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

Store number of points needed for a line segment.

Definition at line 124 of file itkLineCell.h.

◆ NumberOfPoints

template<typename TCellInterface >
constexpr unsigned int itk::LineCell< TCellInterface >::NumberOfPoints = 2
staticconstexpr

Line-specific topology numbers.

Definition at line 63 of file itkLineCell.h.

◆ NumberOfVertices

template<typename TCellInterface >
constexpr unsigned int itk::LineCell< TCellInterface >::NumberOfVertices = 2
staticconstexpr

Definition at line 64 of file itkLineCell.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