OpenCVForUnity.VideoModule.BackgroundSubtractor Class Reference

Base class for background/foreground segmentation. : More...

Public Member Functions
virtual void	apply (Mat image, Mat fgmask)
	Computes a foreground mask.
virtual void	apply (Mat image, Mat fgmask, double learningRate)
	Computes a foreground mask.
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 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.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.CoreModule.Algorithm
Package Attributes inherited from OpenCVForUnity.DisposableOpenCVObject
Properties inherited from OpenCVForUnity.DisposableObject
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

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 Function Documentation

__fromPtr__()

static new BackgroundSubtractor OpenCVForUnity.VideoModule.BackgroundSubtractor.__fromPtr__ ( IntPtr addr )

static

apply() [1/2]

virtual void OpenCVForUnity.VideoModule.BackgroundSubtractor.apply ( Mat image, Mat fgmask )

virtual

Computes a foreground mask.

Parameters

image	Next video frame.
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 in OpenCVForUnity.BgsegmModule.BackgroundSubtractorCNT, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGMG, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGSOC, OpenCVForUnity.BgsegmModule.BackgroundSubtractorLSBP, and OpenCVForUnity.VideoModule.BackgroundSubtractorMOG2.

apply() [2/2]

virtual void OpenCVForUnity.VideoModule.BackgroundSubtractor.apply ( Mat image, Mat fgmask, double learningRate )

virtual

Computes a foreground mask.

Parameters

image	Next video frame.
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 in OpenCVForUnity.BgsegmModule.BackgroundSubtractorCNT, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGMG, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGSOC, OpenCVForUnity.BgsegmModule.BackgroundSubtractorLSBP, and OpenCVForUnity.VideoModule.BackgroundSubtractorMOG2.

Dispose()

override void OpenCVForUnity.VideoModule.BackgroundSubtractor.Dispose ( bool disposing )

protectedvirtual

Reimplemented from OpenCVForUnity.CoreModule.Algorithm.

Reimplemented in OpenCVForUnity.BgsegmModule.BackgroundSubtractorCNT, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGMG, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGSOC, OpenCVForUnity.BgsegmModule.BackgroundSubtractorLSBP, OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG, OpenCVForUnity.VideoModule.BackgroundSubtractorKNN, and OpenCVForUnity.VideoModule.BackgroundSubtractorMOG2.

getBackgroundImage()

virtual void OpenCVForUnity.VideoModule.BackgroundSubtractor.getBackgroundImage ( Mat backgroundImage )

virtual

Computes a background image.

Parameters

backgroundImage

The output background image.

Note

Sometimes the background image can be very blurry, as it contain the average background statistics.

Reimplemented in OpenCVForUnity.BgsegmModule.BackgroundSubtractorCNT, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGMG, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGSOC, and OpenCVForUnity.BgsegmModule.BackgroundSubtractorLSBP.

---

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

• OpenCVForUnity/Assets/OpenCVForUnity/org/opencv/video/BackgroundSubtractor.cs