Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::PolygonSpatialObject< TDimension > Class Template Reference

TODO. More...

#include <itkPolygonSpatialObject.h>

Inheritance diagram for itk::PolygonSpatialObject< TDimension >:
Inheritance graph
[legend]
Collaboration diagram for itk::PolygonSpatialObject< TDimension >:
Collaboration graph
[legend]

List of all members.

Public Types

typedef
AffineGeometryFrameType::Pointer 
AffineGeometryFramePointer
typedef AffineGeometryFrame
< double, TDimension > 
AffineGeometryFrameType
typedef Superclass::BlobPointType BlobPointType
typedef BoundingBoxType::Pointer BoundingBoxPointer
typedef Superclass::BoundingBoxType BoundingBoxType
typedef ChildrenListTypeChildrenListPointer
typedef std::list< PointerChildrenListType
typedef SmartPointer< const SelfConstPointer
typedef
Superclass::CovariantVectorType 
CovariantVectorType
typedef Index< TDimension > IndexType
typedef IndexType::IndexValueType IndexValueType
typedef Point< ScalarType,
TDimension > 
InputType
typedef Offset< TDimension > OffsetType
typedef OffsetType::OffsetValueType OffsetValueType
typedef OutputVectorTypeOutputVectorPointer
typedef CovariantVector
< double, TDimension > 
OutputVectorType
typedef SmartPointer
< PointContainerType
PointContainerPointer
typedef VectorContainer
< unsigned long, PointType
PointContainerType
typedef SmartPointer< SelfPointer
typedef Superclass::PointListType PointListType
typedef PointTypePointPointer
typedef Superclass::PointType PointType
typedef PropertyType::Pointer PropertyPointer
typedef SpatialObjectProperty
< float > 
PropertyType
typedef ImageRegion< TDimension > RegionType
typedef double ScalarType
typedef PolygonSpatialObject
< TDimension > 
Self
typedef Size< TDimension > SizeType
typedef double * SpacingType
typedef
Superclass::SpatialObjectPointType 
SpatialObjectPointType
typedef BlobSpatialObject
< TDimension > 
Superclass
typedef const TransformTypeTransformConstPointer
typedef TransformType::Pointer TransformPointer
typedef Superclass::TransformType TransformType
typedef SpatialObjectTreeNode
< TDimension > 
TreeNodeType
typedef VectorContainer
< unsigned long int, PointType
VectorContainerType
typedef VectorTypeVectorPointer
typedef Superclass::VectorType VectorType

Public Member Functions

bool AddPoint (const PointType &pointToAdd)
void AddSpatialObject (Self *pointer)
virtual void Clear (void)
PointType ClosestPoint (const PointType &curPoint) const
bool ComputeLocalBoundingBox () const
void ComputeObjectToParentTransform (void)
void ComputeObjectToWorldTransform (void)
virtual void CopyInformation (const DataObject *)
virtual LightObject::Pointer CreateAnother () const
void DataHasBeenGenerated ()
virtual void DebugOff () const
virtual void DebugOn () const
virtual void Delete ()
bool DeletePoint (const PointType &pointToDelete)
virtual void DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=NULL)
void DisconnectPipeline ()
virtual BoundingBoxTypeGetBoundingBox () const
virtual const RegionTypeGetBufferedRegion () const
virtual ChildrenListTypeGetChildren (unsigned int depth=0, char *name=NULL) const
CommandGetCommand (unsigned long tag)
bool GetDataReleased () const
bool GetDebug () const
virtual const RegionTypeGetLargestPossibleRegion () const
unsigned int GetMaximumDepth ()
const MetaDataDictionaryGetMetaDataDictionary (void) const
MetaDataDictionaryGetMetaDataDictionary (void)
unsigned long GetMTime (void) const
virtual const char * GetNameOfClass () const
unsigned int GetNumberOfChildren (unsigned int depth=0, char *name=NULL) const
unsigned long GetNumberOfPoints (void) const
unsigned int GetObjectDimension (void) const
unsigned long GetObjectMTime (void) const
virtual SelfGetParent (void)
virtual const SelfGetParent (void) const
SpatialObjectPointTypeGetPoint (unsigned long id)
const SpatialObjectPointTypeGetPoint (unsigned long id) const
const PointListTypeGetPoints (void) const
PointListTypeGetPoints (void)
virtual int GetReferenceCount () const
virtual const RegionTypeGetRequestedRegion () const
SmartPointerForwardReference
< ProcessObject
GetSource () const
unsigned int GetSourceOutputIndex () const
virtual const double * GetSpacing () const
virtual std::string GetSpatialObjectTypeAsString () const
virtual double GetThickness ()
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 ()
bool InsertPoint (const PointType &point1, const PointType &pointToAdd)
void InvokeEvent (const EventObject &) const
void InvokeEvent (const EventObject &)
bool IsClosed () const
virtual bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
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
virtual bool IsInside (const PointType &point) const
virtual bool IsInside (const PointType &point, unsigned int depth, char *name) const
double MeasureArea () const
double MeasurePerimeter () const
double MeasureVolume () const
virtual void Modified () const
unsigned int NumberOfPoints () const
PolygonGroupOrientation Plane () 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)
bool RemoveSegment (const PointType &startpoint, const PointType &endPoint)
void RemoveSpatialObject (Self *object)
bool ReplacePoint (const PointType &oldpoint, const PointType &newPoint)
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 SetPoints (PointListType &newPoints)
void SetProperty (PropertyType *property)
virtual void SetReferenceCount (int)
virtual void SetRequestedRegion (DataObject *)
virtual void SetRequestedRegion (DataObject *data)
virtual void SetRequestedRegion (const RegionType &region)
void SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
virtual void SetThickness (double _arg)
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
bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const



