Atalasoft MobileImage API Reference
kfxKOEIDExtractor.h
Go to the documentation of this file.
1 //
2 // kfxKOEIDExtractor.h
3 // kfxLibEngines
4 //
5 // Copyright (c) 2014-2017 Kofax. All rights reserved. Kofax Confidential.
6 // Unauthorized use, duplication, or distribution, or disclosure is strictly prohibited.
7 //
8 
9 #import <Foundation/Foundation.h>
10 
14 
15 extern NSString* const KFXAdditionalErrorsKey;
16 
18 
23 @interface KFXIDExtractionResult : NSObject
24 
26 
31 @property (nonatomic, assign) BOOL isBarcodeRead;
32 
34 
39 @property (nonatomic, assign) BOOL isOcrRead;
40 
42 
51 @property (nonatomic, assign) float documentVerificationConfidenceRating;
52 
54 
61 @property (nonatomic, strong) NSArray* fields;
62 
64 
76 @property (nonatomic, strong) kfxKEDClassificationResult* frontClassification;
77 
79 
91 @property (nonatomic, strong) kfxKEDClassificationResult* backClassification;
92 
93 @end
94 
96 
99 @protocol kfxKOEIDExtractorDelegate <NSObject>
100 
101 @required
102 
104 
118 - (void)extractionResult:(KFXIDExtractionResult*)result frontError:(NSError*)frontError backError:(NSError*)backError;
119 
120 @end
121 
122 
124 
150 @interface kfxKOEIDExtractor : NSObject
151 
153 
158 @property (nonatomic, weak) id<kfxKOEIDExtractorDelegate> delegate;
159 
160 
162 
169 - (instancetype)initWithProjectProvider:(id<KFXProjectProviderProtocol>)projectProvider;
170 
172 
182 - (void)extract:(KFXIDExtractionParameters*)parameters;
183 
185 
192 - (void)cancelExtraction;
193 
194 @end
A single classification result.
Definition: kfxKEDClassificationResult.h:42
NSString *const KFXAdditionalErrorsKey
kfxKEDClassificationResult * backClassification
Back side classification result.
Definition: kfxKOEIDExtractor.h:91
ID exraction parameters object.
Definition: KFXIDExtractionParameters.h:40
BOOL isBarcodeRead
Barcode read success indicator.
Definition: kfxKOEIDExtractor.h:31
kfxKEDClassificationResult * frontClassification
Front side classification result.
Definition: kfxKOEIDExtractor.h:76
BOOL isOcrRead
OCR success indicator.
Definition: kfxKOEIDExtractor.h:39
The ID Extractor Class.
Definition: kfxKOEIDExtractor.h:150
Project Provider protocol.
Definition: KFXProjectProviderProtocol.h:17
NSArray * fields
An array of extracted fields.
Definition: kfxKOEIDExtractor.h:61
float documentVerificationConfidenceRating
ID verification confidence rating.
Definition: kfxKOEIDExtractor.h:51
ID Extraction Result.
Definition: kfxKOEIDExtractor.h:23
ID Extraction Protocol.
Definition: kfxKOEIDExtractor.h:99
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.