Level 1 algorithm: Compute compactness given an input image of classes and clusters centroids. More...

#include <KMeansComputeCompactnessLvl1.h>

Inheritance diagram for ipsdk::imaproc::classif::KMeansComputeCompactnessLvl1:

Public Member Functions
	~KMeansComputeCompactnessLvl1 ()
	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::InClassImg &	get () const
	Getter for attribute InClassImg.

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

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::InClustersCenters &	get () const
	Getter for attribute InClustersCenters.

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

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

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

Public Member Functions inherited from ipsdk::processor::BaseProcessor< ipsdk::core::BaseAsync1Action >
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< KMeansComputeCompactnessLvl1 >	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
	KMeansComputeCompactnessLvl1 ()
	constructor

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

ipsdk::core::ExecResult	postProcess ()
	method called after processing More...

	IPSDK_DECLARE_STATIC_RESULT_COLL (attr::OutKMeansCompactnessInfo, OutKMeansCompactnessInfoColl)

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

Protected Attributes
attr::DoublesPtr	_pFlattenedClustersCenters

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

boost::shared_ptr< ipsdk::imaproc::attr::InClassImg >	_pInClassImg

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

boost::shared_ptr< ipsdk::imaproc::attr::InClustersCenters >	_pInClustersCenters

boost::shared_ptr< ipsdk::imaproc::attr::OutCompactness >	_pOutCompactness

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

ipUInt32	_nbIter

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

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

Detailed Description

Level 1 algorithm: Compute compactness given an input image of classes and clusters centroids.

See KMeansComputeCompactness algorithm for a complete algorithm description.

Author: H. Delestre

Date: 2018/09/03

Copyright: 2018 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::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::InClustersCenters	[Input] centers of clusters	X
ipsdk::imaproc::attr::OutCompactness	[Output] Compactness, used in k-means algorithm	X

Global attributes rule :

Global rule on attributes is given by
ipsdk::processor::none ()

Member Function Documentation

◆ getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::classif::KMeansComputeCompactnessLvl1::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::KMeansComputeCompactnessLvl1::retrieveProvider	(	const ipsdk::core::BasePriority &	priority,
		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

◆ postProcess()

ipsdk::core::ExecResult ipsdk::imaproc::classif::KMeansComputeCompactnessLvl1::postProcess ( )

protected

method called after processing

Returns: execution result

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/KMeansComputeCompactness/KMeansComputeCompactnessLvl1.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members