stackstac.mosaic

stackstac.mosaic(arr, dim=None, axis=0, reverse=False, nodata=nan)

Flatten a dimension of a DataArray by picking the first valid pixel.

The order of mosaicing is from last to first, meaning the last item is on top.

Parameters

  • arr (DataArray) – The DataArray to mosaic.

  • dim (Union[None, Hashable, Sequence[Hashable]]) – The dimension name to mosaic. Default: None.

  • axis (Union[None, int, Sequence[int]]) – The axis number to mosaic. Default: 0. Only one of dim and axis can be given.

  • reverse (bool) – If False (default), the last item along the dimension is on top. If True, the first item in the dimension is on top.

  • nodata (Union[int, float]) –

    The value to treat as invalid. Default: NaN.

    To catch common mis-use, raises a ValueError if nodata=nan is used when the array has an integer or boolean dtype. Since NaN cannot exist in those arrays, this indicates a different nodata value needs to be used.

Returns

The mosaicked DataArray.

Return type

xarray.DataArray