RecognitionParams (anpr-sdk API)

java.lang.Object
- com.sdtoolkit.anpr.api.RecognitionParams

All Implemented Interfaces:

android.os.Parcelable, java.lang.Cloneable
```
public class RecognitionParams
extends java.lang.Object
implements android.os.Parcelable, java.lang.Cloneable
```
ANPR Engine parameters used to pre-configure recognition.

Nested Class Summary
- 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<RecognitionParams> CREATOR

static int VERSION
- Fields inherited from interface android.os.Parcelable
  CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Fields
Modifier and Type	Field and Description
`static android.os.Parcelable.Creator<RecognitionParams>`	`CREATOR`
`static int`	`VERSION`

Constructor Summary

Constructors
Constructor and Description

RecognitionParams()

Constructors
Constructor and Description
`RecognitionParams()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`copyFrom(RecognitionParams src)`
`int`	`describeContents()`
`android.graphics.RectF`	`getRelScanArea()` Returns manual landscape oriented scan area used to limit recognition overload.
`android.graphics.Rect`	`getScanArea()` Deprecated.
`Container<java.lang.Boolean>`	`propAcceptLowConfidenceResults()` Accept Low Confidence Results Property.
`Container<java.lang.Boolean>`	`propAutoCountryCode()` Automatic Country Code property.
`Container<java.lang.Boolean>`	`propBroadcastResults()` Broadcast Results property.
`Container<java.lang.String>`	`propCountryCode()` Country Code property.
`Container<java.lang.Integer>`	`propDuplicateResultsLockTimeSec()` Ignore duplicated result time property.
`Container<java.util.HashSet<java.lang.String>>`	`propNeighbourCountryCodes()` Neighbour countries Codes property.
`Container<java.lang.Integer>`	`propScanAreaBottom()` Deprecated.
`Container<java.lang.Integer>`	`propScanAreaLeft()` Deprecated.
`Container<java.lang.Integer>`	`propScanAreaRight()` Deprecated.
`Container<java.lang.Integer>`	`propScanAreaTop()` Deprecated.
`Container<java.lang.Boolean>`	`propStoreRecognitionResults()` Store Results Property.
`void`	`readFromParcel(android.os.Parcel source)`
`void`	`setRelScanArea(android.graphics.RectF scanArea)` Sets relative manual scan area used to limit recognition overload.
`void`	`setScanArea(android.graphics.Rect scanArea)` Deprecated.
`void`	`writeToParcel(android.os.Parcel dest, int flags)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - VERSION
```
public static final int VERSION
```
    See Also:
    
    Constant Field Values
  - CREATOR
```
public static final android.os.Parcelable.Creator<RecognitionParams> CREATOR
```
- Constructor Detail
  - RecognitionParams
```
public RecognitionParams()
```
- Method Detail
  - copyFrom
```
public void copyFrom(RecognitionParams src)
```
  - readFromParcel
```
public void readFromParcel(android.os.Parcel source)
```
  - 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
  - propCountryCode
```
public Container<java.lang.String> propCountryCode()
```
    Country Code property. Two symbols ISO3166-2 country code. This is one of major properties used by recognition engine to optimize recognition parameters and to validate recognition results against country-specific licnese plate formats. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value
  - propAutoCountryCode
```
public Container<java.lang.Boolean> propAutoCountryCode()
```
    Automatic Country Code property. When set to true, Anpr Engine will try to determine country code from current geolocation information. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value
  - propScanAreaLeft
```
@Deprecated
public Container<java.lang.Integer> propScanAreaLeft()
```
    Deprecated.
    
    Scan Area left boundary property in pixels. Set it to non-negative value to limit active recognition area from the left. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value
  - propScanAreaTop
```
@Deprecated
public Container<java.lang.Integer> propScanAreaTop()
```
    Deprecated.
    
    Scan Area top boundary property in pixels. Set it to non-negative value to limit active recognition area from the top. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value
  - propScanAreaRight
```
@Deprecated
public Container<java.lang.Integer> propScanAreaRight()
```
    Deprecated.
    
    Scan Area right boundary property in pixels. Set it to non-negative value to limit active recognition area from the right. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value
  - propScanAreaBottom
