ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
itk::PolygonGroupSpatialObject< TDimension > Class Template Reference

#include <itkPolygonGroupSpatialObject.h>

+ Inheritance diagram for itk::PolygonGroupSpatialObject< TDimension >:
+ Collaboration diagram for itk::PolygonGroupSpatialObject< TDimension >:

List of all members.

Public Types

typedef Superclass::BoundingBoxType BoundingBoxType
typedef
Superclass::ChildrenListType 
ChildrenListType
typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef Superclass::PointType PointType
typedef
PolygonGroupSpatialObject
< TDimension > 
Self
typedef GroupSpatialObject
< TDimension > 
Superclass
typedef
TreeNodeType::ChildrenListType 
TreeNodeChildrenListType
typedef Superclass::TreeNodeType TreeNodeType
- Public Types inherited from itk::GroupSpatialObject< TDimension >
typedef double ScalarType
- Public Types inherited from itk::SpatialObject< TDimension >
typedef
AffineGeometryFrameType::Pointer 
AffineGeometryFramePointer
typedef AffineGeometryFrame
< double, VDimension > 
AffineGeometryFrameType
typedef BoundingBoxType::Pointer BoundingBoxPointer
typedef ChildrenListTypeChildrenListPointer
typedef CovariantVector
< ScalarType, VDimension > 
CovariantVectorType
typedef Index< VDimension > IndexType
typedef Point< ScalarType,
VDimension > 
InputType
typedef Offset< VDimension > OffsetType
typedef OutputVectorTypeOutputVectorPointer
typedef CovariantVector
< double, VDimension > 
OutputVectorType
typedef PointTypePointPointer
typedef PropertyType::Pointer PropertyPointer
typedef SpatialObjectProperty
< float > 
PropertyType
typedef ImageRegion< VDimension > RegionType
typedef Size< VDimension > SizeType
typedef double * SpacingType
typedef const TransformTypeTransformConstPointer
typedef TransformType::Pointer TransformPointer
typedef
ScalableAffineTransform
< double, VDimension > 
TransformType
typedef VectorContainer
< IdentifierType, PointType
VectorContainerType
typedef VectorTypeVectorPointer
typedef Vector< ScalarType,
VDimension > 
VectorType
- Public Types inherited from itk::DataObject
typedef std::string DataObjectIdentifierType
typedef std::vector< Pointer >
::size_type 
DataObjectPointerArraySizeType
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

