Atalasoft MobileImage API Reference
Public Member Functions | List of all members
com.kofax.kmc.ken.engines.ImageClassificationResult Class Reference

Results from classifying an image. This object is serializable. More...

Inheritance diagram for com.kofax.kmc.ken.engines.ImageClassificationResult:

Public Member Functions

 ImageClassificationResult ()
 
 ImageClassificationResult (String classId, float confidence, int orientation)
 
float getConfidence ()
 
int getOrientation ()
 
String getClassId ()
 

Detailed Description

Results from classifying an image. This object is serializable.

The ImageClassificationResult object contains the results from classifying an image using the ImageClassifier Object. The results will be attached to the Image that was used for the image classification process.

ImageClassificationResult objects support serialization in a similar way to Image objects. The Image object documentation provides code examples for serialization and deserialization.

Constructor & Destructor Documentation

com.kofax.kmc.ken.engines.ImageClassificationResult.ImageClassificationResult ( )
inline
com.kofax.kmc.ken.engines.ImageClassificationResult.ImageClassificationResult ( String  classId,
float  confidence,
int  orientation 
)
inline

The results returned from an image classification.

Parameters
classId
confidence
orientation

Member Function Documentation

String com.kofax.kmc.ken.engines.ImageClassificationResult.getClassId ( )
inline

ID that identifies the classification of the image. Such as "CA2" for California Drivers license, Type 2.

Returns
the class ID
float com.kofax.kmc.ken.engines.ImageClassificationResult.getConfidence ( )
inline

Value that indicates confidence of Classification operation on an image. Higher numbers > 0 indicate higher confidence. Numbers < 0 indicate lower confidence.

Returns
the classification confidence
int com.kofax.kmc.ken.engines.ImageClassificationResult.getOrientation ( )
inline

Orientation of the image detected by the ImageClassifier Object.

Returns
the detected image orientation

The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.