InitLidarParameters Class Reference

Structure containing the options used to initialize the Lidar object. More...

Functions

def __init__ (self, mode=LIDAR_MODE.AUTO, depth_minimum_distance=0.0, depth_maximum_distance=0.0, coordinate_units=UNIT.METER, coordinate_system=COORDINATE_SYSTEM.IMAGE, svo_real_time_mode=False, auto_recovery_on_config_change=True, multicast_mode=LIDAR_MULTICAST_MODE.AUTO, multicast_group="", sdk_verbose=1, sdk_verbose_log_file="")
 Default constructor.
 
LIDAR_MODE mode (self)
 Lidar mode (resolution and frequency).
 
float depth_minimum_distance (self)
 Minimum distance for data.
 
float depth_maximum_distance (self)
 Maximum distance for data.
 
UNIT coordinate_units (self)
 Unit of spatial data.
 
COORDINATE_SYSTEM coordinate_system (self)
 Coordinate system for spatial data.
 
bool svo_real_time_mode (self)
 Defines if the Lidar returns frames in real-time mode during OSF playback.
 
bool auto_recovery_on_config_change (self)
 Enable automatic recovery when sensor configuration changes externally. More...
 
LIDAR_MULTICAST_MODE multicast_mode (self)
 Multicast mode for multi-client data sharing. More...
 
str multicast_group (self)
 Multicast group IP address (range 239.0.0.0 - 239.255.255.255). More...
 
int sdk_verbose (self)
 Enable the Lidar SDK verbose mode. More...
 
str sdk_verbose_log_file (self)
 File path to store the Lidar SDK logs (if sdk_verbose is enabled). More...
 
InputType input (self)
 Input type (stream, SVO file, etc.).
 
def set_from_stream (self, str, ip, int, port=0)
 Set input from stream IP address.
 

Detailed Description

Structure containing the options used to initialize the Lidar object.

Functions

◆ auto_recovery_on_config_change()

bool auto_recovery_on_config_change (   self)

Enable automatic recovery when sensor configuration changes externally.

When enabled, SDK detects config changes and automatically reconnects. Default: True

◆ multicast_mode()

LIDAR_MULTICAST_MODE multicast_mode (   self)

Multicast mode for multi-client data sharing.

OFF: force unicast, AUTO: smart detection, ON: force multicast. Default: AUTO

◆ multicast_group()

str multicast_group (   self)

Multicast group IP address (range 239.0.0.0 - 239.255.255.255).

If empty and multicast_mode is ON, auto-selects 239.201.201.201. Default: "" (empty)

◆ sdk_verbose()

int sdk_verbose (   self)

Enable the Lidar SDK verbose mode.

This parameter allows you to enable the verbosity of the Lidar SDK to get a variety of runtime information in the console.
When developing an application, enabling verbose (sdk_verbose >= 1) mode can help you understand the current Lidar SDK behavior.
However, this might not be desirable in a shipped version.
Default: 1 (verbose messages enabled)

Note
The verbose messages can also be exported into a log file.
See sdk_verbose_log_file for more.

◆ sdk_verbose_log_file()

str sdk_verbose_log_file (   self)

File path to store the Lidar SDK logs (if sdk_verbose is enabled).

The file will be created if it does not exist.
Default: "" (logs are printed to console only)