Struct opencv::optflow::DualTVL1OpticalFlow
source · pub struct DualTVL1OpticalFlow { /* private fields */ }
Expand description
“Dual TV L1” Optical Flow Algorithm.
The class implements the “Dual TV L1” optical flow algorithm described in Zach2007 and Javier2012 . Here are important members of the class that control the algorithm, which you can set after constructing the class instance:
-
member double tau Time step of the numerical scheme.
-
member double lambda Weight parameter for the data term, attachment parameter. This is the most relevant parameter, which determines the smoothness of the output. The smaller this parameter is, the smoother the solutions we obtain. It depends on the range of motions of the images, so its value should be adapted to each image sequence.
-
member double theta Weight parameter for (u - v)^2, tightness parameter. It serves as a link between the attachment and the regularization terms. In theory, it should have a small value in order to maintain both parts in correspondence. The method is stable for a large range of values of this parameter.
-
member int nscales Number of scales used to create the pyramid of images.
-
member int warps Number of warpings per scale. Represents the number of times that I1(x+u0) and grad( I1(x+u0) ) are computed per scale. This is a parameter that assures the stability of the method. It also affects the running time, so it is a compromise between speed and accuracy.
-
member double epsilon Stopping criterion threshold used in the numerical scheme, which is a trade-off between precision and running time. A small value will yield more accurate solutions at the expense of a slower convergence.
-
member int iterations Stopping criterion iterations number used in the numerical scheme.
C. Zach, T. Pock and H. Bischof, “A Duality Based Approach for Realtime TV-L1 Optical Flow”. Javier Sanchez, Enric Meinhardt-Llopis and Gabriele Facciolo. “TV-L1 Optical Flow Estimation”.
Implementations§
source§impl DualTVL1OpticalFlow
impl DualTVL1OpticalFlow
sourcepub fn create(
tau: f64,
lambda: f64,
theta: f64,
nscales: i32,
warps: i32,
epsilon: f64,
innner_iterations: i32,
outer_iterations: i32,
scale_step: f64,
gamma: f64,
median_filtering: i32,
use_initial_flow: bool
) -> Result<Ptr<DualTVL1OpticalFlow>>
pub fn create( tau: f64, lambda: f64, theta: f64, nscales: i32, warps: i32, epsilon: f64, innner_iterations: i32, outer_iterations: i32, scale_step: f64, gamma: f64, median_filtering: i32, use_initial_flow: bool ) -> Result<Ptr<DualTVL1OpticalFlow>>
Creates instance of cv::DualTVL1OpticalFlow
§C++ default parameters
- tau: 0.25
- lambda: 0.15
- theta: 0.3
- nscales: 5
- warps: 5
- epsilon: 0.01
- innner_iterations: 30
- outer_iterations: 10
- scale_step: 0.8
- gamma: 0.0
- median_filtering: 5
- use_initial_flow: false
sourcepub fn create_def() -> Result<Ptr<DualTVL1OpticalFlow>>
pub fn create_def() -> Result<Ptr<DualTVL1OpticalFlow>>
Creates instance of cv::DualTVL1OpticalFlow
§Note
This alternative version of DualTVL1OpticalFlow::create function uses the following default values for its arguments:
- tau: 0.25
- lambda: 0.15
- theta: 0.3
- nscales: 5
- warps: 5
- epsilon: 0.01
- innner_iterations: 30
- outer_iterations: 10
- scale_step: 0.8
- gamma: 0.0
- median_filtering: 5
- use_initial_flow: false
Trait Implementations§
source§impl AlgorithmTrait for DualTVL1OpticalFlow
impl AlgorithmTrait for DualTVL1OpticalFlow
source§impl AlgorithmTraitConst for DualTVL1OpticalFlow
impl AlgorithmTraitConst for DualTVL1OpticalFlow
fn as_raw_Algorithm(&self) -> *const c_void
source§fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>
fn write(&self, fs: &mut impl FileStorageTrait) -> Result<()>
source§fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>
fn write_1(&self, fs: &mut impl FileStorageTrait, name: &str) -> Result<()>
source§fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>
fn write_with_name(&self, fs: &Ptr<FileStorage>, name: &str) -> Result<()>
source§fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>
fn write_with_name_def(&self, fs: &Ptr<FileStorage>) -> Result<()>
§Note
source§fn empty(&self) -> Result<bool>
fn empty(&self) -> Result<bool>
source§fn save(&self, filename: &str) -> Result<()>
fn save(&self, filename: &str) -> Result<()>
source§fn get_default_name(&self) -> Result<String>
fn get_default_name(&self) -> Result<String>
source§impl Boxed for DualTVL1OpticalFlow
impl Boxed for DualTVL1OpticalFlow
source§unsafe fn from_raw(
ptr: <DualTVL1OpticalFlow as OpenCVFromExtern>::ExternReceive
) -> Self
unsafe fn from_raw( ptr: <DualTVL1OpticalFlow as OpenCVFromExtern>::ExternReceive ) -> Self
source§fn into_raw(
self
) -> <DualTVL1OpticalFlow as OpenCVTypeExternContainer>::ExternSendMut
fn into_raw( self ) -> <DualTVL1OpticalFlow as OpenCVTypeExternContainer>::ExternSendMut
source§fn as_raw(
&self
) -> <DualTVL1OpticalFlow as OpenCVTypeExternContainer>::ExternSend
fn as_raw( &self ) -> <DualTVL1OpticalFlow as OpenCVTypeExternContainer>::ExternSend
source§fn as_raw_mut(
&mut self
) -> <DualTVL1OpticalFlow as OpenCVTypeExternContainer>::ExternSendMut
fn as_raw_mut( &mut self ) -> <DualTVL1OpticalFlow as OpenCVTypeExternContainer>::ExternSendMut
source§impl Debug for DualTVL1OpticalFlow
impl Debug for DualTVL1OpticalFlow
source§impl DenseOpticalFlowTrait for DualTVL1OpticalFlow
impl DenseOpticalFlowTrait for DualTVL1OpticalFlow
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<()>
fn calc( &mut self, i0: &impl ToInputArray, i1: &impl ToInputArray, flow: &mut impl ToInputOutputArray ) -> Result<()>
source§fn collect_garbage(&mut self) -> Result<()>
fn collect_garbage(&mut self) -> Result<()>
source§impl DenseOpticalFlowTraitConst for DualTVL1OpticalFlow
impl DenseOpticalFlowTraitConst for DualTVL1OpticalFlow
fn as_raw_DenseOpticalFlow(&self) -> *const c_void
source§impl Drop for DualTVL1OpticalFlow
impl Drop for DualTVL1OpticalFlow
source§impl DualTVL1OpticalFlowTrait for DualTVL1OpticalFlow
impl DualTVL1OpticalFlowTrait for DualTVL1OpticalFlow
fn as_raw_mut_DualTVL1OpticalFlow(&mut self) -> *mut c_void
source§fn set_lambda(&mut self, val: f64) -> Result<()>
fn set_lambda(&mut self, val: f64) -> Result<()>
source§fn set_theta(&mut self, val: f64) -> Result<()>
fn set_theta(&mut self, val: f64) -> Result<()>
source§fn set_gamma(&mut self, val: f64) -> Result<()>
fn set_gamma(&mut self, val: f64) -> Result<()>
source§fn set_scales_number(&mut self, val: i32) -> Result<()>
fn set_scales_number(&mut self, val: i32) -> Result<()>
source§fn set_warpings_number(&mut self, val: i32) -> Result<()>
fn set_warpings_number(&mut self, val: i32) -> Result<()>
source§fn set_epsilon(&mut self, val: f64) -> Result<()>
fn set_epsilon(&mut self, val: f64) -> Result<()>
source§fn set_inner_iterations(&mut self, val: i32) -> Result<()>
fn set_inner_iterations(&mut self, val: i32) -> Result<()>
source§impl DualTVL1OpticalFlowTraitConst for DualTVL1OpticalFlow
impl DualTVL1OpticalFlowTraitConst for DualTVL1OpticalFlow
fn as_raw_DualTVL1OpticalFlow(&self) -> *const c_void
source§fn get_lambda(&self) -> Result<f64>
fn get_lambda(&self) -> Result<f64>
source§fn get_theta(&self) -> Result<f64>
fn get_theta(&self) -> Result<f64>
source§fn get_gamma(&self) -> Result<f64>
fn get_gamma(&self) -> Result<f64>
source§fn get_scales_number(&self) -> Result<i32>
fn get_scales_number(&self) -> Result<i32>
source§fn get_epsilon(&self) -> Result<f64>
fn get_epsilon(&self) -> Result<f64>
source§fn get_inner_iterations(&self) -> Result<i32>
fn get_inner_iterations(&self) -> Result<i32>
source§impl From<DualTVL1OpticalFlow> for Algorithm
impl From<DualTVL1OpticalFlow> for Algorithm
source§fn from(s: DualTVL1OpticalFlow) -> Self
fn from(s: DualTVL1OpticalFlow) -> Self
source§impl From<DualTVL1OpticalFlow> for DenseOpticalFlow
impl From<DualTVL1OpticalFlow> for DenseOpticalFlow
source§fn from(s: DualTVL1OpticalFlow) -> Self
fn from(s: DualTVL1OpticalFlow) -> Self
impl Send for DualTVL1OpticalFlow
Auto Trait Implementations§
impl Freeze for DualTVL1OpticalFlow
impl RefUnwindSafe for DualTVL1OpticalFlow
impl !Sync for DualTVL1OpticalFlow
impl Unpin for DualTVL1OpticalFlow
impl UnwindSafe for DualTVL1OpticalFlow
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<Mat> ModifyInplace for Matwhere
Mat: Boxed,
impl<Mat> ModifyInplace for Matwhere
Mat: Boxed,
source§unsafe fn modify_inplace<Res>(
&mut self,
f: impl FnOnce(&Mat, &mut Mat) -> Res
) -> Res
unsafe fn modify_inplace<Res>( &mut self, f: impl FnOnce(&Mat, &mut Mat) -> Res ) -> Res
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 of course unsafe as it breaks the Rust aliasing rules, but it might be useful for some performance
sensitive operations. One example of an OpenCV function that allows such in-place modification is imgproc::threshold
. Read more