#include <itkMeshSpatialObject.h>

Detailed Description

template<typename TMesh = Mesh<int>>
class itk::MeshSpatialObject< TMesh >

Implementation of an Mesh as spatial object.

This class combines functionalities from a spatial object, and an itkMesh.

See also: SpatialObject

Examples: Examples/SpatialObjects/MeshSpatialObject.cxx.

Definition at line 38 of file itkMeshSpatialObject.h.

Inheritance diagram for itk::MeshSpatialObject< TMesh >:

Collaboration diagram for itk::MeshSpatialObject< TMesh >:

Public Types
using	BoundingBoxType

using	ConstPointer = SmartPointer<const Self>

using	MeshPointer = typename MeshType::Pointer

using	MeshType = TMesh

using	PointContainerPointer = typename PointContainerType::Pointer

using	PointContainerType = VectorContainer<PointType>

using	Pointer = SmartPointer<Self>

using	PointType

using	ScalarType = double

using	Self = MeshSpatialObject<TMesh>

using	Superclass = SpatialObject<Self::Dimension>

using	TransformType

Public Types inherited from itk::SpatialObject< VDimension >
using	BoundingBoxPointer = typename BoundingBoxType::Pointer

using	BoundingBoxType = BoundingBox<IdentifierType, VDimension, ScalarType, VectorContainerType>

using	ChildrenConstListPointer = ChildrenConstListType *

using	ChildrenConstListType = std::list<ConstPointer>

using	ChildrenListPointer = ChildrenListType *

using	ChildrenListType = std::list<Pointer>

using	ConstPointer = SmartPointer<const Self>

using	CovariantVectorType = CovariantVector<ScalarType, VDimension>

using	DerivativeOffsetType = Vector<double, VDimension>

using	DerivativeVectorPointer = DerivativeVectorType *

using	DerivativeVectorType = CovariantVector<ScalarType, VDimension>

using	IndexType = Index<VDimension>

using	InputType = Point<ScalarType, VDimension>

using	ObjectConstListType = std::list<ConstPointer>

using	ObjectDimensionType = unsigned int

using	ObjectListType = std::list<Pointer>

using	Pointer = SmartPointer<Self>

using	PointPointer = PointType *

using	PointType = Point<ScalarType, VDimension>

using	PropertyType = SpatialObjectProperty

using	RegionType = ImageRegion<VDimension>

using	ScalarType = double

using	Self = SpatialObject<VDimension>

using	SizeType = Size<VDimension>

using	Superclass = DataObject

using	TransformConstPointer = const TransformType *

using	TransformPointer = typename TransformType::Pointer

using	TransformType = AffineTransform<ScalarType, VDimension>

using	VectorContainerType = VectorContainer<PointType>

using	VectorPointer = VectorType *

using	VectorType = Vector<ScalarType, VDimension>

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

using	DataObjectIdentifierType = std::string

using	DataObjectPointerArraySizeType = std::vector<Pointer>::size_type

using	Pointer = SmartPointer<Self>

using	Self = DataObject

using	Superclass = Object

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

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
void	Clear () override

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

ModifiedTimeType	GetMTime () const override

virtual const char *	GetNameOfClass () const

bool	IsInsideInObjectSpace (const PointType &point) const override

bool	IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const

void	SetMesh (MeshType *mesh)


MeshType *	GetMesh ()

const MeshType *	GetMesh () const


virtual void	SetIsInsidePrecisionInObjectSpace (double _arg)

virtual double	GetIsInsidePrecisionInObjectSpace () const

Public Member Functions inherited from itk::SpatialObject< VDimension >
void	AddChild (Self *pointer)

virtual void	AddChildrenToConstList (ChildrenConstListType *childrenCList, unsigned int depth=0, const std::string &name="") const

virtual void	AddChildrenToList (ChildrenListType *childrenList, unsigned int depth=0, const std::string &name="") const

bool	CheckIdValidity () const

virtual bool	ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const

void	ComputeObjectToParentTransform ()

void	CopyInformation (const DataObject *data) override

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

virtual void	DerivativeAtInObjectSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))

void	DerivativeAtInWorldSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=MakeFilled< DerivativeOffsetType >(1))

bool	Evaluate (const PointType &point) const

void	FixIdValidity ()

bool	FixParentChildHierarchyUsingParentIds ()

virtual const RegionType &	GetBufferedRegion () const

virtual ChildrenListType *	GetChildren (unsigned int depth=0, const std::string &name="") const

virtual std::string	GetClassNameAndDimension () const

virtual ChildrenConstListType *	GetConstChildren (unsigned int depth=0, const std::string &name="") const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetFamilyBoundingBoxInWorldSpace () const

