smoother-py 0.1.0__tar.gz

smoother_py-0.1.0/CMakeLists.txt

@@ -0,0 +1,44 @@
+cmake_minimum_required(VERSION 3.15...3.27)
+
+project(_smoother LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+if(NOT CMAKE_BUILD_TYPE)
+  set(CMAKE_BUILD_TYPE Release)
+endif()
+
+# Python
+# SKBUILD_SABI_COMPONENT is set by scikit-build-core when wheel.py-api
+# requests a stable ABI build (Development.SABIModule)
+find_package(Python 3.11 COMPONENTS Interpreter Development.Module ${SKBUILD_SABI_COMPONENT} REQUIRED)
+
+# nanobind
+# nanobind is installed as a Python package, so we find it through its CMake dir
+execute_process(
+    COMMAND ${Python_EXECUTABLE} -m nanobind --cmake_dir
+    OUTPUT_VARIABLE nanobind_ROOT
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    RESULT_VARIABLE nanobind_FIND_RESULT
+    ERROR_QUIET
+)
+
+if(NOT nanobind_FIND_RESULT EQUAL 0)
+    message(FATAL_ERROR
+        "nanobind not found!\n"
+        "Please install nanobind:\n"
+        "  pip install nanobind\n"
+        "\n"
+        "If nanobind is installed, make sure you're using the same Python\n"
+        "interpreter that has nanobind installed."
+    )
+endif()
+
+find_package(nanobind CONFIG REQUIRED)
+
+# STABLE_ABI: builds abi3 wheels on Python >= 3.12, regular builds otherwise
+nanobind_add_module(_smoother STABLE_ABI src/smooth.cpp)
+
+install(TARGETS _smoother LIBRARY DESTINATION smoother)

smoother_py-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+efelipecarlos'at'gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

smoother_py-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Felipe Carlos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

smoother_py-0.1.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.2
+Name: smoother-py
+Version: 0.1.0
+Summary: Spatial smoothing methods for probability maps.
+Keywords: land use and land cover,lulc,satellite,time-series,metrics,remote-sensing
+Author-Email: Felipe Carlos <efelipecarlos@gmail.com>
+License: MIT License
+         
+         Copyright (c) 2024 Felipe Carlos
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+         
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Project-URL: homepage, https://github.com/m3nin0-labs/smoother.py
+Project-URL: repository, https://github.com/m3nin0-labs/smoother.py
+Requires-Python: >=3.11
+Requires-Dist: numpy>=1.26.4
+Provides-Extra: xarray
+Requires-Dist: xarray>=2024.1; extra == "xarray"
+Provides-Extra: examples
+Requires-Dist: rasterio>=1.3; extra == "examples"
+Requires-Dist: rioxarray>=0.15; extra == "examples"
+Requires-Dist: matplotlib>=3.8; extra == "examples"
+Description-Content-Type: text/markdown
+
+## smoother.py 🧹
+
+Spatial smoothing methods for probability maps.
+
+### Installation
+
+To install the package, you can use pip:
+
+```bash
+pip install git+https://github.com/m3nin0-labs/smoother.py
+```
+
+### Methods available
+
+Currently, the `smoother` implements the [Bayes smoothing method](https://e-sensing.github.io/sitsbook/cl_smoothing.html), adapting the code from the [sits](https://github.com/e-sensing/sits) R package.
+
+### Usage
+
+First, import the package:
+
+```python
+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:
+
+```python
+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](https://rasterio.readthedocs.io/en/latest/index.html) or other library to load the numpy array.
+
+#### xarray
+
+`smooth` also accepts `xarray` objects. To use it, first install the `xarray` dependencies:
+
+```bash
+pip install "smoother-py[xarray]"
+```
+
+Then, using your `xarray` data, you can call the `smooth` function:
+
+```python
+# 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:
+
+```python
+help(smoother.smooth)
+```
+
+### Development
+
+The project uses [uv](https://docs.astral.sh/uv/) to manage the development environment:
+
+```bash
+# 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](https://e-sensing.github.io/sitsbook/bayesian-smoothing-for-post-processing.html). 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](https://e-sensing.github.io/sitsbook/) 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
+
+`smoother.py` is distributed under the MIT license. See [LICENSE](./LICENSE) for more details.

smoother_py-0.1.0/README.md

@@ -0,0 +1,91 @@
+## smoother.py 🧹
+
+Spatial smoothing methods for probability maps.
+
+### Installation
+
+To install the package, you can use pip:
+
+```bash
+pip install git+https://github.com/m3nin0-labs/smoother.py
+```
+
+### Methods available
+
+Currently, the `smoother` implements the [Bayes smoothing method](https://e-sensing.github.io/sitsbook/cl_smoothing.html), adapting the code from the [sits](https://github.com/e-sensing/sits) R package.
+
+### Usage
+
+First, import the package:
+
+```python
+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:
+
+```python
+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](https://rasterio.readthedocs.io/en/latest/index.html) or other library to load the numpy array.
+
+#### xarray
+
+`smooth` also accepts `xarray` objects. To use it, first install the `xarray` dependencies:
+
+```bash
+pip install "smoother-py[xarray]"
+```
+
+Then, using your `xarray` data, you can call the `smooth` function:
+
+```python
+# 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:
+
+```python
+help(smoother.smooth)
+```
+
+### Development
+
+The project uses [uv](https://docs.astral.sh/uv/) to manage the development environment:
+
+```bash
+# 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](https://e-sensing.github.io/sitsbook/bayesian-smoothing-for-post-processing.html). 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](https://e-sensing.github.io/sitsbook/) 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
+
+`smoother.py` is distributed under the MIT license. See [LICENSE](./LICENSE) for more details.

smoother_py-0.1.0/example/README.md

@@ -0,0 +1,31 @@
+# Examples
+
+Usage example of `smoother.py` on a real classification output.
+
+## Data
+
+[`data/`](./data) holds a [`sits`](https://github.com/e-sensing/sits) classification probs GeoTIFF with one band per land-use class, in this order:
+
+| Band | Class    | Color     |
+|------|----------|-----------|
+| 1    | Cerrado  | `#a2d43f` |
+| 2    | Forest   | `#1E8449` |
+| 3    | Pasture  | `#FAD12D` |
+| 4    | Soy_Corn | `#D68910` |
+
+The colors come from the QGIS style `data/style.qml` and are reused in the notebook for plotting.
+
+## Running
+
+Install the example dependencies:
+
+```bash
+pip install "smoother-py[examples]"
+# or, in this repo:  uv sync --extra examples
+```
+
+Then open the notebook:
+
+```bash
+jupyter lab bayes.ipynb
+```