Teradata Package for Python Function Reference | 17.10 - is_valid - 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.geodataframecolumn.GeoDataFrameColumn.is_valid
- DESCRIPTION:
Tests if a Geometry value is well-formed.
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.
RAISES:
TypeError, ValueError, TeradataMlException
RETURNS:
GeoDataFrameColumn
Resultant column contains:
* 1, if the geometry is valid
* 0, if the geometry is not valid
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: Check if geometries in column 'polygons' is valid or not.
gdf.assign(res=gdf.polygons.is_valid)
# Example 2: Filter the rows where geometry in column 'polygons' is valid.
gdf[gdf.polygons.is_valid == 1]