retinify 0.1.4
Real-Time AI Stereo Vision Library
Loading...
Searching...
No Matches
retinify::Pipeline Class Reference

This class provides an interface for running a stereo matching pipeline. 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::size_t imageHeight, std::size_t imageWidth) 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

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

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::size_t  imageHeight,
std::size_t  imageWidth 
) -> Status
noexcept

Initializes the stereo matching pipeline with the given image dimensions.

Parameters
imageHeightHeight of the input images (in pixels).
imageWidthWidth of the input images (in pixels).
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
leftImageDataPointer to the left image data (8-bit grayscale).
leftImageStrideStride (in bytes) of a row in the left image.
rightImageDataPointer to the right image data (8-bit grayscale).
rightImageStrideStride (in bytes) of a row in the right image.
disparityDataPointer to the output buffer for disparity data (32-bit float).
disparityStrideStride (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: