Medical Imaging Interaction Toolkit  2022.04.99-01b95b17
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

◆ ~IsoDoseLevelSet()

mitk::IsoDoseLevelSet::~IsoDoseLevelSet ( )
inlineoverrideprotected

Definition at line 61 of file mitkIsoDoseLevelCollections.h.

References mitkCloneMacro.

Member Function Documentation

◆ Begin()

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

Get a begin const iterator for the vector.

◆ DeleteIsoDoseLevel() [1/2]

void mitk::IsoDoseLevelSet::DeleteIsoDoseLevel ( DoseValueType  )

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.

◆ DeleteIsoDoseLevel() [2/2]

void mitk::IsoDoseLevelSet::DeleteIsoDoseLevel ( IsoLevelIndexType  )

◆ DoseLevelExists() [1/2]

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

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

◆ DoseLevelExists() [2/2]

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

◆ End()

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

Get an end const iterator for the vector.

◆ GetIsoDoseLevel() [1/2]

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

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

◆ GetIsoDoseLevel() [2/2]

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

◆ 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.

◆ SetIsoDoseLevel()

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

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

◆ Size()

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

Get the number of elements currently stored in the vector.


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