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.

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
void	AddChild (Self *pointer)

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

bool	CheckIdValidity () const

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

virtual bool	ComputeMyBoundingBox () const

void	ComputeObjectToParentTransform ()

void	ComputeObjectToWorldTransform ()

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

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

virtual const char *	GetNameOfClass () 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 const Self *	GetParent () const

virtual Self *	GetParent ()

const PropertyType &	GetProperty () const

PropertyType &	GetProperty ()

virtual const RegionType &	GetRequestedRegion () const

virtual const 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

virtual 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

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

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

void	RemoveAllChildren (unsigned int depth=MaximumDepth)

bool	RemoveChild (Self *object)

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)

virtual void	SetRequestedRegion (const RegionType &region)

void	SetRequestedRegion (const DataObject *data) override

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

virtual 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	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime () const

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp () const

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

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

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

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 noexceptoverride

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::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	SetGlobalReleaseDataFlag (bool val)

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

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

static Pointer	New ()

Static Public Attributes
static constexpr unsigned int	MaximumDepth = 9999999

static constexpr ObjectDimensionType	ObjectDimension = VDimension

Protected Member Functions
BoundingBoxType *	GetModifiableMyBoundingBoxInObjectSpace () const

LightObject::Pointer	InternalClone () const override

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

	SpatialObject ()

	~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 &time)

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

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