69 KiB

Raw Blame History

Sensors reference

Collision detector
Depth camera
GNSS sensor
IMU sensor
Lane invasion detector
LIDAR sensor
Obstacle detector
Radar sensor
RGB camera
RSS sensor
Semantic LIDAR sensor
Semantic segmentation camera
Instance segmentation camera
DVS camera
Optical Flow camera
V2X sensor
- Cooperative awareness
- Custom message

!!! Important All the sensors use the UE coordinate system (x-forward, y-right, z-up), and return coordinates in local space. When using any visualization software, pay attention to its coordinate system. Many invert the Y-axis, so visualizing the sensor data directly may result in mirrored outputs.

Collision detector

Blueprint: sensor.other.collision
Output: carla.CollisionEvent per collision.

This sensor registers an event each time its parent actor collides against something in the world. Each collision sensor produces one collision event per collision per frame. Multiple collision events may be produced in a single frame by collisions with multiple other actors. To ensure that collisions with any kind of object are detected, the server creates "fake" actors for elements such as buildings or bushes so the semantic tag can be retrieved to identify it.

Collision detectors do not have any configurable attribute.

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`actor`	carla.Actor	Actor that measured the collision (sensor's parent).
`other_actor`	carla.Actor	Actor against whom the parent collided.
`normal_impulse`	carla.Vector3D	Normal impulse result of the collision.

Depth camera

Blueprint: sensor.camera.depth
Output: carla.Image per step (unless sensor_tick says otherwise).

The camera provides a raw data of the scene codifying the distance of each pixel to the camera (also known as depth buffer or z-buffer) to create a depth map of the elements.

The image codifies depth value per pixel using 3 channels of the RGB color space, from less to more significant bytes: R -> G -> B. The actual distance in meters can be decoded with:

normalized = (R + G * 256 + B * 256 * 256) / (256 * 256 * 256 - 1)
in_meters = 1000 * normalized

The output carla.Image should then be saved to disk using a carla.colorConverter that will turn the distance stored in RGB channels into a [0,1] float containing the distance and then translate this to grayscale. There are two options in carla.colorConverter to get a depth view: Depth and Logaritmic depth. The precision is milimetric in both, but the logarithmic approach provides better results for closer objects.

...
raw_image.save_to_disk("path/to/save/converted/image",carla.Depth)

Basic camera attributes

Blueprint attribute	Type	Default	Description
`image_size_x`	int	800	Image width in pixels.
`image_size_y`	int	600	Image height in pixels.
`fov`	float	90.0	Horizontal field of view in degrees.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).

Camera lens distortion attributes

Blueprint attribute	Type	Default	Description
`lens_circle_falloff`	float	5.0	Range: [0.0, 10.0]
`lens_circle_multiplier`	float	0.0	Range: [0.0, 10.0]
`lens_k`	float	-1.0	Range: [-inf, inf]
`lens_kcube`	float	0.0	Range: [-inf, inf]
`lens_x_size`	float	0.08	Range: [0.0, 1.0]
`lens_y_size`	float	0.08	Range: [0.0, 1.0]

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`width`	int	Image width in pixels.
`height`	int	Image height in pixels.
`fov`	float	Horizontal field of view in degrees.
`raw_data`	bytes	Array of BGRA 32-bit pixels.

GNSS sensor

Blueprint: sensor.other.gnss
Output: carla.GNSSMeasurement per step (unless sensor_tick says otherwise).

Reports current gnss position of its parent object. This is calculated by adding the metric position to an initial geo reference location defined within the OpenDRIVE map definition.

GNSS attributes

Blueprint attribute	Type	Default	Description
`noise_alt_bias`	float	0.0	Mean parameter in the noise model for altitude.
`noise_alt_stddev`	float	0.0	Standard deviation parameter in the noise model for altitude.
`noise_lat_bias`	float	0.0	Mean parameter in the noise model for latitude.
`noise_lat_stddev`	float	0.0	Standard deviation parameter in the noise model for latitude.
`noise_lon_bias`	float	0.0	Mean parameter in the noise model for longitude.
`noise_lon_stddev`	float	0.0	Standard deviation parameter in the noise model for longitude.
`noise_seed`	int	0	Initializer for a pseudorandom number generator.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`latitude`	double	Latitude of the actor.
`longitude`	double	Longitude of the actor.
`altitude`	double	Altitude of the actor.

IMU sensor

Blueprint: sensor.other.imu
Output: carla.IMUMeasurement per step (unless sensor_tick says otherwise).

Provides measures that accelerometer, gyroscope and compass would retrieve for the parent object. The data is collected from the object's current state.

IMU attributes

Blueprint attribute	Type	Default	Description
`noise_accel_stddev_x`	float	0.0	Standard deviation parameter in the noise model for acceleration (X axis).
`noise_accel_stddev_y`	float	0.0	Standard deviation parameter in the noise model for acceleration (Y axis).
`noise_accel_stddev_z`	float	0.0	Standard deviation parameter in the noise model for acceleration (Z axis).
`noise_gyro_bias_x`	float	0.0	Mean parameter in the noise model for the gyroscope (X axis).
`noise_gyro_bias_y`	float	0.0	Mean parameter in the noise model for the gyroscope (Y axis).
`noise_gyro_bias_z`	float	0.0	Mean parameter in the noise model for the gyroscope (Z axis).
`noise_gyro_stddev_x`	float	0.0	Standard deviation parameter in the noise model for the gyroscope (X axis).
`noise_gyro_stddev_y`	float	0.0	Standard deviation parameter in the noise model for the gyroscope (Y axis).
`noise_gyro_stddev_z`	float	0.0	Standard deviation parameter in the noise model for the gyroscope (Z axis).
`noise_seed`	int	0	Initializer for a pseudorandom number generator.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`accelerometer`	carla.Vector3D	Measures linear acceleration in `m/s^2`.
`gyroscope`	carla.Vector3D	Measures angular velocity in `rad/s`.
`compass`	float	Orientation in radians. North is 0 radians.

!!! note For the compass, North is 0 radians. East is pi/2 radians, South is pi radians, West is 3pi/2 radians. North is in the direction of decreasing Y in CARLA's global coordinate system. East is in the direction of increasing X. The compass value converted to degrees is equal to 90 - yaw.

Lane invasion detector

Blueprint: sensor.other.lane_invasion
Output: carla.LaneInvasionEvent per crossing.

Registers an event each time its parent crosses a lane marking. The sensor uses road data provided by the OpenDRIVE description of the map to determine whether the parent vehicle is invading another lane by considering the space between wheels. However there are some things to be taken into consideration:

Discrepancies between the OpenDRIVE file and the map will create irregularities such as crossing lanes that are not visible in the map.
The output retrieves a list of crossed lane markings: the computation is done in OpenDRIVE and considering the whole space between the four wheels as a whole. Thus, there may be more than one lane being crossed at the same time.

This sensor does not have any configurable attribute.

!!! Important This sensor works fully on the client-side.

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`actor`	carla.Actor	Vehicle that invaded another lane (parent actor).
`crossed_lane_markings`	list(carla.LaneMarking)	List of lane markings that have been crossed.

LIDAR sensor

Blueprint: sensor.lidar.ray_cast
Output: carla.LidarMeasurement per step (unless sensor_tick says otherwise).

This sensor simulates a rotating LIDAR implemented using ray-casting. The points are computed by adding a laser for each channel distributed in the vertical FOV. The rotation is simulated computing the horizontal angle that the Lidar rotated in a frame. The point cloud is calculated by doing a ray-cast for each laser in every step. points_per_channel_each_step = points_per_second / (FPS * channels)

A LIDAR measurement contains a package with all the points generated during a 1/FPS interval. During this interval the physics are not updated so all the points in a measurement reflect the same "static picture" of the scene.

This output contains a cloud of simulation points and thus, it can be iterated to retrieve a list of their carla.Location:

for location in lidar_measurement:
    print(location)

The information of the LIDAR measurement is encoded 4D points. Being the first three, the space points in xyz coordinates and the last one intensity loss during the travel. This intensity is computed by the following formula.

a — Attenuation coefficient. This may depend on the sensor's wavelenght, and the conditions of the atmosphere. It can be modified with the LIDAR attribute atmosphere_attenuation_rate. d — Distance from the hit point to the sensor.

For a better realism, points in the cloud can be dropped off. This is an easy way to simulate loss due to external perturbations. This can done combining two different.

General drop-off — Proportion of points that are dropped off randomly. This is done before the tracing, meaning the points being dropped are not calculated, and therefore improves the performance. If dropoff_general_rate = 0.5, half of the points will be dropped.
Instensity-based drop-off — For each point detected, and extra drop-off is performed with a probability based in the computed intensity. This probability is determined by two parameters. dropoff_zero_intensity is the probability of points with zero intensity to be dropped. dropoff_intensity_limit is a threshold intensity above which no points will be dropped. The probability of a point within the range to be dropped is a linear proportion based on these two parameters.

Additionally, the noise_stddev attribute makes for a noise model to simulate unexpected deviations that appear in real-life sensors. For positive values, each point is randomly perturbed along the vector of the laser ray. The result is a LIDAR sensor with perfect angular positioning, but noisy distance measurement.

The rotation of the LIDAR can be tuned to cover a specific angle on every simulation step (using a fixed time-step). For example, to rotate once per step (full circle output, as in the picture below), the rotation frequency and the simulated FPS should be equal.
1. Set the sensor's frequency sensors_bp['lidar'][0].set_attribute('rotation_frequency','10').
2. Run the simulation using python3 config.py --fps=10.

Lidar attributes

Blueprint attribute	Type	Default	Description
`channels`	int	32	Number of lasers.
`range`	float	10.0	Maximum distance to measure/raycast in meters (centimeters for CARLA 0.9.6 or previous).
`points_per_second`	int	56000	Points generated by all lasers per second.
`rotation_frequency`	float	10.0	LIDAR rotation frequency.
`upper_fov`	float	10.0	Angle in degrees of the highest laser.
`lower_fov`	float	-30.0	Angle in degrees of the lowest laser.
`horizontal_fov`	float	360.0	Horizontal field of view in degrees, 0 - 360.
`atmosphere_attenuation_rate`	float	0.004	Coefficient that measures the LIDAR instensity loss per meter. Check the intensity computation above.
`dropoff_general_rate`	float	0.45	General proportion of points that are randomy dropped.
`dropoff_intensity_limit`	float	0.8	For the intensity based drop-off, the threshold intensity value above which no points are dropped.
`dropoff_zero_intensity`	float	0.4	For the intensity based drop-off, the probability of each point with zero intensity being dropped.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).
`noise_stddev`	float	0.0	Standard deviation of the noise model to disturb each point along the vector of its raycast.

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`horizontal_angle`	float	Angle (radians) in the XY plane of the LIDAR in the current frame.
`channels`	int	Number of channels (lasers) of the LIDAR.
`get_point_count(channel)`	int	Number of points per channel captured this frame.
`raw_data`	bytes	Array of 32-bits floats (XYZI of each point).

Obstacle detector

Blueprint: sensor.other.obstacle
Output: carla.ObstacleDetectionEvent per obstacle (unless sensor_tick says otherwise).

Registers an event every time the parent actor has an obstacle ahead. In order to anticipate obstacles, the sensor creates a capsular shape ahead of the parent vehicle and uses it to check for collisions. To ensure that collisions with any kind of object are detected, the server creates "fake" actors for elements such as buildings or bushes so the semantic tag can be retrieved to identify it.

Blueprint attribute	Type	Default	Description
`distance`	float	5	Distance to trace.
`hit_radius`	float	0.5	Radius of the trace.
`only_dynamics`	bool	False	If true, the trace will only consider dynamic objects.
`debug_linetrace`	bool	False	If true, the trace will be visible.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`actor`	carla.Actor	Actor that detected the obstacle (parent actor).
`other_actor`	carla.Actor	Actor detected as an obstacle.
`distance`	float	Distance from `actor` to `other_actor`.

Radar sensor

Blueprint: sensor.other.radar
Output: carla.RadarMeasurement per step (unless sensor_tick says otherwise).

The sensor creates a conic view that is translated to a 2D point map of the elements in sight and their speed regarding the sensor. This can be used to shape elements and evaluate their movement and direction. Due to the use of polar coordinates, the points will concentrate around the center of the view.

Points measured are contained in carla.RadarMeasurement as an array of carla.RadarDetection, which specifies their polar coordinates, distance and velocity. This raw data provided by the radar sensor can be easily converted to a format manageable by numpy:

# To get a numpy [[vel, azimuth, altitude, depth],...[,,,]]:
points = np.frombuffer(radar_data.raw_data, dtype=np.dtype('f4'))
points = np.reshape(points, (len(radar_data), 4))

The provided script manual_control.py uses this sensor to show the points being detected and paint them white when static, red when moving towards the object and blue when moving away:

Blueprint attribute	Type	Default	Description
`horizontal_fov`	float	30.0	Horizontal field of view in degrees.
`points_per_second`	int	1500	Points generated by all lasers per second.
`range`	float	100	Maximum distance to measure/raycast in meters.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).
`vertical_fov`	float	30.0	Vertical field of view in degrees.

Output attributes

Sensor data attribute	Type	Description
`raw_data`	carla.RadarDetection	The list of points detected.

RadarDetection attributes	Type	Description
`altitude`	float	Altitude angle in radians.
`azimuth`	float	Azimuth angle in radians.
`depth`	float	Distance in meters.
`velocity`	float	Velocity towards the sensor.

RGB camera

Blueprint: sensor.camera.rgb
Output: carla.Image per step (unless sensor_tick says otherwise)..

The "RGB" camera acts as a regular camera capturing images from the scene. carla.colorConverter

If enable_postprocess_effects is enabled, a set of post-process effects is applied to the image for the sake of realism:

Vignette: darkens the border of the screen.
Grain jitter: adds some noise to the render.
Bloom: intense lights burn the area around them.
Auto exposure: modifies the image gamma to simulate the eye adaptation to darker or brighter areas.
Lens flares: simulates the reflection of bright objects on the lens.
Depth of field: blurs objects near or very far away of the camera.

The sensor_tick tells how fast we want the sensor to capture the data. A value of 1.5 means that we want the sensor to capture data each second and a half. By default a value of 0.0 means as fast as possible.

Basic camera attributes

Blueprint attribute	Type	Default	Description
`bloom_intensity`	float	0.675	Intensity for the bloom post-process effect, `0.0` for disabling it.
`fov`	float	90.0	Horizontal field of view in degrees.
`fstop`	float	1.4	Opening of the camera lens. Aperture is `1/fstop` with typical lens going down to f/1.2 (larger opening). Larger numbers will reduce the Depth of Field effect.
`image_size_x`	int	800	Image width in pixels.
`image_size_y`	int	600	Image height in pixels.
`iso`	float	100.0	The camera sensor sensitivity.
`gamma`	float	2.2	Target gamma value of the camera.
`lens_flare_intensity`	float	0.1	Intensity for the lens flare post-process effect, `0.0` for disabling it.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).
`shutter_speed`	float	200.0	The camera shutter speed in seconds (1.0/s).

Camera lens distortion attributes

Blueprint attribute	Type	Default	Description
`lens_circle_falloff`	float	5.0	Range: [0.0, 10.0]
`lens_circle_multiplier`	float	0.0	Range: [0.0, 10.0]
`lens_k`	float	-1.0	Range: [-inf, inf]
`lens_kcube`	float	0.0	Range: [-inf, inf]
`lens_x_size`	float	0.08	Range: [0.0, 1.0]
`lens_y_size`	float	0.08	Range: [0.0, 1.0]

Advanced camera attributes

Since these effects are provided by UE, please make sure to check their documentation:

