Detailed Description

template<typename TPixelType, unsigned int VDimension = 3, typename TMeshTraits = DefaultStaticMeshTraits< TPixelType, VDimension, VDimension >>
class itk::Mesh< TPixelType, VDimension, TMeshTraits >

Implements the N-dimensional mesh structure.

Overview: Mesh implements the N-dimensional mesh structure for ITK. It provides an API to perform operations on points, cells, boundaries, etc., but does not tie down the underlying implementation and storage. A "MeshTraits" structure is used to define the container and identifier types that will be used to access the mesh. See DefaultStaticMeshTraits for the set of type definitions needed. All types that are defined in the "MeshTraits" structure will have duplicate typedefs in the resulting mesh itself.

Mesh is an adaptive, evolving structure. Typically points and cells are created, with the cells referring to their defining points. If additional topological information is required, then BuildCellLinks() is called and links from the points back to the cells that use them are created. This allows implicit topological information about the faces and edges of the cells to be determined. (For example, a "face" neighbor to a cell can be determined by intersection the sets of cells that use the points defining the face. This is an inherent assumption on the manifold relationship of the cells in the mesh.) In some cases, either because the mesh is non-manifold, because we wish to explicitly store information with the faces and edges of the mesh, or because performance requirements demand that boundaries are explicitly represented (the set intersection does not need to be performed); then Mesh can be further extended by adding explicit boundary assignments.

Usage: Mesh has three template parameters. The first is the pixel type, or the type of data stored (optionally) with points, cells, and/or boundaries. The second is the geometric dimension of the points defining the mesh. This also limits the maximum topological dimension of the cells that can be inserted. The third template parameter is the "MeshTraits" structure controlling type information for the mesh. Most users will be happy with the defaults, and will not have to worry about this third argument.

One of the most important parts of using this mesh is how to create cells to insert into it. The cells for the mesh take two template parameters. The first is the pixel type, and should correspond exactly to that type given to the mesh. The second is a "CellTraits" which holds a sub-set of the "MeshTraits" structure definitions, and is also a member of them. Any cell which is to be inserted to a mesh should have MeshTraits::CellTraits as its second template parameter.

Template parameters for Mesh:

TPixelType = The type stored as data for an entity (cell, point, or boundary).

TMeshTraits = Type information structure for the mesh.

References: No reference information is available.

Examples:: DataRepresentation/Mesh/AutomaticMesh.cxx, DataRepresentation/Mesh/Mesh1.cxx, DataRepresentation/Mesh/Mesh2.cxx, DataRepresentation/Mesh/Mesh3.cxx, DataRepresentation/Mesh/MeshCellsIteration.cxx, DataRepresentation/Mesh/MeshCellVisitor.cxx, DataRepresentation/Mesh/MeshCellVisitor2.cxx, DataRepresentation/Mesh/MeshKComplex.cxx, DataRepresentation/Mesh/MeshPolyLine.cxx, DataRepresentation/Mesh/MeshTraits.cxx, Filtering/SurfaceExtraction.cxx, and SpatialObjects/MeshSpatialObject.cxx.

Definition at line 108 of file itkMesh.h.

Classes
class	BoundaryAssignmentIdentifier

Public Types
typedef MapContainer < BoundaryAssignmentIdentifier, CellIdentifier >	BoundaryAssignmentsContainer

typedef BoundaryAssignmentsContainer::Pointer	BoundaryAssignmentsContainerPointer

typedef std::vector < BoundaryAssignmentsContainerPointer >	BoundaryAssignmentsContainerVector

typedef BoundingBoxType::Pointer	BoundingBoxPointer

typedef BoundingBox < PointIdentifier, itkGetStaticConstMacro(PointDimension), CoordRepType, PointsContainer >	BoundingBoxType

typedef CellType::CellAutoPointer	CellAutoPointer

typedef MeshTraits::CellDataContainer	CellDataContainer

typedef CellDataContainer::ConstPointer	CellDataContainerConstPointer

typedef CellDataContainer::ConstIterator	CellDataContainerIterator

typedef CellDataContainer::Pointer	CellDataContainerPointer

typedef CellFeatureIdentifier	CellFeatureCount

typedef MeshTraits::CellFeatureIdentifier	CellFeatureIdentifier

typedef MeshTraits::CellIdentifier	CellIdentifier

typedef MeshTraits::CellLinksContainer	CellLinksContainer

typedef CellLinksContainer::ConstPointer	CellLinksContainerConstPointer

