2020-07-23 21:08:50 +08:00
---
- module_name : carla
# - CLASSES ------------------------------
classes :
2020-07-29 20:15:38 +08:00
- class_name : Osm2Odr
2020-07-23 21:08:50 +08:00
# - DESCRIPTION ------------------------
doc : >
2020-07-29 20:15:38 +08:00
Class that converts an OpenStreetMap map to OpenDRIVE format, so that it can be loaded in CARLA. Find out more about this feature in the [docs](tuto_G_openstreetmap.md).
# - PROPERTIES -------------------------
instance_variables :
2020-07-23 21:08:50 +08:00
# - METHODS ----------------------------
methods :
2020-07-28 17:34:30 +08:00
- def_name : convert
2020-07-23 21:08:50 +08:00
static :
True
return : str
doc : >
The converted OpenDRIVE xml data.
params :
- param_name : osm_file
type : str
doc : >
2020-07-29 20:15:38 +08:00
The content of the input OpenStreetMap file parsed as string.
2020-07-23 21:08:50 +08:00
- param_name : settings
type : carla.OSM2ODRSettings
doc : >
2020-07-29 20:15:38 +08:00
Parameterization for the conversion.
2020-07-23 21:08:50 +08:00
doc : >
2020-07-29 20:27:20 +08:00
Takes the content of an <code>.osm</code> file (OpenStreetMap format) and returns the content of the <code>.xodr</code> (OpenDRIVE format) describing said map. Some parameterization is passed to do the conversion.
2020-07-23 21:08:50 +08:00
# --------------------------------------
2020-07-28 17:34:30 +08:00
- class_name : Osm2OdrSettings
2020-07-23 21:08:50 +08:00
# - DESCRIPTION ------------------------
doc : >
2020-07-29 20:15:38 +08:00
Helper class that contains the parameterization that will be used by carla.Osm2Odr to convert an OpenStreetMap map to OpenDRIVE format. Find out more about this feature in the [docs](tuto_G_openstreetmap.md).
2020-07-23 21:08:50 +08:00
instance_variables :
- var_name : use_offsets
type : bool
doc : >
2020-07-29 20:15:38 +08:00
Enables the use of offset for the conversion. The offset will move the origin position of the map. Default value is __False__.
2020-07-23 21:08:50 +08:00
- var_name : offset_x
type : float
2020-09-14 22:58:48 +08:00
var_units : meters
2020-07-23 21:08:50 +08:00
doc : >
2020-07-29 20:15:38 +08:00
Offset in the X axis. Default value is __0.0__.
2020-07-23 21:08:50 +08:00
- var_name : offset_y
type : float
2020-09-14 22:58:48 +08:00
var_units : meters
2020-07-23 21:08:50 +08:00
doc : >
2020-07-29 20:15:38 +08:00
Offset in the Y axis. Default value is __0.0__.
2020-07-23 21:08:50 +08:00
- var_name : default_lane_width
type : float
2020-09-14 22:58:48 +08:00
var_units : meters
2020-07-23 21:08:50 +08:00
doc : >
2020-07-29 20:15:38 +08:00
Width of the lanes described in the resulting XODR map. Default value is __4.0__.
2020-07-23 21:08:50 +08:00
- var_name : elevation_layer_height
type : float
2020-09-14 22:58:48 +08:00
var_units : meters
2020-07-23 21:08:50 +08:00
doc : >
2020-07-29 20:15:38 +08:00
Defines the height separating two different [OpenStreetMap layers](https://wiki.openstreetmap.org/wiki/Key:layer). Default value is __0.0__.