virtual const RegionType &	GetLargestPossibleRegion () const

unsigned int	GetMaximumDepth () const

ModifiedTimeType	GetMTime () const override

virtual const BoundingBoxType *	GetMyBoundingBoxInObjectSpace () const

virtual const BoundingBoxType *	GetMyBoundingBoxInWorldSpace () const

ModifiedTimeType	GetMyMTime () const

int	GetNextAvailableId () const

unsigned int	GetNumberOfChildren (unsigned int depth=0, const std::string &name="") const

SpatialObject< VDimension > *	GetObjectById (int id)

unsigned int	GetObjectDimension () const

virtual Self *	GetParent ()

virtual const Self *	GetParent () const

PropertyType &	GetProperty ()

const PropertyType &	GetProperty () const

virtual const RegionType &	GetRequestedRegion () const

virtual std::string	GetTypeName () const

virtual bool	HasParent () const

virtual bool	IsEvaluableAtChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

virtual bool	IsEvaluableAtInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

bool	IsEvaluableAtInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

virtual bool	IsInsideChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const

bool	IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const

bool	IsInsideInWorldSpace (const PointType &point) const

bool	IsInsideInWorldSpace (const PointType &point, unsigned int depth, const std::string &name="") const

void	RemoveAllChildren (unsigned int depth=MaximumDepth)

bool	RemoveChild (Self *pointer)

bool	RequestedRegionIsOutsideOfTheBufferedRegion () override

virtual void	SetBufferedRegion (const RegionType &region)

void	SetChildren (ChildrenListType &children)

virtual void	SetLargestPossibleRegion (const RegionType &region)

void	SetParent (Self *parent)

void	SetProperty (const PropertyType &property)

void	SetRequestedRegion (const DataObject *data) override

virtual void	SetRequestedRegion (const RegionType &region)

void	SetRequestedRegionToLargestPossibleRegion () override

virtual void	SetTypeName (std::string _arg)

void	Update () override

void	UpdateOutputInformation () override

virtual bool	ValueAtChildrenInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

virtual bool	ValueAtInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

bool	ValueAtInWorldSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const

bool	VerifyRequestedRegion () override

void	SetId (int id)

virtual const int &	GetId () const

void	SetObjectToWorldTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToWorldTransform ()

virtual const TransformType *	GetObjectToWorldTransform () const

const TransformType *	GetObjectToWorldTransformInverse () const

void	SetObjectToParentTransform (const TransformType *transform)

virtual TransformType *	GetModifiableObjectToParentTransform ()

virtual const TransformType *	GetObjectToParentTransform () const

const TransformType *	GetObjectToParentTransformInverse () const

virtual void	SetDefaultInsideValue (double _arg)

virtual double	GetDefaultInsideValue () const

virtual void	SetDefaultOutsideValue (double _arg)

virtual double	GetDefaultOutsideValue () const

virtual void	SetParentId (int _arg)

virtual const int &	GetParentId () const

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

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

SmartPointer< ProcessObject >	GetSource () const

DataObjectPointerArraySizeType	GetSourceOutputIndex () const

const DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	Graft (const DataObject *)

virtual void	Initialize ()

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	UpdateOutputData ()

void	UpdateSource () const

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 *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () 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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

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

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::SpatialObject< VDimension >
static Pointer	New ()

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

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static Pointer	New ()

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 val)

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

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	Dimension = TMesh::PointDimension

Static Public Attributes inherited from itk::SpatialObject< VDimension >
static constexpr unsigned int	MaximumDepth = std::numeric_limits<unsigned int>::max()

static constexpr ObjectDimensionType	ObjectDimension = VDimension

Protected Member Functions
void	ComputeMyBoundingBox () override

LightObject::Pointer	InternalClone () const override

	MeshSpatialObject ()

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

	~MeshSpatialObject () override=default

Protected Member Functions inherited from itk::SpatialObject< VDimension >
BoundingBoxType *	GetModifiableMyBoundingBoxInObjectSpace ()

LightObject::Pointer	InternalClone () const override

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

void	ProtectedComputeObjectToWorldTransform ()

	SpatialObject ()=default

	~SpatialObject () override

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

virtual void	PropagateResetPipeline ()

	~DataObject () override

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

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

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

virtual	~LightObject ()

Private Attributes
double	m_IsInsidePrecisionInObjectSpace {}

MeshPointer	m_Mesh {}

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ BoundingBoxType

template<typename TMesh = Mesh<int>>

using itk::SpatialObject< VDimension >::BoundingBoxType

