Medical Imaging Interaction Toolkit  2016.11.0
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)
 
virtual ~IsoDoseLevelSet ()
 
 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 45 of file mitkIsoDoseLevelCollections.h.

Member Typedef Documentation

Definition at line 70 of file mitkIsoDoseLevelCollections.h.

Constructor & Destructor Documentation

mitk::IsoDoseLevelSet::IsoDoseLevelSet ( )
inlineprotected

Definition at line 62 of file mitkIsoDoseLevelCollections.h.

mitk::IsoDoseLevelSet::IsoDoseLevelSet ( const IsoDoseLevelSet other)
protected

Definition at line 49 of file mitkIsoDoseLevelCollections.cpp.

virtual mitk::IsoDoseLevelSet::~IsoDoseLevelSet ( )
inlineprotectedvirtual

Definition at line 65 of file mitkIsoDoseLevelCollections.h.

Member Function Documentation

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

Get a begin const iterator for the vector.

Definition at line 127 of file mitkIsoDoseLevelCollections.cpp.

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 109 of file mitkIsoDoseLevelCollections.cpp.

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

Definition at line 119 of file mitkIsoDoseLevelCollections.cpp.

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 97 of file mitkIsoDoseLevelCollections.cpp.

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

Definition at line 103 of file mitkIsoDoseLevelCollections.cpp.

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

Get an end const iterator for the vector.

Definition at line 132 of file mitkIsoDoseLevelCollections.cpp.

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 57 of file mitkIsoDoseLevelCollections.cpp.

References mitkThrow.

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

Definition at line 69 of file mitkIsoDoseLevelCollections.cpp.

References mitkThrow.

mitk::IsoDoseLevelSet::mitkClassMacroItkParent ( IsoDoseLevelSet  ,
itk::Object   
)
mitk::IsoDoseLevelSet::mitkCloneMacro ( IsoDoseLevelSet  )
protected
static Pointer mitk::IsoDoseLevelSet::New ( )
static
void mitk::IsoDoseLevelSet::Reset ( void  )

Clear the elements. The final size will be zero.

Definition at line 142 of file mitkIsoDoseLevelCollections.cpp.

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 83 of file mitkIsoDoseLevelCollections.cpp.

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

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

Get the number of elements currently stored in the vector.

Definition at line 137 of file mitkIsoDoseLevelCollections.cpp.


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