Class StereoDepthConfig

Defined in File StereoDepthConfig.hpp

Inheritance Relationships

Base Type

public dai::Buffer (Class Buffer)

Class Documentation

class StereoDepthConfig : public dai::Buffer 

StereoDepthConfig message.

Public Types

using MedianFilter = dai::MedianFilter

using AlgorithmControl = RawStereoDepthConfig::AlgorithmControl

using PostProcessing = RawStereoDepthConfig::PostProcessing

using CensusTransform = RawStereoDepthConfig::CensusTransform

using CostMatching = RawStereoDepthConfig::CostMatching

using CostAggregation = RawStereoDepthConfig::CostAggregation

Public Functions

StereoDepthConfig(): Construct StereoDepthConfig message.

explicit StereoDepthConfig(std::shared_ptr<RawStereoDepthConfig> ptr)

virtual ~StereoDepthConfig() = default

StereoDepthConfig &setDepthAlign(AlgorithmControl::DepthAlign align)

Parameters:: align – Set the disparity/depth alignment: centered (between the ‘left’ and ‘right’ inputs), or from the perspective of a rectified output stream

StereoDepthConfig &setConfidenceThreshold(int confThr)

Confidence threshold for disparity calculation

Parameters:: confThr – Confidence threshold value 0..255

int getConfidenceThreshold() const: Get confidence threshold for disparity calculation

StereoDepthConfig &setMedianFilter(MedianFilter median)

Parameters:: median – Set kernel size for disparity/depth median filtering, or disable

MedianFilter getMedianFilter() const: Get median filter setting

StereoDepthConfig &setBilateralFilterSigma(uint16_t sigma)

A larger value of the parameter means that farther colors within the pixel neighborhood will be mixed together, resulting in larger areas of semi-equal color.

Parameters:: sigma – Set sigma value for 5x5 bilateral filter. 0..65535

uint16_t getBilateralFilterSigma() const: Get sigma value for 5x5 bilateral filter

StereoDepthConfig &setLeftRightCheckThreshold(int threshold)

Parameters:: threshold – Set threshold for left-right, right-left disparity map combine, 0..255

int getLeftRightCheckThreshold() const: Get threshold for left-right check combine

StereoDepthConfig &setLeftRightCheck(bool enable)

Computes and combines disparities in both L-R and R-L directions, and combine them.

For better occlusion handling, discarding invalid disparity values

StereoDepthConfig &setExtendedDisparity(bool enable): Disparity range increased from 95 to 190, combined from full resolution and downscaled images. Suitable for short range objects

StereoDepthConfig &setSubpixel(bool enable)

Computes disparity with sub-pixel interpolation (3 fractional bits by default).

Suitable for long range. Currently incompatible with extended disparity

StereoDepthConfig &setSubpixelFractionalBits(int subpixelFractionalBits): Number of fractional bits for subpixel mode. Default value: 3. Valid values: 3,4,5. Defines the number of fractional disparities: 2^x. Median filter postprocessing is supported only for 3 fractional bits.

StereoDepthConfig &setDepthUnit(AlgorithmControl::DepthUnit depthUnit)

Set depth unit of depth map.

Meter, centimeter, millimeter, inch, foot or custom unit is available.

StereoDepthConfig &setDisparityShift(int disparityShift): Shift input frame by a number of pixels to increase minimum depth. For example shifting by 48 will change effective disparity search range from (0,95] to [48,143]. An alternative approach to reducing the minZ. We normally only recommend doing this when it is known that there will be no objects farther away than MaxZ, such as having a depth camera mounted above a table pointing down at the table surface.

StereoDepthConfig &setNumInvalidateEdgePixels(int32_t numInvalidateEdgePixels): Invalidate X amount of pixels at the edge of disparity frame. For right and center alignment X pixels will be invalidated from the right edge, for left alignment from the left edge.

AlgorithmControl::DepthUnit getDepthUnit(): Get depth unit of depth map.

float getMaxDisparity() const

Useful for normalization of the disparity map.

Returns:: Maximum disparity value that the node can return

StereoDepthConfig &set(dai::RawStereoDepthConfig config)

Set explicit configuration.

Parameters:: config – Explicit configuration

dai::RawStereoDepthConfig get() const

Retrieve configuration data for StereoDepth.

Returns:: config for stereo depth algorithm