SDK Application Reference
Before running the example program, first use ListDevices to obtain the camera’s TL version information:
TL version = Gige_2_1: The camera is compliant with the GenICam standard. Please use the sample_genicam_sfnc example program.
TL version = Gige_2_0: The camera is not compliant with the GenICam standard. Please use either the sample_v1 or sample_v2 example program.
Sample Program Descriptions
sample_read_calibration_data: reads camera calibration parameters.sample_binocular_streamceStorage: displays left and right grayscale images with speckle patterns.sample_parameters_depthrange: filters the depth map based on the set minimum and maximum depth thresholds, and displays the processed depth image in real time.sample_parameters_exp_time: selects the color image format and display the color image after setting the exposure time.sample_parameters_laser: sets laser brightness.sample_rw_feature: reads or sets camera features via command lines.sample_stream: selects a specified image format and resolution, and outputs the image data.sample_ForceDeviceIP: forcibly sets the IP address of a network depth camera.sample_trigger: selects the camera work mode and outputs image data.sample_userset_ctl: demonstrates how to obtain the number of User Sets supported for selection and loading by the camera. It uses the User Set 0 (value 8) as an example to perform operations such as adding a description, saving, and reading the description.sample_UserSetCurrent: reads the User Set currently used by the camera and iterates through all the User Sets that can be loaded.sample_UserSetDefault: sets the default User Set to be loaded when the camera powers on.sample_UserSetDescription: sets the description of a User Set.sample_UserSetLoad: iterates through all User Sets and provides a method to determine whether a User Set can be loaded.sample_UserSetSave: adds descriptions to all User Sets supported by the camera.3sample_UserSetSelector: reads the name, tool tip, descriptor, and display name of the User Sets supported by the camera.
ListDevices: demonstrates how to list all the depth cameras that are connected to the host system.DeviceStorage: demonstrates how to read from and write to the camera’s Custom Block Storage area (64KB) and the ISP Block Storage area (64KB).DumpAllFeatures: demonstrates how to list the components and features supported by the depth camera, along with the read and write operations available for each feature.ForceDeviceIP: demonstrates how to manually set the IP address for depth camera.LoopDetect: demonstrates how to address data connection anomalies caused by unstable environmental factors.NetStatistic: demonstrates how to calculate the packet loss rate of the network connection for the depth camera.SimpleView_FetchFrame: demonstrates how to continuously capture and output image data when the depth camera is in continuous capture mode.SimpleView_Callback: demonstrates how to capture image data in continuous capture mode and render it using OpenCV in a separate processing thread to prevent blocking.SimpleView_FetchHisto: demonstrates how to retrieve the image brightness distribution histogram.SimpleView_MultiDevice: demonstrates how to use multiple depth cameras to continuously capture and output image data.SimpleView_Point3D: demonstrates how to acquire 3D point cloud data.SimpleView_Registration: demonstrates how to obtain the intrinsic parameters, extrinsic parameters, depth map, and color image of the depth camera, and align the depth map with the color image.SimpleView_TriggerDelay: demonstrates how to control the camera’s trigger delay.SimpleView_TriggerMode0: demonstrates how to set the depth camera to trigger mode 0, allowing it to continuously capture and output images at the highest frame rate.SimpleView_TriggerMode1: demonstrates how to set the depth camera to trigger mode 1, allowing it to acquire and output images upon receiving a trigger signal.SimpleView_TriggerMode_M2S1: demonstrates how to set the master device (camera) to work in trigger mode 2, and multiple slave devices (cameras) to work in trigger mode 1, in order to achieve cascaded triggering among multiple depth cameras while capturing images simultaneously. Upon receiving a software trigger signal sent by the host computer, the master device outputs a trigger signal via the hardware TRIG_OUT interface, while simultaneously triggering itself to capture and output a depth map. After receiving the hardware trigger signal from the master device, the slave devices capture and output depth maps.SimpleView_TriggerMode_M3S1: demonstrates how to set the master device (camera) to work in trigger mode 3, and multiple slave devices (cameras) to work in trigger mode 1, in order to achieve cascaded triggering of multiple depth cameras at the set frame rate while capturing images simultaneously. The master device outputs a trigger signal through the hardware TRIG_OUT interface at the set frame rate, while simultaneously triggering itself to capture and output a depth map. After receiving the hardware trigger signal from the master device, the slave devices capture and output depth maps.SimpleView_SaveLoadConfig: demonstrates how to write a local JSON file into the camera’s Storage component and load the JSON file that has been written into the Storage component. Additionally, the program supports exporting the JSON file to the local system for checking and configuring parameters.SimpleView_XYZ48: demonstrates how to parse and display depth maps in XYZ format.SimpleView_Point3D_XYZ48: demonstrates how to acquire 3D point cloud data represented in xyz48 format.SimpleView_OpenWithIP: demonstrates how to open the Network depth camera camera with the specified IP address.SimpleView_StreamAsync: demonstrates how to con the camera to acquire streams and output image data asynchronously when the camera works in software trigger mode.SimpleView_StreamAsync1: demonstrates how to con the camera to acquire streams and output image data asynchronously when the camera works in continuous capture mode.SimpleView_PixelsRegistration: demonstrates how to display the position of the depth map center on the color image.
ListDevices_v2: demonstrates how to list all depth cameras that are connected to the host computer.DepthStream_v2: demonstrates how to acquire the depth map from the depth camera.ExposureTimeSetting_v2: demonstrates how to set the exposure time of the camera’s color image.ForceDeviceIP_v2: demonstrates how to forcibly set the IP address of the depth camera.GetCalibData_v2: demonstrates how to get the raw calibration parameters of the depth camera.TofDepthStream_v2: demonstrates how to perform distortion correction on a ToF depth map.IREnhance_v2: performs image enhancement for the IR images of the ToF depth cameras.NetStatistic_v2: demonstrates how to calculate the network packet loss rate of the depth camera.OfflineReconnection_v2: demonstrates how to automatically reconnect the camera after a disconnection.OpenWithInterface_v2: demonstrates how to access the camera through a specified network interface.OpenWithIP_v2: demonstrates how to access the camera through a specified IP address.PointCloud_v2: demonstrates how to acquire and save 3D point cloud data in PLY format.Registration_v2: demonstrates how to register the depth and color images.ResolutionSetting_v2: demonstrates how to set the image resolution through user interaction or by directly specifying the image mode.SaveLoadConfig_v2: demonstrates how to save camera parameters to custom_block.bin (the camera’s internal memory) and export the camera parameters locally from it.SoftTrigger_v2: demonstrates how to acquire and output images upon receiving a trigger signal.StreamAsync_v2: demonstrates how to con the asynchronous output of image data streaming from the camera.