Teradata Package for Python Function Reference | 20.00 - get_user_field - 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 - 20.00

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Teradata Package for Python
Release Number
20.00
Published
March 2024
Language
English (United States)
Last Update
2024-04-10
dita:id
TeradataPython_FxRef_Enterprise_2000
Product Category
Teradata Vantage
teradataml.geospatial.geodataframe.GeoDataFrame.get_user_field = get_user_field(self, field_index, index)
DESCRIPTION:
    Returns the user field specified by "field_index" for the point specified by
    "index" for a GeoSequence type.
 
PARAMETERS:
    field_index:
        Required Argument.
        Specifies the index of the user field within the point, where the index of the
        first user field is 1.
        Types: int, str, ColumnExpression
 
    index:
        Required Argument.
        Specifies the index of the point within the GeoSequence type, where the index
        of the first point is 1.
        Types: int, str, ColumnExpression
 
SUPPORTED GEOMETRY TYPES:
    GeoSequence
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrame
 
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)
    
    # 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 1st user field with respect to the point at index 1 in a Geosequence
    #            geometry in 'geosequence' column.
    geoseq.get_user_field(1, 1)
 
    # Example 2: Get the 2nd user field with respect to the point at index 1 in a Geosequence
    #            geometry in 'geosequence' column.
    geoseq.get_user_field(field_index=2, index=1)