This class stores construction parameters for a VocabularyStructure. More...

Public Member Functions
	Parameters ()=default
	Default constructor. More...

	Parameters (const unsigned int maximalNumberClustersPerLevel, const unsigned int maximalDescriptorsPerLeaf, const unsigned int maximalLevels=(unsigned int)(-1), const InitializationStrategy initializationStrategy=IS_LARGEST_DISTANCE)
	Creates a new parameters object. More...

bool	isValid () const
	Returns whether this object holds valid parameters. More...

Data Fields
unsigned int	maximalNumberClustersPerLevel_ = 10u
	The maximal number of clusters each tree level can have with range [2, infinity). More...

unsigned int	maximalDescriptorsPerLeaf_ = 40u
	The maximal number of descriptors each leaf can have, with range [1, infinity). More...

unsigned int	maximalLevels_ = (unsigned int)(-1)
	The maximal number of tree levels, at tree will never have more level regardless what has been specified in 'maximalNumberClustersPerLevel_' or 'maximalDescriptorsPerLeaf_'. More...

InitializationStrategy	initializationStrategy_ = IS_LARGEST_DISTANCE
	The initialization strategy for initial clusters. More...

Detailed Description

This class stores construction parameters for a VocabularyStructure.

Constructor & Destructor Documentation

◆ Parameters() [1/2]

Ocean::Tracking::VocabularyStructure::Parameters::Parameters ( )

default

Default constructor.

◆ Parameters() [2/2]

Ocean::Tracking::VocabularyStructure::Parameters::Parameters	(	const unsigned int	maximalNumberClustersPerLevel,
		const unsigned int	maximalDescriptorsPerLeaf,
		const unsigned int	maximalLevels = `(unsigned int)(-1)`,
		const InitializationStrategy	initializationStrategy = `IS_LARGEST_DISTANCE`
	)

inline

Creates a new parameters object.

Parameters

maximalNumberClustersPerLevel	The maximal number of clusters each tree level can have with range [2, infinity)
maximalDescriptorsPerLeaf	The maximal number of descriptors each leaf can have, with range [1, infinity)
maximalLevels	The maximal number of tree levels, at tree will never have more level regardless what has been specified in 'maximalNumberClustersPerLevel' or 'maximalDescriptorsPerLeaf'
initializationStrategy	The initialization strategy for initial clusters

Member Function Documentation

◆ isValid()

bool Ocean::Tracking::VocabularyStructure::Parameters::isValid ( ) const

inline

Returns whether this object holds valid parameters.

Returns: True, if so

Field Documentation

◆ initializationStrategy_

InitializationStrategy Ocean::Tracking::VocabularyStructure::Parameters::initializationStrategy_ = IS_LARGEST_DISTANCE

The initialization strategy for initial clusters.

◆ maximalDescriptorsPerLeaf_

unsigned int Ocean::Tracking::VocabularyStructure::Parameters::maximalDescriptorsPerLeaf_ = 40u

The maximal number of descriptors each leaf can have, with range [1, infinity).

◆ maximalLevels_

unsigned int Ocean::Tracking::VocabularyStructure::Parameters::maximalLevels_ = (unsigned int)(-1)

The maximal number of tree levels, at tree will never have more level regardless what has been specified in 'maximalNumberClustersPerLevel_' or 'maximalDescriptorsPerLeaf_'.

◆ maximalNumberClustersPerLevel_

unsigned int Ocean::Tracking::VocabularyStructure::Parameters::maximalNumberClustersPerLevel_ = 10u

The maximal number of clusters each tree level can have with range [2, infinity).

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

VocabularyTree.h

Public Member Functions

Data Fields