IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Functions

Measure of common statistics indicators in the image (mean, max, etc.) algorithm. More...

Functions

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::StatsResultPtr ipsdk::imaproc::glbmsr::statsMsr3d (const ipsdk::image::ImageConstPtr &pInImg)
 wrapper function for measure of common statistics indicators in a 3d image (mean, max, etc.) More...
 
IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::PlanIndexedStatsResultPtr ipsdk::imaproc::glbmsr::multiSlice_statsMsr3d (const ipsdk::image::ImageConstPtr &pInImg)
 wrapper function for measure of common statistics indicators in a 3d image (mean, max, etc.) More...
 

Detailed Description

Measure of common statistics indicators in the image (mean, max, etc.) algorithm.

This algorithm computes statistic measurements for each 3d data of the input image.

In other words, the results will be computed :

Two wrappers can be called : the statsMsr3d wrapper is only used to compute the statistic measurements on a grey level 3d volume, whereas the multiSlice_statsMsr3d wrapper must be used for more complex data (sequence and/or color).

See ipsdk::imaproc::attr::StatsResult for a complete list of image statistic measurements processed by this algorithm.

Attributes description

Attribute description for algorithm :

Name ToolTip Default Initializer
ipsdk::imaproc::attr::InImg3d [Input] 3d image for operation X
ipsdk::imaproc::attr::OutPIStatsResult [Output] Plan indexed collection of results for image statistics measure operation ipsdk::imaproc::fromImageButVolume (_pOutPIStatsResult, _pInImg3d)

Global Rule description

Global rule description for algorithm :
ipsdk::imaproc::matchImagePlans (_pOutPIStatsResult,_pInImg3d,eImagePlansMatchPolicy::eIPMP_CT)

Example of Python code :

Example imports

import PyIPSDK
import PyIPSDK.IPSDKIPLGlobalMeasure as glbmsr

Code Example

# opening of input image
inImg = PyIPSDK.loadTiffImageFile(inputImgPath)
# statistics measurement
statsMsrResult = glbmsr.statsMsr3d(inImg)
# retrieve measurement results
mean = statsMsrResult.mean
print("Mean value for image is " + str(mean))

Example of C++ code :

Example informations

Associated library

IPSDKIPLGlobalMeasure

Header file

Code Example

// ------------ Calculation on a mono-slice grey level volume ------------ //
// Load the input image
ImagePtr pInImg = loadTiffImageFile(inImgPath, eTiffDirectoryMode::eTDM_Volume);
// Compute statistics on input image
StatsResultPtr pStatsRes = statsMsr3d(pInImg);
// Retrieve the results as scalar variables
const ipUInt64 uPixCount = pStatsRes->getValue<StatsResult::PixCount>();
const ipReal64 fSum = pStatsRes->getValue<StatsResult::Sum>();
const ipReal64 fMean = pStatsRes->getValue<StatsResult::Mean>();
const ipReal64 fStdDev = pStatsRes->getValue<StatsResult::StdDev>();
const ipReal64 fMin = pStatsRes->getValue<StatsResult::Min>();
const ipReal64 fMax = pStatsRes->getValue<StatsResult::Max>();
// --------------- Calculation on a multi-slice RGB volume -------------- //
// Load the input image
ImagePtr pInImg_multiSlice = loadTiffImageFile(inImgPath_multiSlice, eTiffDirectoryMode::eTDM_Volume);
// Compute statistics on input image
PlanIndexedStatsResultPtr pStatsRes_multiSlice = multiSlice_statsMsr3d(pInImg_multiSlice);
// Retrieve the results as scalar variables for the channel 1 (Green color)
const ipUInt64 c = 1;
const ipUInt64 uPixCount_multiSlice = pStatsRes_multiSlice->getValue(0, c, 0).getNode<StatsResult::PixCount>().getValue();
const ipReal64 fSum_multiSlice = pStatsRes_multiSlice->getValue(0, c, 0).getNode<StatsResult::Sum>().getValue();
const ipReal64 fMean_multiSlice = pStatsRes_multiSlice->getValue(0, c, 0).getNode<StatsResult::Mean>().getValue();
const ipReal64 fStdDev_multiSlice = pStatsRes_multiSlice->getValue(0, c, 0).getNode<StatsResult::StdDev>().getValue();
const ipReal64 fMin_multiSlice = pStatsRes_multiSlice->getValue(0, c, 0).getNode<StatsResult::Min>().getValue();
const ipReal64 fMax_multiSlice = pStatsRes_multiSlice->getValue(0, c, 0).getNode<StatsResult::Max>().getValue();
See also
StatsMsr3dLvl1
StatsMsr3dLvl2
StatsMsr3dLvl3

Function Documentation

◆ statsMsr3d()

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::StatsResultPtr ipsdk::imaproc::glbmsr::statsMsr3d ( const ipsdk::image::ImageConstPtr pInImg)

wrapper function for measure of common statistics indicators in a 3d image (mean, max, etc.)

Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionon failure

◆ multiSlice_statsMsr3d()

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::PlanIndexedStatsResultPtr ipsdk::imaproc::glbmsr::multiSlice_statsMsr3d ( const ipsdk::image::ImageConstPtr pInImg)

wrapper function for measure of common statistics indicators in a 3d image (mean, max, etc.)

Note
This wrapper can be used with multi slice input images to retrieve by slice results
Exceptions
ipsdk::processor::IPSDKBaseProcessingExceptionon failure