virtual bool ComputeBoundingBox () const
IndexType ComputeIndex (OffsetValueType offset) const
OffsetValueType ComputeOffset (const IndexType &ind) const
virtual void CopyInformation (const DataObject *data)
bool Evaluate (const PointType &point) const
virtual const
AffineGeometryFrameType
GetAffineGeometryFrame ()
virtual const unsigned int & GetBoundingBoxChildrenDepth ()
virtual const std::string & GetBoundingBoxChildrenName ()
virtual double GetDefaultInsideValue () const
virtual double GetDefaultOutsideValue () const
virtual const int & GetId ()
const TransformTypeGetIndexToObjectTransform (void) const
TransformTypeGetIndexToObjectTransform (void)
virtual const TransformTypeGetIndexToWorldTransform ()
virtual TransformTypeGetIndexToWorldTransform ()
const TransformTypeGetNodeToParentNodeTransform (void) const
TransformTypeGetNodeToParentNodeTransform (void)
const TransformTypeGetObjectToNodeTransform (void) const
TransformTypeGetObjectToNodeTransform (void)
const TransformTypeGetObjectToParentTransform (void) const
TransformTypeGetObjectToParentTransform (void)
virtual const TransformTypeGetObjectToWorldTransform ()
virtual TransformTypeGetObjectToWorldTransform ()
const OffsetValueTypeGetOffsetTable () const
virtual const int & GetParentId ()
const PropertyTypeGetProperty (void) const
PropertyTypeGetProperty (void)
virtual const TreeNodeTypeGetTreeNode ()
virtual TreeNodeTypeGetTreeNode ()
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual void SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
virtual void SetBoundingBoxChildrenDepth (unsigned int _arg)
virtual void SetBoundingBoxChildrenName (std::string _arg)
virtual void SetDefaultInsideValue (double _arg)
virtual void SetDefaultOutsideValue (double _arg)
virtual void SetId (int _arg)
void SetNodeToParentNodeTransform (TransformType *transform)
void SetObjectToParentTransform (TransformType *transform)
void SetObjectToWorldTransform (TransformType *transform)
virtual void SetParentId (int _arg)
virtual void SetRequestedRegionToLargestPossibleRegion ()
virtual void UpdateOutputInformation ()
virtual bool VerifyRequestedRegion ()

Static Public Member Functions

static void BreakOnError ()
static Pointer New ()

Static Public Attributes

static const unsigned int MaximumDepth = 9999999
static const unsigned int ObjectDimension = TDimension

Protected Member Functions

void ComputeOffsetTable ()
virtual const BoundingBoxTypeGetBounds ()
virtual const unsigned int & GetDimension ()
virtual const TransformTypeGetInternalInverseTransform ()
bool PrintObservers (std::ostream &os, Indent indent) const
void PrintSelf (std::ostream &os, Indent indent) const
virtual void PropagateResetPipeline ()
virtual void SetDimension (unsigned int _arg)
bool SetInternalInverseTransformToWorldToIndexTransform () const
virtual void SetTypeName (std::string _arg)

Protected Attributes

PointListType m_Points
InternalReferenceCountType m_ReferenceCount
SimpleFastMutexLock m_ReferenceCountLock



