Medical Imaging Interaction Toolkit  2022.04.99-b2814023
Medical Imaging Interaction Toolkit
mitk::ImageStatisticsContainer::ImageStatisticsObject Class Reference

Container class for storing the computed image statistics. More...

#include <mitkImageStatisticsContainer.h>

Public Types

using StatisticNameVector = std::vector< std::string >
 

Public Member Functions

 ImageStatisticsObject ()
 
void AddStatistic (const std::string &key, StatisticsVariantType value)
 Adds a statistic to the statistics object. More...
 
const StatisticNameVectorGetCustomStatisticNames () const
 Returns the names of all custom statistics (defined at runtime and no default names). More...
 
StatisticNameVector GetAllStatisticNames () const
 Returns the names of all statistics (default and custom defined) Additional custom keys are added at the end in a sorted order. More...
 
StatisticNameVector GetExistingStatisticNames () const
 
bool HasStatistic (const std::string &name) const
 
template<typename TType >
TType GetValueConverted (const std::string &name) const
 Converts the requested value to the defined type. More...
 
StatisticsVariantType GetValueNonConverted (const std::string &name) const
 Returns the requested value. More...
 
void Reset ()
 

Static Public Member Functions

static const StatisticNameVectorGetDefaultStatisticNames ()
 Returns the names of the default statistics. More...
 

Public Attributes

HistogramType::ConstPointer m_Histogram
 

Detailed Description

Container class for storing the computed image statistics.

The statistics are stored in a map <name,value> with value as boost::variant<RealType, VoxelCountType, IndexType >. The type used to create the boost::variant is important as only this type can be recovered lateron.

Definition at line 62 of file mitkImageStatisticsContainer.h.

Member Typedef Documentation

◆ StatisticNameVector

Constructor & Destructor Documentation

◆ ImageStatisticsObject()

mitk::ImageStatisticsContainer::ImageStatisticsObject::ImageStatisticsObject ( )

Member Function Documentation

◆ AddStatistic()

void mitk::ImageStatisticsContainer::ImageStatisticsObject::AddStatistic ( const std::string &  key,
StatisticsVariantType  value 
)

Adds a statistic to the statistics object.

if already a statistic with that name is included, it is overwritten

◆ GetAllStatisticNames()

StatisticNameVector mitk::ImageStatisticsContainer::ImageStatisticsObject::GetAllStatisticNames ( ) const

Returns the names of all statistics (default and custom defined) Additional custom keys are added at the end in a sorted order.

◆ GetCustomStatisticNames()

const StatisticNameVector& mitk::ImageStatisticsContainer::ImageStatisticsObject::GetCustomStatisticNames ( ) const

Returns the names of all custom statistics (defined at runtime and no default names).

◆ GetDefaultStatisticNames()

static const StatisticNameVector& mitk::ImageStatisticsContainer::ImageStatisticsObject::GetDefaultStatisticNames ( )
static

Returns the names of the default statistics.

The order is derived from the image statistics plugin.

◆ GetExistingStatisticNames()

StatisticNameVector mitk::ImageStatisticsContainer::ImageStatisticsObject::GetExistingStatisticNames ( ) const

◆ GetValueConverted()

template<typename TType >
TType mitk::ImageStatisticsContainer::ImageStatisticsObject::GetValueConverted ( const std::string &  name) const
inline

Converts the requested value to the defined type.

Parameters
namedefined string on creation (AddStatistic)
Exceptions
ifno statistics with key name was found.

Definition at line 100 of file mitkImageStatisticsContainer.h.

◆ GetValueNonConverted()

StatisticsVariantType mitk::ImageStatisticsContainer::ImageStatisticsObject::GetValueNonConverted ( const std::string &  name) const

Returns the requested value.

Exceptions
ifno statistics with key name was found.

◆ HasStatistic()

bool mitk::ImageStatisticsContainer::ImageStatisticsObject::HasStatistic ( const std::string &  name) const

◆ Reset()

void mitk::ImageStatisticsContainer::ImageStatisticsObject::Reset ( )

Member Data Documentation

◆ m_Histogram

HistogramType::ConstPointer mitk::ImageStatisticsContainer::ImageStatisticsObject::m_Histogram

Definition at line 114 of file mitkImageStatisticsContainer.h.


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