ITK: itk::SpatialObject< TDimension > Class Template Reference

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::AddSpatialObject ( Self * pointer )

Add an object to the list of children.

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::Clear ( void ) [virtual]

Clear the spatial object by deleting all lists of children and subchildren

Reimplemented in itk::TubeSpatialObject< TDimension, TTubePointType >, itk::TubeSpatialObject< TDimension, itk::DTITubeSpatialObjectPoint< TDimension > >, and itk::TubeSpatialObject< TDimension, itk::VesselTubeSpatialObjectPoint< TDimension > >.

template<unsigned int TDimension = 3>

virtual bool itk::SpatialObject< TDimension >::ComputeBoundingBox ( ) const [virtual]

Compute an axis-aligned bounding box for an object and its selected children, down to a specified depth. After computation, the resulting bounding box is stored in this->m_Bounds.

By default, the bounding box children depth is maximum, meaning that the bounding box for the object and all its recursive children is computed. This depth can be set (before calling ComputeBoundingBox) using SetBoundingBoxChildrenDepth().

By calling SetBoundingBoxChildrenName(), it is possible to restrict the bounding box computation to objects of a specified type or family of types. The spatial objects included in the computation are those whose typenames share, as their initial substring, the string specified via SetBoundingBoxChildrenName(). The root spatial object (on which the method is called) is not treated specially. If its typename does not match the bounding box children name, then it is not included in the bounding box computation, but its descendents that match the string are included.

template<unsigned int TDimension = 3>

IndexType itk::SpatialObject< TDimension >::ComputeIndex ( OffsetValueType offset ) const [inline]

Compute the index of the pixel at a specified offset from the beginning of the buffered region.

Definition at line 316 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

virtual bool itk::SpatialObject< TDimension >::ComputeLocalBoundingBox ( void ) const [inline, virtual]

Compute an axis-aligned bounding box for an object and its selected children, down to a specified depth. After computation, the resulting bounding box is stored in this->m_Bounds.

By default, the bounding box children depth is maximum, meaning that the bounding box for the object and all its recursive children is computed. This depth can be set (before calling ComputeBoundingBox) using SetBoundingBoxChildrenDepth().

By calling SetBoundingBoxChildrenName(), it is possible to restrict the bounding box computation to objects of a specified type or family of types. The spatial objects included in the computation are those whose typenames share, as their initial substring, the string specified via SetBoundingBoxChildrenName(). The root spatial object (on which the method is called) is not treated specially. If its typename does not match the bounding box children name, then it is not included in the bounding box computation, but its descendents that match the string are included.

Definition at line 505 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::ComputeObjectToParentTransform ( void )

Compute the Local transform when the global transform is set

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::ComputeObjectToWorldTransform ( void )

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

template<unsigned int TDimension = 3>

OffsetValueType itk::SpatialObject< TDimension >::ComputeOffset ( const IndexType & ind ) const [inline]

Compute an offset from the beginning of the buffer for a pixel at the specified index.

Definition at line 296 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::ComputeOffsetTable ( ) [protected]

Calculate the offsets needed to move from one pixel to the next along a row, column, slice, volume, etc. These offsets are based on the size of the BufferedRegion. This should be called after the BufferedRegion is set.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::CopyInformation ( const DataObject * data ) [virtual]

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.

Reimplemented in itk::EllipseSpatialObject< TDimension >, itk::TubeSpatialObject< TDimension, TTubePointType >, itk::TubeSpatialObject< TDimension, itk::DTITubeSpatialObjectPoint< TDimension > >, and itk::TubeSpatialObject< TDimension, itk::VesselTubeSpatialObjectPoint< TDimension > >.

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

void itk::DataObject::DataHasBeenGenerated ( ) [inherited]

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::DerivativeAt	(	const PointType &	point,
		short unsigned int	order,
		OutputVectorType &	value,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)			`[virtual]`

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

void itk::DataObject::DisconnectPipeline ( ) [inherited]

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

template<unsigned int TDimension = 3>

bool itk::SpatialObject< TDimension >::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 210 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

virtual const AffineGeometryFrameType* itk::SpatialObject< TDimension >::GetAffineGeometryFrame ( ) [virtual]

