PredictorFactoryBaseEx Class Reference

Base class for classifier factory classes. More...

#include <cvb/polimago/predictor_factory_base.hpp>

Inherits PredictorFactoryBase.

Inherited by ClassificationPredictorFactory, and RegressionPredictorFactory.

Public Member Functions
InterpolationType	Interpolation () const noexcept
	Gets the interpolation setting to be used for generating this object.
void	SetInterpolation (InterpolationType interpolation) noexcept
	Sets the interpolation setting to be used for generating this object. Using interpolation will generate less artifacts, but requires more processor time.
int	FeatureResolution () const noexcept
	Gets the feature resolution (determines the size of the classification retina).
void	SetFeatureResolution (int featureResolution)
	Sets the feature resolution (determines the size of the classification retina).
Public Member Functions inherited from PredictorFactoryBase
double	Lambda () const noexcept
	Gets the regularization value to be used for generating the object.
void	SetLambda (double lambda)
	Sets the regularization value to be used for generating the object. Possible values range from 0 to 10, good starting values for experiments are usually around 0.01.
String	Preprocessing () const
	Get preprocessing code with which the object is to be generated.
void	SetPreprocessing (const String &code)
	Set preprocessing code with which the object is to be generated.

Static Public Attributes
static constexpr InterpolationType	InterpolationDefault = InterpolationType::Linear
	Default value for interpolation.
Static Public Attributes inherited from PredictorFactoryBase
static constexpr double	LambdaDefault = 0.1
	Default value for lambda.
static constexpr int	FeatureResolutionDefault = 1
	Default value for feature resolution.
static constexpr int	PreprocessingMaxLength = 15
	Maximum length of a preprocessing code (excluding the terminating zero).

Additional Inherited Members
Static Public Member Functions inherited from PredictorFactoryBase
static ValueRange< double >	LambdaRange ()
	Acceptable scale factor range for search classifier training.
static ValueRange< int >	FeatureResolutionRange ()
	Valid range of feature resolution value.
static constexpr std::array< char, 4 >	PreprocessingValidCharacters ()
	Characters that a preprocessing string may contain.
static String	FormatPreprocessingCode (const String &input)
	Correct a preprocessing code to make sure that no invalid characters are in the code and the code does not exceed the maximum length.

Detailed Description

Base class for classifier factory classes.

Member Function Documentation

FeatureResolution()

int FeatureResolution ( ) const

inlinenoexcept

Gets the feature resolution (determines the size of the classification retina).

Returns

The feature resolution value.

Exceptions

Does	not throw any exception.

Interpolation()

InterpolationType Interpolation ( ) const

inlinenoexcept

Gets the interpolation setting to be used for generating this object.

Returns

The interpolation value.

Exceptions

Does	not throw any exception.

SetFeatureResolution()

void SetFeatureResolution ( int featureResolution )

inline

Sets the feature resolution (determines the size of the classification retina).

Parameters

[in]

featureResolution

The feature resolution value.

Exceptions

Any	exception derived from std::exception including CvbException.

SetInterpolation()

void SetInterpolation ( InterpolationType interpolation )

inlinenoexcept

Sets the interpolation setting to be used for generating this object. Using interpolation will generate less artifacts, but requires more processor time.

Parameters

[in]

interpolation

The interpolation value.

Exceptions

Does	not throw any exception.