Class ImageRecognitionConfiguration

Definition

Namespace:

Tizen.Multimedia.Vision

Assembly:

Tizen.Multimedia.Vision.dll

API Level:

4

Feature:

http://tizen.org/feature/vision.image_recognition

Represents a configuration of ImageRecognizer.

public class ImageRecognitionConfiguration : EngineConfiguration, IDisposable

Inheritance

Object

EngineConfiguration

ImageRecognitionConfiguration

Derived

ImageTrackingConfiguration

ImageTrackingConfiguration

Implements

IDisposable

Constructors

ImageRecognitionConfiguration()

Initializes a new instance of the ImageRecognitionConfiguration class.

Declaration

public ImageRecognitionConfiguration()

Exceptions

Type	Condition
NotSupportedException	The feature is not supported.

API Level: 4

Fields

DefaultMinKeyPointMatches

A read-only field that represents the default value of MinKeyPointMatches.

Declaration

public static readonly int DefaultMinKeyPointMatches

Field Value

Type	Description
Int32

API Level: 4

DefaultRequiredMatchPart

A read-only field that represents the default value of RequiredMatchingPart.

Declaration

public static readonly double DefaultRequiredMatchPart

Field Value

Type	Description
Double

API Level: 4

DefaultSceneMaxKeypoints

A read-only field that represents the default value of SceneMaxKeyPoints.

Declaration

public static readonly int DefaultSceneMaxKeypoints

Field Value

Type	Description
Int32

API Level: 4

DefaultSceneScaleFactor

A read-only field that represents the default value of SceneScaleFactor.

Declaration

public static readonly double DefaultSceneScaleFactor

Field Value

Type	Description
Double

API Level: 4

DefaultTolerantPartMatchError

A read-only field that represents the default value of TolerantPartMatchError.

Declaration

public static readonly double DefaultTolerantPartMatchError

Field Value

Type	Description
Double

API Level: 4

Properties

MinKeyPointMatches

Gets or sets the minimum number of key points matches required for recognition.

Declaration

public int MinKeyPointMatches { get; set; }

Property Value

Type	Description
Int32	The minimal number of key points should be matched between an image and a scene for image objects recognition. The default is 30.

Exceptions

Type	Condition
ObjectDisposedException	The ImageRecognitionConfiguration already has been disposed of.
ArgumentOutOfRangeException	value is less than zero.

API Level: 4

RequiredMatchingPart

Gets or sets the required matching part for the image recognition. To recognize occluded or hidden an image by other images, required relative part of the matches in respect to the total amount of matching keypoints required for image recognition. Too low value will result in unsustainable behavior, but the effect of object overlapping will be reduced.

Declaration

public double RequiredMatchingPart { get; set; }

Property Value

Type	Description
Double	The value indicating required relative part of the matches; can be from 0 to 1, inclusive. The default is 0.05.

Exceptions

Type	Condition
ObjectDisposedException	The ImageRecognitionConfiguration already has been disposed of.
ArgumentOutOfRangeException	value is less than zero. -or- value is greater than one.

API Level: 4

SceneMaxKeyPoints

Gets or sets the maximum key points that should be detected on the scene. The maximal number of key points can be selected on the scene including the images (objects) to calculate descriptors.

Declaration

public int SceneMaxKeyPoints { get; set; }

Property Value

Type	Description
Int32	The maximal key points for image recognition. The default is 5000.

Exceptions

Type	Condition
ObjectDisposedException	The ImageRecognitionConfiguration already has been disposed of.
ArgumentOutOfRangeException	value is less than zero.

API Level: 4

SceneScaleFactor

Gets or sets the scene scale factor.

Declaration

public double SceneScaleFactor { get; set; }

Property Value

Type	Description
Double	The value indicating the factor will be used for resizing of the scene including the images (objects) for recognition. The default is 1.2.

Exceptions

Type	Condition
ObjectDisposedException	The ImageRecognitionConfiguration already has been disposed of.

API Level: 4

TolerantPartMatchError

Gets or sets the part matching error for the image recognition.
Allowable error of matches number.

Declaration

public double TolerantPartMatchError { get; set; }

Property Value

Type	Description
Double	The value indicating allowable error of matches; can be from 0 to 1, inclusive. The default is 0.1.

Exceptions

Type	Condition
ObjectDisposedException	The ImageRecognitionConfiguration already has been disposed of.
ArgumentOutOfRangeException	value is less than zero. -or- value is greater than one.

API Level: 4

Implements

System.IDisposable