Blueprint attribute	Type	Default	Description
`min_fstop`	float	1.2	Maximum aperture.
`blade_count`	int	5	Number of blades that make up the diaphragm mechanism.
`exposure_mode`	str	`histogram`	Can be `manual` or `histogram`. More in UE4 docs.
`exposure_compensation`	float	Linux: +0.75 Windows: 0.0	Logarithmic adjustment for the exposure. 0: no adjustment, -1:2x darker, -2:4 darker, 1:2x brighter, 2:4x brighter.
`exposure_min_bright`	float	10.0	In `exposure_mode: "histogram"`. Minimum brightness for auto exposure. The lowest the eye can adapt within. Must be greater than 0 and less than or equal to `exposure_max_bright`.
`exposure_max_bright`	float	12.0	In `exposure_mode: "histogram"`. Maximum brightness for auto exposure. The highestthe eye can adapt within. Must be greater than 0 and greater than or equal to `exposure_min_bright`.
`exposure_speed_up`	float	3.0	In `exposure_mode: "histogram"`. Speed at which the adaptation occurs from dark to bright environment.
`exposure_speed_down`	float	1.0	In `exposure_mode: "histogram"`. Speed at which the adaptation occurs from bright to dark environment.
`calibration_constant`	float	16.0	Calibration constant for 18% albedo.
`focal_distance`	float	1000.0	Distance at which the depth of field effect should be sharp. Measured in cm (UE units).
`blur_amount`	float	1.0	Strength/intensity of motion blur.
`blur_radius`	float	0.0	Radius in pixels at 1080p resolution to emulate atmospheric scattering according to distance from camera.
`motion_blur_intensity`	float	0.45	Strength of motion blur [0,1].
`motion_blur_max_distortion`	float	0.35	Max distortion caused by motion blur. Percentage of screen width.
`motion_blur_min_object_screen_size`	float	0.1	Percentage of screen width objects must have for motion blur, lower value means less draw calls.
`slope`	float	0.88	Steepness of the S-curve for the tonemapper. Larger values make the slope steeper (darker) [0.0, 1.0].
`toe`	float	0.55	Adjusts dark color in the tonemapper [0.0, 1.0].
`shoulder`	float	0.26	Adjusts bright color in the tonemapper [0.0, 1.0].
`black_clip`	float	0.0	This should NOT be adjusted. Sets where the crossover happens and black tones start to cut off their value [0.0, 1.0].
`white_clip`	float	0.04	Set where the crossover happens and white tones start to cut off their value. Subtle change in most cases [0.0, 1.0].
`temp`	float	6500.0	White balance in relation to the temperature of the light in the scene. White light: when this matches light temperature. Warm light: When higher than the light in the scene, it is a yellowish color. Cool light: When lower than the light. Blueish color.
`tint`	float	0.0	White balance temperature tint. Adjusts cyan and magenta color ranges. This should be used along with the white balance Temp property to get accurate colors. Under some light temperatures, the colors may appear to be more yellow or blue. This can be used to balance the resulting color to look more natural.
`chromatic_aberration_intensity`	float	0.0	Scaling factor to control color shifting, more noticeable on the screen borders.
`chromatic_aberration_offset`	float	0.0	Normalized distance to the center of the image where the effect takes place.
`enable_postprocess_effects`	bool	True	Post-process effects activation.

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`width`	int	Image width in pixels.
`height`	int	Image height in pixels.
`fov`	float	Horizontal field of view in degrees.
`raw_data`	bytes	Array of BGRA 32-bit pixels.

RSS sensor

Blueprint: sensor.other.rss
Output: carla.RssResponse per step (unless sensor_tick says otherwise).

!!! Important It is highly recommended to read the specific rss documentation before reading this.

This sensor integrates the C++ Library for Responsibility Sensitive Safety in CARLA. It is disabled by default in CARLA, and it has to be explicitly built in order to be used.

The RSS sensor calculates the RSS state of a vehicle and retrieves the current RSS Response as sensor data. The carla.RssRestrictor will use this data to adapt a carla.VehicleControl before applying it to a vehicle.

These controllers can be generated by an Automated Driving stack or user input. For instance, hereunder there is a fragment of code from PythonAPI/examples/rss/manual_control_rss.py, where the user input is modified using RSS when necessary.

1. Checks if the RssSensor generates a valid response containing restrictions. 2. Gathers the current dynamics of the vehicle and the vehicle physics. 3. Applies restrictions to the vehicle control using the response from the RssSensor, and the current dynamics and physicis of the vehicle.

rss_proper_response = self._world.rss_sensor.proper_response if self._world.rss_sensor and self._world.rss_sensor.response_valid else None
if rss_proper_response:
...
        vehicle_control = self._restrictor.restrict_vehicle_control(
            vehicle_control, rss_proper_response, self._world.rss_sensor.ego_dynamics_on_route, self._vehicle_physics)

The carla.RssSensor class

The blueprint for this sensor has no modifiable attributes. However, the carla.RssSensor object that it instantiates has attributes and methods that are detailed in the Python API reference. Here is a summary of them.

carla.RssSensor variables	Type	Description
`ego_vehicle_dynamics`	ad.rss.world.RssDynamics	RSS parameters to be applied for the ego vehicle
`other_vehicle_dynamics`	ad.rss.world.RssDynamics	RSS parameters to be applied for the other vehicles
`pedestrian_dynamics`	ad.rss.world.RssDynamics	RSS parameters to be applied for pedestrians
`road_boundaries_mode`	carla.RssRoadBoundariesMode	Enables/Disables the stay on road feature. Default is Off.

# Fragment of rss_sensor.py
# The carla.RssSensor is updated when listening for a new carla.RssResponse
def _on_rss_response(weak_self, response):
...
        self.timestamp = response.timestamp
        self.response_valid = response.response_valid
        self.proper_response = response.proper_response
        self.ego_dynamics_on_route = response.ego_dynamics_on_route
        self.rss_state_snapshot = response.rss_state_snapshot
        self.situation_snapshot = response.situation_snapshot
        self.world_model = response.world_model

!!! Warning This sensor works fully on the client side. There is no blueprint in the server. Changes on the attributes will have effect after the listen() has been called.

The methods available in this class are related to the routing of the vehicle. RSS calculations are always based on a route of the ego vehicle through the road network.

The sensor allows to control the considered route by providing some key points, which could be the carla.Transform in a carla.Waypoint. These points are best selected after the intersections to force the route to take the desired turn.

carla.RssSensor methods	Description
`routing_targets`	Get the current list of routing targets used for route.
`append_routing_target`	Append an additional position to the current routing targets.
`reset_routing_targets`	Deletes the appended routing targets.
`drop_route`	Discards the current route and creates a new one.
`register_actor_constellation_callback`	Register a callback to customize the calculations.
`set_log_level`	Sets the log level.
`set_map_log_level`	Sets the log level used for map related logs.

# Update the current route
self.sensor.reset_routing_targets()
if routing_targets:
    for target in routing_targets:
        self.sensor.append_routing_target(target)

