- invertedai.api.location_info(location: str, include_map_source: bool = False, rendering_fov: Optional[int] = None, rendering_center: Optional[Tuple[float, float]] = None) LocationResponse #
Provides static information about a given location.
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.
rendering_fov – Optional fov for both x and y axis for the rendered birdview in meters.
rendering_center – Optional center x,y coordinates for the rendered birdview.
- class invertedai.api.LocationResponse(*, version: str, max_agent_number: int, bounding_polygon: Optional[List[Point]] = None, birdview_image: Image, osm_map: Optional[LocationMap] = None, map_center: Point, map_fov: float, static_actors: List[StaticMapActor])#
Response returned from an API call to
- bounding_polygon: Optional[List[Point]]#
Convex polygon denoting the boundary of the supported area within the location.
- map_fov: float#
The field of view in meters for the birdview image.
- max_agent_number: int#
Maximum number of agents recommended in the location. Use more at your own risk.
- version: str#
Map version. Matches the version in the input location string, if one was specified.