itk::PolygonGroupSpatialObject< TDimension > Class Template Reference

Implements a Region Of Interest Type. More...

#include <itkPolygonGroupSpatialObject.h>

Inheritance diagram for itk::PolygonGroupSpatialObject< TDimension >:

[legend]Collaboration diagram for itk::PolygonGroupSpatialObject< TDimension >:

[legend]List of all members.

Public Types
typedef PolygonGroupSpatialObject< TDimension >	Self
typedef GroupSpatialObject< TDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::PointType	PointType
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef Superclass::ChildrenListType	ChildrenListType
typedef Superclass::TreeNodeType	TreeNodeType
typedef TreeNodeType::ChildrenListType	TreeNodeChildrenListType
Public Member Functions
virtual const char *	GetNameOfClass () const
bool	AddStrand (PolygonSpatialObject< TDimension > *toAdd)
bool	DeleteStrand (PolygonSpatialObject< TDimension > *toDelete)
bool	ReplaceStrand (PolygonSpatialObject< TDimension > *toReplace, PolygonSpatialObject< TDimension > *replacement)
bool	IsClosed ()
unsigned int	NumberOfStrands ()
double	Volume ()
double	MeasureVolume ()
virtual bool	IsInside (const PointType &point, unsigned int depth=0, char *name=NULL) const
Static Public Member Functions
Pointer	New ()

---

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 54 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 64 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 65 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 62 of file itkPolygonGroupSpatialObject.h.

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

Reimplemented from itk::GroupSpatialObject< TDimension >. Definition at line 61 of file itkPolygonGroupSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 63 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 59 of file itkPolygonGroupSpatialObject.h.

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

Reimplemented from itk::GroupSpatialObject< TDimension >. Definition at line 60 of file itkPolygonGroupSpatialObject.h.

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

Reimplemented from itk::GroupSpatialObject< TDimension >. Definition at line 67 of file itkPolygonGroupSpatialObject.h.

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

Reimplemented from itk::GroupSpatialObject< TDimension >. Definition at line 66 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> 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. Reimplemented from itk::SpatialObject< TDimension >.

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

Same as Volume, above.

template<unsigned int TDimension = 3> 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> 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:

• itkPolygonGroupSpatialObject.h

---