Orfeo Toolbox  3.16
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes
itk::SpatialObjectPoint< TPointDimension > Class Template Reference

Point used for spatial objets. More...

#include <itkSpatialObjectPoint.h>

+ Inheritance diagram for itk::SpatialObjectPoint< TPointDimension >:
+ Collaboration diagram for itk::SpatialObjectPoint< TPointDimension >:

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

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

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>
itk::SpatialObjectPoint< TPointDimension >::SpatialObjectPoint ( void  )

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

Constructor

Definition at line 28 of file itkSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
itk::SpatialObjectPoint< TPointDimension >::~SpatialObjectPoint ( void  )
virtual

Default destructor.

Destructor

Definition at line 44 of file itkSpatialObjectPoint.txx.


Member Function Documentation

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

Return the alpha value of the point

Definition at line 145 of file itkSpatialObjectPoint.txx.

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

Return the blue channel of the point

Definition at line 127 of file itkSpatialObjectPoint.txx.

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

Set/Get color of the point

Return the color of the point

Definition at line 52 of file itkSpatialObjectPoint.txx.

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

Return the green channel of the point

Definition at line 109 of file itkSpatialObjectPoint.txx.

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

Get the SpatialObjectPoint Id.

Get the Identification number of a point

Definition at line 163 of file itkSpatialObjectPoint.txx.

Referenced by itk::ContourSpatialObjectPoint< TPointDimension >::operator=().

template<unsigned int TPointDimension>
const SpatialObjectPoint< TPointDimension >::PointType & itk::SpatialObjectPoint< TPointDimension >::GetPosition ( void  ) const
template<unsigned int TPointDimension>
float itk::SpatialObjectPoint< TPointDimension >::GetRed ( void  ) const

Return the red channel of the point

Definition at line 91 of file itkSpatialObjectPoint.txx.

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

PrintSelf method

PrintSelfMethod

Definition at line 226 of file itkSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::SpatialObjectPoint< TPointDimension >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual
template<unsigned int TPointDimension>
void itk::SpatialObjectPoint< TPointDimension >::SetAlpha ( float  a)

Set/Get alpha value of the point

Set the alpha value of the point

Definition at line 136 of file itkSpatialObjectPoint.txx.

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

Set/Get blue color of the point

Set the blue channel of the point

Definition at line 118 of file itkSpatialObjectPoint.txx.

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

Set the color of the point

Definition at line 61 of file itkSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::SpatialObjectPoint< TPointDimension >::SetColor ( float  r,
float  g,
float  b,
float  a = 1 
)

Set the color of the point

Definition at line 70 of file itkSpatialObjectPoint.txx.

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

Set/Get Green color of the point

Set the green channel of the point

Definition at line 100 of file itkSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::SpatialObjectPoint< TPointDimension >::SetID ( const int  newID)

Set the SpatialObjectPoint Id.

Set the Identification number of a point

Definition at line 154 of file itkSpatialObjectPoint.txx.

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

Set the position : 2D case

Definition at line 202 of file itkSpatialObjectPoint.txx.

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

Set the position : 3D case

Definition at line 191 of file itkSpatialObjectPoint.txx.

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

Set/Get red color of the point

Set the red channel of the point

Definition at line 82 of file itkSpatialObjectPoint.txx.


Member Data Documentation

template<unsigned int TPointDimension = 3>
PixelType itk::SpatialObjectPoint< TPointDimension >::m_Color
protected
template<unsigned int TPointDimension = 3>
int itk::SpatialObjectPoint< TPointDimension >::m_ID
protected
template<unsigned int TPointDimension = 3>
PointType itk::SpatialObjectPoint< TPointDimension >::m_X
protected

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

Generated at Sun Feb 3 2013 02:36:02 for Orfeo Toolbox with doxygen 1.8.1.1