retinify::tools::StereoMatchingPipeline Class Reference

This class provides an interface for running a stereo matching pipeline using OpenCV. More...

#include <pipeline.hpp>

Public Member Functions
	StereoMatchingPipeline () noexcept=default
	~StereoMatchingPipeline () noexcept=default
	StereoMatchingPipeline (const StereoMatchingPipeline &)=delete
auto	operator= (const StereoMatchingPipeline &) noexcept -> StereoMatchingPipeline &=delete
	StereoMatchingPipeline (StereoMatchingPipeline &&)=delete
auto	operator= (StereoMatchingPipeline &&other) noexcept -> StereoMatchingPipeline &=delete
auto	Initialize (Mode mode=Mode::ACCURATE) noexcept -> Status
	Initializes the stereo matching pipeline with the specified processing mode.
auto	Run (const cv::Mat &leftImage, const cv::Mat &rightImage, cv::Mat &disparity) noexcept -> Status
	Runs the stereo matching pipeline.
auto	RunWithLeftRightConsistencyCheck (const cv::Mat &leftImage, const cv::Mat &rightImage, cv::Mat &disparity, float maxDisparityDifference=1.0F) noexcept -> Status
	Runs the stereo matching pipeline with left-right consistency check on the provided images.

Detailed Description

This class provides an interface for running a stereo matching pipeline using OpenCV.

Constructor & Destructor Documentation

StereoMatchingPipeline() [1/3]

retinify::tools::StereoMatchingPipeline::StereoMatchingPipeline ( )

defaultnoexcept

~StereoMatchingPipeline()

retinify::tools::StereoMatchingPipeline::~StereoMatchingPipeline ( )

defaultnoexcept

StereoMatchingPipeline() [2/3]

retinify::tools::StereoMatchingPipeline::StereoMatchingPipeline ( const StereoMatchingPipeline &  )

delete

StereoMatchingPipeline() [3/3]

retinify::tools::StereoMatchingPipeline::StereoMatchingPipeline ( StereoMatchingPipeline &&  )

delete

Member Function Documentation

Initialize()

auto retinify::tools::StereoMatchingPipeline::Initialize ( Mode  mode = Mode::ACCURATE ) -> Status

noexcept

Initializes the stereo matching pipeline with the specified processing mode.

Parameters

mode	The processing mode to use for the stereo matching pipeline.

Returns

A Status object indicating whether initialization succeeded.

operator=() [1/2]

auto retinify::tools::StereoMatchingPipeline::operator= ( const StereoMatchingPipeline &  ) -> StereoMatchingPipeline &=delete

deletenoexcept

operator=() [2/2]

auto retinify::tools::StereoMatchingPipeline::operator= ( StereoMatchingPipeline &&  other ) -> StereoMatchingPipeline &=delete

deletenoexcept

Run()

auto retinify::tools::StereoMatchingPipeline::Run ( const cv::Mat &  leftImage, const cv::Mat &  rightImage, cv::Mat &  disparity  ) -> Status

noexcept

Runs the stereo matching pipeline.

Parameters

leftImage	The left input image as a cv::Mat.
rightImage	The right input image as a cv::Mat.
disparity	The output disparity map as a cv::Mat.

Returns

A Status object indicating whether the operation succeeded.

Note

Input images are resized internally, so as long as the left and right images share the same dimensions, their original sizes don’t matter.

RunWithLeftRightConsistencyCheck()

auto retinify::tools::StereoMatchingPipeline::RunWithLeftRightConsistencyCheck ( const cv::Mat &  leftImage, const cv::Mat &  rightImage, cv::Mat &  disparity, float  maxDisparityDifference = 1.0F  ) -> Status

noexcept

Runs the stereo matching pipeline with left-right consistency check on the provided images.

Parameters

leftImage	The left input image as a cv::Mat.
rightImage	The right input image as a cv::Mat.
disparity	The output disparity map as a cv::Mat.
maxDisparityDifference	Maximum allowed disparity difference for left-right consistency check. If the value is less than or equal to 0, the check will be skipped.

Returns

A Status object indicating whether the operation succeeded.

Note

Input images are resized internally, so as long as the left and right images share the same dimensions, their original sizes don’t matter.

---

The documentation for this class was generated from the following file:

• /home/runner/work/retinify/retinify/tools/include/retinify/tools/pipeline.hpp