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

Point used for a tube definition. More...

#include <itkTubeSpatialObjectPoint.h>

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

List of all members.

Public Types

typedef PixelType ColorType
typedef CovariantVector
< double, TPointDimension > 
CovariantVectorType
typedef RGBAPixel< float > PixelType
typedef Point< double,
TPointDimension > 
PointType
typedef TubeSpatialObjectPoint Self
typedef SpatialObjectPoint
< TPointDimension > 
Superclass
typedef Vector< double,
TPointDimension > 
VectorType

Public Member Functions

 TubeSpatialObjectPoint (void)
virtual ~TubeSpatialObjectPoint (void)
float GetAlpha (void) const
float GetBlue (void) const
const PixelTypeGetColor (void) const
float GetGreen (void) const
int GetID (void) const
const CovariantVectorTypeGetNormal1 (void) const
const CovariantVectorTypeGetNormal2 (void) const
unsigned short int GetNumDimensions (void) const
const PointTypeGetPosition (void) const
float GetRadius (void) const
float GetRed (void) const
const VectorTypeGetTangent (void) const
Selfoperator= (const TubeSpatialObjectPoint &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 SetNormal1 (const CovariantVectorType &newV1)
void SetNormal1 (const double v10, const double v11)
void SetNormal1 (const double v10, const double v11, const double v12)
void SetNormal2 (const CovariantVectorType &newV2)
void SetNormal2 (const double v20, const double v21)
void SetNormal2 (const double v20, const double v21, const double v22)
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 SetRadius (const float newR)
void SetRed (float r)
void SetTangent (const VectorType &newT)
void SetTangent (const double t0, const double t1)
void SetTangent (const double t0, const double t1, const double t2)

Protected Member Functions

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

Protected Attributes

PixelType m_Color
int m_ID
CovariantVectorType m_Normal1
CovariantVectorType m_Normal2
unsigned short int m_NumDimensions
float m_R
VectorType m_T
PointType m_X

Detailed Description

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

Point used for a tube definition.

This class contains all the functions necessary to define a point that can be used to build tubes.

See also:
TubeSpatialObject

Definition at line 38 of file itkTubeSpatialObjectPoint.h.


Member Typedef Documentation

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

Definition at line 53 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3>
typedef CovariantVector<double, TPointDimension > itk::TubeSpatialObjectPoint< TPointDimension >::CovariantVectorType
template<unsigned int TPointDimension = 3>
typedef RGBAPixel< float > itk::SpatialObjectPoint< TPointDimension >::PixelType
inherited

Definition at line 52 of file itkSpatialObjectPoint.h.

template<unsigned int TPointDimension = 3>
typedef Point< double, TPointDimension > itk::TubeSpatialObjectPoint< TPointDimension >::PointType
template<unsigned int TPointDimension = 3>
typedef TubeSpatialObjectPoint itk::TubeSpatialObjectPoint< TPointDimension >::Self
template<unsigned int TPointDimension = 3>
typedef SpatialObjectPoint<TPointDimension> itk::TubeSpatialObjectPoint< TPointDimension >::Superclass
template<unsigned int TPointDimension = 3>
typedef Vector<double, TPointDimension > itk::TubeSpatialObjectPoint< TPointDimension >::VectorType

Constructor & Destructor Documentation

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

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

Constructor

Definition at line 28 of file itkTubeSpatialObjectPoint.txx.

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

Default destructor.

Destructor

Definition at line 40 of file itkTubeSpatialObjectPoint.txx.


Member Function Documentation

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

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
inherited

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
inherited

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
inherited

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
inherited

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 TubeSpatialObjectPoint< TPointDimension >::CovariantVectorType & itk::TubeSpatialObjectPoint< TPointDimension >::GetNormal1 ( void  ) const

Get V1

Definition at line 103 of file itkTubeSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
const TubeSpatialObjectPoint< TPointDimension >::CovariantVectorType & itk::TubeSpatialObjectPoint< TPointDimension >::GetNormal2 ( void  ) const

Get V2

Definition at line 141 of file itkTubeSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
unsigned short int itk::TubeSpatialObjectPoint< TPointDimension >::GetNumDimensions ( void  ) const

Get # of dimensions

Definition at line 180 of file itkTubeSpatialObjectPoint.txx.

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

Get R

Get the radius

Definition at line 48 of file itkTubeSpatialObjectPoint.txx.

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

Return the red channel of the point

Definition at line 91 of file itkSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
const TubeSpatialObjectPoint< TPointDimension >::VectorType & itk::TubeSpatialObjectPoint< TPointDimension >::GetTangent ( void  ) const

Get the tangent

Definition at line 65 of file itkTubeSpatialObjectPoint.txx.

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

PrintSelf method

PrintSelfMethod

Definition at line 226 of file itkSpatialObjectPoint.txx.

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

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)
inherited

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)
inherited

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 
)
inherited

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)
inherited

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)
inherited

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::TubeSpatialObjectPoint< TPointDimension >::SetNormal1 ( const CovariantVectorType newV1)

Set V1

Definition at line 112 of file itkTubeSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetNormal1 ( const double  v10,
const double  v11 
)

Definition at line 132 of file itkTubeSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetNormal1 ( const double  v10,
const double  v11,
const double  v12 
)

Definition at line 121 of file itkTubeSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetNormal2 ( const CovariantVectorType newV2)

Set V2

Definition at line 151 of file itkTubeSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetNormal2 ( const double  v20,
const double  v21 
)

Definition at line 171 of file itkTubeSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetNormal2 ( const double  v20,
const double  v21,
const double  v22 
)

Definition at line 160 of file itkTubeSpatialObjectPoint.txx.

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

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 
)
inherited

Set the position : 3D case

Definition at line 191 of file itkSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetRadius ( const float  newR)

Set R

Set the radius

Definition at line 57 of file itkTubeSpatialObjectPoint.txx.

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

Set/Get red color of the point

Set the red channel of the point

Definition at line 82 of file itkSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetTangent ( const VectorType newT)

Set T. Couldn't use macros for these methods

Definition at line 74 of file itkTubeSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetTangent ( const double  t0,
const double  t1 
)

Definition at line 94 of file itkTubeSpatialObjectPoint.txx.

template<unsigned int TPointDimension>
void itk::TubeSpatialObjectPoint< TPointDimension >::SetTangent ( const double  t0,
const double  t1,
const double  t2 
)

Definition at line 83 of file itkTubeSpatialObjectPoint.txx.


Member Data Documentation

template<unsigned int TPointDimension = 3>
PixelType itk::SpatialObjectPoint< TPointDimension >::m_Color
protectedinherited
template<unsigned int TPointDimension = 3>
int itk::SpatialObjectPoint< TPointDimension >::m_ID
protectedinherited
template<unsigned int TPointDimension = 3>
CovariantVectorType itk::TubeSpatialObjectPoint< TPointDimension >::m_Normal1
protected
template<unsigned int TPointDimension = 3>
CovariantVectorType itk::TubeSpatialObjectPoint< TPointDimension >::m_Normal2
protected
template<unsigned int TPointDimension = 3>
unsigned short int itk::TubeSpatialObjectPoint< TPointDimension >::m_NumDimensions
protected
template<unsigned int TPointDimension = 3>
float itk::TubeSpatialObjectPoint< TPointDimension >::m_R
protected
template<unsigned int TPointDimension = 3>
VectorType itk::TubeSpatialObjectPoint< TPointDimension >::m_T
protected
template<unsigned int TPointDimension = 3>
PointType itk::SpatialObjectPoint< TPointDimension >::m_X
protectedinherited

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

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