RealSense_GrabDepthImage


Captures a Depth image using RealSense.

Syntax

C++
Python
 
def RealSense_GrabDepthImage(
	state: RealSense_State,
	outImage: Image,
	/,
	*,
	inConfigFile: str | None = None,
	inSerial: str | None = None,
	inConnectionTimeout: int | None = None,
	inInputQueueSize: int = 12,
	inPoints: list[Point2D] | None = None,
	inRGBSettings: RealSenseRGBConfiguration | None = None,
	inDepthSettings: RealSenseDepthConfiguration | None = None,
	inPostProcessingSettings: RealSensePostProcessingFilters | None = None
)
-> (
	outResult: bool,
	outDistances: list[float]
)

Parameters

Name Type Range Default Description
Input will be modified ioState RealSense_State
Input value inConfigFile str | None None Configuration file with the .json extension
Input value inSerial str | None None Device serial number
Input value inConnectionTimeout int | None None Maximum time to wait for frames in milliseconds
Input value inInputQueueSize int 1 - 12 Capacity of output frames queue
Input value inPoints list[Point2D] | None None Mark the points from which you want to calculate the distance to the camera
Input value inRGBSettings RealSenseRGBConfiguration | None None Settings for RGB stream
Input value inDepthSettings RealSenseDepthConfiguration | None None Settings for Depth and Infrared streams
Input value inPostProcessingSettings RealSensePostProcessingFilters | None None Post-processing filters to choose
Output value outDistances list[float] Distance from every point in meters
Output value outImage Image Output image