Atalasoft MobileImage API Reference
KFXIDExtractionParameters.h
Go to the documentation of this file.
1 //
2 // KFXIDExtractionParameters.h
3 // kfxLibEngines
4 //
5 // Copyright (c) 2016 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 
11 @class kfxKEDImage;
12 
14 
17 typedef NS_ENUM(NSInteger, kfxKOEIDRegion)
18 {
19  kfxKOEIDRegion_US,
20  kfxKOEIDRegion_Asia, // Reserved for future usage
21  kfxKOEIDRegion_Australia // Reserved for future usage
22 };
23 
25 
39 @interface KFXIDExtractionParameters : NSObject
40 
42 
49 @property (nonatomic, assign, readonly) kfxKOEIDRegion region;
50 
52 
59 @property (nonatomic, strong, readonly) kfxKEDImage* frontImage;
60 
62 
70 @property (nonatomic, strong, readonly) kfxKEDImage* backImage;
71 
73 
79 @property (nonatomic, strong, readonly) NSString* barcode;
80 
82 
90 + (NSString*)projectNameForRegion:(kfxKOEIDRegion)region;
91 
93 
101 + (kfxKOEIDRegion)regionForProject:(NSString*)projectName;
102 
104 
114 - (instancetype)initWithFrontImage:(kfxKEDImage*)frontImage backImage:(kfxKEDImage*)backImage region:(kfxKOEIDRegion)region;
115 
117 
127 - (instancetype)initWithFrontImage:(kfxKEDImage*)frontImage barcode:(NSString*)barcode region:(kfxKOEIDRegion)region;
128 
129 @end
kfxKEDImage * frontImage
Front image parameter.
Definition: KFXIDExtractionParameters.h:59
barcode
Barcode enum to define barcode types to find, or those found.
Definition: kfxKEDBarcodeResult.h:14
ID exraction parameters object.
Definition: KFXIDExtractionParameters.h:39
kfxKOEIDRegion region
Region parameter.
Definition: KFXIDExtractionParameters.h:49
typedef NS_ENUM(NSInteger, kfxKOEIDRegion)
An enumeration containing the possible region values.
Definition: KFXIDExtractionParameters.h:17
An Image object contains an image and associated data.
Definition: kfxKEDImage.h:158
kfxKEDImage * backImage
Back image parameter.
Definition: KFXIDExtractionParameters.h:70
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.