Medical Imaging Interaction Toolkit  2022.04.99-b2814023
Medical Imaging Interaction Toolkit
mitk::ImageStatisticsContainerManager Class Reference

Returns the StatisticsContainer that was computed on given input (image/mask/planar figure) and is added as DataNode in a DataStorage. More...

#include <mitkImageStatisticsContainerManager.h>

Static Public Member Functions

static mitk::ImageStatisticsContainer::Pointer GetImageStatistics (const mitk::DataStorage *dataStorage, const mitk::BaseData *image, const mitk::BaseData *mask=nullptr, bool ignoreZeroVoxel=false, unsigned int histogramNBins=100, bool onlyIfUpToDate=true, bool noWIP=true)
 Returns the StatisticsContainer for the given image and mask from the storage-. More...
 
static mitk::DataNode::Pointer GetImageStatisticsNode (const mitk::DataStorage *dataStorage, const mitk::BaseData *image, const mitk::BaseData *mask=nullptr, bool ignoreZeroVoxel=false, unsigned int histogramNBins=100, bool onlyIfUpToDate=true, bool noWIP=true)
 
static mitk::NodePredicateBase::ConstPointer GetStatisticsPredicateForSources (const mitk::BaseData *image, const mitk::BaseData *mask=nullptr)
 

Detailed Description

Returns the StatisticsContainer that was computed on given input (image/mask/planar figure) and is added as DataNode in a DataStorage.

Definition at line 37 of file mitkImageStatisticsContainerManager.h.

Member Function Documentation

◆ GetImageStatistics()

static mitk::ImageStatisticsContainer::Pointer mitk::ImageStatisticsContainerManager::GetImageStatistics ( const mitk::DataStorage dataStorage,
const mitk::BaseData image,
const mitk::BaseData mask = nullptr,
bool  ignoreZeroVoxel = false,
unsigned int  histogramNBins = 100,
bool  onlyIfUpToDate = true,
bool  noWIP = true 
)
static

Returns the StatisticsContainer for the given image and mask from the storage-.

Documentation

Returns
a valid StatisticsContainer or nullptr if no StatisticsContainer is found.

if more than one StatisticsContainer is found, only the newest (ModifiedTime) is returned

Precondition
Datastorage must point to a valid instance.
image must Point to a valid instance.
Parameters
dataStorage
image
mask
onlyIfUpToDateIndicates if results should only be returned if the are up to date, thus not older then image and ROI.
noWIPIf noWIP is true, the function only returns valid final result and not just its placeholder (WIP). If noWIP equals false it might also return a WIP, thus the valid result is currently processed/ordered but might not be ready yet.
ignoreZeroVoxelindicates the wanted statistics are calculated with or w/o zero voxels.
histogramNBinsNumber of bins the statistics should have that are searched for.

◆ GetImageStatisticsNode()

static mitk::DataNode::Pointer mitk::ImageStatisticsContainerManager::GetImageStatisticsNode ( const mitk::DataStorage dataStorage,
const mitk::BaseData image,
const mitk::BaseData mask = nullptr,
bool  ignoreZeroVoxel = false,
unsigned int  histogramNBins = 100,
bool  onlyIfUpToDate = true,
bool  noWIP = true 
)
static

◆ GetStatisticsPredicateForSources()

static mitk::NodePredicateBase::ConstPointer mitk::ImageStatisticsContainerManager::GetStatisticsPredicateForSources ( const mitk::BaseData image,
const mitk::BaseData mask = nullptr 
)
static

Returns the predicate that can be used to search for statistic containers of the given image (and mask) in the passed data storage.


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