OpticalFlowPCAFlow

Struct OpticalFlowPCAFlow 

Source
pub struct OpticalFlowPCAFlow { /* private fields */ }
Expand description

PCAFlow algorithm.

Implementations§

Source§

impl OpticalFlowPCAFlow

Source

pub fn new( _prior: Ptr<PCAPrior>, _basis_size: Size, _sparse_rate: f32, _retained_corners_fraction: f32, _occlusions_threshold: f32, _damping_factor: f32, _clahe_clip: f32, ) -> Result<OpticalFlowPCAFlow>

Creates an instance of PCAFlow algorithm.

§Parameters
  • _prior: Learned prior or no prior (default). see also: cv::optflow::PCAPrior
  • _basisSize: Number of basis vectors.
  • _sparseRate: Controls density of sparse matches.
  • _retainedCornersFraction: Retained corners fraction.
  • _occlusionsThreshold: Occlusion threshold.
  • _dampingFactor: Regularization term for solving least-squares. It is not related to the prior regularization.
  • _claheClip: Clip parameter for CLAHE.
§C++ default parameters
  • _prior: Ptr()
  • _basis_size: Size(18,14)
  • _sparse_rate: 0.024
  • _retained_corners_fraction: 0.2
  • _occlusions_threshold: 0.0003
  • _damping_factor: 0.00002
  • _clahe_clip: 14
Source

pub fn new_def() -> Result<OpticalFlowPCAFlow>

Creates an instance of PCAFlow algorithm.

§Parameters
  • _prior: Learned prior or no prior (default). see also: cv::optflow::PCAPrior
  • _basisSize: Number of basis vectors.
  • _sparseRate: Controls density of sparse matches.
  • _retainedCornersFraction: Retained corners fraction.
  • _occlusionsThreshold: Occlusion threshold.
  • _dampingFactor: Regularization term for solving least-squares. It is not related to the prior regularization.
  • _claheClip: Clip parameter for CLAHE.
§Note

This alternative version of [new] function uses the following default values for its arguments:

  • _prior: Ptr()
  • _basis_size: Size(18,14)
  • _sparse_rate: 0.024
  • _retained_corners_fraction: 0.2
  • _occlusions_threshold: 0.0003
  • _damping_factor: 0.00002
  • _clahe_clip: 14

Trait Implementations§

Source§

impl AlgorithmTrait for OpticalFlowPCAFlow

Source§

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

Source§

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

Clears the algorithm state
Source§

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

Reads algorithm parameters from a file storage
Source§

impl AlgorithmTraitConst for OpticalFlowPCAFlow

Source§

fn as_raw_Algorithm(&self) -> *const c_void

Source§

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

Stores algorithm parameters in a file storage
Source§

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

Stores algorithm parameters in a file storage Read more
Source§

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

@deprecated Read more
Source§

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: Read more
Source§

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

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

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).
Source§

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.
Source§

impl Boxed for OpticalFlowPCAFlow

Source§

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

Wrap the specified raw pointer Read more
Source§

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

Return the underlying raw pointer while consuming this wrapper. Read more
Source§

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

Return the underlying raw pointer. Read more
Source§

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

Return the underlying mutable raw pointer Read more
Source§

impl Debug for OpticalFlowPCAFlow

Source§

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

Formats the value using the given formatter. Read more
Source§

impl DenseOpticalFlowTrait for OpticalFlowPCAFlow

Source§

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

Source§

fn calc( &mut self, i0: &impl ToInputArray, i1: &impl ToInputArray, flow: &mut impl ToInputOutputArray, ) -> Result<()>

Calculates an optical flow. Read more
Source§

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

Releases all inner buffers.
Source§

impl DenseOpticalFlowTraitConst for OpticalFlowPCAFlow

Source§

impl Drop for OpticalFlowPCAFlow

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl From<OpticalFlowPCAFlow> for Algorithm

Source§

fn from(s: OpticalFlowPCAFlow) -> Self

Converts to this type from the input type.
Source§

impl From<OpticalFlowPCAFlow> for DenseOpticalFlow

Source§

fn from(s: OpticalFlowPCAFlow) -> Self

Converts to this type from the input type.
Source§

impl OpticalFlowPCAFlowTrait for OpticalFlowPCAFlow

Source§

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

Source§

fn calc( &mut self, i0: &impl ToInputArray, i1: &impl ToInputArray, flow: &mut impl ToInputOutputArray, ) -> Result<()>

Source§

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

Source§

impl OpticalFlowPCAFlowTraitConst for OpticalFlowPCAFlow

Source§

impl Send for OpticalFlowPCAFlow

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<Mat> ModifyInplace for Mat
where Mat: Boxed,

Source§

unsafe fn modify_inplace<Res>( &mut self, f: impl FnOnce(&Mat, &mut Mat) -> Res, ) -> Res

Helper function to call OpenCV functions that allow in-place modification of a Mat or another similar object. By passing a mutable reference to the Mat to this function your closure will get called with the read reference and a write references to the same Mat. This is unsafe in a general case as it leads to having non-exclusive mutable access to the internal data, but it can be useful for some performance sensitive operations. One example of an OpenCV function that allows such in-place modification is imgproc::threshold. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.