com.microblink.detectors.quad

Class QuadDetectorResult

java.lang.Object

com.microblink.detectors.DetectorResult

com.microblink.detectors.quad.QuadDetectorResult

All Implemented Interfaces:

android.os.Parcelable

public class QuadDetectorResult
extends DetectorResult

A detector result represented by quadrilateral.

Nested Class Summary

Nested classes/interfaces inherited from class com.microblink.detectors.DetectorResult

DetectorResult.DetectionCode

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<QuadDetectorResult>	CREATOR The parcelable CREATOR
protected Quadrilateral	mDetectionLocation The detection location.
protected Quadrilateral	mDisplayLocation The detection location modified for display in UI

Fields inherited from class com.microblink.detectors.DetectorResult

mDetectionCode, mDetectionStatus, mTransformMatrix

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
QuadDetectorResult(int detectionCode, int detectionStatus, float[] transformMatrix, float[] detectionLocation, float[] displayLocation) Constructor which uses the given parameters to initialize the object.
QuadDetectorResult(android.os.Parcel source) Initializes the object from the given Parcel.

Method Summary

Modifier and Type	Method and Description
Quadrilateral	getDetectionLocation() Returns the location of detection in coordinate system of image on which detection was performed.
Quadrilateral	getDisplayLocation() Returns the display location in coordinate system of image on which detection was performed.
Quadrilateral	getTransformedDetectionLocation() Returns the location of detection in normalized coordinate system of visible camera frame.
Quadrilateral	getTransformedDisplayLocation() Returns the display location in normalized coordinate system of visible camera frame.
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.microblink.detectors.DetectorResult

describeContents, getDetectionCode, getDetectionCodeName, getDetectionCodeOrdinal, getDetectionStatus, setDetectionCode

Methods inherited from class java.lang.Object

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

Field Detail

mDetectionLocation

protected Quadrilateral mDetectionLocation

The detection location.

mDisplayLocation

protected Quadrilateral mDisplayLocation

The detection location modified for display in UI

CREATOR

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

The parcelable CREATOR

Constructor Detail

QuadDetectorResult

public QuadDetectorResult(int detectionCode,
                          int detectionStatus,
                          float[] transformMatrix,
                          float[] detectionLocation,
                          float[] displayLocation)

Constructor which uses the given parameters to initialize the object.

Parameters:

detectionCode - Detection code from native library.

detectionStatus - Detection status from native library.

transformMatrix - Transformation matrix from native library.

detectionLocation - Location of the detection.

QuadDetectorResult

public QuadDetectorResult(android.os.Parcel source)

Initializes the object from the given Parcel.

Parameters:

source - The parcel.

Method Detail

getDetectionLocation

public Quadrilateral getDetectionLocation()

Returns the location of detection in coordinate system of image on which detection was performed.

Returns:

the location of detection in coordinate system of image on which detection was performed.

getTransformedDetectionLocation

public Quadrilateral getTransformedDetectionLocation()

Returns the location of detection in normalized coordinate system of visible camera frame. The normalized coordinate system of visible camera frame is coordinate system whose top left position is at coordinates (0,0), and bottom right is at coordinates (1,1). It is oriented in landscape right orientation.

Returns:

the location of detection in normalized coordinate system of visible camera frame.

getDisplayLocation

public Quadrilateral getDisplayLocation()

Returns the display location in coordinate system of image on which detection was performed. The display location is usually same as detection location returned with getDetectionLocation(), however sometimes it can be different. While detection location is actually used to perform searching of fields that need to be recognised, the display location is usually used for displaying the detection feedback in UI.

Returns:

the display location in coordinate system of image on which detection was performed.

getTransformedDisplayLocation

public Quadrilateral getTransformedDisplayLocation()

Returns the display location in normalized coordinate system of visible camera frame. The normalized coordinate system of visible camera frame is coordinate system whose top left position is at coordinates (0,0), and bottom right is at coordinates (1,1). It is oriented in landscape right orientation. For more information about display location, see getDisplayLocation().

Returns:

the display location in normalized coordinate system of visible camera frame.

writeToParcel

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

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class DetectorResult

toString

public java.lang.String toString()

Overrides:

toString in class DetectorResult