/**
* @class ImageFeatureManager
- * @brief This class provides methods to generate individual feature data from an individual image data and collect to feature set file.
+ * @brief This class provides methods to generate individual feature data from an individual image data, and load it into a feature set file.
*
* @since 2.1
*
- * The %ImageFeatureManager class provides methods to generate individual feature data from an individual image data. This class also provides methods to manage image feature set which is a collection of individual feature data.
+ * The %ImageFeatureManager class provides methods to generate individual feature data from an individual image data.
+ * This class also provides methods to manage the image feature set which is a collection of individual feature data.
*
* The following example demonstrates how to use the %ImageFeatureManager class.
*
~ImageFeatureManager(void);
/**
- * Initializes this instance of %ImageFeatureManager and create image feature set. @n
- * Every application must call %Construct() before calling any other methods of %ImageFeatureManager.
+ * Initializes this instance of %ImageFeatureManager and creates an image feature set. @n
+ * Every application must call the %Construct() method before calling any other method of %ImageFeatureManager.
*
* @since 2.1
*
*
* @return An error code
*
- * @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);
/**
- * Loads a feature set file.
+ * Loads the feature set file.
*
* @since 2.1
*
* @return An error code
*
- * @param[in] featureSetFilePath The feature set file path
+ * @param[in] featureSetFilePath The feature set file path at which to load the file
*
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified feature set file path is invalid.
+ * @exception E_INVALID_ARG The specified @c featureSetFilePath is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @remarks
* - If a feature set file exists, it is updated.
* - If a feature set file does not exist, it is newly created.
- * - It is not mandatory to call this method to create new feature set file, but Flush() must be called with valid feature set file path.
+ * - It is not mandatory to call this method to create a new feature set file, but the Flush() method must be called with a valid feature set file path.
*/
result Load(const Tizen::Base::String& featureSetFilePath);
/**
- * Gets a list of supported image file formats for adding a feature.
+ * Gets the list of supported image file formats used to add the feature.
*
* @since 2.1
*
- * @return A list of supported image file formats
+ * @return The list of supported image file formats
*/
static Tizen::Base::Collection::IListT<Tizen::Media::ImageFormat>* GetSupportedImageFileFormatsListN(void);
/**
- * Adds a feature to a feature set.
+ * Adds a feature to the feature set.
*
* @since 2.1
*
- * @return A feature index of newly and successfully created feature, otherwise returns -1.
+ * @return The feature index of the newly and successfully created feature, @n
+ * else @c -1 is returned
*
* @param[in] imagePath The input image file path
*
*
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
- * - Input image file must be one of the supported image file formats.
- * - Calling this method actually means 'Mark As Add Feature'.
- * And the marked feature data will be added to a feature set file after calling Flush().
+ * - The input image file must have one of the supported image file formats.
+ * - Calling this method actually means 'Mark As Add Feature'
+ * and the marked feature data is added to the feature set file after calling the Flush() method.
* @see GetSupportedImageFileFormatsListN()
- * Flush(const Tizen::Base::String*)
*/
int AddFeature(const Tizen::Base::String& imagePath);
/**
- * Adds a feature to a feature set.
+ * Adds a feature to the feature set.
*
* @since 2.1
*
- * @return A feature index of newly and successfully created feature, otherwise returns -1.
+ * @return The feature index of the newly and successfully created feature, @n
+ * else @c -1 is returned
*
- * @param[in] imageBuffer The image buffer of grayscale image data of specified width and height
+ * @param[in] imageBuffer The image buffer of the grayscale image data with the specified @c width and @c height
* @param[in] width The width of the input image
* @param[in] height The height of the input image
* @param[in] description The description of the feature
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - Calling this method actually means 'Mark As Add Feature'.
- * And the marked feature data will be added to a feature set file after calling Flush().
+ * and the marked feature data is added to the feature set file after calling the Flush() method.
* @see Flush(const Tizen::Base::String*)
*/
int AddFeature(const Tizen::Base::ByteBuffer& imageBuffer, int width, int height, const Tizen::Base::String& description);
/**
- * Gets the total number of features in a feature set.
+ * Gets the total number of features in the feature set.
*
* @since 2.1
*
- * @return The total number of features in a feature set
+ * @return The total number of features in the feature set
*/
int GetTotalNumberOfFeatures(void);
/**
- * Deletes a feature with a specified index in a feature set.
+ * Deletes the feature at the specified index in the feature set.
*
* @since 2.1
*
* @return An error code
*
- * @param[in] featureIndex The feature index in a feature set
+ * @param[in] featureIndex The feature index in the feature set
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @remarks Calling this method actually means 'Mark As Delete Feature'.
- * And the marked feature data is deleted after calling Flush().
- * @see Flush(const Tizen::Base::String*)
+ * and the marked feature data is deleted after calling the Flush() method.
+ * @see Flush(const Tizen::Base::String*)
*/
result DeleteFeature(int featureIndex);
/**
- * Deletes all features in a feature set.
+ * Deletes all the features in the feature set.
*
* @since 2.1
*
* @exception E_OUT_OF_MEMORY The memory is insufficient.
*
* @remarks Calling this method actually means 'Mark As Delete All Features'.
- * And all feature data is deleted after calling Flush().
+ * and all the feature data is deleted after calling the Flush() method.
* @see Flush(const Tizen::Base::String*)
*/
result DeleteAllFeatures(void);
/**
- * Flushes features into a feature set file and updates all changes as marked.
+ * Flushes features from the feature set file and updates all the changes as marked.
*
*
* @since 2.1
*
* @param[in] featureSetFilePath The feature set file path
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified feature set path is invalid.
+ * @exception E_INVALID_ARG The specified @c featureSetFilePath is invalid.
*
* @remarks
- * - All changes in the feature set file by AddFeature() or DeleteFeature() or DeleteAllFeatures() are updated by calling this method.
- * - If @c featureSetFilePath is not decided or is same as the file path used in Load(), the loaded feature set file is updated.
- * - If @c featureSetFilePath is not same as the file path used in %Load(), the loaded feature set file remains as is and new feature set file is created.
- * - If @c featureSetFilePath is @c null, the feature set file loaded by %Load() is overwritten.
- * - If @c featureSetFilePath is not decided or is same to file path used in %Load() and the loaded feature set file is read-only @c E_INVALID_ARG exception will be returned.
- * - If %Load() is not called to create new feature set file, this method must be called with valid @c featureSetFilePath.
+ * - All the changes in the feature set file used by the AddFeature(), DeleteFeature(), or DeleteAllFeatures() method are updated by calling this method.
+ * - If the @c featureSetFilePath is not decided or is same as the file path used in the Load() method, the loaded feature set file is updated.
+ * - If the @c featureSetFilePath is not same as the file path used by the %Load() method, the loaded feature set file is retained and a new feature set file is created.
+ * - If the @c featureSetFilePath is @c null, the feature set file loaded by the %Load() method is overwritten.
+ * - If the @c featureSetFilePath is not decided or is same as the file path used by the %Load() method, and the loaded feature set file is a read-only file, then @c E_INVALID_ARG exception is returned.
+ * - If the %Load() method is not called to create a new feature set file, this method must be called with a valid @c featureSetFilePath.
*
*/
result Flush(const Tizen::Base::String* featureSetFilePath = null);
/**
- * Gets information of the individual feature.
+ * Gets the information of the specified feature.
*
* @since 2.1
*
- * @return A pointer to ImageFeatureInfo
+ * @return A pointer to the ImageFeatureInfo instance
*
- * @param[in] featureIndex The feature index in a feature set
+ * @param[in] featureIndex The feature index in the feature set
*/
const Tizen::Uix::Vision::ImageFeatureInfo* GetImageFeatureInfo(int featureIndex) const;
projects / framework / osp / vision.git / blobdiff