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:

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

Public Types
typedef Superclass::BoundingBoxType	BoundingBoxType

typedef Superclass::ChildrenListType	ChildrenListType

typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

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 SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef double	ScalarType

typedef GroupSpatialObject	Self

typedef SpatialObject< TDimension >	Superclass

typedef TreeNodeType::ChildrenListType	TreeNodeChildrenListType

typedef Superclass::TreeNodeType	TreeNodeType

Public Types inherited from itk::SpatialObject< TDimension >
typedef AffineGeometryFrameType::Pointer	AffineGeometryFramePointer

typedef AffineGeometryFrame < double, VDimension >	AffineGeometryFrameType

typedef BoundingBoxType::Pointer	BoundingBoxPointer

typedef BoundingBox < IdentifierType, VDimension, ScalarType, VectorContainerType >	BoundingBoxType

typedef ChildrenListType *	ChildrenListPointer

typedef std::list< Pointer >	ChildrenListType

typedef SmartPointer< const Self >	ConstPointer

typedef CovariantVector < ScalarType, VDimension >	CovariantVectorType

typedef Index< VDimension >	IndexType

typedef Point< ScalarType, VDimension >	InputType

typedef Offset< VDimension >	OffsetType

typedef OutputVectorType *	OutputVectorPointer

typedef CovariantVector < double, VDimension >	OutputVectorType

typedef SmartPointer< Self >	Pointer

typedef PointType *	PointPointer

typedef Point< ScalarType, VDimension >	PointType

typedef PropertyType::Pointer	PropertyPointer

typedef SpatialObjectProperty < float >	PropertyType

typedef ImageRegion< VDimension >	RegionType

typedef double	ScalarType

typedef SpatialObject< VDimension >	Self

typedef Size< VDimension >	SizeType

typedef double *	SpacingType

typedef DataObject	Superclass

typedef const TransformType *	TransformConstPointer

typedef TransformType::Pointer	TransformPointer

typedef ScalableAffineTransform < double, VDimension >	TransformType

typedef SpatialObjectTreeNode < VDimension >	TreeNodeType

typedef VectorContainer < IdentifierType, PointType >	VectorContainerType

typedef VectorType *	VectorPointer

typedef Vector< ScalarType, VDimension >	VectorType

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

typedef std::string	DataObjectIdentifierType

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

typedef SmartPointer< Self >	Pointer

typedef DataObject	Self

typedef Object	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

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

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
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 ()

Public Member Functions inherited from itk::GroupSpatialObject< TDimension >
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 ::itk::LightObject::Pointer	CreateAnother (void) const

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 BoundingBoxType *	GetBoundingBox () const

virtual const RegionType &	GetBufferedRegion () const

virtual ChildrenListType *	GetChildren (unsigned int depth=0, char *name=NULL) const

const TransformType *	GetIndexToObjectTransform (void) const

TransformType *	GetIndexToObjectTransform (void)

virtual const TransformType *	GetIndexToWorldTransform () const

virtual const RegionType &	GetLargestPossibleRegion () const

unsigned int	GetMaximumDepth () const

TransformType *	GetModifiableIndexToObjectTransform (void)

virtual TransformType *	GetModifiableIndexToWorldTransform ()

virtual TreeNodeType *	GetModifiableTreeNode ()

ModifiedTimeType	GetMTime (void) const

TransformType *	GetNodeToParentNodeTransform (void)

const TransformType *	GetNodeToParentNodeTransform (void) const

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

unsigned int	GetObjectDimension (void) const

unsigned long	GetObjectMTime (void) const

TransformType *	GetObjectToNodeTransform (void)

const TransformType *	GetObjectToNodeTransform (void) const

TransformType *	GetObjectToParentTransform (void)

const TransformType *	GetObjectToParentTransform (void) const

virtual const Self *	GetParent (void) const

virtual Self *	GetParent (void)

virtual const RegionType &	GetRequestedRegion () const

virtual const double *	GetSpacing () const

virtual std::string	GetSpatialObjectTypeAsString () const

unsigned long	GetTransformMTime (void)

virtual const TreeNodeType *	GetTreeNode () const

virtual const char *	GetTypeName (void) const

