bmnd 0.3.0__tar.gz

bmnd-0.3.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Christof Duhme
+
+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.

bmnd-0.3.0/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: bmnd
+Version: 0.3.0
+Summary: Direct Poisson Denoising by N-Dimensional Block-Matching and Collaborative Filtering
+Author-email: Christof Duhme <c_duhm02@uni-muenster.de>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Image Processing
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numba
+Requires-Dist: numpy
+Requires-Dist: PyWavelets
+Requires-Dist: scipy
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: scikit-image; extra == "test"
+Requires-Dist: bm3d; extra == "test"
+Requires-Dist: bm4d; extra == "test"
+Dynamic: license-file
+
+# Direct Poisson Denoising by N-Dimensional Block-Matching and Collaborative Filtering
+
+BMND is an algorithm for denoising of Poisson corrupted n-dimensional data.
+
+This implementation is based on the paper
+```
+Christof Duhme, Lars Schiefelbein, Florian Büther and Xiaoyi Jiang,
+''BMND: Direct Poisson Denoising by N-Dimensional Block-Matching and Collaborative Filtering'',
+In: arXiv preprint arxiv:DOI, 2026.
+```
+
+The basic algorithms we build upon are BM3D/BM4D, introduced and developed in these publications:
+```
+Kostadin Dabov, Alessandro Foi, Vladimir Katkovnik and Karen Egiazarian,
+''Image Denoising by Sparse 3-D Transform-Domain Collaborative Filtering'',
+In: IEEE Transactions on Image Processing, vol. 16, no. 8, pp. 2080-2095, 2007.
+DOI: 10.1109/TIP.2007.901238.
+
+Matteo Maggioni, Vladimir Katkovnik, Karen Egiazarian and Alessandro Foi,
+''A Nonlocal Transform-Domain Filter for Volumetric Data Denoising and Reconstruction'',
+In: IEEE Transactions on Image Processing, vol. 22, no. 1, pp. 119-133, 2013.
+DOI: 10.1109/TIP.2012.2210725.
+
+Ymir Mäkinen, Lucio Azzari and Alessandro Foi,
+''Collaborative Filtering of Correlated Noise: Exact Transform-Domain Variance for Improved Shrinkage and Patch Matching'',
+In: IEEE Transactions on Image Processing, vol. 29, pp. 8339-8354, 2020.
+DOI: 10.1109/TIP.2020.3014721.
+```
+
+## Usage
+
+```python
+import numpy as np
+from bmnd import BM3DProfile, NoiseModel, bmnd
+
+# Generate a synthetic 2D image with Poisson noise.
+image = np.full((64, 64), 5.0, dtype=np.float32)
+image[16:48, 16:48] = 20.0
+noisy = np.random.default_rng(0).poisson(image).astype(np.float32)
+
+profile = BM3DProfile(noise_model=NoiseModel.POISSON)
+denoised = bmnd(noisy, profile)
+```
+
+For your own data, replace `noisy` with a non-negative NumPy array in count
+units, without normalizing it to `[0, 1]`. No noise standard deviation is needed
+for Poisson denoising. The output has the same shape as the input.
+
+We provide `BM3DProfile` for 2D images and `BM4DProfile` for 3D volumes to match
+the original algorithms defaults.

bmnd-0.3.0/README.md

@@ -0,0 +1,50 @@
+# Direct Poisson Denoising by N-Dimensional Block-Matching and Collaborative Filtering
+
+BMND is an algorithm for denoising of Poisson corrupted n-dimensional data.
+
+This implementation is based on the paper
+```
+Christof Duhme, Lars Schiefelbein, Florian Büther and Xiaoyi Jiang,
+''BMND: Direct Poisson Denoising by N-Dimensional Block-Matching and Collaborative Filtering'',
+In: arXiv preprint arxiv:DOI, 2026.
+```
+
+The basic algorithms we build upon are BM3D/BM4D, introduced and developed in these publications:
+```
+Kostadin Dabov, Alessandro Foi, Vladimir Katkovnik and Karen Egiazarian,
+''Image Denoising by Sparse 3-D Transform-Domain Collaborative Filtering'',
+In: IEEE Transactions on Image Processing, vol. 16, no. 8, pp. 2080-2095, 2007.
+DOI: 10.1109/TIP.2007.901238.
+
+Matteo Maggioni, Vladimir Katkovnik, Karen Egiazarian and Alessandro Foi,
+''A Nonlocal Transform-Domain Filter for Volumetric Data Denoising and Reconstruction'',
+In: IEEE Transactions on Image Processing, vol. 22, no. 1, pp. 119-133, 2013.
+DOI: 10.1109/TIP.2012.2210725.
+
+Ymir Mäkinen, Lucio Azzari and Alessandro Foi,
+''Collaborative Filtering of Correlated Noise: Exact Transform-Domain Variance for Improved Shrinkage and Patch Matching'',
+In: IEEE Transactions on Image Processing, vol. 29, pp. 8339-8354, 2020.
+DOI: 10.1109/TIP.2020.3014721.
+```
+
+## Usage
+
+```python
+import numpy as np
+from bmnd import BM3DProfile, NoiseModel, bmnd
+
+# Generate a synthetic 2D image with Poisson noise.
+image = np.full((64, 64), 5.0, dtype=np.float32)
+image[16:48, 16:48] = 20.0
+noisy = np.random.default_rng(0).poisson(image).astype(np.float32)
+
+profile = BM3DProfile(noise_model=NoiseModel.POISSON)
+denoised = bmnd(noisy, profile)
+```
+
+For your own data, replace `noisy` with a non-negative NumPy array in count
+units, without normalizing it to `[0, 1]`. No noise standard deviation is needed
+for Poisson denoising. The output has the same shape as the input.
+
+We provide `BM3DProfile` for 2D images and `BM4DProfile` for 3D volumes to match
+the original algorithms defaults.

bmnd-0.3.0/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "bmnd"
+version = "0.3.0"
+description = "Direct Poisson Denoising by N-Dimensional Block-Matching and Collaborative Filtering"
+authors = [
+  { name="Christof Duhme", email="c_duhm02@uni-muenster.de" },
+]
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "numba",
+    "numpy",
+    "PyWavelets",
+    "scipy",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Image Processing",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "scikit-image",
+    "bm3d",
+    "bm4d",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.black]
+extend-exclude = '''
+(^|/)shifts\.py$
+'''

bmnd-0.3.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bmnd-0.3.0/src/bmnd/__init__.py

@@ -0,0 +1,35 @@
+from .bmndalgo import bmnd
+from .enums import (
+    AggregationWeightDomain,
+    AggregationWeightModel,
+    AggregationWeightScope,
+    BlockMatchDistance,
+    CacheMode,
+    NoiseModel,
+    PoissonGroupMassConservation,
+    PoissonHTMatchPolicy,
+    PoissonVarianceSource,
+    PoissonWienerGainMode,
+    ReferenceScheduleMode,
+)
+from .profiles import BM2DProfile, BM3DProfile, BM4DProfile, BM5DProfile, BMNDProfile
+
+__all__ = [
+    "AggregationWeightDomain",
+    "AggregationWeightModel",
+    "AggregationWeightScope",
+    "BM2DProfile",
+    "BM3DProfile",
+    "BM4DProfile",
+    "BM5DProfile",
+    "BMNDProfile",
+    "BlockMatchDistance",
+    "CacheMode",
+    "NoiseModel",
+    "PoissonGroupMassConservation",
+    "PoissonHTMatchPolicy",
+    "PoissonVarianceSource",
+    "PoissonWienerGainMode",
+    "ReferenceScheduleMode",
+    "bmnd",
+]