IdExtractionParameters Class Reference

Public Member Functions
	IdExtractionParameters (IdRegion region, IdType idType, Image frontImage, List< BarCodeResult > frontBarcodes, Image backImage, List< BarCodeResult > backBarcodes, boolean isProcessed, IIdExtractionListener listener)
	IdExtractionParameters (String projectName, IdType idType, Image frontImage, List< BarCodeResult > frontBarcodes, Image backImage, List< BarCodeResult > backBarcodes, boolean isProcessed, IIdExtractionListener listener)
IIdExtractionListener	getListener ()
IdRegion	getRegion ()
String	getProjectName ()
IdType	getIdType ()
Image	getFrontImage ()
Image	getBackImage ()
List< BarCodeResult >	getFrontBarcodes ()
List< BarCodeResult >	getBackBarcodes ()
boolean	isProcessed ()

Static Public Attributes
static final String	PREPROCESS_STRING = "_DeviceType_2_Do90DegreeRotation_4_DoCropCorrection__DoScaleImageToDPI_500_DoSkewCorrectionPage__DocDimLarge_3.375_DocDimSmall_2.125_LoadSetting_<Property Name=\"CSkewDetect.correct_illumination.Bool\" Value=\"0\" />"
static final String	PREPROCESS_PASSPORT_STRING = "_DeviceType_2_DoCropCorrection__DoSkewCorrectionAlt__Do90DegreeRotation_4_DoScaleImageToDPI_500_DocDimSmall_3.465_DocDimLarge_4.921_"
static final String	PREPROCESS_ID2_STRING = "_DeviceType_2_Do90DegreeRotation_4_DoCropCorrection__DoScaleImageToDPI_500_DoSkewCorrectionPage__DocDimLarge_4.134_DocDimSmall_2.913_LoadSetting_<Property Name=\"CSkewDetect.correct_illumination.Bool\" Value=\"0\" />"

Detailed Description

Parameter holder object for on-device extraction.

Any Image(s) may be pre-processed for de-skew and crop prior to sending it for extraction.

One or both images, or a barcode string is required.

Constructor & Destructor Documentation

IdExtractionParameters	(	IdRegion	region,
		IdType	idType,
		Image	frontImage,
		List< BarCodeResult >	frontBarcodes,
		Image	backImage,
		List< BarCodeResult >	backBarcodes,
		boolean	isProcessed,
		IIdExtractionListener	listener
	)

Construct a new IdExtractionParameters object.

At least one of the frontImage, backImage, frontBarcode, backBarcode parameters is required. If using either image, any of the other parameters is optional. When using barcode strings, one or both of the image parameters is required.

Parameters

region	The region of the image(s) (cannot be null)
idType	The type of the document (cannot be null)
frontImage	Pass the front-side image (optional)
frontBarcodes	Pass the front-side barcode strings and types (optional)
backImage	Pass the back-side image (optional)
backBarcodes	Pass the back-side barcode strings and types (optional)
isProcessed	Whether the images passed are pre-processed or not. If true, the SDK will not pre-process both images before extraction. Otherwise, any processing required will be handled internally by the SDK.
listener	A callback that will be called with results and errors (cannot be null)

Exceptions

IllegalArgumentException

When IdRegion or Listener is null, or if both the front image and barcode string are null

Deprecated:

As of SDK 3.3 replaced by IdExtractionParameters(String, IdType, Image, List<BarCodeResult>, Image, List<BarCodeResult>, boolean, IIdExtractionListener)

IdExtractionParameters	(	String	projectName,
		IdType	idType,
		Image	frontImage,
		List< BarCodeResult >	frontBarcodes,
		Image	backImage,
		List< BarCodeResult >	backBarcodes,
		boolean	isProcessed,
		IIdExtractionListener	listener
	)

Construct a new IdExtractionParameters object.

At least one of the frontImage, backImage, frontBarcodes, backBarcodes parameters is required. If using either image, any of the other parameters is optional. When using barcodes, one or both of the image parameters is required for regions other than US and Canada.

Parameters

projectName	The region of the image(s) (cannot be null)
idType	The type of the document (cannot be null)
frontImage	Pass the front-side image (optional)
frontBarcodes	Pass the front-side barcode strings and types (optional)
backImage	Pass the back-side image (optional)
backBarcodes	Pass the back-side barcode strings and types (optional)
isProcessed	Whether the images passed are pre-processed or not. If true, the SDK will not pre-process both images before extraction. Otherwise, any processing required will be handled internally by the SDK.
listener	A callback that will be called with results and errors (cannot be null)

Exceptions

IllegalArgumentException	When projectName or idType or listener is null.
KmcRuntimeException	(KMC_GN_ILLEGAL_ARGUMENT_EXCEPTION) When both images and barcode lists are null.

Member Function Documentation

List<BarCodeResult> getBackBarcodes

(

)

Image getBackImage

(

)

List<BarCodeResult> getFrontBarcodes

(

)

Image getFrontImage

(

)

IdType getIdType

(

)

IIdExtractionListener getListener

(

)

String getProjectName

(

)

IdRegion getRegion

(

)

Deprecated:

As of SDK 3.3 replaced by getProjectName()

boolean isProcessed

(

)

Member Data Documentation

final String PREPROCESS_ID2_STRING = "_DeviceType_2_Do90DegreeRotation_4_DoCropCorrection__DoScaleImageToDPI_500_DoSkewCorrectionPage__DocDimLarge_4.134_DocDimSmall_2.913_LoadSetting_<Property Name=\"CSkewDetect.correct_illumination.Bool\" Value=\"0\" />"

static

final String PREPROCESS_PASSPORT_STRING = "_DeviceType_2_DoCropCorrection__DoSkewCorrectionAlt__Do90DegreeRotation_4_DoScaleImageToDPI_500_DocDimSmall_3.465_DocDimLarge_4.921_"

static

final String PREPROCESS_STRING = "_DeviceType_2_Do90DegreeRotation_4_DoCropCorrection__DoScaleImageToDPI_500_DoSkewCorrectionPage__DocDimLarge_3.375_DocDimSmall_2.125_LoadSetting_<Property Name=\"CSkewDetect.correct_illumination.Bool\" Value=\"0\" />"

static

---

The documentation for this class was generated from the following file:

• IdExtractionParameters.java