function for computing super voxels More...

IPSDKIPLADVANCEDMORPHOLOGY_API image::ImagePtr	ipsdk::imaproc::advmorpho::superVoxels3dImg (const image::ImageConstPtr &pInImg, const ipUInt32 inSuperPixelsParamValue, const ipReal32 inCompactness, const ipUInt32 inNbIter)
	wrapper function for Super voxels algorithm based on SLIC More...

IPSDKIPLADVANCEDMORPHOLOGY_API image::ImagePtr	ipsdk::imaproc::advmorpho::superVoxels3dImg (const image::ImageConstPtr &pInImg, const ipUInt32 inSuperPixelsParamValue, const ipReal32 inCompactness, const ipUInt32 inNbIter, const ipReal32 inOptSizeRatio, const ipsdk::imaproc::attr::eSuperPixelsType &pInOptSuperPixelsType)
	wrapper function for Super voxels algorithm based on SLIC More...

IPSDKIPLADVANCEDMORPHOLOGY_API void	ipsdk::imaproc::advmorpho::superVoxels3dImg (const image::ImageConstPtr &pInImg, const ipUInt32 inSuperPixelsParamValue, const ipReal32 inCompactness, const ipUInt32 inNbIter, const image::ImagePtr &pOutLabelImg)
	wrapper function for Super voxels algorithm based on SLIC More...

IPSDKIPLADVANCEDMORPHOLOGY_API void	ipsdk::imaproc::advmorpho::superVoxels3dImg (const image::ImageConstPtr &pInImg, const ipUInt32 inSuperPixelsParamValue, const ipReal32 inCompactness, const ipUInt32 inNbIter, const ipReal32 inOptSizeRatio, const ipsdk::imaproc::attr::eSuperPixelsType &pInOptSuperPixelsType, const image::ImagePtr &pOutLabelImg)
	wrapper function for Super voxels algorithm based on SLIC More...

Detailed Description

function for computing super voxels

The super voxels algorithm is based on the SILC method (Simple Linear Iterative Clustering)

See also: https://darshita1405.medium.com/superpixels-and-slic-6b2d8a6e4f08

This algorithm is used to separate an image into super voxels (group of voxels). Those super voxels are computed to follow the contours of the input image. Each voxel is compared with the center of the closest super voxels, and associated to the most similar one, in term of distance and color.

The following parameters allow to optimise the computation of the super voxels:

is the desired number of super voxels, or the desired size of the super voxels, depending on the value of .
is the ratio between the euclidian distance and the color distance, used to classify a voxel in his corresponding super voxels. With a small value, the super voxels will fit the contours better, and with a high value, the super voxels will be more regular. Advised values are around 0.5.
is the number of iterations used in the algorithm. At the end of each iteration, the center of each super voxel is updated for the next iteration.
is the minimal size of a super voxel (as a fraction of their supposed size). If a super voxel is smaller, it will be removed and replaced by the neighboring super voxels. Default value is 0.5.
define if the first parameter is the desired number of super voxels, or the desired size of the super voxels. Default value is "Number".

For simplest visualization, an example of super pixels computation is illustrated in Super Pixels 2d.

Attributes description

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InImg3d	[Input] 3d image for operation	X
ipsdk::imaproc::attr::InSuperPixelsParamValue	[Input] Value used to initialize super pixels (number or size)	X
ipsdk::imaproc::attr::InNbIter	[Input] Number of iterations for an iterative algorithm	X
ipsdk::imaproc::attr::InCompactness	[Input] Ratio between distance and color for super pixels algorithm	X
ipsdk::imaproc::attr::InOptSizeRatio	[Input Optional] Ratio to compare a size with a reference	X
ipsdk::imaproc::attr::InOptSuperPixelsType	[Input Optional] Type of input parameter for super pixels algorithm (number of super pixels or size)	X
ipsdk::imaproc::attr::OutWk1Img	[Output] Temporary working image for algorithm	duplicateInOut (_pOutWk1Img, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Real32)
ipsdk::imaproc::attr::OutWk1LabelImg	[Output] Temporary working image for algorithm	duplicateGreyInOut (_pOutWk1LabelImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Label32)
ipsdk::imaproc::attr::OutLabelImg	[Output] label image for processing operation	duplicateGreyInOut (_pOutLabelImg, _pInImg3d, ipsdk::image::eImageBufferType::eIBT_Label32)

