ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
itk::SpatialObject< VDimension > Class Template Reference
Group Core » Module ITKSpatialObjects

#include <itkSpatialObject.h>

+ Inheritance diagram for itk::SpatialObject< VDimension >:
+ Collaboration diagram for itk::SpatialObject< VDimension >:

Public Types

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

virtual ::itk::LightObject::Pointer CreateAnother () const
 
unsigned int GetMaximumDepth () const
 
virtual const char * GetNameOfClass () const
 
unsigned int GetObjectDimension () const
 
- Public Member Functions inherited from itk::DataObject
void DisconnectPipeline ()
 
bool GetDataReleased () const
 
virtual const bool & GetReleaseDataFlag () const
 
SmartPointer< ProcessObject > GetSource () const
 
DataObjectPointerArraySizeType GetSourceOutputIndex () const
 
const DataObjectIdentifierType & GetSourceOutputName () 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 ModifiedTimeType & GetPipelineMTime () const
 
virtual ModifiedTimeType GetUpdateMTime () const
 
virtual void SetRealTimeStamp (RealTimeStamp _arg)
 
virtual const RealTimeStamp & GetRealTimeStamp () 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
 
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)
 
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::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 MaximumDepth = 9999999
 
static constexpr ObjectDimensionType ObjectDimension = VDimension
 
int m_Id { -1 }
 
std::string m_TypeName { "SpatialObject" }
 
PropertyType m_Property
 
int m_ParentId { -1 }
 
Self * m_Parent { nullptr }
 
RegionType m_LargestPossibleRegion
 
RegionType m_RequestedRegion
 
RegionType m_BufferedRegion
 
const BoundingBoxPointer m_MyBoundingBoxInObjectSpace { BoundingBoxType::New() }
 
const BoundingBoxPointer m_MyBoundingBoxInWorldSpace { BoundingBoxType::New() }
 
const BoundingBoxPointer m_FamilyBoundingBoxInObjectSpace { BoundingBoxType::New() }
 
const BoundingBoxPointer m_FamilyBoundingBoxInWorldSpace { BoundingBoxType::New() }
 
const TransformPointer m_ObjectToParentTransform { TransformType::New() }
 
const TransformPointer m_ObjectToParentTransformInverse { TransformType::New() }
 
const TransformPointer m_ObjectToWorldTransform { TransformType::New() }
 
const TransformPointer m_ObjectToWorldTransformInverse { TransformType::New() }
 
ChildrenListType m_ChildrenList
 
double m_DefaultInsideValue { 1.0 }
 
double m_DefaultOutsideValue { 0.0 }
 
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
 
virtual void Clear ()
 
void SetProperty (const PropertyType &property)
 
const PropertyType & GetProperty () const
 
PropertyType & GetProperty ()
 
ModifiedTimeType GetMTime () const override
 
ModifiedTimeType GetMyMTime () 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
 
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 &offset=1)
 
virtual void DerivativeAtInWorldSpace (const PointType &point, short unsigned int order, CovariantVectorType &value, unsigned int depth=0, const std::string &name="", const DerivativeOffsetType &offset=1)
 
void SetParent (Self *parent)
 
virtual bool HasParent () const
 
virtual const Self * GetParent () const
 
virtual Self * GetParent ()
 
virtual void SetParentId (int _arg)
 
virtual const int & GetParentId () const
 
void SetChildren (ChildrenListType &children)
 
void AddChild (Self *pointer)
 
bool RemoveChild (Self *pointer)
 
void RemoveAllChildren (unsigned int depth=MaximumDepth)
 
virtual ChildrenListType * GetChildren (unsigned int depth=0, const std::string &name="") const
 
virtual void AddChildrenToList (ChildrenListType *childrenList, 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 BoundingBoxType * GetMyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxType * GetMyBoundingBoxInWorldSpace () const
 
virtual bool ComputeFamilyBoundingBox (unsigned int depth=0, const std::string &name="") const
 
virtual const BoundingBoxType * GetFamilyBoundingBoxInObjectSpace () const
 
virtual const BoundingBoxType * GetFamilyBoundingBoxInWorldSpace () const
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
virtual const RegionType & GetLargestPossibleRegion () const
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual const RegionType & GetBufferedRegion () const
 
virtual void SetRequestedRegion (const RegionType &region)
 
void SetRequestedRegion (const DataObject *data) override
 
virtual const RegionType & GetRequestedRegion () 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
 
void ProtectedComputeObjectToWorldTransform ()
 
virtual void ComputeMyBoundingBox ()
 
 SpatialObject ()=default
 
 ~SpatialObject () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
BoundingBoxType * GetModifiableMyBoundingBoxInObjectSpace ()
 
LightObject::Pointer InternalClone () const override
 

Additional Inherited Members

- 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 &timeStamp)
 
