opendatacube / datacube-core

Open Data Cube analyses continental scale Earth Observation data through time
http://www.opendatacube.org
Apache License 2.0
505 stars 176 forks source link

Standardise geobox parameter names across reprojection functions #1032

Closed robbibt closed 1 year ago

robbibt commented 3 years ago

Expected/actual behaviour

The following two functions can be used for reprojecting xarray objects and raster files respectively:

from odc.algo import xr_reproject
from datacube.testutils.io import rio_slurp_xarray

Currently, the two functions require different parameter names to specify a geobox, e.g. xr_reproject requires a parameter called geobox, while rio_slurp_xarray requires gbox. For example:

xr_reproject(src=ds, geobox=raster.geobox)
rio_slurp_xarray(fname=..., gbox=ds.geobox)

To improve the user experience, it would be nice to have parameter names standardised across these functions and others that require a geobox as an input, e.g. use geobox consistently across all ODC functions.

Environment information

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

robbibt commented 3 years ago

Still relevant

Ariana-B commented 1 year ago

Note that with odc-geo migration, this will also require a PR to odc-geo

Ariana-B commented 1 year ago

Taken care of in #1441