itk::MeshSpatialObject< TMesh > Class Template Reference

#include <itkMeshSpatialObject.h>

Inheritance diagram for itk::MeshSpatialObject< TMesh >:

Collaboration diagram for itk::MeshSpatialObject< TMesh >:

Detailed Description

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

Implementation of an Mesh as spatial object.

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

See Also

SpatialObject

Examples:

Examples/SpatialObjects/MeshSpatialObject.cxx.

Definition at line 37 of file itkMeshSpatialObject.h.

Public Types
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef SmartPointer< const Self >	ConstPointer
typedef MeshType::Pointer	MeshPointer
typedef TMesh	MeshType
typedef PointContainerType::Pointer	PointContainerPointer
typedef VectorContainer < IdentifierType, PointType >	PointContainerType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef double	ScalarType
typedef MeshSpatialObject< TMesh >	Self
typedef SpatialObject < itkGetStaticConstMacro(Dimension) >	Superclass
typedef Superclass::TransformType	TransformType
Public Types inherited from itk::SpatialObject< TMesh::PointDimension >
typedef AffineGeometryFrameType::Pointer	AffineGeometryFramePointer
typedef AffineGeometryFrame < double, VDimension >	AffineGeometryFrameType
typedef BoundingBoxType::Pointer	BoundingBoxPointer
typedef BoundingBox < IdentifierType, VDimension, ScalarType, VectorContainerType >	BoundingBoxType
typedef ChildrenListType *	ChildrenListPointer
typedef std::list< Pointer >	ChildrenListType
typedef SmartPointer< const Self >	ConstPointer
typedef CovariantVector < ScalarType, VDimension >	CovariantVectorType
typedef Index< VDimension >	IndexType
typedef Point< ScalarType, VDimension >	InputType
typedef Offset< VDimension >	OffsetType
typedef OutputVectorType *	OutputVectorPointer
typedef CovariantVector < double, VDimension >	OutputVectorType
typedef SmartPointer< Self >	Pointer
typedef PointType *	PointPointer
typedef Point< ScalarType, VDimension >	PointType
typedef PropertyType::Pointer	PropertyPointer
typedef SpatialObjectProperty < float >	PropertyType
typedef ImageRegion< VDimension >	RegionType
typedef double	ScalarType
typedef SpatialObject< VDimension >	Self
typedef Size< VDimension >	SizeType
typedef double *	SpacingType
typedef DataObject	Superclass
typedef const TransformType *	TransformConstPointer
typedef TransformType::Pointer	TransformPointer
typedef ScalableAffineTransform < double, VDimension >	TransformType
typedef SpatialObjectTreeNode < VDimension >	TreeNodeType
typedef VectorContainer < IdentifierType, PointType >	VectorContainerType
typedef VectorType *	VectorPointer
typedef Vector< ScalarType, VDimension >	VectorType

Public Member Functions
bool	ComputeLocalBoundingBox () const override
virtual ::itk::LightObject::Pointer	CreateAnother () const
ModifiedTimeType	GetMTime (void) const override
virtual const char *	GetNameOfClass () const
const char *	GetPixelType ()
bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=nullptr) const override
bool	IsInside (const PointType &point, unsigned int depth, char *name) const override
virtual bool	IsInside (const PointType &point) const
void	SetMesh (MeshType *Mesh)
bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=nullptr) const override
MeshType *	GetMesh ()
const MeshType *	GetMesh () const
virtual void	SetIsInsidePrecision (double _arg)
virtual double	GetIsInsidePrecision ()
Public Member Functions inherited from itk::SpatialObject< TMesh::PointDimension >
void	AddSpatialObject (Self *pointer)
virtual void	Clear ()
virtual bool	ComputeBoundingBox () const
void	ComputeObjectToParentTransform ()
void	ComputeObjectToWorldTransform ()
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual void	DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=nullptr)
bool	Evaluate (const PointType &point) const
virtual BoundingBoxType *	GetBoundingBox () const
virtual const RegionType &	GetBufferedRegion () const
virtual ChildrenListType *	GetChildren (unsigned int depth=0, char *name=nullptr) const
const TransformType *	GetIndexToObjectTransform () const
TransformType *	GetIndexToObjectTransform (void)
virtual const TransformType *	GetIndexToWorldTransform () const
virtual const RegionType &	GetLargestPossibleRegion () const
unsigned int	GetMaximumDepth () const
TransformType *	GetModifiableIndexToObjectTransform (void)
virtual TransformType *	GetModifiableIndexToWorldTransform ()
virtual TreeNodeType *	GetModifiableTreeNode ()
TransformType *	GetNodeToParentNodeTransform ()
const TransformType *	GetNodeToParentNodeTransform () const
unsigned int	GetNumberOfChildren (unsigned int depth=0, char *name=nullptr) const
unsigned int	GetObjectDimension (void) const
ModifiedTimeType	GetObjectMTime (void) const
TransformType *	GetObjectToNodeTransform ()
const TransformType *	GetObjectToNodeTransform () const
TransformType *	GetObjectToParentTransform ()
const TransformType *	GetObjectToParentTransform () const
virtual const Self *	GetParent () const
virtual Self *	GetParent ()
virtual const RegionType &	GetRequestedRegion () const
virtual const double *	GetSpacing () const
virtual std::string	GetSpatialObjectTypeAsString () const
ModifiedTimeType	GetTransformMTime ()
virtual const TreeNodeType *	GetTreeNode () const
virtual const char *	GetTypeName (void) const
ModifiedTimeType	GetWorldTransformMTime ()
virtual bool	HasParent () const
void	RemoveSpatialObject (Self *object)
virtual void	SetBufferedRegion (const RegionType &region)
void	SetChildren (ChildrenListType &children)
virtual void	SetLargestPossibleRegion (const RegionType &region)
void	SetNodeToParentNodeTransform (TransformType *transform)
void	SetObjectToParentTransform (TransformType *transform)
void	SetParent (Self *parent)
virtual void	SetRequestedRegion (const RegionType &region)
virtual void	SetRequestedRegion (const DataObject *data) override
void	SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
virtual void	SetTreeNode (TreeNodeType *_arg)
virtual void	Update (void) override
virtual void	SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
virtual AffineGeometryFrameType *	GetModifiableAffineGeometryFrame ()
virtual const AffineGeometryFrameType *	GetAffineGeometryFrame () const
void	SetObjectToWorldTransform (TransformType *transform)
virtual TransformType *	GetModifiableObjectToWorldTransform ()
virtual const TransformType *	GetObjectToWorldTransform () const
const OffsetValueType *	GetOffsetTable () const
OffsetValueType	ComputeOffset (const IndexType &ind) const
IndexType	ComputeIndex (OffsetValueType offset) const
virtual void	CopyInformation (const DataObject *data) override
virtual void	UpdateOutputInformation () override
virtual void	SetRequestedRegionToLargestPossibleRegion () override
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion () override
virtual bool	VerifyRequestedRegion () override
PropertyType *	GetProperty ()
const PropertyType *	GetProperty (void) const
void	SetProperty (PropertyType *property)
virtual const int &	GetId () const
virtual void	SetId (int _arg)
virtual void	SetParentId (int _arg)
virtual const int &	GetParentId () const
virtual void	SetBoundingBoxChildrenDepth (unsigned int _arg)
virtual const unsigned int &	GetBoundingBoxChildrenDepth () const
virtual void	SetBoundingBoxChildrenName (std::string _arg)
virtual const std::string &	GetBoundingBoxChildrenName () const
virtual void	SetDefaultInsideValue (double _arg)
virtual double	GetDefaultInsideValue () const
virtual void	SetDefaultOutsideValue (double _arg)
virtual double	GetDefaultOutsideValue () const

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

Static Public Attributes
static const unsigned int	Dimension = TMesh::PointDimension
Static Public Attributes inherited from itk::SpatialObject< TMesh::PointDimension >
static const unsigned int	MaximumDepth
static const unsigned int	ObjectDimension

Protected Member Functions
	MeshSpatialObject ()
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual	~MeshSpatialObject ()
Protected Member Functions inherited from itk::SpatialObject< TMesh::PointDimension >
void	ComputeOffsetTable ()
virtual const BoundingBoxType *	GetBounds () const
virtual const unsigned int &	GetDimension () const
virtual const TransformType *	GetInternalInverseTransform () const
virtual BoundingBoxType *	GetModifiableBounds ()
virtual TransformType *	GetModifiableInternalInverseTransform ()
virtual void	SetDimension (unsigned int _arg)
bool	SetInternalInverseTransformToWorldToIndexTransform () const
virtual void	SetTypeName (std::string _arg)
	SpatialObject ()
virtual	~SpatialObject ()

Protected Attributes
double	m_IsInsidePrecision
MeshPointer	m_Mesh
std::string	m_PixelType

Member Typedef Documentation

template<typename TMesh = Mesh< int >>

typedef Superclass::BoundingBoxType itk::MeshSpatialObject< TMesh >::BoundingBoxType

Definition at line 55 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef SmartPointer< const Self > itk::MeshSpatialObject< TMesh >::ConstPointer

Definition at line 49 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef MeshType::Pointer itk::MeshSpatialObject< TMesh >::MeshPointer

Definition at line 52 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef TMesh itk::MeshSpatialObject< TMesh >::MeshType

Definition at line 51 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef PointContainerType::Pointer itk::MeshSpatialObject< TMesh >::PointContainerPointer

Definition at line 58 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef VectorContainer< IdentifierType, PointType > itk::MeshSpatialObject< TMesh >::PointContainerType

Definition at line 57 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef SmartPointer< Self > itk::MeshSpatialObject< TMesh >::Pointer

Definition at line 48 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef Superclass::PointType itk::MeshSpatialObject< TMesh >::PointType

Definition at line 54 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef double itk::MeshSpatialObject< TMesh >::ScalarType

Definition at line 42 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef MeshSpatialObject< TMesh > itk::MeshSpatialObject< TMesh >::Self

Definition at line 43 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef SpatialObject< itkGetStaticConstMacro(Dimension) > itk::MeshSpatialObject< TMesh >::Superclass

Definition at line 47 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

typedef Superclass::TransformType itk::MeshSpatialObject< TMesh >::TransformType

Definition at line 53 of file itkMeshSpatialObject.h.

Constructor & Destructor Documentation

template<typename TMesh = Mesh< int >>

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

protected

template<typename TMesh = Mesh< int >>

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

protectedvirtual

Member Function Documentation

template<typename TMesh = Mesh< int >>

bool itk::MeshSpatialObject< TMesh >::ComputeLocalBoundingBox ( ) const

overridevirtual

Compute the boundaries of the iamge spatial object.

Reimplemented from itk::SpatialObject< TMesh::PointDimension >.

template<typename TMesh = Mesh< int >>

virtual::itk::LightObject::Pointer itk::MeshSpatialObject< TMesh >::CreateAnother

(

)

const

template<typename TMesh = Mesh< int >>

virtual double itk::MeshSpatialObject< TMesh >::GetIsInsidePrecision ( )

virtual

Set/Get the precision for the IsInside 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_IsInsidePrecision the point is considered inside the mesh. The default value is 1.

template<typename TMesh = Mesh< int >>

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

(

)

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

template<typename TMesh = Mesh< int >>

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

(

)

const

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

template<typename TMesh = Mesh< int >>

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

overridevirtual

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

Reimplemented from itk::SpatialObject< TMesh::PointDimension >.

template<typename TMesh = Mesh< int >>

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::SpatialObject< TMesh::PointDimension >.

template<typename TMesh = Mesh< int >>

const char* itk::MeshSpatialObject< TMesh >::GetPixelType ( )

inline

Return the type of pixel used

Definition at line 101 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

bool itk::MeshSpatialObject< TMesh >::IsEvaluableAt ( const PointType &  point, unsigned int  depth = 0, char *  name = nullptr  ) const

overridevirtual

Return true if the object is evaluable at the requested point, and else otherwise.

Reimplemented from itk::SpatialObject< TMesh::PointDimension >.

template<typename TMesh = Mesh< int >>

bool itk::MeshSpatialObject< TMesh >::IsInside ( const PointType &  point, unsigned int  depth, char *  name  ) const

overridevirtual

Returns true if the point is inside, false otherwise.

Reimplemented from itk::SpatialObject< TMesh::PointDimension >.

template<typename TMesh = Mesh< int >>

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

virtual

Test whether a point is inside or outside the object For computational speed purposes, it is faster if the method does not check the name of the class and the current depth

template<typename TMesh = Mesh< int >>

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

static

Method for creation through the object factory.

template<typename TMesh = Mesh< int >>

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

overrideprotectedvirtual

Reimplemented from itk::SpatialObject< TMesh::PointDimension >.

template<typename TMesh = Mesh< int >>

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

virtual

Set/Get the precision for the IsInside 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_IsInsidePrecision the point is considered inside the mesh. The default value is 1.

template<typename TMesh = Mesh< int >>

void itk::MeshSpatialObject< TMesh >::SetMesh

(

MeshType *

Mesh

)

Set the Mesh.

template<typename TMesh = Mesh< int >>

bool itk::MeshSpatialObject< TMesh >::ValueAt ( const PointType &  point, double &  value, unsigned int  depth = 0, char *  name = nullptr  ) const

overridevirtual

Returns the value of the Mesh at the requested point. If the point is not inside the object, then an exception is thrown.

See Also

ExceptionObject

Reimplemented from itk::SpatialObject< TMesh::PointDimension >.

Member Data Documentation

template<typename TMesh = Mesh< int >>

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

static

Definition at line 45 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

double itk::MeshSpatialObject< TMesh >::m_IsInsidePrecision

protected

Definition at line 120 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

MeshPointer itk::MeshSpatialObject< TMesh >::m_Mesh

protected

Definition at line 113 of file itkMeshSpatialObject.h.

template<typename TMesh = Mesh< int >>

std::string itk::MeshSpatialObject< TMesh >::m_PixelType

protected

Definition at line 119 of file itkMeshSpatialObject.h.

---

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

• itkMeshSpatialObject.h