Medical Imaging Interaction Toolkit  2018.4.99-389bf124
Medical Imaging Interaction Toolkit
mitk::IsoDoseLevelSet Class Reference

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

#include <mitkIsoDoseLevelCollections.h>

Inheritance diagram for mitk::IsoDoseLevelSet:
Collaboration diagram for mitk::IsoDoseLevelSet:

Classes

class  ConstIterator
 

Public Types

typedef size_type IsoLevelIndexType
 
typedef IsoDoseLevel::DoseValueType DoseValueType
 

Public Member Functions

 mitkClassMacroItkParent (IsoDoseLevelSet, itk::Object)
 
const IsoDoseLevelGetIsoDoseLevel (IsoLevelIndexType) const
 
const IsoDoseLevelGetIsoDoseLevel (DoseValueType) const
 
void SetIsoDoseLevel (const IsoDoseLevel *)
 
bool DoseLevelExists (IsoLevelIndexType) const
 
bool DoseLevelExists (DoseValueType) const
 
void DeleteIsoDoseLevel (DoseValueType)
 
void DeleteIsoDoseLevel (IsoLevelIndexType)
 
ConstIterator Begin (void) const
 
ConstIterator End (void) const
 
IsoLevelIndexType Size (void) const
 
void Reset (void)
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 IsoDoseLevelSet ()
 
 IsoDoseLevelSet (const IsoDoseLevelSet &other)
 
 ~IsoDoseLevelSet () override
 
 mitkCloneMacro (IsoDoseLevelSet)
 

Detailed Description

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

Set of dose iso levels sorted by the dose values of the iso levels (low to high values). This data structure is used to represent the dose iso level setup used for the visualization of a dose distribution.

Definition at line 41 of file mitkIsoDoseLevelCollections.h.

Member Typedef Documentation

◆ DoseValueType

◆ IsoLevelIndexType

Definition at line 66 of file mitkIsoDoseLevelCollections.h.

Constructor & Destructor Documentation

◆ IsoDoseLevelSet() [1/2]

mitk::IsoDoseLevelSet::IsoDoseLevelSet ( )
inlineprotected

Definition at line 58 of file mitkIsoDoseLevelCollections.h.

◆ IsoDoseLevelSet() [2/2]

mitk::IsoDoseLevelSet::IsoDoseLevelSet ( const IsoDoseLevelSet other)
explicitprotected

Definition at line 45 of file mitkIsoDoseLevelCollections.cpp.

◆ ~IsoDoseLevelSet()

mitk::IsoDoseLevelSet::~IsoDoseLevelSet ( )
inlineoverrideprotected

Definition at line 61 of file mitkIsoDoseLevelCollections.h.

References mitkCloneMacro.

Member Function Documentation

◆ Begin()

mitk::IsoDoseLevelSet::ConstIterator mitk::IsoDoseLevelSet::Begin ( void  ) const

Get a begin const iterator for the vector.

Definition at line 124 of file mitkIsoDoseLevelCollections.cpp.

References ConstIterator.

Referenced by mitk::ConfigureNodeAsDoseNode().

◆ DeleteIsoDoseLevel() [1/2]

void mitk::IsoDoseLevelSet::DeleteIsoDoseLevel ( DoseValueType  value)

Delete the element defined by the index identifier. In practice, it doesn't make sense to delete a vector index. Instead, this method just overwrites the index with the default element.

Definition at line 106 of file mitkIsoDoseLevelCollections.cpp.

Referenced by SetIsoDoseLevel().

◆ DeleteIsoDoseLevel() [2/2]

void mitk::IsoDoseLevelSet::DeleteIsoDoseLevel ( IsoLevelIndexType  index)

Definition at line 116 of file mitkIsoDoseLevelCollections.cpp.

References DoseLevelExists().

◆ DoseLevelExists() [1/2]

bool mitk::IsoDoseLevelSet::DoseLevelExists ( IsoLevelIndexType  index) const

Check if the index range of the vector is large enough to allow the given index without expansion.

Definition at line 94 of file mitkIsoDoseLevelCollections.cpp.

Referenced by DeleteIsoDoseLevel().

◆ DoseLevelExists() [2/2]

bool mitk::IsoDoseLevelSet::DoseLevelExists ( DoseValueType  value) const

Definition at line 100 of file mitkIsoDoseLevelCollections.cpp.

◆ End()

mitk::IsoDoseLevelSet::ConstIterator mitk::IsoDoseLevelSet::End ( void  ) const

Get an end const iterator for the vector.

Definition at line 129 of file mitkIsoDoseLevelCollections.cpp.

References ConstIterator.

Referenced by mitk::ConfigureNodeAsDoseNode().

◆ GetIsoDoseLevel() [1/2]

const mitk::IsoDoseLevel & mitk::IsoDoseLevelSet::GetIsoDoseLevel ( IsoLevelIndexType  index) const

Read the element from the given index. It is assumed that the index exists.

Definition at line 54 of file mitkIsoDoseLevelCollections.cpp.

References mitkThrow.

◆ GetIsoDoseLevel() [2/2]

const mitk::IsoDoseLevel & mitk::IsoDoseLevelSet::GetIsoDoseLevel ( DoseValueType  value) const

Definition at line 66 of file mitkIsoDoseLevelCollections.cpp.

References mitkThrow.

◆ mitkClassMacroItkParent()

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

◆ mitkCloneMacro()

mitk::IsoDoseLevelSet::mitkCloneMacro ( IsoDoseLevelSet  )
protected

◆ New()

static Pointer mitk::IsoDoseLevelSet::New ( )
static

◆ Reset()

void mitk::IsoDoseLevelSet::Reset ( void  )

Clear the elements. The final size will be zero.

Definition at line 139 of file mitkIsoDoseLevelCollections.cpp.

◆ SetIsoDoseLevel()

void mitk::IsoDoseLevelSet::SetIsoDoseLevel ( const IsoDoseLevel level)

Set the element value at the given index. It is assumed that the index exists.

Definition at line 80 of file mitkIsoDoseLevelCollections.cpp.

References DeleteIsoDoseLevel(), mitk::IsoDoseLevel::GetDoseValue(), mitk::lesserIsoDoseLevel(), and mitkThrow.

◆ Size()

mitk::IsoDoseLevelSet::IsoLevelIndexType mitk::IsoDoseLevelSet::Size ( void  ) const

Get the number of elements currently stored in the vector.

Definition at line 134 of file mitkIsoDoseLevelCollections.cpp.


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