teradataml.geospatial.geodataframecolumn.GeoDataFrameColumn.coord_dim

DESCRIPTION:
    Returns the coordinate dimension of a geometry.
    Note:
        *  The coordinate dimension is the same as the coordinate dimension of
          the spatial reference system for the Geometry value.
 
PARAMETERS:
    None
 
SUPPORTED GEOMETRY TYPES:
    All Geometry types.
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrameColumn
    Resultant column contains:
        * 1, if the input geometry is 1D
        * 2, if the input geometry is 2D
        * 3, if the input geometry is 3D
 
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 coordinate dimension of all geometries in column 'polygons'.
    gdf.assign(res=gdf.polygons.coord_dim)
 
    # Example 2: Filter the rows where coordinate dimension of geometry (polygon) is equal to 3.
    gdf[gdf.polygons.coord_dim == 3]