RegressionPredictor Class Reference

Polimago Regression predictor. More...

#include <cvb/polimago/regression_predictor.hpp>

Inherits PredictorBaseEx.

Public Member Functions
	RegressionPredictor (const String &fileName)
	Load a saved Polimago regression predictor from a file. More...
	RegressionPredictor (RegressionPredictor &&) noexcept=default
	Move constructor.
RegressionPredictor &	operator= (RegressionPredictor &&) noexcept=default
	Move assignment operator.
int	RegressionDimension () const
	Regression result dimension. More...
std::vector< double >	PredictVector (const Image &img, Point2D< int > pos) const
	Calculate a regression result on a given location. More...
Public Member Functions inherited from PredictorBaseEx
int	FeatureResolution () const noexcept
	Feature resolution value with which the classifier was trained. More...
Public Member Functions inherited from PredictorBase
bool	IsCompatible (const Image &img, Point2D< int > pos) const
	Verify the compatibility of a CVB image with this classifier. More...
bool	IsCompatible (const Image &img) const
	Verify the compatibility of a CVB image with this classifier. More...
Public Member Functions inherited from PolimagoFactoryCreatedObject
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...

Static Public Member Functions
static std::unique_ptr< RegressionPredictor >	FromHandle (ReleaseObjectGuard &&guard)
	Creates predictor from a classic API handle. More...
static std::unique_ptr< RegressionPredictor >	Load (const String &fileName)
	Load a saved predictor from a file. More...

Detailed Description

Polimago Regression predictor.

Constructor & Destructor Documentation

RegressionPredictor()

RegressionPredictor ( const String &  fileName )

inline

Load a saved Polimago regression predictor from a file.

Parameters

[in]

fileName

Name of the file to be loaded.

Returns

Loaded predictor.

Exceptions

Any	exception derived from std::exception including CvbException.

Member Function Documentation

FromHandle()

static std::unique_ptr< RegressionPredictor > FromHandle ( ReleaseObjectGuard &&  guard )

inlinestatic

Creates predictor from a classic API handle.

Parameters

[in]

guard

Life time guard for C-API handle.

Returns

The predictor created from the classic API handle.

Exceptions

Any	exception derived from std::exception including CvbException.

The predictor takes ownership of the handle, so you must share it before using this function.

Load()

static std::unique_ptr< RegressionPredictor > Load ( const String &  fileName )

inlinestatic

Load a saved predictor from a file.

Parameters

[in]

fileName

Name of the file to be loaded.

Returns

Pointer to the loaded predictor.

Exceptions

Any	exception derived from std::exception including CvbException.

PredictVector()

std::vector< double > PredictVector ( const Image &  img, Point2D< int >  pos  ) const

inline

Calculate a regression result on a given location.

Parameters

[in]	img	Image to calculate the result in.
[in]	pos	Position in the image referred to by img to be investigated.

Returns

Array that represents the prediction results. The length of that (always 1-dimensional) array depends on the RegressionDimension.

Exceptions

Any	exception derived from std::exception including CvbException.

RegressionDimension()

int RegressionDimension ( ) const

inline

Regression result dimension.

Returns

Regression dimension.

Exceptions

Any	exception derived from std::exception including CvbException.