structure allowing to encapsulate parameters for kernel kmeans clustering algorithm More...

#include <KernelKMeansParams.h>

Inheritance diagram for ipsdk::imaproc::attr::KernelKMeansParams:

Public Member Functions
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 data item node

const std::string	getLibraryName () const
	retrieve library name associated data item node

const ipsdk::ItemNames &	getItemIds () const
	retrieve item associated to a given id More...

	~KernelKMeansParams ()
	public destructor

Methods associated to sub node RBKParamsPolicy
template<>
const ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eRadialBasisKernelParamsPolicy > &	getNode () const
	access to sub node RBKParamsPolicy

template<>
ipsdk::DataItemLeaf< ipsdk::imaproc::attr::eRadialBasisKernelParamsPolicy > &	get ()
	access to sub node RBKParamsPolicy

template<>
const ipsdk::imaproc::attr::eRadialBasisKernelParamsPolicy &	getValue () const
	access to value for sub node RBKParamsPolicy

template<>
void	setValue (const ipsdk::imaproc::attr::eRadialBasisKernelParamsPolicy &value)
	access to value for sub node RBKParamsPolicy

Methods associated to sub node RBKSigmaParam
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	getNode () const
	access to sub node RBKSigmaParam

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	get ()
	access to sub node RBKSigmaParam

template<>
const ipsdk::ipReal32 &	getValue () const
	access to value for sub node RBKSigmaParam

template<>
void	setValue (const ipsdk::ipReal32 &value)
	access to value for sub node RBKSigmaParam

Methods associated to sub node RBKAccuracyThresholdParam
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	getNode () const
	access to sub node RBKAccuracyThresholdParam

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	get ()
	access to sub node RBKAccuracyThresholdParam

template<>
const ipsdk::ipReal32 &	getValue () const
	access to value for sub node RBKAccuracyThresholdParam

template<>
void	setValue (const ipsdk::ipReal32 &value)
	access to value for sub node RBKAccuracyThresholdParam

Methods associated to sub node NbAttempts
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node NbAttempts

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node NbAttempts

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node NbAttempts

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node NbAttempts

Methods associated to sub node NbMaxIteration
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node NbMaxIteration

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node NbMaxIteration

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node NbMaxIteration

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node NbMaxIteration

Methods associated to sub node MinChangeRatio
template<>
const ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	getNode () const
	access to sub node MinChangeRatio

template<>
ipsdk::DataItemLeaf< ipsdk::ipReal32 > &	get ()
	access to sub node MinChangeRatio

template<>
const ipsdk::ipReal32 &	getValue () const
	access to value for sub node MinChangeRatio

template<>
void	setValue (const ipsdk::ipReal32 &value)
	access to value for sub node MinChangeRatio

Methods associated to sub node MaxDictionarySize
template<>
const ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	getNode () const
	access to sub node MaxDictionarySize

template<>
ipsdk::DataItemLeaf< ipsdk::ipUInt32 > &	get ()
	access to sub node MaxDictionarySize

template<>
const ipsdk::ipUInt32 &	getValue () const
	access to value for sub node MaxDictionarySize

template<>
void	setValue (const ipsdk::ipUInt32 &value)
	access to value for sub node MaxDictionarySize

Public Member Functions inherited from ipsdk::BaseDataItemNode
eDataItemType	getDataItemType () const

bool	existsItem (const std::string &itemId) const

const BaseDataItem &	getItem (const std::string &itemId) const

const std::string &	getItemName (const std::string &itemId) const

const std::string &	getItemToolTip (const std::string &itemId) const

Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string &	getClassName () const

virtual BaseDynamicObject *	createNew () const=0

virtual DynamicObjectPtr	createShared () const=0

virtual bool	hasCopySupport () const=0

virtual BaseDynamicObject *	duplicate () const=0

virtual DynamicObjectPtr	duplicateShared () const=0

Static Public Member Functions
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 data item node

static const std::string	getLibraryNameStr ()
	retrieve library name associated data item node

static boost::shared_ptr< KernelKMeansParams >	createNode ()
	node creation function

Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32	getVersion ()

Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string &	getTypeName ()

Static Public Attributes
static const ipsdk::ipUInt32	g_nbChildNodes
	number of child nodes associated to object

Static Public Attributes inherited from ipsdk::BaseDataItemNode
static const bool	g_bIsColl

static const bool	g_bNode

static const bool	g_bLeaf

static const eDataItemType::domain	g_itemType

Protected Member Functions
	KernelKMeansParams ()
	protected constructor

Protected Member Functions inherited from ipsdk::BaseDataItemNode
virtual ItemInfoPtr	getItemInfo (const std::string &itemId) const=0

Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult	write (BaseOArchive &ar) const

virtual BoolResult	read (BaseIArchive &ar)

Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void	initCtorCopy (const BaseDynamicObject &object)

virtual void	copy (const BaseDynamicObject &object)

Additional Inherited Members
Protected Types inherited from ipsdk::BaseDataItemNode
typedef boost::shared_ptr< ItemInfo >	ItemInfoPtr

Detailed Description

structure allowing to encapsulate parameters for kernel kmeans clustering algorithm

Author: E.Noirfalise

Date: 2018/08/20

Copyright: 2018 Reactiv'IP, all right reserved.

Node associated library :

IPSDKIPLAttributes

SubNodes description

Name	ToolTip	Associated Class	Default Value
RBKParamsPolicy	used policy for radial basis kernel parameters computation	ipsdk::DataItemEnumLeaf<ipsdk::imaproc::attr::eRadialBasisKernelParamsPolicy>	ipsdk::imaproc::attr::eRadialBasisKernelParamsPolicy::eRBKPP_FromDataDynamic
RBKSigmaParam	Parameter used to compute radial basis kernel sigma value.	ipsdk::DataItemLeaf<ipsdk::ipReal32>
RBKAccuracyThresholdParam	Parameter used to compute accuracy threshold for approximate linear dependence condition.	ipsdk::DataItemLeaf<ipsdk::ipReal32>
NbAttempts	number of attempts for KMeans algorithm	ipsdk::DataItemLeaf<ipsdk::ipUInt32>
NbMaxIteration	maximum number of K-Means algorithm iterations for an attempt	ipsdk::DataItemLeaf<ipsdk::ipUInt32>
MinChangeRatio	minimum ratio for sample assignment change (versus full number of samples) to consider that an iteration has converged	ipsdk::DataItemLeaf<ipsdk::ipReal32>
MaxDictionarySize	maximum dictionary size by cluster	ipsdk::DataItemLeaf<ipsdk::ipUInt32>

Member Function Documentation

◆ getItemIds()

const ipsdk::ItemNames& ipsdk::imaproc::attr::KernelKMeansParams::getItemIds ( ) const

virtual

retrieve item associated to a given id

Exceptions

ipsdk::IPSDKBaseDataException if existsItem(itemName) == false

Implements ipsdk::BaseDataItemNode.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKIPL/IPSDKIPLAttributes/DataItem/KernelKMeansParams.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Node associated library :

SubNodes description

Member Function Documentation

◆ getItemIds()