Teradata Package for Python Function Reference on VantageCloud Lake | 17.20 - dimension - 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.geodataframecolumn.GeoDataFrameColumn.dimension
DESCRIPTION:
    Returns the dimension of the Geometry type.
 
PARAMETERS:
    None
 
SUPPORTED GEOMETRY TYPES:
    All Geometry types.
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrameColumn
    Resultant column contains:
        * 0, for a 0-dimensional geometry
        * 1, for a 1D geometry
        * 2, for a 2D geometry
        * -1, 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
 
    # Example 1: Get the dimension of all geometries in column 'polygons'.
    gdf.assign(res=gdf.polygons.dimension)
 
    # Example 2: Filter the rows where dimension of geometry (polygon) is equal to 2.
    gdf[gdf.polygons.dimension == 2]