ipsdk::imaproc::classif::KernelKMeansImgLvl1 Class Reference

Level 1 algorithm: Kernel KMeans clustering algorithm. More...

#include <KernelKMeansImgLvl1.h>

Inheritance diagram for ipsdk::imaproc::classif::KernelKMeansImgLvl1:

Public Member Functions
	~KernelKMeansImgLvl1 ()
	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::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::InNbSamples &	get () const
	Getter for attribute InNbSamples.
template<>
void	set (const typename ipsdk::imaproc::attr::InNbSamples::StorageType &value)
	Setter for attribute InNbSamples.
template<>
const ipsdk::imaproc::attr::InOptNbAttempts &	get () const
	Getter for attribute InOptNbAttempts.
template<>
void	set (const typename ipsdk::imaproc::attr::InOptNbAttempts::StorageType &value)
	Setter for attribute InOptNbAttempts.
template<>
const ipsdk::imaproc::attr::InOptKernelKMeansParams &	get () const
	Getter for attribute InOptKernelKMeansParams.
template<>
void	set (const typename ipsdk::imaproc::attr::InOptKernelKMeansParams::StorageType &value)
	Setter for attribute InOptKernelKMeansParams.
template<>
const ipsdk::imaproc::attr::OutClassImg &	get () const
	Getter for attribute OutClassImg.
template<>
void	set (const typename ipsdk::imaproc::attr::OutClassImg::StorageType &value)
	Setter for attribute OutClassImg.
template<>
const ipsdk::imaproc::attr::OutKKMeansCentroids &	get () const
	Getter for attribute OutKKMeansCentroids.
template<>
void	set (const typename ipsdk::imaproc::attr::OutKKMeansCentroids::StorageType &value)
	Setter for attribute OutKKMeansCentroids.
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< KernelKMeansImgLvl1 >	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
	KernelKMeansImgLvl1 ()
	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...
ipsdk::core::ExecResult	preProcess ()
	method called before processing More...
void	clearIntermediateData ()
	method allowing to clear intermediate data for object
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	_pInSeqImg
	input image with color plans reshaped as temporal plans
ipUInt32	_curNbAttempt
	current number attempt for clustering processing
ipReal32	_radialBasisKernelSigma
	used sigma value for radial basis kernel computation
ipReal32	_accuracyThreshold
attr::PlanIndexedStatsResultPtr	_pImgStats
	statistics associated to input image
attr::PlanIndexedDoublesPtr	_pImgSampledValues
	image sampled values for clustering processing
ipReal64	_bestSeparation
	'best' separation value for kernel KMeans clustering computation
attr::KKMeansCentroidsPtr	_pBestKKMeansCentroids
	'best' centroids associated to clustering computation
Attribute members
boost::shared_ptr< ipsdk::imaproc::attr::InHomogeneousImg >	_pInHomogeneousImg
boost::shared_ptr< ipsdk::imaproc::attr::InNbClusters >	_pInNbClusters
boost::shared_ptr< ipsdk::imaproc::attr::InNbSamples >	_pInNbSamples
boost::shared_ptr< ipsdk::imaproc::attr::InOptNbAttempts >	_pInOptNbAttempts
boost::shared_ptr< ipsdk::imaproc::attr::InOptKernelKMeansParams >	_pInOptKernelKMeansParams
boost::shared_ptr< ipsdk::imaproc::attr::OutClassImg >	_pOutClassImg
boost::shared_ptr< ipsdk::imaproc::attr::OutKKMeansCentroids >	_pOutKKMeansCentroids
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: Kernel KMeans clustering algorithm.

See Kernel K-means algorithm for a complete algorithm description.

Author

E.Noirfalise

Date

2018/08/17

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::InNbClusters	[Input] Number of clusters	X
ipsdk::imaproc::attr::InNbSamples	[Input] number of samples for processing operation	X
ipsdk::imaproc::attr::InOptNbAttempts	[Input Optional] Number of times k-means is executed using different initial clusters centers	X
ipsdk::imaproc::attr::InOptKernelKMeansParams	[Input Optional] parameters for kernel kmeans clustering algorithm	X
ipsdk::imaproc::attr::OutClassImg	[Output] Image of classes	customOutput (_pOutClassImg, outputKernelKMeans(_pInHomogeneousImg,_pInNbClusters))
ipsdk::imaproc::attr::OutKKMeansCentroids	[Output] collection of kernel cluster centroid representation	allocate (_pOutKKMeansCentroids)

Global attributes rule :

Global rule on attributes is given by
ipsdk::imaproc::customImageProperty (_pOutClassImg,
 matchKernelKMeansClassImg (_pInHomogeneousImg,_pInNbClusters))

Member Function Documentation

getStorage()

template<typename TAttribute >

TAttribute::StorageType ipsdk::imaproc::classif::KernelKMeansImgLvl1::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::KernelKMeansImgLvl1::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

preProcess()

ipsdk::core::ExecResult ipsdk::imaproc::classif::KernelKMeansImgLvl1::preProcess ( )

protected

method called before processing

Returns

execution result

Member Data Documentation

_accuracyThreshold

ipReal32 ipsdk::imaproc::classif::KernelKMeansImgLvl1::_accuracyThreshold

protected

used accuracy threshold used for linear dependency analysis while processing radial basis kernels

---

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/KernelKMeansImg/KernelKMeansImgLvl1.h