```
@Deprecated
public Container<java.lang.Integer> propScanAreaBottom()
```
    Deprecated.
    
    Scan Area bottom boundary property in pixels. Set it to non-negative value to limit active recognition area from the bottom. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value
  - getScanArea
```
@Deprecated
public android.graphics.Rect getScanArea()
```
    Deprecated.
    
    Returns manual landscape oriented scan area used to limit recognition overload. Only objects within Scan Area will be processed by the recognition engine. Scan Area is set in pixels starting from left top corner as if video source orientation is landscape. For example, capturing camera in portrait at HD resolution (1080 x 1280) you still have to specify scan rectangle for landscape 1280 x 1080, as: Left = 100, Top = 100, Right = 1180, Bottom = 980
    
    Returns:
    
    area rectangel
  - setScanArea
```
@Deprecated
public void setScanArea(android.graphics.Rect scanArea)
```
    Deprecated.
    
    Sets Manual landscape oriented scan area used to limit recognition overload. Only objects within Scan Area will be processed by the recognition engine. Scan Area is set in pixels starting from left top corner as if video source orientation is landscape. For example, capturing camera in portrait at HD resolution (1080 x 1280) you still have to specify scan rectangle for landscape 1280 x 1080, for example: Left = 100, Top = 100, Right = 1180, Bottom = 980
    
    Parameters:
    
    scanArea - area rectangel
  - propDuplicateResultsLockTimeSec
```
public Container<java.lang.Integer> propDuplicateResultsLockTimeSec()
```
    Ignore duplicated result time property. Specify how long should be the time interval before reporting again the same recognition result. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value
  - propNeighbourCountryCodes
```
public Container<java.util.HashSet<java.lang.String>> propNeighbourCountryCodes()
```
    Neighbour countries Codes property. Specify neighbour countries codes as a comma separated list. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance
  - propBroadcastResults
```
public Container<java.lang.Boolean> propBroadcastResults()
```
    Broadcast Results property. When set to true each recognition result will be sent as a broadcast intent. Default value: true. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value
  - getRelScanArea
```
public android.graphics.RectF getRelScanArea()
```
    Returns manual landscape oriented scan area used to limit recognition overload. Only objects within Scan Area will be processed by the recognition engine. Relative Scan Area coordinates are measured in diapason form 0.0 to 1.0
    
    Returns:
    
    area rectangle
  - setRelScanArea
```
public void setRelScanArea(android.graphics.RectF scanArea)
```
    Sets relative manual scan area used to limit recognition overload. Only objects within Scan Area will be processed by the recognition engine. Relative Scan Area specifies value for left and right boundaries relative to input width and top bottom values are set relative to image height. Minimal value is 0.0f, Maximal - 1.0f
    
    Parameters:
    
    scanArea - area rectangle
  - propStoreRecognitionResults
```
public Container<java.lang.Boolean> propStoreRecognitionResults()
```
    Store Results Property. When set to true each recognition result will be stored in Results Content Provider. Default value: true. Set to false to disable results storage. This will minimize recognition time. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value
  - propAcceptLowConfidenceResults
```
public Container<java.lang.Boolean> propAcceptLowConfidenceResults()
```
    Accept Low Confidence Results Property. When set to false recognition results with low confidence < 0.8 will be ignored and either not reported nor stored in the Content Provider. Use Container.set(Object) to set new value and Container.value() } to read current value of the property
    
    Returns:
    
    reference to Container instance holding corresponding property value

Class RecognitionParams

Nested Class Summary

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

Field Summary

Fields inherited from interface android.os.Parcelable

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

CREATOR

Constructor Detail

RecognitionParams

Method Detail

copyFrom

readFromParcel

describeContents

writeToParcel

propCountryCode

propAutoCountryCode

propScanAreaLeft

propScanAreaTop

propScanAreaRight

propScanAreaBottom

getScanArea

setScanArea

propDuplicateResultsLockTimeSec

propNeighbourCountryCodes

propBroadcastResults

getRelScanArea

setRelScanArea

propStoreRecognitionResults

propAcceptLowConfidenceResults