Teradata Package for Python Function Reference | 17.10 - set_z - 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.set_z = set_z(self, zcoord)
DESCRIPTION:
    Set the Z coordinate of an ST_Point value.
    Note:
        *  This method can be used to convert a 2D point to a 3D point if a
          zcoord argument is passed.
 
PARAMETERS:
    zcoord:
        Required Argument.
        Specifies a value to the new Z coordinate of the ST_Point value.
        Types: float, int, str, ColumnExpression
 
SUPPORTED GEOMETRY TYPES:
    ST_Point
 
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)
 
    # Example 1: Set the Z coordinate of the ST_Point geometries in column 'points'.
    # Let's select only few columns from GeoDataFrame.
    points_df = geodf.select(["skey", "points"])[geodf.skey.isin([1001, 1002, 1003])]
    points_df.assign(res = points_df.points.set_z(zcoord=1000))