mitk::IsoDoseLevel Class Reference

Stores values needed for the representation/visualization of dose iso levels. More...

#include <mitkIsoDoseLevel.h>

Inheritance diagram for mitk::IsoDoseLevel:

Collaboration diagram for mitk::IsoDoseLevel:

Public Types
typedef ::itk::RGBPixel< float >	ColorType
	RGB color type using float components in [0,1]. More...
typedef DoseValueRel	DoseValueType
	Type for the relative dose value of this iso level. More...

Public Member Functions
	mitkClassMacroItkParent (IsoDoseLevel, itk::Object)
	mitkNewMacro4Param (Self, DoseValueType, ColorType, bool, bool)
bool	operator> (const IsoDoseLevel &right) const
	Greater-than comparison based on dose values. More...
bool	operator< (const IsoDoseLevel &right) const
	Less-than comparison based on dose values. More...
bool	operator== (const IsoDoseLevel &right) const
	Equality comparison. Checks dose value, color, and both visibility flags. More...
virtual void	SetDoseValue (DoseValueType _arg)
	Set the relative dose value (fraction of reference dose). More...
virtual DoseValueType	GetDoseValue () const
	Get the relative dose value (fraction of reference dose). More...
virtual void	SetColor (ColorType _arg)
	Set the RGB display color for this iso level. More...
virtual ColorType	GetColor () const
	Get the RGB display color for this iso level. More...
virtual void	SetVisibleIsoLine (bool _arg)
	Set whether the iso line should be visible for this level. More...
virtual bool	GetVisibleIsoLine () const
	Get whether the iso line is visible for this level. More...
virtual void	VisibleIsoLineOn ()
	Toggle iso line visibility. More...
virtual void	VisibleIsoLineOff ()
virtual void	SetVisibleColorWash (bool _arg)
	Set whether the color wash should be visible for this level. More...
virtual bool	GetVisibleColorWash () const
	Get whether the color wash is visible for this level. More...
virtual void	VisibleColorWashOn ()
	Toggle color wash visibility. More...
virtual void	VisibleColorWashOff ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	IsoDoseLevel ()
	IsoDoseLevel (const IsoDoseLevel &other)
	IsoDoseLevel (const DoseValueType &value, const ColorType &color, bool visibleIsoLine=true, bool visibleColorWash=true)
	~IsoDoseLevel () override
	mitkCloneMacro (IsoDoseLevel)
void	PrintSelf (std::ostream &os, itk::Indent indent) const override

Detailed Description

Stores values needed for the representation/visualization of dose iso levels.

The dose iso level is defined in the topology of a dose distribution by the dose value that indicates the lower boundary of the iso level. The upper boundary is implicitly defined by the next IsoDoseLevel greater (higher dose value) than the current iso level. Color and the visibility options are used to indicate the visualization style.

See also

IsoDoseLevelSet

IsoDoseLevelVector

IsoDoseLevelSetProperty

Definition at line 40 of file mitkIsoDoseLevel.h.

Member Typedef Documentation

ColorType

typedef ::itk::RGBPixel<float> mitk::IsoDoseLevel::ColorType

RGB color type using float components in [0,1].

Definition at line 44 of file mitkIsoDoseLevel.h.

DoseValueType

typedef DoseValueRel mitk::IsoDoseLevel::DoseValueType

Type for the relative dose value of this iso level.

Definition at line 47 of file mitkIsoDoseLevel.h.

Constructor & Destructor Documentation

IsoDoseLevel() [1/3]

mitk::IsoDoseLevel::IsoDoseLevel ( )

protected

IsoDoseLevel() [2/3]

mitk::IsoDoseLevel::IsoDoseLevel ( const IsoDoseLevel &  other )

protected

IsoDoseLevel() [3/3]

mitk::IsoDoseLevel::IsoDoseLevel ( const DoseValueType &  value, const ColorType &  color, bool  visibleIsoLine = true, bool  visibleColorWash = true  )

protected

~IsoDoseLevel()

mitk::IsoDoseLevel::~IsoDoseLevel ( )

overrideprotected

Member Function Documentation

GetColor()

virtual ColorType mitk::IsoDoseLevel::GetColor ( ) const

virtual

Get the RGB display color for this iso level.

GetDoseValue()

virtual DoseValueType mitk::IsoDoseLevel::GetDoseValue ( ) const

virtual

Get the relative dose value (fraction of reference dose).

GetVisibleColorWash()

virtual bool mitk::IsoDoseLevel::GetVisibleColorWash ( ) const

virtual

Get whether the color wash is visible for this level.

GetVisibleIsoLine()

virtual bool mitk::IsoDoseLevel::GetVisibleIsoLine ( ) const

virtual

Get whether the iso line is visible for this level.

mitkClassMacroItkParent()

mitk::IsoDoseLevel::mitkClassMacroItkParent	(	IsoDoseLevel	,
		itk::Object
	)

mitkCloneMacro()

mitk::IsoDoseLevel::mitkCloneMacro ( IsoDoseLevel  )

protected

mitkNewMacro4Param()

mitk::IsoDoseLevel::mitkNewMacro4Param	(	Self	,
		DoseValueType	,
		ColorType	,
		bool	,
		bool
	)

New()

static Pointer mitk::IsoDoseLevel::New ( )

static

operator<()

bool mitk::IsoDoseLevel::operator<

(

const IsoDoseLevel &

right

)

const

Less-than comparison based on dose values.

Parameters

[in]

right

The iso dose level to compare against.

Returns

True if this level's dose value is less than right's dose value.

operator==()

bool mitk::IsoDoseLevel::operator==

(

const IsoDoseLevel &

right

)

const

Equality comparison. Checks dose value, color, and both visibility flags.

Parameters

[in]

right

The iso dose level to compare against.

Returns

True if all fields (dose value, color, iso line visibility, color wash visibility) are equal.

operator>()

bool mitk::IsoDoseLevel::operator>

(

const IsoDoseLevel &

right

)

const

Greater-than comparison based on dose values.

Parameters

[in]

right

The iso dose level to compare against.

Returns

True if this level's dose value is greater than right's dose value.

PrintSelf()

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

overrideprotected

SetColor()

virtual void mitk::IsoDoseLevel::SetColor ( ColorType  _arg )

virtual

Set the RGB display color for this iso level.

SetDoseValue()

virtual void mitk::IsoDoseLevel::SetDoseValue ( DoseValueType  _arg )

virtual

Set the relative dose value (fraction of reference dose).

SetVisibleColorWash()

virtual void mitk::IsoDoseLevel::SetVisibleColorWash ( bool  _arg )

virtual

Set whether the color wash should be visible for this level.

SetVisibleIsoLine()

virtual void mitk::IsoDoseLevel::SetVisibleIsoLine ( bool  _arg )

virtual

Set whether the iso line should be visible for this level.

VisibleColorWashOff()

virtual void mitk::IsoDoseLevel::VisibleColorWashOff ( )

virtual

VisibleColorWashOn()

virtual void mitk::IsoDoseLevel::VisibleColorWashOn ( )

virtual

Toggle color wash visibility.

VisibleIsoLineOff()

virtual void mitk::IsoDoseLevel::VisibleIsoLineOff ( )

virtual

VisibleIsoLineOn()

virtual void mitk::IsoDoseLevel::VisibleIsoLineOn ( )

virtual

Toggle iso line visibility.

---

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

• mitkIsoDoseLevel.h