static bool GetGlobalReleaseDataFlag ()
static void GlobalReleaseDataFlagOff ()
static void GlobalReleaseDataFlagOn ()
static void SetGlobalReleaseDataFlag (bool val)
virtual const unsigned long & GetPipelineMTime ()
virtual const bool & GetReleaseDataFlag ()
virtual void PropagateRequestedRegion () throw (InvalidRequestedRegionError)
virtual void ReleaseDataFlagOff ()
virtual void ReleaseDataFlagOn ()
void SetPipelineMTime (unsigned long time)
void SetReleaseDataFlag (bool flag)
virtual void UpdateOutputData ()



static bool GetGlobalWarningDisplay ()
static void GlobalWarningDisplayOff ()
static void GlobalWarningDisplayOn ()
static void SetGlobalWarningDisplay (bool flag)
unsigned long AddObserver (const EventObject &event, Command *) const
unsigned long AddObserver (const EventObject &event, Command *)



virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
typedef int InternalReferenceCountType

Detailed Description

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

TODO.

Definition at line 30 of file itkPolygonSpatialObject.h.


Member Typedef Documentation

template<unsigned int TDimension = 3>
typedef AffineGeometryFrameType::Pointer itk::SpatialObject< TDimension >::AffineGeometryFramePointer [inherited]

Definition at line 114 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef AffineGeometryFrame<double,TDimension> itk::SpatialObject< TDimension >::AffineGeometryFrameType [inherited]

Definition at line 113 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::BlobPointType itk::PolygonSpatialObject< TDimension >::BlobPointType

Reimplemented from itk::BlobSpatialObject< TDimension >.

Definition at line 41 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>
typedef BoundingBoxType::Pointer itk::SpatialObject< TDimension >::BoundingBoxPointer [inherited]

Definition at line 111 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::BoundingBoxType itk::BlobSpatialObject< TDimension >::BoundingBoxType [inherited]

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 59 of file itkBlobSpatialObject.h.

template<unsigned int TDimension = 3>
typedef ChildrenListType* itk::SpatialObject< TDimension >::ChildrenListPointer [inherited]

Definition at line 118 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef std::list< Pointer > itk::SpatialObject< TDimension >::ChildrenListType [inherited]

Return type for the list of children

Reimplemented in itk::PolygonGroupSpatialObject< TDimension >.

Definition at line 117 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< const Self > itk::PolygonSpatialObject< TDimension >::ConstPointer

Reimplemented from itk::BlobSpatialObject< TDimension >.

Definition at line 37 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::CovariantVectorType itk::PointBasedSpatialObject< TDimension >::CovariantVectorType [inherited]
template<unsigned int TDimension = 3>
typedef Index<TDimension> itk::SpatialObject< TDimension >::IndexType [inherited]

Index typedef support. An index is used to access pixel values.

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

Definition at line 122 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef IndexType::IndexValueType itk::SpatialObject< TDimension >::IndexValueType [inherited]

Definition at line 123 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Point< ScalarType, TDimension > itk::SpatialObject< TDimension >::InputType [inherited]

Definition at line 91 of file itkSpatialObject.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 139 of file itkLightObject.h.

template<unsigned int TDimension = 3>
typedef Offset<TDimension> itk::SpatialObject< TDimension >::OffsetType [inherited]

Offset typedef support. An offset represent relative position between indices.

Definition at line 127 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef OffsetType::OffsetValueType itk::SpatialObject< TDimension >::OffsetValueType [inherited]

Definition at line 128 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef OutputVectorType* itk::SpatialObject< TDimension >::OutputVectorPointer [inherited]

Definition at line 101 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef CovariantVector< double, TDimension > itk::SpatialObject< TDimension >::OutputVectorType [inherited]

Definition at line 100 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer<PointContainerType> itk::BlobSpatialObject< TDimension >::PointContainerPointer [inherited]

Definition at line 61 of file itkBlobSpatialObject.h.

template<unsigned int TDimension = 3>
typedef VectorContainer<unsigned long,PointType> itk::BlobSpatialObject< TDimension >::PointContainerType [inherited]

Definition at line 60 of file itkBlobSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< Self > itk::PolygonSpatialObject< TDimension >::Pointer

Reimplemented from itk::BlobSpatialObject< TDimension >.

Definition at line 36 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::PointListType itk::PolygonSpatialObject< TDimension >::PointListType

Reimplemented from itk::BlobSpatialObject< TDimension >.

Definition at line 40 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>
typedef PointType* itk::SpatialObject< TDimension >::PointPointer [inherited]

Definition at line 92 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::PointType itk::PolygonSpatialObject< TDimension >::PointType

Reimplemented from itk::BlobSpatialObject< TDimension >.

Definition at line 38 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>
typedef PropertyType::Pointer itk::SpatialObject< TDimension >::PropertyPointer [inherited]

