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...
 

Class Methods

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

Properties

kfxKOEIDRegion region
 Region parameter. More...
 
kfxKEDImagefrontImage
 Front image parameter. More...
 
kfxKEDImagebackImage
 Back image parameter. More...
 
NSString * barcode
 Barcode string parameter. 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.

Only US region is currently supported.

See also
kfxKOEIDExtractor

Method Documentation

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

Constructor.

This method allows to specify front image, back image and region.

Parameters
frontImage- front image.
backImage- back image.
region- ID region.
See also
kfxKEDImage
kfxKOEIDRegion
- (instancetype) initWithFrontImage: (kfxKEDImage *)  frontImage
barcode: (NSString *)  barcode
region: (kfxKOEIDRegion)  region 

Constructor.

This method allows to specify front image, barcode string and region.

Parameters
frontImage- front image.
barcode- barcode string.
region- ID region.
See also
kfxKEDImage
kfxKOEIDRegion
+ (NSString*) projectNameForRegion: (kfxKOEIDRegion)  region

Converter method.

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

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

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

Property Documentation

- (kfxKEDImage*) backImage
readnonatomicstrong

Back image parameter.

Allows to get back image object. Cannot be valid with barcode string simultaneously.

Default value is nil.

See also
kfxKEDImage
- (NSString*) barcode
readnonatomicstrong

Barcode string parameter.

Allows to get barcode string value. Cannot be valid with back image simultaneously.

Default value is nil.

- (kfxKEDImage*) frontImage
readnonatomicstrong

Front image parameter.

Allows to get front image object.

Default value is nil.

See also
kfxKEDImage
- (kfxKOEIDRegion) region
readnonatomicassign

Region parameter.

Allows to get region parameter value.

Default value is kfxKOEIDRegion_US.

See also
kfxKOEIDRegion

The documentation for this class was generated from the following file:
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.