/
ImageObject.cs
executable file
·309 lines (281 loc) · 12.3 KB
/
ImageObject.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
/*
* Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.IO;
using InteropImage = Interop.MediaVision.Image;
namespace Tizen.Multimedia.Vision
{
/// <summary>
/// Represents an image object.
/// </summary>
/// <feature>http://tizen.org/feature/vision.image_recognition</feature>
/// <since_tizen> 4 </since_tizen>
public class ImageObject : IDisposable
{
private IntPtr _handle = IntPtr.Zero;
private bool _disposed = false;
/// <summary>
/// Initializes a new instance of the <see cref="ImageObject"/> class.
/// </summary>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <since_tizen> 4 </since_tizen>
public ImageObject()
{
InteropImage.Create(out _handle).Validate("Failed to create image object");
}
/// <summary>
/// Initializes a new instance of the <see cref="ImageObject"/> class from the specified file.
/// </summary>
/// <remarks>
/// ImageObject has been saved by <see cref="Save(string)"/> can be loaded.
/// </remarks>
/// <param name="path">Path to the image object to load.</param>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// <exception cref="FileNotFoundException"><paramref name="path"/> is invalid.</exception>
/// <exception cref="NotSupportedException">
/// The feature is not supported.<br/>
/// -or-<br/>
/// <paramref name="path"/> is not supported file.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
/// <seealso cref="Save(string)"/>
/// <since_tizen> 4 </since_tizen>
public ImageObject(string path)
{
if (path == null)
{
throw new ArgumentNullException(nameof(path));
}
InteropImage.Load(path, out _handle).Validate("Failed to load image object from file");
}
/// <summary>
/// Finalizes an instance of the ImageObject class.
/// </summary>
~ImageObject()
{
Dispose(false);
}
/// <summary>
/// Gets a value that determines how well an image object can be recognized.
/// </summary>
/// <remarks>
/// If recognition rate is too low, try to use another image or change some configuration parameters
/// and fill the image object again.
/// </remarks>
/// <value>
/// 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.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageObject"/> has already been disposed of.</exception>
/// <seealso cref="ImageFillConfiguration"/>
/// <seealso cref="Fill(MediaVisionSource)"/>
/// <seealso cref="Fill(MediaVisionSource, ImageFillConfiguration)"/>
/// <seealso cref="Fill(MediaVisionSource, Rectangle)"/>
/// <seealso cref="Fill(MediaVisionSource, ImageFillConfiguration, Rectangle)"/>
/// <since_tizen> 4 </since_tizen>
public double RecognitionRate
{
get
{
InteropImage.GetRecognitionRate(Handle, out var rate).Validate("Failed to get recognition rate");
return rate;
}
}
#region Methods
/// <summary>
/// Gets the label for the image object.
/// </summary>
/// <returns>
/// The label value if the <see cref="ImageObject"/> has label, otherwise null.
/// </returns>
/// <exception cref="ObjectDisposedException">The <see cref="ImageObject"/> has already been disposed of.</exception>
/// <seealso cref="SetLabel(int)"/>
/// <since_tizen> 4 </since_tizen>
public int? GetLabel()
{
var ret = InteropImage.GetLabel(Handle, out var label);
if (ret == MediaVisionError.NoData)
{
return null;
}
ret.Validate("Failed to get label");
return label;
}
/// <summary>
/// Sets the label for the <see cref="ImageObject"/>.
/// </summary>
/// <param name="label">The label which will be assigned to the image object.</param>
/// <seealso cref="GetLabel"/>
/// <since_tizen> 4 </since_tizen>
public void SetLabel(int label)
{
InteropImage.SetLabel(Handle, label).Validate("Failed to set label");
}
/// <summary>
/// Fills the image object.<br/>
/// Extracts data from source image which will be needed for recognition of depicted object.
/// </summary>
/// <param name="source">The source image where image object is depicted.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
/// The <see cref="ImageObject"/> has already been disposed of.<br/>
/// -or-<br/>
/// <paramref name="source"/> has already been disposed of.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public void Fill(MediaVisionSource source)
{
InvokeFill(source, null, null);
}
/// <summary>
/// Fills the image object.<br/>
/// Extracts data from source image which will be needed for recognition of depicted object.
/// </summary>
/// <param name="source">The source image where image object is depicted.</param>
/// <param name="config">The configuration used for extract recognition data from source. This value can be null.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
/// The <see cref="ImageObject"/> has already been disposed of.<br/>
/// -or-<br/>
/// <paramref name="source"/> has already been disposed of.<br/>
/// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public void Fill(MediaVisionSource source, ImageFillConfiguration config)
{
InvokeFill(source, config, null);
}
/// <summary>
/// Fills the image object.<br/>
/// Extracts data from source image which will be needed for recognition of depicted object
/// in location.
/// </summary>
/// <param name="source">The source image where image object is depicted.</param>
/// <param name="rect">Rectangular bound of the image object on the source image.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
/// The <see cref="ImageObject"/> has already been disposed of.<br/>
/// -or-<br/>
/// <paramref name="source"/> has already been disposed of.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public void Fill(MediaVisionSource source, Rectangle rect)
{
InvokeFill(source, null, rect);
}
/// <summary>
/// Fills the image object.<br/>
/// Extracts data from source image which will be needed for recognition of depicted object
/// in location.
/// </summary>
/// <param name="source">The source image where image object is depicted.</param>
/// <param name="config">The configuration used for extract recognition data from source. This value can be null.</param>
/// <param name="rect">Rectangular bound of the image object on the source image.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
/// The <see cref="ImageObject"/> has already been disposed of.<br/>
/// -or-<br/>
/// <paramref name="source"/> has already been disposed of.<br/>
/// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <since_tizen> 4 </since_tizen>
public void Fill(MediaVisionSource source, ImageFillConfiguration config, Rectangle rect)
{
InvokeFill(source, config, rect);
}
private MediaVisionError InvokeFill(IntPtr source, IntPtr config, Rectangle? area)
{
if (area == null)
{
return InteropImage.Fill(Handle, config, source, IntPtr.Zero);
}
var rect = area.Value.ToMarshalable();
return InteropImage.Fill(Handle, config, source, ref rect);
}
private void InvokeFill(MediaVisionSource source, ImageFillConfiguration config, Rectangle? area)
{
if (source == null)
{
throw new ArgumentNullException(nameof(source));
}
InvokeFill(source.Handle, EngineConfiguration.GetHandle(config), area).
Validate("Failed to fill the image object");
}
/// <summary>
/// Saves the image object.
/// </summary>
/// <param name="path">Path to the file to save the model.</param>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// <exception cref="UnauthorizedAccessException">No permission to write to the specified path.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="ImageObject"/> has already been disposed of.</exception>
/// <exception cref="DirectoryNotFoundException">The directory for <paramref name="path"/> does not exist.</exception>
/// <since_tizen> 4 </since_tizen>
public void Save(string path)
{
if (path == null)
{
throw new ArgumentNullException(nameof(path));
}
var ret = InteropImage.Save(path, Handle);
if (ret == MediaVisionError.InvalidPath)
{
throw new DirectoryNotFoundException($"The directory for the path({path}) does not exist.");
}
ret.Validate("Failed to save the image object");
}
#endregion
#region IDisposable-support
/// <summary>
/// Releases all the resources used by the <see cref="ImageObject"/> object.
/// </summary>
/// <since_tizen> 4 </since_tizen>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>
/// Releases the resources used by the <see cref="ImageObject"/> object.
/// </summary>
/// <param name="disposing">
/// true to release both managed and unmanaged resources; otherwise false to release only unmanaged resources.
/// </param>
/// <since_tizen> 4 </since_tizen>
protected virtual void Dispose(bool disposing)
{
if (_disposed)
{
return;
}
InteropImage.Destroy(_handle);
_disposed = true;
}
internal IntPtr Handle
{
get
{
if (_disposed)
{
throw new ObjectDisposedException(nameof(ImageObject));
}
return _handle;
}
}
#endregion
}
}