ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::MeshSpatialObject< TMesh > Class Template Reference

#include <itkMeshSpatialObject.h>

+ Inheritance diagram for itk::MeshSpatialObject< TMesh >:
+ Collaboration diagram for itk::MeshSpatialObject< TMesh >:

Public Types

using BoundingBoxType = typename Superclass::BoundingBoxType
 
using ConstPointer = SmartPointer< const Self >
 
using MeshPointer = typename MeshType::Pointer
 
using MeshType = TMesh
 
using PointContainerPointer = typename PointContainerType::Pointer
 
using PointContainerType = VectorContainer< IdentifierType, PointType >
 
using Pointer = SmartPointer< Self >
 
using PointType = typename Superclass::PointType
 
using ScalarType = double
 
using Self = MeshSpatialObject< TMesh >
 
using Superclass = SpatialObject< Self::Dimension >
 
using TransformType = typename Superclass::TransformType
 
- Public Types inherited from itk::SpatialObject< TMesh::PointDimension >
using BoundingBoxPointer = typename BoundingBoxType::Pointer
 
using BoundingBoxType = BoundingBox< IdentifierType, VDimension, ScalarType, VectorContainerType >
 
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 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< IdentifierType, 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
 
virtual const char * GetNameOfClass () const
 
void SetMesh (MeshType *Mesh)
 
- Public Member Functions inherited from itk::SpatialObject< TMesh::PointDimension >
virtual ::itk::LightObject::Pointer CreateAnother () const
 
unsigned int GetMaximumDepth () const
 
unsigned int GetObjectDimension () const
 
void SetId (int id)
 
virtual const int & GetId () const
 
virtual void SetTypeName (std::string _arg)
 
virtual const std::string GetTypeName () const
 
virtual std::string GetClassNameAndDimension () const
 
void SetProperty (const PropertyType &property)
 
const PropertyTypeGetProperty () const
 
PropertyTypeGetProperty ()
 
ModifiedTimeType GetMTime () const override
 
ModifiedTimeType GetMyMTime () const
 
void SetObjectToWorldTransform (const TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToWorldTransform ()
 
virtual const TransformTypeGetObjectToWorldTransform () const
 
const TransformTypeGetObjectToWorldTransformInverse () const
 
void SetObjectToParentTransform (const TransformType *transform)
 
virtual TransformTypeGetModifiableObjectToParentTransform ()
 
virtual const TransformTypeGetObjectToParentTransform () const
 
const TransformTypeGetObjectToParentTransformInverse () const
 
void ComputeObjectToParentTransform ()
 
bool IsInsideInObjectSpace (const PointType &point, unsigned int depth, const std::string &name="") const
 
virtual bool IsInsideInObjectSpace (const PointType &point) const
 
void Update () override
 
virtual bool ValueAtInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsEvaluableAtInObjectSpace (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
 
virtual bool ValueAtChildrenInObjectSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsEvaluableAtChildrenInObjectSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual void SetDefaultInsideValue (double _arg)
 
virtual double GetDefaultInsideValue () const
 
virtual void SetDefaultOutsideValue (double _arg)
 
virtual double GetDefaultOutsideValue () const
 
virtual bool ValueAtInWorldSpace (const PointType &point, double &value, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsInsideInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual bool IsEvaluableAtInWorldSpace (const PointType &point, unsigned int depth=0, const std::string &name="") const
 
virtual void DerivativeAtInObjectSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &spacing=1)
 
virtual void DerivativeAtInWorldSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &spacing=1)
 
void SetParent (Self *parent)
 
virtual bool HasParent () const
 
virtual const SelfGetParent () const
 
virtual SelfGetParent ()
 
virtual void SetParentId (int _arg)
 
virtual const int & GetParentId () const
 
void SetChildren (ChildrenListType &children)
 
void AddChild (Self *pointer)
 
bool RemoveChild (Self *object)
 
void RemoveAllChildren (unsigned int depth=MaximumDepth)
 
virtual ChildrenListTypeGetChildren (unsigned int depth=0, const std::string &name="") const
 
virtual void AddChildrenToList (ChildrenListType *children, unsigned int depth=0, const std::string &name="") const
 
unsigned int GetNumberOfChildren (unsigned int depth=0, const std::string &name="") const
 
SpatialObject< VDimension > * GetObjectById (int Id)
 
bool FixParentChildHierarchyUsingParentIds ()
 
bool CheckIdValidity () const
 
void FixIdValidity ()
 
int GetNextAvailableId () const
 
virtual const BoundingBoxTypeGetMyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxTypeGetMyBoundingBoxInWorldSpace () const
 
virtual bool ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const
 
virtual const BoundingBoxTypeGetFamilyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxTypeGetFamilyBoundingBoxInWorldSpace () const
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual const RegionTypeGetBufferedRegion () const
 
virtual void SetRequestedRegion (const RegionType &region)
 
void SetRequestedRegion (const DataObject *data) override
 
virtual const RegionTypeGetRequestedRegion () const
 
void SetRequestedRegionToLargestPossibleRegion () override
 
bool RequestedRegionIsOutsideOfTheBufferedRegion () override
 
bool VerifyRequestedRegion () override
 
void UpdateOutputInformation () override
 
void CopyInformation (const DataObject *data) override
 
bool Evaluate (const PointType &point) const
 
- Public Member Functions inherited from itk::DataObject
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObjectGetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierTypeGetSourceOutputName () const
 
virtual void Initialize ()
 
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 SetPipelineMTime (ModifiedTimeType time)
 
virtual const ModifiedTimeTypeGetPipelineMTime () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStampGetRealTimeStamp () const
 
virtual void PrepareForNewData ()
 
virtual void DataHasBeenGenerated ()
 
virtual void Graft (const DataObject *)
 
- 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual const TimeStampGetTimeStamp () 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)
 
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
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::SpatialObject< TMesh::PointDimension >
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 flag)
 
- 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< TMesh::PointDimension >
static constexpr unsigned int MaximumDepth
 
static constexpr ObjectDimensionType ObjectDimension
 
MeshPointer m_Mesh
 
double m_IsInsidePrecisionInObjectSpace
 
MeshTypeGetMesh ()
 
const MeshTypeGetMesh () const
 
bool IsInsideInObjectSpace (const PointType &point) const override
 
ModifiedTimeType GetMTime () const override
 
virtual void SetIsInsidePrecisionInObjectSpace (double _arg)
 
virtual double GetIsInsidePrecisionInObjectSpace () const
 
void ComputeMyBoundingBox () override
 
 MeshSpatialObject ()
 
 ~MeshSpatialObject () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
LightObject::Pointer InternalClone () const override
 

Additional Inherited Members

- Protected Member Functions inherited from itk::SpatialObject< TMesh::PointDimension >
void ProtectedComputeObjectToWorldTransform ()
 
 SpatialObject ()=default
 
 ~SpatialObject () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
BoundingBoxTypeGetModifiableMyBoundingBoxInObjectSpace ()
 
LightObject::Pointer InternalClone () const override
 
- Protected Member Functions inherited from itk::DataObject
 DataObject ()
 
 ~DataObject () override
 
virtual void PropagateResetPipeline ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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.

Member Typedef Documentation

◆ BoundingBoxType

template<typename TMesh = Mesh<int>>
using itk::MeshSpatialObject< TMesh >::BoundingBoxType = typename Superclass::BoundingBoxType

Definition at line 54 of file itkMeshSpatialObject.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<IdentifierType, 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::MeshSpatialObject< TMesh >::PointType = typename Superclass::PointType

Definition at line 53 of file itkMeshSpatialObject.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::MeshSpatialObject< TMesh >::TransformType = typename Superclass::TransformType

Definition at line 52 of file itkMeshSpatialObject.h.

Constructor & Destructor Documentation

◆ MeshSpatialObject()

template<typename TMesh = Mesh<int>>
itk::MeshSpatialObject< TMesh >::MeshSpatialObject ( )
protected

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

◆ ~MeshSpatialObject()

template<typename TMesh = Mesh<int>>
itk::MeshSpatialObject< TMesh >::~MeshSpatialObject ( )
overrideprotecteddefault

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

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< TMesh::PointDimension >.

◆ ComputeMyBoundingBox()

template<typename TMesh = Mesh<int>>
void itk::MeshSpatialObject< TMesh >::ComputeMyBoundingBox ( )
overrideprotectedvirtual

Compute the boundaries of the iamge spatial object.

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

◆ 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::Object.

◆ GetIsInsidePrecisionInObjectSpace()

template<typename TMesh = Mesh<int>>
virtual double itk::MeshSpatialObject< TMesh >::GetIsInsidePrecisionInObjectSpace ( ) const
virtual

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

◆ 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
overridevirtual

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

Run-time type information (and related methods).

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

◆ InternalClone()

template<typename TMesh = Mesh<int>>
LightObject::Pointer itk::MeshSpatialObject< TMesh >::InternalClone ( ) const
overrideprotectedvirtual

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

Reimplemented from itk::LightObject.

◆ IsInsideInObjectSpace()

template<typename TMesh = Mesh<int>>
bool itk::MeshSpatialObject< TMesh >::IsInsideInObjectSpace ( const PointType point) const
override

Returns true if the point is inside, false otherwise.

◆ 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

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

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>>
constexpr 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

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

Definition at line 126 of file itkMeshSpatialObject.h.

◆ m_Mesh

template<typename TMesh = Mesh<int>>
MeshPointer itk::MeshSpatialObject< TMesh >::m_Mesh
private

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

Definition at line 122 of file itkMeshSpatialObject.h.


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