itk::ContourSpatialObject< TDimension > Class Template Reference

#include <itkContourSpatialObject.h>

Inheritance diagram for itk::ContourSpatialObject< TDimension >:

Collaboration diagram for itk::ContourSpatialObject< TDimension >:

List of all members.

Public Types
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef SmartPointer< const Self >	ConstPointer
typedef std::vector < ControlPointType >	ControlPointListType
typedef ContourSpatialObjectPoint < TDimension >	ControlPointType
typedef std::vector < InterpolatedPointType >	InterpolatedPointListType
typedef SpatialObjectPoint < TDimension >	InterpolatedPointType
enum	InterpolationType {   NO_INTERPOLATION = 0,   EXPLICIT_INTERPOLATION,   BEZIER_INTERPOLATION,   LINEAR_INTERPOLATION }
typedef SmartPointer < PointContainerType >	PointContainerPointer
typedef VectorContainer < IdentifierType, PointType >	PointContainerType
typedef SmartPointer< Self >	Pointer
typedef Superclass::PointType	PointType
typedef double	ScalarType
typedef ContourSpatialObject	Self
typedef Superclass::SpatialObjectPointType	SpatialObjectPointType
typedef PointBasedSpatialObject < TDimension >	Superclass
typedef Superclass::TransformType	TransformType
Public Member Functions
bool	ComputeLocalBoundingBox (void) const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
const ControlPointType *	GetControlPoint (IdentifierType id) const
ControlPointType *	GetControlPoint (IdentifierType id)
ControlPointListType &	GetControlPoints (void)
const ControlPointListType &	GetControlPoints (void) const
const InterpolatedPointType *	GetInterpolatedPoint (IdentifierType id) const
InterpolatedPointType *	GetInterpolatedPoint (IdentifierType id)
InterpolatedPointListType &	GetInterpolatedPoints (void)
const InterpolatedPointListType &	GetInterpolatedPoints (void) const
virtual const char *	GetNameOfClass () const
SizeValueType	GetNumberOfControlPoints (void) const
SizeValueType	GetNumberOfInterpolatedPoints (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
virtual bool	IsInside (const PointType &point) const
void	SetControlPoints (ControlPointListType &newPoints)
void	SetInterpolatedPoints (InterpolatedPointListType &newPoints)
bool	ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
InterpolationType	GetInterpolationType () const
void	SetInterpolationType (InterpolationType interpolation)
virtual void	SetClosed (bool _arg)
virtual bool	GetClosed () const
virtual void	SetDisplayOrientation (int _arg)
virtual int	GetDisplayOrientation () const
virtual void	SetAttachedToSlice (int _arg)
virtual int	GetAttachedToSlice () const
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
	ContourSpatialObject (const Self &)
	ContourSpatialObject ()
void	operator= (const Self &)
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual	~ContourSpatialObject ()
Protected Attributes
int	m_AttachedToSlice
bool	m_Closed
ControlPointListType	m_ControlPoints
int	m_DisplayOrientation
InterpolatedPointListType	m_InterpolatedPoints
InterpolationType	m_InterpolationType

---

Detailed Description

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

Representation of a Contour based on the spatial object classes.

The Contour is basically defined by a set of points which are inside this blob

See also:

SpatialObjectPoint

Definition at line 39 of file itkContourSpatialObject.h.

---

Member Typedef Documentation

template<unsigned int TDimension = 3>

typedef Superclass::BoundingBoxType itk::ContourSpatialObject< TDimension >::BoundingBoxType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 57 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 47 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef std::vector< ControlPointType > itk::ContourSpatialObject< TDimension >::ControlPointListType

Definition at line 51 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef ContourSpatialObjectPoint< TDimension > itk::ContourSpatialObject< TDimension >::ControlPointType

Definition at line 49 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef std::vector< InterpolatedPointType > itk::ContourSpatialObject< TDimension >::InterpolatedPointListType

Definition at line 52 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SpatialObjectPoint< TDimension > itk::ContourSpatialObject< TDimension >::InterpolatedPointType

Definition at line 50 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef SmartPointer< PointContainerType > itk::ContourSpatialObject< TDimension >::PointContainerPointer

Definition at line 59 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef VectorContainer< IdentifierType, PointType > itk::ContourSpatialObject< TDimension >::PointContainerType

Definition at line 58 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 46 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 55 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef double itk::ContourSpatialObject< TDimension >::ScalarType

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 48 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef ContourSpatialObject itk::ContourSpatialObject< TDimension >::Self

Standard class typedefs.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 44 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef Superclass::SpatialObjectPointType itk::ContourSpatialObject< TDimension >::SpatialObjectPointType

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 54 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

typedef PointBasedSpatialObject< TDimension > itk::ContourSpatialObject< TDimension >::Superclass

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 45 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 56 of file itkContourSpatialObject.h.

---

Member Enumeration Documentation

template<unsigned int TDimension = 3>

enum itk::ContourSpatialObject::InterpolationType

Enumerator:

NO_INTERPOLATION
EXPLICIT_INTERPOLATION
BEZIER_INTERPOLATION
LINEAR_INTERPOLATION

Definition at line 109 of file itkContourSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>

itk::ContourSpatialObject< TDimension >::ContourSpatialObject

(

const Self &

)

[protected]

template<unsigned int TDimension = 3>

itk::ContourSpatialObject< TDimension >::ContourSpatialObject

(

)

[protected]

template<unsigned int TDimension = 3>

virtual itk::ContourSpatialObject< TDimension >::~ContourSpatialObject

(

)

[protected, virtual]

---

Member Function Documentation

template<unsigned int TDimension = 3>

bool itk::ContourSpatialObject< TDimension >::ComputeLocalBoundingBox

(

void

)

const [virtual]

Compute the boundaries of the Contour.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual::itk::LightObject::Pointer itk::ContourSpatialObject< 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::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual int itk::ContourSpatialObject< TDimension >::GetAttachedToSlice

(

)

const [virtual]

Set/Get the slice attached to the contour if any -1 is returned if no contour attached.

template<unsigned int TDimension = 3>

virtual bool itk::ContourSpatialObject< TDimension >::GetClosed

(

)

const [virtual]

Set/Get if the contour is closed

template<unsigned int TDimension = 3>

const ControlPointType* itk::ContourSpatialObject< TDimension >::GetControlPoint

(

IdentifierType

id

)

const [inline]

Return a control point in the list given the index

Definition at line 77 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

ControlPointType* itk::ContourSpatialObject< TDimension >::GetControlPoint

(

IdentifierType

id

)

[inline]

Return a control point in the list given the index

Definition at line 81 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

ControlPointListType& itk::ContourSpatialObject< TDimension >::GetControlPoints

(

void

)

Returns a reference to the list of the control points.

template<unsigned int TDimension = 3>

const ControlPointListType& itk::ContourSpatialObject< TDimension >::GetControlPoints

(

void

)

const

Returns a reference to the list of the control points.

template<unsigned int TDimension = 3>

virtual int itk::ContourSpatialObject< TDimension >::GetDisplayOrientation

(

)

const [virtual]

Set/Get the display orientation of the contour

template<unsigned int TDimension = 3>

const InterpolatedPointType* itk::ContourSpatialObject< TDimension >::GetInterpolatedPoint

(

IdentifierType

id

)

const [inline]

Return a interpolated point in the list given the index

Definition at line 98 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

InterpolatedPointType* itk::ContourSpatialObject< TDimension >::GetInterpolatedPoint

(

IdentifierType

id

)

[inline]

Return a interpolated point in the list given the index

Definition at line 102 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

InterpolatedPointListType& itk::ContourSpatialObject< TDimension >::GetInterpolatedPoints

(

void

)

Returns a reference to the list of the interpolated points.

template<unsigned int TDimension = 3>

const InterpolatedPointListType& itk::ContourSpatialObject< TDimension >::GetInterpolatedPoints

(

void

)

const

Returns a reference to the list of the interpolated points.

template<unsigned int TDimension = 3>

InterpolationType itk::ContourSpatialObject< TDimension >::GetInterpolationType

(

)

const [inline]

Set/Get the interpolation type

Definition at line 114 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

virtual const char* itk::ContourSpatialObject< TDimension >::GetNameOfClass

(

)

const [virtual]

Method for creation through the object factory.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

SizeValueType itk::ContourSpatialObject< TDimension >::GetNumberOfControlPoints

(

void

)

const [inline]

Return the number of control points in the list

Definition at line 85 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

SizeValueType itk::ContourSpatialObject< TDimension >::GetNumberOfInterpolatedPoints

(

void

)

const [inline]

Return the number of interpolated points in the list

Definition at line 106 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

bool itk::ContourSpatialObject< TDimension >::IsEvaluableAt	(	const PointType &	point,
		unsigned int	depth = 0,
		char *	name = NULL
	)		const

Returns true if the Contour is evaluable at the requested point, false otherwise.

Note: For this class, this will always return false. -GH

template<unsigned int TDimension = 3>

bool itk::ContourSpatialObject< TDimension >::IsInside	(	const PointType &	point,
		unsigned int	depth,
		char *	name
	)		const

Returns true if the point is inside the Contour, false otherwise.

template<unsigned int TDimension = 3>

virtual bool itk::ContourSpatialObject< 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>

static Pointer itk::ContourSpatialObject< TDimension >::New

(

)

[static]

Method for creation through the object factory.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

void itk::ContourSpatialObject< TDimension >::operator=

(

const Self &

)

[protected]

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual void itk::ContourSpatialObject< TDimension >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const [protected, virtual]

Method to print the object.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>

virtual void itk::ContourSpatialObject< TDimension >::SetAttachedToSlice

(

int

_arg

)

[virtual]

Set/Get the slice attached to the contour if any -1 is returned if no contour attached.

template<unsigned int TDimension = 3>

virtual void itk::ContourSpatialObject< TDimension >::SetClosed

(

bool

_arg

)

[virtual]

Set/Get if the contour is closed

template<unsigned int TDimension = 3>

void itk::ContourSpatialObject< TDimension >::SetControlPoints

(

ControlPointListType &

newPoints

)

Set the list of control points.

template<unsigned int TDimension = 3>

virtual void itk::ContourSpatialObject< TDimension >::SetDisplayOrientation

(

int

_arg

)

[virtual]

Set/Get the display orientation of the contour

template<unsigned int TDimension = 3>

void itk::ContourSpatialObject< TDimension >::SetInterpolatedPoints

(

InterpolatedPointListType &

newPoints

)

Set the list of interpolated points.

template<unsigned int TDimension = 3>

void itk::ContourSpatialObject< TDimension >::SetInterpolationType

(

InterpolationType

interpolation

)

[inline]

Set/Get the interpolation type

Definition at line 116 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

bool itk::ContourSpatialObject< TDimension >::ValueAt	(	const PointType &	point,
		double &	value,
		unsigned int	depth = 0,
		char *	name = NULL
	)		const

Returns the value of the Contour at that point. Currently this function returns a binary value, but it might want to return a degree of membership in case of fuzzy Contours.

---

Member Data Documentation

template<unsigned int TDimension = 3>

int itk::ContourSpatialObject< TDimension >::m_AttachedToSlice [protected]

Definition at line 172 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

bool itk::ContourSpatialObject< TDimension >::m_Closed [protected]

Definition at line 170 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

ControlPointListType itk::ContourSpatialObject< TDimension >::m_ControlPoints [protected]

Definition at line 167 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

int itk::ContourSpatialObject< TDimension >::m_DisplayOrientation [protected]

Definition at line 171 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

InterpolatedPointListType itk::ContourSpatialObject< TDimension >::m_InterpolatedPoints [protected]

Definition at line 168 of file itkContourSpatialObject.h.

template<unsigned int TDimension = 3>

InterpolationType itk::ContourSpatialObject< TDimension >::m_InterpolationType [protected]

Definition at line 169 of file itkContourSpatialObject.h.

---

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

• itkContourSpatialObject.h