src/Tizen.Multimedia.Vision/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     /// Represents result of <see cref="FaceRecognizer"/> operations.
  21     /// </summary>
  22     /// <since_tizen> 3</since_tizen>
  23     public class FaceRecognitionResult
  24     {
  25         internal FaceRecognitionResult(bool recognized, double confidence, int label, Rectangle? area)
  26         {
  27             Success = recognized;
  28             Label = label;
  29             Area = area;
  30             Confidence = confidence;
  31         }
  32
  33         /// <summary>
  34         /// Gets the value indicating the recognition is successful.
  35         /// </summary>
  36         /// <since_tizen> 3</since_tizen>
  37         public bool Success { get; }
  38
  39         /// <summary>
  40         /// Gets the label of the recognized face.
  41         /// </summary>
  42         /// <since_tizen> 3</since_tizen>
  43         public int Label { get; }
  44
  45         /// <summary>
  46         /// Gets the location of the recognized face.
  47         /// </summary>
  48         /// <since_tizen> 3</since_tizen>
  49         public Rectangle? Area { get; }
  50
  51         /// <summary>
  52         /// The confidence of the recognition model that face has been recognized correctly (value from 0.0 to 1.0).
  53         /// No faces were recognized if confidence was 0.0. When model has been learned on large amount of examples,
  54         /// threshold for this value can be high (0.85-0.95). If model was learned for small amount of examples,
  55         /// then threshold can be reduced (0.5-0.85).
  56         /// </summary>
  57         /// <since_tizen> 3</since_tizen>
  58         public double Confidence { get; }
  59     }
  60 }