com.microblink.blinkinput.entities.detectors.quad.document

Class DocumentDetector

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.document.DocumentDetector

All Implemented Interfaces:

android.os.Parcelable

public final class DocumentDetector
extends QuadWithSizeDetector

Detector that can perform detection of card documents, cheques, papers, etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentDetector.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
DocumentDetector(DocumentSpecification[] specifications) Constructs detector that can perform detection of card documents, cheques, papers, etc.

Method Summary

Modifier and Type	Method and Description
DocumentDetector	clone() Create a copy of the entity.
void	consumeResultFrom(Entity other) Consume result from other entity.
protected void	deserializeNativeSettings(byte[] serializedSettings)
DocumentSpecification[]	getDocumentSpecifications()
int	getNumStableDetectionsThreshold() Retrieves the minimum number of stable detections required for detection to be successful
protected byte[]	serializeNativeSettings()
void	setNumStableDetectionsThreshold(int numStableDetectionsThreshold) Sets minimum number of stable detections required for detection to be successful
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

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

Constructor Detail

DocumentDetector

public DocumentDetector(@NonNull
                        DocumentSpecification[] specifications)

Constructs detector that can perform detection of card documents, cheques, papers, etc.

Parameters:

specifications - Non-empty of non-null specifications describing possible documents that should be detected.

Method Detail

setNumStableDetectionsThreshold

public void setNumStableDetectionsThreshold(int numStableDetectionsThreshold)

Sets minimum number of stable detections required for detection to be successful

Parameters:

numStableDetectionsThreshold - minimum number of stable detections required for detection to be successful

getNumStableDetectionsThreshold

public int getNumStableDetectionsThreshold()

Retrieves the minimum number of stable detections required for detection to be successful

Returns:

the minimum number of stable detections required for detection to be successful

getDocumentSpecifications

@NonNull
public DocumentSpecification[] getDocumentSpecifications()

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