Level 1 algorithm: Initializes the clusters for K-Mean classification. More...

#include <KMeansPPClusterInitLvl1.h>

Inheritance diagram for ipsdk::imaproc::classif::KMeansPPClusterInitLvl1:

Public Member Functions
	~KMeansPPClusterInitLvl1 ()
	destructor

const std::string &	getObjectName () const
	method allowing to retrieve object name

const std::string &	getToolTip () const
	method allowing to retrieve object tooltip

const boost::filesystem::path	getHeaderPath () const
	retrieve relative header path associated to processor

const std::string	getLibraryName () const
	retrieve library name associated processor

template<typename TAttribute >
TAttribute::StorageType	getStorage ()
	retrieve storage associated to a given attribute More...

Attribute accessors
Setters and Getters for attributes
template<>
const ipsdk::imaproc::attr::InHomogeneousImg &	get () const
	Getter for attribute InHomogeneousImg.

template<>
void	set (const typename ipsdk::imaproc::attr::InHomogeneousImg::StorageType &value)
	Setter for attribute InHomogeneousImg.

template<>
const ipsdk::imaproc::attr::InOptSingleGreyMaskImg &	get () const
	Getter for attribute InOptSingleGreyMaskImg.

template<>
void	set (const typename ipsdk::imaproc::attr::InOptSingleGreyMaskImg::StorageType &value)
	Setter for attribute InOptSingleGreyMaskImg.

template<>
const ipsdk::imaproc::attr::InNbClusters &	get () const
	Getter for attribute InNbClusters.

template<>
void	set (const typename ipsdk::imaproc::attr::InNbClusters::StorageType &value)
	Setter for attribute InNbClusters.

template<>
const ipsdk::imaproc::attr::InRandomAlgoType &	get () const
	Getter for attribute InRandomAlgoType.

template<>
void	set (const typename ipsdk::imaproc::attr::InRandomAlgoType::StorageType &value)
	Setter for attribute InRandomAlgoType.

template<>
const ipsdk::imaproc::attr::InOutOptWk1RealImg &	get () const
	Getter for attribute InOutOptWk1RealImg.

template<>
void	set (const typename ipsdk::imaproc::attr::InOutOptWk1RealImg::StorageType &value)
	Setter for attribute InOutOptWk1RealImg.

template<>
const ipsdk::imaproc::attr::OutOptWk1RealImg &	get () const
	Getter for attribute OutOptWk1RealImg.

template<>
void	set (const typename ipsdk::imaproc::attr::OutOptWk1RealImg::StorageType &value)
	Setter for attribute OutOptWk1RealImg.

template<>
const ipsdk::imaproc::attr::OutClustersCenters &	get () const
	Getter for attribute OutClustersCenters.

template<>
void	set (const typename ipsdk::imaproc::attr::OutClustersCenters::StorageType &value)
	Setter for attribute OutClustersCenters.

Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
virtual eProcessorType	getProcessorType () const =0

BoolResult	init (const eProcessorRulePolicy rulePolicy=eProcessorRulePolicy::ePRP_DisableSubRules)

const eProcessorRulePolicy &	getProcessorRulePolicy () const

std::string	getFullInfoStr () const

const BaseRule &	getGlobalRule () const

const ProcessorDispatchPolicy &	getDispatchPolicy () const

void	restrictDispatchPolicy (const ProcessorDispatchPolicy &policy)

bool	isProgressAvailable () const

ipsdk::processor::eProcessorProgressAvailability	getProgressAvailability () const

ipsdk::ipUInt64	getTotalNbIterations () const

bool	existsHeaderKey (const std::string &key) const

bool	existsHeaderKey (const std::string &key) const

ItemNames	getHeaderKeys () const

ItemNames	getHeaderKeys () const

const BaseDataItem &	getHeaderItem (const std::string &key) const

BaseDataItem &	getHeaderItem (const std::string &key)

const BaseDataItem &	getHeaderItem (const std::string &key) const

BaseDataItem &	getHeaderItem (const std::string &key)

void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)

void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)

void	removeHeaderItem (const std::string &key)

void	removeHeaderItem (const std::string &key)

void	clearHeader ()

void	clearHeader ()

ipUInt32	getNbAttributes () const

ipUInt32	getNbAttributes () const

const BaseAttribute &	getAttribute (ipUInt32 index) const

BaseAttribute &	getAttribute (ipUInt32 index)

const BaseAttribute &	getAttribute (const std::string &attributeName) const

BaseAttribute &	getAttribute (const std::string &attributeName)

const BaseAttribute &	getAttribute (ipUInt32 index) const

BaseAttribute &	getAttribute (ipUInt32 index)

const BaseAttribute &	getAttribute (const std::string &attributeName) const

BaseAttribute &	getAttribute (const std::string &attributeName)

bool	existsAttribute (const std::string &attributeName) const

bool	existsAttribute (const std::string &attributeName) const

StringVector	getAttributeNameColl () const

StringVector	getAttributeNameColl () const

bool	hasOutputInitializer (const std::string &attributeName) const

bool	hasOutputInitializer (const std::string &attributeName) const

const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const

const BaseOutputInitializer &	getOutputInitializer (const std::string &attributeName) const

Static Public Member Functions
static boost::shared_ptr< KMeansPPClusterInitLvl1 >	createProcessor ()
	processor creation function

static const std::string &	getObjectNameStr ()
	method allowing to retrieve object name

static const std::string &	getToolTipStr ()
	method allowing to retrieve object tooltip

static const boost::filesystem::path	getHeaderPathStr ()
	retrieve relative header path associated to processor

