semantique.processor.arrays.Array.shift

Contents

semantique.processor.arrays.Array.shift#

Array.shift(dimension, steps, **kwargs)[source]#

Apply the shift verb to the array.

The shift verb shifts the values in an array a given amount of steps along a dimension.

Parameters:
  • dimension (str) – Name of the dimension to shift along.

  • steps (int) – Amount of steps each value should be shifted. A negative integer will result in a shift to the left, while a positive integer will result in a shift to the right. A shift along the spatial dimension follows the pixel order defined by the CRS, e.g. starting in the top-left and moving down each column.

  • **kwargs – Ignored.

Returns:

xarray.DataArray

Raises:

exceptions.UnknownDimensionError – If a dimension with the given name is not present in the array.