cv::BackgroundSubtractor Class Reference

The Base Class for Background/Foreground Segmentation. More...

#include <background_segm.hpp>

Inherits cv::Algorithm.

Inherited by cv::BackgroundSubtractorGMG, cv::BackgroundSubtractorMOG, and cv::BackgroundSubtractorMOG2.

List of all members.

Public Types
typedef Algorithm *(*	Constructor )(void)
typedef int(Algorithm::*	Getter )() const
typedef void(Algorithm::*	Setter )(int)
Public Member Functions
virtual	~BackgroundSubtractor ()
	the virtual destructor
	CV_WRAP_AS (apply) virtual void operator()(InputArray image
	the update operator that takes the next video frame and returns the current foreground mask as 8-bit binary image.
virtual void	getBackgroundImage (OutputArray backgroundImage) const
	computes a background image
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
CV_WRAP int	getInt (const string &name) const
CV_WRAP double	getDouble (const string &name) const
CV_WRAP bool	getBool (const string &name) const
CV_WRAP string	getString (const string &name) const
CV_WRAP Mat	getMat (const string &name) const
CV_WRAP vector< Mat >	getMatVector (const string &name) const
CV_WRAP Ptr< Algorithm >	getAlgorithm (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	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)
CV_WRAP void	setInt (const string &name, int value)
void	setInt (const char *name, int value)
CV_WRAP void	setDouble (const string &name, double value)
void	setDouble (const char *name, double value)
CV_WRAP void	setBool (const string &name, bool value)
void	setBool (const char *name, bool value)
CV_WRAP void	setString (const string &name, const string &value)
void	setString (const char *name, const string &value)
CV_WRAP void	setMat (const string &name, const Mat &value)
void	setMat (const char *name, const Mat &value)
CV_WRAP void	setMatVector (const string &name, const vector< Mat > &value)
void	setMatVector (const char *name, const vector< Mat > &value)
CV_WRAP void	setAlgorithm (const string &name, const Ptr< Algorithm > &value)
template<typename _Tp >
void	setAlgorithm (const string &name, const Ptr< _Tp > &value)
void	setAlgorithm (const char *name, const Ptr< Algorithm > &value)
template<typename _Tp >
void	setAlgorithm (const char *name, const Ptr< _Tp > &value)
CV_WRAP string	paramHelp (const string &name) const
int	paramType (const char *name) const
CV_WRAP int	paramType (const string &name) const
CV_WRAP void	getParams (CV_OUT vector< string > &names) const
virtual void	write (FileStorage &fs) const
virtual void	read (const FileNode &fn)
virtual AlgorithmInfo *	info () const
Static Public Member Functions
static CV_WRAP void	getList (CV_OUT vector< string > &algorithms)
static CV_WRAP Ptr< Algorithm >	_create (const string &name)
template<typename _Tp >
static Ptr< _Tp >	create (const string &name)
Public Attributes
OutputArray	fgmask
OutputArray double	learningRate = 0)

---

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.

---

Member Typedef Documentation

typedef Algorithm*(* cv::Algorithm::Constructor)(void) [inherited]

typedef int(Algorithm::* cv::Algorithm::Getter)() const [inherited]

typedef void(Algorithm::* cv::Algorithm::Setter)(int) [inherited]

---

Constructor & Destructor Documentation

virtual cv::BackgroundSubtractor::~BackgroundSubtractor

(

)

[virtual]

the virtual destructor

---

Member Function Documentation

cv::BackgroundSubtractor::CV_WRAP_AS

(

apply

)

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

virtual void cv::BackgroundSubtractor::getBackgroundImage

(

OutputArray

backgroundImage

)

const [virtual]

computes a background image

Reimplemented in cv::BackgroundSubtractorMOG2.

string cv::Algorithm::name

(

)

const [inherited]

template<typename _Tp >

ParamType< _Tp >::member_type cv::Algorithm::get

(

const string &

name

)

const [inherited]

template<typename _Tp >

ParamType< _Tp >::member_type cv::Algorithm::get

(

const char *

name

)

const [inherited]

CV_WRAP int cv::Algorithm::getInt

(

const string &

name

)

const [inherited]

CV_WRAP double cv::Algorithm::getDouble

(

const string &

name

)

const [inherited]

CV_WRAP bool cv::Algorithm::getBool

(

const string &

name

)

const [inherited]

CV_WRAP string cv::Algorithm::getString

(

const string &

name

)

const [inherited]

CV_WRAP Mat cv::Algorithm::getMat

(

const string &

name

)

const [inherited]

CV_WRAP vector<Mat> cv::Algorithm::getMatVector

(

const string &

name

)

const [inherited]

CV_WRAP Ptr<Algorithm> cv::Algorithm::getAlgorithm

(

const string &

name

)

const [inherited]