Set/Get the AffineGeometryFrame

template<unsigned int TDimension = 3>

virtual BoundingBoxType* itk::SpatialObject< TDimension >::GetBoundingBox ( ) const [virtual]

Get the bounding box of the object. This function calls ComputeBoundingBox()

template<unsigned int TDimension = 3>

virtual const unsigned int& itk::SpatialObject< TDimension >::GetBoundingBoxChildrenDepth ( ) [virtual]

template<unsigned int TDimension = 3>

virtual const std::string& itk::SpatialObject< TDimension >::GetBoundingBoxChildrenName ( ) [virtual]

template<unsigned int TDimension = 3>

virtual const BoundingBoxType* itk::SpatialObject< TDimension >::GetBounds ( ) [protected, virtual]

template<unsigned int TDimension = 3>

virtual const RegionType& itk::SpatialObject< TDimension >::GetBufferedRegion ( ) const [inline, virtual]

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 260 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

virtual ChildrenListType* itk::SpatialObject< TDimension >::GetChildren	(	unsigned int	depth = `0`,
		char *	name = `NULL`
	)			const `[virtual]`

Returns a list of pointer to the children affiliated to this object. A depth of 0 returns the immediate childred. 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.

Command* itk::Object::GetCommand ( unsigned long tag ) [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::DataObject::GetDataReleased ( ) const [inline, inherited]

Get the flag indicating the data has been released.

Definition at line 334 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

template<unsigned int TDimension = 3>

virtual double itk::SpatialObject< TDimension >::GetDefaultInsideValue ( ) const [virtual]

template<unsigned int TDimension = 3>

virtual double itk::SpatialObject< TDimension >::GetDefaultOutsideValue ( ) const [virtual]

template<unsigned int TDimension = 3>

virtual const unsigned int& itk::SpatialObject< TDimension >::GetDimension ( ) [protected, virtual]

static bool itk::DataObject::GetGlobalReleaseDataFlag ( ) [static, inherited]

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

template<unsigned int TDimension = 3>

virtual const int& itk::SpatialObject< TDimension >::GetId ( ) [virtual]

Get/Set the ID

template<unsigned int TDimension = 3>

const TransformType* itk::SpatialObject< TDimension >::GetIndexToObjectTransform ( void ) const

template<unsigned int TDimension = 3>

TransformType* itk::SpatialObject< TDimension >::GetIndexToObjectTransform ( void )

Transform points from the internal data coordinate system of the object (typically the indices of the image from which the object was defined) to "physical" space (which accounts for the spacing, orientation, and offset of the indices)

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetSpacing(), and itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::SetSpacing().

template<unsigned int TDimension = 3>

virtual const TransformType* itk::SpatialObject< TDimension >::GetIndexToWorldTransform ( ) [virtual]

template<unsigned int TDimension = 3>

virtual TransformType* itk::SpatialObject< TDimension >::GetIndexToWorldTransform ( ) [virtual]

template<unsigned int TDimension = 3>

virtual const TransformType* itk::SpatialObject< TDimension >::GetInternalInverseTransform ( ) [protected, virtual]

template<unsigned int TDimension = 3>

virtual const RegionType& itk::SpatialObject< TDimension >::GetLargestPossibleRegion ( ) const [inline, virtual]

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 249 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

unsigned int itk::SpatialObject< TDimension >::GetMaximumDepth ( ) [inline]

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

Definition at line 82 of file itkSpatialObject.h.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

template<unsigned int TDimension = 3>

unsigned long itk::SpatialObject< TDimension >::GetMTime ( void ) const [virtual]

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

Reimplemented from itk::Object.

Reimplemented in itk::ImageSpatialObject< TDimension, TPixelType >, itk::MeshSpatialObject< TMesh >, and itk::ImageSpatialObject< TDimension, unsigned char >.

template<unsigned int TDimension = 3>

virtual const char* itk::SpatialObject< TDimension >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::DataObject.

template<unsigned int TDimension = 3>

const TransformType* itk::SpatialObject< TDimension >::GetNodeToParentNodeTransform ( void ) const

template<unsigned int TDimension = 3>

TransformType* itk::SpatialObject< TDimension >::GetNodeToParentNodeTransform ( void )

template<unsigned int TDimension = 3>

unsigned int itk::SpatialObject< TDimension >::GetNumberOfChildren	(	unsigned int	depth = `0`,
		char *	name = `NULL`
	)			const

Returns the number of children currently assigned to the object.

template<unsigned int TDimension = 3>

unsigned int itk::SpatialObject< TDimension >::GetObjectDimension ( void ) const [inline]

Get the dimensionality of the object

Definition at line 150 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

unsigned long itk::SpatialObject< TDimension >::GetObjectMTime ( void ) const [inline]

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

Definition at line 230 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

const TransformType* itk::SpatialObject< TDimension >::GetObjectToNodeTransform ( void ) const

template<unsigned int TDimension = 3>

TransformType* itk::SpatialObject< TDimension >::GetObjectToNodeTransform ( void )

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

template<unsigned int TDimension = 3>

const TransformType* itk::SpatialObject< TDimension >::GetObjectToParentTransform ( void ) const

template<unsigned int TDimension = 3>

TransformType* itk::SpatialObject< TDimension >::GetObjectToParentTransform ( void )

template<unsigned int TDimension = 3>

virtual const TransformType* itk::SpatialObject< TDimension >::GetObjectToWorldTransform ( ) [virtual]

template<unsigned int TDimension = 3>

virtual TransformType* itk::SpatialObject< TDimension >::GetObjectToWorldTransform ( ) [virtual]

template<unsigned int TDimension = 3>

const OffsetValueType* itk::SpatialObject< TDimension >::GetOffsetTable ( ) const [inline]

Get the offset table. The offset table gives increments for moving from one pixel to next in the current row, column, slice, etc.. This table if of size [VImageDimension+1], because its values are computed progressively as: {1, N1, N1*N2, N1*N2*N3,...,(N1*...*Nn)} Where the values {N1,...,Nn} are the elements of the BufferedRegion::Size array. The last element of the OffsetTable is equivalent to the BufferSize. Having a [VImageDimension+1] size array, simplifies the implementation of some data accessing algorithms.

Definition at line 291 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

virtual Self* itk::SpatialObject< TDimension >::GetParent ( void ) [virtual]

Return a pointer to the parent object in the hierarchy tree

template<unsigned int TDimension = 3>

virtual const Self* itk::SpatialObject< TDimension >::GetParent ( void ) const [virtual]

Return a pointer to the parent object in the hierarchy tree

template<unsigned int TDimension = 3>

virtual const int& itk::SpatialObject< TDimension >::GetParentId ( ) [virtual]

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( ) [virtual, inherited]

template<unsigned int TDimension = 3>

const PropertyType* itk::SpatialObject< TDimension >::GetProperty ( void ) const [inline]

Compute the index of the pixel at a specified offset from the beginning of the buffered region.

Definition at line 382 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

PropertyType* itk::SpatialObject< TDimension >::GetProperty ( void )

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

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 98 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( ) [virtual, inherited]

template<unsigned int TDimension = 3>

virtual const RegionType& itk::SpatialObject< TDimension >::GetRequestedRegion ( ) const [inline, virtual]

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 279 of file itkSpatialObject.h.

SmartPointerForwardReference<ProcessObject> itk::DataObject::GetSource ( ) const [inherited]

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const [inherited]

Which of the source's outputs corresponds to this data object?

template<unsigned int TDimension = 3>

virtual const double* itk::SpatialObject< TDimension >::GetSpacing ( void ) const [inline, virtual]

Get the spacing of the spatial object.

Definition at line 417 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

virtual std::string itk::SpatialObject< TDimension >::GetSpatialObjectTypeAsString ( ) const [virtual]

Return the type of the spatial object as a string This is used by the SpatialObjectFactory

template<unsigned int TDimension = 3>

unsigned long itk::SpatialObject< TDimension >::GetTransformMTime ( void )

Return the Modified time of the LocalToWorldTransform

template<unsigned int TDimension = 3>

virtual const TreeNodeType* itk::SpatialObject< TDimension >::GetTreeNode ( ) [virtual]

template<unsigned int TDimension = 3>

virtual TreeNodeType* itk::SpatialObject< TDimension >::GetTreeNode ( ) [virtual]

Return a raw pointer to the node container

template<unsigned int TDimension = 3>

virtual const char* itk::SpatialObject< TDimension >::GetTypeName ( void ) const [inline, virtual]

Get the typename of the SpatialObject

Definition at line 142 of file itkSpatialObject.h.

virtual unsigned long itk::DataObject::GetUpdateMTime ( ) const [virtual, inherited]

MTime for the last time this DataObject was generated.

template<unsigned int TDimension = 3>

unsigned long itk::SpatialObject< TDimension >::GetWorldTransformMTime ( void )

Return the Modified time of the WorldToLocalTransform

void itk::DataObject::GlobalReleaseDataFlagOff ( ) [inline, inherited]

Definition at line 319 of file itkDataObject.h.

void itk::DataObject::GlobalReleaseDataFlagOn ( ) [inline, inherited]

Definition at line 317 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::DataObject::Graft ( const DataObject * ) [inline, virtual, inherited]

Method for grafting the content of one data object into another one. This method is intended to be overloaded by derived classes. Each one of them should use dynamic_casting in order to verify that the grafted object is actually of the same type as the class on which the Graft() method was invoked.

Definition at line 453 of file itkDataObject.h.

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

template<unsigned int TDimension = 3>

virtual bool itk::SpatialObject< TDimension >::HasParent ( void ) const [virtual]

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

virtual void itk::DataObject::Initialize ( ) [virtual, inherited]

Restore the data object to its initial state. This means releasing memory.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

template<unsigned int TDimension = 3>

virtual bool itk::SpatialObject< TDimension >::IsEvaluableAt	(	const PointType &	point,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)			const `[virtual]`

Returns true if the object can provide a "meaningful" value at a point. Often defaults to returning same answer as IsInside, 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.

Reimplemented in itk::ImageSpatialObject< TDimension, unsigned char >.

template<unsigned int TDimension = 3>

virtual bool itk::SpatialObject< TDimension >::IsInside	(	const PointType &	point,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)			const `[virtual]`

Returns true if a point is inside the object.

Reimplemented in itk::ImageSpatialObject< TDimension, unsigned char >.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::Evaluate().

template<unsigned int TDimension = 3>

itk::SpatialObject< TDimension >::itkStaticConstMacro	(	ObjectDimension	,
		unsigned	int,
		TDimension
	)

Dimension of the object. This constant is used by functions that are templated over SpatialObject type when they need compile time access to the dimension of the object.

template<unsigned int TDimension = 3>

itk::SpatialObject< TDimension >::itkStaticConstMacro	(	MaximumDepth	,
		unsigned	int,
		9999999
	)

virtual void itk::Object::Modified ( ) const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, itk::Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<unsigned int TDimension = 3>

static Pointer itk::SpatialObject< TDimension >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

virtual void itk::DataObject::PrepareForNewData ( ) [inline, virtual, inherited]

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 389 of file itkDataObject.h.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)			const `[inherited]`