- 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<unsigned int VDimension = 3>
class itk::SpatialObject< VDimension >

Implementation of the composite pattern.

The purpose of this class is to implement the composite pattern [Design Patterns, Gamma, 1995] within itk, so that it becomes easy to create an environment containing objects within a scene, and to manipulate the environment as a whole or any of its component objects. An object has a list of transformations to transform object coordinates to the corresponding coordinates in the real world coordinate system, and a list of inverse transformation to go backward. Any spatial objects can be plugged to a spatial object as children. To implement your own spatial object, you need to derive from the following class, which requires the definition of just a few pure virtual functions. Examples of such functions are ValueAtInWorldSpace(), IsEvaluableAtInWorldSpace(), and IsInsideInWorldSpace(), each of which has a meaning specific to each particular object type.

Examples
Examples/SpatialObjects/SpatialObjectHierarchy.cxx, and Examples/SpatialObjects/SpatialObjectTransforms.cxx.

Definition at line 57 of file itkSpatialObject.h.

Member Typedef Documentation

◆ BoundingBoxPointer

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::BoundingBoxPointer = typename BoundingBoxType::Pointer

Definition at line 106 of file itkSpatialObject.h.

◆ BoundingBoxType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::BoundingBoxType = BoundingBox<IdentifierType, VDimension, ScalarType, VectorContainerType>

Definition at line 105 of file itkSpatialObject.h.

◆ ChildrenListPointer

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::ChildrenListPointer = ChildrenListType *

Definition at line 110 of file itkSpatialObject.h.

◆ ChildrenListType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::ChildrenListType = std::list<Pointer>

Return type for the list of children

Definition at line 109 of file itkSpatialObject.h.

◆ ConstPointer

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::ConstPointer = SmartPointer<const Self>

Definition at line 82 of file itkSpatialObject.h.

◆ CovariantVectorType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::CovariantVectorType = CovariantVector<ScalarType, VDimension>

Definition at line 91 of file itkSpatialObject.h.

◆ DerivativeOffsetType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::DerivativeOffsetType = Vector<double, VDimension>

Definition at line 97 of file itkSpatialObject.h.

◆ DerivativeVectorPointer

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::DerivativeVectorPointer = DerivativeVectorType *

Definition at line 95 of file itkSpatialObject.h.

◆ DerivativeVectorType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::DerivativeVectorType = CovariantVector<ScalarType, VDimension>

Definition at line 94 of file itkSpatialObject.h.

◆ IndexType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::IndexType = Index<VDimension>

Definition at line 119 of file itkSpatialObject.h.

◆ InputType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::InputType = Point<ScalarType, VDimension>

Definition at line 86 of file itkSpatialObject.h.

◆ ObjectDimensionType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::ObjectDimensionType = unsigned int

Definition at line 64 of file itkSpatialObject.h.

◆ ObjectListType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::ObjectListType = std::list<Pointer>

Definition at line 112 of file itkSpatialObject.h.

◆ Pointer

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::Pointer = SmartPointer<Self>

Definition at line 81 of file itkSpatialObject.h.

◆ PointPointer

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::PointPointer = PointType *

Definition at line 89 of file itkSpatialObject.h.

◆ PointType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::PointType = Point<ScalarType, VDimension>

Definition at line 88 of file itkSpatialObject.h.

◆ PropertyType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::PropertyType = SpatialObjectProperty

Definition at line 116 of file itkSpatialObject.h.

◆ RegionType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::RegionType = ImageRegion<VDimension>

Definition at line 114 of file itkSpatialObject.h.

◆ ScalarType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::ScalarType = double

Definition at line 62 of file itkSpatialObject.h.

◆ Self

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::Self = SpatialObject<VDimension>

Definition at line 78 of file itkSpatialObject.h.

◆ SizeType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::SizeType = Size<VDimension>

Definition at line 120 of file itkSpatialObject.h.

◆ Superclass

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::Superclass = DataObject

Definition at line 79 of file itkSpatialObject.h.

◆ TransformConstPointer

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::TransformConstPointer = const TransformType *

Definition at line 101 of file itkSpatialObject.h.

◆ TransformPointer

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::TransformPointer = typename TransformType::Pointer

Definition at line 100 of file itkSpatialObject.h.

◆ TransformType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::TransformType = AffineTransform<ScalarType, VDimension>

Definition at line 99 of file itkSpatialObject.h.

◆ VectorContainerType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::VectorContainerType = VectorContainer<IdentifierType, PointType>

Definition at line 103 of file itkSpatialObject.h.

◆ VectorPointer

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::VectorPointer = VectorType *

Definition at line 92 of file itkSpatialObject.h.

◆ VectorType

template<unsigned int VDimension = 3>
using itk::SpatialObject< VDimension >::VectorType = Vector<ScalarType, VDimension>

Definition at line 90 of file itkSpatialObject.h.

Constructor & Destructor Documentation

◆ SpatialObject()

template<unsigned int VDimension = 3>
itk::SpatialObject< VDimension >::SpatialObject ( )
protecteddefault

Default constructor. Ensures that its bounding boxes are empty (all bounds zero-valued), its list of children is empty, and its transform objects identical to the identity transform, initially.

◆ ~SpatialObject()

template<unsigned int VDimension = 3>
itk::SpatialObject< VDimension >::~SpatialObject ( )
overrideprotected

Destructor.

Member Function Documentation

◆ AddChild()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::AddChild ( Self *  pointer)

Add an object to the list of children.

◆ AddChildrenToList()

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::AddChildrenToList ( ChildrenListType *  childrenList,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

Object Identification Number

◆ CheckIdValidity()

template<unsigned int VDimension = 3>
bool itk::SpatialObject< VDimension >::CheckIdValidity ( ) const

Confirm that every object inherited from this has a unique Id

◆ Clear()

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::Clear ( )
virtual

Restore a spatial object to its initial state, yet preserves Id as well as parent and children relationships

Reimplemented in itk::ContourSpatialObject< TDimension >, itk::TubeSpatialObject< TDimension, TSpatialObjectPointType >, itk::TubeSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::SurfaceSpatialObject< TDimension >, itk::ImageSpatialObject< TDimension, TPixel >, itk::EllipseSpatialObject< TDimension >, itk::MeshSpatialObject< TMesh >, itk::GaussianSpatialObject< TDimension >, itk::PointBasedSpatialObject< TDimension, TSpatialObjectPointType >, itk::PointBasedSpatialObject< TDimension, ContourSpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension, SurfaceSpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension >, itk::PointBasedSpatialObject< TDimension, SpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension, LineSpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >, itk::PolygonSpatialObject< TDimension >, itk::ArrowSpatialObject< TDimension >, and itk::BoxSpatialObject< TDimension >.

◆ ComputeFamilyBoundingBox()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::ComputeFamilyBoundingBox ( unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

Compute an axis-aligned bounding box for an object and its selected children, down to a specified depth, in object space.

◆ ComputeMyBoundingBox()

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::ComputeMyBoundingBox ( )
protectedvirtual

Compute bounding box for the object in object space

Reimplemented in itk::PointBasedSpatialObject< TDimension, TSpatialObjectPointType >, itk::PointBasedSpatialObject< TDimension, ContourSpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension, SurfaceSpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension >, itk::PointBasedSpatialObject< TDimension, SpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension, LineSpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::ImageSpatialObject< TDimension, TPixel >, itk::GaussianSpatialObject< TDimension >, itk::TubeSpatialObject< TDimension, TSpatialObjectPointType >, itk::TubeSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >, itk::MeshSpatialObject< TMesh >, itk::ImageMaskSpatialObject< TDimension, TPixel >, itk::EllipseSpatialObject< TDimension >, itk::ArrowSpatialObject< TDimension >, and itk::BoxSpatialObject< TDimension >.

◆ ComputeObjectToParentTransform()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::ComputeObjectToParentTransform ( )

Compute the Local transform when the global transform is set

◆ CopyInformation()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::CopyInformation ( const DataObject *  data)
overridevirtual

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. ImageBase has more meta-data than its DataObject. Thus, it must provide its own version of CopyInformation() in order to copy the LargestPossibleRegion from the input parameter.

Reimplemented from itk::DataObject.

◆ CreateAnother()

template<unsigned int VDimension = 3>
virtual::itk::LightObject::Pointer itk::SpatialObject< VDimension >::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.

Reimplemented in itk::TubeSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >.

◆ DerivativeAtInObjectSpace()

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

Return the n-th order derivative value at the specified point.

◆ DerivativeAtInWorldSpace()

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

Return the n-th order derivative value at the specified point.

◆ Evaluate()

template<unsigned int VDimension = 3>
bool itk::SpatialObject< VDimension >::Evaluate ( const PointType &  point) const
inline

Returns true if a point is inside the object - provided to make spatial objects compatible with spatial functions and conditional iterators for defining regions of interest.

Definition at line 588 of file itkSpatialObject.h.

◆ FixIdValidity()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::FixIdValidity ( )

Give every object inherited from this a unique Id

◆ FixParentChildHierarchyUsingParentIds()

template<unsigned int VDimension = 3>
bool itk::SpatialObject< VDimension >::FixParentChildHierarchyUsingParentIds ( )

In practice, this is used to transform an imported MetaIO scene hierarchy specified only by Ids into the SpatialObject hierarchy specified by Ids and Child/Parent lists.

◆ GetBufferedRegion()

template<unsigned int VDimension = 3>
virtual const RegionType& itk::SpatialObject< VDimension >::GetBufferedRegion ( ) const
inlinevirtual

Get the region object that defines the size and starting index of the region of the image currently loaded in memory.

See also
ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

Definition at line 498 of file itkSpatialObject.h.

◆ GetChildren()

template<unsigned int VDimension = 3>
virtual ChildrenListType* itk::SpatialObject< VDimension >::GetChildren ( unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

Returns a list of pointer to the children affiliated to this object. A depth of 0 returns the immediate children. A depth of 1 returns the children and those children's children.

Warning
User is responsible for freeing the list, but not the elements of the list.

◆ GetClassNameAndDimension()

template<unsigned int VDimension = 3>
virtual std::string itk::SpatialObject< VDimension >::GetClassNameAndDimension ( ) const
virtual

Get the class name with the dimension of the spatial object appended

◆ GetDefaultInsideValue()

template<unsigned int VDimension = 3>
virtual double itk::SpatialObject< VDimension >::GetDefaultInsideValue ( ) const
virtual

Object Identification Number

◆ GetDefaultOutsideValue()

template<unsigned int VDimension = 3>
virtual double itk::SpatialObject< VDimension >::GetDefaultOutsideValue ( ) const
virtual

Object Identification Number

◆ GetFamilyBoundingBoxInObjectSpace()

template<unsigned int VDimension = 3>
virtual const BoundingBoxType* itk::SpatialObject< VDimension >::GetFamilyBoundingBoxInObjectSpace ( ) const
virtual

Get a pointer to the bounding box of the object. The extents and the position of the box are not computed.

◆ GetFamilyBoundingBoxInWorldSpace()

template<unsigned int VDimension = 3>
virtual const BoundingBoxType* itk::SpatialObject< VDimension >::GetFamilyBoundingBoxInWorldSpace ( ) const
virtual

Get a pointer to the bounding box of the object. The extents and the position of the box are not computed.

◆ GetId()

template<unsigned int VDimension = 3>
virtual const int& itk::SpatialObject< VDimension >::GetId ( ) const
virtual

Object Identification Number

◆ GetLargestPossibleRegion()

template<unsigned int VDimension = 3>
virtual const RegionType& itk::SpatialObject< VDimension >::GetLargestPossibleRegion ( ) const
inlinevirtual

Get the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.

See also
ImageRegion, GetBufferedRegion(), GetRequestedRegion()

Definition at line 483 of file itkSpatialObject.h.

◆ GetMaximumDepth()

template<unsigned int VDimension = 3>
unsigned int itk::SpatialObject< VDimension >::GetMaximumDepth ( ) const
inline

Return the maximum depth that a tree of spatial objects can have. This provides convenient access to a static constant.

Definition at line 73 of file itkSpatialObject.h.

◆ GetModifiableMyBoundingBoxInObjectSpace()

template<unsigned int VDimension = 3>
BoundingBoxType* itk::SpatialObject< VDimension >::GetModifiableMyBoundingBoxInObjectSpace ( )
inlineprotected

Object Identification Number

Definition at line 637 of file itkSpatialObject.h.

◆ GetModifiableObjectToParentTransform()

template<unsigned int VDimension = 3>
virtual TransformType* itk::SpatialObject< VDimension >::GetModifiableObjectToParentTransform ( )
virtual

Object Identification Number

◆ GetModifiableObjectToWorldTransform()

template<unsigned int VDimension = 3>
virtual TransformType* itk::SpatialObject< VDimension >::GetModifiableObjectToWorldTransform ( )
virtual

Object Identification Number

◆ GetMTime()

template<unsigned int VDimension = 3>
ModifiedTimeType itk::SpatialObject< VDimension >::GetMTime ( ) const
overridevirtual

Returns the latest modified time of the spatial object, and any of its components.

Reimplemented from itk::Object.

◆ GetMyBoundingBoxInObjectSpace()

template<unsigned int VDimension = 3>
virtual const BoundingBoxType* itk::SpatialObject< VDimension >::GetMyBoundingBoxInObjectSpace ( ) const
virtual

Get a pointer to the axis-aligned bounding box of the object in world space. This box is computed by ComputeMyBoundingBox which is called by Update().

◆ GetMyBoundingBoxInWorldSpace()

template<unsigned int VDimension = 3>
virtual const BoundingBoxType* itk::SpatialObject< VDimension >::GetMyBoundingBoxInWorldSpace ( ) const
virtual

Get a pointer to the axis-aligned bounding box of the object in world space. This box is computed by ComputeMyBoundingBox which is called by Update().

◆ GetMyMTime()

template<unsigned int VDimension = 3>
ModifiedTimeType itk::SpatialObject< VDimension >::GetMyMTime ( ) const
inline

Returns the latest modified time of the spatial object, but not the modification time of the children

Definition at line 192 of file itkSpatialObject.h.

◆ GetNameOfClass()

template<unsigned int VDimension = 3>
virtual const char* itk::SpatialObject< VDimension >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

Reimplemented in itk::ContourSpatialObject< TDimension >, itk::BlobSpatialObject< TDimension >, itk::ImageMaskSpatialObject< TDimension, TPixel >, itk::LineSpatialObject< TDimension >, itk::TubeSpatialObject< TDimension, TSpatialObjectPointType >, itk::TubeSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >, itk::DTITubeSpatialObject< TDimension >, itk::ImageSpatialObject< TDimension, TPixelType >, itk::SurfaceSpatialObject< TDimension >, itk::ImageSpatialObject< TDimension, TPixel >, itk::LandmarkSpatialObject< TDimension >, itk::EllipseSpatialObject< TDimension >, itk::MeshSpatialObject< TMesh >, itk::GaussianSpatialObject< TDimension >, itk::PointBasedSpatialObject< TDimension, TSpatialObjectPointType >, itk::PointBasedSpatialObject< TDimension, ContourSpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension, SurfaceSpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension >, itk::PointBasedSpatialObject< TDimension, SpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension, LineSpatialObjectPoint< TDimension > >, itk::PointBasedSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >, itk::PolygonSpatialObject< TDimension >, itk::ArrowSpatialObject< TDimension >, itk::BoxSpatialObject< TDimension >, itk::GroupSpatialObject< TDimension >, and itk::GroupSpatialObject< 3 >.

◆ GetNextAvailableId()

template<unsigned int VDimension = 3>
int itk::SpatialObject< VDimension >::GetNextAvailableId ( ) const

Generate a unique Id

◆ GetNumberOfChildren()

template<unsigned int VDimension = 3>
unsigned int itk::SpatialObject< VDimension >::GetNumberOfChildren ( unsigned int  depth = 0,
const std::string &  name = "" 
) const

Returns the number of children currently assigned to the object.

◆ GetObjectById()

template<unsigned int VDimension = 3>
SpatialObject<VDimension>* itk::SpatialObject< VDimension >::GetObjectById ( int  id)

Return a SpatialObject given its ID, if it is a child

◆ GetObjectDimension()

template<unsigned int VDimension = 3>
unsigned int itk::SpatialObject< VDimension >::GetObjectDimension ( ) const
inline

Get the dimensionality of the object

Definition at line 124 of file itkSpatialObject.h.

◆ GetObjectToParentTransform()

template<unsigned int VDimension = 3>
virtual const TransformType* itk::SpatialObject< VDimension >::GetObjectToParentTransform ( ) const
virtual

Object Identification Number

◆ GetObjectToParentTransformInverse()

template<unsigned int VDimension = 3>
const TransformType* itk::SpatialObject< VDimension >::GetObjectToParentTransformInverse ( ) const

Object Identification Number

◆ GetObjectToWorldTransform()

template<unsigned int VDimension = 3>
virtual const TransformType* itk::SpatialObject< VDimension >::GetObjectToWorldTransform ( ) const
virtual

Object Identification Number

◆ GetObjectToWorldTransformInverse()

template<unsigned int VDimension = 3>
const TransformType* itk::SpatialObject< VDimension >::GetObjectToWorldTransformInverse ( ) const

Object Identification Number

◆ GetParent() [1/2]

template<unsigned int VDimension = 3>
virtual Self* itk::SpatialObject< VDimension >::GetParent ( )
virtual

Return a pointer to the parent object in the hierarchy tree

◆ GetParent() [2/2]

template<unsigned int VDimension = 3>
virtual const Self* itk::SpatialObject< VDimension >::GetParent ( ) const
virtual

Return a pointer to the parent object in the hierarchy tree

◆ GetParentId()

template<unsigned int VDimension = 3>
virtual const int& itk::SpatialObject< VDimension >::GetParentId ( ) const
virtual

Object Identification Number

◆ GetProperty() [1/2]

template<unsigned int VDimension = 3>
PropertyType& itk::SpatialObject< VDimension >::GetProperty ( )
inline

Object Identification Number

Definition at line 179 of file itkSpatialObject.h.

◆ GetProperty() [2/2]

template<unsigned int VDimension = 3>
const PropertyType& itk::SpatialObject< VDimension >::GetProperty ( ) const
inline

Returns a pointer to the property object applied to this class.

Definition at line 173 of file itkSpatialObject.h.

◆ GetRequestedRegion()

template<unsigned int VDimension = 3>
virtual const RegionType& itk::SpatialObject< VDimension >::GetRequestedRegion ( ) const
inlinevirtual

Get the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter).

See also
ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

Definition at line 522 of file itkSpatialObject.h.

◆ GetTypeName()

template<unsigned int VDimension = 3>
virtual const std::string itk::SpatialObject< VDimension >::GetTypeName ( ) const
inlinevirtual

Get the typename of the SpatialObject

Definition at line 148 of file itkSpatialObject.h.

◆ HasParent()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::HasParent ( ) const
virtual

Return true if the object has a parent object. Basically, only the root object , or some isolated objects should return false.

◆ InternalClone()

template<unsigned int VDimension = 3>
LightObject::Pointer itk::SpatialObject< VDimension >::InternalClone ( ) const
overrideprotectedvirtual

Object Identification Number

Reimplemented from itk::LightObject.

Reimplemented in itk::TubeSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >.

◆ IsEvaluableAtChildrenInObjectSpace()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::IsEvaluableAtChildrenInObjectSpace ( const PointType &  point,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

Object Identification Number

◆ IsEvaluableAtInObjectSpace()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::IsEvaluableAtInObjectSpace ( const PointType &  point,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

Returns true if the object can provide a "meaningful" value at a point. Often defaults to returning same answer as IsInsideInWorldSpace, but certain objects influence space beyond their spatial extent, e.g., an RFA Needle Spatial Object can cause a burn that extends beyond the tip of the needle.

◆ IsEvaluableAtInWorldSpace()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::IsEvaluableAtInWorldSpace ( const PointType &  point,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

World space equivalent to IsEvaluableAtInObjectSpace

◆ IsInsideChildrenInObjectSpace()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::IsInsideChildrenInObjectSpace ( const PointType &  point,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

Object Identification Number

◆ IsInsideInObjectSpace() [1/2]

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::IsInsideInObjectSpace ( const PointType &  point) const
virtual

Returns false by default, but is overridden in order to return true if a point is inside the object.

◆ IsInsideInObjectSpace() [2/2]

template<unsigned int VDimension = 3>
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 in object space.

◆ IsInsideInWorldSpace()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::IsInsideInWorldSpace ( const PointType &  point,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

World space equivalent to IsInsideInObjectSpace

◆ New()

template<unsigned int VDimension = 3>
static Pointer itk::SpatialObject< VDimension >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Object Identification Number

Reimplemented from itk::DataObject.

Reimplemented in itk::TubeSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >.

◆ ProtectedComputeObjectToWorldTransform()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::ProtectedComputeObjectToWorldTransform ( )
protected

Compute the World transform when the local transform is set This function should be called each time the local transform has been modified

◆ RemoveAllChildren()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::RemoveAllChildren ( unsigned int  depth = MaximumDepth)

Remove all children to a given depth

◆ RemoveChild()

template<unsigned int VDimension = 3>
bool itk::SpatialObject< VDimension >::RemoveChild ( Self *  pointer)

Remove the object passed as arguments from the list of children.

◆ RequestedRegionIsOutsideOfTheBufferedRegion()

template<unsigned int VDimension = 3>
bool itk::SpatialObject< VDimension >::RequestedRegionIsOutsideOfTheBufferedRegion ( )
overridevirtual

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented from itk::DataObject.

◆ SetBufferedRegion()

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::SetBufferedRegion ( const RegionType &  region)
virtual

Set the region object that defines the size and starting index of the region of the image currently loaded in memory.

See also
ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

◆ SetChildren()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::SetChildren ( ChildrenListType &  children)

Set the list of pointers to children to the list passed as argument.

◆ SetDefaultInsideValue()

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::SetDefaultInsideValue ( double  _arg)
virtual

Set/Get the default inside value (ValueAtInWorldSpace()) of the object. Default is 1.0

◆ SetDefaultOutsideValue()

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::SetDefaultOutsideValue ( double  _arg)
virtual

Set/Get the default outside value (ValueAtInWorldSpace()) of the object. Default is 0.0

◆ SetId()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::SetId ( int  id)

Get/Set the ID

◆ SetLargestPossibleRegion()

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::SetLargestPossibleRegion ( const RegionType &  region)
virtual

Set the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.

See also
ImageRegion, SetBufferedRegion(), SetRequestedRegion()

◆ SetObjectToParentTransform()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::SetObjectToParentTransform ( const TransformType *  transform)

Transforms points from the object-specific "physical" space to the "physical" space of its parent object.

◆ SetObjectToWorldTransform()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::SetObjectToWorldTransform ( const TransformType *  transform)

This defines the transformation from the global coordinate frame. By setting this transform, the object transform is updated

◆ SetParent()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::SetParent ( Self *  parent)

Set the pointer to the parent object in the tree hierarchy. Updates the ObjectToParentTransform to keep the object from moving in space.

◆ SetParentId()

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::SetParentId ( int  _arg)
virtual

Set/Get the parent Identification number

◆ SetProperty()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::SetProperty ( const PropertyType &  property)
inline

Set the property applied to the object.

Definition at line 164 of file itkSpatialObject.h.

◆ SetRequestedRegion() [1/2]

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::SetRequestedRegion ( const DataObject *  data)
overridevirtual

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to an ImageBase.

Reimplemented from itk::DataObject.

◆ SetRequestedRegion() [2/2]

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::SetRequestedRegion ( const RegionType &  region)
virtual

Set the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter).

See also
ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

◆ SetRequestedRegionToLargestPossibleRegion()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::SetRequestedRegionToLargestPossibleRegion ( )
overridevirtual

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Reimplemented from itk::DataObject.

◆ SetTypeName()

template<unsigned int VDimension = 3>
virtual void itk::SpatialObject< VDimension >::SetTypeName ( std::string  _arg)
virtual

Set the typename of the SpatialObject. Use cautiously - Conversion, Factory, and IO methods depend on standard naming. Can be used to prepend a subtype to a typename.

◆ Update()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::Update ( )
overridevirtual

Update - Optionally used to compute a world-coordinate representation of the object. Object-dependent implementation.

Reimplemented from itk::DataObject.

◆ UpdateOutputInformation()

template<unsigned int VDimension = 3>
void itk::SpatialObject< VDimension >::UpdateOutputInformation ( )
overridevirtual

Update the information for this DataObject so that it can be used as an output of a ProcessObject. This method is used the pipeline mechanism to propagate information and initialize the meta data associated with a DataObject. This method calls its source's ProcessObject::UpdateOutputInformation() which determines modified times, LargestPossibleRegions, and any extra meta data like spacing, origin, etc.

Reimplemented from itk::DataObject.

◆ ValueAtChildrenInObjectSpace()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::ValueAtChildrenInObjectSpace ( const PointType &  point,
double &  value,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

Object Identification Number

◆ ValueAtInObjectSpace()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::ValueAtInObjectSpace ( const PointType &  point,
double &  value,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

Returns the value at a point. Returns true if that value is valid

◆ ValueAtInWorldSpace()

template<unsigned int VDimension = 3>
virtual bool itk::SpatialObject< VDimension >::ValueAtInWorldSpace ( const PointType &  point,
double &  value,
unsigned int  depth = 0,
const std::string &  name = "" 
) const
virtual

World space equivalent to ValueAtInObjectSpace

◆ VerifyRequestedRegion()

template<unsigned int VDimension = 3>
bool itk::SpatialObject< VDimension >::VerifyRequestedRegion ( )
overridevirtual

Verify that the RequestedRegion is within the LargestPossibleRegion. If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possible satisfy the request. This method returns true if the request can be satisfied and returns fails if the request cannot. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception is the requested region is not within the LargestPossibleRegion.

Reimplemented from itk::DataObject.

Member Data Documentation

◆ m_BufferedRegion

template<unsigned int VDimension = 3>
RegionType itk::SpatialObject< VDimension >::m_BufferedRegion
private

Object Identification Number

Definition at line 659 of file itkSpatialObject.h.

◆ m_ChildrenList

template<unsigned int VDimension = 3>
ChildrenListType itk::SpatialObject< VDimension >::m_ChildrenList
private

Object Identification Number

Definition at line 672 of file itkSpatialObject.h.

◆ m_DefaultInsideValue

template<unsigned int VDimension = 3>
double itk::SpatialObject< VDimension >::m_DefaultInsideValue { 1.0 }
private

Default inside value for the ValueAtInWorldSpace()

Definition at line 675 of file itkSpatialObject.h.

◆ m_DefaultOutsideValue

template<unsigned int VDimension = 3>
double itk::SpatialObject< VDimension >::m_DefaultOutsideValue { 0.0 }
private

Default outside value for the ValueAtInWorldSpace()

Definition at line 678 of file itkSpatialObject.h.

◆ m_FamilyBoundingBoxInObjectSpace

template<unsigned int VDimension = 3>
const BoundingBoxPointer itk::SpatialObject< VDimension >::m_FamilyBoundingBoxInObjectSpace { BoundingBoxType::New() }
private

Object Identification Number

Definition at line 663 of file itkSpatialObject.h.

◆ m_FamilyBoundingBoxInWorldSpace

template<unsigned int VDimension = 3>
const BoundingBoxPointer itk::SpatialObject< VDimension >::m_FamilyBoundingBoxInWorldSpace { BoundingBoxType::New() }
private

Object Identification Number

Definition at line 664 of file itkSpatialObject.h.

◆ m_Id

template<unsigned int VDimension = 3>
int itk::SpatialObject< VDimension >::m_Id { -1 }
private

Object Identification Number

Definition at line 647 of file itkSpatialObject.h.

◆ m_LargestPossibleRegion

template<unsigned int VDimension = 3>
RegionType itk::SpatialObject< VDimension >::m_LargestPossibleRegion
private

Object Identification Number

Definition at line 657 of file itkSpatialObject.h.

◆ m_MyBoundingBoxInObjectSpace

template<unsigned int VDimension = 3>
const BoundingBoxPointer itk::SpatialObject< VDimension >::m_MyBoundingBoxInObjectSpace { BoundingBoxType::New() }
private

Object Identification Number

Definition at line 661 of file itkSpatialObject.h.

◆ m_MyBoundingBoxInWorldSpace

template<unsigned int VDimension = 3>
const BoundingBoxPointer itk::SpatialObject< VDimension >::m_MyBoundingBoxInWorldSpace { BoundingBoxType::New() }
private

Object Identification Number

Definition at line 662 of file itkSpatialObject.h.

◆ m_ObjectToParentTransform

template<unsigned int VDimension = 3>
const TransformPointer itk::SpatialObject< VDimension >::m_ObjectToParentTransform { TransformType::New() }
private

Object Identification Number

Definition at line 666 of file itkSpatialObject.h.

◆ m_ObjectToParentTransformInverse

template<unsigned int VDimension = 3>
const TransformPointer itk::SpatialObject< VDimension >::m_ObjectToParentTransformInverse { TransformType::New() }
private

Object Identification Number

Definition at line 667 of file itkSpatialObject.h.

◆ m_ObjectToWorldTransform

template<unsigned int VDimension = 3>
const TransformPointer itk::SpatialObject< VDimension >::m_ObjectToWorldTransform { TransformType::New() }
private

Object Identification Number

Definition at line 669 of file itkSpatialObject.h.

◆ m_ObjectToWorldTransformInverse

template<unsigned int VDimension = 3>
const TransformPointer itk::SpatialObject< VDimension >::m_ObjectToWorldTransformInverse { TransformType::New() }
private

Object Identification Number

Definition at line 670 of file itkSpatialObject.h.

◆ m_Parent

template<unsigned int VDimension = 3>
Self* itk::SpatialObject< VDimension >::m_Parent { nullptr }
private

Object Identification Number

Definition at line 655 of file itkSpatialObject.h.

◆ m_ParentId

template<unsigned int VDimension = 3>
int itk::SpatialObject< VDimension >::m_ParentId { -1 }
private

Object Identification Number

Definition at line 654 of file itkSpatialObject.h.

◆ m_Property

template<unsigned int VDimension = 3>
PropertyType itk::SpatialObject< VDimension >::m_Property
private

Object Identification Number

Definition at line 652 of file itkSpatialObject.h.

◆ m_RequestedRegion

template<unsigned int VDimension = 3>
RegionType itk::SpatialObject< VDimension >::m_RequestedRegion
private

Object Identification Number

Definition at line 658 of file itkSpatialObject.h.

◆ m_TypeName

template<unsigned int VDimension = 3>
std::string itk::SpatialObject< VDimension >::m_TypeName { "SpatialObject" }
private

Type of spatial object

Definition at line 650 of file itkSpatialObject.h.

◆ MaximumDepth

template<unsigned int VDimension = 3>
constexpr unsigned int itk::SpatialObject< VDimension >::MaximumDepth = 9999999
staticconstexpr

Definition at line 68 of file itkSpatialObject.h.

◆ ObjectDimension

template<unsigned int VDimension = 3>
constexpr ObjectDimensionType itk::SpatialObject< VDimension >::ObjectDimension = VDimension
staticconstexpr

Definition at line 66 of file itkSpatialObject.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Thu Apr 1 2021 02:33:17 for ITK by   doxygen 1.8.16