!!! Note If no routing targets are defined, a random route is created.

Output attributes

carla.RssResponse attributes	Type	Description
`response_valid`	bool	Validity of the response data.
`proper_response`	ad.rss.state.ProperResponse	Proper response that the RSS calculated for the vehicle including acceleration restrictions.
`rss_state_snapshot`	ad.rss.state.RssStateSnapshot	RSS states at the current point in time. This is the detailed individual output of the RSS calclulations.
`situation_snapshot`	ad.rss.situation.SituationSnapshot	RSS situation at the current point in time. This is the processed input data for the RSS calclulations.
`world_model`	ad.rss.world.WorldModel	RSS world model at the current point in time. This is the input data for the RSS calculations.
`ego_dynamics_on_route`	carla.RssEgoDynamicsOnRoute	Current ego vehicle dynamics regarding the route.

In case a actor_constellation_callback is registered, a call is triggered for:

default calculation (actor_constellation_data.other_actor=None)
per-actor calculation

# Fragment of rss_sensor.py
# The function is registered as actor_constellation_callback
def _on_actor_constellation_request(self, actor_constellation_data):
    actor_constellation_result = carla.RssActorConstellationResult()
    actor_constellation_result.rss_calculation_mode = ad.rss.map.RssMode.NotRelevant
    actor_constellation_result.restrict_speed_limit_mode = ad.rss.map.RssSceneCreation.RestrictSpeedLimitMode.IncreasedSpeedLimit10
    actor_constellation_result.ego_vehicle_dynamics = self.current_vehicle_parameters
    actor_constellation_result.actor_object_type = ad.rss.world.ObjectType.Invalid
    actor_constellation_result.actor_dynamics = self.current_vehicle_parameters

    actor_id = -1
    actor_type_id = "none"
    if actor_constellation_data.other_actor != None:
        # customize actor_constellation_result for specific actor
        ...
    else:
        # default
        ...
    return actor_constellation_result

Semantic LIDAR sensor

Blueprint: sensor.lidar.ray_cast_semantic
Output: carla.SemanticLidarMeasurement per step (unless sensor_tick says otherwise).

This sensor simulates a rotating LIDAR implemented using ray-casting that exposes all the information about the raycast hit. Its behaviour is quite similar to the LIDAR sensor, but there are two main differences between them.

The raw data retrieved by the semantic LIDAR includes more data per point.
- Coordinates of the point (as the normal LIDAR does).
- The cosine between the angle of incidence and the normal of the surface hit.
- Instance and semantic ground-truth. Basically the index of the CARLA object hit, and its semantic tag.
The semantic LIDAR does not include neither intensity, drop-off nor noise model attributes.

The points are computed by adding a laser for each channel distributed in the vertical FOV. The rotation is simulated computing the horizontal angle that the LIDAR rotated in a frame. The point cloud is calculated by doing a ray-cast for each laser in every step.

points_per_channel_each_step = points_per_second / (FPS * channels)

This output contains a cloud of lidar semantic detections and therefore, it can be iterated to retrieve a list of their carla.SemanticLidarDetection:

for detection in semantic_lidar_measurement:
    print(detection)

SemanticLidar attributes

Blueprint attribute	Type	Default	Description
`channels`	int	32	Number of lasers.
`range`	float	10.0	Maximum distance to measure/raycast in meters (centimeters for CARLA 0.9.6 or previous).
`points_per_second`	int	56000	Points generated by all lasers per second.
`rotation_frequency`	float	10.0	LIDAR rotation frequency.
`upper_fov`	float	10.0	Angle in degrees of the highest laser.
`lower_fov`	float	-30.0	Angle in degrees of the lowest laser.
`horizontal_fov`	float	360.0	Horizontal field of view in degrees, 0 - 360.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`horizontal_angle`	float	Angle (radians) in the XY plane of the LIDAR in the current frame.
`channels`	int	Number of channels (lasers) of the LIDAR.
`get_point_count(channel)`	int	Number of points per channel captured in the current frame.
`raw_data`	bytes	Array containing the point cloud with instance and semantic information. For each point, four 32-bits floats are stored. XYZ coordinates. cosine of the incident angle. Unsigned int containing the index of the object hit. Unsigned int containing the semantic tag of the object it.

Semantic segmentation camera

Blueprint: sensor.camera.semantic_segmentation
Output: carla.Image per step (unless sensor_tick says otherwise).

This camera classifies every object in sight by displaying it in a different color according to its tags (e.g., pedestrians in a different color than vehicles). When the simulation starts, every element in scene is created with a tag. So it happens when an actor is spawned. The objects are classified by their relative file path in the project. For example, meshes stored in Unreal/CarlaUE4/Content/Static/Pedestrians are tagged as Pedestrian.

The server provides an image with the tag information encoded in the red channel: A pixel with a red value of x belongs to an object with tag x. This raw carla.Image can be stored and converted it with the help of CityScapesPalette in carla.ColorConverter to apply the tags information and show picture with the semantic segmentation.

...
raw_image.save_to_disk("path/to/save/converted/image",carla.ColorConverter.cityScapesPalette)

The following tags are currently available (Note, tags changed from version 0.9.13 to 0.9.14):