Cause the object to print itself out.

Referenced by itk::WeakPointer< itk::ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::DataObject.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

virtual void itk::DataObject::PropagateRequestedRegion ( ) throw (InvalidRequestedRegionError) [virtual, inherited]

Methods to update the pipeline. Called internally by the pipeline mechanism.

virtual void itk::DataObject::PropagateResetPipeline ( ) [protected, virtual, inherited]

Propagate a call to ResetPipeline(). Called only from ProcessObject.

virtual void itk::Object::Register ( ) const [virtual, inherited]

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

void itk::DataObject::ReleaseData ( ) [inherited]

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

virtual void itk::DataObject::ReleaseDataFlagOff ( ) [virtual, inherited]

virtual void itk::DataObject::ReleaseDataFlagOn ( ) [virtual, inherited]

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::RemoveSpatialObject ( Self * object )

Remove the object passed as arguments from the list of children. May this function should return a false value if the object to remove is not found in the list.

template<unsigned int TDimension = 3>

virtual bool itk::SpatialObject< TDimension >::RequestedRegionIsOutsideOfTheBufferedRegion ( ) [virtual]

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.

virtual void itk::DataObject::ResetPipeline ( ) [virtual, inherited]

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetAffineGeometryFrame ( AffineGeometryFrameType * _arg ) [virtual]

