Teradata Package for Python Function Reference | 17.10 - get_link - 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.get_link = get_link(self, index)
DESCRIPTION:
    Get the link ID of a specified point in a GeoSequence.
 
PARAMETERS:
    index:
        Required Argument.
        Specifies the index of the point in the GeoSequence, where the index of the
        first point is 1.
        Types: int, str, ColumnExpression
 
SUPPORTED GEOMETRY TYPES:
    GeoSequence
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrameColumn
 
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)
    
    # Select 'skey' and 'geosequence' column and filter the rows where geometries are not None.
    geoseq = geodf.select(["skey", "geosequence"])[geodf.geosequence != None]
 
    # Example 1: Get the link ID of the point at 1st position in a Geosequence geometry in 'geosequence' column.
    geo_gl1 = geoseq.geosequence.get_link(1)
    geoseq.assign(res = geo_gl1)
 
    # Example 2: Get all the rows where the link ID of the point at 2nd position in a Geosequence
    #            geometry in 'geosequence' column is equal to 2.
    geo_gl2 = geoseq.geosequence.get_link(index=2)
    geoseq[geo_gl2 == 2]