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.


                C#
                
                    Copy
                    
                
            
public class ImageRecognitionConfiguration : EngineConfiguration, IDisposable

Inheritance: System.Object

EngineConfiguration

ImageRecognitionConfiguration

Derived: ImageTrackingConfiguration

ImageTrackingConfiguration

Implements: System.IDisposable

Constructors

View Source

ImageRecognitionConfiguration()

Initializes a new instance of the ImageRecognitionConfiguration class.

Declaration


                C#
                
                    Copy
                    
                
            
public ImageRecognitionConfiguration()

Exceptions

Type	Condition
System.NotSupportedException	The feature is not supported.

API Level: 4

Fields

View Source

DefaultMinKeyPointMatches

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

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly int DefaultMinKeyPointMatches

Field Value

Type	Description
Int32

API Level: 4

View Source

DefaultRequiredMatchPart

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

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly double DefaultRequiredMatchPart

Field Value

Type	Description
System.Double

API Level: 4

View Source

DefaultSceneMaxKeypoints

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

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly int DefaultSceneMaxKeypoints

Field Value

Type	Description
Int32

API Level: 4

View Source

DefaultSceneScaleFactor

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

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly double DefaultSceneScaleFactor

Field Value

Type	Description
System.Double

API Level: 4

View Source

DefaultTolerantPartMatchError

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

Declaration


                C#
                
                    Copy
                    
                
            
public static readonly double DefaultTolerantPartMatchError

Field Value

Type	Description
System.Double

API Level: 4

Properties

View Source

MinKeyPointMatches

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

Declaration


                C#
                
                    Copy
                    
                
            
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.
System.ArgumentOutOfRangeException	`value` is less than zero.

API Level: 4

View Source

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


                C#
                
                    Copy
                    
                
            
public double RequiredMatchingPart { get; set; }

Property Value

Type	Description
System.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.
System.ArgumentOutOfRangeException	`value` is less than zero. -or- `value` is greater than one.

API Level: 4

View Source

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


                C#
                
                    Copy
                    
                
            
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.
System.ArgumentOutOfRangeException	`value` is less than zero.

API Level: 4

View Source

SceneScaleFactor

Gets or sets the scene scale factor.

Declaration


                C#
                
                    Copy
                    
                
            
public double SceneScaleFactor { get; set; }

Property Value

Type	Description
System.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

View Source

TolerantPartMatchError

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

Declaration


                C#
                
                    Copy
                    
                
            
public double TolerantPartMatchError { get; set; }

Property Value

Type	Description
System.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.
System.ArgumentOutOfRangeException	`value` is less than zero. -or- `value` is greater than one.

API Level: 4

Implements

System.IDisposable