Set/Get the AffineGeometryFrame

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetBoundingBoxChildrenDepth ( unsigned int _arg ) [virtual]

Set/Get the depth at which the bounding box is computed

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetBoundingBoxChildrenName ( std::string _arg ) [virtual]

Set/Get the name of the children to consider when computing the bounding box

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::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()

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::SetChildren ( ChildrenListType & children )

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

void itk::Object::SetDebug ( bool debugFlag ) const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetDefaultInsideValue ( double _arg ) [virtual]

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

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetDefaultOutsideValue ( double _arg ) [virtual]

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

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetDimension ( unsigned int _arg ) [protected, virtual]

static void itk::DataObject::SetGlobalReleaseDataFlag ( const bool val ) [static, inherited]

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

This is a global flag that controls whether any debug, warning or error messages are displayed.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetId ( int _arg ) [virtual]

Get/Set the ID

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::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()

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::SetNodeToParentNodeTransform ( TransformType * transform )

These function are just calling the node container transforms

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::SetObjectToParentTransform ( TransformType * transform )

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

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::SetObjectToWorldTransform ( TransformType * transform )

This defines the transformation from the global coordinate frame. By setting this transform, the local transform is computed

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::SetParent ( Self * parent )

Set the pointer to the parent object in the tree hierarchy used for the spatial object patter.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetParentId ( int _arg ) [virtual]