Definition at line 132 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SpatialObjectProperty< float > itk::SpatialObject< TDimension >::PropertyType [inherited]

Definition at line 131 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef ImageRegion<TDimension> itk::SpatialObject< TDimension >::RegionType [inherited]
template<unsigned int TDimension = 3>
typedef double itk::BlobSpatialObject< TDimension >::ScalarType [inherited]

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 53 of file itkBlobSpatialObject.h.

template<unsigned int TDimension = 3>
typedef PolygonSpatialObject<TDimension> itk::PolygonSpatialObject< TDimension >::Self

Standard class typedefs.

Reimplemented from itk::BlobSpatialObject< TDimension >.

Definition at line 34 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Size<TDimension> itk::SpatialObject< TDimension >::SizeType [inherited]
template<unsigned int TDimension = 3>
typedef double* itk::SpatialObject< TDimension >::SpacingType [inherited]

Definition at line 98 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::SpatialObjectPointType itk::BlobSpatialObject< TDimension >::SpatialObjectPointType [inherited]

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 57 of file itkBlobSpatialObject.h.

template<unsigned int TDimension = 3>
typedef BlobSpatialObject< TDimension > itk::PolygonSpatialObject< TDimension >::Superclass

Reimplemented from itk::BlobSpatialObject< TDimension >.

Definition at line 35 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>
typedef const TransformType* itk::SpatialObject< TDimension >::TransformConstPointer [inherited]

Definition at line 105 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef TransformType::Pointer itk::SpatialObject< TDimension >::TransformPointer [inherited]

Definition at line 104 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::TransformType itk::PolygonSpatialObject< TDimension >::TransformType

Reimplemented from itk::BlobSpatialObject< TDimension >.

Definition at line 39 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SpatialObjectTreeNode<TDimension> itk::SpatialObject< TDimension >::TreeNodeType [inherited]
template<unsigned int TDimension = 3>
typedef VectorContainer< unsigned long int, PointType > itk::SpatialObject< TDimension >::VectorContainerType [inherited]

Definition at line 107 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef VectorType* itk::SpatialObject< TDimension >::VectorPointer [inherited]

Definition at line 96 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::VectorType itk::PointBasedSpatialObject< TDimension >::VectorType [inherited]

Member Function Documentation

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) const [inherited]

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

unsigned long itk::Object::AddObserver ( const EventObject event,
Command  
) [inherited]

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>
bool itk::PolygonSpatialObject< TDimension >::AddPoint ( const PointType pointToAdd  ) 

Method adds a point to the end of the strand

template<unsigned int TDimension = 3>
void itk::SpatialObject< TDimension >::AddSpatialObject ( Self pointer  )  [inherited]

Theses functions are just calling the itkSpatialObjectTreeNode functions 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, inherited]
template<unsigned int TDimension = 3>
PointType itk::PolygonSpatialObject< TDimension >::ClosestPoint ( const PointType curPoint  )  const

Method returns the Point closest to the given point

template<unsigned int TDimension = 3>
virtual bool itk::SpatialObject< TDimension >::ComputeBoundingBox (  )  const [virtual, inherited]

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, inherited]

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

Definition at line 315 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
bool itk::BlobSpatialObject< TDimension >::ComputeLocalBoundingBox (  )  const [virtual, inherited]

Compute the boundaries of the Blob.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
void itk::SpatialObject< TDimension >::ComputeObjectToParentTransform ( void   )  [inherited]

Compute the Local transform when the global transform is set

template<unsigned int TDimension = 3>
void itk::SpatialObject< TDimension >::ComputeObjectToWorldTransform ( void   )  [inherited]

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, inherited]

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

Definition at line 295 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
void itk::SpatialObject< TDimension >::ComputeOffsetTable (  )  [protected, inherited]

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.

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

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. The default implementation of this method is empty. If a subclass overrides this method, it should always call its superclass' version.

Definition at line 439 of file itkDataObject.h.

template<unsigned int TDimension = 3>
virtual void itk::SpatialObject< TDimension >::CopyInformation ( const DataObject data  )  [virtual, inherited]

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 in itk::EllipseSpatialObject< TDimension >, itk::TubeSpatialObject< TDimension, TTubePointType >, itk::TubeSpatialObject< TDimension, VesselTubeSpatialObjectPoint< TDimension > >, and itk::TubeSpatialObject< TDimension, DTITubeSpatialObjectPoint< TDimension > >.

virtual LightObject::Pointer itk::Object::CreateAnother (  )  const [virtual, inherited]
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>
bool itk::PolygonSpatialObject< TDimension >::DeletePoint ( const PointType pointToDelete  ) 

Method deletes a point from the strand

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, inherited]

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, inherited]

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

template<unsigned int TDimension = 3>
virtual const AffineGeometryFrameType* itk::SpatialObject< TDimension >::GetAffineGeometryFrame (  )  [virtual, inherited]

Set/Get the AffineGeometryFrame

template<unsigned int TDimension = 3>
virtual BoundingBoxType* itk::SpatialObject< TDimension >::GetBoundingBox (  )  const [virtual, inherited]

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, inherited]

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>
virtual const std::string& itk::SpatialObject< TDimension >::GetBoundingBoxChildrenName (  )  [virtual, inherited]

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>
virtual const BoundingBoxType* itk::SpatialObject< TDimension >::GetBounds (  )  [protected, virtual, inherited]
template<unsigned int TDimension = 3>
virtual const RegionType& itk::SpatialObject< TDimension >::GetBufferedRegion (  )  const [inline, virtual, inherited]

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

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

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, inherited]

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>
virtual double itk::SpatialObject< TDimension >::GetDefaultOutsideValue (  )  const [virtual, inherited]

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>
virtual const unsigned int& itk::SpatialObject< TDimension >::GetDimension (  )  [protected, virtual, inherited]
static bool itk::DataObject::GetGlobalReleaseDataFlag (  )  [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 bool itk::Object::GetGlobalWarningDisplay (  )  [static, inherited]

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

template<unsigned int TDimension = 3>
virtual const int& itk::SpatialObject< TDimension >::GetId (  )  [virtual, inherited]

Get/Set the ID

template<unsigned int TDimension = 3>
const TransformType* itk::SpatialObject< TDimension >::GetIndexToObjectTransform ( void   )  const [inherited]

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>
TransformType* itk::SpatialObject< TDimension >::GetIndexToObjectTransform ( void   )  [inherited]

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, inherited]

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>
virtual TransformType* itk::SpatialObject< TDimension >::GetIndexToWorldTransform (  )  [virtual, inherited]

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>
virtual const TransformType* itk::SpatialObject< TDimension >::GetInternalInverseTransform (  )  [protected, virtual, inherited]
template<unsigned int TDimension = 3>
virtual const RegionType& itk::SpatialObject< TDimension >::GetLargestPossibleRegion (  )  const [inline, virtual, inherited]

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

template<unsigned int TDimension = 3>
unsigned int itk::SpatialObject< TDimension >::GetMaximumDepth (  )  [inline, inherited]

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

Definition at line 81 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, inherited]

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::PolygonSpatialObject< TDimension >::GetNameOfClass (  )  const [virtual]

Method for creation through the object factory.

Reimplemented from itk::BlobSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
const TransformType* itk::SpatialObject< TDimension >::GetNodeToParentNodeTransform ( void   )  const [inherited]

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>
TransformType* itk::SpatialObject< TDimension >::GetNodeToParentNodeTransform ( void   )  [inherited]

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>
unsigned int itk::SpatialObject< TDimension >::GetNumberOfChildren ( unsigned int  depth = 0,
char *  name = NULL 
) const [inherited]

Returns the number of children currently assigned to the object.

template<unsigned int TDimension = 3>
unsigned long itk::BlobSpatialObject< TDimension >::GetNumberOfPoints ( void   )  const [inline, virtual, inherited]

Return the number of points in the list

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 88 of file itkBlobSpatialObject.h.

template<unsigned int TDimension = 3>
unsigned int itk::SpatialObject< TDimension >::GetObjectDimension ( void   )  const [inline, inherited]

Get the dimensionality of the object

Definition at line 149 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
unsigned long itk::SpatialObject< TDimension >::GetObjectMTime ( void   )  const [inline, inherited]

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

Definition at line 229 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
const TransformType* itk::SpatialObject< TDimension >::GetObjectToNodeTransform ( void   )  const [inherited]

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>
TransformType* itk::SpatialObject< TDimension >::GetObjectToNodeTransform ( void   )  [inherited]

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 [inherited]

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>
TransformType* itk::SpatialObject< TDimension >::GetObjectToParentTransform ( void   )  [inherited]

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>
virtual const TransformType* itk::SpatialObject< TDimension >::GetObjectToWorldTransform (  )  [virtual, inherited]

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>
virtual TransformType* itk::SpatialObject< TDimension >::GetObjectToWorldTransform (  )  [virtual, inherited]

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>
const OffsetValueType* itk::SpatialObject< TDimension >::GetOffsetTable (  )  const [inline, inherited]

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

template<unsigned int TDimension = 3>
virtual Self* itk::SpatialObject< TDimension >::GetParent ( void   )  [virtual, inherited]

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, inherited]

