com.microblink.blinkinput.entities.detectors.quad.mrtd

Class MRTDDetector

java.lang.Object

com.microblink.blinkinput.entities.Entity

com.microblink.blinkinput.entities.detectors.Detector

com.microblink.blinkinput.entities.detectors.quad.QuadDetector

com.microblink.blinkinput.entities.detectors.quad.QuadWithSizeDetector

com.microblink.blinkinput.entities.detectors.quad.mrtd.MRTDDetector

All Implemented Interfaces:

android.os.Parcelable

public final class MRTDDetector
extends QuadWithSizeDetector

Detector that can perform detection of Machine Readable Travel Documents (MRTD).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MRTDDetector.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.blinkinput.entities.detectors.quad.QuadWithSizeDetector

CLASS_NAME

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
MRTDDetector()

Method Summary

Modifier and Type	Method and Description
MRTDDetector	clone() Create a copy of the entity.
void	consumeResultFrom(Entity other) Consume result from other entity.
protected void	deserializeNativeSettings(byte[] serializedSettings)
MrtdSpecification[]	getSpecifications() Returns the array of MrtdSpecification objects that will define which MRTD documents should be detectable.
boolean	isDetectFullDocument() Defines whether full document will be detected.
boolean	isUseCardDetector() Enable detection correction with card detector.
protected byte[]	serializeNativeSettings()
void	setDetectFullDocument(boolean detectFullDocument) Defines whether full document will be detected.
void	setSpecifications(MrtdSpecification[] specifications) Sets one or more MrtdSpecification objects that will define which MRTD documents should be detectable.
void	setUseCardDetector(boolean useCardDetector) Enable detection correction with card detector.
protected void	terminateNative(long nativeContext)

Methods inherited from class com.microblink.blinkinput.entities.Entity

describeContents, finalize, getNativeContext, getResult, nativeGetNativeResultContext, readFromParcel, writeToParcel

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

MRTDDetector

public MRTDDetector()

Method Detail

setDetectFullDocument

public void setDetectFullDocument(boolean detectFullDocument)

Defines whether full document will be detected. If set to false, result will contain location of Machine Readable Zone only. If set to true, result will contain location of entire document. By default, this is set to 'true'

isDetectFullDocument

public boolean isDetectFullDocument()

Defines whether full document will be detected. If set to false, result will contain location of Machine Readable Zone only. If set to true, result will contain location of entire document. By default, this is set to 'true'

setUseCardDetector

public void setUseCardDetector(boolean useCardDetector)

Enable detection correction with card detector. When this option is enabled, after MRTD detector has found the document, it will internally use DocumentDetector to additionally correct document location estimated from detected MRZ location. Note that although enabling this option will usually improve detection accuracy, it may be possible that for some use cases accuracy will be lower. By default, this is set to 'false'

isUseCardDetector

public boolean isUseCardDetector()

Enable detection correction with card detector. When this option is enabled, after MRTD detector has found the document, it will internally use DocumentDetector to additionally correct document location estimated from detected MRZ location. Note that although enabling this option will usually improve detection accuracy, it may be possible that for some use cases accuracy will be lower. By default, this is set to 'false'

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.

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 MRTDDetector 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 Entity

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.blinkinput.entities.recognizers.RecognizerBundle#loadFromIntent(Intent) and similar methods to replace the result content of the saved entities with results that have arrived over Intent

Specified by:

consumeResultFrom in class Entity

Parameters:

other - Entity from which result should be consumed.