Struct DisparityWLSFilter

pub struct DisparityWLSFilter { /* private fields */ }

Disparity map filter based on Weighted Least Squares filter (in form of Fast Global Smoother that is a lot faster than traditional Weighted Least Squares filter implementations) and optional use of left-right-consistency-based confidence to refine the results in half-occlusions and uniform areas.

Trait Implementations

impl AlgorithmTrait for DisparityWLSFilter

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 DisparityWLSFilter

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 DisparityWLSFilter

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

Wrap the specified raw pointer

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

Return the underlying raw pointer while consuming this wrapper.

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

Return the underlying raw pointer.

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

Return the underlying mutable raw pointer

impl Debug for DisparityWLSFilter

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

Formats the value using the given formatter.

impl DisparityFilterTrait for DisparityWLSFilter

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

fn filter( &mut self, disparity_map_left: &impl ToInputArray, left_view: &impl ToInputArray, filtered_disparity_map: &mut impl ToOutputArray, disparity_map_right: &impl ToInputArray, roi: Rect, right_view: &impl ToInputArray, ) -> Result<()>

Apply filtering to the disparity map.

fn filter_def( &mut self, disparity_map_left: &impl ToInputArray, left_view: &impl ToInputArray, filtered_disparity_map: &mut impl ToOutputArray, ) -> Result<()>

Apply filtering to the disparity map.

impl DisparityFilterTraitConst for DisparityWLSFilter

fn as_raw_DisparityFilter(&self) -> *const c_void

impl DisparityWLSFilterTrait for DisparityWLSFilter

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

fn get_lambda(&mut self) -> Result<f64>

Lambda is a parameter defining the amount of regularization during filtering. Larger values force filtered disparity map edges to adhere more to source image edges. Typical value is 8000.

fn set_lambda(&mut self, _lambda: f64) -> Result<()>

See also

fn get_sigma_color(&mut self) -> Result<f64>

SigmaColor is a parameter defining how sensitive the filtering process is to source image edges. Large values can lead to disparity leakage through low-contrast edges. Small values can make the filter too sensitive to noise and textures in the source image. Typical values range from 0.8 to 2.0.

fn set_sigma_color(&mut self, _sigma_color: f64) -> Result<()>

See also

fn get_lr_cthresh(&mut self) -> Result<i32>

LRCthresh is a threshold of disparity difference used in left-right-consistency check during confidence map computation. The default value of 24 (1.5 pixels) is virtually always good enough.

fn set_lr_cthresh(&mut self, _lrc_thresh: i32) -> Result<()>

See also

fn get_depth_discontinuity_radius(&mut self) -> Result<i32>

DepthDiscontinuityRadius is a parameter used in confidence computation. It defines the size of low-confidence regions around depth discontinuities.

fn set_depth_discontinuity_radius(&mut self, _disc_radius: i32) -> Result<()>

See also

fn get_confidence_map(&mut self) -> Result<Mat>

Get the confidence map that was used in the last filter call. It is a CV_32F one-channel image with values ranging from 0.0 (totally untrusted regions of the raw disparity map) to 255.0 (regions containing correct disparity values with a high degree of confidence).

fn get_roi(&mut self) -> Result<Rect>

Get the ROI used in the last filter call

impl DisparityWLSFilterTraitConst for DisparityWLSFilter

fn as_raw_DisparityWLSFilter(&self) -> *const c_void

impl Drop for DisparityWLSFilter

fn drop(&mut self)

Executes the destructor for this type.

impl From<DisparityWLSFilter> for Algorithm

fn from(s: DisparityWLSFilter) -> Self

Converts to this type from the input type.

impl From<DisparityWLSFilter> for DisparityFilter

fn from(s: DisparityWLSFilter) -> Self

Converts to this type from the input type.

impl TryFrom<DisparityFilter> for DisparityWLSFilter

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Send for DisparityWLSFilter