Struct StereoBM 

pub struct StereoBM { /* private fields */ }

Class for computing stereo correspondence using the block matching algorithm, introduced and contributed to OpenCV by K. Konolige. @details This class implements a block matching algorithm for stereo correspondence, which is used to compute disparity maps from stereo image pairs. It provides methods to fine-tune parameters such as pre-filtering, texture thresholds, uniqueness ratios, and regions of interest (ROIs) to optimize performance and accuracy.

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, the algorithm will find the best disparity from 0 (default minimum disparity) to numDisparities. The search range can 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 a higher chance for the algorithm to find a wrong correspondence.

Returns

A pointer to the created StereoBM object. @details The function creates a 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

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

Creates StereoBM object

Parameters

• numDisparities: The disparity search range. For each pixel, the algorithm will find the best disparity from 0 (default minimum disparity) to numDisparities. The search range can 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 a higher chance for the algorithm to find a wrong correspondence.

Returns

A pointer to the created StereoBM object. @details The function creates a StereoBM object. You can then call StereoBM::compute() to compute disparity for a specific stereo pair.

Note

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

• 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_: &impl FileNodeTraitConst) -> 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 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 StereoBM

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for StereoBM

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

Formats the value using the given formatter.

impl Drop for StereoBM

fn drop(&mut self)

Executes the destructor for this type.

impl From<CUDA_StereoBM> for StereoBM

fn from(s: CUDA_StereoBM) -> Self

Converts to this type from the input type.

impl From<StereoBM> for Algorithm

fn from(s: StereoBM) -> Self

Converts to this type from the input type.

impl From<StereoBM> for StereoMatcher

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<()>

Sets the type of pre-filtering used in the algorithm.

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

Sets the size of the pre-filter kernel.

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

Sets the truncation value for prefiltered pixels.

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

Sets the threshold for filtering low-texture regions.

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

Sets the uniqueness ratio for filtering ambiguous matches.

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

Sets the size of the smaller block used for texture check.

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

Sets the Region of Interest (ROI) for the left image.

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

Sets the Region of Interest (ROI) for the right image.

impl StereoBMTraitConst for StereoBM

fn as_raw_StereoBM(&self) -> *const c_void

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

Gets the type of pre-filtering currently used in the algorithm.

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

Gets the current size of the pre-filter kernel.

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

Gets the current truncation value for prefiltered pixels.

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

Gets the current texture threshold value.

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

Gets the current uniqueness ratio value.

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

Gets the current size of the smaller block used for texture check.

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

Gets the current Region of Interest (ROI) for the left image.

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

Gets the current Region of Interest (ROI) for the right image.

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 TryFrom<StereoMatcher> for StereoBM

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Send for StereoBM