dpm-srm 0.1.8__cp312-cp312-win_amd64.whl

dpm_srm-0.1.8.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.4
+Name: dpm_srm
+Version: 0.1.8
+Summary: Statistical Region Merging Segmentation
+Author: Digital Porous Media
+Author-email: Digital Porous Media <bcchang@utexas.edu>
+License: BSD License
+Project-URL: Homepage, https://github.com/digital-porous-media/
+Project-URL: Repository, https://github.com/digital-porous-media/dpm_srm
+Project-URL: Issues, https://github.com/digital-porous-media/dpm_srm/issues
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Dynamic: author
+Dynamic: license-file
+
+# Statistical Region Merging
+
+Statistical Region Merging (SRM) is a method for image segmentation. The labeled image is initialized such that each pixel (or voxel) corresponds to one region. A statistical test on neighboring regions determines whether the mean intensities are similar enough to be merged.
+
+This library is an adaptation of the [SRM plugin to Fiji/ImageJ](https://imagej.net/plugins/statistical-region-merging) and is based on the algorithm proposed in [Nock and Nielsen (2004)](10.1109/tpami.2004.110). Our contribution was to translate the original algorithm to C++ and wrap it in Python. We provide this package under the Digital Porous Media (DPM) organization.
+
+
+## Installation:
+dpm_srm is packaged on [pypi](https://pypi.org/project/dpm-srm/) and can be installed with pip.
+```pip install dpm-srm```.
+
+If installing from source, this package requires a C++ compiler.
+
+## Usage Example:
+---
+This implementation of SRM expects a 2D or 3D grayscale (single color channel) image of type uint8, uint16, or uint32 and a value for *Q*, which is used as a merging criterion. Roughly speaking, *Q* is an estimate of the number of expected regions, though this is not strictly adhered to. The larger the *Q* value, the more regions are produced. The algorithm will return a labeled image of the same shape and datatype as the input image. 
+
+Note that the algorithm performs bucket sorting, where the number of buckets correspond to the maximum allowable value for the particular datatype. Therefore, it's important that intensity values of the input image are scaled over the entire range of the datatype. For example, if the input image is uint8, the image should be scaled such that the minimum intensity value is 0, and the maximum is 255. If the input image is uint16 or uint32, the minimum values should be 0 and the maximum should be 65535 (or 4294967295) respectively.
+
+We wrapped each version (2D vs. 3D, dtype) of the template class into individual class instances. The nomenclature is: SRM[2(or 3)]D_u[number_of_bits]() (e.g. ```SRG2D_u8()```, ```SRG3D_u32()```).
+
+**Python Example:**
+```
+import dpm_srm
+import numpy as np
+
+np.random.seed(130621)
+image = np.random.randint(0, 256, size=(100, 200, 200), dtype=np.uint8)
+
+srm_obj = dpm_srm.SRM3D_u8(image, Q=5.0)
+srm_obj.segment()
+segmentation = srm_obj.get_result()
+```
+
+
+## Acknowledgements
+This project includes code adapted from Statistical Region Merging by Johannes Schindelin, which is licensed under the BSD 2-Clause License.
+
+The original code can be found [here](https://github.com/fiji/Statistical_Region_Merging/tree/master)

dpm_srm-0.1.8.dist-info/RECORD

@@ -0,0 +1,6 @@
+dpm_srm.cp312-win_amd64.pyd,sha256=gsSiQSUEBLld-hN_0dnoGe3VY_hyoRWSD96slzz7gDg,227328
+dpm_srm-0.1.8.dist-info/licenses/LICENSE,sha256=TM5GONWvPhpRwVxI_NcUUc7uI-0X3len7GhDC4zVkR4,3130
+dpm_srm-0.1.8.dist-info/METADATA,sha256=OCy9N8ze8lD_NRfgr_YhKyWdUDvVDKnfr_vtkJ7WxsE,3739
+dpm_srm-0.1.8.dist-info/WHEEL,sha256=-0WtXfa1FcFqYulduII3R48HVP8SNWtKBAbj4Y-usSY,102
+dpm_srm-0.1.8.dist-info/top_level.txt,sha256=7x0Y5PfjV6e74A2kkg8ayzUTPlgqLbLdjZkWsP6TiL8,8
+dpm_srm-0.1.8.dist-info/RECORD,,

dpm_srm-0.1.8.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: false
+Tag: cp312-cp312-win_amd64
+

dpm_srm-0.1.8.dist-info/licenses/LICENSE

@@ -0,0 +1,57 @@
+BSD 2-Clause License
+
+# Attribution
+This project includes code adapted from Statistical Region Merging by Johannes Schindelin, licensed under the BSD 2-Clause License.
+
+# Original License
+Copyright (C) 2009 - 2013, Johannes Schindelin
+
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * 
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ * 
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ * 
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of any organization.
+
+
+# Our Contributions
+Copyright (c) 2024, Digital Porous Media
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

dpm_srm-0.1.8.dist-info/top_level.txt

@@ -0,0 +1 @@
+dpm_srm