Teradata Package for Python Function Reference | 17.10 - is_closed_3D - 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
- Product Category
- Teradata Vantage
- teradataml.geospatial.geodataframe.GeoDataFrame.is_closed_3D
- DESCRIPTION:
Tests whether a 3D LineString or 3D MultiLineString is closed, taking
into account the Z coordinates in the calculation.
PARAMETERS:
None
SUPPORTED GEOMETRY TYPES:
LineString and MultiLineString types that include Z coordinates
RAISES:
TypeError, ValueError, TeradataMlException
RETURNS:
GeoDataFrame
Resultant column contains:
* 1, if the 3D LineString or 3D MultiLineString is closed.
* 0, if the 3D LineString or 3D MultiLineString is not closed or is empty.
EXAMPLES:
from teradataml import GeoDataFrame, load_example_data
# Load example data.
load_example_data("geodataframe", "sample_shapes")
# Create a GeoDataFrame.
gdf = GeoDataFrame("sample_shapes")
# Select few columns and filter rows containing only 3D geometries in 'linestrings' column.
gdf = gdf.select(["skey", "polygons", "linestrings"])[gdf.linestrings.is_3D == 1]
gdf
# Example 1: Check if 3D geometries in column "linestings" is are closed or not.
# Let's check where the GeoDataFrame.geometry property points to.
print(gdf.geometry.name)
# Note: By default, GeoDataFrame.geometry property points to the first geometry column,
# in this case it is 'polygons'.
# Set the geometry property to 'linestrings' column.
gdf.geometry = gdf.linestrings
gdf.is_closed_3D