retinify::Pipeline Class Reference

A retinify::Pipeline provides an interface for running a stereo matching. More...

#include <pipeline.hpp>

Public Member Functions
	Pipeline () noexcept
	~Pipeline () noexcept
	Pipeline (const Pipeline &)=delete
auto	operator= (const Pipeline &) noexcept -> Pipeline &=delete
	Pipeline (Pipeline &&) noexcept=delete
auto	operator= (Pipeline &&) noexcept -> Pipeline &=delete
auto	Initialize (std::uint32_t imageWidth, std::uint32_t imageHeight, PixelFormat pixelFormat=PixelFormat::RGB8, DepthMode depthMode=DepthMode::ACCURATE, const CalibrationParameters &calibrationParameters=CalibrationParameters{}) noexcept -> Status
	Initializes the stereo matching pipeline with the given image dimensions.
auto	Run (const std::uint8_t *leftImageData, std::size_t leftImageStride, const std::uint8_t *rightImageData, std::size_t rightImageStride, float *disparityData, std::size_t disparityStride) noexcept -> Status
	Executes the stereo matching pipeline using the given left and right image data.

Detailed Description

A retinify::Pipeline provides an interface for running a stereo matching.

Constructor & Destructor Documentation

Pipeline() [1/3]

retinify::Pipeline::Pipeline ( )

noexcept

~Pipeline()

retinify::Pipeline::~Pipeline ( )

noexcept

Pipeline() [2/3]

retinify::Pipeline::Pipeline ( const Pipeline &  )

delete

Pipeline() [3/3]

retinify::Pipeline::Pipeline ( Pipeline &&  )

deletenoexcept

Member Function Documentation

Initialize()

auto retinify::Pipeline::Initialize ( std::uint32_t  imageWidth, std::uint32_t  imageHeight, PixelFormat  pixelFormat = PixelFormat::RGB8, DepthMode  depthMode = DepthMode::ACCURATE, const CalibrationParameters &  calibrationParameters = CalibrationParameters{}  ) -> Status

noexcept

Initializes the stereo matching pipeline with the given image dimensions.

Parameters

imageWidth	Width of the input images (in pixels).
imageHeight	Height of the input images (in pixels).
pixelFormat	The pixel format of the input images.
depthMode	The depth mode option for the stereo matching.
calibrationParameters	The stereo camera calibration parameters.

Returns

A Status object indicating whether the initialization was successful.

operator=() [1/2]

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

deletenoexcept

operator=() [2/2]

auto retinify::Pipeline::operator= ( Pipeline &&  ) -> Pipeline &=delete

deletenoexcept

Run()

auto retinify::Pipeline::Run ( const std::uint8_t *  leftImageData, std::size_t  leftImageStride, const std::uint8_t *  rightImageData, std::size_t  rightImageStride, float *  disparityData, std::size_t  disparityStride  ) -> Status

noexcept

Executes the stereo matching pipeline using the given left and right image data.

Parameters

leftImageData	Pointer to the left image data.
leftImageStride	Stride (in bytes) of a row in the left image.
rightImageData	Pointer to the right image data.
rightImageStride	Stride (in bytes) of a row in the right image.
disparityData	Pointer to the output buffer for disparity data (32-bit float).
disparityStride	Stride (in bytes) of a row in the output disparity data.

Returns

A Status object indicating whether the operation was successful.

---

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

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