OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG Class Reference

Gaussian Mixture-based Background/Foreground Segmentation Algorithm. More...

Public Member Functions
override void	apply (Mat image, Mat fgmask)
	Computes a foreground mask.
override void	apply (Mat image, Mat fgmask, double learningRate)
	Computes a foreground mask.
override void	apply (Mat image, Mat knownForegroundMask, Mat fgmask)
	Computes a foreground mask and skips known foreground in evaluation.
override void	apply (Mat image, Mat knownForegroundMask, Mat fgmask, double learningRate)
	Computes a foreground mask and skips known foreground in evaluation.
double	getBackgroundRatio ()
int	getHistory ()
int	getNMixtures ()
double	getNoiseSigma ()
void	setBackgroundRatio (double backgroundRatio)
void	setHistory (int nframes)
void	setNMixtures (int nmix)
void	setNoiseSigma (double noiseSigma)
Public Member Functions inherited from OpenCVForUnity.VideoModule.BackgroundSubtractor
virtual void	getBackgroundImage (Mat backgroundImage)
	Computes a background image.
Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
virtual void	clear ()
	Clears the algorithm state.
virtual bool	empty ()
	Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read.
virtual string	getDefaultName ()
IntPtr	getNativeObjAddr ()
void	save (string filename)
Public Member Functions inherited from OpenCVForUnity.DisposableObject
void	Dispose ()
void	ThrowIfDisposed ()

Static Public Member Functions
static new BackgroundSubtractorMOG	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.VideoModule.BackgroundSubtractor
static new BackgroundSubtractor	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
static Algorithm	__fromPtr__ (IntPtr addr)
Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)

Protected Member Functions
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.VideoModule.BackgroundSubtractor
Protected Member Functions inherited from OpenCVForUnity.CoreModule.Algorithm
Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
	DisposableOpenCVObject ()
	DisposableOpenCVObject (bool isEnabledDispose)
	DisposableOpenCVObject (IntPtr ptr)
	DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
override void	Dispose (bool disposing)
Protected Member Functions inherited from OpenCVForUnity.DisposableObject
	DisposableObject ()
	DisposableObject (bool isEnabledDispose)

Additional Inherited Members
Package Functions inherited from OpenCVForUnity.VideoModule.BackgroundSubtractor
Package Functions inherited from OpenCVForUnity.CoreModule.Algorithm
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

Gaussian Mixture-based Background/Foreground Segmentation Algorithm.

The class implements the algorithm described in [KB2001] .

Member Function Documentation

__fromPtr__()

static new BackgroundSubtractorMOG OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.__fromPtr__ ( IntPtr addr )

static

apply() [1/4]

override void OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.apply ( Mat image, Mat fgmask )

virtual

Computes a foreground mask.

Parameters

image	Next video frame of type CV_8UC(n),CV_8SC(n),CV_16UC(n),CV_16SC(n),CV_32SC(n),CV_32FC(n),CV_64FC(n), where n is 1,2,3,4.
fgmask	The output foreground mask as an 8-bit binary image.
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.

Reimplemented from OpenCVForUnity.VideoModule.BackgroundSubtractor.

apply() [2/4]

override void OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.apply ( Mat image, Mat fgmask, double learningRate )

virtual

Computes a foreground mask.

Parameters

image	Next video frame of type CV_8UC(n),CV_8SC(n),CV_16UC(n),CV_16SC(n),CV_32SC(n),CV_32FC(n),CV_64FC(n), where n is 1,2,3,4.
fgmask	The output foreground mask as an 8-bit binary image.
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.

Reimplemented from OpenCVForUnity.VideoModule.BackgroundSubtractor.

apply() [3/4]

override void OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.apply ( Mat image, Mat knownForegroundMask, Mat fgmask )

virtual

Computes a foreground mask and skips known foreground in evaluation.

Parameters

image	Next video frame of type CV_8UC(n),CV_8SC(n),CV_16UC(n),CV_16SC(n),CV_32SC(n),CV_32FC(n),CV_64FC(n), where n is 1,2,3,4.
fgmask	The output foreground mask as an 8-bit binary image.
knownForegroundMask	The mask for inputting already known foreground, allows model to ignore learning known pixels.
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.

Reimplemented from OpenCVForUnity.VideoModule.BackgroundSubtractor.

apply() [4/4]

override void OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.apply ( Mat image, Mat knownForegroundMask, Mat fgmask, double learningRate )

virtual

Computes a foreground mask and skips known foreground in evaluation.

Parameters

image	Next video frame of type CV_8UC(n),CV_8SC(n),CV_16UC(n),CV_16SC(n),CV_32SC(n),CV_32FC(n),CV_64FC(n), where n is 1,2,3,4.
fgmask	The output foreground mask as an 8-bit binary image.
knownForegroundMask	The mask for inputting already known foreground, allows model to ignore learning known pixels.
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.

Reimplemented from OpenCVForUnity.VideoModule.BackgroundSubtractor.

Dispose()

override void OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.VideoModule.BackgroundSubtractor.

getBackgroundRatio()

double OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.getBackgroundRatio

(

)

getHistory()

int OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.getHistory

(

)

getNMixtures()

int OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.getNMixtures

(

)

getNoiseSigma()

double OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.getNoiseSigma

(

)

setBackgroundRatio()

void OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.setBackgroundRatio

(

double

backgroundRatio

)

setHistory()

void OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.setHistory

(

int

nframes

)

setNMixtures()

void OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.setNMixtures

(

int

nmix

)

setNoiseSigma()

void OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG.setNoiseSigma

(

double

noiseSigma

)

---

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

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv_contrib/bgsegm/BackgroundSubtractorMOG.cs