Return a pointer to the parent object in the hierarchy tree

template<unsigned int TDimension = 3>
virtual const int& itk::SpatialObject< TDimension >::GetParentId (  )  [virtual, inherited]

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.

virtual const unsigned long& itk::DataObject::GetPipelineMTime (  )  [virtual, 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.

template<unsigned int TDimension = 3>
SpatialObjectPointType* itk::BlobSpatialObject< TDimension >::GetPoint ( unsigned long  id  )  [inline, virtual, inherited]

Return a point in the list given the index

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 85 of file itkBlobSpatialObject.h.

template<unsigned int TDimension = 3>
const SpatialObjectPointType* itk::BlobSpatialObject< TDimension >::GetPoint ( unsigned long  id  )  const [inline, virtual, inherited]

Return a point in the list given the index

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 79 of file itkBlobSpatialObject.h.

template<unsigned int TDimension = 3>
const PointListType& itk::BlobSpatialObject< TDimension >::GetPoints ( void   )  const [inherited]

Returns a reference to the list of the Blob points.

template<unsigned int TDimension = 3>
PointListType& itk::BlobSpatialObject< TDimension >::GetPoints ( void   )  [inherited]

Returns a reference to the list of the Blob points.

template<unsigned int TDimension = 3>
const PropertyType* itk::SpatialObject< TDimension >::GetProperty ( void   )  const [inline, inherited]

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

template<unsigned int TDimension = 3>
PropertyType* itk::SpatialObject< TDimension >::GetProperty ( void   )  [inherited]

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 106 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag (  )  [virtual, 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.

template<unsigned int TDimension = 3>
virtual const RegionType& itk::SpatialObject< TDimension >::GetRequestedRegion (  )  const [inline, virtual, inherited]

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 278 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, inherited]

Get the spacing of the spatial object.

Definition at line 416 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
virtual std::string itk::SpatialObject< TDimension >::GetSpatialObjectTypeAsString (  )  const [virtual, inherited]

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

template<unsigned int TDimension = 3>
virtual double itk::PolygonSpatialObject< TDimension >::GetThickness (  )  [virtual]

Method gets the thickness of the current strand

template<unsigned int TDimension = 3>
unsigned long itk::SpatialObject< TDimension >::GetTransformMTime ( void   )  [inherited]

Return the Modified time of the LocalToWorldTransform

template<unsigned int TDimension = 3>
virtual const TreeNodeType* itk::SpatialObject< TDimension >::GetTreeNode (  )  [virtual, inherited]

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>
virtual TreeNodeType* itk::SpatialObject< TDimension >::GetTreeNode (  )  [virtual, inherited]

Return a raw pointer to the node container

template<unsigned int TDimension = 3>
virtual const char* itk::SpatialObject< TDimension >::GetTypeName ( void   )  const [inline, virtual, inherited]

Get the typename of the SpatialObject

Definition at line 141 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   )  [inherited]

Return the Modified time of the WorldToLocalTransform

