get_footprint

Contents

get_footprint#

get_footprint(ds: str | CloudPath | Path | tuple[ndarray | MaskedArray, dict] | DataArray | Dataset | DatasetReader | DatasetWriter) → GeoDataFrame[source]#

Get real footprint of the product (without nodata, in french == emprise utile)

Parameters:

ds (AnyRasterType) – Path to the raster, its dataset, its xarray or a tuple containing its array and metadata

Returns:

Footprint as a GeoDataFrame

Return type:

gpd.GeoDataFrame

Example

>>> raster_path = "path/to/raster.tif"
>>>
>>> footprint1 = get_footprint(raster_path)
>>>
>>> # or
>>> with rasterio.open(raster_path) as ds:
>>>     footprint2 = get_footprint(ds)
>>>
>>> # Assert those two approaches give the same result
>>> footprint1 == footprint2
Contents