Struct opencv::calib3d::StereoBM

pub struct StereoBM { /* private fields */ }

Class for computing stereo correspondence using the block matching algorithm, introduced and contributed to OpenCV by K. Konolige.

Implementations

impl StereoBM

pub fn create(num_disparities: i32, block_size: i32) -> Result<Ptr<StereoBM>>

Creates StereoBM object

Parameters

• numDisparities: the disparity search range. For each pixel algorithm will find the best disparity from 0 (default minimum disparity) to numDisparities. The search range can then be shifted by changing the minimum disparity.
• blockSize: the linear size of the blocks compared by the algorithm. The size should be odd (as the block is centered at the current pixel). Larger block size implies smoother, though less accurate disparity map. Smaller block size gives more detailed disparity map, but there is higher chance for algorithm to find a wrong correspondence.

The function create StereoBM object. You can then call StereoBM::compute() to compute disparity for a specific stereo pair.

C++ default parameters

• num_disparities: 0
• block_size: 21

Trait Implementations

impl AlgorithmTrait for StereoBM

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

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

Clears the algorithm state

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

Reads algorithm parameters from a file storage

impl AlgorithmTraitConst for StereoBM

fn as_raw_Algorithm(&self) -> *const c_void

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

Stores algorithm parameters in a file storage

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

Stores algorithm parameters in a file storage

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

@deprecated

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 StereoBM

unsafe fn from_raw(ptr: *mut c_void) -> Self

Wrap the specified raw pointer

fn into_raw(self) -> *mut c_void

Return an the underlying raw pointer while consuming this wrapper.

fn as_raw(&self) -> *const c_void

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Drop for StereoBM

fn drop(&mut self)

Executes the destructor for this type.

impl From<StereoBM> for Algorithm

fn from(s: StereoBM) -> Self

Converts to this type from the input type.

impl StereoBMTrait for StereoBM

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

fn set_pre_filter_type(&mut self, pre_filter_type: i32) -> Result<()>

fn set_pre_filter_size(&mut self, pre_filter_size: i32) -> Result<()>

fn set_pre_filter_cap(&mut self, pre_filter_cap: i32) -> Result<()>

fn set_texture_threshold(&mut self, texture_threshold: i32) -> Result<()>

fn set_uniqueness_ratio(&mut self, uniqueness_ratio: i32) -> Result<()>

fn set_smaller_block_size(&mut self, block_size: i32) -> Result<()>

fn set_roi1(&mut self, roi1: Rect) -> Result<()>

fn set_roi2(&mut self, roi2: Rect) -> Result<()>

impl StereoBMTraitConst for StereoBM

fn as_raw_StereoBM(&self) -> *const c_void

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

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

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

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

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

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

fn get_roi1(&self) -> Result<Rect>

fn get_roi2(&self) -> Result<Rect>

impl StereoMatcherTrait for StereoBM

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

fn compute( &mut self, left: &impl ToInputArray, right: &impl ToInputArray, disparity: &mut impl ToOutputArray ) -> Result<()>

Computes disparity map for the specified stereo pair

fn set_min_disparity(&mut self, min_disparity: i32) -> Result<()>

fn set_num_disparities(&mut self, num_disparities: i32) -> Result<()>

fn set_block_size(&mut self, block_size: i32) -> Result<()>

fn set_speckle_window_size(&mut self, speckle_window_size: i32) -> Result<()>

fn set_speckle_range(&mut self, speckle_range: i32) -> Result<()>

fn set_disp12_max_diff(&mut self, disp12_max_diff: i32) -> Result<()>

impl StereoMatcherTraitConst for StereoBM

fn as_raw_StereoMatcher(&self) -> *const c_void

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

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

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

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

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

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

impl Send for StereoBM