Geospatial Filters

Requests for multiple Flow or Incident objects require the in parameter to be provided, it specified a geospatial filter defining a region in which the data will be returned.

There are three different geospatial filter types which can be used.

  • Circle
  • Bounding Box
  • Corridor

Circle

The circle geospatial filter is defined by a center point and a radius in meters. The center point must be provided as WGS84 coordinates.

Note

The maximum radius permitted for a circle filter is 50 Km (50000 meters).

  • Format: circle:{latitude},{longitude};r={radius}
  • Type: circle:{decimal},{decimal};r={integer}
  • Example: 52.537675,13.40302;r=1000

The example given above describes a circle centered on the coordinates 52.537675, 13.40302 with a radius of 1000 meters (1 kilometer). A graphical representation can be seen below.

A representation of a circle filter laid over a map of Mitte, Berlin
Figure 1. Circle geospatial filter example

Bounding Box

The bounding box geospatial filter is defined by two longitude values and two latitude values. The format is specified below.

Note

The maximum width and height for a bounding box filter is 1 degree.

  • Format: bbox:{west longitude},{south latitude},{east longitude},{north latitude}
  • Type: bbox:{decimal},{decimal},{decimal},{decimal}
  • Example: bbox:13.386969,52.527129,13.424134,52.549420

The example given above describes a bounding box with the following limits:

  • Western limit at longitude 13.386969
  • Southern limit at latitude 52.527129
  • Eastern limit at longitude 13.424134
  • Northern limit at latitude 52.549420

A graphical representation can be seen below.

A representation of a bounding box filter laid over a map of Mitte, Berlin
Figure 2. Bounding box geospatial filter example

Corridor

The corridor geospatial filter is defined by a list of two or more coordinates and a radius in meters. The coordinates are provided as a polyline in Flexible Polyline encoding.

The radius is the distance on either side of the points forming the corridor, so the width of the corridor is twice the radius.

Note

The maximum length for a corridor is 500 Km (500000 meters) and the maximum radius is 5 Km (5000 meters).

The format is specified below.

  • Format: corridor:{polyline};r={radius}
  • Type: corridor:{string};r={integer}
  • Example: corridor:BG-6kmkDw1zwZqqG6xmBsgL5rGmwFgqZ_oEw1d;r=230

To create the example above, we first define a corridor by the following 5 points:

  1. 52.529583, 13.379416
  2. 52.532820, 13.399157
  3. 52.538458, 13.395896
  4. 52.541277, 13.408856
  5. 52.539085, 13.424048

This corresponds to the Flexible Polyline BG-6kmkDw1zwZqqG6xmBsgL5rGmwFgqZ_oEw1d. The specified radius is 230 meters so the distance from one side of the corridor to the other is 460 meters.

A graphical representation can be seen below.

A representation of a corridor filter laid over a map of Mitte, Berlin
Figure 3. Corridor geospatial filter example

results matching ""

    No results matching ""