src/Tizen.Multimedia.Vision/MediaVision/PersonRecognitionConfiguration.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 using System;
  18
  19 namespace Tizen.Multimedia.Vision
  20 {
  21     /// <summary>
  22     /// Represents a configuration of <see cref="PersonRecognizer"/> instances.
  23     /// </summary>
  24     /// <feature>http://tizen.org/feature/vision.face_recognition</feature>
  25     /// <feature>http://tizen.org/feature/vision.image_recognition</feature>
  26     /// <since_tizen> 3 </since_tizen>
  27     public class PersonRecognitionConfiguration : SurveillanceEngineConfiguration
  28     {
  29         private const string KeyFaceRecognitionModelFilePath = "MV_SURVEILLANCE_FACE_RECOGNITION_MODEL_FILE_PATH";
  30
  31         /// <summary>
  32         /// Initializes a new instance of the <see cref="PersonRecognitionConfiguration"/> class.
  33         /// </summary>
  34         /// <param name="modelPath">Path to the face recognition model.</param>
  35         /// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
  36         /// <exception cref="NotSupportedException">The required features are not supported.</exception>
  37         /// <since_tizen> 3 </since_tizen>
  38         public PersonRecognitionConfiguration(string modelPath)
  39         {
  40             FaceRecognitionModelPath = modelPath;
  41         }
  42
  43         /// <summary>
  44         /// Gets or sets face recognition model file path.
  45         /// </summary>
  46         /// <exception cref="ArgumentNullException"><paramref name="value"/> is null.</exception>
  47         /// <exception cref="ObjectDisposedException">The <see cref="PersonRecognitionConfiguration"/> already has been disposed of.</exception>
  48         /// <since_tizen> 3 </since_tizen>
  49         public string FaceRecognitionModelPath
  50         {
  51             get
  52             {
  53                 return GetString(KeyFaceRecognitionModelFilePath);
  54             }
  55             set
  56             {
  57                 if (value == null)
  58                 {
  59                     throw new ArgumentNullException(nameof(FaceRecognitionModelPath));
  60                 }
  61                 Set(KeyFaceRecognitionModelFilePath, value);
  62             }
  63         }
  64     }
  65 }