bool AddStrand (PolygonSpatialObject< TDimension > *toAdd)
virtual ::itk::LightObject::Pointer CreateAnother (void) const
bool DeleteStrand (PolygonSpatialObject< TDimension > *toDelete)
virtual const char * GetNameOfClass () const
bool IsClosed ()
virtual bool IsInside (const PointType &point, unsigned int depth=0, char *name=NULL) const
double MeasureVolume ()
unsigned int NumberOfStrands ()
bool ReplaceStrand (PolygonSpatialObject< TDimension > *toReplace, PolygonSpatialObject< TDimension > *replacement)
double Volume ()
bool ComputeLocalBoundingBox () const
- Public Member Functions inherited from itk::SpatialObject< TDimension >
void AddSpatialObject (Self *pointer)
virtual void Clear (void)
virtual bool ComputeBoundingBox () const
void ComputeObjectToParentTransform (void)
void ComputeObjectToWorldTransform (void)
virtual void DerivativeAt (const PointType &point, short unsigned int order, OutputVectorType &value, unsigned int depth=0, char *name=NULL)
bool Evaluate (const PointType &point) const
virtual BoundingBoxTypeGetBoundingBox () const
virtual const RegionTypeGetBufferedRegion () const
virtual ChildrenListTypeGetChildren (unsigned int depth=0, char *name=NULL) const
TransformTypeGetIndexToObjectTransform (void)
const TransformTypeGetIndexToObjectTransform (void) const
virtual TransformTypeGetIndexToWorldTransform ()
virtual const TransformTypeGetIndexToWorldTransform ()
virtual const RegionTypeGetLargestPossibleRegion () const
unsigned int GetMaximumDepth () const
unsigned long GetMTime (void) const
TransformTypeGetNodeToParentNodeTransform (void)
const TransformTypeGetNodeToParentNodeTransform (void) const
unsigned int GetNumberOfChildren (unsigned int depth=0, char *name=NULL) const
unsigned int GetObjectDimension (void) const
unsigned long GetObjectMTime (void) const
TransformTypeGetObjectToNodeTransform (void)
const TransformTypeGetObjectToNodeTransform (void) const
TransformTypeGetObjectToParentTransform (void)
const TransformTypeGetObjectToParentTransform (void) const
virtual TransformTypeGetObjectToWorldTransform ()
virtual const TransformTypeGetObjectToWorldTransform ()
virtual const SelfGetParent (void) const
virtual SelfGetParent (void)
virtual const RegionTypeGetRequestedRegion () const
virtual const double * GetSpacing () const
virtual std::string GetSpatialObjectTypeAsString () const
unsigned long GetTransformMTime (void)
virtual const char * GetTypeName (void) const
unsigned long GetWorldTransformMTime (void)
virtual bool HasParent (void) const
virtual bool IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
virtual bool IsInside (const PointType &point, unsigned int depth=0, char *name=NULL) const
void RemoveSpatialObject (Self *object)
virtual void SetBufferedRegion (const RegionType &region)
void SetChildren (ChildrenListType &children)
virtual void SetLargestPossibleRegion (const RegionType &region)
void SetNodeToParentNodeTransform (TransformType *transform)
void SetObjectToParentTransform (TransformType *transform)
void SetObjectToWorldTransform (TransformType *transform)
void SetParent (Self *parent)
virtual void SetRequestedRegion (const RegionType &region)
virtual void SetRequestedRegion (const DataObject *data)
void SetSpacing (const double spacing[itkGetStaticConstMacro(ObjectDimension)])
virtual void SetTreeNode (TreeNodeType *_arg)
virtual void Update (void)
virtual bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
virtual const
AffineGeometryFrameType
GetAffineGeometryFrame ()
virtual void SetAffineGeometryFrame (AffineGeometryFrameType *_arg)
const OffsetValueTypeGetOffsetTable () const
OffsetValueType ComputeOffset (const IndexType &ind) const
IndexType ComputeIndex (OffsetValueType offset) const
virtual void CopyInformation (const DataObject *data)
virtual void UpdateOutputInformation ()
virtual void SetRequestedRegionToLargestPossibleRegion ()
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
virtual bool VerifyRequestedRegion ()
PropertyTypeGetProperty (void)
const PropertyTypeGetProperty (void) const
void SetProperty (PropertyType *property)
virtual const int & GetId ()
virtual void SetId (int _arg)
virtual void SetParentId (int _arg)
virtual const int & GetParentId ()
virtual TreeNodeTypeGetTreeNode ()
virtual const TreeNodeTypeGetTreeNode ()
virtual void SetBoundingBoxChildrenDepth (unsigned int _arg)
virtual const unsigned int & GetBoundingBoxChildrenDepth ()
virtual void SetBoundingBoxChildrenName (std::string _arg)
virtual const std::string & GetBoundingBoxChildrenName ()
virtual void SetDefaultInsideValue (double _arg)
virtual double GetDefaultInsideValue () const
virtual void SetDefaultOutsideValue (double _arg)
virtual double GetDefaultOutsideValue () const
- Public Member Functions inherited from itk::DataObject
virtual void DataHasBeenGenerated ()
void DisconnectPipeline ()
bool GetDataReleased () const
virtual const bool & GetReleaseDataFlag ()
SmartPointerForwardReference
< ProcessObject
GetSource () const
DataObjectPointerArraySizeType GetSourceOutputIndex () const
const DataObjectIdentifierTypeGetSourceOutputName () const
virtual unsigned long GetUpdateMTime () const
virtual void Initialize ()
virtual void PrepareForNewData ()
virtual void PropagateRequestedRegion ()
void ReleaseData ()
virtual void ReleaseDataFlagOff ()
virtual void ReleaseDataFlagOn ()
virtual void ResetPipeline ()
void SetReleaseDataFlag (bool flag)
bool ShouldIReleaseData () const
virtual void UpdateOutputData ()
void SetPipelineMTime (unsigned long time)
virtual const unsigned long & GetPipelineMTime ()
virtual void SetRealTimeStamp (RealTimeStamp _arg)
virtual const RealTimeStampGetRealTimeStamp ()
virtual void Graft (const DataObject *)
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
unsigned long AddObserver (const EventObject &event, Command *) const
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual const TimeStampGetTimeStamp () const
bool HasObserver (const EventObject &event) const
void InvokeEvent (const EventObject &)
void InvokeEvent (const EventObject &) const
virtual void Modified () const
virtual void Register () const
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () const
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
virtual int GetReferenceCount () const
 itkCloneMacro (Self)
void Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions

static Pointer New ()

Protected Member Functions

void operator= (const Self &)
 PolygonGroupSpatialObject (const Self &)
 PolygonGroupSpatialObject (void)
 ~PolygonGroupSpatialObject (void)
- Protected Member Functions inherited from itk::GroupSpatialObject< TDimension >
 GroupSpatialObject ()
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual ~GroupSpatialObject ()
 GroupSpatialObject (const Self &)
- Protected Member Functions inherited from itk::SpatialObject< TDimension >
void ComputeOffsetTable ()
virtual const BoundingBoxTypeGetBounds ()
virtual const unsigned int & GetDimension ()
virtual const TransformTypeGetInternalInverseTransform ()
virtual void SetDimension (unsigned int _arg)
bool SetInternalInverseTransformToWorldToIndexTransform () const
virtual void SetTypeName (std::string _arg)
 SpatialObject ()
virtual ~SpatialObject ()
- Protected Member Functions inherited from itk::DataObject
virtual void PropagateResetPipeline ()
 DataObject ()
 ~DataObject ()
- Protected Member Functions inherited from itk::Object
 Object ()
bool PrintObservers (std::ostream &os, Indent indent) const
virtual void SetTimeStamp (const TimeStamp &time)
virtual ~Object ()
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 LightObject ()
virtual void PrintHeader (std::ostream &os, Indent indent) const
virtual void PrintTrailer (std::ostream &os, Indent indent) const
virtual ~LightObject ()

Detailed Description

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

Implements a Region Of Interest Type.

This class implements a Region of Interest, which is simply a space in a medical image that has some significance as a component of the scan. Different components of brain anatomy, for instance are Regions of Interest in the human brain. The primary difference between PolygonGroupSpatialObject and other descendants of SpatialObject are these:

  1. For now, an PolygonGroup needs to comprise a series of slices parallel to a plane swept by any two of the major axes. In other words, the points in each slice (or strand) all need to have one of the X,Y,Z values to be constant.
  2. The IsInside method implements the concept of spatial 'insidedness' where other descendents of SpatialObject have a concept of insidedness defined in a rather ad-hoc manner. PolygonGroupSpatialObjects define IsInside to mean that the given point resides in space inside the surface of the PolygonGroupSpatialObject.

Definition at line 50 of file itkPolygonGroupSpatialObject.h.


Member Typedef Documentation

template<unsigned int TDimension = 3>
typedef Superclass::BoundingBoxType itk::PolygonGroupSpatialObject< TDimension >::BoundingBoxType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 59 of file itkPolygonGroupSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::ChildrenListType itk::PolygonGroupSpatialObject< TDimension >::ChildrenListType

Return type for the list of children

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 60 of file itkPolygonGroupSpatialObject.h.

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

Reimplemented from itk::GroupSpatialObject< TDimension >.

