class ImageFeatureManager;
/**
* @class ImageRecognizer
- * @brief This class provides methods to find same image objects to input image in the feature set that stores features of the reference images.
+ * @brief This class provides methods to find similar image objects that are used as the input images to the feature set that stores the features of the reference images.
*
* @since 2.1
*
- * The %ImageRecognizer class provides methods to find same image objects to input image in the feature set that stores features of the reference images.
- * This class also provide methods to calculate the 2D position and 3D pose transform matrix of the recognized image objects.
+ * The %ImageRecognizer class provides methods to find similar image objects that are used as the input images to the feature set that stores the features of the reference images.
+ * This class also provides methods to calculate the 2D position and 3D pose transform matrix of the recognized image objects.
*
* The following example demonstrates how to use the %ImageRecognizer class.
*
/**
* Initializes this instance of %ImageRecognizer. @n
- * Every application must call %Construct() before calling any other methods of %ImageRecognizer.
+ * Every application must call the %Construct() method before calling any other method of %ImageRecognizer.
*
* @since 2.1
*
* @feature %http://tizen.org/feature/vision.image_recognition
*
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
result Construct(void);
/**
- * Enables single or multiple tracking mode.
+ * Enables or disables the single or multiple tracking mode.
*
* @since 2.1
*
- * @param[in] enable Enable multiple tracking mode on @c true, default is single tracking mode
+ * @param[in] enable The boolean value that enables or disables the multiple tracking mode @n
+ * The default mode is the single tracking mode.
*
* @remarks
- * - In single tracking mode, only one image is recognized in the screen at once.
- * - In multiple tracking mode, multiple images (maximum 3) can be recognized and tracked simultaneously.
+ * - In the single tracking mode, only one image is recognized at a time on the screen.
+ * - In the multiple tracking mode, multiple images (maximum 3) can be recognized and tracked simultaneously.
*/
void SetMultiTrackingEnabled(bool enable);
/**
- * Sets the width and height of an input image.
+ * Sets the width and the height of the input image.
*
* @since 2.1
*
* Sets the ImageFeatureManager instance for initialization.
*
* @since 2.1
- * @pre ImageFeatureManager should be initialized by loading a feature set file using the ImageFeatureManager::Load() method.
+ * @pre The ImageFeatureManager should be initialized by loading the feature set file using the ImageFeatureManager::Load() method.
*
* @return An error code
- * @param[in] imageFeatureManager The ImageFeatureManager instance managing image feature set to use for recognition
+ * @param[in] imageFeatureManager The ImageFeatureManager instance that manages the image feature set to use for recognition
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG An input ImageFeatureManager is invalid.
+ * @exception E_INVALID_ARG The ImageFeatureManager is invalid.
*
- * @remarks ImageFeatureManager should be initialized by loading a feature set file.
+ * @remarks The ImageFeatureManager should be initialized by loading the feature set file.
*/
result SetFeatureManager(ImageFeatureManager& imageFeatureManager);
/**
- * Gets a count of the recognized image object.
+ * Gets the count of the recognized image object.
*
* @since 2.1
*
- * @return A count of the recognized image object
+ * @return The count of the recognized image object
*
- * @remarks The recognized object has index value from @c 0 to (count of the recognized image objects - 1)
- * @see GetRecognizedObject(int)
+ * @remarks The recognized object has an index value that ranges from @c 0 to (count of the recognized image objects) @c - 1.
+ * @see GetRecognizedObject()
*/
int GetRecognizedObjectCount(void);
/**
- * Gets the recognized image object to get information.
+ * Gets the recognized image object that contains the information.
*
* @since 2.1
*
- * @return A pointer to ImageObject that includes all information about the recognized image object
+ * @return A pointer to the ImageObject instance that includes all the information about the recognized image object
* @param[in] index The index of the recognized image object @n
- * Valid range of this parameter is @c 0 to (count of the recognized image objects - 1).
+ * The valid range for this parameter is @c 0 to (count of the recognized image objects) @c - 1.
* @exception E_SUCCESS The method is successful.
*
* @see GetRecognizedObjectCount()
const ImageObject* GetRecognizedObject(int index) const;
/**
- * Processes an input image for recognition.
+ * Processes the input image for recognition.
*
* @since 2.1
*
* @return An error code
*
* @param[in] imageBuffer The input image buffer @n
- * It must be allocated outside and have size of (width*height) set by SetImageSize().
+ * It must be allocated externally and have a size of (width*height) set by SetImageSize().
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c imageBuffer is not allocated or the size of @c imageBuffer is not equal to the input image size set by SetImageSize().
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified @c imageBuffer is not allocated.
+ * - The size of the specified @c imageBuffer is not equal to the input image size set by SetImageSize().
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @see SetImageSize(int, int)
*/
projects / framework / osp / vision.git / blobdiff