Cvb::Polimago Namespace Reference

Namespace for the Polimago package. More...

Namespaces
namespace	Testing
	Namespace for the Polimago package testing functionality.
namespace	Training
	Namespace for the Polimago package training functionality.

Classes
class	ClassificationPredictor
	Predictor to classify patterns with. More...
class	ClassificationPredictorFactory
	Predictor factory for classification predictor. More...
class	ClassificationResult
	Polimago classification result container. More...
class	ClassificationTestResult
	Classification test result object. More...
class	ConfusionMatrix
	Representation of a confusion matrix. More...
class	HoldoutTestResultFactory
	Factory object for holdout tests. More...
class	PolimagoFactoryCreatedObject
	Base class for Polimago objects created by one of the factory classes. More...
class	PredictionResult
	The information contained in each cell of the confusion matrix. More...
class	PredictorBase
	Base class for Polimago predictors. More...
class	PredictorBaseEx
	Base class for Polimago predictors. More...
class	PredictorFactoryBase
	Base class for classifier factory classes. More...
class	PredictorFactoryBaseEx
	Base class for classifier factory classes. More...
class	RegressionPredictor
	Polimago Regression predictor. More...
class	RegressionPredictorFactory
	Factory class for regression predictors. More...
class	RegressionTestResult
	Regression test result object. More...
class	SampleTestResultFactory
	Factory object for running a sample test in which all the elements of a training database are classified with a given classifier. More...
class	SearchPredictor
	Predictor that may be used for searching objects. More...
class	SearchPredictorFactory
	Factory class for the generation of search predictors. More...
class	SearchResult
	Search results as provided by a Search Classifier. More...
class	TestResultBase
	Base class for all Polimago Test Results. More...
class	TestResultFactory
	Base class for test factory classes. More...

Typedefs
using	ClassificationPredictorPtr = std::shared_ptr<ClassificationPredictor>
	Convenience shared pointer for ClassificationPredictor.
using	PolimagoFactoryCreatedObjectPtr = std::shared_ptr<PolimagoFactoryCreatedObject>
	Convenience shared pointer for PolimagoFactoryCreatedObject.
using	PredictorBasePtr = std::shared_ptr<PredictorBase>
	Convenience shared pointer for PredictorBase.
using	PredictorBaseExPtr = std::shared_ptr<PredictorBaseEx>
	Convenience shared pointer for PredictorBaseEx.
using	RegressionPredictorPtr = std::shared_ptr<RegressionPredictor>
	Convenience shared pointer for RegressionPredictor.
using	SearchPredictorPtr = std::shared_ptr<SearchPredictor>
	Convenience shared pointer for SearchPredictor.
using	ClassificationPredictorFactoryPtr
	Convenience shared pointer for ClassificationPredictorFactory.
using	ClassificationTestResultPtr
	Convenience shared pointer for ClassificationTestResult.
using	HoldoutTestResultFactoryPtr
	Convenience shared pointer for HoldoutTestResultFactory.
using	PredictorFactoryBaseExPtr
	Convenience shared pointer for PredictorFactoryBaseEx.
using	PredictorFactoryBasePtr
	Convenience shared pointer for PredictorFactoryBase.
using	RegressionPredictorFactoryPtr
	Convenience shared pointer for RegressionPredictorFactory.
using	RegressionTestResultPtr
	Convenience shared pointer for RegressionTestResult.
using	SampleTestResultFactoryPtr
	Convenience shared pointer for SampleTestResultFactory.
using	SearchPredictorFactoryPtr
	Convenience shared pointer for SearchPredictorFactory.
using	TestResultBasePtr
	Convenience shared pointer for TestResultBase.
using	TestResultFactoryPtr
	Convenience shared pointer for TestResultFactory.

Enumerations
enum class	ClassificationType { None , OneVersusAll , OneVersusOne }
	Determine the classification type to be carried out. More...
enum class	InterpolationType { None , Linear }
	Interpolation to be used when extracting image data for classifier generation. More...
enum class	InvarianceType { None = 0 , Translation = CExports::TI_Translations , RotationScaleTranslation = CExports::TI_RotScaleTrans , AffineGroup = CExports::TI_AffineGroup }
	Invariance types that can be defined for training. More...

Functions
int	GetGranularity (const String &preproCode)
	The function returns the granularity associated with a preprocessing code.
bool	operator== (const SearchResult &lhs, const SearchResult &rhs) noexcept
	Comparison operator for SearchResult objects.
bool	operator!= (const SearchResult &lhs, const SearchResult &rhs) noexcept
	Comparison operator for SearchResult objects.

Detailed Description

Namespace for the Polimago package.

Online Manual

Common Vision Blox-Tool Polimago

Example

QmlCookieClassification

For further information regarding Qt/QML, see Image Display in C++ Using Qt/QML

Remarks

CMake users: Link to imported target CVB::CvbPolimago

Enumeration Type Documentation

ClassificationType

enum class ClassificationType

strong

Determine the classification type to be carried out.

Enumerator
None	The enum element indicating undefined state.
OneVersusAll	Quick classification, that tests versus all classes simultaneously (but potentially at the cost of result quality, especially if many classes are involved).
OneVersusOne	Thorough classification, that tests all possible pairs of classes (which yields potentially better results if many classes are involved but takes significantly longer than the OneVersusAll approach).

InterpolationType

enum class InterpolationType

strong

Interpolation to be used when extracting image data for classifier generation.

Enumerator
None	Image data is (if necessary) extracted without interpolation.
Linear	Image data is (if necessary) extracted with linear interpolation.

InvarianceType

enum class InvarianceType

strong

Invariance types that can be defined for training.

Enumerator
None	No invariance (not valid for training!).
Translation	Translation.
RotationScaleTranslation	Rotation + Scale + Translation.
AffineGroup	Affine group (i.e. 2x2 matrix plus translation).

Function Documentation

GetGranularity()

int GetGranularity ( const String & preproCode )

inline

The function returns the granularity associated with a preprocessing code.

Parameters

[in]

preproCode

Preprocessing code to determine the granularity for.

Returns

Granularity value for the preprocessing code.

Exceptions

Any	exception derived from std::exception including CvbException.

operator!=()

bool operator!= ( const SearchResult & lhs, const SearchResult & rhs )

inlinenoexcept

Comparison operator for SearchResult objects.

Parameters

[in]	lhs	Left hand side operand.
[in]	rhs	Right hand side operand.

Returns

True if lhs == rhs, false otherwise.

Exceptions

Does	not throw any exception.

operator==()

bool operator== ( const SearchResult & lhs, const SearchResult & rhs )

inlinenoexcept

Comparison operator for SearchResult objects.

Parameters

[in]	lhs	Left hand side operand.
[in]	rhs	Right hand side operand.

Returns

True if lhs != rhs, false otherwise.

Exceptions

Does	not throw any exception.