datatree.DataTree.shift

Contents

Attention

This repository has been archived. Please use xarray.DataTree instead.

datatree.DataTree.shift#

DataTree.shift(shifts: ~collections.abc.Mapping[~typing.Any, int] | None = None, fill_value: ~typing.Any = <NA>, **shifts_kwargs: int) → Self[source]#

Shift this dataset by an offset along one or more dimensions.

Only data variables are moved; coordinates stay in place. This is consistent with the behavior of shift in pandas.

Values shifted from beyond array bounds will appear at one end of each dimension, which are filled according to fill_value. For periodic offsets instead see roll.

Parameters:

  • shifts (mapping of hashable to int) – Integer offset to shift along each of the given dimensions. Positive offsets shift to the right; negative offsets shift to the left.

  • fill_value (scalar or dict-like, optional) – Value to use for newly missing values. If a dict-like, maps variable names (including coordinates) to fill values.

  • **shifts_kwargs – The keyword arguments form of shifts. One of shifts or shifts_kwargs must be provided.

Returns:

shifted (Dataset) – Dataset with the same coordinates and attributes but shifted data variables.

See also

roll

Examples

>>> ds = xr.Dataset({"foo": ("x", list("abcde"))})
>>> ds.shift(x=2)
<xarray.Dataset> Size: 40B
Dimensions:  (x: 5)
Dimensions without coordinates: x
Data variables:
    foo      (x) object 40B nan nan 'a' 'b' 'c'
Contents