LOCATION_INFO#

invertedai.api.location_info(location: str, include_map_source: bool = False) LocationResponse[source]#

Provides static information about a given location.

Parameters:
  • location – Location string in IAI format.

  • include_map_source – Whether to return full map specification in Lanelet2 OSM format. This significantly increases the response size, consuming more network resources.

See also

drive(), initialize()


class invertedai.api.LocationResponse(*, version: str, max_agent_number: int, bounding_polygon: Optional[List[Point]] = None, birdview_image: Image, osm_map: Optional[LocationMap] = None, static_actors: List[StaticMapActor])[source]#

Response returned from an API call to iai.location_info().

birdview_image: Image#

Visualization of the location.

bounding_polygon: Optional[List[Point]]#

Convex polygon denoting the boundary of the supported area within the location.

max_agent_number: int#

Maximum number of agents recommended in the location. Use more at your own risk.

osm_map: Optional[LocationMap]#

Underlying map annotation, returned if include_map_source was set.

static_actors: List[StaticMapActor]#

Lists traffic lights with their IDs and locations.

version: str#

Map version. Matches the version in the input location string, if one was specified.