Add doxygen to GammaRemover and VignetteRemover.

Author: nynyg

modules/photometric_calib/include/opencv2/photometric_calib/GammaRemover.hpp

@@ -9,19 +9,53 @@
 
 namespace cv { namespace photometric_calib {
 
+//! @addtogroup photometric_calib
+//! @{
+
+/*!
+ * @brief Class for removing the camera response function (mostly gamma function) when provided with pcalib file.
+ *
+ */
+
 class CV_EXPORTS GammaRemover
 {
 public:
+    /*!
+     * @brief Constructor
+     * @param gammaPath the path of pcalib file of which the format should be .yaml or .yml
+     * @param w_ the width of input image
+     * @param h_ the height of input image
+     */
     GammaRemover(const std::string &gammaPath, int w_, int h_);
 
+    /*!
+     * @brief get irradiance image in the form of cv::Mat. Convenient for display, etc.
+     * @param inputIm
+     * @return
+     */
     Mat getUnGammaImageMat(Mat inputIm);
+
+    /*!
+     * @brief get irradiance image in the form of std::vector<float>. Convenient for optimization or SLAM.
+     * @param inputIm
+     * @param outImVec
+     */
     void getUnGammaImageVec(Mat inputIm, std::vector<float> &outImVec);
 
+    /*!
+     * @brief get gamma function.
+     * @return
+     */
     inline float* getG()
     {
         if(!validGamma) return 0;
         else return G;
     };
+
+    /*!
+     * @brief get inverse gamma function
+     * @return
+     */
     inline float* getGInv()
     {
         if(!validGamma) return 0;

modules/photometric_calib/include/opencv2/photometric_calib/VignetteRemover.hpp

@@ -9,13 +9,38 @@
 
 namespace cv { namespace photometric_calib {
 
+//! @addtogroup photometric_calib
+//! @{
+
+/*!
+ * @brief Class for removing the vignetting artifact when provided with vignetting file.
+ *
+ */
+
 class CV_EXPORTS VignetteRemover
 {
 public:
+    /*!
+     * @brief Constructor
+     * @param vignettePath the path of vignetting file
+     * @param w_ the width of input image
+     * @param h_ the height of input image
+     */
     VignetteRemover(const std::string &vignettePath, int w_, int h_);
     ~VignetteRemover();
 
+    /*!
+     * @brief get vignetting-removed image in form of cv::Mat.
+     * @param unGammaImVec the irradiance image.
+     * @return
+     */
     Mat getUnVignetteImageMat(std::vector<float> &unGammaImVec);
+
+    /*!
+     * @brief get vignetting-removed image in form of std::vector<float>.
+     * @param unGammaImVec the irradiance image.
+     * @param outImVec the vignetting-removed image vector.
+     */
     void getUnVignetteImageVec(const std::vector<float> &unGammaImVec, std::vector<float> &outImVec);
 
 private: