ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::SpatialObjectProperty Class Reference

#include <itkSpatialObjectProperty.h>

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 38 of file itkSpatialObjectProperty.h.

+ Collaboration diagram for itk::SpatialObjectProperty:

Public Types

using ColorType = RGBAPixel< double >
 
using Self = SpatialObjectProperty
 

Public Member Functions

virtual void Clear ()
 
double GetAlpha () const
 
double GetBlue () const
 
ColorTypeGetColor ()
 
const ColorTypeGetColor () 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
 
double GetTagScalarValue (const std::string &tag) 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
 
std::string GetTagStringValue (const std::string &tag) const
 
bool GetTagStringValue (const std::string &tag, std::string &value) const
 
Selfoperator= (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

◆ ColorType

Definition at line 47 of file itkSpatialObjectProperty.h.

◆ Self

Definition at line 45 of file itkSpatialObjectProperty.h.

Constructor & Destructor Documentation

◆ SpatialObjectProperty()

itk::SpatialObjectProperty::SpatialObjectProperty ( )

◆ ~SpatialObjectProperty()

virtual itk::SpatialObjectProperty::~SpatialObjectProperty ( )
virtualdefault

Member Function Documentation

◆ Clear()

virtual void itk::SpatialObjectProperty::Clear ( )
virtual

◆ GetAlpha()

double itk::SpatialObjectProperty::GetAlpha ( ) const

◆ GetBlue()

double itk::SpatialObjectProperty::GetBlue ( ) const

◆ GetColor() [1/2]

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

Definition at line 59 of file itkSpatialObjectProperty.h.

◆ GetColor() [2/2]

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

Definition at line 65 of file itkSpatialObjectProperty.h.

◆ GetGreen()

double itk::SpatialObjectProperty::GetGreen ( ) const

◆ GetName() [1/2]

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

Definition at line 101 of file itkSpatialObjectProperty.h.

◆ GetName() [2/2]

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

Definition at line 108 of file itkSpatialObjectProperty.h.

◆ GetRed()

double itk::SpatialObjectProperty::GetRed ( ) const

◆ GetTagScalarDictionary() [1/2]

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

◆ GetTagScalarDictionary() [2/2]

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

◆ GetTagScalarValue() [1/2]

double itk::SpatialObjectProperty::GetTagScalarValue ( const std::string &  tag) const
inline

Definition at line 121 of file itkSpatialObjectProperty.h.

◆ GetTagScalarValue() [2/2]

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

◆ GetTagStringDictionary() [1/2]

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

◆ GetTagStringDictionary() [2/2]

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

◆ GetTagStringValue() [1/2]

std::string itk::SpatialObjectProperty::GetTagStringValue ( const std::string &  tag) const

◆ GetTagStringValue() [2/2]

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

◆ operator=()

Self & itk::SpatialObjectProperty::operator= ( const SpatialObjectProperty rhs)

◆ Print()

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

Definition at line 152 of file itkSpatialObjectProperty.h.

◆ PrintSelf()

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

◆ SetAlpha()

void itk::SpatialObjectProperty::SetAlpha ( double  a)

◆ SetBlue()

void itk::SpatialObjectProperty::SetBlue ( double  b)

◆ SetColor() [1/2]

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

Definition at line 53 of file itkSpatialObjectProperty.h.

◆ SetColor() [2/2]

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

◆ SetGreen()

void itk::SpatialObjectProperty::SetGreen ( double  g)

◆ SetName()

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

Definition at line 94 of file itkSpatialObjectProperty.h.

◆ SetRed()

void itk::SpatialObjectProperty::SetRed ( double  r)

◆ SetTagScalarDictionary()

void itk::SpatialObjectProperty::SetTagScalarDictionary ( const std::map< std::string, double > &  dict)

◆ SetTagScalarValue()

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

◆ SetTagStringDictionary()

void itk::SpatialObjectProperty::SetTagStringDictionary ( const std::map< std::string, std::string > &  dict)

◆ SetTagStringValue()

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

Member Data Documentation

◆ m_Color

ColorType itk::SpatialObjectProperty::m_Color {}
private

Definition at line 165 of file itkSpatialObjectProperty.h.

◆ m_Name

std::string itk::SpatialObjectProperty::m_Name {}
private

Definition at line 167 of file itkSpatialObjectProperty.h.

◆ m_ScalarDictionary

std::map<std::string, double> itk::SpatialObjectProperty::m_ScalarDictionary {}
private

Definition at line 169 of file itkSpatialObjectProperty.h.

◆ m_StringDictionary

std::map<std::string, std::string> itk::SpatialObjectProperty::m_StringDictionary {}
private

Definition at line 170 of file itkSpatialObjectProperty.h.


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