itk::SpatialObjectPoint< TPointDimension > Class Template Reference

#include <itkSpatialObjectPoint.h>

Inheritance diagram for itk::SpatialObjectPoint< TPointDimension >:

Collaboration diagram for itk::SpatialObjectPoint< TPointDimension >:

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

Examples:

SpatialObjects/BlobSpatialObject.cxx, and SpatialObjects/LandmarkSpatialObject.cxx.

Definition at line 37 of file itkSpatialObjectPoint.h.

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
float	GetAlpha (void) const
float	GetBlue (void) const
const PixelType &	GetColor (void) const
float	GetGreen (void) const
int	GetID (void) const
const PointType &	GetPosition (void) const
float	GetRed (void) const
Self &	operator= (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)
	SpatialObjectPoint (void)
virtual	~SpatialObjectPoint (void)

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

Protected Attributes
PixelType	m_Color
int	m_ID
PointType	m_X

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 = 3>

itk::SpatialObjectPoint< TPointDimension >::SpatialObjectPoint

(

void

)

Constructor. This one defines the number 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

template<unsigned int TPointDimension = 3>

float itk::SpatialObjectPoint< TPointDimension >::GetBlue

(

void

)

const

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

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

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

protectedvirtual

PrintSelf method

Reimplemented in itk::VesselTubeSpatialObjectPoint< TPointDimension >, itk::TubeSpatialObjectPoint< TPointDimension >, itk::DTITubeSpatialObjectPoint< TPointDimension >, itk::ContourSpatialObjectPoint< TPointDimension >, itk::LineSpatialObjectPoint< TPointDimension >, and itk::SurfaceSpatialObjectPoint< 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

(

const PixelType &

color

)

template<unsigned int TPointDimension = 3>

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

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 PointType &

newX

)

Set the point object. Couldn't use macros for these methods.

Examples:

SpatialObjects/BlobSpatialObject.cxx.

template<unsigned int TPointDimension = 3>

void itk::SpatialObjectPoint< TPointDimension >::SetPosition	(	const double	x0,
		const double	x1
	)

template<unsigned int TPointDimension = 3>

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

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

template<unsigned int TPointDimension = 3>

PointType itk::SpatialObjectPoint< TPointDimension >::m_X

protected

Position of the point

Definition at line 112 of file itkSpatialObjectPoint.h.

---

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

• itkSpatialObjectPoint.h