docs-v2/content/flux/v0/stdlib/experimental/geo/shapedata.md

2.3 KiB

title description menu weight
geo.shapeData() function `geo.shapeData()` renames existing latitude and longitude fields to **lat** and **lon** and adds an **s2_cell_id** tag.
flux_v0_ref
name parent identifier
geo.shapeData experimental/geo experimental/geo/shapeData
201

geo.shapeData() renames existing latitude and longitude fields to lat and lon and adds an s2_cell_id tag.

Use geo.shapeData() to ensure geotemporal data meets the requirements of the Geo package:

  1. Rename existing latitude and longitude fields to lat and lon.
  2. Pivot fields into columns based on _time.
  3. Generate s2_cell_id tags using lat and lon values and a specified S2 cell level.
Function type signature
(
    <-tables: stream[{C with _field: string}],
    latField: A,
    level: int,
    lonField: B,
) => stream[{D with s2_cell_id: string, lon: float, lat: float}] where A: Equatable, B: Equatable

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

latField

({{< req >}}) Name of the existing field that contains the latitude value in decimal degrees (WGS 84).

Field is renamed to lat.

lonField

({{< req >}}) Name of the existing field that contains the longitude value in decimal degrees (WGS 84).

Field is renamed to lon.

level

({{< req >}}) S2 cell level to use when generating the S2 cell ID token.

tables

Input data. Default is piped-forward data (<-).