Class InferenceModelConfiguration

Definition

Namespace:: Tizen.Multimedia.Vision

Assembly:: Tizen.Multimedia.Vision.dll

API Level:: 6

Feature:: http://tizen.org/feature/vision.inference.facehttp://tizen.org/feature/vision.inference.image

Represents a configuration of FaceDetector, FacialLandmarkDetector, ImageClassifier and ObjectDetector.


                C#
                
                    Copy
                    
                
            
public class InferenceModelConfiguration : EngineConfiguration, IDisposable

Inheritance: System.Object

EngineConfiguration

InferenceModelConfiguration

Implements: System.IDisposable

Remarks

'Inference model' means pre-learned data, which is represented by ConfigurationFilePath and WeightFilePath, CategoryFilePath.
If user want to use tizen default inference model and its related value, Please refer Tizen guide page(https://developer.tizen.org/development/guides/.net-application).

Constructors

View Source

InferenceModelConfiguration()

Initializes a new instance of the InferenceModelConfiguration class.

Declaration


                C#
                
                    Copy
                    
                
            
public InferenceModelConfiguration()

Exceptions

Type	Condition
System.NotSupportedException	The feature is not supported.

API Level: 6

Feature: http://tizen.org/feature/vision.inference.facehttp://tizen.org/feature/vision.inference.image

Properties

View Source

Backend

Gets or sets the inference model's backend engine.

Declaration


                C#
                
                    Copy
                    
                
            
public InferenceBackendType Backend { get; set; }

Property Value

Type	Description
InferenceBackendType

Remarks

The default backend type is OpenCV

Exceptions

Type	Condition
System.ArgumentException	`value` is not valid.
System.NotSupportedException	The engine type is not supported.

CategoryFilePath

Gets or sets the path of inference model's category file.

Declaration


                C#
                
                    Copy
                    
                
            
public string CategoryFilePath { get; set; }

Property Value

Type	Description
System.String

Remarks

This value should be set to use ImageClassifier or ObjectDetector.

Exceptions

Type	Condition
System.ArgumentNullException	Input file path is null.

API Level: 6

View Source

ConfidenceThreshold

Gets or sets the threshold of confidence.

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API9. Will be removed in API11. Please use MetadataFilePath instead.")]
public double ConfidenceThreshold { get; set; }

Property Value

Type	Description
System.Double

Remarks

The vaild range is greater than or equal to 0.0 and less than or equal to 1.0.
The value 1.0 means maximum accuracy.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	`value`is out of range.

API Level: 6

View Source

ConfigurationFilePath

Gets or sets the path of inference model's configuration data file.

Declaration


                C#
                
                    Copy
                    
                
            
public string ConfigurationFilePath { get; set; }

Property Value

Type	Description
System.String

Exceptions

Type	Condition
System.ArgumentNullException	Input file path is null.

API Level: 6

View Source

DataType

Gets or sets the type of data used for inference model.

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API9. Will be removed in API11. Please use MetadataFilePath instead.")]
public InferenceDataType DataType { get; set; }

Property Value

Type	Description
InferenceDataType

Remarks

For example, this value should be set to Float32 for a model data supporting float32.
Float32 will be used internally if a user doesn't set the value.

Exceptions

Type	Condition
System.ArgumentException	`value` is not valid.

API Level: 8

View Source

Device

Gets or sets the processor type for inference models.

Declaration


                C#
                
                    Copy
                    
                
            
public InferenceTargetDevice Device { get; set; }

Property Value

Type	Description
InferenceTargetDevice

Remarks

The default device is CPU.
If a device doesn't support GPU and Custom, CPU will be used internally, despite the user's choice.

Exceptions

Type	Condition
System.ArgumentException	`value` is not valid.

API Level: 8

View Source

InputNodeName

Gets or sets the name of an input node

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API9. Will be removed in API11. Please use MetadataFilePath instead.")]
public string InputNodeName { get; set; }

Property Value

Type	Description
System.String

Exceptions

Type	Condition
System.ArgumentNullException	`value` is null.

API Level: 6

View Source

MaxOutputNumber

Gets or sets the maximum output number of detection or classification.

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API9. Will be removed in API11. Please use MetadataFilePath instead.")]
public int MaxOutputNumber { get; set; }

Property Value

Type	Description
Int32

Remarks

The input value over 10 will be set to 10 and the input value under 1 will be set to 1.
This value can be used to decide the size of Roi, it's length should be the same.

API Level: 6

View Source

MeanValue

Gets or sets the inference model's mean value.

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API9. Will be removed in API11. Please use MetadataFilePath instead.")]
public double MeanValue { get; set; }

Property Value

Type	Description
System.Double

Remarks

It should be greater than or equal to 0.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	The value is invalid.

API Level: 6

View Source

MetadataFilePath

Gets or sets the path of inference model's metadata file.

Declaration


                C#
                
                    Copy
                    
                
            
public string MetadataFilePath { get; set; }

Property Value

Type	Description
System.String

Remarks

This value should be set to use ImageClassifier or ObjectDetector.

Exceptions

Type	Condition
System.ArgumentNullException	Metadata file path is null.

API Level: 9

View Source

OutputNodeName

Gets or sets the name of an output node

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API9. Will be removed in API11. Please use MetadataFilePath instead.")]
public IList<string> OutputNodeName { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Exceptions

Type	Condition
System.ArgumentNullException	`value` is null.

API Level: 6

View Source

Roi

Gets or sets the ROI(Region Of Interest) of ImageClassifier and FacialLandmarkDetector

Declaration


                C#
                
                    Copy
                    
                
            
public Rectangle? Roi { get; set; }

Property Value

Type	Description
System.Nullable<Rectangle>

Remarks

Default value is null. If Roi is null, the entire region of MediaVisionSource will be analyzed.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	The width of `value` is less than or equal to zero. -or- The height of `value` is less than or equal to zero. -or- The x position of `value` is less than zero. -or- The y position of `value` is less than zero.

StdValue

Gets or sets the inference model's STD(Standard deviation) value.

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API9. Will be removed in API11. Please use MetadataFilePath instead.")]
public double StdValue { get; set; }

Property Value

Type	Description
System.Double

Remarks

It should be greater than or equal to 0.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	The value is invalid.

API Level: 6

View Source

SupportedBackend

Gets the list of inference backend engine which is supported in the current device.

Declaration


                C#
                
                    Copy
                    
                
            
public IEnumerable<InferenceBackendType> SupportedBackend { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<InferenceBackendType>	If there's no supported backend, empty collection will be returned.

API Level: 6

View Source

Target

Gets or sets the inference model's target.

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API8. Will be removed in API10. Please use Device instead.")]
public InferenceTargetType Target { get; set; }

Property Value

Type	Description
InferenceTargetType

Remarks

The default target is CPU.
If target doesn't support GPU and Custom, CPU will be used internally, despite the user's choice.

Exceptions

Type	Condition
System.ArgumentException	`value` is not valid.

API Level: 6

View Source

TensorChannels

Gets or sets the number of inference model's tensor channel.

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API9. Will be removed in API11. Please use MetadataFilePath instead.")]
public int TensorChannels { get; set; }

Property Value

Type	Description
Int32

Remarks

For example, for RGB colorspace this value should be set to 3
It should be greater than 0.

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	The value is invalid.

API Level: 6

View Source

TensorSize

Gets or sets the size of inference model's tensor.

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated since API9. Will be removed in API11. Please use MetadataFilePath instead.")]
public Size TensorSize { get; set; }

Property Value

Type	Description
Size

Remarks

Both width and height of tensor should be greater than 0.
'Size(-1, -1) is allowed when the intention is to use original image source size as TensorSize.

Exceptions

Type	Condition
System.ArgumentException	Only one of `value.Width.Width` or `value.Height.Height` have -1.
System.ArgumentOutOfRangeException	The value is invalid.

API Level: 6

View Source

WeightFilePath

Gets or sets the path of inference model's weight file.

Declaration


                C#
                
                    Copy
                    
                
            
public string WeightFilePath { get; set; }

Property Value

Type	Description
System.String

Exceptions

Type	Condition
System.ArgumentNullException	Input file path is null.

API Level: 6

Methods

View Source

Dispose(Boolean)

Releases the resources used by the InferenceModelConfiguration object.

Declaration


                C#
                
                    Copy
                    
                
            
protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
Boolean	disposing	true to release both managed and unmanaged resources, otherwise false to release only unmanaged resources.

Overrides

EngineConfiguration.Dispose(Boolean)

API Level: 6

View Source

LoadInferenceModel()

Loads inference model data and its related attributes.

Declaration


                C#
                
                    Copy
                    
                
            
public void LoadInferenceModel()

Remarks

Before calling this method, user should set all properties which is required by each inference model.
The properties set after calling this method will not be affected in the result.

Exceptions

Type	Condition
System.IO.FileNotFoundException	ConfigurationFilePath, WeightFilePath or CategoryFilePath have invalid path.
FileFormatException	Invalid data type is used in inference model data.
System.IO.InvalidDataException	Inference model data contains unsupported operations in current backend version. -or- Invalid data type is used in inference model data.
System.InvalidOperationException	Internal operation error.
UnauthorizedAccessException	The caller has no required privilege.

API Level: 6

Privilege Level: public

Privilege: http://tizen.org/privilege/mediastoragehttp://tizen.org/privilege/externalstorage

Feature: http://tizen.org/feature/vision.inference.facehttp://tizen.org/feature/vision.inference.image

Implements

System.IDisposable

Class InferenceModelConfiguration

Definition

Remarks

Constructors

InferenceModelConfiguration()

Declaration

Exceptions

API Level: 6

Feature: http://tizen.org/feature/vision.inference.facehttp://tizen.org/feature/vision.inference.image

Properties

Backend

Declaration

Property Value

Remarks

Exceptions

See Also

API Level: 6

CategoryFilePath

Declaration

Property Value

Remarks

Exceptions

API Level: 6

ConfidenceThreshold

Declaration

Property Value

Remarks

Exceptions

API Level: 6

ConfigurationFilePath

Declaration

Property Value

Exceptions

API Level: 6

DataType

Declaration

Property Value

Remarks

Exceptions

API Level: 8

Device

Declaration

Property Value

Remarks

Exceptions

API Level: 8

InputNodeName

Declaration

Property Value

Exceptions

API Level: 6

MaxOutputNumber

Declaration

Property Value

Remarks

API Level: 6

MeanValue

Declaration

Property Value

Remarks

Exceptions

API Level: 6

MetadataFilePath

Declaration

Property Value

Remarks

Exceptions

API Level: 9

OutputNodeName

Declaration

Property Value

Exceptions

API Level: 6

Roi

Declaration

Property Value

Remarks

Exceptions

See Also

API Level: 6