Fixed docs
This commit is contained in:
Marc Garcia Puig
parent
00343bb875
commit
6ad2610d33
184
Docs/index.md
184
Docs/index.md
|
|
@ -20,149 +20,79 @@ CARLA forum</a>
|
|||
---
|
||||
|
||||
## Getting started
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__Introduction__](start_introduction.md)
|
||||
— What to expect from CARLA.
|
||||
[__Quick start__](start_quickstart.md)
|
||||
— Get the CARLA releases.
|
||||
</p>
|
||||
|
||||
[__Introduction__](start_introduction.md) — What to expect from CARLA.
|
||||
[__Quick start__](start_quickstart.md) — Get the CARLA releases.
|
||||
|
||||
|
||||
## Building CARLA
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__Linux build__](build_linux.md)
|
||||
— Make the build on Linux.
|
||||
[__Windows build__](build_windows.md)
|
||||
— Make the build on Windows.
|
||||
[__Update CARLA__](build_update.md)
|
||||
— Get up to date with the latest content.
|
||||
[__Build system__](build_system.md)
|
||||
— Learn about the build and how it is made.
|
||||
[__Running in a Docker__](build_docker.md)
|
||||
— Run CARLA using a container solution.
|
||||
[__F.A.Q.__](build_faq.md)
|
||||
— Some of the most frequent installation issues.
|
||||
</p>
|
||||
|
||||
[__Linux build__](build_linux.md) — Make the build on Linux.
|
||||
[__Windows build__](build_windows.md) — Make the build on Windows.
|
||||
[__Update CARLA__](build_update.md) — Get up to date with the latest content.
|
||||
[__Build system__](build_system.md) — Learn about the build and how it is made.
|
||||
[__Running in a Docker__](build_docker.md) — Run CARLA using a container solution.
|
||||
[__F.A.Q.__](build_faq.md) — Some of the most frequent installation issues.
|
||||
|
||||
|
||||
## First steps
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__Core concepts__](core_concepts.md)
|
||||
— Overview of the basic concepts in CARLA.
|
||||
[__1st. World and client__](core_world.md)
|
||||
— Manage and access the simulation.
|
||||
[__2nd. Actors and blueprints__](core_actors.md)
|
||||
— Learn about actors and how to handle them.
|
||||
[__3rd. Maps and navigation__](core_map.md)
|
||||
— Discover the different maps and how do vehicles move around.
|
||||
[__4th. Sensors and data__](core_sensors.md)
|
||||
— Retrieve simulation data using sensors.
|
||||
</p>
|
||||
[__Core concepts__](core_concepts.md) — Overview of the basic concepts in CARLA.
|
||||
[__1st. World and client__](core_world.md) — Manage and access the simulation.
|
||||
[__2nd. Actors and blueprints__](core_actors.md) — Learn about actors and how to handle them.
|
||||
[__3rd. Maps and navigation__](core_map.md) — Discover the different maps and how do vehicles move around.
|
||||
[__4th. Sensors and data__](core_sensors.md) — Retrieve simulation data using sensors.
|
||||
|
||||
## Advanced steps
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__OpenDRIVE standalone mode__](adv_opendrive.md)
|
||||
— Use any OpenDRIVE file as a CARLA map.
|
||||
[__PTV-Vissim co-simulation__](adv_ptv.md)
|
||||
— Run a synchronous simulation between CARLA and PTV-Vissim.
|
||||
[__Recorder__](adv_recorder.md)
|
||||
— Register the events in a simulation and play it again.
|
||||
[__Rendering options__](adv_rendering_options.md)
|
||||
— From quality settings to no-render or off-screen modes.
|
||||
[__RSS__](adv_rss.md)
|
||||
— An implementation of RSS in the CARLA client library.
|
||||
[__SUMO co-simulation__](adv_sumo.md)
|
||||
— Run a synchronous simulation between CARLA and SUMO.
|
||||
[__Synchrony and time-step__](adv_synchrony_timestep.md)
|
||||
— Client-server communication and simulation time.
|
||||
[__Traffic Manager__](adv_traffic_manager.md)
|
||||
— Simulate urban traffic by setting vehicles to autopilot mode.
|
||||
</p>
|
||||
[__OpenDRIVE standalone mode__](adv_opendrive.md) — Use any OpenDRIVE file as a CARLA map.
|
||||
[__PTV-Vissim co-simulation__](adv_ptv.md) — Run a synchronous simulation between CARLA and PTV-Vissim.
|
||||
[__Recorder__](adv_recorder.md) — Register the events in a simulation and play it again.
|
||||
[__Rendering options__](adv_rendering_options.md) — From quality settings to no-render or off-screen modes.
|
||||
[__RSS__](adv_rss.md) — An implementation of RSS in the CARLA client library.
|
||||
[__SUMO co-simulation__](adv_sumo.md) — Run a synchronous simulation between CARLA and SUMO.
|
||||
[__Synchrony and time-step__](adv_synchrony_timestep.md) — Client-server communication and simulation time.
|
||||
[__Traffic Manager__](adv_traffic_manager.md) — Simulate urban traffic by setting vehicles to autopilot mode.
|
||||
|
||||
## References
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__Python API reference__](python_api.md)
|
||||
— Classes and methods in the Python API.
|
||||
[__Blueprint library__](bp_library.md)
|
||||
— Blueprints provided to spawn actors.
|
||||
[__C++ reference__](ref_cpp.md)
|
||||
— Classes and methods in CARLA C++.
|
||||
[__Recorder binary file format__](ref_recorder_binary_file_format.md)
|
||||
— Detailed explanation of the recorder file format.
|
||||
[__Sensors reference__](ref_sensors.md)
|
||||
— Everything about sensors and the data they retrieve.
|
||||
</p>
|
||||
[__Python API reference__](python_api.md) — Classes and methods in the Python API.
|
||||
[__Code recipes__](ref_code_recipes.md) — Some code fragments commonly used.
|
||||
[__Blueprint library__](bp_library.md) — Blueprints provided to spawn actors.
|
||||
[__C++ reference__](ref_cpp.md) — Classes and methods in CARLA C++.
|
||||
[__Recorder binary file format__](ref_recorder_binary_file_format.md) — Detailed explanation of the recorder file format.
|
||||
[__Sensors reference__](ref_sensors.md) — Everything about sensors and the data they retrieve.
|
||||
|
||||
## Plugins
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__carlaviz — web visualizer__](plugins_carlaviz.md)
|
||||
— Plugin that listens the simulation and shows the scene and some simulation data in a web browser.
|
||||
</p>
|
||||
|
||||
[__carlaviz — web visualizer__](plugins_carlaviz.md) — Plugin that listens the simulation and shows the scene and some simulation data in a web browser.
|
||||
|
||||
## ROS bridge
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__ROS bridge installation__](ros_installation.md)
|
||||
— The different ways to install the ROS bridge.
|
||||
[__CARLA messages reference__](ros_msgs.md)
|
||||
— Contains explanations and fields for every type of CARLA message available in ROS.
|
||||
[__Launchfiles reference__](ros_launchs.md)
|
||||
— Lists the launchfiles and nodes provided, and the topics being consumed and published.
|
||||
</p>
|
||||
[__ROS bridge installation__](ros_installation.md) — The different ways to install the ROS bridge.
|
||||
[__CARLA messages reference__](ros_msgs.md) — Contains explanations and fields for every type of CARLA message available in ROS.
|
||||
[__Launchfiles reference__](ros_launchs.md) — Lists the launchfiles and nodes provided, and the topics being consumed and published.
|
||||
|
||||
## Tutorials — General
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__Add friction triggers__](tuto_G_add_friction_triggers.md)
|
||||
— Define dynamic box triggers for wheels.
|
||||
[__Control vehicle physics__](tuto_G_control_vehicle_physics.md)
|
||||
— Set runtime changes on a vehicle physics.
|
||||
[__Control walker skeletons__](tuto_G_control_walker_skeletons.md)
|
||||
— Animate walkers using skeletons.
|
||||
[__Retrieve simulation data__](tuto_G_retrieve_data.md)
|
||||
— A step by step guide to properly gather data using the recorder.
|
||||
</p>
|
||||
[__Add friction triggers__](tuto_G_add_friction_triggers.md) — Define dynamic box triggers for wheels.
|
||||
[__Control vehicle physics__](tuto_G_control_vehicle_physics.md) — Set runtime changes on a vehicle physics.
|
||||
[__Control walker skeletons__](tuto_G_control_walker_skeletons.md) — Animate walkers using skeletons.
|
||||
[__Retrieve simulation data__](tuto_G_retrieve_data.md) — A step by step guide to properly gather data using the recorder.
|
||||
|
||||
## Tutorials — Assets
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__Add a new map__](tuto_A_add_map.md)
|
||||
— Create and ingest a new map.
|
||||
[__Add a new vehicle__](tuto_A_add_vehicle.md)
|
||||
— Prepare a vehicle to be used in CARLA.
|
||||
[__Add new props__](tuto_A_add_props.md)
|
||||
— Import additional props into CARLA.
|
||||
[__Create standalone packages__](tuto_A_create_standalone.md)
|
||||
— Generate and handle standalone packages for assets.
|
||||
[__Map customization__](tuto_A_map_customization.md)
|
||||
— Edit an existing map.
|
||||
[__Material customization__](tuto_A_material_customization.md)
|
||||
— Edit vehicle and building materials.
|
||||
[__Vehicle modelling__](tuto_A_vehicle_modelling.md)
|
||||
— Create a new vehicle for CARLA.
|
||||
</p>
|
||||
[__Add a new map__](tuto_A_add_map.md) — Create and ingest a new map.
|
||||
[__Add a new vehicle__](tuto_A_add_vehicle.md) — Prepare a vehicle to be used in CARLA.
|
||||
[__Add new props__](tuto_A_add_props.md) — Import additional props into CARLA.
|
||||
[__Create standalone packages__](tuto_A_create_standalone.md) — Generate and handle standalone packages for assets.
|
||||
[__Map customization__](tuto_A_map_customization.md) — Edit an existing map.
|
||||
[__Material customization__](tuto_A_material_customization.md) — Edit vehicle and building materials.
|
||||
[__Vehicle modelling__](tuto_A_vehicle_modelling.md) — Create a new vehicle for CARLA.
|
||||
|
||||
## Tutorials — Developers
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__Contribute new assets__](tuto_D_contribute_assets.md)
|
||||
— Add new content to CARLA.
|
||||
[__Create a sensor__](tuto_D_create_sensor.md)
|
||||
— Develop a new sensor to be used in CARLA.
|
||||
[__Create semantic tags__](tuto_D_create_semantic_tags.md)
|
||||
— Define new semantic tags for semantic segmentation.
|
||||
[__Customize vehicle suspension__](tuto_D_customize_vehicle_suspension.md)
|
||||
— Modify the suspension system of a vehicle.
|
||||
[__Make a release__](tuto_D_make_release.md)
|
||||
— For developers who want to publish a release.
|
||||
[__Generate detailed colliders__](tuto_D_generate_colliders.md)
|
||||
— Create detailed colliders for vehicles.
|
||||
[__Generate pedestrian navigation__](tuto_D_generate_pedestrian_navigation.md)
|
||||
— Obtain the information needed for walkers to move around.
|
||||
</p>
|
||||
[__Contribute with new assets__](tuto_D_contribute_assets.md) — Add new content to CARLA.
|
||||
[__Create a sensor__](tuto_D_create_sensor.md) — Develop a new sensor to be used in CARLA.
|
||||
[__Customize vehicle suspension__](tuto_D_customize_vehicle_suspension.md) — Modify the suspension system of a vehicle.
|
||||
[__Make a release__](tuto_D_make_release.md) — For developers who want to publish a release.
|
||||
[__Generate detailed colliders__](tuto_D_generate_colliders.md) — Create detailed colliders for vehicles.
|
||||
[__Generate pedestrian navigation__](tuto_D_generate_pedestrian_navigation.md) — Obtain the information needed for walkers to move around.
|
||||
|
||||
## Contributing
|
||||
<p style="padding-left:30px;line-height:1.8">
|
||||
[__Contribution guidelines__](cont_contribution_guidelines.md)
|
||||
— The different ways to contribute to CARLA.
|
||||
[__Code of conduct__](cont_code_of_conduct.md)
|
||||
— Standard rights and duties for contributors.
|
||||
[__Coding standard__](cont_coding_standard.md)
|
||||
— Guidelines to write proper code.
|
||||
[__Documentation standard__](cont_doc_standard.md)
|
||||
— Guidelines to write proper documentation.
|
||||
</p>
|
||||
[__Contribution guidelines__](cont_contribution_guidelines.md) — The different ways to contribute to CARLA.
|
||||
[__Code of conduct__](cont_code_of_conduct.md) — Standard rights and duties for contributors.
|
||||
[__Coding standard__](cont_coding_standard.md) — Guidelines to write proper code.
|
||||
[__Documentation standard__](cont_doc_standard.md) — Guidelines to write proper documentation.
|
||||
|
|
|
|||
|
|
@ -503,7 +503,8 @@ Sets the maxixum time a network call is allowed before blocking it and raising a
|
|||
---
|
||||
|
||||
## carla.CollisionEvent<a name="carla.CollisionEvent"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines a collision data for <b>sensor.other.collision</b>. The sensor creates one of this for every collision detected which may be many for one simulation step. Learn more about this [here](ref_sensors.md#collision-detector).
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that defines a collision data for <b>sensor.other.collision</b>. The sensor creates one of this for every collision detected which may be many for one simulation step. Learn more about this [here](ref_sensors.md#collision-detector).
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.CollisionEvent.actor"></a>**<font color="#f8805a">actor</font>** (_[carla.Actor](#carla.Actor)_)
|
||||
|
|
@ -713,7 +714,8 @@ Height regarding ground level.
|
|||
---
|
||||
|
||||
## carla.GnssMeasurement<a name="carla.GnssMeasurement"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines the Gnss data registered by a <b>sensor.other.gnss</b>. It essentially reports its position with the position of the sensor and an OpenDRIVE geo-reference.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that defines the Gnss data registered by a <b>sensor.other.gnss</b>. It essentially reports its position with the position of the sensor and an OpenDRIVE geo-reference.
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.GnssMeasurement.altitude"></a>**<font color="#f8805a">altitude</font>** (_float<small> – meters</small>_)
|
||||
|
|
@ -731,7 +733,8 @@ West/East value of a point on the map.
|
|||
---
|
||||
|
||||
## carla.IMUMeasurement<a name="carla.IMUMeasurement"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines the data registered by a <b>sensor.other.imu</b>, regarding the sensor's transformation according to the current [carla.World](#carla.World). It essentially acts as accelerometer, gyroscope and compass.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that defines the data registered by a <b>sensor.other.imu</b>, regarding the sensor's transformation according to the current [carla.World](#carla.World). It essentially acts as accelerometer, gyroscope and compass.
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.IMUMeasurement.accelerometer"></a>**<font color="#f8805a">accelerometer</font>** (_[carla.Vector3D](#carla.Vector3D)<small> – m/s<sup>2</sup></small>_)
|
||||
|
|
@ -749,7 +752,8 @@ Angular velocity.
|
|||
---
|
||||
|
||||
## carla.Image<a name="carla.Image"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines an image of 32-bit BGRA colors that will be used as initial data retrieved by camera sensors. There are different camera sensors (currently three, RGB, depth and semantic segmentation) and each of these makes different use for the images. Learn more about them [here](ref_sensors.md).
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that defines an image of 32-bit BGRA colors that will be used as initial data retrieved by camera sensors. There are different camera sensors (currently three, RGB, depth and semantic segmentation) and each of these makes different use for the images. Learn more about them [here](ref_sensors.md).
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.Image.fov"></a>**<font color="#f8805a">fov</font>** (_float<small> – degrees</small>_)
|
||||
|
|
@ -978,7 +982,8 @@ Traffic rules allow turning either right or left.
|
|||
---
|
||||
|
||||
## carla.LaneInvasionEvent<a name="carla.LaneInvasionEvent"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines lanes invasion for <b>sensor.other.lane_invasion</b>. It works only client-side and is dependant on OpenDRIVE to provide reliable information. The sensor creates one of this every time there is a lane invasion, which may be more than once per simulation step. Learn more about this [here](ref_sensors.md#lane-invasion-detector).
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that defines lanes invasion for <b>sensor.other.lane_invasion</b>. It works only client-side and is dependant on OpenDRIVE to provide reliable information. The sensor creates one of this every time there is a lane invasion, which may be more than once per simulation step. Learn more about this [here](ref_sensors.md#lane-invasion-detector).
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.LaneInvasionEvent.actor"></a>**<font color="#f8805a">actor</font>** (_[carla.Actor](#carla.Actor)_)
|
||||
|
|
@ -1088,7 +1093,8 @@ Computed intensity for this point as a scalar value between [0.0 , 1.0].
|
|||
---
|
||||
|
||||
## carla.LidarMeasurement<a name="carla.LidarMeasurement"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines the LIDAR data retrieved by a <b>sensor.lidar.ray_cast</b>. This essentially simulates a rotating LIDAR using ray-casting. Learn more about this [here](ref_sensors.md#lidar-raycast-sensor).
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that defines the LIDAR data retrieved by a <b>sensor.lidar.ray_cast</b>. This essentially simulates a rotating LIDAR using ray-casting. Learn more about this [here](ref_sensors.md#lidar-raycast-sensor).
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.LidarMeasurement.channels"></a>**<font color="#f8805a">channels</font>** (_int_)
|
||||
|
|
@ -1319,7 +1325,8 @@ Switch of a light. It is __True__ when the light is on.
|
|||
---
|
||||
|
||||
## carla.Location<a name="carla.Location"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.Vector3D](#carla.Vector3D)_</b></small></div></p><p>Represents a spot in the world.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.Vector3D](#carla.Vector3D)_**</small></br>
|
||||
Represents a spot in the world.
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.Location.x"></a>**<font color="#f8805a">x</font>** (_float<small> – meters</small>_)
|
||||
|
|
@ -1433,7 +1440,8 @@ Returns a waypoint if all the parameters passed are correct. Otherwise, returns
|
|||
---
|
||||
|
||||
## carla.ObstacleDetectionEvent<a name="carla.ObstacleDetectionEvent"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines the obstacle data for <b>sensor.other.obstacle</b>. Learn more about this [here](ref_sensors.md#obstacle-detector).
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that defines the obstacle data for <b>sensor.other.obstacle</b>. Learn more about this [here](ref_sensors.md#obstacle-detector).
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.ObstacleDetectionEvent.actor"></a>**<font color="#f8805a">actor</font>** (_[carla.Actor](#carla.Actor)_)
|
||||
|
|
@ -1522,7 +1530,8 @@ The velocity of the detected object towards the sensor.
|
|||
---
|
||||
|
||||
## carla.RadarMeasurement<a name="carla.RadarMeasurement"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines and gathers the measures registered by a <b>sensor.other.radar</b>, representing a wall of points in front of the sensor with a distance, angle and velocity in relation to it. The data consists of a [carla.RadarDetection](#carla.RadarDetection) array. Learn more about this [here](ref_sensors.md#radar-sensor).
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that defines and gathers the measures registered by a <b>sensor.other.radar</b>, representing a wall of points in front of the sensor with a distance, angle and velocity in relation to it. The data consists of a [carla.RadarDetection](#carla.RadarDetection) array. Learn more about this [here](ref_sensors.md#radar-sensor).
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.RadarMeasurement.raw_data"></a>**<font color="#f8805a">raw_data</font>** (_bytes_)
|
||||
|
|
@ -1688,7 +1697,8 @@ Enum declaration used in [carla.RssSensor](#carla.RssSensor) to set the log leve
|
|||
---
|
||||
|
||||
## carla.RssResponse<a name="carla.RssResponse"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that contains the output of a [carla.RssSensor](#carla.RssSensor). This is the result of the RSS calculations performed for the parent vehicle of the sensor.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that contains the output of a [carla.RssSensor](#carla.RssSensor). This is the result of the RSS calculations performed for the parent vehicle of the sensor.
|
||||
|
||||
A [carla.RssRestrictor](#carla.RssRestrictor) will use the data to modify the [carla.VehicleControl](#carla.VehicleControl) of the vehicle.
|
||||
|
||||
|
|
@ -1740,7 +1750,8 @@ Disables the _stay on road_ feature.
|
|||
---
|
||||
|
||||
## carla.RssSensor<a name="carla.RssSensor"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.Sensor](#carla.Sensor)_</b></small></div></p><p>This sensor works a bit differently than the rest. Take look at the [specific documentation](adv_rss.md), and the [rss sensor reference](ref_sensors.md#rss-sensor) to gain full understanding of it.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.Sensor](#carla.Sensor)_**</small></br>
|
||||
This sensor works a bit differently than the rest. Take look at the [specific documentation](adv_rss.md), and the [rss sensor reference](ref_sensors.md#rss-sensor) to gain full understanding of it.
|
||||
|
||||
The RSS sensor uses world information, and a [RSS library](https://github.com/intel/ad-rss-lib) to make safety checks on a vehicle. The output retrieved by the sensor is a [carla.RssResponse](#carla.RssResponse). This will be used by a [carla.RssRestrictor](#carla.RssRestrictor) to modify a [carla.VehicleControl](#carla.VehicleControl) before applying it to a vehicle.
|
||||
|
||||
|
|
@ -1806,7 +1817,8 @@ ID of the actor hit by the ray.
|
|||
---
|
||||
|
||||
## carla.SemanticLidarMeasurement<a name="carla.SemanticLidarMeasurement"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.SensorData](#carla.SensorData)_</b></small></div></p><p>Class that defines the semantic LIDAR data retrieved by a <b>sensor.lidar.ray_cast_semantic</b>. This essentially simulates a rotating LIDAR using ray-casting. Learn more about this [here](ref_sensors.md#semanticlidar-raycast-sensor).
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.SensorData](#carla.SensorData)_**</small></br>
|
||||
Class that defines the semantic LIDAR data retrieved by a <b>sensor.lidar.ray_cast_semantic</b>. This essentially simulates a rotating LIDAR using ray-casting. Learn more about this [here](ref_sensors.md#semanticlidar-raycast-sensor).
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.SemanticLidarMeasurement.channels"></a>**<font color="#f8805a">channels</font>** (_int_)
|
||||
|
|
@ -1839,22 +1851,23 @@ Iterate over the [carla.SemanticLidarDetection](#carla.SemanticLidarDetection) r
|
|||
---
|
||||
|
||||
## carla.Sensor<a name="carla.Sensor"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.Actor](#carla.Actor)_</b></small></div></p><p>Sensors compound a specific family of actors quite diverse and unique. They are normally spawned as attachment/sons of a vehicle (take a look at [carla.World](#carla.World) to learn about actor spawning). Sensors are thoroughly designed to retrieve different types of data that they are listening to. The data they receive is shaped as different subclasses inherited from [carla.SensorData](#carla.SensorData) (depending on the sensor).
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.Actor](#carla.Actor)_**</small></br>
|
||||
Sensors compound a specific family of actors quite diverse and unique. They are normally spawned as attachment/sons of a vehicle (take a look at [carla.World](#carla.World) to learn about actor spawning). Sensors are thoroughly designed to retrieve different types of data that they are listening to. The data they receive is shaped as different subclasses inherited from [carla.SensorData](#carla.SensorData) (depending on the sensor).
|
||||
|
||||
Most sensors can be divided in two groups: those receiving data on every tick (cameras, point clouds and some specific sensors) and those who only receive under certain circumstances (trigger detectors). CARLA provides a specific set of sensors and their blueprint can be found in [carla.BlueprintLibrary](#carla.BlueprintLibrary). All the information on their preferences and settlement can be found [here](ref_sensors.md), but the list of those available in CARLA so far goes as follow.
|
||||
<br><b>Receive data on every tick.</b>
|
||||
- [Depth camera](ref_sensors.md#depth-camera).
|
||||
- [Gnss sensor](ref_sensors.md#gnss-sensor).
|
||||
- [IMU sensor](ref_sensors.md#imu-sensor).
|
||||
- [Lidar raycast](ref_sensors.md#lidar-raycast-sensor).
|
||||
- [SemanticLidar raycast](ref_sensors.md#semanticlidar-raycast-sensor).
|
||||
- [Radar](ref_sensors.md#radar-sensor).
|
||||
- [RGB camera](ref_sensors.md#rgb-camera).
|
||||
- [RSS sensor](ref_sensors.md#rss-sensor).
|
||||
- [Semantic Segmentation camera](ref_sensors.md#semantic-segmentation-camera).
|
||||
<br><b>Only receive data when triggered.</b>
|
||||
- [Collision detector](ref_sensors.md#collision-detector).
|
||||
- [Lane invasion detector](ref_sensors.md#lane-invasion-detector).
|
||||
Most sensors can be divided in two groups: those receiving data on every tick (cameras, point clouds and some specific sensors) and those who only receive under certain circumstances (trigger detectors). CARLA provides a specific set of sensors and their blueprint can be found in [carla.BlueprintLibrary](#carla.BlueprintLibrary). All the information on their preferences and settlement can be found [here](ref_sensors.md), but the list of those available in CARLA so far goes as follow.
|
||||
<br><b>Receive data on every tick.</b>
|
||||
- [Depth camera](ref_sensors.md#depth-camera).
|
||||
- [Gnss sensor](ref_sensors.md#gnss-sensor).
|
||||
- [IMU sensor](ref_sensors.md#imu-sensor).
|
||||
- [Lidar raycast](ref_sensors.md#lidar-raycast-sensor).
|
||||
- [SemanticLidar raycast](ref_sensors.md#semanticlidar-raycast-sensor).
|
||||
- [Radar](ref_sensors.md#radar-sensor).
|
||||
- [RGB camera](ref_sensors.md#rgb-camera).
|
||||
- [RSS sensor](ref_sensors.md#rss-sensor).
|
||||
- [Semantic Segmentation camera](ref_sensors.md#semantic-segmentation-camera).
|
||||
<br><b>Only receive data when triggered.</b>
|
||||
- [Collision detector](ref_sensors.md#collision-detector).
|
||||
- [Lane invasion detector](ref_sensors.md#lane-invasion-detector).
|
||||
- [Obstacle detector](ref_sensors.md#obstacle-detector).
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
|
|
@ -1926,7 +1939,8 @@ Time register of the frame at which this measurement was taken given by the OS i
|
|||
---
|
||||
|
||||
## carla.TrafficLight<a name="carla.TrafficLight"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.TrafficSign](#carla.TrafficSign)_</b></small></div></p><p>A traffic light actor, considered a specific type of traffic sign. As traffic lights will mostly appear at junctions, they belong to a group which contains the different traffic lights in it. Inside the group, traffic lights are differenciated by their pole index.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.TrafficSign](#carla.TrafficSign)_**</small></br>
|
||||
A traffic light actor, considered a specific type of traffic sign. As traffic lights will mostly appear at junctions, they belong to a group which contains the different traffic lights in it. Inside the group, traffic lights are differenciated by their pole index.
|
||||
|
||||
Within a group the state of traffic lights is changed in a cyclic pattern: one index is chosen and it spends a few seconds in green, yellow and eventually red. The rest of the traffic lights remain frozen in red this whole time, meaning that there is a gap in the last seconds of the cycle where all the traffic lights are red. However, the state of a traffic light can be changed manually.
|
||||
|
||||
|
|
@ -2115,7 +2129,8 @@ _</font>
|
|||
---
|
||||
|
||||
## carla.TrafficSign<a name="carla.TrafficSign"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.Actor](#carla.Actor)_</b></small></div></p><p>Traffic signs appearing in the simulation except for traffic lights. These have their own class inherited from this in [carla.TrafficLight](#carla.TrafficLight). Right now, speed signs, stops and yields are mainly the ones implemented, but many others are borne in mind.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.Actor](#carla.Actor)_**</small></br>
|
||||
Traffic signs appearing in the simulation except for traffic lights. These have their own class inherited from this in [carla.TrafficLight](#carla.TrafficLight). Right now, speed signs, stops and yields are mainly the ones implemented, but many others are borne in mind.
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.TrafficSign.trigger_volume"></a>**<font color="#f8805a">trigger_volume</font>**
|
||||
|
|
@ -2240,7 +2255,8 @@ Returns the axis values for the vector parsed as string.
|
|||
---
|
||||
|
||||
## carla.Vehicle<a name="carla.Vehicle"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.Actor](#carla.Actor)_</b></small></div></p><p>One of the most important group of actors in CARLA. These include any type of vehicle from cars to trucks, motorbikes, vans, bycicles and also official vehicles such as police cars. A wide set of these actors is provided in [carla.BlueprintLibrary](#carla.BlueprintLibrary) to facilitate differente requirements. Vehicles can be either manually controlled or set to an autopilot mode that will be conducted client-side by the <b>traffic manager</b>.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.Actor](#carla.Actor)_**</small></br>
|
||||
One of the most important group of actors in CARLA. These include any type of vehicle from cars to trucks, motorbikes, vans, bycicles and also official vehicles such as police cars. A wide set of these actors is provided in [carla.BlueprintLibrary](#carla.BlueprintLibrary) to facilitate differente requirements. Vehicles can be either manually controlled or set to an autopilot mode that will be conducted client-side by the <b>traffic manager</b>.
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.Vehicle.bounding_box"></a>**<font color="#f8805a">bounding_box</font>** (_[carla.BoundingBox](#carla.BoundingBox)_)
|
||||
|
|
@ -2424,7 +2440,8 @@ VehiclePhysicsControl constructor.
|
|||
---
|
||||
|
||||
## carla.Walker<a name="carla.Walker"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.Actor](#carla.Actor)_</b></small></div></p><p>This class inherits from the [carla.Actor](#carla.Actor) and defines pedestrians in the simulation. Walkers are a special type of actor that can be controlled either by an AI ([carla.WalkerAIController](#carla.WalkerAIController)) or manually via script, using a series of [carla.WalkerControl](#carla.WalkerControl) to move these and their skeletons.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.Actor](#carla.Actor)_**</small></br>
|
||||
This class inherits from the [carla.Actor](#carla.Actor) and defines pedestrians in the simulation. Walkers are a special type of actor that can be controlled either by an AI ([carla.WalkerAIController](#carla.WalkerAIController)) or manually via script, using a series of [carla.WalkerControl](#carla.WalkerControl) to move these and their skeletons.
|
||||
|
||||
<h3>Instance Variables</h3>
|
||||
- <a name="carla.Walker.bounding_box"></a>**<font color="#f8805a">bounding_box</font>** (_[carla.BoundingBox](#carla.BoundingBox)_)
|
||||
|
|
@ -2451,7 +2468,8 @@ The client returns the control applied to this walker during last tick. The meth
|
|||
---
|
||||
|
||||
## carla.WalkerAIController<a name="carla.WalkerAIController"></a>
|
||||
<div class="Inherited"><small><b>Inherited from _[carla.Actor](#carla.Actor)_</b></small></div></p><p>Class that conducts AI control for a walker. The controllers are defined as actors, but they are quite different from the rest. They need to be attached to a parent actor during their creation, which is the walker they will be controlling (take a look at [carla.World](#carla.World) if you are yet to learn on how to spawn actors). They also need for a special blueprint (already defined in [carla.BlueprintLibrary](#carla.BlueprintLibrary) as "controller.ai.walker"). This is an empty blueprint, as the AI controller will be invisible in the simulation but will follow its parent around to dictate every step of the way.
|
||||
<small style="display:block;margin-top:-20px;">**Inherited from _[carla.Actor](#carla.Actor)_**</small></br>
|
||||
Class that conducts AI control for a walker. The controllers are defined as actors, but they are quite different from the rest. They need to be attached to a parent actor during their creation, which is the walker they will be controlling (take a look at [carla.World](#carla.World) if you are yet to learn on how to spawn actors). They also need for a special blueprint (already defined in [carla.BlueprintLibrary](#carla.BlueprintLibrary) as "controller.ai.walker"). This is an empty blueprint, as the AI controller will be invisible in the simulation but will follow its parent around to dictate every step of the way.
|
||||
|
||||
<h3>Methods</h3>
|
||||
- <a name="carla.WalkerAIController.go_to_location"></a>**<font color="#7fb800">go_to_location</font>**(<font color="#00a6ed">**self**</font>, <font color="#00a6ed">**destination**</font>)
|
||||
|
|
@ -3675,4 +3693,4 @@ for (let i = 0; i < buttons.length; i++) {
|
|||
buttons[i].addEventListener("click",function(){ButtonAction(buttons[i].id);},true);
|
||||
}
|
||||
window.onresize = WindowResize;
|
||||
</script>
|
||||
</script>
|
||||
|
|
|
|||
|
|
@ -77,9 +77,6 @@ class MarkdownFile:
|
|||
self._data = join([
|
||||
self._data, '#Python API reference\n'])
|
||||
|
||||
def button_apis(self):
|
||||
self._data = join([self._data, ''])
|
||||
|
||||
def title(self, strongness, buf):
|
||||
self._data = join([
|
||||
self._data, '\n', self.list_depth(), '#' * strongness, ' ', buf, '\n'])
|
||||
|
|
@ -94,7 +91,7 @@ class MarkdownFile:
|
|||
|
||||
def inherit_join(self, inh):
|
||||
self._data = join([
|
||||
self._data,'<div class="Inherited"><small><b>Inherited from ',inh,'</b></small></div></p><p>'])
|
||||
self._data, '<small style="display:block;margin-top:-20px;">**Inherited from ', inh, '**</small></br>\n'])
|
||||
|
||||
def note(self, buf):
|
||||
self._data = join([self._data, buf])
|
||||
|
|
@ -131,8 +128,9 @@ def brackets(buf):
|
|||
def parentheses(buf):
|
||||
return join(['(', buf, ')'])
|
||||
|
||||
|
||||
def small_html(buf):
|
||||
return join(['<small>'+buf+'</small>'])
|
||||
return join(['<small>', buf, '</small>'])
|
||||
|
||||
|
||||
def small(buf):
|
||||
|
|
@ -666,8 +664,8 @@ class Documentation:
|
|||
class_name = cl['class_name']
|
||||
class_key = join([module_key, class_name], '.')
|
||||
current_title = module_name+'.'+class_name
|
||||
md.title(2, join([current_title,'<a name="'+current_title+'"></a>']))
|
||||
inherits = ''
|
||||
md.title(2, join([current_title,'<a name="',current_title,'"></a>']))
|
||||
# Inheritance
|
||||
if valid_dic_val(cl, 'parent'):
|
||||
inherits = italic(create_hyperlinks(cl['parent']))
|
||||
md.inherit_join(inherits)
|
||||
|
|
|
|||
Loading…
Reference in New Issue