itk::PolygonSpatialObject< TDimension > Class Template Reference

#include <itkPolygonSpatialObject.h>

Inheritance diagram for itk::PolygonSpatialObject< TDimension >:

Collaboration diagram for itk::PolygonSpatialObject< TDimension >:

Detailed Description

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

TODO.

Definition at line 30 of file itkPolygonSpatialObject.h.

Public Types
typedef Superclass::BlobPointType	BlobPointType
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointListType	PointListType
typedef Superclass::PointType	PointType
enum	PolygonGroupOrientation {   Axial = 0,   Coronal = 1,   Sagittal = 2,   UserPlane = 3,   Unknown = 4 }
typedef PolygonSpatialObject < TDimension >	Self
typedef BlobSpatialObject < TDimension >	Superclass
typedef Superclass::TransformType	TransformType
Public Types inherited from itk::BlobSpatialObject< TDimension >
typedef SpatialObjectPoint < TDimension >	BlobPointType
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer < PointContainerType >	PointContainerPointer
typedef VectorContainer < IdentifierType, PointType >	PointContainerType
typedef SmartPointer< Self >	Pointer
typedef std::vector < BlobPointType >	PointListType
typedef Superclass::PointType	PointType
typedef double	ScalarType
typedef BlobSpatialObject	Self
typedef Superclass::SpatialObjectPointType	SpatialObjectPointType
typedef PointBasedSpatialObject < TDimension >	Superclass
typedef Superclass::TransformType	TransformType
Public Types inherited from itk::PointBasedSpatialObject< TDimension >
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::CovariantVectorType	CovariantVectorType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef double	ScalarType
typedef PointBasedSpatialObject	Self
typedef SpatialObjectPoint < TDimension >	SpatialObjectPointType
typedef SpatialObject< TDimension >	Superclass
typedef Superclass::TransformType	TransformType
typedef Superclass::VectorType	VectorType
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	AddPoint (const PointType &pointToAdd)
PointType	ClosestPoint (const PointType &curPoint) const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
bool	DeletePoint (const PointType &pointToDelete)
virtual const char *	GetNameOfClass () const
virtual double	GetThickness ()
bool	InsertPoint (const PointType &point1, const PointType &pointToAdd)
bool	IsClosed () const
virtual bool	IsInside (const PointType &point, unsigned int depth, char *name) const
virtual bool	IsInside (const PointType &point) const
double	MeasureArea () const
double	MeasurePerimeter () const
double	MeasureVolume () const
unsigned int	NumberOfPoints () const
PolygonGroupOrientation	Plane () const
bool	RemoveSegment (const PointType &startpoint, const PointType &endPoint)
bool	ReplacePoint (const PointType &oldpoint, const PointType &newPoint)
virtual void	SetThickness (double _arg)
Public Member Functions inherited from itk::BlobSpatialObject< TDimension >
bool	ComputeLocalBoundingBox () const
SizeValueType	GetNumberOfPoints (void) const
const SpatialObjectPointType *	GetPoint (IdentifierType id) const
SpatialObjectPointType *	GetPoint (IdentifierType id)
PointListType &	GetPoints (void)
const PointListType &	GetPoints (void) const
bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
bool	IsInside (const PointType &point, unsigned int depth, char *name) const
bool	IsInside (const PointType &point) const
void	SetPoints (PointListType &newPoints)
bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
Public Member Functions inherited from itk::PointBasedSpatialObject< 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
TransformType *	GetIndexToObjectTransform (void)
const TransformType *	GetIndexToObjectTransform (void) const
virtual TransformType *	GetIndexToWorldTransform ()
virtual const TransformType *	GetIndexToWorldTransform ()
virtual const RegionType &	GetLargestPossibleRegion () const
unsigned int	GetMaximumDepth () const
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 TransformType *	GetObjectToWorldTransform ()
virtual const TransformType *	GetObjectToWorldTransform ()
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 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 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 TreeNodeType *	GetTreeNode ()
virtual const TreeNodeType *	GetTreeNode ()
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::BlobSpatialObject< TDimension >
static Pointer	New ()
Static Public Member Functions inherited from itk::PointBasedSpatialObject< 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	PrintSelf (std::ostream &os, Indent indent) const
Protected Member Functions inherited from itk::BlobSpatialObject< TDimension >
	BlobSpatialObject (const Self &)
	BlobSpatialObject ()
void	operator= (const Self &)
virtual	~BlobSpatialObject ()
Protected Member Functions inherited from itk::PointBasedSpatialObject< TDimension >
void	operator= (const Self &)
	PointBasedSpatialObject (const Self &)
	PointBasedSpatialObject ()