typedef CellLinksContainer::ConstIterator	CellLinksContainerIterator

typedef CellLinksContainer::Pointer	CellLinksContainerPointer

typedef CellType::MultiVisitor	CellMultiVisitorType

typedef MeshTraits::CellPixelType	CellPixelType

enum	CellsAllocationMethodType { CellsAllocationMethodUndefined, CellsAllocatedAsStaticArray, CellsAllocatedAsADynamicArray, CellsAllocatedDynamicallyCellByCell }

typedef MeshTraits::CellsContainer	CellsContainer

typedef CellsContainer::ConstIterator	CellsContainerConstIterator

typedef CellsContainer::ConstPointer	CellsContainerConstPointer

typedef CellsContainer::Iterator	CellsContainerIterator

typedef CellsContainer::Pointer	CellsContainerPointer

typedef MeshTraits::CellTraits	CellTraits

typedef CellInterface < CellPixelType, CellTraits >	CellType

typedef SmartPointer< const Self >	ConstPointer

typedef MeshTraits::CoordRepType	CoordRepType

typedef MeshTraits::InterpolationWeightType	InterpolationWeightType

typedef TMeshTraits	MeshTraits

typedef MeshTraits::PixelType	PixelType

typedef MeshTraits::PointCellLinksContainer	PointCellLinksContainer

typedef PointCellLinksContainer::const_iterator	PointCellLinksContainerIterator

typedef MeshTraits::PointDataContainer	PointDataContainer

typedef PointDataContainer::ConstIterator	PointDataContainerIterator

typedef PointDataContainer::Pointer	PointDataContainerPointer

typedef SmartPointer< Self >	Pointer

typedef MeshTraits::PointHashType	PointHashType

typedef MeshTraits::PointIdentifier	PointIdentifier

typedef MeshTraits::PointsContainer	PointsContainer

typedef PointsContainer::ConstIterator	PointsContainerConstIterator

typedef PointsContainer::Iterator	PointsContainerIterator

typedef PointsContainer::Pointer	PointsContainerPointer

typedef MeshTraits::PointType	PointType

typedef Superclass::RegionType	RegionType

typedef Mesh	Self

typedef PointSet< TPixelType, VDimension, TMeshTraits >	Superclass

Public Types inherited from itk::PointSet< TPixelType, VDimension, TMeshTraits >
typedef SmartPointer< const Self >	ConstPointer

typedef MeshTraits::CoordRepType	CoordRepType

typedef TMeshTraits	MeshTraits

typedef MeshTraits::PixelType	PixelType

typedef MeshTraits::PointDataContainer	PointDataContainer

typedef PointDataContainer::ConstPointer	PointDataContainerConstPointer

typedef PointDataContainer::ConstIterator	PointDataContainerIterator

typedef PointDataContainer::Pointer	PointDataContainerPointer

typedef SmartPointer< Self >	Pointer

typedef MeshTraits::PointIdentifier	PointIdentifier

typedef MeshTraits::PointsContainer	PointsContainer

typedef PointsContainer::ConstIterator	PointsContainerConstIterator

typedef PointsContainer::ConstPointer	PointsContainerConstPointer

typedef PointsContainer::Iterator	PointsContainerIterator

typedef PointsContainer::Pointer	PointsContainerPointer

typedef MeshTraits::PointType	PointType

typedef long	RegionType

typedef PointSet	Self

typedef DataObject	Superclass

Public Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer

typedef std::string	DataObjectIdentifierType

typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual void	Accept (CellMultiVisitorType *mv) const

void	BuildCellLinks () const

virtual void	CopyInformation (const DataObject *data)

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

bool	GetAssignedCellBoundaryIfOneExists (int dimension, CellIdentifier, CellFeatureIdentifier, CellAutoPointer &) const

bool	GetBoundaryAssignment (int dimension, CellIdentifier cellId, CellFeatureIdentifier featureId, CellIdentifier *boundaryId) const

BoundaryAssignmentsContainerPointer	GetBoundaryAssignments (int dimension)

const BoundaryAssignmentsContainerPointer	GetBoundaryAssignments (int dimension) const

const BoundingBoxType *	GetBoundingBox (void) const

bool	GetCell (CellIdentifier, CellAutoPointer &) const

bool	GetCellBoundaryFeature (int dimension, CellIdentifier, CellFeatureIdentifier, CellAutoPointer &) const

CellIdentifier	GetCellBoundaryFeatureNeighbors (int dimension, CellIdentifier, CellFeatureIdentifier, std::set< CellIdentifier > *cellSet)

