com.microblink.entities.recognizers.blinkid.mrtd

Class MrtdRecognizer

java.lang.Object

com.microblink.entities.Entity

com.microblink.entities.recognizers.Recognizer

com.microblink.entities.recognizers.templating.TemplatingRecognizer

com.microblink.entities.recognizers.blinkid.mrtd.MrtdRecognizer

All Implemented Interfaces:

android.os.Parcelable, FullDocumentImageDpiOptions, EncodeFullDocumentImagesOptions, FullDocumentImageExtensionOptions, FullDocumentImageOptions, GlareDetectorOptions

public final class MrtdRecognizer
extends TemplatingRecognizer
implements GlareDetectorOptions, FullDocumentImageOptions, FullDocumentImageDpiOptions, FullDocumentImageExtensionOptions, EncodeFullDocumentImagesOptions

Recognizer that can recognize Machine Readable Zone (MRZ) of the Machine Readable Travel Document (MRTD)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MrtdRecognizer.Result

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator, android.os.Parcelable.Creator

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator	CREATOR

Fields inherited from class com.microblink.entities.recognizers.templating.TemplatingRecognizer

CLASS_NAME

Fields inherited from interface com.microblink.entities.settings.GlareDetectorOptions

CLASS_NAME

Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageoptions.FullDocumentImageOptions

CLASS_NAME

Fields inherited from interface com.microblink.entities.recognizers.blinkid.imageoptions.encode.EncodeFullDocumentImagesOptions

CLASS_NAME

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
MrtdRecognizer()

Method Summary

Modifier and Type	Method and Description
MrtdRecognizer	clone() Create a copy of the entity.
void	consumeResultFrom(Entity other) Consume result from other entity.
protected void	deserializeNativeSettings(byte[] serializedSettings)
int	getFullDocumentImageDpi() Returns the DPI (Dots Per Inch) for full document image that should be returned.
ImageExtensionFactors	getFullDocumentImageExtensionFactors() Returns the extension factors for full document image.
MrtdSpecification[]	getSpecifications() Returns the array of MrtdSpecification objects that will define which MRTD documents should be detectable.
boolean	isAllowSpecialCharacters() Whether special characters are allowed.
boolean	isAllowUnparsedResults() Whether returning of unparsed results is allowed.
boolean	isAllowUnverifiedResults() Whether returning of unverified results is allowed.
protected void	readFromParcel(android.os.Parcel in)
protected byte[]	serializeNativeSettings()
void	setAllowSpecialCharacters(boolean allowSpecialCharacters) Whether special characters are allowed.
void	setAllowUnparsedResults(boolean allowUnparsedResults) Whether returning of unparsed results is allowed.
void	setAllowUnverifiedResults(boolean allowUnverifiedResults) Whether returning of unverified results is allowed.
void	setDetectGlare(boolean detectGlare) Defines whether glare detector will be used during recognition process.
void	setEncodeFullDocumentImage(boolean encodeFullDocumentImage) Sets whether full document image should be encoded in JPEG format and written into the corresponding recognition result.
void	setFullDocumentImageDpi(int desiredDPI) Sets desired DPI (Dots Per Inch) for full document image that should be returned.
void	setFullDocumentImageExtensionFactors(ImageExtensionFactors fullDocumentImageExtensionFactors) Sets extension factors for full document image.
void	setMRZFilter(MrzFilter mrzFilter) Sets the MrzFilter that can determine whether document should be processed or filtered out.
protected void	setNativeTemplatingClasses(long[] nativeTemplatingClasses)
void	setReturnFullDocumentImage(boolean returnFullDocumentImage) Sets whether full document image should be available in FullDocumentImageResult.
void	setSpecifications(MrtdSpecification[] specifications) Sets one or more MrtdSpecification objects that will define which MRTD documents should be detectable.
boolean	shouldDetectGlare() Returns whether glare detector is enabled.
boolean	shouldEncodeFullDocumentImage() Returns whether encoding of full document images and writing them into the recognition result is enabled.
boolean	shouldReturnFullDocumentImage() Returns whether full document image will be available in FullDocumentImageResult.
protected void	terminateNative(long nativeContext)
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.microblink.entities.recognizers.templating.TemplatingRecognizer

setTemplatingClasses

Methods inherited from class com.microblink.entities.recognizers.Recognizer

requiresAutofocus, requiresLandscapeMode

Methods inherited from class com.microblink.entities.Entity

describeContents, finalize, getNativeContext, getResult, nativeGetNativeResultContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator CREATOR

Constructor Detail

MrtdRecognizer

public MrtdRecognizer()

Method Detail

setAllowSpecialCharacters

public void setAllowSpecialCharacters(boolean allowSpecialCharacters)

Whether special characters are allowed. By default, this is set to 'false'.

isAllowSpecialCharacters

public boolean isAllowSpecialCharacters()

Whether special characters are allowed. By default, this is set to 'false'.

setDetectGlare

public void setDetectGlare(boolean detectGlare)

Description copied from interface: GlareDetectorOptions

Defines whether glare detector will be used during recognition process. By default this option is set to true and glare detector is used. If the glare detector is used and GlareCallback is set to MetadataCallbacks, it will receive glare status will. Also when glare is detected OCR will not be performed on the affected document position to prevent errors in the extracted data. By default, this is set to 'true'.

Specified by:

setDetectGlare in interface GlareDetectorOptions

Parameters:

detectGlare - whether glare detector will be used during recognition process.

shouldDetectGlare

public boolean shouldDetectGlare()

Description copied from interface: GlareDetectorOptions

Returns whether glare detector is enabled. By default, this is set to 'true'.

Specified by:

shouldDetectGlare in interface GlareDetectorOptions

Returns:

it the glare detector is enabled returns true, otherwise returns false.

setAllowUnverifiedResults

public void setAllowUnverifiedResults(boolean allowUnverifiedResults)

Whether returning of unverified results is allowed. Unverified result is result that is parsed, but check digits are incorrect. By default, this is set to 'false'.

isAllowUnverifiedResults

public boolean isAllowUnverifiedResults()

Whether returning of unverified results is allowed. Unverified result is result that is parsed, but check digits are incorrect. By default, this is set to 'false'.

setReturnFullDocumentImage

public void setReturnFullDocumentImage(boolean returnFullDocumentImage)

Description copied from interface: FullDocumentImageOptions

Sets whether full document image should be available in FullDocumentImageResult. If enabled, get image using FullDocumentImageResult.getFullDocumentImage() By default, this is set to 'false'. IMPORTANT NOTE: If you set MicroblinkSDK.setIntentDataTransferMode(com.microblink.intent.IntentDataTransferMode) to IntentDataTransferMode.STANDARD recognizer which contains encoded image cannot be parcelized and passed by Intent extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results in Activity.onActivityResult(int, int, android.content.Intent) method use either IntentDataTransferMode.OPTIMISED or IntentDataTransferMode.PERSISTED_OPTIMISED By default, this is set to 'false'

Specified by:

setReturnFullDocumentImage in interface FullDocumentImageOptions

Parameters:

returnFullDocumentImage - whether full document image will be available in FullDocumentImageResult.

shouldReturnFullDocumentImage

public boolean shouldReturnFullDocumentImage()

Description copied from interface: FullDocumentImageOptions

Returns whether full document image will be available in FullDocumentImageResult. By default, this is set to 'false'. By default, this is set to 'false'

Specified by:

shouldReturnFullDocumentImage in interface FullDocumentImageOptions

Returns:

whether full document image will be available in FullDocumentImageResult.

setEncodeFullDocumentImage

public void setEncodeFullDocumentImage(boolean encodeFullDocumentImage)

Description copied from interface: EncodeFullDocumentImagesOptions

Sets whether full document image should be encoded in JPEG format and written into the corresponding recognition result. By default, this is set to 'false'.
IMPORTANT NOTE: If you set MicroblinkSDK.setIntentDataTransferMode(com.microblink.intent.IntentDataTransferMode) to IntentDataTransferMode.STANDARD recognizer which contains encoded image cannot be parcelized and passed by Intent extras because of Android limitations on intent extras size. If you are using one of the provided scan activities and expect receiving scan results in Activity.onActivityResult(int, int, Intent) method use either IntentDataTransferMode.OPTIMISED or IntentDataTransferMode.PERSISTED_OPTIMISED

Specified by:

setEncodeFullDocumentImage in interface EncodeFullDocumentImagesOptions

Parameters:

encodeFullDocumentImage - whether full document images should be encoded in JPEG format and written into the corresponding recognition result.

shouldEncodeFullDocumentImage

public boolean shouldEncodeFullDocumentImage()

Description copied from interface: EncodeFullDocumentImagesOptions

Returns whether encoding of full document images and writing them into the recognition result is enabled. By default, this is set to 'false'.

Specified by:

shouldEncodeFullDocumentImage in interface EncodeFullDocumentImagesOptions

Returns:

whether encoding of full document images and writing them into the recognition result is enabled.

setAllowUnparsedResults

public void setAllowUnparsedResults(boolean allowUnparsedResults)

Whether returning of unparsed results is allowed. By default, this is set to 'false'.

isAllowUnparsedResults

public boolean isAllowUnparsedResults()

Whether returning of unparsed results is allowed. By default, this is set to 'false'.

getFullDocumentImageDpi

public int getFullDocumentImageDpi()

Returns the DPI (Dots Per Inch) for full document image that should be returned. By default, this is set to '250'.

Specified by:

getFullDocumentImageDpi in interface FullDocumentImageDpiOptions

Returns:

DPI for full document image that should be returned.

setFullDocumentImageDpi

public void setFullDocumentImageDpi(int desiredDPI)

Sets desired DPI (Dots Per Inch) for full document image that should be returned. By default, this is set to '250'.

Specified by:

setFullDocumentImageDpi in interface FullDocumentImageDpiOptions

Parameters:

desiredDPI - desired DPI in range [100, 400]

setFullDocumentImageExtensionFactors

public void setFullDocumentImageExtensionFactors(@NonNull
                                                 ImageExtensionFactors fullDocumentImageExtensionFactors)

Sets extension factors for full document image. By default, this is set to '[0.0, 0.0, 0.0, 0.0]'.

Specified by:

setFullDocumentImageExtensionFactors in interface FullDocumentImageExtensionOptions

Parameters:

fullDocumentImageExtensionFactors - extension factors for full document image.

getFullDocumentImageExtensionFactors

@NonNull
public ImageExtensionFactors getFullDocumentImageExtensionFactors()

Returns the extension factors for full document image. By default, this is set to '[0.0, 0.0, 0.0, 0.0]'.

Specified by:

getFullDocumentImageExtensionFactors in interface FullDocumentImageExtensionOptions

Returns:

extension factors for full document image.

setNativeTemplatingClasses

protected void setNativeTemplatingClasses(@Nullable
                                          long[] nativeTemplatingClasses)

Specified by:

setNativeTemplatingClasses in class TemplatingRecognizer

setSpecifications

public void setSpecifications(@Nullable
                              MrtdSpecification[] specifications)

Sets one or more MrtdSpecification objects that will define which MRTD documents should be detectable. Setting null or empty array will enable all possible specifications.

Parameters:

specifications - specifications for MRTD documents that should be detectable

getSpecifications

@NonNull
public MrtdSpecification[] getSpecifications()

Returns the array of MrtdSpecification objects that will define which MRTD documents should be detectable.

Returns:

the array of MrtdSpecification objects that will define which MRTD documents should be detectable.

setMRZFilter

public void setMRZFilter(@Nullable
                         MrzFilter mrzFilter)

Sets the MrzFilter that can determine whether document should be processed or filtered out.

Parameters:

mrzFilter - MrzFilter that can determine whether document should be processed or filtered out or null to allow processing of all documents.

writeToParcel

public void writeToParcel(@NonNull
                          android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class TemplatingRecognizer

readFromParcel

protected void readFromParcel(@NonNull
                              android.os.Parcel in)

Overrides:

readFromParcel in class TemplatingRecognizer

terminateNative

protected void terminateNative(long nativeContext)

Specified by:

terminateNative in class Entity

serializeNativeSettings

@Nullable
protected byte[] serializeNativeSettings()

Specified by:

serializeNativeSettings in class Entity

deserializeNativeSettings

protected void deserializeNativeSettings(@NonNull
                                         byte[] serializedSettings)

Specified by:

deserializeNativeSettings in class Entity

clone

public MrtdRecognizer clone()

Description copied from class: Entity

Create a copy of the entity. This is required if properties of the entity must be modified while background thread performs processing. In order to avoid race conditions, changing properties is not allowed while entity is used in background processing. However, you are able to make a copy of the entity, change properties of it and then update the RecognizerRunnerView or RecognizerRunner with the updated entity hierarchy.

Specified by:

clone in class Recognizer

Returns:

a copy of the entity

consumeResultFrom

public void consumeResultFrom(@NonNull
                              Entity other)

Description copied from class: Entity

Consume result from other entity. The result from other will be put instead current result of this entity. This method is used inside com.microblink.entities.recognizers.RecognizerBundle#loadFromIntent(Intent) and similar methods to replace the result content of the saved entities with results that have arrived over Intent

Overrides:

consumeResultFrom in class TemplatingRecognizer

Parameters:

other - Entity from which result should be consumed.