smoother-py 0.1.1

smoother.py 🧹

Spatial smoothing methods for probability maps.

Installation

To install the package, you can use pip:

pip install smoother-py

Methods available

Currently, the smoother implements the Bayes smoothing method, adapting the code from the sits R package.

Usage

First, import the package:

import smoother

Then, use the smooth function on the numpy data of your map. The smoothing method is selected with method (defaults to "bayes"), and any method-specific options are passed as keyword arguments:

smoothed = smoother.smooth(your_numpy_array)

# selecting the method explicitly and tuning it
smoothed = smoother.smooth(your_numpy_array, method="bayes", window_size=5)

You can use rasterio or other library to load the numpy array.

xarray

smooth also accepts xarray objects. To use it, first install the xarray dependencies:

pip install "smoother-py[xarray]"

Then, using your xarray data, you can call the smooth function:

# DataArray with class, y and x dimensions
smoothed = smoother.smooth(your_data_array)

# dimension names are inferred (e.g. band/class, y/latitude, x/longitude)
# you can also name them explicitly
smoothed = smoother.smooth(your_data_array, class_dim="band")

Extra dimensions (e.g. time) are smoothed per layer automatically.

Discovering the options

smoother.smooth documents every option, the smoothing parameters and the xarray-only dimension names:

help(smoother.smooth)

Development

The project uses uv to manage the development environment:

# create the environment and build/install the package
uv sync

# run the tests
uv run pytest

Learn more

The smoothing methods implemented in this package uses the approach described in the sits documentation. This method helps in refining the probability maps by considering the spatial context of each pixel.

Acknowledgments

We would like to thank the developers and contributors of the sits R package for their work on spatial smoothing methods for Earth observation data. Their comprehensive documentation and methodologies have been invaluable in the development of smoother.py.

Contributing

We welcome contributions! If you have suggestions for improvements or bug fixes, please feel free to fork the repository and submit a pull request.

License

Code is licensed under the GNU General Public License v2.0. See the LICENSE file. The bayes smooth code is ported from the sits R package.