Value	Tag	Converted color	Description
`0`	Unlabeled	`(0, 0, 0)`	Elements that have not been categorized are considered `Unlabeled`. This category is meant to be empty or at least contain elements with no collisions.
`1`	Roads	`(128, 64, 128)`	Part of ground on which cars usually drive. E.g. lanes in any directions, and streets.
`2`	SideWalks	`(244, 35, 232)`	Part of ground designated for pedestrians or cyclists. Delimited from the road by some obstacle (such as curbs or poles), not only by markings. This label includes a possibly delimiting curb, traffic islands (the walkable part), and pedestrian zones.
`3`	Building	`(70, 70, 70)`	Buildings like houses, skyscrapers,... and the elements attached to them. E.g. air conditioners, scaffolding, awning or ladders and much more.
`4`	Wall	`(102, 102, 156)`	Individual standing walls. Not part of a building.
`5`	Fence	`(190, 153, 153)`	Barriers, railing, or other upright structures. Basically wood or wire assemblies that enclose an area of ground.
`6`	Pole	`(153, 153, 153)`	Small mainly vertically oriented pole. If the pole has a horizontal part (often for traffic light poles) this is also considered pole. E.g. sign pole, traffic light poles.
`7`	TrafficLight	`(250, 170, 30)`	Traffic light boxes without their poles.
`8`	TrafficSign	`(220, 220, 0)`	Signs installed by the state/city authority, usually for traffic regulation. This category does not include the poles where signs are attached to. E.g. traffic- signs, parking signs, direction signs...
`9`	Vegetation	`(107, 142, 35)`	Trees, hedges, all kinds of vertical vegetation. Ground-level vegetation is considered `Terrain`.
`10`	Terrain	`(152, 251, 152)`	Grass, ground-level vegetation, soil or sand. These areas are not meant to be driven on. This label includes a possibly delimiting curb.
`11`	Sky	`(70, 130, 180)`	Open sky. Includes clouds and the sun.
`12`	Pedestrian	`(220, 20, 60)`	Humans that walk
`13`	Rider	`(255, 0, 0)`	Humans that ride/drive any kind of vehicle or mobility system E.g. bicycles or scooters, skateboards, horses, roller-blades, wheel-chairs, etc. .
`14`	Car	`(0, 0, 142)`	Cars, vans
`15`	Truck	`(0, 0, 70)`	Trucks
`16`	Bus	`(0, 60, 100)`	Busses
`17`	Train	`(0, 60, 100)`	Trains
`18`	Motorcycle	`(0, 0, 230)`	Motorcycle, Motorbike
`19`	Bicycle	`(119, 11, 32)`	Bicylces
`20`	Static	`(110, 190, 160)`	Elements in the scene and props that are immovable. E.g. fire hydrants, fixed benches, fountains, bus stops, etc.
`21`	Dynamic	`(170, 120, 50)`	Elements whose position is susceptible to change over time. E.g. Movable trash bins, buggies, bags, wheelchairs, animals, etc.
`22`	Other	`(55, 90, 80)`	Everything that does not belong to any other category.
`23`	Water	`(45, 60, 150)`	Horizontal water surfaces. E.g. Lakes, sea, rivers.
`24`	RoadLine	`(157, 234, 50)`	The markings on the road.
`25`	Ground	`(81, 0, 81)`	Any horizontal ground-level structures that does not match any other category. For example areas shared by vehicles and pedestrians, or flat roundabouts delimited from the road by a curb.
`26`	Bridge	`(150, 100, 100)`	Only the structure of the bridge. Fences, people, vehicles, an other elements on top of it are labeled separately.
`27`	RailTrack	`(230, 150, 140)`	All kind of rail tracks that are non-drivable by cars. E.g. subway and train rail tracks.
`28`	GuardRail	`(180, 165, 180)`	All types of guard rails/crash barriers.

!!! Note Read this tutorial to create new semantic tags.

Instance segmentation camera

Blueprint: sensor.camera.instance_segmentation
Output: carla.Image per step (unless sensor_tick says otherwise).

This camera classifies every object in the field of view both by class and also by instance ID. When the simulation starts, every element in scene is created with a tag. So it happens when an actor is spawned. The objects are classified by their relative file path in the project. For example, meshes stored in Unreal/CarlaUE4/Content/Static/Pedestrians are tagged as Pedestrian.

The server provides an image with the tag information encoded in the red channel: A pixel with a red value of x belongs to an object with tag x. The green and blue values of the pixel define the object's unique ID. For example a pixel with an 8 bit RGB value of [10, 20, 55] is a vehicle (Semantic tag 10) with a unique instance ID 20-55.

Basic camera attributes

Blueprint attribute	Type	Default	Description
`fov`	float	90.0	Horizontal field of view in degrees.
`image_size_x`	int	800	Image width in pixels.
`image_size_y`	int	600	Image height in pixels.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).

Camera lens distortion attributes

Blueprint attribute	Type	Default	Description
`lens_circle_falloff`	float	5.0	Range: [0.0, 10.0]
`lens_circle_multiplier`	float	0.0	Range: [0.0, 10.0]
`lens_k`	float	-1.0	Range: [-inf, inf]
`lens_kcube`	float	0.0	Range: [-inf, inf]
`lens_x_size`	float	0.08	Range: [0.0, 1.0]
`lens_y_size`	float	0.08	Range: [0.0, 1.0]

Output attributes

Sensor data attribute	Type	Description
`fov`	float	Horizontal field of view in degrees.
`frame`	int	Frame number when the measurement took place.
`height`	int	Image height in pixels.
`raw_data`	bytes	Array of BGRA 32-bit pixels.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`width`	int	Image width in pixels.

DVS camera

Blueprint: sensor.camera.dvs
Output: carla.DVSEventArray per step (unless sensor_tick says otherwise).

A Dynamic Vision Sensor (DVS) or Event camera is a sensor that works radically differently from a conventional camera. Instead of capturing intensity images at a fixed rate, event cameras measure changes of intensity asynchronously, in the form of a stream of events, which encode per-pixel brightness changes. Event cameras possess distinct properties when compared to standard cameras. They have a very high dynamic range (140 dB versus 60 dB), no motion blur, and high temporal resolution (in the order of microseconds). Event cameras are thus sensors that can provide high-quality visual information even in challenging high-speed scenarios and high dynamic range environments, enabling new application domains for vision-based algorithms.

