Medical Imaging Interaction Toolkit  2018.4.99-bd7b41ba
Medical Imaging Interaction Toolkit
mitk::ImageStatisticsCalculator Class Reference

#include <mitkImageStatisticsCalculator.h>

Inheritance diagram for mitk::ImageStatisticsCalculator:
Collaboration diagram for mitk::ImageStatisticsCalculator:

Public Types

typedef ImageStatisticsCalculator Self
 
typedef itk::Object Superclass
 
typedef itk::SmartPointer< SelfPointer
 
typedef itk::SmartPointer< const SelfConstPointer
 
typedef double statisticsValueType
 
typedef std::map< std::string, statisticsValueTypestatisticsMapType
 
typedef itk::Statistics::Histogram< double > HistogramType
 
typedef unsigned short MaskPixelType
 
using LabelIndex = ImageStatisticsContainer::LabelIndex
 

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...
 
ImageStatisticsContainerGetStatistics (LabelIndex label=1)
 Returns the statistics for label label. If these requested statistics are not computed yet the computation is done as well. For performance reasons, statistics for all labels in the image are computed at once. 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

◆ HistogramType

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

Definition at line 38 of file mitkImageStatisticsCalculator.h.

◆ LabelIndex

◆ MaskPixelType

Definition at line 39 of file mitkImageStatisticsCalculator.h.

◆ Pointer

◆ Self

◆ statisticsMapType

◆ statisticsValueType

◆ Superclass

Definition at line 28 of file mitkImageStatisticsCalculator.h.

Constructor & Destructor Documentation

◆ ImageStatisticsCalculator()

mitk::ImageStatisticsCalculator::ImageStatisticsCalculator ( )
inlineprotected

Definition at line 80 of file mitkImageStatisticsCalculator.h.

References image.

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

Definition at line 91 of file mitkImageStatisticsCalculator.cpp.

◆ 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

Definition at line 71 of file mitkImageStatisticsCalculator.cpp.

◆ GetStatistics()

mitk::ImageStatisticsContainer * mitk::ImageStatisticsCalculator::GetStatistics ( LabelIndex  label = 1)

◆ New()

◆ 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

Definition at line 76 of file mitkImageStatisticsCalculator.cpp.

◆ SetInputImage()

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

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

Documentation

Definition at line 29 of file mitkImageStatisticsCalculator.cpp.

References image.

◆ 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

Definition at line 38 of file mitkImageStatisticsCalculator.cpp.

References mask.

◆ 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

Definition at line 56 of file mitkImageStatisticsCalculator.cpp.

◆ 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

Definition at line 47 of file mitkImageStatisticsCalculator.cpp.

References mask.


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