ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
itk::LineSpatialObject< TDimension > Class Template Reference
Module ITKSpatialObjects

#include <itkLineSpatialObject.h>

+ Inheritance diagram for itk::LineSpatialObject< TDimension >:
+ Collaboration diagram for itk::LineSpatialObject< TDimension >:

List of all members.

Public Types

typedef Superclass::BoundingBoxType BoundingBoxType
typedef SmartPointer< const Self > ConstPointer
typedef const PointListType ConstPointListType
typedef LineSpatialObjectPoint
< TDimension > 		LinePointType
typedef SmartPointer
< PointContainerType > 		PointContainerPointer
typedef VectorContainer
< IdentifierType, PointType > 		PointContainerType
typedef SmartPointer< Self > Pointer
typedef std::vector
< LinePointType > 		PointListType
typedef Superclass::PointType PointType
typedef double ScalarType
typedef LineSpatialObject Self
typedef
Superclass::SpatialObjectPointType 		SpatialObjectPointType
typedef
PointBasedSpatialObject
< TDimension > 		Superclass
typedef Superclass::TransformType TransformType

Public Member Functions

bool ComputeLocalBoundingBox () const
virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual const char * GetNameOfClass () const
SizeValueType GetNumberOfPoints (void) const
const SpatialObjectPointType * GetPoint (IdentifierType id) const
SpatialObjectPointType * GetPoint (IdentifierType id)
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 SetPoints (PointListType &newPoints)
bool ValueAt (const PointType &point, double &value, unsigned int depth=0, char *name=NULL) const
PointListType & GetPoints (void)
ConstPointListType & GetPoints (void) const

Static Public Member Functions

static Pointer New ()

Protected Member Functions

 LineSpatialObject (const Self &)
 LineSpatialObject ()
void operator= (const Self &)
virtual void PrintSelf (std::ostream &os, Indent indent) const
virtual ~LineSpatialObject ()

Protected Attributes

PointListType m_Points

Detailed Description

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

Representation of a Line based on the spatial object classes.

The Line is basically defined by a set of points.

See also:
LineSpatialObjectPoint
Wiki Examples:

Definition at line 43 of file itkLineSpatialObject.h.

Member Typedef Documentation

template<unsigned int TDimension = 3>
typedef Superclass::BoundingBoxType itk::LineSpatialObject< TDimension >::BoundingBoxType

Reimplemented from itk::SpatialObject< TDimension >.

Definition at line 59 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< const Self > itk::LineSpatialObject< TDimension >::ConstPointer

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 51 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef const PointListType itk::LineSpatialObject< TDimension >::ConstPointListType

Definition at line 55 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef LineSpatialObjectPoint< TDimension > itk::LineSpatialObject< TDimension >::LinePointType

Definition at line 53 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef SmartPointer< PointContainerType > itk::LineSpatialObject< TDimension >::PointContainerPointer

Definition at line 61 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef VectorContainer< IdentifierType, PointType > itk::LineSpatialObject< TDimension >::PointContainerType

Definition at line 60 of file itkLineSpatialObject.h.

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 50 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef std::vector< LinePointType > itk::LineSpatialObject< TDimension >::PointListType

Definition at line 54 of file itkLineSpatialObject.h.

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 57 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef double itk::LineSpatialObject< TDimension >::ScalarType

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 52 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef LineSpatialObject itk::LineSpatialObject< TDimension >::Self

Standard class typedefs.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 48 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::SpatialObjectPointType itk::LineSpatialObject< TDimension >::SpatialObjectPointType

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 56 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef PointBasedSpatialObject< TDimension > itk::LineSpatialObject< TDimension >::Superclass

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 49 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
typedef Superclass::TransformType itk::LineSpatialObject< TDimension >::TransformType

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 58 of file itkLineSpatialObject.h.

Constructor & Destructor Documentation

template<unsigned int TDimension = 3>
itk::LineSpatialObject< TDimension >::LineSpatialObject ( const Self &  ) [protected]
template<unsigned int TDimension = 3>
itk::LineSpatialObject< TDimension >::LineSpatialObject ( ) [protected]
template<unsigned int TDimension = 3>
virtual itk::LineSpatialObject< TDimension >::~LineSpatialObject ( ) [protected, virtual]

Member Function Documentation

template<unsigned int TDimension = 3>
bool itk::LineSpatialObject< TDimension >::ComputeLocalBoundingBox ( ) const [virtual]

Compute the boundaries of the line.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual::itk::LightObject::Pointer itk::LineSpatialObject< 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 const char* itk::LineSpatialObject< TDimension >::GetNameOfClass ( ) const [virtual]

Method for creation through the object factory.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
SizeValueType itk::LineSpatialObject< TDimension >::GetNumberOfPoints ( void  ) const [inline, virtual]

Return the number of points in the list

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 87 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
const SpatialObjectPointType* itk::LineSpatialObject< TDimension >::GetPoint ( IdentifierType  id) const [inline, virtual]

Return a point in the list given the index

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 78 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
SpatialObjectPointType* itk::LineSpatialObject< TDimension >::GetPoint ( IdentifierType  id) [inline, virtual]

Return a point in the list given the index

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

Definition at line 84 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
PointListType& itk::LineSpatialObject< TDimension >::GetPoints ( void  ) [inline]

Returns a reference to the list of the Line points.

Definition at line 70 of file itkLineSpatialObject.h.

template<unsigned int TDimension = 3>
ConstPointListType& itk::LineSpatialObject< TDimension >::GetPoints ( void  ) const [inline]

Returns a reference to the list of the Line points.

Definition at line 71 of file itkLineSpatialObject.h.

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

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

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

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

template<unsigned int TDimension = 3>
virtual bool itk::LineSpatialObject< 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::LineSpatialObject< TDimension >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
void itk::LineSpatialObject< TDimension >::operator= ( const Self &  ) [protected]

Reimplemented from itk::PointBasedSpatialObject< TDimension >.

template<unsigned int TDimension = 3>
virtual void itk::LineSpatialObject< 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>
void itk::LineSpatialObject< TDimension >::SetPoints ( PointListType &  newPoints)

Set the list of line points.

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

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

Member Data Documentation

template<unsigned int TDimension = 3>
PointListType itk::LineSpatialObject< TDimension >::m_Points [protected]

Definition at line 117 of file itkLineSpatialObject.h.

The documentation for this class was generated from the following file:
Generated on Fri Mar 2 2012 00:56:52 for ITK by doxygen 1.7.6.1