dea_tools.waterbodies

Loading and processing DEA Waterbodies data.

License: The code in this notebook is licensed under the Apache License, Version 2.0 (https://www.apache.org/licenses/LICENSE-2.0). Digital Earth Australia data is licensed under the Creative Commons by Attribution 4.0 license (https://creativecommons.org/licenses/by/4.0/).

Contact: If you need assistance, please post a question on the Open Data Cube Discord chat (https://discord.com/invite/4hhBQVas5U) or on the GIS Stack Exchange (https://gis.stackexchange.com/questions/ask?tags=open-data-cube) using the open-data-cube tag (you can view previously asked questions here: https://gis.stackexchange.com/questions/tagged/open-data-cube).

If you would like to report an issue with this script, file one on GitHub: GeoscienceAustralia/dea-notebooks#new

Last modified: March 2024

Functions

get_geohashes([bbox, crs, version])

Gets all waterbody geohashes.

get_time_series([geohash, waterbody, version])

Gets the time series for a waterbody.

get_waterbodies(bbox[, crs, version])

Gets the polygons and metadata for multiple waterbodies by bbox.

get_waterbody(geohash[, version])

Gets a waterbody polygon and metadata by geohash.
dea_tools.waterbodies.get_geohashes(bbox: tuple = None, crs: str = 'EPSG:4326', version: str = 'v3') → [<class 'str'>][source]

Gets all waterbody geohashes.

Parameters:

  • bbox ((xmin, ymin, xmax, ymax)) – Optional bounding box.

  • crs (str) – Optional CRS for the bounding box.

Returns:

A list of geohashes.

Return type:

[str]

dea_tools.waterbodies.get_time_series(geohash: str = None, waterbody: pandas.Series = None, version: str = 'v3') → pandas.DataFrame[source]

Gets the time series for a waterbody. Specify either a GeoDataFrame row or a geohash.

Parameters:

  • geohash (str) – The geohash/UID for a waterbody in DEA Waterbodies.

  • waterbody (pd.Series) – One row of a GeoDataFrame representing a waterbody.

Returns:

A time series for the waterbody.

Return type:

pd.DataFrame

dea_tools.waterbodies.get_waterbodies(bbox: tuple, crs='EPSG:4326', version: str = 'v3') → geopandas.GeoDataFrame[source]

Gets the polygons and metadata for multiple waterbodies by bbox.

Parameters:

  • bbox ((xmin, ymin, xmax, ymax)) – Bounding box.

  • crs (str) – Optional CRS for the bounding box.

Returns:

A GeoDataFrame with the polygons and metadata.

Return type:

gpd.GeoDataFrame

dea_tools.waterbodies.get_waterbody(geohash: str, version: str = 'v3') → geopandas.GeoDataFrame[source]

Gets a waterbody polygon and metadata by geohash.

Parameters:

geohash (str) – The geohash/UID for a waterbody in DEA Waterbodies.

Returns:

A GeoDataFrame with the polygon.

Return type:

gpd.GeoDataFrame