* @section CAPI_MEDIA_VISION_FACE_MODULE_HEADER Required Header
* \#include <mv_face.h>
*
- * @section CAPI_MEDIA_VISION_FACE_MODULE_FEATURE Related Features
- * This API is related with the following features:\n
- * - %http://tizen.org/feature/vision.face_recognition\n
- *
- * It is recommended to design feature related codes in your application for
- * reliability.\n
- * You can check if a device supports the related features for this API by using
- * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of
- * your application.\n
- * To ensure your application is only running on the device with specific
- * features, please define the features in your manifest file using the manifest
- * editor in the SDK.\n
- * More details on featuring your application can be found from
- * <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element">
- * <b>Feature Element</b>.
- * </a>
- *
* @section CAPI_MEDIA_VISION_FACE_MODULE_OVERVIEW Overview
* @ref CAPI_MEDIA_VISION_FACE_MODULE contains mv_face_detect() function
* to detect faces on #mv_source_h, and mv_face_detected_cb() callback
* #mv_rectangle_s. Result is handled with
* mv_face_facial_expression_recognized_cb().
*
- * @defgroup CAPI_MEDIA_VISION_IMAGE_MODULE Media Vision Image
- * @ingroup CAPI_MEDIA_VISION_MODULE
- * @brief Flat Image recognition and tracking;\n
- * Flat image feature extraction.
- * @section CAPI_MEDIA_VISION_IMAGE_MODULE_HEADER Required Header
- * \#include <mv_image.h>
- *
- * @section CAPI_MEDIA_VISION_IMAGE_MODULE_FEATURE Related Features
+ * @section CAPI_MEDIA_VISION_FACE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
- * - %http://tizen.org/feature/vision.image_recognition\n
+ * - %http://tizen.org/feature/vision.face_recognition\n
*
* It is recommended to design feature related codes in your application for
* reliability.\n
* <b>Feature Element</b>.
* </a>
*
+ * @defgroup CAPI_MEDIA_VISION_IMAGE_MODULE Media Vision Image
+ * @ingroup CAPI_MEDIA_VISION_MODULE
+ * @brief Flat Image recognition and tracking;\n
+ * Flat image feature extraction.
+ * @section CAPI_MEDIA_VISION_IMAGE_MODULE_HEADER Required Header
+ * \#include <mv_image.h>
+ *
* @section CAPI_MEDIA_VISION_IMAGE_MODULE_OVERVIEW Overview
* @ref CAPI_MEDIA_VISION_IMAGE_MODULE contains mv_image_recognize()
* function to recognize images on #mv_source_h, and
* mv_image_tracking_model_save() and loaded from file with
* mv_image_tracking_model_load().
*
- * @defgroup CAPI_MEDIA_VISION_BARCODE_MODULE Media Vision BarCode
- * @ingroup CAPI_MEDIA_VISION_MODULE
- * @brief Barcode module consists of barcode detection and barcode generation
- * submodules.
- * @section CAPI_MEDIA_VISION_BARCODE_MODULE_HEADER Required Header
- * \#include <mv_barcode.h>
- *
- * @section CAPI_MEDIA_VISION_BARCODE_MODULE_FEATURE Related Features
+ * @section CAPI_MEDIA_VISION_IMAGE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
- * - %http://tizen.org/feature/vision.barcode_detection\n
- * - %http://tizen.org/feature/vision.barcode_generation\n
+ * - %http://tizen.org/feature/vision.image_recognition\n
*
* It is recommended to design feature related codes in your application for
* reliability.\n
* <b>Feature Element</b>.
* </a>
*
+ * @defgroup CAPI_MEDIA_VISION_BARCODE_MODULE Media Vision BarCode
+ * @ingroup CAPI_MEDIA_VISION_MODULE
+ * @brief Barcode module consists of barcode detection and barcode generation
+ * submodules.
+ * @section CAPI_MEDIA_VISION_BARCODE_MODULE_HEADER Required Header
+ * \#include <mv_barcode.h>
+ *
* @section CAPI_MEDIA_VISION_BARCODE_MODULE_OVERVIEW Overview
* @ref CAPI_MEDIA_VISION_BARCODE_MODULE contains two submodules:\n
* * Detection submodule,
* mode (see #mv_barcode_qr_mode_e). Generation to file supports several
* formats (see #mv_barcode_image_format_e).
*
- * @defgroup CAPI_MEDIA_VISION_SURVEILLANCE_MODULE Media Vision Surveillance
- * @ingroup CAPI_MEDIA_VISION_MODULE
- * @brief Video surveillance module.
- * @section CAPI_MEDIA_VISION_SURVEILLANCE_MODULE_HEADER Required Header
- * \#include <mv_surveillance.h>
- *
- * @section CAPI_MEDIA_VISION_SURVEILLANCE_MODULE_FEATURE Related Features
+ * @section CAPI_MEDIA_VISION_BARCODE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
- * - %http://tizen.org/feature/vision.image_recognition\n
- * - %http://tizen.org/feature/vision.face_recognition\n
+ * - %http://tizen.org/feature/vision.barcode_detection\n
+ * - %http://tizen.org/feature/vision.barcode_generation\n
*
* It is recommended to design feature related codes in your application for
* reliability.\n
* <b>Feature Element</b>.
* </a>
*
+ * @defgroup CAPI_MEDIA_VISION_SURVEILLANCE_MODULE Media Vision Surveillance
+ * @ingroup CAPI_MEDIA_VISION_MODULE
+ * @brief Video surveillance module.
+ * @section CAPI_MEDIA_VISION_SURVEILLANCE_MODULE_HEADER Required Header
+ * \#include <mv_surveillance.h>
+ *
* @section CAPI_MEDIA_VISION_SURVEILLANCE_MODULE_OVERVIEW Overview
* @ref CAPI_MEDIA_VISION_SURVEILLANCE_MODULE provides functionality can be
* utilized for creation of video surveillance systems. The main idea underlying
* useful if it is required to obtain supported event types list or result
* value names list dynamically.
*
+ * @section CAPI_MEDIA_VISION_SURVEILLANCE_MODULE_FEATURE Related Features
+ * This API is related with the following features:\n
+ * - %http://tizen.org/feature/vision.image_recognition\n
+ * - %http://tizen.org/feature/vision.face_recognition\n
+ *
+ * It is recommended to design feature related codes in your application for
+ * reliability.\n
+ * You can check if a device supports the related features for this API by using
+ * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of
+ * your application.\n
+ * To ensure your application is only running on the device with specific
+ * features, please define the features in your manifest file using the manifest
+ * editor in the SDK.\n
+ * More details on featuring your application can be found from
+ * <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element">
+ * <b>Feature Element</b>.
+ * </a>
+ *
* @defgroup CAPI_MEDIA_VISION_SURVEILLANCE_EVENT_TYPES Media Vision Surveillance Event Types
* @ingroup CAPI_MEDIA_VISION_SURVEILLANCE_MODULE
* @brief Event types supported by the Surveillance module.
* @section CAPI_MEDIA_VISION_INFERENCE_MODULE_HEADER Required Header
* \#include <mv_inference.h>
*
- * @section CAPI_MEDIA_VISION_INFERECNE_MODULE_FEATURE Related Features
- * This API is related with the following features:\n
- * - %http://tizen.org/feature/vision.inference\n
- * - %http://tizen.org/feature/vision.inference.image\n
- * - %http://tizen.org/feature/vision.inference.face\n
- *
- * It is recommended to use features in your application for reliability.\n
- * You can check if the device supports the related features for this API by using
- * System Information, and control your application's actions accordingly.\n
- * To ensure your application is only running on devices with specific
- * features, please define the features in your manifest file using the manifest
- * editor in the SDK.\n
- * More details on using features in your application can be found in
- * <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element">
- * <b>Feature Element</b>.
- * </a>
- *
* @section CAPI_MEDIA_VISION_INFERENCE_MODULE_OVERVIEW Overview
* @ref CAPI_MEDIA_VISION_INFERENCE_MODULE contains #mv_inference_h handle to perform
* Image Classification, Object Detection, Face and Facial Landmark detection.
* on #mv_source_h, and callbacks mv_inference_face_detected_cb() and
* mv_inference_facial_landmark_detected_cb() to process detection results.
*
- * @defgroup CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE Media Vision Face Recognition
- * @ingroup CAPI_MEDIA_VISION_MODULE
- * @brief Face recognition.
- * @section CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE_HEADER Required Header
- * \#include <mv_face_recognition.h>
- *
- * @section CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE_FEATURE Related Features
+ * @section CAPI_MEDIA_VISION_INFERECNE_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - %http://tizen.org/feature/vision.inference\n
- * - %http://tizen.org/feature/vision.training\n
- * - %http://tizen.org/feature/vision.inference.face_recognition\n
- * - %http://tizen.org/feature/vision.training.face_recognition\n
+ * - %http://tizen.org/feature/vision.inference.image\n
+ * - %http://tizen.org/feature/vision.inference.face\n
*
- * It is recommended to design feature related codes in your application for
- * reliability.\n
- * You can check if a device supports the related features for this API by using
- * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of
- * your application.\n
- * To ensure your application is only running on the device with specific
+ * It is recommended to use features in your application for reliability.\n
+ * You can check if the device supports the related features for this API by using
+ * System Information, and control your application's actions accordingly.\n
+ * To ensure your application is only running on devices with specific
* features, please define the features in your manifest file using the manifest
* editor in the SDK.\n
- * More details on featuring your application can be found from
+ * More details on using features in your application can be found in
* <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element">
* <b>Feature Element</b>.
* </a>
*
+ * @defgroup CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE Media Vision Face Recognition
+ * @ingroup CAPI_MEDIA_VISION_MODULE
+ * @brief Face recognition.
+ * @section CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE_HEADER Required Header
+ * \#include <mv_face_recognition.h>
+ *
* @section CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE_OVERVIEW Overview
* @ref CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE contains mv_face_recognition_register() function
* to train a face on #mv_source_h, and mv_face_recognition_unregister() function to remote
*
* For more details, please refer to test/testsuites/machine_learning/face_recognition/test_face_recognition.cpp
*
+ * @section CAPI_MEDIA_VISION_FACE_RECOGNITION_MODULE_FEATURE Related Features
+ * This API is related with the following features:\n
+ * - %http://tizen.org/feature/vision.inference\n
+ * - %http://tizen.org/feature/vision.training\n
+ * - %http://tizen.org/feature/vision.inference.face_recognition\n
+ * - %http://tizen.org/feature/vision.training.face_recognition\n
+ *
+ * It is recommended to design feature related codes in your application for
+ * reliability.\n
+ * You can check if a device supports the related features for this API by using
+ * @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of
+ * your application.\n
+ * To ensure your application is only running on the device with specific
+ * features, please define the features in your manifest file using the manifest
+ * editor in the SDK.\n
+ * More details on featuring your application can be found from
+ * <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element">
+ * <b>Feature Element</b>.
+ * </a>
+ *
* @defgroup CAPI_MEDIA_VISION_ROI_TRACKER_MODULE Media Vision Roi tracker
* @ingroup CAPI_MEDIA_VISION_MODULE
* @brief Tracking Region of interest inside image.
* @section CAPI_MEDIA_VISION_ROI_TRACKER_MODULE_HEADER Required Header
* \#include <mv_roi_tracker.h>
*
+ * @section CAPI_MEDIA_VISION_ROI_TRACKER_MODULE_OVERVIEW Overview
+ * @ref CAPI_MEDIA_VISION_ROI_TRACKER_MODULE contains #mv_roi_tracker_h handle to perform roi tracking.
+ * Roi Tracker handle should be created with mv_roi_tracker_create() and destroyed with
+ * mv_roi_tracker_destroy(). After creation, #mv_inference_h should be set by
+ * calling mv_roi_tracker_set_coordinate() which sets coordinates of roi.
+ * After setting coordinates, mv_roi_tracker_set_tracker_type() could be called optionally in case of setting other tracker type.
+ * It is set to MV_ROI_TRACKER_TYPE_BALANCE as default.
+ * After setting tracker type, mv_roi_tracker_perform() has to be called to tracking roi of images on #mv_source_h,
+ * and it sets newly generated coordinates to result parameter.
+ *
* @section CAPI_MEDIA_VISION_ROI_TRACKER_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - %http://tizen.org/feature/vision.roi_tracking\n
* <b>Feature Element</b>.
* </a>
*
- * @section CAPI_MEDIA_VISION_ROI_TRACKER_MODULE_OVERVIEW Overview
- * @ref CAPI_MEDIA_VISION_ROI_TRACKER_MODULE contains #mv_roi_tracker_h handle to perform roi tracking.
- * Roi Tracker handle should be created with mv_roi_tracker_create() and destroyed with
- * mv_roi_tracker_destroy(). After creation, #mv_inference_h should be set by
- * calling mv_roi_tracker_set_coordinate() which sets coordinates of roi.
- * After setting coordinates, mv_roi_tracker_set_tracker_type() could be called optionally in case of setting other tracker type.
- * It is set to MV_ROI_TRACKER_TYPE_BALANCE as default.
- * After setting tracker type, mv_roi_tracker_perform() has to be called to tracking roi of images on #mv_source_h,
- * and it sets newly generated coordinates to result parameter.
- *
* @defgroup CAPI_MEDIA_VISION_3D_MODULE Media Vision 3D
* @ingroup CAPI_MEDIA_VISION_MODULE
* @brief 3D Depth and PointCloud Process.
* @section CAPI_MEDIA_VISION_3D_MODULE_HEADER Required Header
* \#include <mv_3d.h>
*
+ * @section CAPI_MEDIA_VISION_3D_MODULE_OVERVIEW Overview
+ * @ref CAPI_MEDIA_VISION_3D_MODULE contains #mv_3d_h handle to perform Depth and PointCloud process.
+ * 3D handle should be created with mv_3d_create() function and destroyed with mv_3d_destroy() function.
+ * #mv_3d_h should be configured by calling mv_3d_configure() function. After configuration, callback functions
+ * for depth and pointcloud should be set to #mv_3d_h. To get depth, callback mv_3d_depth_cb() should be set
+ * by mv_3d_set_depth_cb() function. To get pointcloud, callback mv_3d_pointcloud_cb() should be set
+ * by mv_3d_set_pointcloud_cb() function. After setting callbacks, mv_3d_h should be prepared by
+ * calling mv_3d_prepare() function which initializes depth and pointcloud process.
+ * After preparation, mv_3d_run() has to be called to process synchronously depth or pointcloud from #mv_source_h,
+ * and callback functions will be invoked with processed depth or pointcloud.
+ * Module also contains mv_3d_run_async() functions to process depth or pointcloud asynchronously.
+ *
* @section CAPI_MEDIA_VISION_3D_MODULE_FEATURE Related Features
* This API is related with the following features:\n
* - %http://tizen.org/feature/vision.3d\n
* <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element">
* <b>Feature Element</b>.
* </a>
- *
- * @section CAPI_MEDIA_VISION_3D_MODULE_OVERVIEW Overview
- * @ref CAPI_MEDIA_VISION_3D_MODULE contains #mv_3d_h handle to perform Depth and PointCloud process.
- * 3D handle should be created with mv_3d_create() function and destroyed with mv_3d_destroy() function.
- * #mv_3d_h should be configured by calling mv_3d_configure() function. After configuration, callback functions
- * for depth and pointcloud should be set to #mv_3d_h. To get depth, callback mv_3d_depth_cb() should be set
- * by mv_3d_set_depth_cb() function. To get pointcloud, callback mv_3d_pointcloud_cb() should be set
- * by mv_3d_set_pointcloud_cb() function. After setting callbacks, mv_3d_h should be prepared by
- * calling mv_3d_prepare() function which initializes depth and pointcloud process.
- * After preparation, mv_3d_run() has to be called to process synchronously depth or pointcloud from #mv_source_h,
- * and callback functions will be invoked with processed depth or pointcloud.
- * Module also contains mv_3d_run_async() functions to process depth or pointcloud asynchronously.
*/
#endif /* __TIZEN_MEDIAVISION_DOC_H__ */
projects / platform / core / api / mediavision.git / commitdiff