Teradata Package for Python Function Reference | 20.00 - area - 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.00.03
- Published
- December 2024
- ft:locale
- en-US
- ft:lastEdition
- 2024-12-19
- dita:id
- TeradataPython_FxRef_Enterprise_2000
- Product Category
- Teradata Vantage
- teradataml.geospatial.geodataframecolumn.GeoDataFrameColumn.area
- DESCRIPTION:
Returns the area measurement of an ST_Polygon or ST_MultiPolygon. For
ST_MultiPolygon, returns the sum of the area measurements of the
component polygons.
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 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
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 area of all geometries in column 'polygons'.
gdf.assign(res=gdf.polygons.area)
# Example 2: Filter the rows where area of geometry (polygon) is greater than 400.
gdf[gdf.polygons.area > 400]