PolimagoFactoryCreatedObject Class Reference

Base class for Polimago objects created by one of the factory classes. More...

#include <cvb/polimago/predictor_base.hpp>

Inherited by PredictorBase, and TestResultBase.

Public Member Functions
void *	Handle () const noexcept
	Classic API Polimago handle. More...
String	FileName () const
	Name of the file the object has been loaded from (or empty string if the object was not loaded). More...
void	Save (const String &fileName) const
	Save this object into a file. More...
double	Lambda () const noexcept
	Regularization value that has been used for generating this object. More...
double	Offset () const noexcept
	Intercept weight that has been used for generating this object. More...
InterpolationType	Interpolation () const noexcept
	Interpolation setting used for generating this object. More...
int	ImagePlanes () const noexcept
	The plane count of the images that have been used for generating this classifier. Image on which this classifier is to be used will need to have the same plane count. More...
Rect< int >	FeatureWindowExtent () const noexcept
	The feature window extent that has been used during classifier training. More...
Size2D< int >	RetinaSize () const noexcept
	Size of the 'Retina' in pixels. The retina is the set of paxels onto which the input image is projected using the preprocessing code prior to application/training of the classifier. More...
Point2D< double >	Correction () const noexcept
	Correction factors in X and Y direction required to rescale the input images for projection onto the retina. More...
String	Preprocessing () const
	Preprocessing code with which this object was generated. More...

Detailed Description

Base class for Polimago objects created by one of the factory classes.

Member Function Documentation

Correction()

Point2D< double > Correction ( ) const

inlinenoexcept

Correction factors in X and Y direction required to rescale the input images for projection onto the retina.

Returns

The correction value.

Exceptions

Does	not throw any exception.

FeatureWindowExtent()

Rect< int > FeatureWindowExtent ( ) const

inlinenoexcept

The feature window extent that has been used during classifier training.

Returns

The feature window extent.

Exceptions

Does	not throw any exception.

FileName()

String FileName ( ) const

inline

Name of the file the object has been loaded from (or empty string if the object was not loaded).

Returns

The file name.

Exceptions

Any	exception derived from std::exception including CvbException.

Handle()

void * Handle ( ) const

inlinenoexcept

Classic API Polimago handle.

Returns

Classic API handle.

Exceptions

Does	not throw any exception.

It is normally not necessary to work with this handle.

ImagePlanes()

int ImagePlanes ( ) const

inlinenoexcept

The plane count of the images that have been used for generating this classifier. Image on which this classifier is to be used will need to have the same plane count.

Returns

The plane count.

Exceptions

Does	not throw any exception.

Interpolation()

InterpolationType Interpolation ( ) const

inlinenoexcept

Interpolation setting used for generating this object.

Returns

The interpolation type.

Exceptions

Does	not throw any exception.

Lambda()

double Lambda ( ) const

inlinenoexcept

Regularization value that has been used for generating this object.

Returns

The lambda value.

Exceptions

Does	not throw any exception.

Offset()

double Offset ( ) const

inlinenoexcept

Intercept weight that has been used for generating this object.

Returns

The offset value.

Exceptions

Does	not throw any exception.

Preprocessing()

String Preprocessing ( ) const

inline

Preprocessing code with which this object was generated.

Returns

The preprocessing code.

Exceptions

Any	exception derived from std::exception including CvbException.

RetinaSize()

Size2D< int > RetinaSize ( ) const

inlinenoexcept

Size of the 'Retina' in pixels. The retina is the set of paxels onto which the input image is projected using the preprocessing code prior to application/training of the classifier.

Returns

The retina size.

Exceptions

Does	not throw any exception.

Save()

void Save ( const String &  fileName ) const

inline

Save this object into a file.

Parameters

[in]

fileName

Name of the file to save to.

Exceptions

Any	exception derived from std::exception including CvbException.