The DVS camera outputs a stream of events. An event e=(x,y,t,pol) is triggered at a pixel x, y at a timestamp t when the change in logarithmic intensity L reaches a predefined constant threshold C (typically between 15% and 30%).

L(x,y,t) - L(x,y,t-\delta t) = pol C

t-\delta t is the time when the last event at that pixel was triggered and pol is the polarity of the event according to the sign of the brightness change. The polarity is positive +1 when there is increment in brightness and negative -1 when a decrement in brightness occurs. The working principles depicted in the following figure. The standard camera outputs frames at a fixed rate, thus sending redundant information when no motion is present in the scene. In contrast, event cameras are data-driven sensors that respond to brightness changes with microsecond latency. At the plot, a positive (resp. negative) event (blue dot, resp. red dot) is generated whenever the (signed) brightness change exceeds the contrast threshold C for one dimension x over time t. Observe how the event rate grows when the signal changes rapidly.

The current implementation of the DVS camera works in a uniform sampling manner between two consecutive synchronous frames. Therefore, in order to emulate the high temporal resolution (order of microseconds) of a real event camera, the sensor requires to execute at a high frequency (much higher frequency than a conventional camera). Effectively, the number of events increases the faster a CARLA car drives. Therefore, the sensor frequency should increase accordingly with the dynamics of the scene. The user should find a balance between time accuracy and computational cost.

The provided script manual_control.py uses the DVS camera in order to show how to configure the sensor, how to get the stream of events and how to depict such events in an image format, usually called event frame.

Note that due to the sampling method of the DVS camera, if there is no pixel difference between two consecutive synchronous frames the camera will not return an image. This will always occur in the first frame, as there is no previous frame to compare to and also in the event that there has been no movement between frames.

DVS is a camera and therefore has all the attributes available in the RGB camera. Nevertheless, there are few attributes exclusive to the working principle of an Event camera.

DVS camera attributes

Blueprint attribute	Type	Default	Description
`positive_threshold`	float	0.3	Positive threshold C associated to a increment in brightness change (0-1).
`negative_threshold`	float	0.3	Negative threshold C associated to a decrement in brightness change (0-1).
`sigma_positive_threshold`	float	0	White noise standard deviation for positive events (0-1).
`sigma_negative_threshold`	float	0	White noise standard deviation for negative events (0-1).
`refractory_period_ns`	int	0.0	Refractory period (time during which a pixel cannot fire events just after it fired one), in nanoseconds. It limits the highest frequency of triggering events.
`use_log`	bool	true	Whether to work in the logarithmic intensity scale.
`log_eps`	float	0.001	Epsilon value used to convert images to log: `L = log(eps + I / 255.0)`. Where `I` is the grayscale value of the RGB image: `I = 0.2989R + 0.5870G + 0.1140*B`.

Optical Flow Camera

The Optical Flow camera captures the motion perceived from the point of view of the camera. Every pixel recorded by this sensor encodes the velocity of that point projected to the image plane. The velocity of a pixel is encoded in the range [-2,2]. To obtain the motion in pixel units, this information can be scaled with the image size to [-2 * image_size, 2 * image_size].

Optical Flow camera attributes

Blueprint attribute	Type	Default	Description
`image_size_x`	int	800	Image width in pixels.
`image_size_y`	int	600	Image height in pixels.
`fov`	float	90.0	Horizontal field of view in degrees.
`sensor_tick`	float	0.0	Simulation seconds between sensor captures (ticks).

Optical Flow camera lens distortion attributes

Blueprint attribute	Type	Default	Description
`lens_circle_falloff`	float	5.0	Range: [0.0, 10.0]
`lens_circle_multiplier`	float	0.0	Range: [0.0, 10.0]
`lens_k`	float	-1.0	Range: [-inf, inf]
`lens_kcube`	float	0.0	Range: [-inf, inf]
`lens_x_size`	float	0.08	Range: [0.0, 1.0]
`lens_y_size`	float	0.08	Range: [0.0, 1.0]

Output attributes

Sensor data attribute	Type	Description
`frame`	int	Frame number when the measurement took place.
`timestamp`	double	Simulation time of the measurement in seconds since the beginning of the episode.
`transform`	carla.Transform	Location and rotation in world coordinates of the sensor at the time of the measurement.
`width`	int	Image width in pixels.
`height`	int	Image height in pixels.
`fov`	float	Horizontal field of view in degrees.
`raw_data`	bytes	Array of BGRA 64-bit pixels containing two float values.

V2X sensor

Vehicle-to-everything (V2X) communication is an important aspect for future applications of cooperative intelligent transportation systems. In real vehicles, this requires a dedicated onboard unit (OBU) in each vehicle, that is able to send and receive information over wireless channels. Depending on the region (Europe, China, USA), different physical technologies, protocols and application messaging formats are used.

CARLA currently supports simulation of a simple broadcast wireless channel and two application messages. Protocols for network access and forwarding are not supported yet. The two implemented messages are the Cooperative Awarness Message according to the European standard ETSI, and a custom message type, that can be used to transmit arbitrary string data (e.g. JSON). There are two distinct sensors for V2X communication, that can be used separately, one for each application message type.

Basically, the wireless channel incorporates the following calculation for both sensors:

ReceivedPower = OtherTransmitPower + combined_antenna_gain - loss

IF (ReceivedPower >= receiver_sensitivity)
    THEN message is received

To simulate V2X communication, at least two V2X sensors of the same type need to be spawned (at least one sender-receiver pair). Because the received power is calculated on the receiver-side V2X sensor, only the antenna gain that is specified on the receiver-side sensor is incorporated in this calculation. Transmission power and receiver sensitivity can be configured (see Blueprint attributes).

The loss calculation depends on

