This documentation is for a prerelease version of O3DE. Click here to switch to the latest release, or select a version from the dropdown.

Version:

ROS 2 Lidar Sensor Component

The ROS 2 Lidar Sensor component encapsulates simulation of lidar including data acquisition and publishing. It uses abstraction to enable easily replaceable implementations, differing in how to acquire points. Lidars are useful for tasks such as obstacle detection, localization, and navigation.

Provider

ROS 2 Gem

Dependencies

ROS 2 Frame component

Properties

ROS 2 Lidar Sensor component properties

PropertyDescriptionValuesDefault
Sensor ConfigurationSee Sensor Configuration properties
Lidar ModelWhat kind of lidar it is. This can be a custom one or corresponding to a real device.EnumerationCustom3DLidar
Lidar ImplementationWhich mechanism to use for ray-casting (or other methods of acquiring data). Implementations can be registered by external Gems.EnumerationSceneQueries
Ignore Collision LayersCollision layers to ignore when acquiring data. This is useful to avoid obstruction by the sensor mesh itself.Listempty
Enable SegmentationWhether to enable the class and instance segmentation feature. See Class Segmentation Configuration ComponentBooleanfalse
Points At MaxWhether to return points for values above maximum range (with infinity value).Booleanfalse

Note that depending on the lidar implementation, some additional properties may be present. You can modify lidar parameters for custom lidars, but not for specific lidar models, which have more complex firing patterns which are only approximately reflected by these properties.

PropertyDescriptionValuesDefault
NameName of the lidar, which reflects the choice of modelStringCustomLidar
LayersHow many vertical layers the lidar has.Integer24
Points per layerHow many point for each layer the lidar returns.Integer924
LayersHow many vertical layers the lidar has.Integer24
Min Horizontal AngleMinimal horizontal angle for lidar firing pattern (degrees).Float-180.0
Max Horizontal AngleMaximum horizontal angle for lidar firing pattern (degrees).Float180.0
Min Vertical AngleMinimal vertical angle for lidar firing pattern (degrees).Float-35.0
Max Vertical AngleMaximum vertical angle for lidar firing pattern (degrees).Float35.0
Min rangeSmallest distance at which lidar returns a point.Float0.0
Max rangeLargest distance at which lidar returns a real point. Note that if Points At Max is set, data will include infinity value points for max range.Float100.0

Usage

Add ROS 2 Lidar Sensor to your robot to simulate lidar data. Select lidar implementation and the model you would like to simulate.

If you have an NVIDIA graphics card, consider an efficient GPU implementation provided by RGL Gem . It is orders of magnitude faster than the default implementation, based on Physics scene queries. RGL Gem also supports several popular lidar models.