CVBpy 15.0
PredictorBase Class Reference

Base class for Polimago predictors. More...

Inherits PolimagoFactoryCreatedObject.

Inherited by PredictorBaseEx, and SearchPredictor.

Public Member Functions

bool is_compatible (self, cvb.Image img, cvb.Point2D pos)
 Verify the compatibility of a CVB image with this classifier. More...
 
- Public Member Functions inherited from PolimagoFactoryCreatedObject
None save (self, str file_name)
 Save this object into a file. More...
 

Additional Inherited Members

- Properties inherited from PolimagoFactoryCreatedObject
 correction = property
 cvb.Point2D: Correction factors in X and Y direction required to rescale the input images for projection onto the retina.
 
 feature_window_extent = property
 cvb.Rect: The feature window extent that has been used during classifier training.
 
 file_name = property
 str: Name of the file the object has been loaded from (or empty string if the object was not loaded).
 
 image_planes = property
 int: Intercept weight that has been used for generating this object.
 
 interpolation = property
 int: Interpolation setting used for generating this object (see cvb.polimago.InterpolationType).
 
 lambda_ = property
 float: Regularization value that has been used for generating this object.
 
 offset = property
 float: Intercept weight that has been used for generating this object.
 
 preprocessing = property
 str: Preprocessing code with which this object was generated.
 
 retina_size = property
 cvb.Size2D: Size of the 'Retina' in pixels. More...
 

Detailed Description

Base class for Polimago predictors.

Member Function Documentation

◆ is_compatible()

bool is_compatible (   self,
cvb.Image  img,
cvb.Point2D  pos 
)

Verify the compatibility of a CVB image with this classifier.

Note that even if the classifier is basically compatible with the image, not all positions in the image are usable for classification.

Parameters

img : cvb.Image Image to be verified.

pos : cvb.Point2D Position in the image to be processed (if the parameter is provided).

Returns

bool True if the image is compatible with this classifier and the position indicated by the pos parameter can be used for evaluation.