static const std::string	getLibraryNameStr ()
	retrieve library name associated processor

Protected Member Functions
	KMeansPPClusterInitLvl1 ()
	constructor

ipsdk::processor::RetrievalResult	retrieveProvider (const ipsdk::core::BasePriority &priority, ipsdk::ipUInt32 curNbIter, ipsdk::core::ActionProviderPtr &pProvider)
	method allowing to retrieve provider associated to asynchronous processing in derived class More...

template<typename T >
void	addClusterCenter (const ipUInt64 centerIdx, const ipUInt64 zIdx)
	method allowing to add a center to the collection

void	findRandomClusterCenter (ipUInt64 &maxIdx, ipUInt64 &zIdx)
	method allowing to randomly find the new center

void	mergeLvl2Results (ipUInt64 &maxIdx, ipUInt64 &zIdx)
	method allowing to merge the lvl2 results

void	clearIntermediateData ()
	method allowing to clear intermediate data for object

	IPSDK_DECLARE_STATIC_RESULT_COLL (attr::OutMaxValIdx, OutMaxValIdxColl)

	IPSDK_DECLARE_STATIC_RESULT_COLL (attr::OutKMeansPPClusterInitInfo, OutKMeansPPClusterInitInfoColl)

Protected Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
virtual BoolResult	initDerived (AttributeColl &attributeColl, OutputInitializerColl &outputInitializerColl, ProcessorDispatchPolicy &dispatchPolicy, RulePtr &pGlobalRule, const eProcessorRulePolicy &rulePolicy)=0

Protected Attributes
image::ImageConstPtr	_pReinterpretedInImg

image::ImagePtr	_pDistImg

image::ImagePtr	_pCumulDistImg

attr::DoublesPtr	_pFlattenedClustersCenters

attr::DoublesPtr	_pCumDistColl

image::ImageConstPtr	_pMaskImg

Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InHomogeneousImg >	_pInHomogeneousImg

boost::shared_ptr< ipsdk::imaproc::attr::InOptSingleGreyMaskImg >	_pInOptSingleGreyMaskImg

boost::shared_ptr< ipsdk::imaproc::attr::InNbClusters >	_pInNbClusters

boost::shared_ptr< ipsdk::imaproc::attr::InRandomAlgoType >	_pInRandomAlgoType

boost::shared_ptr< ipsdk::imaproc::attr::InOutOptWk1RealImg >	_pInOutOptWk1RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutOptWk1RealImg >	_pOutOptWk1RealImg

boost::shared_ptr< ipsdk::imaproc::attr::OutClustersCenters >	_pOutClustersCenters

Protected Attributes inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
eProcessorProgressAvailability	_processorProgressAvailability

ipUInt32	_nbIter

Additional Inherited Members
Protected Types inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseRepeatedAsync1Action >
typedef std::vector< AttributePtr >	AttributeColl

typedef std::map< std::string, OutputInitializerPtr >	OutputInitializerColl

Detailed Description

Level 1 algorithm: Initializes the clusters for K-Mean classification.

See K-Means++ cluster center initialization for a complete algorithm description.

Author: R. Abbal

Date: 2017/01/04

Copyright: 2017 Reactiv'IP, all right reserved.

Algorithm associated library :

IPSDKIPLClassification

Attribute description for algorithm :

Name	ToolTip	Default Initializer
ipsdk::imaproc::attr::InHomogeneousImg	[Input] Homogeneous image	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::InNbClusters	[Input] Number of clusters	X
ipsdk::imaproc::attr::InRandomAlgoType	[Input] Informs if the algorithm uses a random approach or not (used for instance in the KMeansPPClusterInit algorithm)	X
ipsdk::imaproc::attr::InOutOptWk1RealImg	[InOut Optional] Temporary working image for algorithm (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::OutOptWk1RealImg	[Output Optional] Temporary working image for algorithm (data contained in image buffer are reals)	X
ipsdk::imaproc::attr::OutClustersCenters	[Output] Centers of clusters	ipsdk::processor::allocate (_pOutClustersCenters)

Global attributes rule :

Global rule on attributes is given by
ipsdk::processor::ifIsSet (_pInOutOptWk1RealImg,
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pInHomogeneousImg,_pInOutOptWk1RealImg) &&
ipsdk::processor::ifIsSet (_pOutOptWk1RealImg,
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pInHomogeneousImg,_pOutOptWk1RealImg) &&
ipsdk::imaproc::matchSizeAndType (_pInOutOptWk1RealImg,_pOutOptWk1RealImg))) &&
ipsdk::processor::ifIsSet (_pInOptSingleGreyMaskImg,
ipsdk::imaproc::matchSize (eMatchImageSizeType::eMIST_3d,_pInHomogeneousImg,_pInOptSingleGreyMaskImg))

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::classif::KMeansPPClusterInitLvl1::getStorage ( )

retrieve storage associated to a given attribute

Note: This method is only available for Output and In/Out attributes

Exceptions

ipsdk::processor::IPSDKBaseProcessingException if isInit() == false

◆ retrieveProvider()

ipsdk::processor::RetrievalResult ipsdk::imaproc::classif::KMeansPPClusterInitLvl1::retrieveProvider	(	const ipsdk::core::BasePriority &	priority,
		ipsdk::ipUInt32	curNbIter,
		ipsdk::core::ActionProviderPtr &	pProvider
	)

protected

method allowing to retrieve provider associated to asynchronous processing in derived class

Returns: provider retrieval result.

Note: On success provider pointer must not be null nor uninitialized

The documentation for this class was generated from the following file:

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLClassification/Processor/KMeansPPClusterInit/KMeansPPClusterInitLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes