com.microblink.recognizers.settings

Class RecognitionSettings

java.lang.Object

com.microblink.recognizers.settings.RecognitionSettings

All Implemented Interfaces:

android.os.Parcelable

public class RecognitionSettings
extends java.lang.Object
implements android.os.Parcelable

Created by dodo on 25/11/14.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecognitionSettings.FrameQualityEstimationMode

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

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<RecognitionSettings>	CREATOR
static int	DETECTION_TEST_MODE will perform only detection and will profile the performance of slip detection
static int	RECOGNITION_MODE indicates normal scanning operation
static int	RECOGNITION_TEST_MODE will perform indefinite scan and will profile the performance of scans

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
RecognitionSettings()

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(java.lang.Object o)
RecognitionSettings.FrameQualityEstimationMode	getFrameQualityEstimationMode()
int	getNumMsBeforeTimeout() Returns the duration in milliseconds that needs to pass since scanning has begun in order to define timeout.
int	getRecognitionMode()
RecognizerSettings[]	getRecognizerSettingsArray() Returns the currently active recognizer settings array
void	setAllowMultipleScanResultsOnSingleImage(boolean multiScan) Sets whether or not outputting of multiple scan results from same image is allowed.
void	setFrameQualityEstimationMode(RecognitionSettings.FrameQualityEstimationMode mode) Sets the mode of the frame quality estimation.
void	setNumMsBeforeTimeout(int numMsBeforeTimeout) Set the duration in milliseconds that needs to pass since scanning has begun in order to define timeout.
void	setRecognitionMode(int recognitionMode) This method is for debugging and testing purposes only.
void	setRecognizerSettingsArray(RecognizerSettings[] settingsArray) Set recognizer settings array that will be passed to native code.
boolean	shouldAllowMultipleScanResultsOnSingleImage() Returns true if multiple scan results can be obtained from single image.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RECOGNITION_MODE

public static final int RECOGNITION_MODE

indicates normal scanning operation

See Also:

Constant Field Values

RECOGNITION_TEST_MODE

public static final int RECOGNITION_TEST_MODE

will perform indefinite scan and will profile the performance of scans

See Also:

Constant Field Values

DETECTION_TEST_MODE

public static final int DETECTION_TEST_MODE

will perform only detection and will profile the performance of slip detection

See Also:

Constant Field Values

CREATOR

public static final android.os.Parcelable.Creator<RecognitionSettings> CREATOR

Constructor Detail

RecognitionSettings

public RecognitionSettings()

Method Detail

getRecognitionMode

public int getRecognitionMode()

setRecognitionMode

public void setRecognitionMode(int recognitionMode)

This method is for debugging and testing purposes only. Please do not use it because calling it with wrong parameter might cause scanning loop to never terminate.

Parameters:

recognitionMode - Mode of recognition. Allowed values are RECOGNITION_MODE (default), RECOGNITION_TEST_MODE (recognition in the loop) and DETECTION_TEST_MODE (detection in the loop, recognition disabled).

shouldAllowMultipleScanResultsOnSingleImage

public boolean shouldAllowMultipleScanResultsOnSingleImage()

Returns true if multiple scan results can be obtained from single image. @see setAllowMultipleScanResultsOnSingleImage for details.

Returns:

true if multiple scan results can be obtained from single image.

setAllowMultipleScanResultsOnSingleImage

public void setAllowMultipleScanResultsOnSingleImage(boolean multiScan)

Sets whether or not outputting of multiple scan results from same image is allowed. If that is true, it is possible to return multiple recognition results from same image. If this option is false, the array of BaseRecognitionResults will contain at most 1 element. The upside of setting that option to false is the speed - if you enable lots of recognizers, as soon as the first recognizer succeeds in scanning, recognition chain will be terminated and other recognizers will not get a chance to analyze the image. The downside is that you are then unable to obtain multiple results from single image.

setNumMsBeforeTimeout

public void setNumMsBeforeTimeout(int numMsBeforeTimeout)

Set the duration in milliseconds that needs to pass since scanning has begun in order to define timeout. Please be aware that time counting does not start from the moment when scanning starts. Instead it starts from the moment when at least one BaseRecognitionResult becomes available which is neither empty (BaseRecognitionResult.isEmpty()) nor valid (BaseRecognitionResult.isValid()).

The reason for this is the better user experience in cases when for example timeout is set to 10 seconds and user starts scanning and leaves device lying on table for 9 seconds and then points the device towards the object it wants to scan: in such case it is better to let that user scan the object it wants instead of completing scan with empty scan result as soon as 10 seconds timeout ticks out.

Parameters:

numMsBeforeTimeout - duration in milliseconds

getNumMsBeforeTimeout

public int getNumMsBeforeTimeout()

Returns the duration in milliseconds that needs to pass since scanning has begun in order to define timeout.

Returns:

the duration in milliseconds that needs to pass since scanning has begun in order to define timeout.

See Also:

setNumMsBeforeTimeout(int)

setFrameQualityEstimationMode

public void setFrameQualityEstimationMode(RecognitionSettings.FrameQualityEstimationMode mode)

Sets the mode of the frame quality estimation. If automatic, it will be used if at least one enabled recognizer requires it or if device is fast enough to perform it always (default). If always on or always off, it will not depend on active recognizers nor device. Frame quality estimation helps choosing the best possible frame from camera stream for processing.

Parameters:

mode - Desired mode of frame quality estimation.

getFrameQualityEstimationMode

public RecognitionSettings.FrameQualityEstimationMode getFrameQualityEstimationMode()

setRecognizerSettingsArray

public void setRecognizerSettingsArray(RecognizerSettings[] settingsArray)

Set recognizer settings array that will be passed to native code.

Parameters:

settingsArray - array of recognizer settings

getRecognizerSettingsArray

public RecognizerSettings[] getRecognizerSettingsArray()

Returns the currently active recognizer settings array

Returns:

the currently active recognizer settings array

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

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

Specified by:

writeToParcel in interface android.os.Parcelable

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object