BackgroundSubtractor

Objective-C

@interface BackgroundSubtractor : Algorithm

Swift

class BackgroundSubtractor : Algorithm

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 of Video


                    
                    
                    -apply:fgmask:learningRate:

Computes a foreground mask.

Objective-C

- (void)apply:(nonnull Mat *)image
          fgmask:(nonnull Mat *)fgmask
    learningRate:(double)learningRate;

Swift

func apply(image: Mat, fgmask: Mat, learningRate: Double)

`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.


                    
                    
                    -apply:fgmask:

Computes a foreground mask.

Objective-C

- (void)apply:(nonnull Mat *)image fgmask:(nonnull Mat *)fgmask;

Swift

func apply(image: Mat, fgmask: Mat)

`image`	Next video frame.
`fgmask`	The output foreground mask as an 8-bit binary image. 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.


                    
                    
                    -getBackgroundImage:

Computes a background image.

Objective-C

- (void)getBackgroundImage:(nonnull Mat *)backgroundImage;

Swift

func getBackgroundImage(backgroundImage: Mat)


                                backgroundImage

The output background image.

Note

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