void cv::Algorithm::set	(	const string &	name,
		int	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		double	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		bool	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		const string &	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		const Mat &	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		const vector< Mat > &	value
	)		[inherited]

void cv::Algorithm::set	(	const string &	name,
		const Ptr< Algorithm > &	value
	)		[inherited]

template<typename _Tp >

void cv::Algorithm::set	(	const string &	name,
		const Ptr< _Tp > &	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		int	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		double	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		bool	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		const string &	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		const Mat &	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		const vector< Mat > &	value
	)		[inherited]

void cv::Algorithm::set	(	const char *	name,
		const Ptr< Algorithm > &	value
	)		[inherited]

template<typename _Tp >

void cv::Algorithm::set	(	const char *	name,
		const Ptr< _Tp > &	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setInt	(	const string &	name,
		int	value
	)		[inherited]

void cv::Algorithm::setInt	(	const char *	name,
		int	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setDouble	(	const string &	name,
		double	value
	)		[inherited]

void cv::Algorithm::setDouble	(	const char *	name,
		double	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setBool	(	const string &	name,
		bool	value
	)		[inherited]

void cv::Algorithm::setBool	(	const char *	name,
		bool	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setString	(	const string &	name,
		const string &	value
	)		[inherited]

void cv::Algorithm::setString	(	const char *	name,
		const string &	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setMat	(	const string &	name,
		const Mat &	value
	)		[inherited]

void cv::Algorithm::setMat	(	const char *	name,
		const Mat &	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setMatVector	(	const string &	name,
		const vector< Mat > &	value
	)		[inherited]

void cv::Algorithm::setMatVector	(	const char *	name,
		const vector< Mat > &	value
	)		[inherited]

CV_WRAP void cv::Algorithm::setAlgorithm	(	const string &	name,
		const Ptr< Algorithm > &	value
	)		[inherited]

template<typename _Tp >

void cv::Algorithm::setAlgorithm	(	const string &	name,
		const Ptr< _Tp > &	value
	)		[inherited]

void cv::Algorithm::setAlgorithm	(	const char *	name,
		const Ptr< Algorithm > &	value
	)		[inherited]

template<typename _Tp >

void cv::Algorithm::setAlgorithm	(	const char *	name,
		const Ptr< _Tp > &	value
	)		[inherited]

CV_WRAP string cv::Algorithm::paramHelp

(

const string &

name

)

const [inherited]

int cv::Algorithm::paramType

(

const char *

name

)

const [inherited]

CV_WRAP int cv::Algorithm::paramType

(

const string &

name

)

const [inherited]

CV_WRAP void cv::Algorithm::getParams

(

CV_OUT vector< string > &

names

)

const [inherited]

virtual void cv::Algorithm::write

(

FileStorage &

fs

)

const [virtual, inherited]

Reimplemented in cv::CalonderDescriptorExtractor< T >, cv::FlannBasedMatcher, cv::DescriptorMatcher, cv::BriefDescriptorExtractor, cv::OpponentColorDescriptorExtractor, and cv::SimpleBlobDetector.

virtual void cv::Algorithm::read

(

const FileNode &

fn

)

[virtual, inherited]

Reimplemented in cv::CalonderDescriptorExtractor< T >, cv::FlannBasedMatcher, cv::DescriptorMatcher, cv::BriefDescriptorExtractor, cv::OpponentColorDescriptorExtractor, cv::SimpleBlobDetector, and cv::EM.

static CV_WRAP void cv::Algorithm::getList

(

CV_OUT vector< string > &

algorithms

)

[static, inherited]

static CV_WRAP Ptr<Algorithm> cv::Algorithm::_create

(

const string &

name

)

[static, inherited]

template<typename _Tp >

Ptr< _Tp > cv::Algorithm::create

(

const string &

name

)

[static, inherited]

Reimplemented in cv::DescriptorMatcher, cv::AdjusterAdapter, cv::Feature2D, cv::DescriptorExtractor, and cv::FeatureDetector.

virtual AlgorithmInfo* cv::Algorithm::info

(

)

const [virtual, inherited]

Reimplemented in cv::BriefDescriptorExtractor, cv::GridAdaptedFeatureDetector, cv::DenseFeatureDetector, cv::EM, cv::GFTTDetector, cv::FastFeatureDetector, cv::StarDetector, cv::MSER, cv::FREAK, cv::ORB, cv::BRISK, cv::BackgroundSubtractorGMG, cv::BackgroundSubtractorMOG2, cv::SURF, cv::BackgroundSubtractorMOG, and cv::SIFT.

---

Member Data Documentation

OutputArray cv::BackgroundSubtractor::fgmask

OutputArray double cv::BackgroundSubtractor::learningRate = 0)

Reimplemented in cv::BackgroundSubtractorGMG.

---

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

• include/opencv2/video/background_segm.hpp