teradataml.geospatial.geodataframecolumn.GeoDataFrameColumn.envelope = envelope(self)

DESCRIPTION:
    Returns the bounding rectangle for the Geometry value.
 
PARAMETERS:
    None
 
SUPPORTED GEOMETRY TYPES:
    All Geometry types.
    Note:
        This method can be called on 3D geometries (those that include Z
        coordinates). However, the Z coordinate is dropped, and only x and y
        coordinates are returned.
 
RAISES:
    TypeError, ValueError, TeradataMlException
 
RETURNS:
    GeoDataFrameColumn containing Geometry values
 
EXAMPLES:
    from teradataml import GeoDataFrame, load_example_data
    from teradataml import Point, LineString, Polygon, GeometryCollection
    # Load example data.
    load_example_data("geodataframe", "sample_shapes")
    # Create a GeoDataFrame.
    geodf = GeoDataFrame("sample_shapes")
    print(geodf)
 
    # Example 1: Get the bounding rectangle for (ST_Point/ST_MultiPoint) geometries in column
    #            'points'.
    points_lines = geodf.select(["skey", "points", "linestrings"])
    ep_expr = points_lines.geometry.envelope()
    points_lines.assign(res = ep_expr)
 
    # Example 2: Get the bounding rectangle for (ST_Linestring/ST_MultiLinestring) geometries in column
    #            'linestrings'.
    ep_expr = points_lines.linestrings.envelope()
    points_lines.assign(res = ep_expr)
 
    # Example 3: Filter the rows where the bounding rectangle for (ST_Point/ST_MultiPoint)
    #            geometries in column 'points' is same as the specified Polygon GeometryType
    #            object.
    # Create an object of Polygon GeometryType.
    po1 = Polygon([(1, 1), (20, 1), (20, 5), (1, 5), (1, 1)])
    points_lines[points_lines.points.envelope() == po1]