Teradata Package for Python Function Reference on VantageCloud Lake | 17.20 - 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 on VantageCloud Lake

Deployment
VantageCloud
Edition
Lake
Product
Teradata Package for Python
Release Number
17.20
Publication Date
November 2022
Content Type
Programming Reference
Publication ID
B700-4500-112K
ft:locale
en-US
ft:lastEdition
2024-02-21
ft:sourceId
FTML
dita:id
TeradataPython_FxRef_Lake_1720
Product Category
Teradata Vantage
teradataml.geospatial.geodataframe.GeoDataFrame.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:
    GeoDataFrame
    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
    # 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.
    # 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