Compute clusters centroids given an input image and the image of classes. More...

IPSDKIPLCLASSIFICATION_API attr::ClustersCentersPtr	ipsdk::imaproc::classif::kMeansComputeCenters (const ipsdk::image::ImageConstPtr &pInImg, const ipsdk::image::ImageConstPtr &pClassImg)
	wrapper function for Compute clusters centroids given an input image and the image of classes More...

IPSDKIPLCLASSIFICATION_API attr::ClustersCentersPtr	ipsdk::imaproc::classif::kMeansComputeCenters (const ipsdk::image::ImageConstPtr &pInImg, const ipsdk::image::ImageConstPtr &pClassImg, const ipsdk::image::ImageConstPtr &pMaskImg)
	wrapper function for Compute clusters centroids given an input image and the image of classes More...

IPSDKIPLCLASSIFICATION_API attr::ClustersCentersPtr	ipsdk::imaproc::classif::kMeansComputeCenters (const ipsdk::image::ImageConstPtr &pInImg, const ipsdk::image::ImageConstPtr &pClassImg, const ipUInt32 nbClusters)
	wrapper function for Compute clusters centroids given an input image and the image of classes More...

IPSDKIPLCLASSIFICATION_API attr::ClustersCentersPtr	ipsdk::imaproc::classif::kMeansComputeCenters (const ipsdk::image::ImageConstPtr &pInImg, const ipsdk::image::ImageConstPtr &pClassImg, const ipsdk::image::ImageConstPtr &pMaskImg, const ipUInt32 nbClusters)
	wrapper function for Compute clusters centroids given an input image and the image of classes More...

Detailed Description

Compute clusters centroids given an input image and the image of classes.

Consider:

an image of size (x, y, z, c, t) (with x, y and z the sizes respectively along x, y and z-axis, c the number of color channels and t the number of elements in temporal sequence) as a set of x*y*z data vector of c*t dimension, and a set of n clusters of dimensions c*t (n > 1),
and an image of size (x, y ,z) giving the class of each data vector.

The algorithm computes the properties of each cluster, namely the centroids, the standard deviation along each dimension and the compactness. For empty clusters, centroids coordinates are set to 0.

Input and output attributes of the algorithm are:

: the input image of data vectors,
: image giving, for each data vector, the class which it belongs to; this image must be a single grey-level image, and it must have same size than along x, y and z axis,
: total number of clusters; if not intialized, this number is computed by the algorithm from the InClassImg, which may require a little bit more time,
: collection of clusters properties computed by the algorithm, namely:
- clusters centers,
- clusters standard deviations for each dimension,
- clusters compactnesses; a cluster compactness equals to the sum of the squared distances between the cluster center and all the clusters elements,
- global compactnesses, that is the sum of all clusters compactnesses,
: optional; collection of population per cluster.

Note: A mask can be provided to use only a subset of pixels/voxels during the calculation.

Attributes description

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InHomogeneousImg	[Input] Homogeneous image	X
ipsdk::imaproc::attr::InClassImg	[Input] Image of classes	X
ipsdk::imaproc::attr::InOptSingleGreyMaskImg	[Input Optional] Binary image for masking operation for each (x, y, z) coordinate regardless to (c, t) coordinates	X
ipsdk::imaproc::attr::InOptNbClusters	[Input Optional] Number of clusters	X
ipsdk::imaproc::attr::OutClustersCenters	[Output] Centers of clusters	ipsdk::processor::allocate (_pOutClustersCenters)
ipsdk::imaproc::attr::OutOptNbEltsPerCluster	[Output Optional] Number of elements per cluster	X

Global Rule description

Global rule description for algorithm :
ipsdk::processor::If (
ipsdk::processor::isSet (_pInOptSingleGreyMaskImg),
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pInHomogeneousImg,_pInOptSingleGreyMaskImg),
ipsdk::processor::none ())

Example of Python code :

Example imports

import PyIPSDK

import PyIPSDK.IPSDKIPLClassification as classif

Code Example

    # opening of input image
    inImg = PyIPSDK.loadTiffImageFile(inputImgPath)
    
    # opening of input class image
    inClassImg = PyIPSDK.loadTiffImageFile(inputClassImgPath)
    
    # apply "compute centers" algorithm
    outClustersCenters = classif.kMeansComputeCenters(inImg, inClassImg)
    
    # Access to the first cluster center
    firstClusterCenter = outClustersCenters.coll[0].elements

Example of C++ code :

Example informations

Associated library

IPSDKIPLClassification

Header file

#include <IPSDKIPL/IPSDKIPLClassification/Processor/KMeansComputeCenters/KMeansComputeCenters.h>

Code Example

    ImagePtr pInImg = loadTiffImageFile(inputImgPath);
    ImagePtr pInClassImg = loadTiffImageFile(inputClassImgPath);
    const ipUInt64 nbExpectedClusters = 4;
    // apply clusters centers computation algorithm
    ClustersCentersPtr pOutClustersCenters = classif::kMeansComputeCenters(pInImg, pInClassImg, nbExpectedClusters);
    // Access to the first generated cluster center elements
    ClusterCenterPtr clusterCenter = pOutClustersCenters->getNodeColl<ClustersCenters::Coll>()[0];
    const std::vector<ipReal64>& vRandomClusterElements = clusterCenter->getLeafColl<ClusterCenter::Elements>();

See also: KMeansComputeCentersLvl1; KMeansComputeCentersLvl2; KMeansComputeCentersLvl3

Function Documentation

◆ kMeansComputeCenters() [1/4]

IPSDKIPLCLASSIFICATION_API attr::ClustersCentersPtr ipsdk::imaproc::classif::kMeansComputeCenters	(	const ipsdk::image::ImageConstPtr &	pInImg,
		const ipsdk::image::ImageConstPtr &	pClassImg
	)

wrapper function for Compute clusters centroids given an input image and the image of classes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ kMeansComputeCenters() [2/4]

IPSDKIPLCLASSIFICATION_API attr::ClustersCentersPtr ipsdk::imaproc::classif::kMeansComputeCenters	(	const ipsdk::image::ImageConstPtr &	pInImg,
		const ipsdk::image::ImageConstPtr &	pClassImg,
		const ipsdk::image::ImageConstPtr &	pMaskImg
	)

wrapper function for Compute clusters centroids given an input image and the image of classes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ kMeansComputeCenters() [3/4]

IPSDKIPLCLASSIFICATION_API attr::ClustersCentersPtr ipsdk::imaproc::classif::kMeansComputeCenters	(	const ipsdk::image::ImageConstPtr &	pInImg,
		const ipsdk::image::ImageConstPtr &	pClassImg,
		const ipUInt32	nbClusters
	)

wrapper function for Compute clusters centroids given an input image and the image of classes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure

◆ kMeansComputeCenters() [4/4]

IPSDKIPLCLASSIFICATION_API attr::ClustersCentersPtr ipsdk::imaproc::classif::kMeansComputeCenters	(	const ipsdk::image::ImageConstPtr &	pInImg,
		const ipsdk::image::ImageConstPtr &	pClassImg,
		const ipsdk::image::ImageConstPtr &	pMaskImg,
		const ipUInt32	nbClusters
	)

wrapper function for Compute clusters centroids given an input image and the image of classes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException on failure