itk::SpatialObjectProperty Class Reference

#include <itkSpatialObjectProperty.h>

Collaboration diagram for itk::SpatialObjectProperty:

Detailed Description

This class contains the objects properties such as colors, opacity, etc... it's templated over the representation to use for each color component.

Definition at line 36 of file itkSpatialObjectProperty.h.

Public Types
using	ColorType = RGBAPixel< double >
using	Self = SpatialObjectProperty

Public Member Functions
double	GetAlpha () const
double	GetBlue () const
ColorType &	GetColor ()
const ColorType &	GetColor () const
double	GetGreen () const
std::string &	GetName ()
const std::string &	GetName () const
double	GetRed () const
std::map< std::string, double > &	GetTagScalarDictionary ()
const std::map< std::string, double > &	GetTagScalarDictionary () const
bool	GetTagScalarValue (const std::string &tag, double &value) const
std::map< std::string, std::string > &	GetTagStringDictionary ()
const std::map< std::string, std::string > &	GetTagStringDictionary () const
bool	GetTagStringValue (const std::string &tag, std::string &value) const
Self &	operator= (const SpatialObjectProperty &rhs)
void	Print (std::ostream &os) const
void	SetAlpha (double a)
void	SetBlue (double b)
void	SetColor (const ColorType &color)
void	SetColor (double r, double g, double b)
void	SetGreen (double g)
void	SetName (const std::string &name)
void	SetRed (double r)
void	SetTagScalarDictionary (const std::map< std::string, double > &dict)
void	SetTagScalarValue (const std::string &tag, double value)
void	SetTagStringDictionary (const std::map< std::string, std::string > &dict)
void	SetTagStringValue (const std::string &tag, const std::string &value)
	SpatialObjectProperty ()
virtual	~SpatialObjectProperty ()=default

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

Private Attributes
ColorType	m_Color
std::string	m_Name
std::map< std::string, double >	m_ScalarDictionary
std::map< std::string, std::string >	m_StringDictionary

Member Typedef Documentation

using itk::SpatialObjectProperty::ColorType = RGBAPixel< double >

Definition at line 46 of file itkSpatialObjectProperty.h.

using itk::SpatialObjectProperty::Self = SpatialObjectProperty

Definition at line 44 of file itkSpatialObjectProperty.h.

Constructor & Destructor Documentation

itk::SpatialObjectProperty::SpatialObjectProperty

(

)

virtual itk::SpatialObjectProperty::~SpatialObjectProperty ( )

virtualdefault

Member Function Documentation

double itk::SpatialObjectProperty::GetAlpha

(

)

const

double itk::SpatialObjectProperty::GetBlue

(

)

const

ColorType& itk::SpatialObjectProperty::GetColor ( )

inline

Definition at line 51 of file itkSpatialObjectProperty.h.

References m_Color.

const ColorType& itk::SpatialObjectProperty::GetColor ( ) const

inline

Definition at line 54 of file itkSpatialObjectProperty.h.

References m_Color.

double itk::SpatialObjectProperty::GetGreen

(

)

const

std::string& itk::SpatialObjectProperty::GetName ( )

inline

Definition at line 74 of file itkSpatialObjectProperty.h.

References m_Name.

const std::string& itk::SpatialObjectProperty::GetName ( ) const

inline

Definition at line 77 of file itkSpatialObjectProperty.h.

References m_Name.

double itk::SpatialObjectProperty::GetRed

(

)

const

std::map< std::string, double >& itk::SpatialObjectProperty::GetTagScalarDictionary

(

)

const std::map< std::string, double >& itk::SpatialObjectProperty::GetTagScalarDictionary

(

)

const

bool itk::SpatialObjectProperty::GetTagScalarValue	(	const std::string &	tag,
		double &	value
	)		const

std::map< std::string, std::string >& itk::SpatialObjectProperty::GetTagStringDictionary

(

)

const std::map< std::string, std::string >& itk::SpatialObjectProperty::GetTagStringDictionary

(

)

const

bool itk::SpatialObjectProperty::GetTagStringValue	(	const std::string &	tag,
		std::string &	value
	)		const

Self& itk::SpatialObjectProperty::operator=

(

const SpatialObjectProperty &

rhs

)

void itk::SpatialObjectProperty::Print ( std::ostream &  os ) const

inline

Definition at line 95 of file itkSpatialObjectProperty.h.

References PrintSelf().

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

protected

Referenced by Print().

void itk::SpatialObjectProperty::SetAlpha

(

double

a

)

void itk::SpatialObjectProperty::SetBlue

(

double

b

)

void itk::SpatialObjectProperty::SetColor ( const ColorType &  color )

inline

Definition at line 48 of file itkSpatialObjectProperty.h.

References m_Color.

void itk::SpatialObjectProperty::SetColor	(	double	r,
		double	g,
		double	b
	)

void itk::SpatialObjectProperty::SetGreen

(

double

g

)

void itk::SpatialObjectProperty::SetName ( const std::string &  name )

inline

Definition at line 71 of file itkSpatialObjectProperty.h.

References m_Name.

void itk::SpatialObjectProperty::SetRed

(

double

r

)

void itk::SpatialObjectProperty::SetTagScalarDictionary

(

const std::map< std::string, double > &

dict

)

void itk::SpatialObjectProperty::SetTagScalarValue	(	const std::string &	tag,
		double	value
	)

void itk::SpatialObjectProperty::SetTagStringDictionary

(

const std::map< std::string, std::string > &

dict

)

void itk::SpatialObjectProperty::SetTagStringValue	(	const std::string &	tag,
		const std::string &	value
	)

Member Data Documentation

ColorType itk::SpatialObjectProperty::m_Color

private

Definition at line 106 of file itkSpatialObjectProperty.h.

Referenced by GetColor(), and SetColor().

std::string itk::SpatialObjectProperty::m_Name

private

Definition at line 108 of file itkSpatialObjectProperty.h.

Referenced by GetName(), and SetName().

std::map< std::string, double > itk::SpatialObjectProperty::m_ScalarDictionary

private

Definition at line 110 of file itkSpatialObjectProperty.h.

std::map< std::string, std::string > itk::SpatialObjectProperty::m_StringDictionary

private

Definition at line 111 of file itkSpatialObjectProperty.h.

---

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

• itkSpatialObjectProperty.h