OpenCV  2.4.13.5
Open Source Computer Vision
cv::BackgroundSubtractor Class Reference

#include <background_segm.hpp>

Inheritance diagram for cv::BackgroundSubtractor:
cv::Algorithm cv::BackgroundSubtractorGMG cv::BackgroundSubtractorMOG cv::BackgroundSubtractorMOG2

Public Member Functions

virtual ~BackgroundSubtractor ()
 the virtual destructor More...
 
virtual void operator() (InputArray image, OutputArray fgmask, double learningRate=0)
 the update operator that takes the next video frame and returns the current foreground mask as 8-bit binary image. More...
 
virtual void getBackgroundImage (OutputArray backgroundImage) const
 computes a background image More...
 
- Public Member Functions inherited from cv::Algorithm
 Algorithm ()
 
virtual ~Algorithm ()
 
string name () const
 
template<typename _Tp >
ParamType< _Tp >::member_type get (const string &name) const
 
template<typename _Tp >
ParamType< _Tp >::member_type get (const char *name) const
 
int getInt (const string &name) const
 
double getDouble (const string &name) const
 
bool getBool (const string &name) const
 
string getString (const string &name) const
 
Mat getMat (const string &name) const
 
vector< MatgetMatVector (const string &name) const
 
Ptr< AlgorithmgetAlgorithm (const string &name) const
 
void set (const string &name, int value)
 
void set (const string &name, double value)
 
void set (const string &name, bool value)
 
void set (const string &name, const string &value)
 
void set (const string &name, const Mat &value)
 
void set (const string &name, const vector< Mat > &value)
 
void set (const string &name, const Ptr< Algorithm > &value)
 
template<typename _Tp >
void set (const string &name, const Ptr< _Tp > &value)
 
void setInt (const string &name, int value)
 
void setDouble (const string &name, double value)
 
void setBool (const string &name, bool value)
 
void setString (const string &name, const string &value)
 
void setMat (const string &name, const Mat &value)
 
void setMatVector (const string &name, const vector< Mat > &value)
 
void setAlgorithm (const string &name, const Ptr< Algorithm > &value)
 
template<typename _Tp >
void setAlgorithm (const string &name, const Ptr< _Tp > &value)
 
void set (const char *name, int value)
 
void set (const char *name, double value)
 
void set (const char *name, bool value)
 
void set (const char *name, const string &value)
 
void set (const char *name, const Mat &value)
 
void set (const char *name, const vector< Mat > &value)
 
void set (const char *name, const Ptr< Algorithm > &value)
 
template<typename _Tp >
void set (const char *name, const Ptr< _Tp > &value)
 
void setInt (const char *name, int value)
 
void setDouble (const char *name, double value)
 
void setBool (const char *name, bool value)
 
void setString (const char *name, const string &value)
 
void setMat (const char *name, const Mat &value)
 
void setMatVector (const char *name, const vector< Mat > &value)
 
void setAlgorithm (const char *name, const Ptr< Algorithm > &value)
 
template<typename _Tp >
void setAlgorithm (const char *name, const Ptr< _Tp > &value)
 
string paramHelp (const string &name) const
 
int paramType (const char *name) const
 
int paramType (const string &name) const
 
void getParams (CV_OUT vector< string > &names) const
 
virtual void write (FileStorage &fs) const
 
virtual void read (const FileNode &fn)
 
virtual AlgorithmInfoinfo () const
 

Additional Inherited Members

- Public Types inherited from cv::Algorithm
typedef Algorithm *(* Constructor) (void)
 
typedef int(Algorithm::* Getter) () const
 
typedef void(Algorithm::* Setter) (int)
 
- Static Public Member Functions inherited from cv::Algorithm
static void getList (CV_OUT vector< string > &algorithms)
 
static Ptr< Algorithm_create (const string &name)
 
template<typename _Tp >
static Ptr< _Tp > create (const string &name)
 

Detailed Description

The Base Class for Background/Foreground Segmentation

The class is only used to define the common interface for the whole family of background/foreground segmentation algorithms.

Constructor & Destructor Documentation

§ ~BackgroundSubtractor()

virtual cv::BackgroundSubtractor::~BackgroundSubtractor ( )
virtual

the virtual destructor

Member Function Documentation

§ getBackgroundImage()

virtual void cv::BackgroundSubtractor::getBackgroundImage ( OutputArray  backgroundImage) const
virtual

computes a background image

Reimplemented in cv::BackgroundSubtractorMOG2.

§ operator()()

virtual void cv::BackgroundSubtractor::operator() ( InputArray  image,
OutputArray  fgmask,
double  learningRate = 0 
)
virtual

the update operator that takes the next video frame and returns the current foreground mask as 8-bit binary image.

Reimplemented in cv::BackgroundSubtractorGMG, cv::BackgroundSubtractorMOG2, and cv::BackgroundSubtractorMOG.


The documentation for this class was generated from the following file: