itk::TubeSpatialObject< TDimension > Class Template Reference

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

#include <itkTubeSpatialObject.h>

Inheritance diagram for itk::TubeSpatialObject:

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

[legend]List of all members.

Public Types
typedef TubeSpatialObject	Self
typedef SpatialObject< TDimension >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef double	ScalarType
typedef itk::TubeSpatialObjectPoint< TDimension >	TubePointType
typedef std::list< TubePointType >	PointListType
typedef PointListType *	PointListPointer
typedef Superclass::PointType	PointType
typedef VectorContainer< unsigned long, PointType >	PointContainerType
typedef SmartPointer< PointContainerType >	PointContainerPointer
typedef Superclass::VectorType	VectorType
Public Methods
virtual const char *	GetClassName () const
PointListType &	GetPoints (void)
const PointListType &	GetPoints (void) const
void	Clear (void)
bool	CalcTangent (void)
bool	CalcNormal (void)
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=0, char *name=NULL) const
bool	ComputeBoundingBox (unsigned int depth=0, char *name=NULL)
void	SetPoints (PointListType &newPoints)
virtual void	SetParentPoint (int _arg)
virtual int	GetParentPoint ()
Static Public Methods
Pointer	New ()
Protected Methods
	TubeSpatialObject ()
virtual	~TubeSpatialObject ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
PointListType	m_Points
int	m_ParentPoint

---

Detailed Description

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

Representation of a tube based on the spatial object classes.

The tube is basically defined by a set of points. Each tube can be connected to a tube network, by using the AddSpatialObject() methods of a TubeSpatialObject Object. A tube is also identified by an id number when connected to a network.

\also TubeSpatialObjectPoint

Definition at line 42 of file itkTubeSpatialObject.h.

---

Member Typedef Documentation

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

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 51 of file itkTubeSpatialObject.h.

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

Definition at line 58 of file itkTubeSpatialObject.h.

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

Definition at line 57 of file itkTubeSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 50 of file itkTubeSpatialObject.h.

template<unsigned int TDimension = 3> typedef PointListType* itk::TubeSpatialObject< TDimension >::PointListPointer

Definition at line 55 of file itkTubeSpatialObject.h.

template<unsigned int TDimension = 3> typedef std::list< TubePointType > itk::TubeSpatialObject< TDimension >::PointListType

Definition at line 54 of file itkTubeSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 56 of file itkTubeSpatialObject.h.

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

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 52 of file itkTubeSpatialObject.h.

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

Standard class typedefs. Reimplemented from itk::SpatialObject< TDimension >. Definition at line 48 of file itkTubeSpatialObject.h.

template<unsigned int TDimension = 3> typedef SpatialObject< TDimension > itk::TubeSpatialObject< TDimension >::Superclass

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 49 of file itkTubeSpatialObject.h.

template<unsigned int TDimension = 3> typedef itk::TubeSpatialObjectPoint< TDimension > itk::TubeSpatialObject< TDimension >::TubePointType

Definition at line 53 of file itkTubeSpatialObject.h.

template<unsigned int TDimension = 3> typedef Superclass::VectorType itk::TubeSpatialObject< TDimension >::VectorType

Reimplemented from itk::SpatialObject< TDimension >. Definition at line 59 of file itkTubeSpatialObject.h.

---

Constructor & Destructor Documentation

template<unsigned int TDimension = 3> itk::TubeSpatialObject< TDimension >::TubeSpatialObject (    )  [protected]

template<unsigned int TDimension = 3> virtual itk::TubeSpatialObject< TDimension >::~TubeSpatialObject (    )  [protected, virtual]

---

Member Function Documentation

template<unsigned int TDimension = 3> bool itk::TubeSpatialObject< TDimension >::CalcNormal (  void    )

Calculate the normal vector of the tube.

template<unsigned int TDimension = 3> bool itk::TubeSpatialObject< TDimension >::CalcTangent (  void    )

Calculate the normalized tangent

template<unsigned int TDimension = 3> void itk::TubeSpatialObject< TDimension >::Clear (  void    )  [virtual]

Remove the list of tube points Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> bool itk::TubeSpatialObject< TDimension >::ComputeBoundingBox (  unsigned int    depth = 0, char *    name = NULL )  [virtual]

Compute the boundaries of the tube. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> virtual const char* itk::TubeSpatialObject< TDimension >::GetClassName (    )  const [virtual]

Method for creation through the object factory. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> virtual int itk::TubeSpatialObject< TDimension >::GetParentPoint (    )  [virtual]

Set/Get the parent point which corresponds to the position of the point in the parent's points list

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

Returns a reference to the list of the tube points.

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

Returns a reference to the list of the tube points.

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

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

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

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

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

Method for creation through the object factory. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> virtual void itk::TubeSpatialObject< TDimension >::PrintSelf (  std::ostream &    os, Indent    indent )  const [protected, virtual]

Method to print the object. Reimplemented from itk::SpatialObject< TDimension >.

template<unsigned int TDimension = 3> virtual void itk::TubeSpatialObject< TDimension >::SetParentPoint (  int    _arg )  [virtual]

Set/Get the parent point which corresponds to the position of the point in the parent's points list

template<unsigned int TDimension = 3> void itk::TubeSpatialObject< TDimension >::SetPoints (  PointListType &    newPoints )

Set the list of tube points.

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

Returns the value of the tube at that point. Currently this function returns a binary value, but it might want to return a degree of membership in case of fuzzy tubes. Reimplemented from itk::SpatialObject< TDimension >.

---

Member Data Documentation

template<unsigned int TDimension = 3> int itk::TubeSpatialObject< TDimension >::m_ParentPoint [protected]

Definition at line 115 of file itkTubeSpatialObject.h.

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

Definition at line 114 of file itkTubeSpatialObject.h.

---

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

• itkTubeSpatialObject.h

---