Teradata Package for Python Function Reference on VantageCloud Lake | 17.20 - point_on_surface - 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 on VantageCloud Lake

Deployment
VantageCloud
Edition
Lake
Product
Teradata Package for Python
Release Number
17.20
Publication Date
November 2022
Content Type
Programming Reference
Publication ID
B700-4500-112K
ft:locale
en-US
ft:lastEdition
2024-02-21
ft:sourceId
FTML
dita:id
TeradataPython_FxRef_Lake_1720
Product Category
Teradata Vantage
teradataml.geospatial.geodataframe.GeoDataFrame.point_on_surface = point_on_surface(self)
DESCRIPTION:
    Returns a point that is guaranteed to spatially intersect an ST_Polygon,
    or at least one of the component polygons of an ST_MultiPolygon.
 
PARAMETERS:
    None
 
SUPPORTED GEOMETRY TYPES:
    ST_Polygon and ST_MultiPolygon
    Note:
        This method can be called on 3D geometries (those that include Z
        coordinates). However, the Z coordinate is dropped, and only x and y
        coordinates are returned.
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrame with result column containing Geometry values
 
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 point in polygon geometries that is guaranteed to spatially intersect.
    # Let's select only few columns from GeoDataFrame.
    pols = geodf.select(["skey", "polygons"])[geodf.skey.isin([1001, 1002, 1003])]
    pols.point_on_surface()