static void itk::DataObject::GlobalReleaseDataFlagOff (  )  [inline, 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.

Definition at line 319 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn (  )  [inline, 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.

Definition at line 317 of file itkDataObject.h.

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

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

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

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

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, inherited]

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.

Reimplemented in itk::watershed::SegmentTree< TScalarType >, itk::ChainCodePath< VDimension >, itk::FourierSeriesPath< VDimension >, itk::Image< TPixel, VImageDimension >, itk::ImageAdaptor< TImage, TAccessor >, itk::ImageBase< VImageDimension >, itk::Mesh< TPixelType, VDimension, TMeshTraits >, itk::OrthogonallyCorrected2DParametricPath, itk::PointSet< TPixelType, VDimension, TMeshTraits >, itk::PolyLineParametricPath< VDimension >, itk::SparseImage< TNode, VImageDimension >, itk::SpecialCoordinatesImage< TPixel, VImageDimension >, itk::VectorImage< TPixel, VImageDimension >, itk::Statistics::OneHiddenLayerBackPropagationNeuralNetwork< TMeasurementVector, TTargetVector >, itk::Statistics::RBFNetwork< TMeasurementVector, TTargetVector >, itk::Statistics::TwoHiddenLayerBackPropagationNeuralNetwork< TMeasurementVector, TTargetVector >, itk::LabelMap< TLabelObject >, itk::QuadEdgeMesh< TPixel, VDimension, TTraits >, itk::ChainCodePath< 2 >, itk::Image< BloxCoreAtomPixel< NDimension >, TImageDimension >, itk::Image< TNode *, VImageDimension >, itk::Image< BloxBoundaryProfilePixel< TImageDimension >, TImageDimension >, itk::Image< TBloxPixelType, TImageDimension >, itk::Image< BloxBoundaryPointPixel< TImageDimension >, TImageDimension >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, PixelAccessor >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageBase< ::itk::GetImageDimension< TLabelObject >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >, itk::Mesh< TCoordType, 2, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::Mesh< TPixel, VDimension, TTraits >, itk::PointSet< TPixel, VDimension, TTraits >, itk::PointSet< TCoordType, VDimension, DefaultDynamicMeshTraits< TCoordType, 2, 2, TCoordType > >, itk::SpecialCoordinatesImage< TPixel, 3 >, and itk::VectorImage< TPixelType, Dimension >.

template<unsigned int TDimension = 3>
bool itk::PolygonSpatialObject< TDimension >::InsertPoint ( const PointType point1,
const PointType pointToAdd 
)

Method inserts point after point1

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>
bool itk::PolygonSpatialObject< TDimension >::IsClosed (  )  const

Returns if the polygon is closed

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

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>
bool itk::BlobSpatialObject< TDimension >::IsEvaluableAt ( const PointType point,
unsigned int  depth = 0,
char *  name = NULL 
) const [inherited]

Returns true if the Blob is evaluable at the requested point, false otherwise.

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

Test whether a point is inside or outside the object For computational speed purposes, it is faster if the method does not check the name of the class and the current depth.

Reimplemented from itk::BlobSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual bool itk::PolygonSpatialObject< TDimension >::IsInside ( const PointType point,
unsigned int  depth,
char *  name 
) const [virtual]

Test whether a point is inside or outside the object.

Reimplemented from itk::BlobSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
double itk::PolygonSpatialObject< TDimension >::MeasureArea (  )  const

Method returns area of polygon described by points

template<unsigned int TDimension = 3>
double itk::PolygonSpatialObject< TDimension >::MeasurePerimeter (  )  const

Method returns the length of the perimeter

template<unsigned int TDimension = 3>
double itk::PolygonSpatialObject< TDimension >::MeasureVolume (  )  const

Method returns the volume of the strand

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.

Reimplemented in itk::NormalizeImageFilter< TInputImage, TOutputImage >, itk::ImageAdaptor< TImage, TAccessor >, itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, TFilter >, itk::GrayscaleDilateImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleErodeImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalClosingImageFilter< TInputImage, TOutputImage, TKernel >, itk::GrayscaleMorphologicalOpeningImageFilter< TInputImage, TOutputImage, TKernel >, itk::MorphologicalGradientImageFilter< TInputImage, TOutputImage, TKernel >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, PixelAccessor >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, and itk::MiniPipelineSeparableImageFilter< TInputImage, TOutputImage, RankImageFilter< TInputImage, TInputImage, FlatStructuringElement< ::itk::GetImageDimension< TInputImage >::ImageDimension > > >.

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), 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::PolygonSpatialObject< TDimension >::New (  )  [static]

Method for creation through the object factory.

Reimplemented from itk::BlobSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
unsigned int itk::PolygonSpatialObject< TDimension >::NumberOfPoints (  )  const

Returns the number of points of the polygon

template<unsigned int TDimension = 3>
PolygonGroupOrientation itk::PolygonSpatialObject< TDimension >::Plane (  )  const

Method returning plane alignment of strand

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< ProcessObject >::Print().

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

Define the type of the reference count according to the target. This allows the use of atomic operations

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const [protected, inherited]
template<unsigned int TDimension = 3>
void itk::PolygonSpatialObject< TDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const [protected, virtual]

Method to print the object.

Reimplemented from itk::BlobSpatialObject< TDimension >.

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

Define the type of the reference count according to the target. This allows the use of atomic operations

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

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

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, PixelAccessor >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >.

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]

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.

virtual void itk::DataObject::ReleaseDataFlagOn (  )  [virtual, 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.

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>
bool itk::PolygonSpatialObject< TDimension >::RemoveSegment ( const PointType startpoint,
const PointType endPoint 
)

Method removes the series of points between startpoint and endpoint

template<unsigned int TDimension = 3>
void itk::SpatialObject< TDimension >::RemoveSpatialObject ( Self object  )  [inherited]

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>
bool itk::PolygonSpatialObject< TDimension >::ReplacePoint ( const PointType oldpoint,
const PointType newPoint 
)

Method replaces a point

template<unsigned int TDimension = 3>
virtual bool itk::SpatialObject< TDimension >::RequestedRegionIsOutsideOfTheBufferedRegion (  )  [virtual, inherited]

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, inherited]

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>
virtual void itk::SpatialObject< TDimension >::SetBoundingBoxChildrenDepth ( unsigned int  _arg  )  [virtual, inherited]

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, inherited]

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, inherited]

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  )  [inherited]

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, inherited]

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, inherited]

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, inherited]
static void itk::DataObject::SetGlobalReleaseDataFlag ( 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, inherited]

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>
bool itk::SpatialObject< TDimension >::SetInternalInverseTransformToWorldToIndexTransform (  )  const [protected, inherited]