Global Rule description

Global rule description for algorithm :
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_XYZT,_pInImg3d,_pOutLabelImg)

Example of Python code :

Example imports

import PyIPSDK

import PyIPSDK.IPSDKIPLAdvancedMorphology as advmorpho

Code Example

    # opening of input image
    inImg = PyIPSDK.loadTiffImageFile(inputImgPath)
    # Optional parameters
    superPixelsNumber = 500
    compactness = 0.5
    nbIter = 3
    sizeRatio = 0.5
    superPixelsType = PyIPSDK.eSPT_Number
    outImg = advmorpho.superVoxels3dImg(inImg, superPixelsNumber, compactness, nbIter, sizeRatio, superPixelsType)

Example of C++ code :

Example informations

Associated library

IPSDKIPLAdvancedMorphology

Header file

#include <IPSDKIPL/IPSDKIPLAdvancedMorphology/Processor/SuperVoxels3dImg/SuperVoxels3dImg.h>

Code Example

        ImagePtr pInImg = loadTiffImageFile(inputImgPath);
        ImagePtr pOutBinLabImg = superVoxels3dImg(pInImg, 500, 0.5, 3);

See also: SuperVoxels3dImgLvl1; SuperVoxels3dImgLvl2; SuperVoxels3dImgLvl3

Function Documentation

◆ superVoxels3dImg() [1/4]

IPSDKIPLADVANCEDMORPHOLOGY_API image::ImagePtr ipsdk::imaproc::advmorpho::superVoxels3dImg	(	const image::ImageConstPtr &	pInImg,
		const ipUInt32	inSuperPixelsParamValue,
		const ipReal32	inCompactness,
		const ipUInt32	inNbIter
	)

wrapper function for Super voxels algorithm based on SLIC

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ superVoxels3dImg() [2/4]

IPSDKIPLADVANCEDMORPHOLOGY_API image::ImagePtr ipsdk::imaproc::advmorpho::superVoxels3dImg	(	const image::ImageConstPtr &	pInImg,
		const ipUInt32	inSuperPixelsParamValue,
		const ipReal32	inCompactness,
		const ipUInt32	inNbIter,
		const ipReal32	inOptSizeRatio,
		const ipsdk::imaproc::attr::eSuperPixelsType &	pInOptSuperPixelsType
	)

wrapper function for Super voxels algorithm based on SLIC

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ superVoxels3dImg() [3/4]

IPSDKIPLADVANCEDMORPHOLOGY_API void ipsdk::imaproc::advmorpho::superVoxels3dImg	(	const image::ImageConstPtr &	pInImg,
		const ipUInt32	inSuperPixelsParamValue,
		const ipReal32	inCompactness,
		const ipUInt32	inNbIter,
		const image::ImagePtr &	pOutLabelImg
	)

wrapper function for Super voxels algorithm based on SLIC

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ superVoxels3dImg() [4/4]

IPSDKIPLADVANCEDMORPHOLOGY_API void ipsdk::imaproc::advmorpho::superVoxels3dImg	(	const image::ImageConstPtr &	pInImg,
		const ipUInt32	inSuperPixelsParamValue,
		const ipReal32	inCompactness,
		const ipUInt32	inNbIter,
		const ipReal32	inOptSizeRatio,
		const ipsdk::imaproc::attr::eSuperPixelsType &	pInOptSuperPixelsType,
		const image::ImagePtr &	pOutLabelImg
	)

wrapper function for Super voxels algorithm based on SLIC

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure