teradataml.geospatial.geodataframe.GeoDataFrame.perimeter

DESCRIPTION:
    Returns the boundary length of an ST_Polygon, or the sum of the boundary
    lengths of the component polygons of an ST_MultiPolygon.
 
PARAMETERS:
    None
 
SUPPORTED GEOMETRY TYPES:
    ST_Polygon or ST_MultiPolygon
    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:
    GeoDataFrame
 
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
 
    # Example 1: Get the perimeter of all geometries in column 'polygons'.
    # 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'. Thus, no need to set it again.
    gdf.perimeter