Struct VariationalRefinement

pub struct VariationalRefinement { /* private fields */ }

Variational optical flow refinement

This class implements variational refinement of the input flow field, i.e. it uses input flow to initialize the minimization of the following functional: , where are color constancy, gradient constancy and smoothness terms respectively. is a robust penalizer to limit the influence of outliers. A complete formulation and a description of the minimization procedure can be found in Brox2004

Implementations

impl VariationalRefinement

pub fn create() -> Result<Ptr<VariationalRefinement>>

Creates an instance of VariationalRefinement

Trait Implementations

impl AlgorithmTrait for VariationalRefinement

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 VariationalRefinement

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 Boxed for VariationalRefinement

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for VariationalRefinement

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

Formats the value using the given formatter.

impl DenseOpticalFlowTrait for VariationalRefinement

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

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

Calculates an optical flow.

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

Releases all inner buffers.

impl DenseOpticalFlowTraitConst for VariationalRefinement

fn as_raw_DenseOpticalFlow(&self) -> *const c_void

impl Drop for VariationalRefinement

fn drop(&mut self)

Executes the destructor for this type.

impl From<VariationalRefinement> for Algorithm

fn from(s: VariationalRefinement) -> Self

Converts to this type from the input type.

impl From<VariationalRefinement> for DenseOpticalFlow

fn from(s: VariationalRefinement) -> Self

Converts to this type from the input type.

impl TryFrom<DenseOpticalFlow> for VariationalRefinement

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl VariationalRefinementTrait for VariationalRefinement

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

fn calc_uv( &mut self, i0: &impl ToInputArray, i1: &impl ToInputArray, flow_u: &mut impl ToInputOutputArray, flow_v: &mut impl ToInputOutputArray, ) -> Result<()>

[calc] function overload to handle separate horizontal (u) and vertical (v) flow components (to avoid extra splits/merges)

fn set_fixed_point_iterations(&mut self, val: i32) -> Result<()>

Number of outer (fixed-point) iterations in the minimization procedure.

fn set_sor_iterations(&mut self, val: i32) -> Result<()>

Number of inner successive over-relaxation (SOR) iterations in the minimization procedure to solve the respective linear system.

fn set_omega(&mut self, val: f32) -> Result<()>

Relaxation factor in SOR

fn set_alpha(&mut self, val: f32) -> Result<()>

Weight of the smoothness term

fn set_delta(&mut self, val: f32) -> Result<()>

Weight of the color constancy term

fn set_gamma(&mut self, val: f32) -> Result<()>

Weight of the gradient constancy term

fn set_epsilon(&mut self, val: f32) -> Result<()>

Norm value shift for robust penalizer

impl VariationalRefinementTraitConst for VariationalRefinement

fn as_raw_VariationalRefinement(&self) -> *const c_void

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

Number of outer (fixed-point) iterations in the minimization procedure.

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

Number of inner successive over-relaxation (SOR) iterations in the minimization procedure to solve the respective linear system.

fn get_omega(&self) -> Result<f32>

Relaxation factor in SOR

fn get_alpha(&self) -> Result<f32>

Weight of the smoothness term

fn get_delta(&self) -> Result<f32>

Weight of the color constancy term

fn get_gamma(&self) -> Result<f32>

Weight of the gradient constancy term

fn get_epsilon(&self) -> Result<f32>

Norm value shift for robust penalizer

impl Send for VariationalRefinement