f702d6fc022554be436e00b1e55b4fba51812b9f
[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia / MediaVision / FaceRecognitionResult.cs
1 /*
2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
3  *
4  * Licensed under the Apache License, Version 2.0 (the License);
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an AS IS BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 namespace Tizen.Multimedia
18 {
19     /// <summary>
20     /// This class represents result of face recognition operation.
21     /// </summary>
22     public class FaceRecognitionResult
23     {
24         internal FaceRecognitionResult()
25         {
26         }
27
28         /// <summary>
29         /// Gets the label of the recognized face.
30         /// </summary>
31         public int Label { get; internal set; }
32
33         /// <summary>
34         /// Gets the location of the recognized face.
35         /// </summary>
36         public Rectangle Location { get; internal set; }
37
38         /// <summary>
39         /// The confidence of the recognition_model that face has been recognized correctly (value from 0.0 to 1.0).
40         /// No faces were recognized if confidence was 0.0. When model has been learned on large amount of examples,
41         /// threshold for this value can be high (0.85-0.95). If model was learned for small amount of examples,
42         /// then threshold can be reduced (0.5-0.85).
43         /// </summary>
44         public double Confidence { get; internal set; }
45     }
46 }