com.microblink.blinkinput.entities.recognizers.detector

Class DetectorRecognizer

java.lang.Object

com.microblink.blinkinput.entities.Entity

com.microblink.blinkinput.entities.recognizers.Recognizer

com.microblink.blinkinput.entities.recognizers.templating.TemplatingRecognizer

com.microblink.blinkinput.entities.recognizers.detector.DetectorRecognizer

All Implemented Interfaces:

android.os.Parcelable, GlareDetectorOptions

public final class DetectorRecognizer
extends TemplatingRecognizer

Templating API recognizer for scanning generic documents by using custom QuadWithSizeDetector. This recognizer is used for implementing support for data extraction from custom document types by using templating API. If you don't need data extraction, but only want to take cropped document images, use DocumentCaptureRecognizer instead.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DetectorRecognizer.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.recognizers.templating.TemplatingRecognizer

CLASS_NAME

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
DetectorRecognizer(QuadWithSizeDetector detector)

Method Summary

Modifier and Type	Method and Description
DetectorRecognizer	clone() Create a copy of the entity.
void	consumeResultFrom(Entity other) Consume result from other entity.
protected void	deserializeNativeSettings(byte[] serializedSettings)
QuadWithSizeDetector	getDetector() Returns the detector that will be used for performing the document detection during recognition
boolean	isAllowFlippedRecognition() Returns whether or not flipped recognition feature is enabled.
protected byte[]	serializeNativeSettings()
void	setAllowFlippedRecognition(boolean allowFlippedRecognition) Set this to true to enable recognition of document also in upside down direction.
void	setDetectGlare(boolean detectGlare) Defines whether glare detector will be used during recognition process.
protected void	setNativeTemplatingClasses(long[] nativeTemplatingClasses)
boolean	shouldDetectGlare() Returns whether glare detector is enabled.
protected void	terminateNative(long nativeContext)
void	writeToParcel(android.os.Parcel dest, int flags)

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

readFromParcel, setTemplatingClasses

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

getName, isExcludedFromPing, requiresAutofocus, requiresLandscapeMode

Methods inherited from class com.microblink.blinkinput.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

@NonNull
public static final android.os.Parcelable.Creator CREATOR

Constructor Detail

DetectorRecognizer

public DetectorRecognizer(@NonNull
                          QuadWithSizeDetector detector)

Parameters:

detector - Detector that will be used for performing document detection during recognition

Method Detail

getDetector

@NonNull
public QuadWithSizeDetector getDetector()

Returns the detector that will be used for performing the document detection during recognition

Returns:

the detector

setAllowFlippedRecognition

public void setAllowFlippedRecognition(boolean allowFlippedRecognition)

Set this to true to enable recognition of document also in upside down direction. This is useful if detector being used cannot determine correct orientation of detected document (for example DocumentDetector). Keep in mind that enabling this feature will make recognition two times slower and possibly less accurate. By default, this is turned off.

Parameters:

allowFlippedRecognition - whether or not flipped recognition is allowed

isAllowFlippedRecognition

public boolean isAllowFlippedRecognition()

Returns whether or not flipped recognition feature is enabled. For more information, see DetectorRecognizer.setAllowFlippedRecognition(boolean).

Returns:

whether or not flipped recognition feature is enabled

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

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

Returns:

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

setNativeTemplatingClasses

protected void setNativeTemplatingClasses(@Nullable
                                          long[] nativeTemplatingClasses)

Specified by:

setNativeTemplatingClasses 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

@NonNull
public DetectorRecognizer 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.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

Overrides:

consumeResultFrom in class TemplatingRecognizer

Parameters:

other - Entity from which result should be consumed.

writeToParcel

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

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class TemplatingRecognizer