Set/Get the parent Identification number

void itk::DataObject::SetPipelineMTime ( unsigned long time ) [inline, inherited]

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 373 of file itkDataObject.h.

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::SetProperty ( PropertyType * property )

Set the property applied to the object.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

void itk::DataObject::SetReleaseDataFlag ( bool flag ) [inline, inherited]

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetRequestedRegion ( DataObject * data ) [virtual]

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.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::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()

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetRequestedRegionToLargestPossibleRegion ( ) [virtual]

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.

template<unsigned int TDimension = 3>

void itk::SpatialObject< TDimension >::SetSpacing ( const double spacing[itkGetStaticConstMacro(ObjectDimension)] ) [inline]

Set the spacing of the spatial object.

Definition at line 412 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetTreeNode ( TreeNodeType * _arg ) [virtual]

Set the tree container

Referenced by itk::SpatialObjectTreeNode< TDimension >::SetData().

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::SetTypeName ( std::string _arg ) [protected, virtual]

bool itk::DataObject::ShouldIReleaseData ( ) const [inherited]

Return flag indicating whether data should be released after use by a filter.

virtual void itk::Object::UnRegister ( ) const [virtual, inherited]

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::Update ( void ) [virtual]

Specify that the object has been updated

Reimplemented from itk::DataObject.

virtual void itk::DataObject::UpdateOutputData ( ) [virtual, inherited]

Methods to update the pipeline. Called internally by the pipeline mechanism.

template<unsigned int TDimension = 3>

virtual void itk::SpatialObject< TDimension >::UpdateOutputInformation ( ) [virtual]

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.

template<unsigned int TDimension = 3>

virtual bool itk::SpatialObject< TDimension >::ValueAt	(	const PointType &	point,
		double &	value,
		unsigned int	depth = `0`,
		char *	name = `NULL`
	)			const `[virtual]`

Returns the value at a point

Reimplemented in itk::ImageSpatialObject< TDimension, unsigned char >.

template<unsigned int TDimension = 3>

virtual bool itk::SpatialObject< TDimension >::VerifyRequestedRegion ( ) [virtual]

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.

volatile int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 122 of file itkLightObject.h.

itk::SpatialObject< TDimension > Class Template Reference

Detailed Description

template<unsigned int TDimension = 3>
class itk::SpatialObject< TDimension >

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


