Teradata Package for Python Function Reference | 17.10 - length_3D - Teradata Package for Python

Teradata® Package for Python Function Reference

Product
Teradata Package for Python
Release Number
17.10
Published
April 2022
Language
English (United States)
Last Update
2022-08-19
Product Category
Teradata Vantage
teradataml.geospatial.geodataframe.GeoDataFrame.length_3D = length_3D(self)
DESCRIPTION:
    Returns the length of a 3D LineString or MultiLineString, taking into
    account the Z coordinates in the calculation.
 
PARAMETERS:
    None
 
SUPPORTED GEOMETRY TYPES:
    LineString and MultiLineString types that include Z coordinates
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrame
    Resultant column contains a 0, if the LineString or MultiLineString is an empty set.
 
EXAMPLES:
    from teradataml import GeoDataFrame, load_example_data
    from teradataml import Point, LineString, Polygon
    # Load example data.
    load_example_data("geodataframe", "sample_shapes")
    # Create a GeoDataFrame.
    geodf = GeoDataFrame("sample_shapes")
    print(geodf)
 
    # Example 1: Get the length of 3D ST_Linestring/ST_MultiLinestring geometries
    #            in column 'linestrings'.
    # Let's select only few columns from GeoDataFrame.
    lines = geodf.select(["skey", "linestrings"])[geodf.linestrings.is_3D == 1]
    lines.length_3D()