unsigned long	GetWorldTransformMTime (void)

virtual bool	HasParent (void) const

virtual bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=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	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 void	SetAffineGeometryFrame (AffineGeometryFrameType *_arg)

virtual AffineGeometryFrameType *	GetModifiableAffineGeometryFrame ()

virtual const AffineGeometryFrameType *	GetAffineGeometryFrame () const

void	SetObjectToWorldTransform (TransformType *transform)

virtual TransformType *	GetModifiableObjectToWorldTransform ()

virtual const TransformType *	GetObjectToWorldTransform () const

const OffsetValueType *	GetOffsetTable () const

OffsetValueType	ComputeOffset (const IndexType &ind) const

IndexType	ComputeIndex (OffsetValueType offset) const

virtual void	CopyInformation (const DataObject *data)

virtual void	UpdateOutputInformation ()

virtual void	SetRequestedRegionToLargestPossibleRegion ()

virtual bool	RequestedRegionIsOutsideOfTheBufferedRegion ()

virtual bool	VerifyRequestedRegion ()

PropertyType *	GetProperty (void)

const PropertyType *	GetProperty (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 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 DataObjectIdentifierType &	GetSourceOutputName () const

virtual ModifiedTimeType	GetUpdateMTime () const

virtual void	Graft (const DataObject *)

virtual void	Initialize ()

virtual void	PrepareForNewData ()

virtual void	PropagateRequestedRegion ()

void	ReleaseData ()

virtual void	ReleaseDataFlagOff ()

virtual void	ReleaseDataFlagOn ()

virtual void	ResetPipeline ()

void	SetReleaseDataFlag (bool flag)

bool	ShouldIReleaseData () const

virtual void	UpdateOutputData ()

void	SetPipelineMTime (ModifiedTimeType time)

virtual const ModifiedTimeType &	GetPipelineMTime ()

virtual void	SetRealTimeStamp (RealTimeStamp _arg)

virtual const RealTimeStamp &	GetRealTimeStamp ()

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

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

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary (void)

const MetaDataDictionary &	GetMetaDataDictionary (void) const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const

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

Static Public Member Functions inherited from itk::GroupSpatialObject< TDimension >
static Pointer	New ()

Static Public Member Functions inherited from itk::SpatialObject< TDimension >
static Pointer	New ()

Static Public Member Functions inherited from itk::DataObject
static bool	GetGlobalReleaseDataFlag ()

static void	GlobalReleaseDataFlagOff ()

static void	GlobalReleaseDataFlagOn ()

static void	SetGlobalReleaseDataFlag (bool val)

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

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

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

static Pointer	New ()

Protected Member Functions
void	operator= (const Self &)

	PolygonGroupSpatialObject (const Self &)

	PolygonGroupSpatialObject (void)

	~PolygonGroupSpatialObject (void)

Protected Member Functions inherited from itk::GroupSpatialObject< TDimension >
	GroupSpatialObject (const Self &)

	GroupSpatialObject ()

void	operator= (const Self &)

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

virtual	~GroupSpatialObject ()

Protected Member Functions inherited from itk::SpatialObject< TDimension >
void	ComputeOffsetTable ()

virtual const BoundingBoxType *	GetBounds () const

virtual const unsigned int &	GetDimension ()

virtual const TransformType *	GetInternalInverseTransform () const

virtual BoundingBoxType *	GetModifiableBounds ()

virtual TransformType *	GetModifiableInternalInverseTransform ()

virtual void	SetDimension (unsigned int _arg)

bool	SetInternalInverseTransformToWorldToIndexTransform () const

virtual void	SetTypeName (std::string _arg)

	SpatialObject ()

virtual	~SpatialObject ()

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

virtual void	PropagateResetPipeline ()

	~DataObject ()

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

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object ()

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

	LightObject ()

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

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

virtual	~LightObject ()

Additional Inherited Members
Static Public Attributes inherited from itk::SpatialObject< TDimension >
static const unsigned int	MaximumDepth

static const unsigned int	ObjectDimension

Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Protected Attributes inherited from itk::LightObject
InternalReferenceCountType	m_ReferenceCount

SimpleFastMutexLock	m_ReferenceCountLock