This convenience method take the IndexToWorldTransform, and if it can compute its inverse, then stores the result in the InternalInverse member variable, that can be later accessed with the method GetInternalInverseTransform(). This method is not exposed to users, it is only intended to be called internally by derived classes.

template<unsigned int TDimension = 3>
virtual void itk::SpatialObject< TDimension >::SetLargestPossibleRegion ( const RegionType region  )  [virtual, inherited]

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  )  [inherited]

These function are just calling the node container transforms

template<unsigned int TDimension = 3>
void itk::SpatialObject< TDimension >::SetObjectToParentTransform ( TransformType transform  )  [inherited]

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  )  [inherited]

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  )  [inherited]

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, inherited]

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::BlobSpatialObject< TDimension >::SetPoints ( PointListType newPoints  )  [inherited]

Set the list of Blob points.

template<unsigned int TDimension = 3>
void itk::SpatialObject< TDimension >::SetProperty ( PropertyType property  )  [inherited]

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.

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

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. For DataObject's that do not support Regions, this method does nothing. Subclasses of DataObject that do support Regions, provide an alternative implementation.

Definition at line 446 of file itkDataObject.h.

template<unsigned int TDimension = 3>
virtual void itk::SpatialObject< TDimension >::SetRequestedRegion ( DataObject data  )  [virtual, inherited]

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.

template<unsigned int TDimension = 3>
virtual void itk::SpatialObject< TDimension >::SetRequestedRegion ( const RegionType region  )  [virtual, inherited]

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, inherited]

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, inherited]

Theses functions are just calling the AffineGeometryFrame functions Set the spacing of the spatial object.

Definition at line 411 of file itkSpatialObject.h.

template<unsigned int TDimension = 3>
virtual void itk::PolygonSpatialObject< TDimension >::SetThickness ( double  _arg  )  [virtual]

Method sets the thickness of the current strand

template<unsigned int TDimension = 3>
virtual void itk::SpatialObject< TDimension >::SetTreeNode ( TreeNodeType _arg  )  [virtual, inherited]

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, inherited]
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, inherited]

Specify that the object has been updated

Reimplemented from itk::DataObject.

virtual void itk::DataObject::UpdateOutputData (  )  [virtual, 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.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageBase< VImageDimension >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, PixelAccessor >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< VectorImage< TPixelType, Dimension >, Accessor::VectorImageToImagePixelAccessor< TPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >, itk::ImageBase< ::itk::GetImageDimension< TLabelObject >::ImageDimension >, itk::ImageBase< ::itk::GetImageDimension< VectorImage< TPixelType, Dimension > >::ImageDimension >, and itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

template<unsigned int TDimension = 3>
virtual void itk::SpatialObject< TDimension >::UpdateOutputInformation (  )  [virtual, inherited]

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, inherited]

Returns the value at a point

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

template<unsigned int TDimension = 3>
bool itk::BlobSpatialObject< TDimension >::ValueAt ( const PointType point,
double &  value,
unsigned int  depth = 0,
char *  name = NULL 
) const [inherited]

Returns the value of the Blob at that point. Currently this function returns a binary value, but it might want to return a degree of membership in case of fuzzy Blobs.

template<unsigned int TDimension = 3>
virtual bool itk::SpatialObject< TDimension >::VerifyRequestedRegion (  )  [virtual, inherited]

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

template<unsigned int TDimension = 3>
PointListType itk::BlobSpatialObject< TDimension >::m_Points [protected, inherited]

Definition at line 118 of file itkBlobSpatialObject.h.

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

template<unsigned int TDimension = 3>
const unsigned int itk::SpatialObject< TDimension >::MaximumDepth = 9999999 [static, inherited]
template<unsigned int TDimension = 3>
const unsigned int itk::SpatialObject< TDimension >::ObjectDimension = TDimension [static, inherited]

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.

Definition at line 146 of file itkSpatialObject.h.


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

Generated at Fri Apr 16 23:54:26 2010 for ITK by doxygen 1.6.1 written by Dimitri van Heesch, © 1997-2000