ClassificationPredictor Class Reference

Predictor to classify patterns with. More...

Inherits PredictorBaseEx.

Public Member Functions
	ClassificationPredictor (string fileName)
	Load a saved Polimago classification classifier from a file. More...
ClassificationResult	Classify (Image img, Point2D pos)
	Classify a location inside an image. More...
unsafe ClassificationResult	Classify (Image img, Point2D pos, out double[] confidences)
	Classify a location inside an image. More...
Public Member Functions inherited from PredictorBase
bool	IsCompatible (Image img, Point2D pos)
	Verify the compatibility of a CVB image with this classifier. More...
bool	IsCompatible (Image img)
	Verify the compatibility of a CVB image with this classifier. More...
Public Member Functions inherited from PolimagoFactoryCreatedObject
void	Save (string fileName)
	Save this object into a file. More...
Public Member Functions inherited from PolimagoRefCountedObject
virtual void	Dispose ()
	IDisposable implementation. More...

Properties
ReadOnlyCollection< string >	Classes [get]
	Class labels available in this predictor.
ClassificationType	Classification [get]
	Retrieve the classification type for which this classifier has been generated.
int	OutputDimension [get]
	Dimension of results generated by this predictor.
int	NumClasses [get]
	Number of classes a classification predictor has been trained for.
Properties inherited from PredictorBaseEx
int	FeatureResolution [get]
	Feature resolution value with which the classifier was trained.
Properties inherited from PolimagoFactoryCreatedObject
string	FileName [get, protected set]
	Name of the file the object has been loaded from (or More...
double	Lambda [get]
	Regularization value that has been used for generating this object.
double	Offset [get]
	Intercept weight that has been used for generating this object.
InterpolationType	Interpolation [get]
	Interpolation setting used for generating this object.
int	ImagePlanes [get]
	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.
Rect	FeatureWindowExtent [get]
	The feature window extent that has been used during classifier training.
Size2D	RetinaSize [get]
	Size of the "Retina" in paxels. 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.
Point2Dd	Correction [get]
	Correction factors in X and Y direction required to rescale the input images for projection onto the retina.
string	Preprocessing [get]
	Preprocessing code with which this object was generated.
Properties inherited from PolimagoRefCountedObject
IntPtr	Handle [get]
	Native Manto classifier handle. More...
bool	IsDisposed [get]
	Tests if the native handle has already been disposed.
Properties inherited from INativeHandle
IntPtr	Handle [get]
	The native handle of the object.
bool	IsDisposed [get]
	Possibility to check whether the object has already been disposed of.

Additional Inherited Members
Static Public Member Functions inherited from PredictorBase
static int	GetGranularity (string preproCode)
	The function returns the granularity (see tutorial) associated with a preprocessing code. More...
Protected Member Functions inherited from PredictorBase
void	VerifyCompatibility (Image img)
	Verify the compatibility of a CVB image with this classifier. More...
void	VerifyCompatibility (Image img, Point2D pos)
	Verify the compatibility of a CVB image with this classifier. More...
Protected Member Functions inherited from PolimagoRefCountedObject
virtual void	Dispose (bool disposing)
	IDispose helper function. More...
Events inherited from PolimagoRefCountedObject
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method. More...
Events inherited from INativeHandle
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method. More...

Detailed Description

Predictor to classify patterns with.

Constructor & Destructor Documentation

ClassificationPredictor()

ClassificationPredictor

(

string

fileName

)

Load a saved Polimago classification classifier from a file.

Parameters

fileName

name of the file to be loaded

Exceptions

FileNotFoundException	If the classifier file does not exist
FileLoadException	If loading an existing classifier file failed
ArgumentNullException	If fileName is null

Member Function Documentation

Classify() [1/2]

ClassificationResult Classify	(	Image	img,
		Point2D	pos
	)

Classify a location inside an image.

Parameters

img	Image to classify in.
pos	Position to classify.

Returns

Classification result.

Classify() [2/2]

unsafe ClassificationResult Classify	(	Image	img,
		Point2D	pos,
		out double[]	confidences
	)

Classify a location inside an image.

Parameters

confidences	Confidence distribution.
img	Image to classify in.
pos	Position to classify.

Returns

Classification result.