measure of common statistics indicators in an image (mean, max, etc.) for each 2d plan More...

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::StatsResultPtr	ipsdk::imaproc::glbmsr::statsMsr2d (const ipsdk::image::ImageConstPtr &pInImg)
	wrapper function for measure of common statistics indicators in an image (mean, max, etc.) for each 2d plan More...

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

Detailed Description

measure of common statistics indicators in an image (mean, max, etc.) for each 2d plan

This algorithm computes statistic measurements for each 2d plan of the input image.

In other words, the results will be computed :

for the whole grey level 2d image,
for each channel of a color image,
for each slice of a volume,
for each frame in a 2d sequence,
...
for each channel of each slice of each volume of an RGB volume sequence.

Two wrappers can be called : the statsMsr2d wrapper is only used to compute the statistic measurements on a grey level 2d image, whereas the multiSlice_statsMsr2d wrapper must be used for more complex data (volume, 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::InImg	[Input] image for processing operation	X
ipsdk::imaproc::attr::OutPIStatsResult	[Output] Plan indexed collection of results for image statistics measure operation	ipsdk::imaproc::fromImage (_pOutPIStatsResult, _pInImg)

Global Rule description

Global rule description for algorithm :
ipsdk::imaproc::matchImagePlans (_pOutPIStatsResult,_pInImg,eImagePlansMatchPolicy::eIPMP_ZCT)

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.statsMsr2d(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

#include <IPSDKIPL/IPSDKIPLGlobalMeasure/Processor/StatsMsr2d/StatsMsr2d.h>

Code Example

    // ------------ Calculation on a mono-slice grey level image ------------ //
    // Load the input image
    ImagePtr pInImg = loadTiffImageFile(inImgPath);
    // Compute statistics on input image
    StatsResultPtr pStatsRes = statsMsr2d(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 image -------------- //
    // Load the input image
    ImagePtr pInImg_multiSlice = loadTiffImageFile(inImgPath_multiSlice);
    // Compute statistics on input image
    PlanIndexedStatsResultPtr pStatsRes_multiSlice = multiSlice_statsMsr2d(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: StatsMsr2dLvl1; StatsMsr2dLvl2; StatsMsr2dLvl3

Function Documentation

◆ statsMsr2d()

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

wrapper function for measure of common statistics indicators in an image (mean, max, etc.) for each 2d plan

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ multiSlice_statsMsr2d()

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

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

Note: This wrapper can be used with multi slice input images to retrieve by slice results

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure