Teradata Package for Python Function Reference | 17.10 - boundary - 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
Release Number
17.10
Published
April 2022
Language
English (United States)
Last Update
2022-08-19
lifecycle
previous
Product Category
DESCRIPTION:
Returns the boundary of the Geometry value.
Notes:
The boundary of a Geometry value is a set of Geometry values of the
next lower dimension.
+=====================================+=====================================+
| IF the Geometry represents ...      | THEN the boundary ...               |
+=====================================+=====================================+
| an ST_Point or ST_MulitPoint value  | is the empty set.                   |
+-------------------------------------+-------------------------------------+
| a nonclosed ST_LineString or        | consists of the start and end       |
| GeoSequence value                   | ST_Point values.                    |
+-------------------------------------+-------------------------------------+
| a closed ST_LineString or           | is empty.                           |
| GeoSequence value                   |                                     |
+-------------------------------------+-------------------------------------+
| an ST_MultiLineString value         | that are in the boundaries of an    |
| consists of ST_Point values         | odd number of its element           |
|                                     | ST_LineString values.               |
+-------------------------------------+-------------------------------------+
| an ST_Polygon value                 | consists of its set of linear rings |
+-------------------------------------+-------------------------------------+
| an ST_MultiPolygon value            | consists of the set of linear rings |
|                                     |  of its ST_Polygon values.          |
+-------------------------------------+-------------------------------------+
| an ST_GeomCollection where the      | consists of geometry values drawn   |
| interiors of the geometries in the  | from the boundaries of the element  |
| collection are disjoint             | geometries, where the geometry      |
|                                     | values are in the boundaries of an  |
|                                     | odd number of element geometries.   |
+=====================================+=====================================+

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:

RETURNS:
GeoDataFrameColumn containing Geometry values

EXAMPLES:
from teradataml import Point, LineString, Polygon
# Create a GeoDataFrame.
gdf = GeoDataFrame("sample_shapes")
gdf = gdf.select(["skey", "polygons", "linestrings"])
gdf

# Example 1: Get the boundary of all Polygon geometries in column 'polygons'.
gdf.assign(res=gdf.polygons.boundary)

# Example 2: Filter the rows where boundary of geometry (polygon) is same as that of the Linestring Geometry type object.
# Create Linestring Geometry objects.
l1 = LineString([(0, 0), (0, 20), (20, 20), (20, 0), (0, 0)])
l2 = LineString([(0,0,0), (0,0,20), (0,20,0), (0,20,20), (20,0,0), (20,0,20), (20,20,0), (20,20,20), (0,0,0)])
# Execute the function using slice filtering.
gdf[(gdf.polygons.boundary == l1) | (gdf.polygons.boundary == l2)]