ID exraction parameters object. More...

#import <KFXIDExtractionParameters.h>

Inheritance diagram for KFXIDExtractionParameters:

Instance Methods
(instancetype)	- initWithType:projectName:frontImage:frontBarcodes:backImage:backBarcodes:isProcessed:
	Constructor. More...

(instancetype)	- initWithFrontImage:frontBarcodes:backImage:backBarcodes:isProcessed:
	Constructor. More...

(instancetype)	- initWithType:projectName:frontImage:frontBarcodes:backImage:backBarcodes:isProcessed:extractFaceImage:extractSignatureImage:
	Constructor. More...

Class Methods
(NSString *)	+ projectNameForRegion:idType:
	Converter method. More...

(void)	+ regionForProject:region:idType:
	Converter method. More...

(NSString *)	+ subProjectForProject:
	Converter method. More...

Properties
KFXIDType	type
	ID type parameter. More...

NSString *	projectName
	Project name parameter. More...

kfxKEDImage *	frontImage
	Front image parameter. More...

kfxKEDImage *	backImage
	Back image parameter. More...

NSArray< kfxKEDBarcodeResult * > *	frontBarcodes
	Front barcode array parameter. More...

NSArray< kfxKEDBarcodeResult * > *	backBarcodes
	Back barcode array parameter. More...

BOOL	isProcessed
	Is processed flag. More...

BOOL	extractFaceImage
	Extract face flag. More...

BOOL	extractSignatureImage
	Extract signature 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* 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
frontBarcodes:	(NSArray< kfxKEDBarcodeResult * > *)	frontBarcodes
backImage:	(kfxKEDImage *)	backImage
backBarcodes:	(NSArray< kfxKEDBarcodeResult * > *)	backBarcodes
isProcessed:	(BOOL)	isProcessed

Constructor.

Specify front image, front barcodes, back image, back barcodes, and isProcessed flag. At least one of the frontImage, backImage, frontBarcodes, or backBarcodes parameters is required.

Parameters

frontImage	- front image (optional).
frontBarcodes	- front side barcodes (optional).
backImage	- back image (optional).
backBarcodes	- back side barcodes (optional).
isProcessed	- front/back image processed indicator. If true, the SDK will not pre-process images before extraction.

See also: kfxKEDImage; KFXIDType; kfxKEDBarcodeResult

- (instancetype) initWithType:	(KFXIDType)	type
projectName:	(NSString *)	projectName
frontImage:	(kfxKEDImage *)	frontImage
frontBarcodes:	(NSArray< kfxKEDBarcodeResult * > *)	frontBarcodes
backImage:	(kfxKEDImage *)	backImage
backBarcodes:	(NSArray< kfxKEDBarcodeResult * > *)	backBarcodes
isProcessed:	(BOOL)	DEPRECATED_ATTRIBUTE

Constructor.

Specify ID type, project name, front image, front barcodes, back image, back barcode, isProcessed flag. At least one of the frontImage, backImage, frontBarcodes, or backBarcodes parameters is required.

Parameters

type	- ID type (optional).
projectName	- project name (optional). The default value is null.
frontImage	- front image (optional).
frontBarcodes	- front side barcodes(optional).
backImage	- back image(optional).
backBarcodes	- back side barcodes(optional).
isProcessed	- front/back image processed indicator. If true, the SDK will not pre-process images before extraction.

See also: kfxKEDImage; KFXIDType; kfxKEDBarcodeResult

Deprecated:: Deprecated in 3.5, replaced with initWithFrontImage:frontBarcodes:backImage:backBarcodes:isProcessed:

- (instancetype) initWithType:	(KFXIDType)	type
projectName:	(NSString *)	projectName
frontImage:	(kfxKEDImage *)	frontImage
frontBarcodes:	(NSArray< kfxKEDBarcodeResult * > *)	frontBarcodes
backImage:	(kfxKEDImage *)	backImage
backBarcodes:	(NSArray< kfxKEDBarcodeResult * > *)	backBarcodes
isProcessed:	(BOOL)	isProcessed
extractFaceImage:	(BOOL)	extractFaceImage
extractSignatureImage:	(BOOL)	extractSignatureImage

Constructor.

Specify ID type, project name, front image, front barcodes, back image, back barcode, isProcessed flag, extracFaceImage flag, and extractSignatureImage flag. At least one of the frontImage, backImage, frontBarcodes, or backBarcodes parameters is required.

Parameters

type	- ID type (optional).
projectName	- project name (optional). The default value is null.
frontImage	- front image (optional).
frontBarcodes	- front side barcodes(optional).
backImage	- back image(optional).
backBarcodes	- back side barcodes(optional).
isProcessed	- front/back image processed indicator. If true, the SDK will not pre-process images before extraction.
extractFaceImage	- whether or not identification photo extraction will be attempted.
extractSignatureImage	- whether or not signature image extraction will be attempted.

See also: kfxKEDImage; KFXIDType; kfxKEDBarcodeResult

+ (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: kfxKOEIDRegion; KFXIDType

+ (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

+ (NSString*) subProjectForProject: (NSString *) project

Converter method.

This method converts provided project name to the corresponding subProject name. If project is invalid, returns nil.

Parameters

projectName - ID project.

Returns: subProject name.

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

- (BOOL) extractFaceImage

readnonatomicassign

Extract face flag.

Allows to specify if identification photo extraction will be attempted.

Default value is NO.

- (BOOL) extractSignatureImage

readnonatomicassign

Extract signature flag.

Allows to specify if signature image extraction will be attempted.

Default value is NO.

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

- (NSString*) projectName

readnonatomicstrong

Project name parameter.

Allows to get projectName parameter value.

Default value is nil.

- (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:

KFXIDExtractionParameters.h

Instance Methods

Class Methods

Properties

Detailed Description

Method Documentation

Property Documentation