From 6d56aa843fc57a338f113a1c555e5bc7ef732b70 Mon Sep 17 00:00:00 2001 From: Axel Date: Wed, 29 Jul 2020 14:27:20 +0200 Subject: [PATCH] Updated function naming. --- Docs/tuto_G_openstreetmap.md | 34 ++++++++++----------- PythonAPI/carla/source/libcarla/OSM2ODR.cpp | 2 +- PythonAPI/docs/osm2odr.yml | 2 +- PythonAPI/util/config.py | 2 +- 4 files changed, 20 insertions(+), 20 deletions(-) diff --git a/Docs/tuto_G_openstreetmap.md b/Docs/tuto_G_openstreetmap.md index 6c5a2bd30..1940c7f24 100644 --- a/Docs/tuto_G_openstreetmap.md +++ b/Docs/tuto_G_openstreetmap.md @@ -11,7 +11,7 @@ OpenStreetMap is an open license map of the world developed by contributors. Sec The first thing to do is using [OpenStreetMap](https://www.openstreetmap.org) to generate an XML file containing the map information. -__1.1. Go to [openstreetmap.org](https://www.openstreetmap.org)__. If the map is not properly visualized, try changing the layer in the righ pannel. +__1.1. Go to [openstreetmap.org](https://www.openstreetmap.org)__. If the map is not properly visualized, try changing the layer in the righ pannel. __1.2 Search for a desired location__ and zoom in to a specific area. ![openstreetmap_view](img/tuto_g_osm_web.jpg) @@ -32,42 +32,42 @@ __1.6. Click the `Export` button__ in the __Export__ pannel, and save the map in --- ## 2- Convert to OpenDRIVE format -CARLA can read a XML file generated with OpenStreetMaps, and convert it to OpenDRIVE format that can be ingested as a CARLA map. This can be done through the PythonAPI using the following classes. +CARLA can read a XML file generated with OpenStreetMaps, and convert it to OpenDRIVE format that can be ingested as a CARLA map. This can be done through the PythonAPI using the following classes. -* __[carla.osm2odr](python_api.md#carla.osm2odr)__ – The class that does the conversion. It takes the content of the `.osm` parsed as strind, and returns a string containing the resulting `.xodr`. - * `osm_file` — The content of the initial `.osm` file parsed as string. - * `settings` — A [carla.Osm2OdrSettings](python_api.md#carla.Osm2OdrSettings) object containing the settings to parameterize the conversion. -* __[carla.Osm2OdrSettings](python_api.md#carla.Osm2OdrSettings)__ – Helper class that contains different parameters used during the conversion. - * `use_offsets` *(default False)* — Determines whereas the map should be generated with an offset, thus moving the origin from the center according to that offset. - * `offset_x` *(default 0.0)* — Offset in the X axis. - * `offset_y` *(default 0.0)* — Offset in the Y axis. - * `default_lane_width` *(default 4.0)* — Determines the width that lanes should have in the resulting XODR file. - * `elevation_layer_height` *(default 0.0)* — Determines the height separating elements in different layers, used for overlapping elements. Read more on [layers](https://wiki.openstreetmap.org/wiki/Key:layer). +* __[carla.Osm2Odr](python_api.md#carla.Osm2Odr)__ – The class that does the conversion. It takes the content of the `.osm` parsed as strind, and returns a string containing the resulting `.xodr`. + * `osm_file` — The content of the initial `.osm` file parsed as string. + * `settings` — A [carla.Osm2OdrSettings](python_api.md#carla.Osm2OdrSettings) object containing the settings to parameterize the conversion. +* __[carla.Osm2OdrSettings](python_api.md#carla.Osm2OdrSettings)__ – Helper class that contains different parameters used during the conversion. + * `use_offsets` *(default False)* — Determines whereas the map should be generated with an offset, thus moving the origin from the center according to that offset. + * `offset_x` *(default 0.0)* — Offset in the X axis. + * `offset_y` *(default 0.0)* — Offset in the Y axis. + * `default_lane_width` *(default 4.0)* — Determines the width that lanes should have in the resulting XODR file. + * `elevation_layer_height` *(default 0.0)* — Determines the height separating elements in different layers, used for overlapping elements. Read more on [layers](https://wiki.openstreetmap.org/wiki/Key:layer). -The input and output of the conversion are not the `.osm` and `.xodr` files itself, but their content. For said reason, the code should be similar to the following. +The input and output of the conversion are not the `.osm` and `.xodr` files itself, but their content. For said reason, the code should be similar to the following. ``` # Read the .osm data f = open("path/to/osm/file", 'r') osm_data = f.read() f.close() -# Define the desired settings. In this case, default values. +# Define the desired settings. In this case, default values. settings = carla.Osm2OdrSettings() # Convert to .xodr -xodr_data = carla.osm2odr.convert(osm_data, settings) +xodr_data = carla.Osm2Odr.convert(osm_data, settings) # save opendrive file f = open("path/to/output/file", 'w') f.write(xodr_data) f.close() ``` -The resulting file contains the road information in OpenDRIVE format. +The resulting file contains the road information in OpenDRIVE format. --- ## 3- Import into CARLA -Finally, the OpenDRIVE file can be easily ingested in CARLA using the [OpenDRIVE Standalone Mode](#adv_opendrive.md). +Finally, the OpenDRIVE file can be easily ingested in CARLA using the [OpenDRIVE Standalone Mode](#adv_opendrive.md). __a) Using your own script__ — Call for [`client.generate_opendrive_world()`](python_api.md#carla.Client.generate_opendrive_world) through the API. This will generate the new map, and block the simulation until it is ready. Use the [carla.OpendriveGenerationParameters](python_api.md#carla.OpendriveGenerationParameters) class to set the parameterization of the mesh generation. @@ -87,7 +87,7 @@ world = client.generate_opendrive_world( ``` !!! Note - `wall_height = 0.0` is strongly recommended. OpenStreetMap defines lanes in opposing directions as different roads. If walls are generated, this result in wall overlapping and undesired collisions. + `wall_height = 0.0` is strongly recommended. OpenStreetMap defines lanes in opposing directions as different roads. If walls are generated, this result in wall overlapping and undesired collisions. __b) Using config.py__ — We also provide the means to load an OpenStreetMap file directly to CARLA using the `config.py` script provided with CARLA. ``` diff --git a/PythonAPI/carla/source/libcarla/OSM2ODR.cpp b/PythonAPI/carla/source/libcarla/OSM2ODR.cpp index 8757264a1..bde06dc87 100644 --- a/PythonAPI/carla/source/libcarla/OSM2ODR.cpp +++ b/PythonAPI/carla/source/libcarla/OSM2ODR.cpp @@ -32,7 +32,7 @@ void export_osm2odr() { .def(self_ns::str(self_ns::self)) ; - class_("osm2odr", no_init) + class_("Osm2Odr", no_init) .def("convert", &ConvertOSMToOpenDRIVE, (arg("osm_file"), arg("settings") = OSM2ODRSettings())) .staticmethod("convert") ; diff --git a/PythonAPI/docs/osm2odr.yml b/PythonAPI/docs/osm2odr.yml index d91fbca01..365992e6b 100644 --- a/PythonAPI/docs/osm2odr.yml +++ b/PythonAPI/docs/osm2odr.yml @@ -27,7 +27,7 @@ doc: > Parameterization for the conversion. doc: > - Takes the content of an .osm file (OpenStreetMap format) and returns the content of the .xodr (OpenDRIVE format) describing said map. Some parameterization is passed to do the conversion. + Takes the content of an .osm file (OpenStreetMap format) and returns the content of the .xodr (OpenDRIVE format) describing said map. Some parameterization is passed to do the conversion. # -------------------------------------- - class_name: Osm2OdrSettings # - DESCRIPTION ------------------------ diff --git a/PythonAPI/util/config.py b/PythonAPI/util/config.py index 178af2913..2b74ad5b5 100755 --- a/PythonAPI/util/config.py +++ b/PythonAPI/util/config.py @@ -236,7 +236,7 @@ def main(): print('file could not be readed.') sys.exit() print('Converting OSM data to opendrive') - xodr_data = carla.osm2odr.convert(data) + xodr_data = carla.Osm2Odr.convert(data) print('load opendrive map.') vertex_distance = 2.0 # in meters max_road_length = 500.0 # in meters