Class ImageObject
Definition
- Namespace:
- Tizen.Multimedia.Vision
- Assembly:
- Tizen.Multimedia.Vision.dll
Represents an image object.
public class ImageObject : IDisposable
- Inheritance
-
objectImageObject
- Implements
-
System.IDisposable
Constructors
View SourceImageObject()
Initializes a new instance of the ImageObject class.
Declaration
public ImageObject()
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The feature is not supported. |
ImageObject(string)
Initializes a new instance of the ImageObject class from the specified file.
Declaration
public ImageObject(string path)
Parameters
Type | Name | Description |
---|---|---|
string | path | Path to the image object to load. |
Remarks
ImageObject has been saved by Save(string) can be loaded.
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.IO.FileNotFoundException |
|
System.NotSupportedException | The feature is not supported. |
System.UnauthorizedAccessException | No permission to access the specified file. |
See Also
Properties
View SourceRecognitionRate
Gets a value that determines how well an image object can be recognized.
Declaration
public double RecognitionRate { get; }
Property Value
Type | Description |
---|---|
double | Recognition rate determines how well an image object can be recognized. This value can be from 0 to 1. If the recognition rate is 0 object can not be recognized and the bigger it is the more likely to recognize the object. |
Remarks
If recognition rate is too low, try to use another image or change some configuration parameters and fill the image object again.
Exceptions
Type | Condition |
---|---|
System.ObjectDisposedException | The ImageObject has already been disposed of. |
See Also
Methods
View SourceDispose()
Releases all the resources used by the ImageObject object.
Declaration
public void Dispose()
Dispose(bool)
Releases the resources used by the ImageObject object.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources. |
Fill(MediaVisionSource, Rectangle)
Fills the image object.
Extracts data from source image which will be needed for recognition of depicted object
in location.
Declaration
public void Fill(MediaVisionSource source, Rectangle rect)
Parameters
Type | Name | Description |
---|---|---|
MediaVisionSource | source | The source image where image object is depicted. |
Rectangle | rect | Rectangular bound of the image object on the source image. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.ObjectDisposedException | The ImageObject has already been disposed of. |
Fill(MediaVisionSource, ImageFillConfiguration, Rectangle)
Fills the image object.
Extracts data from source image which will be needed for recognition of depicted object
in location.
Declaration
public void Fill(MediaVisionSource source, ImageFillConfiguration config, Rectangle rect)
Parameters
Type | Name | Description |
---|---|---|
MediaVisionSource | source | The source image where image object is depicted. |
ImageFillConfiguration | config | The configuration used for extract recognition data from source. This value can be null. |
Rectangle | rect | Rectangular bound of the image object on the source image. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.ObjectDisposedException | The ImageObject has already been disposed of. |
Fill(MediaVisionSource, ImageFillConfiguration)
Fills the image object.
Extracts data from source image which will be needed for recognition of depicted object.
Declaration
public void Fill(MediaVisionSource source, ImageFillConfiguration config)
Parameters
Type | Name | Description |
---|---|---|
MediaVisionSource | source | The source image where image object is depicted. |
ImageFillConfiguration | config | The configuration used for extract recognition data from source. This value can be null. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.ObjectDisposedException | The ImageObject has already been disposed of. |
Fill(MediaVisionSource)
Fills the image object.
Extracts data from source image which will be needed for recognition of depicted object.
Declaration
public void Fill(MediaVisionSource source)
Parameters
Type | Name | Description |
---|---|---|
MediaVisionSource | source | The source image where image object is depicted. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.ObjectDisposedException | The ImageObject has already been disposed of. |
~ImageObject()
Finalizes an instance of the ImageObject class.
Declaration
protected ~ImageObject()
GetLabel()
Gets the label for the image object.
Declaration
public int? GetLabel()
Returns
Type | Description |
---|---|
int? | The label value if the ImageObject has label, otherwise null. |
Exceptions
Type | Condition |
---|---|
System.ObjectDisposedException | The ImageObject has already been disposed of. |
See Also
View SourceSave(string)
Saves the image object.
Declaration
public void Save(string path)
Parameters
Type | Name | Description |
---|---|---|
string | path | Path to the file to save the model. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException |
|
System.UnauthorizedAccessException | No permission to write to the specified path. |
System.ObjectDisposedException | The ImageObject has already been disposed of. |
System.IO.DirectoryNotFoundException | The directory for |
SetLabel(int)
Sets the label for the ImageObject.
Declaration
public void SetLabel(int label)
Parameters
Type | Name | Description |
---|---|---|
int | label | The label which will be assigned to the image object. |