Atalasoft MobileImage API Reference
Properties | List of all members
KFXIDExtractionResult Class Reference

ID Extraction Result. More...

#import <kfxKOEIDExtractor.h>

Inheritance diagram for KFXIDExtractionResult:

Properties

BOOL isBarcodeRead
 Barcode read success indicator. More...
 
BOOL isOcrRead
 OCR success indicator. More...
 
float documentVerificationConfidenceRating
 ID verification confidence rating. More...
 
NSArray * fields
 An array of extracted fields. More...
 
kfxKEDClassificationResultfrontClassification
 Front side classification result. More...
 
kfxKEDClassificationResultbackClassification
 Back side classification result. More...
 

Detailed Description

ID Extraction Result.

Represents the result of ID extraction.

See also
kfxKOEIDExtractor

Property Documentation

- (kfxKEDClassificationResult*) backClassification
readwritenonatomicstrong

Back side classification result.

Contains back side image classification result. Nil if back image was not provided for extraction or if back image classification failed.

Classification is considered as failed if classification confidence value returned by classifier is negative. Any non-negative confidence is considered as a successful classification. There is no determined range confidence value can take; higher values mean higher credibility.

Default value is nil.

See also
kfxKEDClassificationResult
- (float) documentVerificationConfidenceRating
readwritenonatomicassign

ID verification confidence rating.

Provides the confidence rating that specified ID was verified. Can take the following values:

  • 0 if front side was not provided or failed to be extracted.
  • 50 if front data was extracted successfully and back side wasn't (or wasn't provided).
  • from 50 to 100 if both sides were extracted successfully. Actual value will depend on difference between front and back values. Higher value means a better match.

Default value is 0.0.

- (NSArray*) fields
readwritenonatomicstrong

An array of extracted fields.

Array of kfxKOEDataField objects.

Default value is nil.

See also
kfxKOEDataField
- (kfxKEDClassificationResult*) frontClassification
readwritenonatomicstrong

Front side classification result.

Contains front side image classification result. Nil if front image was not provided for extraction or if front image classification failed.

Classification is considered as failed if classification confidence value returned by classifier is negative. Any non-negative confidence is considered as a successful classification. There is no determined range confidence value can take; higher values mean higher credibility.

Default value is nil.

See also
kfxKEDClassificationResult
- (BOOL) isBarcodeRead
readwritenonatomicassign

Barcode read success indicator.

YES if barcode data was provided and extracted successfully (either from back image or barcode string), NO otherwise.

Default value is NO.

- (BOOL) isOcrRead
readwritenonatomicassign

OCR success indicator.

YES if front side data was provided and extracted successfully, NO otherwise.

Default value is NO.


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