Classify Method of the Model Object

Classify method of the Model object in the ABBYY FineReader Engine API — uses the model to classify a given ClassificationObject and returns category-label / probability pairs.

Uses the model to classify a given classification object. As the result of this method call, you will receive a collection of pairs “category label — probability,” and will then be able to select the most likely category for the document or page from which the classification object was created.

In Linux and Windows : Model training and classification will be performed in sequential mode, regardless of the IMultiProcessingParams::MultiProcessingMode value.

Syntax

C++

HRESULT Classify(
  IClassificationObject*   Object,
  IClassificationResults** Result
);

C#

IClassificationResults Classify( IClassificationObject Document );

Visual Basic .NET

Function Classify(Document As IClassificationObject) As IClassificationResults

Parameters

Object

[in] A ClassificationObject which needs to be classified. Note that if the classification object was created from a document or page which had not been previously recognized, you will not be able to classify it with the help of a classifier which uses the text features. You can check that the object’s SuitableClassifiers property contains the classifier specified in IModel::ClassifierType.

Result

[out, retval] A pointer to the IClassificationResults* pointer variable that receives the interface pointer of the output ClassificationResults object. The classification results are sorted by probability in descending order. May be null if the classifier could not assign the classification object to any of the categories.

Return values

This method has no specific return values. It returns the standard return values of ABBYY FineReader Engine functions.

See also

Model