Added hand extractor API doc

Author: gineshidalgo99

include/openpose/hand/handExtractor.hpp

@@ -11,17 +11,49 @@
 
 namespace op
 {
+    /**
+     * Hand keypoint extractor class.
+     */
     class OP_API HandExtractor
     {
     public:
+        /**
+         * Constructor of the HandExtractor class.
+         * @param netInputSize Size at which the cropped image (where the hand is located) is resized.
+         * @param netOutputSize Size of the final results. At the moment, it must be equal than netOutputSize.
+         * @param modelFolder Folder where the models are located.
+         * @param gpuId The GPU index (0-based) which the deep net will use.
+         * @param numberScales Number of scales to run. The more scales, the slower it will be but possibly also more accurate.
+         * @param rangeScales The range between the smaller and bigger scale.
+         */
         explicit HandExtractor(const Point<int>& netInputSize, const Point<int>& netOutputSize, const std::string& modelFolder, const int gpuId,
                                const unsigned short numberScales = 1, const float rangeScales = 0.4f);
 
+        /**
+         * This function must be call before using any other function. It must also be called inside the thread in which the functions are going
+         * to be used.
+         */
         void initializationOnThread();
 
+        /**
+         * This function extracts the hand keypoints for each detected hand in the image.
+         * @param fpsMode handRectangles Location of the hands in the image. It is a length-variable std::vector, where each index corresponds to
+         * a different person in the image. Internally the std::vector, a std::array of 2 elements: index 0 and 1 for left and right hand
+         * respectively. Inside each array element, a op::Rectangle<float> (similar to cv::Rect for floating values) with the position of that hand
+         * (or 0,0,0,0 if some hand is missing, e.g. if a specific person has only half of the body inside the image).
+         * @param cvInputData Original image in cv::Mat format and BGR format.
+         * @param scaleInputToOutput Desired scale of the final keypoints. Set to 1 if the desired size is the cvInputData size.
+         */
         void forwardPass(const std::vector<std::array<Rectangle<float>, 2>> handRectangles, const cv::Mat& cvInputData,
                          const float scaleInputToOutput);
 
+        /**
+         * This function returns the hand keypoins. VERY IMPORTANT: use getHandKeypoints().clone() if the keypoints are going to be edited
+         * in a different thread.
+         * @return And std::array with all the left hand keypoints (index 0) and all the right ones (index 1). Each Array<float> follows the pose
+         * structure, i.e. the first dimension corresponds to all the people in the image, the second to each specific keypoint, and the third
+         * one to (x, y, score).
+         */
         std::array<Array<float>, 2> getHandKeypoints() const;
 
     private: