BackgroundSubtractorKNN Class |
K-nearest neighbors - based Background/Foreground Segmentation Algorithm.
Inheritance HierarchyNamespace: Emgu.CV
Assembly: Emgu.CV.World (in Emgu.CV.World.dll) Version: 4.0.1.3373 (4.0.1.3373)
SyntaxThe BackgroundSubtractorKNN type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BackgroundSubtractorKNN |
Create a K-nearest neighbors - based Background/Foreground Segmentation Algorithm.
|
Properties| Name | Description | |
|---|---|---|
 | AlgorithmPtr |
Pointer to the unmanaged Algorithm object
|
| BackgroundSubtractorPtr |
Pointer to the unmanaged BackgroundSubtractor object
|
| DetectShadows |
If true, the algorithm detects shadows and marks them.
|
| Dist2Threshold |
The threshold on the squared distance between the pixel and the sample to decide whether a pixel is close to a data sample.
|
| History |
The number of last frames that affect the background model
|
| KNNSamples |
The number of neighbours, the k in the kNN. K is the number of samples that need to be within dist2Threshold in order to decide that pixel is matching the kNN background model.
|
| NSamples |
The number of data samples in the background model
|
| Ptr |
Pointer to the unmanaged object
(Inherited from UnmanagedObject.) |
| ShadowThreshold |
A shadow is detected if pixel is a darker version of the background. The shadow threshold (Tau in the paper) is a threshold defining how much darker the shadow can be. Tau= 0.5 means that if a pixel is more than twice darker then it is not shadow.
|
| ShadowValue |
Shadow value is the value used to mark shadows in the foreground mask. Default value is 127. Value 0 in the mask always means background, 255 means foreground.
|
Methods| Name | Description | |
|---|---|---|
| Dispose |
The dispose function that implements IDisposable interface
(Inherited from DisposableObject.) |
 | DisposeObject |
Release all the unmanaged memory associated with this background model.
(Overrides DisposableObjectDisposeObject.) |
| Equals | (Inherited from Object.) |
| Finalize |
Destructor
(Inherited from DisposableObject.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReleaseManagedResources |
Release the managed resources. This function will be called during the disposal of the current object.
override ride this function if you need to call the Dispose() function on any managed IDisposable object created by the current object
(Inherited from DisposableObject.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
 | _ptr |
A pointer to the unmanaged object
(Inherited from UnmanagedObject.) |
Extension Methods| Name | Description | |
|---|---|---|
 | Apply |
Update the background model
(Defined by BackgroundSubtractorExtension.) |
| Clear |
Clear the algorithm
(Defined by AlgorithmExtensions.) |
| GetBackgroundImage |
Computes a background image.
(Defined by BackgroundSubtractorExtension.) |
| GetDefaultName |
Returns the algorithm string identifier.
This string is used as top level xml/yml node tag when the object is saved to a file or string.
(Defined by AlgorithmExtensions.) |
| IsEmpty |
Returns true if the Algorithm is empty. e.g. in the very beginning or after unsuccessful read.
(Defined by AlgorithmExtensions.) |
| Load |
Loads algorithm from the file
(Defined by AlgorithmExtensions.) |
| LoadFromString |
Loads algorithm from a String
(Defined by AlgorithmExtensions.) |
| Read |
Reads algorithm parameters from a file storage.
(Defined by AlgorithmExtensions.) |
| Save |
Save the algorithm to file
(Defined by AlgorithmExtensions.) |
| SaveToString |
Save the algorithm to a string
(Defined by AlgorithmExtensions.) |
| Write(FileStorage) | Overloaded.
Stores algorithm parameters in a file storage
(Defined by AlgorithmExtensions.) |
| Write(FileStorage, String) | Overloaded.
Stores algorithm parameters in a file storage
(Defined by AlgorithmExtensions.) |
See Also