geo.shapeData() function

The geo.shapeData() function is experimental and subject to change at any time. By using this function, you accept the risks of experimental functions.

The geo.shapeData() function renames existing latitude and longitude fields to lat and lon and adds an s2_cell_id tag. Use geo.shapeData() to ensure geo-temporal data meets the requirements of the Geo package:

1. Rename existing latitude and longitude fields to lat and lon.
2. Pivot data into row-wise sets based on _time.
3. Generate s2_cell_id tags using lat and lon values and a specified S2 cell level.

*Function type: Transformation*

import "experimental/geo"
geo.shapeData(
  latField: "latitude",
  lonField: "longitude",
  level: 10
)

Parameters

latField

Name of the existing field that contains the latitude value in decimal degrees (WGS 84). Field is renamed to lat.

*Data type: String*

lonField

Name of the existing field that contains the longitude value in decimal degrees (WGS 84). Field is renamed to lon.

*Data type: String*

level

S2 cell level to use when generating the S2 cell ID token.

*Data type: Integer*

Examples

Shape data to meet the requirements of the Geo package

import "experimental/geo"
from(bucket: "example-bucket")
  |> range(start: -1h)
  |> filter(fn: (r) => r._measurement == "example-measurement")
  |> geo.shapeData(
    latField: "latitude",
    lonField: "longitude",
    level: 10
  )

geo.shapeData input and output

Given the following input:

The following function would output:

|> geo.shapeData(
  latField: "latitude",
  lonField: "longitude",
  level: 5
)

Related articles

• Work with geo-temporal data

functions geo