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 index 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 ValueAt(), IsEvaluableAt(), and IsInside(), each of which has a meaning specific to each particular object type.

Examples:: SpatialObjects/SpatialObjectTransforms.cxx.

Definition at line 59 of file itkSpatialObject.h.

Public Types
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 Types inherited from itk::DataObject
typedef SmartPointer< const Self >	ConstPointer

typedef std::string	DataObjectIdentifierType

typedef std::vector< Pointer > ::size_type	DataObjectPointerArraySizeType

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
void	AddSpatialObject (Self *pointer)

virtual void	Clear (void)

virtual bool	ComputeBoundingBox () const

virtual bool	ComputeLocalBoundingBox () const

void	ComputeObjectToParentTransform (void)

void	ComputeObjectToWorldTransform (void)

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

virtual void	DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=ITK_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=ITK_NULLPTR) const

const TransformType *	GetIndexToObjectTransform (void) 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 ()

virtual ModifiedTimeType	GetMTime (void) const ITK_OVERRIDE

virtual const char *	GetNameOfClass () const

TransformType *	GetNodeToParentNodeTransform (void)

const TransformType *	GetNodeToParentNodeTransform (void) const

unsigned int	GetNumberOfChildren (unsigned int depth=0, char *name=ITK_NULLPTR) const

unsigned int	GetObjectDimension (void) const

unsigned long	GetObjectMTime (void) const

TransformType *	GetObjectToNodeTransform (void)

const TransformType *	GetObjectToNodeTransform (void) const

TransformType *	GetObjectToParentTransform (void)

const TransformType *	GetObjectToParentTransform (void) const

virtual const Self *	GetParent (void) const

virtual Self *	GetParent (void)

virtual const RegionType &	GetRequestedRegion () const

virtual const double *	GetSpacing () const

virtual std::string	GetSpatialObjectTypeAsString () const

unsigned long	GetTransformMTime (void)

virtual const TreeNodeType *	GetTreeNode () const

virtual const char *	GetTypeName (void) const

unsigned long	GetWorldTransformMTime (void)

virtual bool	HasParent (void) const

virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=ITK_NULLPTR) const

virtual bool	IsInside (const PointType &point, unsigned int depth=0, char *name=ITK_NULLPTR) 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) ITK_OVERRIDE

void	SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])

virtual void	SetTreeNode (TreeNodeType *_arg)

virtual void	Update (void) ITK_OVERRIDE

virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=ITK_NULLPTR) const


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

virtual void	UpdateOutputInformation () ITK_OVERRIDE

virtual void	SetRequestedRegionToLargestPossibleRegion () ITK_OVERRIDE

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion () ITK_OVERRIDE

virtual bool	VerifyRequestedRegion () ITK_OVERRIDE

PropertyType *	GetProperty (void)

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

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

void	DisconnectPipeline ()

bool	GetDataReleased () const

virtual const bool &	GetReleaseDataFlag () const

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

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

virtual void	Register () const ITK_OVERRIDE

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) ITK_OVERRIDE

virtual void	UnRegister () const ITK_OVERRIDE

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 const unsigned int	MaximumDepth = 9999999

static const unsigned int	ObjectDimension = VDimension

Protected Member Functions
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	PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE

virtual void	SetDimension (unsigned int _arg)

bool	SetInternalInverseTransformToWorldToIndexTransform () const

virtual void	SetTypeName (std::string _arg)

	SpatialObject ()

virtual	~SpatialObject ()

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

virtual void	PropagateResetPipeline ()

	~DataObject ()

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

virtual	~LightObject ()

Private Member Functions
void	operator= (const Self &)

	SpatialObject (const Self &)

Private Attributes
AffineGeometryFramePointer	m_AffineGeometryFrame

unsigned int	m_BoundingBoxChildrenDepth

std::string	m_BoundingBoxChildrenName

BoundingBoxPointer	m_Bounds

ModifiedTimeType	m_BoundsMTime

RegionType	m_BufferedRegion

double	m_DefaultInsideValue

double	m_DefaultOutsideValue

unsigned int	m_Dimension

int	m_Id

TransformPointer	m_IndexToWorldTransform

ChildrenListType	m_InternalChildrenList

TransformPointer	m_InternalInverseTransform

RegionType	m_LargestPossibleRegion

TransformPointer	m_ObjectToParentTransform

TransformPointer	m_ObjectToWorldTransform

OffsetValueType	m_OffsetTable [3+1]

int	m_ParentId

PropertyPointer	m_Property

RegionType	m_RequestedRegion

TreeNodeType::Pointer	m_TreeNode

std::string	m_TypeName

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock