Computes the ratio between the number of pivoxels and the total image size. More...

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::DoublesPtr	ipsdk::imaproc::glbmsr::volumePercent3dMsr (const ipsdk::image::ImageConstPtr &pInImg)
	wrapper function for Computes the ratio between the number of pivoxels and the total image size. More...

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::DoublesPtr	ipsdk::imaproc::glbmsr::volumePercent3dMsr (const ipsdk::image::ImageConstPtr &pInImg, const ipsdk::image::ImageConstPtr &pInMaskImg)
	wrapper function for Computes the ratio between the number of pivoxels and the total image size. More...

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::PlanIndexedDoublesPtr	ipsdk::imaproc::glbmsr::multiSlice_volumePercent3dMsr (const ipsdk::image::ImageConstPtr &pInImg)
	wrapper function for Computes the ratio between the number of pivoxels and the total image size. More...

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::PlanIndexedDoublesPtr	ipsdk::imaproc::glbmsr::multiSlice_volumePercent3dMsr (const ipsdk::image::ImageConstPtr &pInImg, const ipsdk::image::ImageConstPtr &pInMaskImg)
	wrapper function for Computes the ratio between the number of pivoxels and the total image size. More...

Detailed Description

Computes the ratio between the number of pivoxels and the total image size.

This algorithm computes the ratio between the 3D objects volumes and the total image volume. Let VolumePercent(i) be the result for the ith object, Volume(i) its volume and (sizeX, sizeY, sizeZ) the image size, the calculation can be expressed as follows:

$VolumePercent(i) = \frac{Volume(i)}{sizeX \times sizeY \times sizeZ}$

In the case of binary images, the result contains the volume ratio for the background (voxels set to 0) at index 0 and the volume ratio for the foreground (voxels set to 1) at index 1.

In the case of label images, the result contains the volume ratio for the background (voxels set to 0) at index 0 and then the volume ratio for each label.

Here is an example of result for a label image:

Attributes description

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InBinLabImg3d	[Input] binary or label 3d image for processing operation	X
ipsdk::imaproc::attr::InOptMaskImg	[Input Optional] Binary image for masking operation	X
ipsdk::imaproc::attr::OutPIValues	[Output] plan indexed collection of values	ipsdk::imaproc::fromImageButVolume (_pOutPIValues, _pInBinLabImg3d)

Global Rule description

Global rule description for algorithm :
ipsdk::processor::If (
ipsdk::processor::isSet (_pInOptMaskImg),
ipsdk::imaproc::matchSize (_pInBinLabImg3d,_pInOptMaskImg),
ipsdk::processor::none ()) &&
ipsdk::imaproc::matchImagePlans (_pOutPIValues,_pInBinLabImg3d,eImagePlansMatchPolicy::eIPMP_CT)

Example of Python code :

Example imports

import PyIPSDK

import PyIPSDK.IPSDKIPLGlobalMeasure as glbmsr

Code Example

    # measurement for a single slice
    result = glbmsr.volumePercent3dMsr(inImg)
    # retrieve measurement results
    print("Volume percent for the first shape is " + str(result.coll[1]))
    # measurement for a multi-slice case
    planIndexedResult = glbmsr.multiSlice_volumePercent3dMsr(inImg_multiSlice)
    # retrieve measurement results
    resSlice1 = PyIPSDK.toPyDict(planIndexedResult)[(0, 0, 1)]
    print("Volume percent for the second slice is " + str(resSlice1["Coll"]))

Example of C++ code :

Example informations

Associated library

IPSDKIPLGlobalMeasure

Header file

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

Code Example

        // ------------ Calculation on a mono-slice grey level image ------------ //
        // Compute area percents on the mono-slice input image
        DoublesPtr pResult = volumePercent3dMsr(pInImg);
        // Retrieve the results as scalar variables
        // pResBinary contains 2 values for binary input images : vResult[0] for background and vResult[1] for foreground
        // and nbLabels + 1 values to include the background
        const std::vector<ipReal64>& vResult = pResult->getLeafColl<Doubles::Coll>();
        // --------------- Calculation on a multi-slice sequence image -------------- //
        // Compute area percents on the monoslice input binary image
        PlanIndexedDoublesPtr pResult_multiSlice = multiSlice_volumePercent3dMsr(pInImg_multiSlice);
        // Retrieve the results as scalar variables for z = 1
        const ipUInt64 t = 1;
        const std::vector<ipReal64>& vResult_multiSlice = pResult_multiSlice->getValue(0, 0, t).getNode<Doubles::Coll>().getColl();

See also: VolumePercent3dMsrLvl1; VolumePercent3dMsrLvl2; VolumePercent3dMsrLvl3

Function Documentation

◆ volumePercent3dMsr() [1/2]

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::DoublesPtr ipsdk::imaproc::glbmsr::volumePercent3dMsr ( const ipsdk::image::ImageConstPtr & pInImg )

wrapper function for Computes the ratio between the number of pivoxels and the total image size.

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ volumePercent3dMsr() [2/2]

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::DoublesPtr ipsdk::imaproc::glbmsr::volumePercent3dMsr	(	const ipsdk::image::ImageConstPtr &	pInImg,
		const ipsdk::image::ImageConstPtr &	pInMaskImg
	)

wrapper function for Computes the ratio between the number of pivoxels and the total image size.

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ multiSlice_volumePercent3dMsr() [1/2]

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::PlanIndexedDoublesPtr ipsdk::imaproc::glbmsr::multiSlice_volumePercent3dMsr ( const ipsdk::image::ImageConstPtr & pInImg )

wrapper function for Computes the ratio between the number of pivoxels and the total image size.

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ multiSlice_volumePercent3dMsr() [2/2]

IPSDKIPLGLOBALMEASURE_API ipsdk::imaproc::attr::PlanIndexedDoublesPtr ipsdk::imaproc::glbmsr::multiSlice_volumePercent3dMsr	(	const ipsdk::image::ImageConstPtr &	pInImg,
		const ipsdk::image::ImageConstPtr &	pInMaskImg
	)

wrapper function for Computes the ratio between the number of pivoxels and the total image size.

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure