Struct BackgroundSubtractorKNN

pub struct BackgroundSubtractorKNN { /* private fields */ }

K-nearest neighbours - based Background/Foreground Segmentation Algorithm.

The class implements the K-nearest neighbours background subtraction described in Zivkovic2006 . Very efficient if number of foreground pixels is low.

Trait Implementations

impl AlgorithmTrait for BackgroundSubtractorKNN

fn as_raw_mut_Algorithm(&mut self) -> *mut c_void

fn clear(&mut self) -> Result<()>

Clears the algorithm state

fn read(&mut self, fn_: &impl FileNodeTraitConst) -> Result<()>

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for BackgroundSubtractorKNN

fn as_raw_Algorithm(&self) -> *const c_void

fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>

Stores algorithm parameters in a file storage

fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>

Stores algorithm parameters in a file storage

fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>

@deprecated

fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>

👎Deprecated:

Note

Deprecated: ## Note This alternative version of AlgorithmTraitConst::write_with_name function uses the following default values for its arguments:

fn empty(&self) -> Result<bool>

Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read

fn save(&self, filename: &str) -> Result<()>

Saves the algorithm to a file. In order to make this method work, the derived class must implement Algorithm::write(FileStorage& fs).

fn get_default_name(&self) -> Result<String>

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.

impl BackgroundSubtractorKNNTrait for BackgroundSubtractorKNN

fn as_raw_mut_BackgroundSubtractorKNN(&mut self) -> *mut c_void

fn set_history(&mut self, history: i32) -> Result<()>

Sets the number of last frames that affect the background model

fn set_n_samples(&mut self, _n_n: i32) -> Result<()>

Sets the number of data samples in the background model.

fn set_dist2_threshold(&mut self, _dist2_threshold: f64) -> Result<()>

Sets the threshold on the squared distance

fn setk_nn_samples(&mut self, _nk_nn: i32) -> Result<()>

Sets the k in the kNN. How many nearest neighbours need to match.

fn set_detect_shadows(&mut self, detect_shadows: bool) -> Result<()>

Enables or disables shadow detection

fn set_shadow_value(&mut self, value: i32) -> Result<()>

Sets the shadow value

fn set_shadow_threshold(&mut self, threshold: f64) -> Result<()>

Sets the shadow threshold

impl BackgroundSubtractorKNNTraitConst for BackgroundSubtractorKNN

fn as_raw_BackgroundSubtractorKNN(&self) -> *const c_void

fn get_history(&self) -> Result<i32>

Returns the number of last frames that affect the background model

fn get_n_samples(&self) -> Result<i32>

Returns the number of data samples in the background model

fn get_dist2_threshold(&self) -> Result<f64>

Returns the threshold on the squared distance between the pixel and the sample

fn getk_nn_samples(&self) -> Result<i32>

Returns the number of neighbours, the k in the kNN.

fn get_detect_shadows(&self) -> Result<bool>

Returns the shadow detection flag

fn get_shadow_value(&self) -> Result<i32>

Returns the shadow value

fn get_shadow_threshold(&self) -> Result<f64>

Returns the shadow threshold

impl BackgroundSubtractorTrait for BackgroundSubtractorKNN

fn as_raw_mut_BackgroundSubtractor(&mut self) -> *mut c_void

fn apply( &mut self, image: &impl ToInputArray, fgmask: &mut impl ToOutputArray, learning_rate: f64, ) -> Result<()>

Computes a foreground mask.

fn apply_def( &mut self, image: &impl ToInputArray, fgmask: &mut impl ToOutputArray, ) -> Result<()>

Computes a foreground mask.

impl BackgroundSubtractorTraitConst for BackgroundSubtractorKNN

fn as_raw_BackgroundSubtractor(&self) -> *const c_void

fn get_background_image( &self, background_image: &mut impl ToOutputArray, ) -> Result<()>

Computes a background image.

impl Boxed for BackgroundSubtractorKNN

unsafe fn from_raw( ptr: <BackgroundSubtractorKNN as OpenCVFromExtern>::ExternReceive, ) -> Self

Wrap the specified raw pointer

fn into_raw( self, ) -> <BackgroundSubtractorKNN as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper.

fn as_raw( &self, ) -> <BackgroundSubtractorKNN as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer.

fn as_raw_mut( &mut self, ) -> <BackgroundSubtractorKNN as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer

impl Debug for BackgroundSubtractorKNN

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for BackgroundSubtractorKNN

fn drop(&mut self)

Executes the destructor for this type.

impl From<BackgroundSubtractorKNN> for Algorithm

fn from(s: BackgroundSubtractorKNN) -> Self

Converts to this type from the input type.

impl From<BackgroundSubtractorKNN> for BackgroundSubtractor

fn from(s: BackgroundSubtractorKNN) -> Self

Converts to this type from the input type.

impl TryFrom<BackgroundSubtractor> for BackgroundSubtractorKNN

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: BackgroundSubtractor) -> Result<Self>

Performs the conversion.

impl Send for BackgroundSubtractorKNN