Medical Imaging Interaction Toolkit
2024.06.99-bf8fb9c0
Medical Imaging Interaction Toolkit
|
Container class for storing the computed image statistics. More...
#include <mitkImageStatisticsContainer.h>
Public Types | |
using | RealType = double |
using | IndexType = vnl_vector< int > |
using | VoxelCountType = unsigned long |
using | StatisticsVariantType = boost::variant< RealType, VoxelCountType, IndexType > |
using | StatisticNameVector = std::vector< std::string > |
Public Member Functions | |
ImageStatisticsObject () | |
void | AddStatistic (const std::string_view key, StatisticsVariantType value) |
Adds a statistic to the statistics object. More... | |
const StatisticNameVector & | GetCustomStatisticNames () 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_view name) const |
template<typename TType > | |
TType | GetValueConverted (const std::string_view name) const |
Converts the requested value to the defined type. More... | |
StatisticsVariantType | GetValueNonConverted (const std::string_view name) const |
Returns the requested value. More... | |
void | Reset () |
Static Public Member Functions | |
static const StatisticNameVector & | GetDefaultStatisticNames () |
Returns the names of the default statistics. More... | |
Public Attributes | |
HistogramType::ConstPointer | m_Histogram |
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 later on.
Definition at line 57 of file mitkImageStatisticsContainer.h.
using mitk::ImageStatisticsContainer::ImageStatisticsObject::IndexType = vnl_vector<int> |
Definition at line 62 of file mitkImageStatisticsContainer.h.
Definition at line 61 of file mitkImageStatisticsContainer.h.
using mitk::ImageStatisticsContainer::ImageStatisticsObject::StatisticNameVector = std::vector<std::string> |
Definition at line 73 of file mitkImageStatisticsContainer.h.
using mitk::ImageStatisticsContainer::ImageStatisticsObject::StatisticsVariantType = boost::variant<RealType, VoxelCountType, IndexType > |
Definition at line 65 of file mitkImageStatisticsContainer.h.
using mitk::ImageStatisticsContainer::ImageStatisticsObject::VoxelCountType = unsigned long |
Definition at line 63 of file mitkImageStatisticsContainer.h.
mitk::ImageStatisticsContainer::ImageStatisticsObject::ImageStatisticsObject | ( | ) |
void mitk::ImageStatisticsContainer::ImageStatisticsObject::AddStatistic | ( | const std::string_view | key, |
StatisticsVariantType | value | ||
) |
Adds a statistic to the statistics object.
if already a statistic with that name is included, it is overwritten
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.
const StatisticNameVector& mitk::ImageStatisticsContainer::ImageStatisticsObject::GetCustomStatisticNames | ( | ) | const |
Returns the names of all custom statistics (defined at runtime and no default names).
|
static |
Returns the names of the default statistics.
The order is derived from the image statistics plugin.
StatisticNameVector mitk::ImageStatisticsContainer::ImageStatisticsObject::GetExistingStatisticNames | ( | ) | const |
|
inline |
Converts the requested value to the defined type.
name | defined string on creation (AddStatistic) |
if | no statistics with key name was found. |
Definition at line 102 of file mitkImageStatisticsContainer.h.
StatisticsVariantType mitk::ImageStatisticsContainer::ImageStatisticsObject::GetValueNonConverted | ( | const std::string_view | name | ) | const |
Returns the requested value.
if | no statistics with key name was found. |
bool mitk::ImageStatisticsContainer::ImageStatisticsObject::HasStatistic | ( | const std::string_view | name | ) | const |
void mitk::ImageStatisticsContainer::ImageStatisticsObject::Reset | ( | ) |
HistogramType::ConstPointer mitk::ImageStatisticsContainer::ImageStatisticsObject::m_Histogram |
Definition at line 116 of file mitkImageStatisticsContainer.h.