void	GlobalReleaseDataFlagOff ()
void	GlobalReleaseDataFlagOn ()
static bool	GetGlobalReleaseDataFlag ()
static void	SetGlobalReleaseDataFlag (const bool val)
Public Types
typedef AffineGeometryFrameType::Pointer	AffineGeometryFramePointer
typedef AffineGeometryFrame< double, TDimension >	AffineGeometryFrameType
typedef BoundingBoxType::Pointer	BoundingBoxPointer
typedef BoundingBox< unsigned long int, TDimension, ScalarType, VectorContainerType >	BoundingBoxType
typedef ChildrenListType *	ChildrenListPointer
typedef std::list< Pointer >	ChildrenListType
typedef SmartPointer< const Self >	ConstPointer
typedef CovariantVector< ScalarType, TDimension >	CovariantVectorType
typedef Index< TDimension >	IndexType
typedef IndexType::IndexValueType	IndexValueType
typedef Point< ScalarType, TDimension >	InputType
typedef Offset< TDimension >	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef OutputVectorType *	OutputVectorPointer
typedef CovariantVector< double, TDimension >	OutputVectorType
typedef SmartPointer< Self >	Pointer
typedef PointType *	PointPointer
typedef Point< ScalarType, TDimension >	PointType
typedef PropertyType::Pointer	PropertyPointer
typedef SpatialObjectProperty< float >	PropertyType
typedef ImageRegion< TDimension >	RegionType
typedef double	ScalarType
typedef SpatialObject< TDimension >	Self
typedef Size< TDimension >	SizeType
typedef double *	SpacingType
typedef DataObject	Superclass
typedef const TransformType *	TransformConstPointer
typedef TransformType::Pointer	TransformPointer
typedef ScalableAffineTransform< double, TDimension >	TransformType
typedef SpatialObjectTreeNode< TDimension >	TreeNodeType
typedef VectorContainer< unsigned long int, PointType >	VectorContainerType
typedef VectorType *	VectorPointer
typedef Vector< ScalarType, TDimension >	VectorType
Public Member Functions
void	AddSpatialObject (Self *pointer)
virtual void	Clear (void)
void	ComputeObjectToParentTransform (void)
void	ComputeObjectToWorldTransform (void)
virtual LightObject::Pointer	CreateAnother () const
void	DataHasBeenGenerated ()
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=NULL)
void	DisconnectPipeline ()
virtual BoundingBoxType *	GetBoundingBox () const
virtual const RegionType &	GetBufferedRegion () const
virtual ChildrenListType *	GetChildren (unsigned int depth=0, char *name=NULL) const
Command *	GetCommand (unsigned long tag)
bool	GetDataReleased () const
bool	GetDebug () const
virtual const RegionType &	GetLargestPossibleRegion () const
unsigned int	GetMaximumDepth ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
unsigned long	GetMTime (void) const
virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfChildren (unsigned int depth=0, char *name=NULL) const
unsigned int	GetObjectDimension (void) const
unsigned long	GetObjectMTime (void) const
virtual Self *	GetParent (void)
virtual const Self *	GetParent (void) const
virtual int	GetReferenceCount () const
virtual const RegionType &	GetRequestedRegion () const
SmartPointerForwardReference< ProcessObject >	GetSource () const
unsigned int	GetSourceOutputIndex () const
virtual const double *	GetSpacing () const
virtual std::string	GetSpatialObjectTypeAsString () const
unsigned long	GetTransformMTime (void)
virtual const char *	GetTypeName (void) const
virtual unsigned long	GetUpdateMTime () const
unsigned long	GetWorldTransformMTime (void)
virtual void	Graft (const DataObject *)
bool	HasObserver (const EventObject &event) const
virtual bool	HasParent (void) const
virtual void	Initialize ()
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
virtual bool	IsInside (const PointType &point, unsigned int depth=0, char *name=NULL) const
	itkStaticConstMacro (ObjectDimension, unsigned int, TDimension)
	itkStaticConstMacro (MaximumDepth, unsigned int, 9999999)