Definition at line 57 of file itkPolygonGroupSpatialObject.h.

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

Reimplemented from itk::GroupSpatialObject< TDimension >.

Definition at line 56 of file itkPolygonGroupSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 58 of file itkPolygonGroupSpatialObject.h.

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

Standard class typedefs.

Reimplemented from itk::GroupSpatialObject< TDimension >.

Definition at line 54 of file itkPolygonGroupSpatialObject.h.

template<unsigned int TDimension = 3>
typedef GroupSpatialObject< TDimension > itk::PolygonGroupSpatialObject< TDimension >::Superclass

Reimplemented from itk::GroupSpatialObject< TDimension >.

Definition at line 55 of file itkPolygonGroupSpatialObject.h.

template<unsigned int TDimension = 3>
typedef TreeNodeType::ChildrenListType itk::PolygonGroupSpatialObject< TDimension >::TreeNodeChildrenListType

Reimplemented from itk::GroupSpatialObject< TDimension >.

Definition at line 62 of file itkPolygonGroupSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::TreeNodeType itk::PolygonGroupSpatialObject< TDimension >::TreeNodeType

Reimplemented from itk::GroupSpatialObject< TDimension >.

Definition at line 61 of file itkPolygonGroupSpatialObject.h.


Constructor & Destructor Documentation

template<unsigned int TDimension = 3>
itk::PolygonGroupSpatialObject< TDimension >::PolygonGroupSpatialObject ( const Self )
protected
template<unsigned int TDimension = 3>
itk::PolygonGroupSpatialObject< TDimension >::PolygonGroupSpatialObject ( void  )
inlineprotected

Definition at line 106 of file itkPolygonGroupSpatialObject.h.

template<unsigned int TDimension = 3>
itk::PolygonGroupSpatialObject< TDimension >::~PolygonGroupSpatialObject ( void  )
inlineprotected

Definition at line 107 of file itkPolygonGroupSpatialObject.h.


Member Function Documentation

template<unsigned int TDimension = 3>
bool itk::PolygonGroupSpatialObject< TDimension >::AddStrand ( PolygonSpatialObject< TDimension > *  toAdd)

Return true if the given PolygonSpatialObject is successfully added to the PolygonGroup.

template<unsigned int TDimension = 3>
virtual::itk::LightObject::Pointer itk::PolygonGroupSpatialObject< TDimension >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::GroupSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
bool itk::PolygonGroupSpatialObject< TDimension >::DeleteStrand ( PolygonSpatialObject< TDimension > *  toDelete)

Return true if the given PolygonSpatialObject is successfully removed from the PolygonGroup

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

Method for creation through the object factory.

Reimplemented from itk::GroupSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
bool itk::PolygonGroupSpatialObject< TDimension >::IsClosed ( )

Return true if all constituent Polygons are closed.

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

Test whether a point is inside or outside the object.

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

Same as Volume, above.

template<unsigned int TDimension = 3>
static Pointer itk::PolygonGroupSpatialObject< TDimension >::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::GroupSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
unsigned int itk::PolygonGroupSpatialObject< TDimension >::NumberOfStrands ( )

returns the number of Polygons in this PolygonGroup

template<unsigned int TDimension = 3>
void itk::PolygonGroupSpatialObject< TDimension >::operator= ( const Self )
protected
template<unsigned int TDimension = 3>
bool itk::PolygonGroupSpatialObject< TDimension >::ReplaceStrand ( PolygonSpatialObject< TDimension > *  toReplace,
PolygonSpatialObject< TDimension > *  replacement 
)

Return true if the given PolygonSpatialObject successfully replaces the Polygon given in toReplace. This will fail if toReplace is not a strand in the PolygonGroupObject.

template<unsigned int TDimension = 3>
double itk::PolygonGroupSpatialObject< TDimension >::Volume ( )

Volume of this PolygonGroup, which is the sum of the volume of all its constituent Polygons


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