ST_CreateDistance

ST_CreateDistance takes a number and a linear unit and returns a distance tuple. The linear unit can be meters, kilometers, feet, miles, or nauticalmiles. Both the value and unit can be specified as either literal values or columns.

The distance tuple can be used to query and split tracks using track functions.

Tracks are linestrings that represent the change in an entity's location over time. Each vertex in the linestring has a timestamp (stored as the M-value) and the vertices are ordered sequentially.

For more information on using tracks in GeoAnalytics Engine, see the core concept topic on tracks.

FunctionSyntax
Pythoncreate_distance(value, unit)
SQLST_CreateDistance(value, unit)
ScalacreateDistance(value, unit)

For more details, go to the GeoAnalytics Engine API reference for create_distance.

Examples

PythonPythonSQLScala
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
from geoanalytics.sql import functions as ST

data = [(4.3, "meters"),(5.6, "meters"),(2.7, "feet")]

spark.createDataFrame(data, ["value", "units"]) \
     .select(ST.create_distance("value", "units").alias("create_distance")) \
     .show(truncate=False)
Result
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
+---------------+
|create_distance|
+---------------+
|{4.3, meter}   |
|{5.6, meter}   |
|{2.7, foot}    |
+---------------+

Version table

ReleaseNotes

1.4.0

Python and SQL functions introduced

1.5.0

Scala function introduced

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.