Skip to main content

mapillary.config.api.vector_tiles

mapillary.config.api.vector_tiles#

This module contains the class implementation of the VectorTile functionalities for the Vector Tile aspect of the API v4 of Mapillary.

For more information, please check out https://www.mapillary.com/developer/api-documentation/.

  • Copyright: (c) 2021 Facebook
  • License: MIT LICENSE

class mapillary.config.api.vector_tiles.VectorTiles()#

Bases: object

Vector tiles provide an easy way to visualize vast amounts of data. Mapillary APIs are heavily based on vector tiles to provide the developers with flexibility to programmatically interact with the data they contain in custom ways. Vector tiles support filtering and querying rendered features. Mapillary vector tiles follow the Mapbox Tile Specification, https://docs.mapbox.com/vector-tiles/specification/

static get_computed_image_layer(x: float, y: float, z: float)#

Contain positions of images and sequences with original geometries (computed) for the layer ‘image’

This layer offers,

  1. zoom: 14
  1. geometry: Point
  1. data source: images

With the following properties,

  1. captured_at, int, timestamp in ms since epoch
  1. compass_angle, int, the compass angle of the image
  1. id, int, ID of the image
  1. sequence_id, string, ID of the sequence this image belongs to
  1. organization_id, int, ID of the organization this image belongs to. It can be absent
  1. is_pano, bool, if it is a panoramic image

static get_computed_overview_layer(x: float, y: float, z: float)#

Contain positions of images and sequences with original geometries (computed) for the layer ‘overview’

This layer offers,

  1. zoom: 0 - 5 (inclusive)
  1. geometry: Point
  1. data source: images

With the following properties,

  1. captured_at, int, timestamp in ms since epoch
  1. id, int, ID of the image
  1. sequence_id, string, ID of the sequence this image belongs to
  1. is_pano, bool, if it is a panoramic image

static get_computed_sequence_layer(x: float, y: float, z: float)#

Contain positions of images and sequences with original geometries (computed) for the layer ‘sequence’

This layer offers,

  1. zoom: 6 - 14 (inclusive)
  1. geometry: LineString
  1. data source: images captured in a single collection, sorted by captured_at

With the following properties,

  1. captured_at, int, timestamp in ms since epoch
  1. id, string, ID of the sequence (the legacy sequence key)
  1. image_id, int, ID of the ‘best’ (first) image representing the sequence
  1. organization_id, int, ID of the organization this image belongs to. It can be absent
  1. is_pano, bool, if it is a panoramic sequence

static get_image_layer(x: float, y: float, z: float)#

Contain positions of images and sequences with original geometries (not computed) for the layer ‘image’

This layer offers,

  1. zoom: 14
  1. geometry: Point
  1. data source: images

With the following properties,

  1. captured_at, int, timestamp in ms since epoch
  1. compass_angle, int, the compass angle of the image
  1. id, int, ID of the image
  1. sequence_id, string, ID of the sequence this image belongs to
  1. organization_id, int, ID of the organization this image belongs to. It can be absent
  1. is_pano, bool, if it is a panoramic image

static get_map_feature_point(x: float, y: float, z: float)#

These tiles represent positions of map features which are detected on the Mapillary platform and are not traffic signs.

This layer offers,

  1. zoom: 14
  1. geometry: Point
  1. data source: map features

With the following resultant properties,

  1. id, int, ID of the image
  1. value, string, name of the class which this object represent
  1. first_seen_at, int, timestamp in ms since epoch, capture time of the earliest image on

    which the detection contribute to this map feature

  1. last_seen_at, int, timestamp in ms since epoch, capture time of the latest image on which

    the detection contribute to this map feature

static get_map_feature_traffic_sign(x: float, y: float, z: float)#

These tiles represent positions of map features which are detected on the Mapillary platform and are traffic signs.

The tile metadata is exactly the same as Map feature tiles, points, except that the layer name is traffic_sign.

This layer offers,

  1. zoom: 14
  1. geometry: Point
  1. data source: map features

With the following properties,

  1. id, int, ID of the image
  1. value, string, name of the class which this object represent
  1. first_seen_at, int, timestamp in ms since epoch, capture time of the earliest image on

    which the detection contribute to this map feature

  1. last_seen_at, int, timestamp in ms since epoch, capture time of the latest image on

    which the detection contribute to this map feature

static get_overview_layer(x: float, y: float, z: float)#

Contain positions of images and sequences with original geometries (not computed) for the layer ‘overview’

This layer offers,

  1. zoom: 0 - 5 (inclusive)
  1. geometry: Point
  1. data source: images

With the following properties,

  1. captured_at, int, timestamp in ms since epoch
  1. id, int, ID of the image
  1. sequence_id, string, ID of the sequence this image belongs to
  1. is_pano, bool, if it is a panoramic image

static get_sequence_layer(x: float, y: float, z: float)#

Contain positions of images and sequences with original geometries (not computed) for the layer ‘sequence’

This layer offers,

  1. zoom: 6 - 14 (inclusive)
  1. geometry: LineString
  1. data source: images captured in a single collection, sorted by captured_at

With the following properties,

  1. captured_at, int, timestamp in ms since epoch
  1. id, string, ID of the sequence (the legacy sequence key)
  1. image_id, int, ID of the ‘best’ (first) image representing the sequence
  1. organization_id, int, ID of the organization this image belongs to. It can be absent
  1. is_pano, bool, if it is a panoramic sequence

Module contents#

mapillary.config.api.init

This package contains all the API v4 endpoints provided with the Mapillary Python SDK.

  • Copyright: (c) 2021 Facebook
  • License: MIT LICENSE