Teradata Package for Python Function Reference | 17.10 - convex_hull - 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.convex_hull
- DESCRIPTION:
Returns the convex hull of the Geometry value.
PARAMETERS:
None
SUPPORTED GEOMETRY TYPES:
All Geometry types.
Note:
This method can be called on 3D geometries (those that include Z
coordinates). However, the Z coordinate is ignored in method
calculations. Consequently, any Z coordinates returned by this
method should be ignored. Teradata recommends using the make_2D()
method to strip out the Z coordinates of the return value.
RAISES:
TypeError, ValueError, TeradataMlException
RETURNS:
GeoDataFrameColumn 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.
gdf = GeoDataFrame("sample_shapes")
gdf = gdf.select(["skey", "polygons", "linestrings"])
gdf
# Example 1: Get the convex hull of all geometries in column 'polygons'.
gdf.assign(res=gdf.polygons.convex_hull)
# Example 2: Filter the rows where centroid of geometry (polygon) is same as that of the Polygon Geometry type object.
# Create Polygon Geometry objects.
po1 = Polygon([(0, 0), (0, 20), (20, 20), (20, 0), (0, 0)])
# Execute the function using slice filtering.
gdf[gdf.polygons.convex_hull == po1]