Teradata Package for Python Function Reference | 20.00 - is_closed - 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
Published
March 2024
Language
English (United States)
Last Update
2024-04-10
dita:id
TeradataPython_FxRef_Enterprise_2000
Product Category
Teradata Vantage
teradataml.geospatial.geodataframecolumn.GeoDataFrameColumn.is_closed
DESCRIPTION:
    Tests if a Geometry type that represents an ST_LineString, GeoSequence,
    or ST_MultiLineString value is closed.
    Note:
        *  An ST_LineString value is closed if the start point of the
          ST_LineString value is equal to the end point.
 
PARAMETERS:
    None
 
SUPPORTED GEOMETRY TYPES:
    ST_LineString, GeoSequence, and ST_MultiLineString
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrameColumn
    Resultant column contains:
        * 1, if the ST_LineString, GeoSequence, or ST_LineString components
          of an ST_MultiLineString are closed.
        * 0, if the ST_LineString, GeoSequence, or ST_LineString components
          of an ST_MultiLineString are not closed, or if the input geometry
          is empty.
 
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.skey.isin([1001, 1002, 1003])]
    gdf
 
    # Example 1: Check if geometries in column 'linestrings' is are closed or not.
    gdf.assign(res=gdf.linestrings.is_closed)
 
    # Example 2: Filter the rows where geometry in column 'linestrings' is closed.
    gdf[gdf.linestrings.is_closed == 1]