Struct opencv::video::DISOpticalFlow

pub struct DISOpticalFlow { /* private fields */ }

DIS optical flow algorithm.

This class implements the Dense Inverse Search (DIS) optical flow algorithm. More details about the algorithm can be found at Kroeger2016 . Includes three presets with preselected parameters to provide reasonable trade-off between speed and quality. However, even the slowest preset is still relatively fast, use DeepFlow if you need better quality and don’t care about speed.

This implementation includes several additional features compared to the algorithm described in the paper, including spatial propagation of flow vectors ([getUseSpatialPropagation]), as well as an option to utilize an initial flow approximation passed to [calc] (which is, essentially, temporal propagation, if the previous frame’s flow field is passed).

Implementations

impl DISOpticalFlow

pub fn create(preset: i32) -> Result<Ptr<DISOpticalFlow>>

Creates an instance of DISOpticalFlow

Parameters

• preset: one of PRESET_ULTRAFAST, PRESET_FAST and PRESET_MEDIUM

C++ default parameters

• preset: DISOpticalFlow::PRESET_FAST

pub fn create_def() -> Result<Ptr<DISOpticalFlow>>

Creates an instance of DISOpticalFlow

Parameters

• preset: one of PRESET_ULTRAFAST, PRESET_FAST and PRESET_MEDIUM

Note

This alternative version of DISOpticalFlow::create function uses the following default values for its arguments:

• preset: DISOpticalFlow::PRESET_FAST

Trait Implementations

impl AlgorithmTrait for DISOpticalFlow

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 DISOpticalFlow

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 DISOpticalFlow

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl DISOpticalFlowTrait for DISOpticalFlow

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

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

Finest level of the Gaussian pyramid on which the flow is computed (zero level corresponds to the original image resolution). The final flow is obtained by bilinear upscaling.

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

Size of an image patch for matching (in pixels). Normally, default 8x8 patches work well enough in most cases.

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

Stride between neighbor patches. Must be less than patch size. Lower values correspond to higher flow quality.

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

Maximum number of gradient descent iterations in the patch inverse search stage. Higher values may improve quality in some cases.

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

Maximum number of gradient descent iterations in the patch inverse search stage. Higher values may improve quality in some cases.

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

Weight of the smoothness term

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

Weight of the color constancy term

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

Weight of the gradient constancy term

fn set_use_mean_normalization(&mut self, val: bool) -> Result<()>

Whether to use mean-normalization of patches when computing patch distance. It is turned on by default as it typically provides a noticeable quality boost because of increased robustness to illumination variations. Turn it off if you are certain that your sequence doesn’t contain any changes in illumination.

fn set_use_spatial_propagation(&mut self, val: bool) -> Result<()>

Whether to use spatial propagation of good optical flow vectors. This option is turned on by default, as it tends to work better on average and can sometimes help recover from major errors introduced by the coarse-to-fine scheme employed by the DIS optical flow algorithm. Turning this option off can make the output flow field a bit smoother, however.

impl DISOpticalFlowTraitConst for DISOpticalFlow

fn as_raw_DISOpticalFlow(&self) -> *const c_void

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

Finest level of the Gaussian pyramid on which the flow is computed (zero level corresponds to the original image resolution). The final flow is obtained by bilinear upscaling.

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

Size of an image patch for matching (in pixels). Normally, default 8x8 patches work well enough in most cases.

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

Stride between neighbor patches. Must be less than patch size. Lower values correspond to higher flow quality.

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

Maximum number of gradient descent iterations in the patch inverse search stage. Higher values may improve quality in some cases.

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

Number of fixed point iterations of variational refinement per scale. Set to zero to disable variational refinement completely. Higher values will typically result in more smooth and high-quality flow.

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

Weight of the smoothness term

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

Weight of the color constancy term

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

Weight of the gradient constancy term

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

Whether to use mean-normalization of patches when computing patch distance. It is turned on by default as it typically provides a noticeable quality boost because of increased robustness to illumination variations. Turn it off if you are certain that your sequence doesn’t contain any changes in illumination.

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

Whether to use spatial propagation of good optical flow vectors. This option is turned on by default, as it tends to work better on average and can sometimes help recover from major errors introduced by the coarse-to-fine scheme employed by the DIS optical flow algorithm. Turning this option off can make the output flow field a bit smoother, however.

impl Debug for DISOpticalFlow

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

Formats the value using the given formatter.

impl DenseOpticalFlowTrait for DISOpticalFlow

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 DISOpticalFlow

fn as_raw_DenseOpticalFlow(&self) -> *const c_void

impl Drop for DISOpticalFlow

fn drop(&mut self)

Executes the destructor for this type.

impl From<DISOpticalFlow> for Algorithm

fn from(s: DISOpticalFlow) -> Self

Converts to this type from the input type.

impl From<DISOpticalFlow> for DenseOpticalFlow

fn from(s: DISOpticalFlow) -> Self

Converts to this type from the input type.

impl TryFrom<DenseOpticalFlow> for DISOpticalFlow

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Send for DISOpticalFlow