the visbility condition between sender and receiver: line of sight (no obstacles), non-line of sight obstructed by buildings, or non-line of sight obstructed by vehicles, and
the scenario: highway, rural, or urban environment

While the visibility is simulated within CARLA, the scenario can be configured by the user (see Blueprint attributes), as well as several other attributes of the wireless channel.

Sensor (sub)types

Cooperative Awareness Message

Blueprint: sensor.other.v2x
Output: carla.CAMData, triggered according to the ETSI CAM standard, unless configured otherwise

Triggering conditions according to ETSI standard:

Heading angle change > 4°
Position difference > 4 m
Speed change > 5 m/s
Time elapsed > CAM Generation time (configurable)
Low Frequency Container Time Elapsed > 500 ms

For the CAM V2X sensor, additional blueprint attributes apply:

Blueprint attribute	Type	Default	Description
	Message generation
gen_cam_min	float	`0.1`	Minimum elapsed time between two successive CAMs in seconds (s)
gen_cam_max	float	`1.0`	Maximum elapsed time between two successive CAMs in seconds (s)
fixed_rate	bool	false [true]	Generate a CAM in every CARLA tick (only for debug purposes, will result in slowdown)
	Data generation
`noise_vel_stddev_x`	float	0.0	Standard deviation parameter in the noise model for velocity (X axis).
`noise_accel_stddev_x`	float	0.0	Standard deviation parameter in the noise model for acceleration (X axis).
`noise_accel_stddev_y`	float	0.0	Standard deviation parameter in the noise model for acceleration (Y axis).
`noise_accel_stddev_z`	float	0.0	Standard deviation parameter in the noise model for acceleration (Z axis).
`noise_yawrate_bias`	float	0.0	Mean parameter in the noise model for yaw rate.
`noise_yawrate_stddev`	float	0.0	Standard deviation parameter in the noise model for yaw rate.
`noise_alt_bias`	float	0.0	Mean parameter in the noise model for altitude.
`noise_alt_stddev`	float	0.0	Standard deviation parameter in the noise model for altitude.
`noise_lat_bias`	float	0.0	Mean parameter in the noise model for latitude.
`noise_lat_stddev`	float	0.0	Standard deviation parameter in the noise model for latitude.
`noise_lon_bias`	float	0.0	Mean parameter in the noise model for longitude.
`noise_lon_stddev`	float	0.0	Standard deviation parameter in the noise model for longitude.
`noise_head_bias`	float	0.0	Mean parameter in the noise model for heading.
`noise_head_stddev`	float	0.0	Standard deviation parameter in the noise model for heading.

Custom V2X Message

Blueprint: sensor.other.v2x_custom
Output: carla.CustomV2XData, triggered with next tick after a send() was called

Methods

send(self, callback) The function the user has to call every time to send a message. This function needs for an argument containing an object type carla.SensorData to work with.
- Parameters:
  - data (function) - The called function with one argument containing the sensor data.

The custom V2X message sensor works a little bit different than other sensors, because it has the send function in addition to the listen function, that needs to be called, before another sensor of this type will receive anything. The transmission of a custom message is only triggered, when send is called. Each message given to the send function is only transmitted once to all Custom V2X Message sensors currently spawned.

Example:

bp = world.get_blueprint_library().find('sensor.other.v2x_custom')
sensor = world.spawn_actor(bp, carla.Transform(), attach_to=parent)
sensor.send("Hello CARLA")

V2X sensors blueprint attributes

Blueprint attribute	Type	Default	Description
transmit_power	float	`21.5`	Sender transmission power in dBm
receiver_sensitivity	float	`-99`	Receiver sensitivity in dBm
frequency_ghz	float	`5.9`	Transmission frequency in GHz. 5.9 GHz is standard for several physical channels.
noise_seed	int	`0`	Random parameter for initialization of noise
filter_distance	float	`500`	Maximum transmission distance in meter, path loss calculations above are skipped for simulation speed
	Path loss model parameters
combined_antenna_gain	float	`10.0`	Combined gain of sender and receiver antennas in dBi, parameter for radiation efficiency and directivity
d_ref	float	`1.0`	reference distance for Log-distance path loss model in meter
path_loss_exponent	float	2.7	Loss parameter for non-line of sight due to building obstruction
scenario	string	urban	Options: [urban, rural, highway], defines the fading noise parameters
path_loss_model	string	geometric	general path loss model to be used. Options: [geometric, winner]
use_etsi_fading	bool	true	Use the fading params as mentioned in the ETSI publication (true), or use the custom fading standard deviation
custom_fading_stddev	float	0.0	Custom value for fading standard deviation, only used if `use_etsi_fading` is set to `false`

69 KiB Raw Blame History

Sensors reference

Collision detector

Output attributes

Depth camera

Basic camera attributes

Camera lens distortion attributes

Output attributes

GNSS sensor

GNSS attributes

Output attributes

IMU sensor

IMU attributes

Output attributes

Lane invasion detector

Output attributes

LIDAR sensor

Lidar attributes

Output attributes

Obstacle detector

Output attributes

Radar sensor

Output attributes

RGB camera

Basic camera attributes

Camera lens distortion attributes

Advanced camera attributes

Output attributes

RSS sensor

The carla.RssSensor class

Output attributes

Semantic LIDAR sensor

SemanticLidar attributes

Output attributes

Semantic segmentation camera

Instance segmentation camera

Basic camera attributes

Camera lens distortion attributes

Output attributes

DVS camera

DVS camera attributes

Optical Flow Camera

Optical Flow camera attributes

Optical Flow camera lens distortion attributes

Output attributes

V2X sensor

Sensor (sub)types

Cooperative Awareness Message

Custom V2X Message

Methods

V2X sensors blueprint attributes

69 KiB

Raw Blame History