Medical Imaging Interaction Toolkit  2026.06.00
Medical Imaging Interaction Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::IsoDoseLevelSet Class Reference

Sorted set of dose iso levels for dose distribution visualization. More...

#include <mitkIsoDoseLevelCollections.h>

Inheritance diagram for mitk::IsoDoseLevelSet:
Inheritance graph
[legend]
Collaboration diagram for mitk::IsoDoseLevelSet:
Collaboration graph
[legend]

Classes

class  ConstIterator
 STL-style const iterator for read-only traversal of the iso dose level set. More...
 

Public Types

typedef size_type IsoLevelIndexType
 Index type for accessing iso levels by position. More...
 
typedef IsoDoseLevel::DoseValueType DoseValueType
 Dose value type inherited from IsoDoseLevel. More...
 

Public Member Functions

 mitkClassMacroItkParent (IsoDoseLevelSet, itk::Object)
 
const IsoDoseLevel & GetIsoDoseLevel (IsoLevelIndexType index) const
 Retrieve an iso dose level by its positional index. More...
 
const IsoDoseLevel & GetIsoDoseLevel (DoseValueType value) const
 Retrieve an iso dose level by its dose value. More...
 
void SetIsoDoseLevel (const IsoDoseLevel *level)
 Insert or replace an iso dose level. More...
 
bool DoseLevelExists (IsoLevelIndexType index) const
 Check whether an iso dose level exists at the given index. More...
 
bool DoseLevelExists (DoseValueType value) const
 Check whether an iso dose level with the given dose value exists. More...
 
void DeleteIsoDoseLevel (DoseValueType value)
 Remove an iso dose level identified by its dose value. More...
 
void DeleteIsoDoseLevel (IsoLevelIndexType index)
 Remove an iso dose level identified by its positional index. More...
 
ConstIterator Begin (void) const
 Get a const iterator pointing to the first iso dose level. More...
 
ConstIterator End (void) const
 Get a const iterator pointing past the last iso dose level. More...
 
IsoLevelIndexType Size (void) const
 Get the number of iso dose levels in the set. More...
 
void Reset (void)
 Remove all iso dose levels from the set. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

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

Detailed Description

Sorted set of dose iso levels for dose distribution visualization.

Maintains a collection of IsoDoseLevel instances sorted by their dose values (from low to high). This data structure is the primary means for defining the color coding and visibility rules used to visualize a dose distribution. Duplicate dose values are not allowed; inserting a level with an existing dose value replaces the previous entry.

See also
IsoDoseLevel
IsoDoseLevelVector
IsoDoseLevelSetProperty

Definition at line 52 of file mitkIsoDoseLevelCollections.h.

Member Typedef Documentation

◆ DoseValueType

typedef IsoDoseLevel::DoseValueType mitk::IsoDoseLevelSet::DoseValueType

Dose value type inherited from IsoDoseLevel.

Definition at line 81 of file mitkIsoDoseLevelCollections.h.

◆ IsoLevelIndexType

typedef size_type mitk::IsoDoseLevelSet::IsoLevelIndexType

Index type for accessing iso levels by position.

Definition at line 78 of file mitkIsoDoseLevelCollections.h.

Constructor & Destructor Documentation

◆ IsoDoseLevelSet() [1/2]

mitk::IsoDoseLevelSet::IsoDoseLevelSet ( )
inlineprotected

Definition at line 69 of file mitkIsoDoseLevelCollections.h.

◆ IsoDoseLevelSet() [2/2]

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

◆ ~IsoDoseLevelSet()

mitk::IsoDoseLevelSet::~IsoDoseLevelSet ( )
inlineoverrideprotected

Definition at line 72 of file mitkIsoDoseLevelCollections.h.

Member Function Documentation

◆ Begin()

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

Get a const iterator pointing to the first iso dose level.

Returns
A ConstIterator at the beginning of the set.

◆ DeleteIsoDoseLevel() [1/2]

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

Remove an iso dose level identified by its dose value.

Parameters
[in]valueThe relative dose value of the level to remove. No-op if not found.

◆ DeleteIsoDoseLevel() [2/2]

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

Remove an iso dose level identified by its positional index.

Parameters
[in]indexThe zero-based index of the level to remove. No-op if out of range.

◆ DoseLevelExists() [1/2]

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

Check whether an iso dose level with the given dose value exists.

Parameters
[in]valueThe relative dose value to search for.
Returns
True if a level with that dose value is found.

◆ DoseLevelExists() [2/2]

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

Check whether an iso dose level exists at the given index.

Parameters
[in]indexThe positional index to check.
Returns
True if the index is within the valid range.

◆ End()

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

Get a const iterator pointing past the last iso dose level.

Returns
A ConstIterator at the end of the set.

◆ GetIsoDoseLevel() [1/2]

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

Retrieve an iso dose level by its dose value.

Parameters
[in]valueThe relative dose value to search for.
Returns
Const reference to the matching IsoDoseLevel.
Exceptions
mitk::Exceptionif no level with the given dose value exists.

◆ GetIsoDoseLevel() [2/2]

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

Retrieve an iso dose level by its positional index.

Parameters
[in]indexZero-based index of the level.
Returns
Const reference to the IsoDoseLevel at the given index.
Exceptions
mitk::Exceptionif the index is out of range.

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

Remove all iso dose levels from the set.

Postcondition
Size() == 0.

◆ SetIsoDoseLevel()

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

Insert or replace an iso dose level.

If a level with the same dose value already exists, it is removed first. The new level is cloned and inserted, and the set is re-sorted.

Parameters
[in]levelPointer to the IsoDoseLevel to insert. Must not be nullptr.
Exceptions
mitk::Exceptionif level is nullptr.

◆ Size()

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

Get the number of iso dose levels in the set.

Returns
The number of elements currently stored.
The documentation for this class was generated from the following file: