Atalasoft MobileImage API Reference
Instance Methods | Class Methods | Properties | List of all members
KFXIDExtractionParameters Class Reference

ID exraction parameters object. More...

#import <KFXIDExtractionParameters.h>

Inheritance diagram for KFXIDExtractionParameters:

Instance Methods

(instancetype) - initWithFrontImage:backImage:region:
 Constructor. More...
 
(instancetype) - initWithFrontImage:barcode:region:
 Constructor. More...
 
(instancetype) - initWithType:region:frontImage:frontBarcodes:backImage:backBarcodes:isProcessed:
 Constructor. More...
 

Class Methods

(NSString *) + projectNameForRegion:
 Converter method. More...
 
(kfxKOEIDRegion+ regionForProject:
 Converter method. More...
 
(NSString *) + projectNameForRegion:idType:
 Converter method. More...
 
(void) + regionForProject:region:idType:
 Converter method. More...
 

Properties

KFXIDType type
 ID type parameter. More...
 
kfxKOEIDRegion region
 Region parameter. More...
 
kfxKEDImagefrontImage
 Front image parameter. More...
 
kfxKEDImagebackImage
 Back image parameter. More...
 
NSString *barcode DEPRECATED_ATTRIBUTE
 Back barcode string parameter. More...
 
NSArray< kfxKEDBarcodeResult * > * frontBarcodes
 Front barcode array parameter. More...
 
NSArray< kfxKEDBarcodeResult * > * backBarcodes
 Back barcode array parameter. More...
 
BOOL isProcessed
 Is processed flag. More...
 

Detailed Description

ID exraction parameters object.

This object represents parameters for ID extractor.

Initialization: [KFXIDExtractionParameters new] (or [[KFXIDExtractionParameters alloc] init]) - default constructor, sets parameters to default values. Not a valid object to be sent to the extractor.

[[KFXIDExtractionParameters alloc] initWithFrontImage:backImage:region:] - parameters will be initialized with provided front image, back image and region.

[[KFXIDExtractionParameters alloc] initWithFrontImage:barcode:region:] - parameters will be initialized with provided front image, barcode string and region.

KFXIDExtractionParameters* params = [[KFXIDExtractionParameters alloc] initWithType:region:frontImage:frontBarcodes:backImage:backBarcodes:isProcessed]] - parameters will be initialized with provided type, region, front image, front barcodes, back image, back barcodes, isProcessed.

See also
kfxKOEIDExtractor

Method Documentation

- (instancetype) initWithFrontImage: (kfxKEDImage *)  frontImage
backImage: (kfxKEDImage *)  backImage
region: (kfxKOEIDRegion DEPRECATED_ATTRIBUTE 

Constructor.

This method allows to specify front image, back image and region. ID type will be set to KFXIDType_ID. isProcessed will be set to YES.

Parameters
frontImage- front image.
backImage- back image.
region- ID region.
See also
kfxKEDImage
kfxKOEIDRegion
Deprecated:
Deprecated in 3.1. Please use initWithFrontImage:backImage:idType:region instead.
- (instancetype) initWithFrontImage: (kfxKEDImage *)  frontImage
barcode: (NSString *)  barcode
region: (kfxKOEIDRegion DEPRECATED_ATTRIBUTE 

Constructor.

This method allows to specify front image, barcode string and region. Barcode string is assumed to be a back barcode string from PDF417 barcode. ID type will be set to KFXIDType_ID. isProcessed will be set to YES.

Parameters
frontImage- front image.
barcode- barcode string.
region- ID region.
See also
kfxKEDImage
kfxKOEIDRegion
Deprecated:
Deprecated in 3.1. Please use initWithFrontImage:barcode:idType:region instead.
- (instancetype) initWithType: (KFXIDType type
region: (kfxKOEIDRegion region
frontImage: (kfxKEDImage *)  frontImage
frontBarcodes: (NSArray< kfxKEDBarcodeResult * > *)  frontBarcodes
backImage: (kfxKEDImage *)  backImage
backBarcodes: (NSArray< kfxKEDBarcodeResult * > *)  backBarcodes
isProcessed: (BOOL)  isProcessed 

Constructor.

This method allows to specify front image, front barcodes, back image, back barcode, ID type, region and isProcessed flag indicating whether images are processed or not.

Parameters
type- ID type.
region- ID region.
frontImage- front image.
frontBarcodes- front side barcodes.
backImage- back image.
backBarcodes- back side barcodes.
isProcessed- front/back image processed indicator.
See also
kfxKEDImage
kfxKOEIDRegion
KFXIDType
KFXBarcodeData
+ (NSString*) projectNameForRegion: (kfxKOEIDRegion DEPRECATED_ATTRIBUTE

Converter method.

This method converts provided region value to the corresponding project name. ID type is considered as KFXIDType_ID.

Parameters
region- ID region.
Returns
project name. If provided invalid region value, nil will be returned.
See also
kfxKOEIDRegion
Deprecated:
Deprecated in 3.1. Please use projectNameForRegion:idType: instead.
+ (NSString*) projectNameForRegion: (kfxKOEIDRegion region
idType: (KFXIDType type 

Converter method.

This method converts provided region value and ID type to the corresponding project name.

Parameters
region- ID region.
type- ID type.
Returns
project name. If provided invalid region or type value, nil will be returned.
See also
kfxKOERegion
KFXIDType
+ (kfxKOEIDRegion) regionForProject: (NSString *)  DEPRECATED_ATTRIBUTE

Converter method.

This method converts provided project name to the corresponding region.

Parameters
projectName- ID project.
Returns
region. If provided project name is invalid, default kfxKOEIDRegion will be returned.
See also
kfxKOEIDRegion
Deprecated:
Deprecated in SDK 3.1. Please use regionForProject:region:idType: instead.
+ (void) regionForProject: (NSString *)  projectName
region: (kfxKOEIDRegion *)  region
idType: (KFXIDType *)  type 

Converter method.

This method converts provided project name to the corresponding region and ID type. If project in invalid, region and type will be set to default values (kfxKOEIDRegion_US and KFXIDType_ID, respectively).

Parameters
projectName- ID project.
region- region value to be filled.
type- ID type value to be filled.
See also
kfxKOEIDRegion
KFXIDType

Property Documentation

- (NSArray<kfxKEDBarcodeResult*>*) backBarcodes
readnonatomicstrong

Back barcode array parameter.

Allows to get back barcodes.

Default value is nil.

See also
kfxKEDBarcodeResult
- (kfxKEDImage*) backImage
readnonatomicstrong

Back image parameter.

Allows to get back image object.

Default value is nil.

See also
kfxKEDImage
- (NSString* barcode) DEPRECATED_ATTRIBUTE
readnonatomicstrong

Back barcode string parameter.

Allows to get back barcode string value.

Default value is nil.

Deprecated:
Deprecated in SDK 3.1. Please use backBarcodes instead.
- (NSArray<kfxKEDBarcodeResult*>*) frontBarcodes
readnonatomicstrong

Front barcode array parameter.

Allows to get front barcodes.

Default value is nil.

See also
kfxKEDBarcodeResult
- (kfxKEDImage*) frontImage
readnonatomicstrong

Front image parameter.

Allows to get front image object.

Default value is nil.

See also
kfxKEDImage
- (BOOL) isProcessed
readnonatomicassign

Is processed flag.

Allows to specify if front/back image has already been processed prior to extraction.

Default value is NO.

- (kfxKOEIDRegion) region
readnonatomicassign

Region parameter.

Allows to get region parameter value.

Default value is kfxKOEIDRegion_US.

See also
kfxKOEIDRegion
- (KFXIDType) type
readnonatomicassign

ID type parameter.

Allows to get ID type value.

Default value is KFXIDType_ID.

See also
KFXIDType

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.