virtual	~PointBasedSpatialObject ()
Protected Member Functions inherited from itk::SpatialObject< TDimension >
void	ComputeOffsetTable ()
virtual const BoundingBoxType *	GetBounds ()
virtual const unsigned int &	GetDimension ()
virtual const TransformType *	GetInternalInverseTransform ()
virtual void	SetDimension (unsigned int _arg)
bool	SetInternalInverseTransformToWorldToIndexTransform () const
virtual void	SetTypeName (std::string _arg)
	SpatialObject ()
virtual	~SpatialObject ()
Protected Member Functions inherited from itk::DataObject
	DataObject ()
virtual void	PropagateResetPipeline ()
	~DataObject ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Private Member Functions
void	operator= (const Self &)
	PolygonSpatialObject (const Self &)
	PolygonSpatialObject ()

Private Attributes
PolygonGroupOrientation	m_Orientation
double	m_Thickness

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::BlobSpatialObject< TDimension >
PointListType	m_Points

Member Typedef Documentation

template<unsigned int TDimension = 3>

typedef Superclass::BlobPointType itk::PolygonSpatialObject< TDimension >::BlobPointType

Definition at line 41 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< const Self > itk::PolygonSpatialObject< TDimension >::ConstPointer

Definition at line 37 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< Self > itk::PolygonSpatialObject< TDimension >::Pointer

Definition at line 36 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::PointListType itk::PolygonSpatialObject< TDimension >::PointListType

Definition at line 40 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::PointType itk::PolygonSpatialObject< TDimension >::PointType

Definition at line 38 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>

typedef PolygonSpatialObject< TDimension > itk::PolygonSpatialObject< TDimension >::Self

Definition at line 34 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>

typedef BlobSpatialObject< TDimension > itk::PolygonSpatialObject< TDimension >::Superclass

Definition at line 35 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::TransformType itk::PolygonSpatialObject< TDimension >::TransformType

Definition at line 39 of file itkPolygonSpatialObject.h.

Member Enumeration Documentation

template<unsigned int TDimension = 3>

enum itk::PolygonSpatialObject::PolygonGroupOrientation

enumerates the possible spatial orientations

Enumerator:

Axial
Coronal
Sagittal
UserPlane
Unknown

Definition at line 52 of file itkPolygonSpatialObject.h.

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>

itk::PolygonSpatialObject< TDimension >::PolygonSpatialObject ( const Self &  )

private

template<unsigned int TDimension = 3>

itk::PolygonSpatialObject< TDimension >::PolygonSpatialObject ( )

inlineprivate

Definition at line 121 of file itkPolygonSpatialObject.h.

Member Function Documentation

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>

PointType itk::PolygonSpatialObject< TDimension >::ClosestPoint

(

const PointType &

curPoint

)

const

Method returns the Point closest to the given point

template<unsigned int TDimension = 3>

virtual::itk::LightObject::Pointer itk::PolygonSpatialObject< 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::BlobSpatialObject< TDimension >.

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

virtual double itk::PolygonSpatialObject< TDimension >::GetThickness ( )

virtual

Method gets the thickness of the current strand

template<unsigned int TDimension = 3>

bool itk::PolygonSpatialObject< TDimension >::InsertPoint	(	const PointType &	point1,
		const PointType &	pointToAdd
	)

Method inserts point after point1

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::PolygonSpatialObject< TDimension >::IsInside ( const PointType &  point, unsigned int  depth, char *  name  ) const

virtual

Test whether a point is inside or outside the object.

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.

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

template<unsigned int TDimension = 3>

static Pointer itk::PolygonSpatialObject< TDimension >::New ( )

static

Method for creation through the object factory.

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>

void itk::PolygonSpatialObject< TDimension >::operator= ( const Self &  )

private

template<unsigned int TDimension = 3>

PolygonGroupOrientation itk::PolygonSpatialObject< TDimension >::Plane

(

)

const

Method returning plane alignment of strand

template<unsigned int TDimension = 3>

void itk::PolygonSpatialObject< TDimension >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

Method to print the object.

Reimplemented from itk::BlobSpatialObject< TDimension >.

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>

bool itk::PolygonSpatialObject< TDimension >::ReplacePoint	(	const PointType &	oldpoint,
		const PointType &	newPoint
	)

Method replaces a point

template<unsigned int TDimension = 3>

virtual void itk::PolygonSpatialObject< TDimension >::SetThickness ( double  _arg )

virtual

Method sets the thickness of the current strand

Member Data Documentation

template<unsigned int TDimension = 3>

PolygonGroupOrientation itk::PolygonSpatialObject< TDimension >::m_Orientation

private

Definition at line 119 of file itkPolygonSpatialObject.h.

template<unsigned int TDimension = 3>

double itk::PolygonSpatialObject< TDimension >::m_Thickness

private

Definition at line 120 of file itkPolygonSpatialObject.h.

---

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

• itkPolygonSpatialObject.h