CellDataContainer *	GetCellData ()

const CellDataContainer *	GetCellData () const

CellLinksContainer *	GetCellLinks ()

const CellLinksContainer *	GetCellLinks () const

CellIdentifier	GetCellNeighbors (CellIdentifier cellId, std::set< CellIdentifier > *cellSet)

CellsContainer *	GetCells ()

const CellsContainer *	GetCells () const

virtual const char *	GetNameOfClass () const

CellFeatureCount	GetNumberOfCellBoundaryFeatures (int dimension, CellIdentifier) const

CellIdentifier	GetNumberOfCells () const

virtual void	Graft (const DataObject *data)

virtual void	Initialize ()

void	PassStructure (Self *inputMesh)

bool	RemoveBoundaryAssignment (int dimension, CellIdentifier cellId, CellFeatureIdentifier featureId)

void	SetBoundaryAssignment (int dimension, CellIdentifier cellId, CellFeatureIdentifier featureId, CellIdentifier boundaryId)

void	SetBoundaryAssignments (int dimension, BoundaryAssignmentsContainer *)

void	SetCell (CellIdentifier, CellAutoPointer &)

void	SetCellData (CellDataContainer *)

void	SetCellLinks (CellLinksContainer *)

void	SetCells (CellsContainer *)


void	SetCellData (CellIdentifier, CellPixelType)

bool	GetCellData (CellIdentifier, CellPixelType *) const


virtual void	SetCellsAllocationMethod (CellsAllocationMethodType _arg)

virtual const CellsAllocationMethodType &	GetCellsAllocationMethod () const

Public Member Functions inherited from itk::PointSet< TPixelType, VDimension, TMeshTraits >
virtual RegionType	GetBufferedRegion () const

virtual RegionType	GetMaximumNumberOfRegions () const

PointIdentifier	GetNumberOfPoints (void) const

PointDataContainer *	GetPointData (void)

const PointDataContainer *	GetPointData (void) const

PointsContainer *	GetPoints (void)

const PointsContainer *	GetPoints (void) const

virtual RegionType	GetRequestedRegion () const

void	PassStructure (Self *inputPointSet)

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion () ITK_OVERRIDE

virtual void	SetBufferedRegion (const RegionType &region)

void	SetPointData (PointDataContainer *)

void	SetPoints (PointsContainer *)

virtual void	SetRequestedRegion (const DataObject *data) ITK_OVERRIDE

virtual void	SetRequestedRegion (const RegionType &region)

virtual void	SetRequestedRegionToLargestPossibleRegion () ITK_OVERRIDE

virtual void	UpdateOutputInformation () ITK_OVERRIDE

virtual bool	VerifyRequestedRegion () ITK_OVERRIDE

void	SetPoint (PointIdentifier, PointType)

bool	GetPoint (PointIdentifier, PointType *) const

PointType	GetPoint (PointIdentifier) const

void	SetPointData (PointIdentifier, PixelType)

bool	GetPointData (PointIdentifier, PixelType *) const

Public Member Functions inherited from itk::DataObject
virtual void	DataHasBeenGenerated ()

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointerForwardReference < ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

bool	ShouldIReleaseData () const

virtual void	Update ()

virtual void	UpdateOutputData ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::PointSet< TPixelType, VDimension, TMeshTraits >
static Pointer	New ()

Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	SetGlobalReleaseDataFlag (bool val)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Static Public Attributes

static const unsigned int	PointDimension = TMeshTraits::PointDimension

static const unsigned int	MaxTopologicalDimension = TMeshTraits::MaxTopologicalDimension

Static Public Attributes inherited from itk::PointSet< TPixelType, VDimension, TMeshTraits >
static const unsigned int	PointDimension = TMeshTraits::PointDimension

Protected Member Functions
void	ReleaseCellsMemory ()


	Mesh ()

	~Mesh ()

void	PrintSelf (std::ostream &os, Indent indent) const

Protected Member Functions inherited from itk::PointSet< TPixelType, VDimension, TMeshTraits >
	PointSet ()

	~PointSet ()

Protected Member Functions inherited from itk::DataObject
	DataObject ()

virtual void	PropagateResetPipeline ()

	~DataObject ()

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const

virtual void	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Private Member Functions
	Mesh (const Self &)

void	operator= (const Self &)

Private Attributes
CellsAllocationMethodType	m_CellsAllocationMethod

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType