*
* The %FaceComponentsPosition class encapsulates the extracted face component's information that is processed by the FaceDetector class.
*
- * This class provides the following functionalities: @n
+ * This class provides the following functionalities:
* - Getting/Setting the position of a face.
* - Getting/Setting the position of the eyes.
* - Getting/Setting the position of the mouth.
- * @n
+ *
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/face_detector_recognizer.htm">Face Detector and Recognizer</a>.
*/
public:
/**
* This is the default constructor for this class. @n
- * Initializes this instance of %FaceComponentsPosition with all its attributes set to @c -1.
+ * All values of the attributes are set to @c -1 when this instance is initialized.
*
* @since 2.0
- *
- * @remarks The attributes are set to @c -1 when initialized.
*/
FaceComponentsPosition(void);
/**
- * Gets the position of the face.
+ * Gets the position of the face. @n
+ * The value of all the attributes is set to @c -1 if their value is not set to @c -1 during initialization.
*
* @since 2.0
*
* @return The position of the face
- * @remarks The value of all the attributes is set to @c -1 if their value is not set to @c -1 during initialization.
- */
+ */
Tizen::Graphics::Rectangle GetFacePosition(void) const;
/**
- * Gets the position of the eyes.
+ * Gets the position of the eyes. @n
+ * The value of @c leftEyePos and @c rightEyePos is set to @c -1 if it is not set to @c -1 during initialization.
*
* @since 2.0
*
* @param[out] leftEyePos The eye position on the left
* @param[out] rightEyePos The eye position on the right
- * @remarks The value of @c leftEyePos and @c rightEyePos is set to @c -1 if it is not set to @c -1 during initialization.
*/
void GetEyePosition(Tizen::Graphics::Point& leftEyePos, Tizen::Graphics::Point& rightEyePos) const;
/**
- * Gets the position of the mouth.
+ * Gets the position of the mouth. @n
+ * The value of all the attributes is set to @c -1 if their value is not set to @c -1 during initialization.
*
* @since 2.0
*
* @return The position of the mouth
- * @remarks The value of all the attributes is set to @c -1 if their value is not set to @c -1 during initialization.
*/
Tizen::Graphics::Rectangle GetMouthPosition(void) const;
* This position can be obtained using the FaceDetector::ExtractFaceComponentsN() method.
* @param[in] rightEyePos The eye position on the right @n
* This position can be obtained using the FaceDetector::ExtractFaceComponentsN() method. @n
- * The position of the eyes must be greater than or equal to @c 0. @n
- * The position of @c rightEyePos must be greater than the position of @c leftEyePos.
+ * The position of the right eye must be greater than or equal to @c 0, and must be greater than the position of @c leftEyePos.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
*/
/**
* This is the copy constructor for the %FaceComponentsPosition class. @n
- * Initializes this instance of %FaceComponentsPosition with the specified parameter.
+ * Initializes this instance of %FaceComponentsPosition with the specified parameter. @n
* Copying of objects using this copy constructor is allowed.
*
* @since 2.0
// Lifecycle
public:
/**
- * This is the default constructor for this class.
+ * This is the default constructor for this class. @n
* The object is not fully constructed after this constructor is called.
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @param[in] byteBuffer The buffer containing the input image data
* @param[in] dim The width and height of the input image @n
* Both the width and height must be greater than @c 0.
- * @param[in] format The color format defined by Tizen::Graphics::BitmapPixelFormat
+ * @param[in] format The color format @n
+ * @c BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_FAILURE A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks BitmapPixelFormat::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
Tizen::Base::Collection::IList* DetectFacesFromStillImageN(const Tizen::Base::ByteBuffer& byteBuffer, const Tizen::Graphics::Dimension& dim, Tizen::Graphics::BitmapPixelFormat format);
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see FaceBuffer
*/
FaceBuffer* PreprocessDataN(const Tizen::Base::ByteBuffer& byteBuffer, const Tizen::Graphics::Dimension& dim, Tizen::Graphics::PixelFormat format);
* @exception E_OPERATION_FAILED The method has failed to extract the facial information, but there is no error reported. @n
* This happens when the detected faces are too small or the input data is not clear. This is the result of a normal operation.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @see FaceComponentsPosition
*/
FaceComponentsPosition* ExtractFaceComponentsN(const FaceBuffer& preprocessedFaceBuffer, const Tizen::Graphics::Rectangle& faceRect);
/**
- * Gets the position difference of the face.
+ * Gets the position difference of the face. @n
+ * This can be used for tracking the face from a sequential video data.
*
* @since 2.0
*
* It can happen when the detected faces are too small or two video data are different even if they contain the same face.
* This is the result of a normal operation.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks This can be used for tracking the face from a sequential video data.
* @see DetectFacesN()
*/
result GetFaceMovement(const FaceBuffer& prevData, const FaceBuffer& curData, const Tizen::Graphics::Rectangle& prevFaceRect, int& xDiff, int& yDiff);
* The %FaceRecognitionInfo class encapsulates the information of a face recognized using the FaceRecognizer class by:
* - Getting the position of a recognized face.
* - Getting the facial features of a recognized face.
- * @n
+ *
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/face_detector_recognizer.htm">Face Detector and Recognizer</a>.
*/
{
public:
/**
- * This is the default constructor for this class.
+ * This is the default constructor for this class. @n
* The object is not fully constructed after this constructor is called.
* For full construction, the Construct() method must be called right after calling this constructor.
*
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @see FaceRecognizer::ExtractFaceInfoFromVideoStreamN()
- * @see FaceRecognizer::ExtractFaceInfoFromStillImageN()
+ * @see FaceRecognizer::ExtractFaceInfoFromStillImageN(const Tizen::Base::ByteBuffer&, const Tizen::Graphics::Dimension&, Tizen::Graphics::BitmapPixelFormat)
*/
result Construct(const Tizen::Base::ByteBuffer& faceFeatures);
* @param[in] byteBuffer The buffer containing the input image data
* @param[in] dim The width and height of the input image @n
* Both the width and height must be greater than @c 0.
- * @param[in] format The color format defined by Tizen::Graphics::BitmapPixelFormat
+ * @param[in] format The color format @n
+ * @c BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_FAILURE A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks BitmapPixelFormat::BITMAP_PIXEL_FORMAT_R8G8B8A8 is not applicable for this method.
*/
Tizen::Base::Collection::IList* ExtractFaceInfoFromStillImageN(const Tizen::Base::ByteBuffer& byteBuffer, const Tizen::Graphics::Dimension& dim, Tizen::Graphics::BitmapPixelFormat format);
* else @c null if an exception occurs
* @param[in] preprocessedFaceBuffer The preprocessed data
* @param[in] faceComponentPos The facial information that is obtained from the
- * ExtractFaceComponentsN() method @n
- * The @c faceComponentPos parameter must contain the eye position.
+ * FaceDetector::ExtractFaceComponentsN() method @n
+ * The specified facial information must contain the eye position. @n
* The position of the eyes must be greater than or equal to @c 0.
- * The position of the eyes must be within @c preprocessedFaceBuffer.
+ * The position of the eyes must be within @c preprocessedFaceBuffer. @n
+ * If there are wrong values in the specified facial information, the result cannot be guaranteed even if it returns @c E_SUCCESS. @n
+ * Therefore, be sure not to change the value of facial information after getting it from FaceDetector::ExtractFaceComponentsN().
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* This can happen when the detected faces are too small or the input data is not clear.
* This is the result of a normal operation.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If there are wrong values in the @c faceComponentPos, the result cannot be guaranteed even if it returns @c E_SUCCESS. Therefore, be sure not to change the value of @c faceComponentPos after getting it from ExtractFaceComponentsN().
* @see FaceDetector::PreprocessDataN()
* @see FaceDetector::ExtractFaceComponentsN()
*/
* else @c EYE_STATE_NONE if an exception occurs
* @param[in] preprocessedFaceBuffer The preprocessed data
* @param[in] faceComponentPos The facial information that is obtained from the FaceDetector::ExtractFaceComponentsN() method @n
- * The @c faceComponentPos parameter must contain the eye position.
+ * The specified facial information must contain the eye position. @n
* The position of the eyes must be greater than or equal to @c 0.
- * The position of the eyes must be within @c preprocessedFaceBuffer.
+ * The position of the eyes must be within @c preprocessedFaceBuffer. @n
+ * If there are wrong values in the specified facial information, the result cannot be guaranteed even if it returns @c E_SUCCESS. @n
+ * Therefore, be sure not to change the value of facial information after getting it from FaceDetector::ExtractFaceComponentsN().
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* This can happen when the detected faces are too small or the input data is not clear.
* This is the result of a normal operation.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If there are wrong values in the @c faceComponentPos, the result cannot be guaranteed even if it returns @c E_SUCCESS.
- * Therefore, be sure not to change the value of @c faceComponentPos after getting it from ExtractFaceComponentsN().
* @see FaceDetector::PreprocessDataN()
*/
EyeState GetEyeState(const FaceBuffer& preprocessedFaceBuffer, const FaceComponentsPosition& faceComponentPos);
* else @c FACIAL_EXPRESSION_NONE if an exception occurs
* @param[in] preprocessedFaceBuffer The preprocessed data
* @param[in] faceComponentPos The facial information that is obtained from the FaceDetector::ExtractFaceComponentsN() method @n
- * The @c faceComponentPos parameter must contain the eye position.
+ * The specified facial information must contain the eye position. @n
* The position of the eyes must be greater than or equal to @c 0.
- * The position of the eyes must be within @c preprocessedFaceBuffer.
+ * The position of the eyes must be within @c preprocessedFaceBuffer. @n
+ * If there are wrong values in the specified facial information, the result cannot be guaranteed even if it returns @c E_SUCCESS. @n
+ * Therefore, be sure not to change the value of facial information after getting it from FaceDetector::ExtractFaceComponentsN().
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* This can happen when the detected faces are too small or the input data is not clear.
* This is the result of a normal operation.
* @remarks The specific error code can be accessed using the GetLastResult() method.
- * @remarks If there are wrong values in the @c faceComponentPos, the result cannot be guaranteed even if it returns @c E_SUCCESS. Therefore,
- * be sure not to change the value of @c faceComponentPos after getting it from ExtractFaceComponentsN().
* @see FaceDetector::PreprocessDataN()
*/
FacialExpression RecognizeExpression(const FaceBuffer& preprocessedFaceBuffer, const FaceComponentsPosition& faceComponentPos);
/**
* The maximum number of faces to detect from a still image. @n
- * This will be used when FaceDetector::DetectFacesFromStillImageN() is called.
+ * This will be used when FaceDetector::DetectFacesFromStillImageN(const Tizen::Base::ByteBuffer&, const Tizen::Graphics::Dimension&, Tizen::Graphics::BitmapPixelFormat) is called.
*/
FACEDETECTOR_MAXNUMBER_IMAGE,
* The range is from values @c 1 to @c 3, where the value @c 1 has the longest execution time and @c 3 has
* the shortest execution time. The value @c 1 detects small faces.
* Therefore, for an application handling images, the value @c 1 is an appropriate option.
- * The value @c 1 is used when FaceDetector::DetectFacesFromStillImageN() is called unless it has been changed
+ * The value @c 1 is used when FaceDetector::DetectFacesFromStillImageN(const Tizen::Base::ByteBuffer&, const Tizen::Graphics::Dimension&, Tizen::Graphics::BitmapPixelFormat) is called unless it has been changed
* earlier using the FaceDetector::SetProperty() method. @n
*
- * This will be used when %FaceDetector::DetectFacesFromStillImageN() is called.
+ * This will be used when %FaceDetector::DetectFacesFromStillImageN(const %Tizen::Base::ByteBuffer&, const %Tizen::Graphics::Dimension&, %Tizen::Graphics::BitmapPixelFormat) is called.
*/
FACEDETECTOR_SCALE_IMAGE,
/**
* The maximum number of faces to detect. @n
- * The value @c 1 is used when DetectFacesN() is called unless it has been changed earlier
+ * The value @c 1 is used when FaceDetector::DetectFacesN() is called unless it has been changed earlier
* using the FaceDetector::SetProperty() method. @n
- * This will be used when FaceDetector::DetectFacesN() is called.
+ * This will be used when %FaceDetector::DetectFacesN() is called.
*/
FACEDETECTOR_MAXNUMBER_FACES,
/**
* The maximum number of faces to extract face information from a still image. @n
- * This will be used when FaceRecognizer::ExtractFaceInfoFromStillImageN() is called.
+ * This will be used when FaceRecognizer::ExtractFaceInfoFromStillImageN(const Tizen::Base::ByteBuffer&, const Tizen::Graphics::Dimension&, Tizen::Graphics::BitmapPixelFormat) is called.
*/
FACERECOGNIZER_MAXNUMBER_IMAGE,
* The range is from values @c 1 to @c 3, where the value @c 1 has the longest execution time and @c 3 has
* the shortest execution time. The value @c 1 detects small faces.
* Therefore, for an application using a camera or a video file, the value @c 3 is an appropriate option.
- * The value @c 3 is used when ExtractFaceInfoFromVideoStreamN() is called unless it has been changed
+ * The value @c 3 is used when FaceRecognizer::ExtractFaceInfoFromVideoStreamN() is called unless it has been changed
* earlier using the FaceDetector::SetProperty() method. @n
*
- * This will be used when FaceRecognizer::ExtractFaceInfoFromVideoStreamN() is called.
+ * This will be used when %FaceRecognizer::ExtractFaceInfoFromVideoStreamN() is called.
*/
FACERECOGNIZER_SCALE_VIDEO,
* the shortest execution time.
* The value @c 1 detects small faces.
* Therefore, for an application handling images, the value @c 1 is an appropriate option.
- * The value @c 1 is used when ExtractFaceInfoFromStillImageN() is called unless it has been changed
+ * The value @c 1 is used when FaceRecognizer::ExtractFaceInfoFromStillImageN(const Tizen::Base::ByteBuffer&, const Tizen::Graphics::Dimension&, Tizen::Graphics::BitmapPixelFormat) is called unless it has been changed
* earlier using the FaceDetector::SetProperty() method. @n
*
- * This will be used when FaceRecognizer::ExtractFaceInfoFromStillImageN() is called.
+ * This will be used when %FaceRecognizer::ExtractFaceInfoFromStillImageN(const %Tizen::Base::ByteBuffer&, const %Tizen::Graphics::Dimension&, %Tizen::Graphics::BitmapPixelFormat) is called.
*/
FACERECOGNIZER_SCALE_IMAGE,
};
projects / platform / framework / native / face.git / commitdiff