geo.totalDistance() function

geo.totalDistance() calculates the total distance covered by subsequent points in each input table.

Each row must contain lat (latitude) and lon (longitude) columns that represent the geographic coordinates of the point. Row sort order determines the order in which distance between points is calculated. Use the geo.units option to specify the unit of distance to return (default is km).

Function type signature

(<-tables: stream[{B with lon: float, lat: float}], ?outputColumn: A) => stream[C] where C: Record

Parameters

outputColumn

Total distance output column. Default is _value.

tables

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

Examples

• Return the total distance travelled per input table
• Return the total distance travelled in miles

Return the total distance travelled per input table

import "experimental/geo"

data
    |> geo.totalDistance()

Return the total distance travelled in miles

import "experimental/geo"

option geo.units = {distance: "mile"}

data
    |> geo.totalDistance()