Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::SpatialObjectPoint< TPointDimension > Class Template Reference

Point used for spatial objets. More...

#include <itkSpatialObjectPoint.h>

Inheritance diagram for itk::SpatialObjectPoint< TPointDimension >:

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

Collaboration graph
[legend]

List of all members.

Public Types

typedef PixelType ColorType
typedef RGBAPixel< float > PixelType
typedef Point< double,
TPointDimension > 
PointType
typedef SpatialObjectPoint Self
typedef vnl_vector< double > VectorType

Public Member Functions

int GetID (void) const
const PointTypeGetPosition (void) const
Selfoperator= (const SpatialObjectPoint &rhs)
void Print (std::ostream &os) const
void SetID (const int newID)
 SpatialObjectPoint (void)
virtual ~SpatialObjectPoint (void)
float GetAlpha (void) const
void SetAlpha (float a)
float GetBlue (void) const
void SetBlue (float b)
const PixelTypeGetColor (void) const
void SetColor (float r, float g, float b, float a=1)
void SetColor (const PixelType &color)
float GetGreen (void) const
void SetGreen (float g)
float GetRed (void) const
void SetRed (float r)
void SetPosition (const double x0, const double x1, const double x2)
void SetPosition (const double x0, const double x1)
void SetPosition (const PointType &newX)

Protected Member Functions

virtual void PrintSelf (std::ostream &os, Indent indent) const

Protected Attributes

PixelType m_Color
int m_ID
PointType m_X


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

See also:
TubeSpatialObjectPoint SurfaceSpatialObjectPoint

Definition at line 37 of file itkSpatialObjectPoint.h.


Member Typedef Documentation

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

Definition at line 53 of file itkSpatialObjectPoint.h.

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

Definition at line 52 of file itkSpatialObjectPoint.h.

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

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

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


Constructor & Destructor Documentation

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

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

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

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>
const PixelType& itk::SpatialObjectPoint< TPointDimension >::GetColor ( void   )  const

Set/Get color of the point

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

Set/Get Green color of the point

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

Get the SpatialObjectPoint Id.

template<unsigned int TPointDimension = 3>
const 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 >::operator= ( const SpatialObjectPoint< TPointDimension > &  rhs  ) 

Copy one SpatialObjectPoint to another

template<unsigned int TPointDimension = 3>
void itk::SpatialObjectPoint< TPointDimension >::Print ( std::ostream &  os  )  const

PrintSelf method

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

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 ( float  r,
float  g,
float  b,
float  a = 1 
)

Set/Get 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 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 114 of file itkSpatialObjectPoint.h.

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

A unique ID assigned to this SpatialObjectPoint

Definition at line 108 of file itkSpatialObjectPoint.h.

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

Position of the point

Definition at line 111 of file itkSpatialObjectPoint.h.


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

Generated at Tue Sep 15 13:08:30 2009 for ITK by doxygen 1.5.8 written by Dimitri van Heesch, © 1997-2000