Interpolate_na: Rework 'limit' argument documentation/implementation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
What is your issue?
Currently, the 'limit' argument of interpolate_na shows some counterintuitive/undocumented behaviour.
Take the following example:
import xarray as xr
import numpy as np
n=np.nan
da=xr.DataArray([n, n, n, 4, 5, n ,n ,n], dims=["y"])
da.interpolate_na('y', limit=1, fill_value='extrapolate')
This will produce the following result:
array([ 1., nan, nan, 4., 5., 6., nan, nan])
Two things are surprising, in my opinion:
- The interpolated value
1at the beginning is far from any of the given values - The filling is done only towards the 'right'. This asymmetric behaviour is not mentioned in the documentation.
Comparison to pandas
Similar behaviour can be created using pandas with the following arguments:
da=xr.DataArray([n, n, n, 4, 5, n ,n ,n], dims=["y"])
dap=da.to_pandas()
dap.interpolate(method='slinear', limit=1, limit_direction='forward', fill_value='extrapolate')
Output
y
0 NaN
1 NaN
2 NaN
3 4.0
4 5.0
5 6.0
6 NaN
7 NaN
dtype: float64
This is equivalent to the current xarray behaviour, except there is no 1 at the beginning.
Cause
Currently, the fill mask in xarray is implemented using a rolling window operation, where values outside the array are assumed to be valid (therefore the 1). See xarray.core.missing._get_valid_fill_mask
Possible Solutions
Boundary Issue
Concerning the 1 at the beginning: I think this should be considered a bug. It is likely not what you would expect if you specify a limit. As stated, pandas does not create it as well.
Asymmetric Filling
Concerning the asymmetric filling, I see two options:
- No changes to the code, but mention in the documentation that (effectively), a forward-fill is done.
- Make something similar to what pandas is doing. In pandas, there are two additional arguments controlling the limit behaviour:
limit_directionis controlling the fill direction (left, right or both).limit_areaeffectively controls if we only do interpolation or allow for extrapolation as well.
What do you think?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with xarray.core.missing._get_valid_fill_mask and reproduce the interpolate_na example from the issue. Compare the boundary and directional behavior with pandas, then resolve whether to change the implementation or document forward-only filling. Done means the agreed limit semantics are implemented and documented consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, pandas, python
- Domain
- data
- Issue type
- Bug
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100