Teradata Package for Python Function Reference | 17.10 - line_interpolate_point - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the 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
lifecycle
previous
Product Category
Teradata Vantage
teradataml.geospatial.geodataframecolumn.GeoDataFrameColumn.line_interpolate_point = line_interpolate_point(self, proportion)
DESCRIPTION:
    Returns a point interpolated along a Geometry type that represents an
    ST_LineString or GeoSequence value, given a proportional distance along
    that line.
 
PARAMETERS:
    proportion:
        Required Argument.
        Specifies a value between 0 and 1 that represents the fraction of the
        total 2-dimensional length of the ST_LineString where the point must
        be located.
        Types: float, str, ColumnExpression
 
SUPPORTED GEOMETRY TYPES:
    ST_LineString and GeoSequence
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrameColumn containing ST_Point Geometry values
 
EXAMPLES:
    from teradataml import GeoDataFrame, load_example_data
    from teradataml import Point, LineString, Polygon, GeometryCollection
    # Load example data.
    load_example_data("geodataframe", "sample_shapes")
    # Create a GeoDataFrame.
    geodf = GeoDataFrame("sample_shapes")
    print(geodf)
 
    # Example 1: Get the point interpolated along the ST_Linestring geometries
    #            in column 'linestrings'.
    # Let's select only few columns from GeoDataFrame and filter rows which contains
    # only ST_Linestring geometries.
    lines = geodf.select(["skey", "linestrings"])[geodf.linestrings.geom_type == "ST_Linestring"]
    lines.assign(res = lines.geometry.line_interpolate_point(proportion=0.28))
 
    # Example 2: Filter the rows where the point interpolated along the ST_Linestring geometries
    #            in column 'linestrings' is same as the specified Point GeometryType object.
    # Create an object of Point GeometryType.
    p1 = Point(1.84, 1.84)
    lines[lines.geometry.line_interpolate_point(proportion=0.28) == p1]