itk::SpatialObjectPoint< TPointDimension > Class Template Reference

Point used for spatial objets. More...

#include <itkSpatialObjectPoint.h>

Inheritance diagram for itk::SpatialObjectPoint:

[legend]Collaboration diagram for itk::SpatialObjectPoint< TPointDimension >:

[legend]List of all members.

Public Types
typedef SpatialObjectPoint	Self
typedef LightObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef const SmartPointer< const Self >	ConstPointer
typedef Point< double, TPointDimension >	PointType
typedef vnl_vector< double >	VectorType
typedef VectorType *	VectorPointer
typedef RGBAPixel< float >	PixelType
Public Methods
virtual const char *	GetClassName () const
unsigned int	GetId (void)
void	SetId (const unsigned int newID)
Self &	GetReference (void)
Pointer	GetPointer (void)
ConstPointer	GetConstPointer (void)
PointType	GetPosition (void) const
unsigned short int	GetNumDimensions (void) const
Self &	operator= (const SpatialObjectPoint &rhs)
void	SetPosition (const PointType &newX)
void	SetPosition (const double x0, const double x1)
void	SetPosition (const double x0, const double x1, const double x2)
const PixelType &	GetColor (void) const
void	SetColor (const PixelType &color)
void	SetRed (float r)
float	GetRed (void) const
void	SetGreen (float g)
float	GetGreen (void) const
void	SetBlue (float b)
float	GetBlue (void) const
void	SetAlpha (float a)
float	GetAlpha (void) const
Static Public Methods
Pointer	New ()
Protected Methods
	SpatialObjectPoint (void)
	~SpatialObjectPoint (void)
void	PrintSelf (std::ostream &os, Indent indent) const
Protected Attributes
unsigned int	m_ID
PointType	m_X
PixelType	m_Color
unsigned short int	m_NumDimensions

---

Detailed Description

template<unsigned int TPointDimension = 3>
class itk::SpatialObjectPoint< TPointDimension >

Point used for spatial objets.

This class contains all the functions necessary to define a point

\also TubeSpatialObjectPoint SurfaceSpatialObjectPoint

Definition at line 37 of file itkSpatialObjectPoint.h.

---

Member Typedef Documentation

template<unsigned int TPointDimension = 3> typedef const SmartPointer< const Self > itk::SpatialObjectPoint< TPointDimension >::ConstPointer

Reimplemented from itk::LightObject. Reimplemented in itk::LineSpatialObjectPoint< TPointDimension >, itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >. Definition at line 46 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> typedef RGBAPixel< float > itk::SpatialObjectPoint< TPointDimension >::PixelType

Definition at line 50 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> typedef SmartPointer<Self> itk::SpatialObjectPoint< TPointDimension >::Pointer

Reimplemented from itk::LightObject. Reimplemented in itk::LineSpatialObjectPoint< TPointDimension >, itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >. Definition at line 45 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> typedef Point< double, TPointDimension > itk::SpatialObjectPoint< TPointDimension >::PointType

Reimplemented in itk::LineSpatialObjectPoint< TPointDimension >, itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >. Definition at line 47 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> typedef SpatialObjectPoint itk::SpatialObjectPoint< TPointDimension >::Self

Standard clas typedefs. Reimplemented from itk::LightObject. Reimplemented in itk::LineSpatialObjectPoint< TPointDimension >, itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >. Definition at line 43 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> typedef LightObject itk::SpatialObjectPoint< TPointDimension >::Superclass

Reimplemented in itk::LineSpatialObjectPoint< TPointDimension >, itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >. Definition at line 44 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> typedef VectorType* itk::SpatialObjectPoint< TPointDimension >::VectorPointer

Reimplemented in itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >. Definition at line 49 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> typedef vnl_vector< double > itk::SpatialObjectPoint< TPointDimension >::VectorType

Reimplemented in itk::LineSpatialObjectPoint< TPointDimension >, itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >. Definition at line 48 of file itkSpatialObjectPoint.h.

---

Constructor & Destructor Documentation

template<unsigned int TPointDimension = 3> itk::SpatialObjectPoint< TPointDimension >::SpatialObjectPoint (  void    )  [protected]

Constructor. This one defines the # of dimensions in the SpatialObjectPoint

template<unsigned int TPointDimension = 3> itk::SpatialObjectPoint< TPointDimension >::~SpatialObjectPoint (  void    )  [protected]

Default destructor.

---

Member Function Documentation

template<unsigned int TPointDimension = 3> float itk::SpatialObjectPoint< TPointDimension >::GetAlpha (  void    )  const

Set/Get alpha value of the point

template<unsigned int TPointDimension = 3> float itk::SpatialObjectPoint< TPointDimension >::GetBlue (  void    )  const

Set/Get blue color of the point

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

Reimplemented in itk::LineSpatialObjectPoint< TPointDimension >, itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >.

template<unsigned int TPointDimension = 3> const PixelType& itk::SpatialObjectPoint< TPointDimension >::GetColor (  void    )  const

Set/Get color of the point

template<unsigned int TPointDimension = 3> ConstPointer itk::SpatialObjectPoint< TPointDimension >::GetConstPointer (  void    )  [inline]

Returns a const pointer to self. Definition at line 69 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> float itk::SpatialObjectPoint< TPointDimension >::GetGreen (  void    )  const

Set/Get Green color of the point

template<unsigned int TPointDimension = 3> unsigned int itk::SpatialObjectPoint< TPointDimension >::GetId (  void    )

Get the SpatialObjectPoint Id.

template<unsigned int TPointDimension = 3> unsigned short int itk::SpatialObjectPoint< TPointDimension >::GetNumDimensions (  void    )  const

Get # of dimensions Reimplemented in itk::TubeSpatialObjectPoint< TPointDimension >.

template<unsigned int TPointDimension = 3> Pointer itk::SpatialObjectPoint< TPointDimension >::GetPointer (  void    )

Returns a pointer to self.

template<unsigned int TPointDimension = 3> PointType itk::SpatialObjectPoint< TPointDimension >::GetPosition (  void    )  const

Return a pointer to the point object.

template<unsigned int TPointDimension = 3> float itk::SpatialObjectPoint< TPointDimension >::GetRed (  void    )  const

Set/Get red color of the point

template<unsigned int TPointDimension = 3> Self& itk::SpatialObjectPoint< TPointDimension >::GetReference (  void    )

Returns a reference to self.

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

Method for creation through the object factory. Reimplemented from itk::LightObject. Reimplemented in itk::LineSpatialObjectPoint< TPointDimension >, itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >.

template<unsigned int TPointDimension = 3> Self& itk::SpatialObjectPoint< TPointDimension >::operator= (  const SpatialObjectPoint< TPointDimension > &    rhs )

Copy one SpatialObjectPoint to another

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

PrintSelf method Reimplemented from itk::LightObject. Reimplemented in itk::LineSpatialObjectPoint< TPointDimension >, itk::SurfaceSpatialObjectPoint< TPointDimension >, and itk::TubeSpatialObjectPoint< TPointDimension >.

template<unsigned int TPointDimension = 3> void itk::SpatialObjectPoint< TPointDimension >::SetAlpha (  float    a )

Set/Get alpha value of the point

template<unsigned int TPointDimension = 3> void itk::SpatialObjectPoint< TPointDimension >::SetBlue (  float    b )

Set/Get blue color of the point

template<unsigned int TPointDimension = 3> void itk::SpatialObjectPoint< TPointDimension >::SetColor (  const PixelType &    color )

Set/Get color of the point

template<unsigned int TPointDimension = 3> void itk::SpatialObjectPoint< TPointDimension >::SetGreen (  float    g )

Set/Get Green color of the point

template<unsigned int TPointDimension = 3> void itk::SpatialObjectPoint< TPointDimension >::SetId (  const unsigned int    newID )

Set the SpatialObjectPoint Id.

template<unsigned int TPointDimension = 3> void itk::SpatialObjectPoint< TPointDimension >::SetPosition (  const double    x0, const double    x1, const double    x2 )

Set the point object. Couldn't use macros for these methods.

template<unsigned int TPointDimension = 3> void itk::SpatialObjectPoint< TPointDimension >::SetPosition (  const double    x0, const double    x1 )

Set the point object. Couldn't use macros for these methods.

template<unsigned int TPointDimension = 3> void itk::SpatialObjectPoint< TPointDimension >::SetPosition (  const PointType &    newX )

Set the point object. Couldn't use macros for these methods.

template<unsigned int TPointDimension = 3> void itk::SpatialObjectPoint< TPointDimension >::SetRed (  float    r )

Set/Get red color of the point

---

Member Data Documentation

template<unsigned int TPointDimension = 3> PixelType itk::SpatialObjectPoint< TPointDimension >::m_Color [protected]

Color of the point Definition at line 129 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> unsigned int itk::SpatialObjectPoint< TPointDimension >::m_ID [protected]

A unique ID assigned to this SpatialObjectPoint Reimplemented in itk::TubeSpatialObjectPoint< TPointDimension >. Definition at line 123 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> unsigned short int itk::SpatialObjectPoint< TPointDimension >::m_NumDimensions [protected]

# of dimensions Reimplemented in itk::TubeSpatialObjectPoint< TPointDimension >. Definition at line 132 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3> PointType itk::SpatialObjectPoint< TPointDimension >::m_X [protected]

Position of the point Definition at line 126 of file itkSpatialObjectPoint.h.

---

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

• itkSpatialObjectPoint.h

---