Definition at line 106 of file itkSpatialObject.h.

◆ ConstPointer

template<typename TMesh = Mesh<int>>

using itk::MeshSpatialObject< TMesh >::ConstPointer = SmartPointer<const Self>

Definition at line 48 of file itkMeshSpatialObject.h.

◆ MeshPointer

template<typename TMesh = Mesh<int>>

using itk::MeshSpatialObject< TMesh >::MeshPointer = typename MeshType::Pointer

Definition at line 51 of file itkMeshSpatialObject.h.

◆ MeshType

template<typename TMesh = Mesh<int>>

using itk::MeshSpatialObject< TMesh >::MeshType = TMesh

Definition at line 50 of file itkMeshSpatialObject.h.

◆ PointContainerPointer

template<typename TMesh = Mesh<int>>

using itk::MeshSpatialObject< TMesh >::PointContainerPointer = typename PointContainerType::Pointer

Definition at line 57 of file itkMeshSpatialObject.h.

◆ PointContainerType

template<typename TMesh = Mesh<int>>

using itk::MeshSpatialObject< TMesh >::PointContainerType = VectorContainer<PointType>

Definition at line 56 of file itkMeshSpatialObject.h.

◆ Pointer

template<typename TMesh = Mesh<int>>

using itk::MeshSpatialObject< TMesh >::Pointer = SmartPointer<Self>

Definition at line 47 of file itkMeshSpatialObject.h.

◆ PointType

template<typename TMesh = Mesh<int>>

using itk::SpatialObject< VDimension >::PointType

Definition at line 89 of file itkSpatialObject.h.

◆ ScalarType

template<typename TMesh = Mesh<int>>

using itk::MeshSpatialObject< TMesh >::ScalarType = double

Definition at line 41 of file itkMeshSpatialObject.h.

◆ Self

template<typename TMesh = Mesh<int>>

using itk::MeshSpatialObject< TMesh >::Self = MeshSpatialObject<TMesh>

Definition at line 42 of file itkMeshSpatialObject.h.

◆ Superclass

template<typename TMesh = Mesh<int>>

using itk::MeshSpatialObject< TMesh >::Superclass = SpatialObject<Self::Dimension>

Definition at line 46 of file itkMeshSpatialObject.h.

◆ TransformType

template<typename TMesh = Mesh<int>>

using itk::SpatialObject< VDimension >::TransformType

Definition at line 100 of file itkSpatialObject.h.

Constructor & Destructor Documentation

◆ MeshSpatialObject()

template<typename TMesh = Mesh<int>>

itk::MeshSpatialObject< TMesh >::MeshSpatialObject ( )

protected

◆ ~MeshSpatialObject()

template<typename TMesh = Mesh<int>>

itk::MeshSpatialObject< TMesh >::~MeshSpatialObject ( )

overrideprotecteddefault

Member Function Documentation

◆ Clear()

template<typename TMesh = Mesh<int>>

void itk::MeshSpatialObject< TMesh >::Clear ( )

overridevirtual

Reset the spatial object to its initial condition, yet preserves Id, Parent, and Child information

Reimplemented from itk::SpatialObject< VDimension >.

◆ ComputeMyBoundingBox()

template<typename TMesh = Mesh<int>>

void itk::MeshSpatialObject< TMesh >::ComputeMyBoundingBox ( )

overrideprotectedvirtual

Compute the boundaries of the spatial object.

Reimplemented from itk::SpatialObject< VDimension >.

◆ CreateAnother()

template<typename TMesh = Mesh<int>>

