pydata / pydata/xarray

Adding non-dimension string coordinate gives different interpolation results

Open
#8,456 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug topic-interpolation
Dominant language
Python
Stars
4.2k
Forks
1.4k
Avg merge
2d 15h
Merged PRs (30d)
14

Description

What happened?

When I interpolate on data by taking a mean along the y dimension the presence of a non-dimension string coordinate makes a difference to the result. I would expect this non-dimension coordinate to be passive.

What did you expect to happen?

I would expect the results to be independent of the non-dimension coordinate string_coord being present or not. But when string_coord is present I get:

<xarray.DataArray (x: 2, y: 2)>
array([[0. , 0.1],
       [0. , 0.1]])
Coordinates:
  * x             (x) int64 0 1
  * y             (x) float64 0.05 0.05
    string_coord  (x) <U21 '0' '1'

whereas after I uncomment the line where I add the non-dimension string coordinate I get the expected result:

<xarray.DataArray (x: 2)>
array([0.005, 0.005])
Coordinates:
    y        (x) float64 0.05 0.05
  * x        (x) int64 0 1
Minimal Complete Verifiable Example
import xarray as xr
import numpy as np
data = np.array([[0.0 , 0.1 ],
    [0.0, 0.1]])
data = xr.DataArray(
    data,
    coords=dict(
        x=[0,1],
        y=[0,1]
        )
)
data["string_coord"] = data.x.astype("str")
data_mean = data.mean(dim="y")
interp_data = data.interp(y=data_mean, method="linear")
print(interp_data)
MVCE confirmation
  • Minimal example — the example is as focused as reasonably possible to demonstrate the underlying issue in xarray.
  • Complete example — the example is self-contained, including all data and the text of any traceback.
  • Verifiable example — the example copy & pastes into an IPython prompt or Binder notebook, returning the result.
  • New issue — a search of GitHub Issues suggests this is not a duplicate.
  • Recent environment — the issue occurs with the latest version of xarray and its dependencies.
Relevant log output

No response

Anything else we need to know?

No response

Environment

INSTALLED VERSIONS

commit: None
python: 3.11.0 | packaged by conda-forge | (main, Jan 14 2023, 12:27:40) [GCC 11.3.0]
python-bits: 64
OS: Linux
OS-release: 5.15.133.1-microsoft-standard-WSL2
machine: x86_64
processor: x86_64
byteorder: little
LC_ALL: None
LANG: C.UTF-8
LOCALE: ('en_US', 'UTF-8')
libhdf5: 1.12.2
libnetcdf: 4.8.1

xarray: 2023.10.1
pandas: 2.1.2
numpy: 1.24.4
scipy: 1.11.3
netCDF4: 1.6.2
pydap: None
h5netcdf: 1.2.0
h5py: 3.8.0
Nio: None
zarr: None
cftime: 1.6.3
nc_time_axis: None
PseudoNetCDF: None
iris: None
bottleneck: 1.3.7
dask: 2023.11.0
distributed: 2023.11.0
matplotlib: 3.8.1
cartopy: 0.22.0
seaborn: 0.13.0
numbagg: None
fsspec: 2023.10.0
cupy: None
pint: 0.22
sparse: None
flox: None
numpy_groupies: None
setuptools: 68.2.2
pip: 23.3.1
conda: 22.9.0
pytest: 7.4.3
mypy: None
IPython: 8.17.2
sphinx: 3.5.3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the minimal Python example against the current xarray checkout and compare interpolation with and without string_coord. Trace the interpolation path used by DataArray.interp after mean(dim="y"). Done means the non-dimension string coordinate no longer changes the interpolation result, with a regression test covering the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
numpy, python
Domain
data
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.