Atalasoft MobileImage API Reference
KFXIDExtractionParameters.h
Go to the documentation of this file.
1 //
2 // KFXIDExtractionParameters.h
3 // kfxLibEngines
4 //
5 // Copyright (c) 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 #import "kfxKOEIDRegion.h"
11 
12 @class kfxKEDImage;
13 @class kfxKEDBarcodeResult;
14 
16 
19 typedef NS_ENUM(NSInteger, KFXIDType)
20 {
23 };
24 
26 
40 @interface KFXIDExtractionParameters : NSObject
41 
43 
50 @property (nonatomic, assign, readonly) KFXIDType type;
51 
53 
60 @property (nonatomic, assign, readonly) kfxKOEIDRegion region;
61 
63 
70 @property (nonatomic, strong, readonly) kfxKEDImage* frontImage;
71 
73 
80 @property (nonatomic, strong, readonly) kfxKEDImage* backImage;
81 
83 
90 @property (nonatomic, strong, readonly) NSString* barcode DEPRECATED_ATTRIBUTE;
91 
93 
100 @property (nonatomic, strong, readonly) NSArray<kfxKEDBarcodeResult*>* frontBarcodes;
101 
103 
110 @property (nonatomic, strong, readonly) NSArray<kfxKEDBarcodeResult*>* backBarcodes;
111 
113 
118 @property (nonatomic, assign, readonly) BOOL isProcessed;
119 
121 
132 + (NSString*)projectNameForRegion:(kfxKOEIDRegion)region DEPRECATED_ATTRIBUTE;
133 
135 
145 + (kfxKOEIDRegion)regionForProject:(NSString*)projectName DEPRECATED_ATTRIBUTE;
146 
148 
158 + (NSString*)projectNameForRegion:(kfxKOEIDRegion)region idType:(KFXIDType)type;
159 
161 
172 + (void)regionForProject:(NSString*)projectName region:(kfxKOEIDRegion*)region idType:(KFXIDType*)type;
173 
175 
189 - (instancetype)initWithFrontImage:(kfxKEDImage*)frontImage backImage:(kfxKEDImage*)backImage region:(kfxKOEIDRegion)region DEPRECATED_ATTRIBUTE;
190 
192 
207 - (instancetype)initWithFrontImage:(kfxKEDImage*)frontImage barcode:(NSString*)barcode region:(kfxKOEIDRegion)region DEPRECATED_ATTRIBUTE;
208 
210 
226 - (instancetype)initWithType:(KFXIDType)type region:(kfxKOEIDRegion)region frontImage:(kfxKEDImage*)frontImage frontBarcodes:(NSArray<kfxKEDBarcodeResult*>*)frontBarcodes backImage:(kfxKEDImage*)backImage backBarcodes:(NSArray<kfxKEDBarcodeResult*>*)backBarcodes isProcessed:(BOOL)isProcessed;
227 
228 @end
kfxKEDImage * frontImage
Front image parameter.
Definition: KFXIDExtractionParameters.h:70
barcode
Barcode enum to define barcode types to find, or those found.
Definition: kfxKEDBarcodeResult.h:14
Definition: KFXIDExtractionParameters.h:21
ID exraction parameters object.
Definition: KFXIDExtractionParameters.h:40
kfxKOEIDRegion region
Region parameter.
Definition: KFXIDExtractionParameters.h:60
KFXIDType type
ID type parameter.
Definition: KFXIDExtractionParameters.h:50
KFXIDType
An enumeration containing possible ID types.
Definition: KFXIDExtractionParameters.h:19
kfxKOEIDRegion
An enumeration containing the possible region values.
Definition: kfxKOEIDRegion.h:16
NSArray< kfxKEDBarcodeResult * > * frontBarcodes
Front barcode array parameter.
Definition: KFXIDExtractionParameters.h:100
A single barcode found data item.
Definition: kfxKEDBarcodeResult.h:70
Definition: KFXIDExtractionParameters.h:22
NSArray< kfxKEDBarcodeResult * > * backBarcodes
Back barcode array parameter.
Definition: KFXIDExtractionParameters.h:110
BOOL isProcessed
Is processed flag.
Definition: KFXIDExtractionParameters.h:118
enum kfxIDRegion DEPRECATED_ATTRIBUTE
An enumeration containing the possible ID region values.
An Image object contains an image and associated data.
Definition: kfxKEDImage.h:158
kfxKEDImage * backImage
Back image parameter.
Definition: KFXIDExtractionParameters.h:80
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.