virtual::itk::LightObject::Pointer itk::MeshSpatialObject< TMesh >::CreateAnother ( ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

◆ GetIsInsidePrecisionInObjectSpace()

template<typename TMesh = Mesh<int>>

virtual double itk::MeshSpatialObject< TMesh >::GetIsInsidePrecisionInObjectSpace ( ) const

virtual

Set/Get the precision for the IsInsideInObjectSpace function. This is used when the cell is a triangle, in this case, it's more likely that the given point will not be falling exactly on the triangle surface. If the distance from the point to the surface is <= to m_IsInsidePrecisionInObjectSpace the point is considered inside the mesh. The default value is 1.

◆ GetMesh() [1/2]

template<typename TMesh = Mesh<int>>

MeshType * itk::MeshSpatialObject< TMesh >::GetMesh ( )

Get a pointer to the Mesh currently attached to the object.

◆ GetMesh() [2/2]

template<typename TMesh = Mesh<int>>

const MeshType * itk::MeshSpatialObject< TMesh >::GetMesh ( ) const

Get a pointer to the Mesh currently attached to the object.

◆ GetMTime()

template<typename TMesh = Mesh<int>>

ModifiedTimeType itk::MeshSpatialObject< TMesh >::GetMTime ( ) const

nodiscardoverridevirtual

Returns the latest modified time of the object and its component.

Reimplemented from itk::Object.

◆ GetNameOfClass()

template<typename TMesh = Mesh<int>>

virtual const char * itk::MeshSpatialObject< TMesh >::GetNameOfClass ( ) const

virtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::SpatialObject< VDimension >.

◆ InternalClone()

template<typename TMesh = Mesh<int>>

LightObject::Pointer itk::MeshSpatialObject< TMesh >::InternalClone ( ) const

nodiscardoverrideprotectedvirtual

Actual implementation of the clone method. This method should be reimplemented in subclasses to clone the extra required parameters.

Reimplemented from itk::LightObject.

◆ IsInsideInObjectSpace() [1/2]

template<typename TMesh = Mesh<int>>

bool itk::MeshSpatialObject< TMesh >::IsInsideInObjectSpace ( const PointType & point ) const

overridevirtual

Test whether a point is inside or outside the object.

Returns true if the point is inside, false otherwise.

For computational speed purposes, it is faster if the method does not check the name of the class and the current depth.

Reimplemented from itk::SpatialObject< VDimension >.

◆ IsInsideInObjectSpace() [2/2]

template<typename TMesh = Mesh<int>>

bool itk::SpatialObject< VDimension >::IsInsideInObjectSpace	(	const PointType &	point,
		unsigned int	depth,
		const std::string &	name = "" ) const

Returns true if a point is inside the object or its children in object space.

◆ New()

template<typename TMesh = Mesh<int>>

static Pointer itk::MeshSpatialObject< TMesh >::New ( )

static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TMesh = Mesh<int>>

void itk::MeshSpatialObject< TMesh >::PrintSelf	(	std::ostream &	os,
		Indent	indent ) const

overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::DataObject.

◆ SetIsInsidePrecisionInObjectSpace()

template<typename TMesh = Mesh<int>>

virtual void itk::MeshSpatialObject< TMesh >::SetIsInsidePrecisionInObjectSpace ( double _arg )

virtual

Set/Get the precision for the IsInsideInObjectSpace function. This is used when the cell is a triangle, in this case, it's more likely that the given point will not be falling exactly on the triangle surface. If the distance from the point to the surface is <= to m_IsInsidePrecisionInObjectSpace the point is considered inside the mesh. The default value is 1.

◆ SetMesh()

template<typename TMesh = Mesh<int>>

void itk::MeshSpatialObject< TMesh >::SetMesh ( MeshType * mesh )

Set the Mesh.

Member Data Documentation

◆ Dimension

template<typename TMesh = Mesh<int>>

unsigned int itk::MeshSpatialObject< TMesh >::Dimension = TMesh::PointDimension

staticconstexpr

Definition at line 44 of file itkMeshSpatialObject.h.

◆ m_IsInsidePrecisionInObjectSpace

template<typename TMesh = Mesh<int>>

double itk::MeshSpatialObject< TMesh >::m_IsInsidePrecisionInObjectSpace {}

private

Definition at line 135 of file itkMeshSpatialObject.h.

◆ m_Mesh

template<typename TMesh = Mesh<int>>

MeshPointer itk::MeshSpatialObject< TMesh >::m_Mesh {}

private

Definition at line 131 of file itkMeshSpatialObject.h.

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

itkMeshSpatialObject.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ BoundingBoxType

◆ ConstPointer

◆ MeshPointer

◆ MeshType

◆ PointContainerPointer

◆ PointContainerType

◆ Pointer

◆ PointType

◆ ScalarType

◆ Self

◆ Superclass

◆ TransformType

Constructor & Destructor Documentation

◆ MeshSpatialObject()

◆ ~MeshSpatialObject()

Member Function Documentation

◆ Clear()

◆ ComputeMyBoundingBox()

◆ CreateAnother()

◆ GetIsInsidePrecisionInObjectSpace()

◆ GetMesh() [1/2]

◆ GetMesh() [2/2]

◆ GetMTime()

◆ GetNameOfClass()

◆ InternalClone()

◆ IsInsideInObjectSpace() [1/2]

◆ IsInsideInObjectSpace() [2/2]

◆ New()

◆ PrintSelf()

◆ SetIsInsidePrecisionInObjectSpace()

◆ SetMesh()

Member Data Documentation

◆ Dimension

◆ m_IsInsidePrecisionInObjectSpace

◆ m_Mesh