Teradata Package for Python Function Reference on VantageCloud Lake - envelope - 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
- 20.00.00.03
- Published
- December 2024
- ft:locale
- en-US
- ft:lastEdition
- 2024-12-19
- dita:id
- TeradataPython_FxRef_Lake_2000
- Product Category
- Teradata Vantage
- teradataml.geospatial.geodataframe.GeoDataFrame.envelope = envelope(self)
- DESCRIPTION:
Returns the bounding rectangle for 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 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 bounding rectangle for (ST_Point/ST_MultiPoint) geometries in column
# 'points'.
points_lines = geodf.select(["skey", "points", "linestrings"])
points_lines.envelope()
# Example 2: Get the bounding rectangle for (ST_Linestring/ST_MultiLinestring) geometries in column
# 'linestrings'.
# Set the geometry property of GeoDataFrame to point to 'linestrings' column.
points_lines.geometry = points_lines.linestrings
points_lines.envelope()