#include <itkPolygonSpatialObject.h>

Inheritance diagram for itk::PolygonSpatialObject< TDimension >:

Collaboration diagram for itk::PolygonSpatialObject< TDimension >:

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 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)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	PrintSelf (std::ostream &os, Indent indent) const
Private Member Functions
void	operator= (const Self &)
	PolygonSpatialObject (const Self &)
	PolygonSpatialObject ()
Private Attributes
PolygonGroupOrientation	m_Orientation
double	m_Thickness

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 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 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 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 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 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 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 Superclass::TransformType itk::PolygonSpatialObject< TDimension >::TransformType

Reimplemented from itk::BlobSpatialObject< TDimension >.

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 ( ) [inline, private]

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.

Reimplemented from itk::BlobSpatialObject< TDimension >.

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>

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.

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>

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

Reimplemented from itk::BlobSpatialObject< TDimension >.

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 `[protected, virtual]`

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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