virtual void	Modified () const
virtual void	PrepareForNewData ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	ReleaseData ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	RemoveSpatialObject (Self *object)
virtual void	ResetPipeline ()
virtual void	SetBufferedRegion (const RegionType &region)
void	SetChildren (ChildrenListType &children)
void	SetDebug (bool debugFlag) const
virtual void	SetLargestPossibleRegion (const RegionType &region)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetParent (Self *parent)
void	SetProperty (PropertyType *property)
virtual void	SetReferenceCount (int)
virtual void	SetRequestedRegion (DataObject *data)
virtual void	SetRequestedRegion (const RegionType &region)
void	SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
virtual void	SetTreeNode (TreeNodeType *_arg)
bool	ShouldIReleaseData () const
virtual void	UnRegister () const
virtual void	Update (void)
virtual bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const

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

virtual bool	ComputeBoundingBox () const
virtual bool	ComputeLocalBoundingBox () const

IndexType	ComputeIndex (OffsetValueType offset) const
OffsetValueType	ComputeOffset (const IndexType &ind) const
virtual void	CopyInformation (const DataObject *data)
const PropertyType *	GetProperty (void) const
PropertyType *	GetProperty (void)
virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void	SetRequestedRegionToLargestPossibleRegion ()
virtual void	UpdateOutputInformation ()
virtual bool	VerifyRequestedRegion ()

bool	Evaluate (const PointType &point) const

virtual const AffineGeometryFrameType *	GetAffineGeometryFrame ()
virtual void	SetAffineGeometryFrame (AffineGeometryFrameType *_arg)

virtual const unsigned int &	GetBoundingBoxChildrenDepth ()
virtual void	SetBoundingBoxChildrenDepth (unsigned int _arg)

virtual const std::string &	GetBoundingBoxChildrenName ()
virtual void	SetBoundingBoxChildrenName (std::string _arg)

virtual double	GetDefaultInsideValue () const
virtual void	SetDefaultInsideValue (double _arg)

virtual double	GetDefaultOutsideValue () const
virtual void	SetDefaultOutsideValue (double _arg)

virtual const int &	GetId ()
virtual void	SetId (int _arg)

const TransformType *	GetIndexToObjectTransform (void) const
TransformType *	GetIndexToObjectTransform (void)

virtual const TransformType *	GetIndexToWorldTransform ()
virtual TransformType *	GetIndexToWorldTransform ()
virtual const TransformType *	GetObjectToWorldTransform ()
virtual TransformType *	GetObjectToWorldTransform ()
void	SetObjectToWorldTransform (TransformType *transform)

const TransformType *	GetNodeToParentNodeTransform (void) const
TransformType *	GetNodeToParentNodeTransform (void)
void	SetNodeToParentNodeTransform (TransformType *transform)

const TransformType *	GetObjectToNodeTransform (void) const
TransformType *	GetObjectToNodeTransform (void)

const TransformType *	GetObjectToParentTransform (void) const
TransformType *	GetObjectToParentTransform (void)
void	SetObjectToParentTransform (TransformType *transform)

const OffsetValueType *	GetOffsetTable () const

virtual const int &	GetParentId ()
virtual void	SetParentId (int _arg)

virtual const unsigned long &	GetPipelineMTime ()
void	SetPipelineMTime (unsigned long time)

virtual const bool &	GetReleaseDataFlag ()
virtual void	ReleaseDataFlagOff ()
virtual void	ReleaseDataFlagOn ()
void	SetReleaseDataFlag (bool flag)

virtual const TreeNodeType *	GetTreeNode ()
virtual TreeNodeType *	GetTreeNode ()

virtual void	PropagateRequestedRegion () throw (InvalidRequestedRegionError)
virtual void	UpdateOutputData ()
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Member Functions
void	ComputeOffsetTable ()
virtual const BoundingBoxType *	GetBounds ()
virtual const unsigned int &	GetDimension ()
virtual const TransformType *	GetInternalInverseTransform ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	SetDimension (unsigned int _arg)
virtual void	SetTypeName (std::string _arg)
	SpatialObject ()
virtual	~SpatialObject ()

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock

itk::SpatialObject< TDimension > Class Template Reference

Detailed Description

template<unsigned int TDimension = 3> class itk::SpatialObject< TDimension >

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<unsigned int TDimension = 3>
class itk::SpatialObject< TDimension >