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 SpatialObjectPoint Self
typedef Point< double, TPointDimension > PointType
typedef vnl_vector< double > VectorType
typedef RGBAPixel< float > PixelType

Public Member Functions

 SpatialObjectPoint (void)
virtual ~SpatialObjectPoint (void)
int GetID (void) const
void SetID (const int newID)
PointType GetPosition (void) const
unsigned short int GetNumDimensions (void) const
Selfoperator= (const SpatialObjectPoint &rhs)
void Print (std::ostream &os) const
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 PixelTypeGetColor (void) const
void SetColor (const PixelType &color)
void SetColor (float r, float g, float b, float a=1)
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

Protected Member Functions

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

Protected Attributes

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

See also:
TubeSpatialObjectPoint SurfaceSpatialObjectPoint

Definition at line 36 of file itkSpatialObjectPoint.h.


Member Typedef Documentation

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 Point< double, TPointDimension > itk::SpatialObjectPoint< TPointDimension >::PointType
 

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

Definition at line 48 of file itkSpatialObjectPoint.h.

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

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 vnl_vector< double > itk::SpatialObjectPoint< TPointDimension >::VectorType
 

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

Definition at line 49 of file itkSpatialObjectPoint.h.


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>
unsigned short int itk::SpatialObjectPoint< TPointDimension >::GetNumDimensions void   )  const
 

Get # of dimensions

Reimplemented in itk::TubeSpatialObjectPoint< TPointDimension >.

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 >::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]
 

PrintSelf method

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 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>
unsigned short int itk::SpatialObjectPoint< TPointDimension >::m_NumDimensions [protected]
 

# of dimensions

Reimplemented in itk::TubeSpatialObjectPoint< TPointDimension >.

Definition at line 117 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 Sat Mar 31 03:03:44 2007 for ITK by doxygen 1.3.8 written by Dimitri van Heesch, © 1997-2000