itk::LineSpatialObject< TDimension > Class Template Reference

Representation of a Line based on the spatial object classes. More...

#include <itkLineSpatialObject.h>

Inheritance diagram for itk::LineSpatialObject< TDimension >:

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

[legend]List of all members.

Public Types
typedef LineSpatialObject	Self
typedef PointBasedSpatialObject< TDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef double	ScalarType
typedef LineSpatialObjectPoint< TDimension >	LinePointType
typedef std::vector< LinePointType >	PointListType
typedef Superclass::SpatialObjectPointType	SpatialObjectPointType
typedef Superclass::PointType	PointType
typedef Superclass::TransformType	TransformType
typedef Superclass::BoundingBoxType	BoundingBoxType
typedef VectorContainer< unsigned long, PointType >	PointContainerType
typedef SmartPointer< PointContainerType >	PointContainerPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
PointListType &	GetPoints (void)
void	SetPoints (PointListType &newPoints)
const SpatialObjectPointType *	GetPoint (unsigned long id) const
SpatialObjectPointType *	GetPoint (unsigned long id)
unsigned long	GetNumberOfPoints (void) const
bool	IsEvaluableAt (const PointType &point, unsigned int depth=0, char *name=NULL) const
bool	ValueAt (const PointType &point, double &value, 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
bool	ComputeLocalBoundingBox () const
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	LineSpatialObject ()
virtual	~LineSpatialObject ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
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

Definition at line 39 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 55 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 48 of file itkLineSpatialObject.h.

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

Definition at line 50 of file itkLineSpatialObject.h.

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

Definition at line 57 of file itkLineSpatialObject.h.

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

Definition at line 56 of file itkLineSpatialObject.h.

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >. Definition at line 47 of file itkLineSpatialObject.h.

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

Definition at line 51 of file itkLineSpatialObject.h.

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >. Definition at line 53 of file itkLineSpatialObject.h.

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >. Definition at line 49 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 45 of file itkLineSpatialObject.h.

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >. Definition at line 52 of file itkLineSpatialObject.h. Referenced by itk::LineSpatialObject< TDimension >::GetPoint().

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >. Definition at line 46 of file itkLineSpatialObject.h.

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

Reimplemented from itk::PointBasedSpatialObject< TDimension >. Definition at line 54 of file itkLineSpatialObject.h.

---

Constructor & Destructor Documentation

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 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> unsigned long itk::LineSpatialObject< TDimension >::GetNumberOfPoints (  void   )  const [inline, virtual]

Return the number of points in the list Reimplemented from itk::PointBasedSpatialObject< TDimension >. Definition at line 78 of file itkLineSpatialObject.h. References itk::LineSpatialObject< TDimension >::m_Points.

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

Return a point in the list given the index Reimplemented from itk::PointBasedSpatialObject< TDimension >. Definition at line 75 of file itkLineSpatialObject.h. References itk::LineSpatialObject< TDimension >::m_Points, and itk::LineSpatialObject< TDimension >::SpatialObjectPointType.

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

Return a point in the list given the index Reimplemented from itk::PointBasedSpatialObject< TDimension >. Definition at line 72 of file itkLineSpatialObject.h. References itk::LineSpatialObject< TDimension >::m_Points, and itk::LineSpatialObject< TDimension >::SpatialObjectPointType.

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

Returns a reference to the list of the Line points.

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

Returns true if the line is evaluable at the requested point, false otherwise. Reimplemented from itk::SpatialObject< TDimension >.

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> bool itk::LineSpatialObject< TDimension >::IsInside (  const PointType &  point, unsigned int  depth, char *  name )  const [virtual]

Returns true if the point is inside the line, false otherwise. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> Pointer itk::LineSpatialObject< TDimension >::New (   )  [static]

Method for creation through the object factory. 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 [virtual]

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. Reimplemented from itk::SpatialObject< TDimension >.

---

Member Data Documentation

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

Definition at line 107 of file itkLineSpatialObject.h. Referenced by itk::LineSpatialObject< TDimension >::GetNumberOfPoints(), and itk::LineSpatialObject< TDimension >::GetPoint().

---

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

• itkLineSpatialObject.h

---