Medical Imaging Interaction Toolkit  2023.12.99-b884b24c
Medical Imaging Interaction Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
mitk::ImageStatisticsCalculator Class Reference

#include <mitkImageStatisticsCalculator.h>

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

Public Types

typedef ImageStatisticsCalculator Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< Self > Pointer
 
typedef itk::SmartPointer< const Self > ConstPointer
 
typedef double statisticsValueType
 
typedef std::map< std::string, statisticsValueType > statisticsMapType
 
typedef itk::Statistics::Histogram< double > HistogramType
 
typedef unsigned short MaskPixelType
 
using LabelIndex = ImageStatisticsContainer::LabelValueType
 

Public Member Functions

virtual const char * GetClassName () const
 
void SetInputImage (const mitk::Image *image)
 Set the image for which the statistics are to be computed. More...
 
void SetMask (mitk::MaskGenerator *mask)
 Set the mask generator that creates the mask which is to be used to calculate statistics. If no more mask is desired simply set. More...
 
void SetSecondaryMask (mitk::MaskGenerator *mask)
 Set this if more than one mask should be applied (for instance if a IgnorePixelValueMask were to be used alongside with a segmentation). Both masks are combined using pixel wise AND operation. The secondary mask does not have to be the same size than the primary but they need to have some overlap. More...
 
void SetNBinsForHistogramStatistics (unsigned int nBins)
 Set number of bins to be used for histogram statistics. If Bin size is set after number of bins, bin size will be used instead! More...
 
unsigned int GetNBinsForHistogramStatistics () const
 Retrieve the number of bins used for histogram statistics. Careful: The return value does not indicate whether NBins or BinSize is used. That solely depends on which parameter has been set last. More...
 
void SetBinSizeForHistogramStatistics (double binSize)
 Set bin size to be used for histogram statistics. If nbins is set after bin size, nbins will be used instead! More...
 
double GetBinSizeForHistogramStatistics () const
 Retrieve the bin size for histogram statistics. Careful: The return value does not indicate whether NBins or BinSize is used. That solely depends on which parameter has been set last. More...
 
ImageStatisticsContainer * GetStatistics ()
 Returns the statistics. If these requested statistics are not computed yet the computation is done as well. More...
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

 ImageStatisticsCalculator ()
 

Detailed Description

Definition at line 23 of file mitkImageStatisticsCalculator.h.

Member Typedef Documentation

◆ ConstPointer

typedef itk::SmartPointer< const Self > mitk::ImageStatisticsCalculator::ConstPointer

Definition at line 30 of file mitkImageStatisticsCalculator.h.

◆ HistogramType

typedef itk::Statistics::Histogram<double> mitk::ImageStatisticsCalculator::HistogramType

Definition at line 38 of file mitkImageStatisticsCalculator.h.

◆ LabelIndex

using mitk::ImageStatisticsCalculator::LabelIndex = ImageStatisticsContainer::LabelValueType

Definition at line 40 of file mitkImageStatisticsCalculator.h.

◆ MaskPixelType

typedef unsigned short mitk::ImageStatisticsCalculator::MaskPixelType

Definition at line 39 of file mitkImageStatisticsCalculator.h.

◆ Pointer

typedef itk::SmartPointer< Self > mitk::ImageStatisticsCalculator::Pointer

Definition at line 29 of file mitkImageStatisticsCalculator.h.

◆ Self

typedef ImageStatisticsCalculator mitk::ImageStatisticsCalculator::Self

Standard Self typedef

Definition at line 27 of file mitkImageStatisticsCalculator.h.

◆ statisticsMapType

typedef std::map<std::string, statisticsValueType> mitk::ImageStatisticsCalculator::statisticsMapType

Definition at line 37 of file mitkImageStatisticsCalculator.h.

◆ statisticsValueType

typedef double mitk::ImageStatisticsCalculator::statisticsValueType

Definition at line 34 of file mitkImageStatisticsCalculator.h.

◆ Superclass

typedef itk::Object mitk::ImageStatisticsCalculator::Superclass

Definition at line 28 of file mitkImageStatisticsCalculator.h.

Constructor & Destructor Documentation

◆ ImageStatisticsCalculator()

mitk::ImageStatisticsCalculator::ImageStatisticsCalculator ( )
inlineprotected

Definition at line 79 of file mitkImageStatisticsCalculator.h.

Member Function Documentation

◆ GetBinSizeForHistogramStatistics()

double mitk::ImageStatisticsCalculator::GetBinSizeForHistogramStatistics ( ) const

Retrieve the bin size for histogram statistics. Careful: The return value does not indicate whether NBins or BinSize is used. That solely depends on which parameter has been set last.

Documentation

◆ GetClassName()

virtual const char* mitk::ImageStatisticsCalculator::GetClassName ( ) const
virtual

Runtime information support.

◆ GetNBinsForHistogramStatistics()

unsigned int mitk::ImageStatisticsCalculator::GetNBinsForHistogramStatistics ( ) const

Retrieve the number of bins used for histogram statistics. Careful: The return value does not indicate whether NBins or BinSize is used. That solely depends on which parameter has been set last.

Documentation

◆ GetStatistics()

ImageStatisticsContainer* mitk::ImageStatisticsCalculator::GetStatistics ( )

Returns the statistics. If these requested statistics are not computed yet the computation is done as well.

Documentation

◆ New()

static Pointer mitk::ImageStatisticsCalculator::New ( )
static

Method for creation through the object factory.

◆ SetBinSizeForHistogramStatistics()

void mitk::ImageStatisticsCalculator::SetBinSizeForHistogramStatistics ( double  binSize)

Set bin size to be used for histogram statistics. If nbins is set after bin size, nbins will be used instead!

Documentation

◆ SetInputImage()

void mitk::ImageStatisticsCalculator::SetInputImage ( const mitk::Image *  image)

Set the image for which the statistics are to be computed.

Documentation

◆ SetMask()

void mitk::ImageStatisticsCalculator::SetMask ( mitk::MaskGenerator *  mask)

Set the mask generator that creates the mask which is to be used to calculate statistics. If no more mask is desired simply set.

Documentation

Parameters
maskto nullptr

◆ SetNBinsForHistogramStatistics()

void mitk::ImageStatisticsCalculator::SetNBinsForHistogramStatistics ( unsigned int  nBins)

Set number of bins to be used for histogram statistics. If Bin size is set after number of bins, bin size will be used instead!

Documentation

◆ SetSecondaryMask()

void mitk::ImageStatisticsCalculator::SetSecondaryMask ( mitk::MaskGenerator *  mask)

Set this if more than one mask should be applied (for instance if a IgnorePixelValueMask were to be used alongside with a segmentation). Both masks are combined using pixel wise AND operation. The secondary mask does not have to be the same size than the primary but they need to have some overlap.

Documentation

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