Orfeo Toolbox  4.0
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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 >:

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 52 of file itkSpatialObjectPoint.h.

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

Definition at line 51 of file itkSpatialObjectPoint.h.

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

Definition at line 49 of file itkSpatialObjectPoint.h.

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

Definition at line 48 of file itkSpatialObjectPoint.h.

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

Definition at line 50 of file itkSpatialObjectPoint.h.

Constructor & Destructor Documentation

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

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

Constructor

Definition at line 28 of file itkSpatialObjectPoint.hxx.

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

Default destructor.

Destructor

Definition at line 44 of file itkSpatialObjectPoint.hxx.

Member Function Documentation

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

Return the alpha value of the point

Definition at line 144 of file itkSpatialObjectPoint.hxx.

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

Return the blue channel of the point

Definition at line 126 of file itkSpatialObjectPoint.hxx.

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 51 of file itkSpatialObjectPoint.hxx.

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

Return the green channel of the point

Definition at line 108 of file itkSpatialObjectPoint.hxx.

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 162 of file itkSpatialObjectPoint.hxx.

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 90 of file itkSpatialObjectPoint.hxx.

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 222 of file itkSpatialObjectPoint.hxx.

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 135 of file itkSpatialObjectPoint.hxx.

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 117 of file itkSpatialObjectPoint.hxx.

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

Set the color of the point

Definition at line 60 of file itkSpatialObjectPoint.hxx.

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 69 of file itkSpatialObjectPoint.hxx.

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 99 of file itkSpatialObjectPoint.hxx.

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 153 of file itkSpatialObjectPoint.hxx.

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 200 of file itkSpatialObjectPoint.hxx.

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 189 of file itkSpatialObjectPoint.hxx.

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 81 of file itkSpatialObjectPoint.hxx.

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 Sat Mar 8 2014 17:46:52 for Orfeo Toolbox with doxygen 1.8.3.1