From 4e0351bafd701d5f71aab064b87acb20aeafb721 Mon Sep 17 00:00:00 2001 From: Vladislav Sovrasov Date: Thu, 26 Jan 2017 12:43:41 +0300 Subject: [PATCH] Clarify docs for MOG2::apply --- modules/video/include/opencv2/video/background_segm.hpp | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/modules/video/include/opencv2/video/background_segm.hpp b/modules/video/include/opencv2/video/background_segm.hpp index 2952d57..f4c6e4c 100644 --- a/modules/video/include/opencv2/video/background_segm.hpp +++ b/modules/video/include/opencv2/video/background_segm.hpp @@ -195,6 +195,17 @@ public: /** @brief Sets the shadow threshold */ CV_WRAP virtual void setShadowThreshold(double threshold) = 0; + + /** @brief Computes a foreground mask. + + @param image Next video frame. Floating point frame will be used without scaling and should be in range \f$[0,255]\f$. + @param fgmask The output foreground mask as an 8-bit binary image. + @param learningRate The value between 0 and 1 that indicates how fast the background model is + learnt. Negative parameter value makes the algorithm to use some automatically chosen learning + rate. 0 means that the background model is not updated at all, 1 means that the background model + is completely reinitialized from the last frame. + */ + CV_WRAP virtual void apply(InputArray image, OutputArray fgmask, double learningRate=-1) = 0; }; /** @brief Creates MOG2 Background Subtractor -- 2.7.4