ct-segmentation-toolkit 0.2.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. ct_segmentation_toolkit-0.2.0/LICENSE +201 -0
  2. ct_segmentation_toolkit-0.2.0/NOTICE +18 -0
  3. ct_segmentation_toolkit-0.2.0/PKG-INFO +156 -0
  4. ct_segmentation_toolkit-0.2.0/README.md +107 -0
  5. ct_segmentation_toolkit-0.2.0/ct_seg/__init__.py +78 -0
  6. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/__init__.py +24 -0
  7. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/data.py +348 -0
  8. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/denoise_slice.py +190 -0
  9. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/denoise_volume.py +164 -0
  10. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/eval.py +94 -0
  11. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/loss.py +78 -0
  12. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/model.py +205 -0
  13. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/tiffs.py +105 -0
  14. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/train.py +385 -0
  15. ct_segmentation_toolkit-0.2.0/ct_seg/denoise/utils.py +68 -0
  16. ct_segmentation_toolkit-0.2.0/ct_seg/labeling.py +145 -0
  17. ct_segmentation_toolkit-0.2.0/ct_seg/model.py +117 -0
  18. ct_segmentation_toolkit-0.2.0/ct_seg/segment.py +461 -0
  19. ct_segmentation_toolkit-0.2.0/ct_seg/som_bands.py +199 -0
  20. ct_segmentation_toolkit-0.2.0/ct_seg/tracking.py +84 -0
  21. ct_segmentation_toolkit-0.2.0/ct_seg/train.py +441 -0
  22. ct_segmentation_toolkit-0.2.0/ct_seg/viewer.py +240 -0
  23. ct_segmentation_toolkit-0.2.0/ct_segmentation_toolkit.egg-info/PKG-INFO +156 -0
  24. ct_segmentation_toolkit-0.2.0/ct_segmentation_toolkit.egg-info/SOURCES.txt +32 -0
  25. ct_segmentation_toolkit-0.2.0/ct_segmentation_toolkit.egg-info/dependency_links.txt +1 -0
  26. ct_segmentation_toolkit-0.2.0/ct_segmentation_toolkit.egg-info/requires.txt +29 -0
  27. ct_segmentation_toolkit-0.2.0/ct_segmentation_toolkit.egg-info/top_level.txt +1 -0
  28. ct_segmentation_toolkit-0.2.0/pyproject.toml +84 -0
  29. ct_segmentation_toolkit-0.2.0/setup.cfg +4 -0
  30. ct_segmentation_toolkit-0.2.0/tests/test_denoise.py +24 -0
  31. ct_segmentation_toolkit-0.2.0/tests/test_model.py +29 -0
  32. ct_segmentation_toolkit-0.2.0/tests/test_segment.py +45 -0
  33. ct_segmentation_toolkit-0.2.0/tests/test_som_bands.py +38 -0
  34. ct_segmentation_toolkit-0.2.0/tests/test_tracking.py +16 -0
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Cameron B. Renteria
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,18 @@
1
+ ct-segmentation-toolkit
2
+ Copyright 2026 Cameron B. Renteria
3
+
4
+ Licensed under the Apache License, Version 2.0 (the "License");
5
+ you may not use this software except in compliance with the License.
6
+ You may obtain a copy of the License at
7
+
8
+ http://www.apache.org/licenses/LICENSE-2.0
9
+
10
+ Unless required by applicable law or agreed to in writing, software
11
+ distributed under the License is distributed on an "AS IS" BASIS,
12
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ See the License for the specific language governing permissions and
14
+ limitations under the License.
15
+
16
+ This product includes `ct_seg.denoise`, an implementation of the Noise2Inverse framework
17
+ (Hendriksen, Pelt & Batenburg, IEEE Transactions on Computational Imaging, 2020;
18
+ https://github.com/ahendriksen/noise2inverse). See ct_seg/denoise/ACKNOWLEDGMENTS.md.
@@ -0,0 +1,156 @@
1
+ Metadata-Version: 2.4
2
+ Name: ct-segmentation-toolkit
3
+ Version: 0.2.0
4
+ Summary: Supervised (U-Net), unsupervised (Otsu/k-means/GMM), and label-free spectral-spatial (SOM) segmentation of scientific image stacks.
5
+ Author-email: "Cameron B. Renteria" <crentb@uw.edu>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/crentb/ct-segmentation-toolkit
8
+ Project-URL: Issues, https://github.com/crentb/ct-segmentation-toolkit/issues
9
+ Keywords: image segmentation,computed tomography,U-Net,self-organizing map,unsupervised,feature extraction,hyperspectral,scientific imaging
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Science/Research
12
+ Classifier: License :: OSI Approved :: Apache Software License
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Topic :: Scientific/Engineering :: Image Processing
19
+ Requires-Python: >=3.10
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ License-File: NOTICE
23
+ Requires-Dist: numpy>=1.24
24
+ Requires-Dist: scipy>=1.10
25
+ Requires-Dist: scikit-learn>=1.3
26
+ Requires-Dist: scikit-image>=0.21
27
+ Requires-Dist: tifffile>=2023.1
28
+ Requires-Dist: minisom>=2.3
29
+ Requires-Dist: tqdm>=4.65
30
+ Requires-Dist: Pillow>=9.0
31
+ Requires-Dist: matplotlib>=3.7
32
+ Requires-Dist: torch>=2.0
33
+ Provides-Extra: viz
34
+ Requires-Dist: napari[all]>=0.4; extra == "viz"
35
+ Requires-Dist: pyvista>=0.43; extra == "viz"
36
+ Provides-Extra: mlops
37
+ Requires-Dist: mlflow>=2.0; extra == "mlops"
38
+ Provides-Extra: denoise
39
+ Requires-Dist: albumentations>=1.3; extra == "denoise"
40
+ Requires-Dist: PyYAML>=6.0; extra == "denoise"
41
+ Provides-Extra: dev
42
+ Requires-Dist: pytest>=8.0; extra == "dev"
43
+ Requires-Dist: pytest-cov>=4.1; extra == "dev"
44
+ Requires-Dist: ruff==0.14.10; extra == "dev"
45
+ Requires-Dist: black==26.3.1; extra == "dev"
46
+ Requires-Dist: mypy==1.17.1; extra == "dev"
47
+ Requires-Dist: pre-commit>=3.7; extra == "dev"
48
+ Dynamic: license-file
49
+
50
+ # ct-segmentation-toolkit
51
+
52
+ [![CI](https://github.com/crentb/ct-segmentation-toolkit/actions/workflows/ci.yml/badge.svg)](https://github.com/crentb/ct-segmentation-toolkit/actions/workflows/ci.yml)
53
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
54
+ [![Python](https://img.shields.io/badge/python-3.10%E2%80%933.12-blue.svg)](pyproject.toml)
55
+
56
+ Segmentation of scientific image stacks (e.g., synchrotron CT) across the full
57
+ supervision spectrum, in one installable, tested package:
58
+
59
+ - **Supervised** — a U-Net (`ct_seg.model.UNetSegmentation`) with training + inference.
60
+ - **Unsupervised** — multi-Otsu, k-means, and GMM segmentation by intensity, with no
61
+ training data needed.
62
+ - **Label-free spectral-spatial** — a Self-Organizing-Map segmenter that describes each
63
+ pixel by multi-scale density, structure-tensor orientation/coherence, a Gabor filter
64
+ bank, and local variance, then clusters the SOM nodes. The same spectral-spatial
65
+ feature engineering transfers directly to **hyperspectral** cubes.
66
+ - **Self-supervised denoising** — a 2.5D **Noise2Inverse** denoiser (`ct_seg.denoise`): a
67
+ no-skip U-Net trained from one noisy reconstruction (no clean reference), with a Laplacian
68
+ Contrast Loss and edge-aware model selection. The author's own implementation of the N2I
69
+ framework (upstream credit in [ct_seg/denoise/ACKNOWLEDGMENTS.md](ct_seg/denoise/ACKNOWLEDGMENTS.md)).
70
+
71
+ ## Install
72
+
73
+ ```bash
74
+ git clone https://github.com/crentb/ct-segmentation-toolkit.git
75
+ cd ct-segmentation-toolkit
76
+ python -m pip install -e ".[dev]" # core + dev tools (pytest, ruff, black, mypy)
77
+ python -m pip install -e ".[viz]" # optional: napari labeling + pyvista viewer
78
+ python -m pip install -e ".[mlops]" # optional: MLflow experiment tracking
79
+ python -m pip install -e ".[denoise]" # optional: N2I training (albumentations, PyYAML)
80
+ ```
81
+
82
+ ## Python API
83
+
84
+ ```python
85
+ import numpy as np
86
+ from ct_seg import segment_kmeans, som_segment, UNetSegmentation
87
+
88
+ volume = np.random.rand(16, 256, 256).astype("float32") # (slices, H, W) in [0, 1]
89
+
90
+ # Unsupervised intensity segmentation (no labels)
91
+ labels, info = segment_kmeans(volume, num_classes=4)
92
+
93
+ # Label-free spectral-spatial segmentation of a single slice
94
+ band_map = som_segment(volume[0], n_clusters=4)
95
+
96
+ # Supervised U-Net
97
+ model = UNetSegmentation(in_channels=1, num_classes=4)
98
+ ```
99
+
100
+ ## Command line
101
+
102
+ ```bash
103
+ # Unsupervised (otsu | kmeans | gmm)
104
+ python -m ct_seg.segment --input /path/to/tiffs --method kmeans --num_classes 4 --save_overlay
105
+
106
+ # Train a U-Net, then segment with it
107
+ python -m ct_seg.train --images /path/to/tiffs --masks /path/to/masks --num_classes 4
108
+ python -m ct_seg.segment --input /path/to/tiffs --method unet --model SegOutput/best_model.pth --num_classes 4
109
+ ```
110
+
111
+ (Interactive `ct_seg.labeling` (napari) and `ct_seg.viewer` (napari/pyvista) require the
112
+ `[viz]` extra.)
113
+
114
+ ## Experiment tracking & profiling
115
+
116
+ Training integrates optional **MLflow** logging (run parameters, per-epoch loss/mIoU,
117
+ and the best checkpoint). Install the extra and it logs automatically; without MLflow,
118
+ tracking is a harmless no-op and training is unaffected:
119
+
120
+ ```bash
121
+ pip install -e ".[mlops]"
122
+ python -m ct_seg.train --images ... --masks ... --num_classes 4 # logs to ./mlruns
123
+ mlflow ui # browse runs
124
+ ```
125
+
126
+ A reproducible **performance profile** (forward / train-step latency, throughput, and
127
+ peak GPU memory) is in [docs/PERF.md](docs/PERF.md):
128
+
129
+ ```bash
130
+ python scripts/profile_unet.py --device cuda --sizes 256 512
131
+ ```
132
+
133
+ ## Testing
134
+
135
+ ```bash
136
+ pytest -m "not slow" # fast suite (what CI runs)
137
+ pytest # everything
138
+ ```
139
+
140
+ ## Status
141
+
142
+ The supervised, unsupervised, SOM, and **Noise2Inverse denoising** paths are functional and
143
+ tested. The denoiser (`ct_seg.denoise`) is the author's own implementation of the N2I
144
+ framework (upstream credit in `ct_seg/denoise/ACKNOWLEDGMENTS.md`). Related published work on deep-learning
145
+ segmentation and self-supervised denoising of synchrotron CT is available as a preprint:
146
+ https://ssrn.com/abstract=6805001
147
+
148
+ ## Acknowledgments
149
+
150
+ `ct_seg.denoise` implements the Noise2Inverse framework (Hendriksen, Pelt & Batenburg,
151
+ *IEEE Transactions on Computational Imaging*, 2020; https://github.com/ahendriksen/noise2inverse).
152
+ See [ct_seg/denoise/ACKNOWLEDGMENTS.md](ct_seg/denoise/ACKNOWLEDGMENTS.md).
153
+
154
+ ## License
155
+
156
+ Apache-2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE).
@@ -0,0 +1,107 @@
1
+ # ct-segmentation-toolkit
2
+
3
+ [![CI](https://github.com/crentb/ct-segmentation-toolkit/actions/workflows/ci.yml/badge.svg)](https://github.com/crentb/ct-segmentation-toolkit/actions/workflows/ci.yml)
4
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
5
+ [![Python](https://img.shields.io/badge/python-3.10%E2%80%933.12-blue.svg)](pyproject.toml)
6
+
7
+ Segmentation of scientific image stacks (e.g., synchrotron CT) across the full
8
+ supervision spectrum, in one installable, tested package:
9
+
10
+ - **Supervised** — a U-Net (`ct_seg.model.UNetSegmentation`) with training + inference.
11
+ - **Unsupervised** — multi-Otsu, k-means, and GMM segmentation by intensity, with no
12
+ training data needed.
13
+ - **Label-free spectral-spatial** — a Self-Organizing-Map segmenter that describes each
14
+ pixel by multi-scale density, structure-tensor orientation/coherence, a Gabor filter
15
+ bank, and local variance, then clusters the SOM nodes. The same spectral-spatial
16
+ feature engineering transfers directly to **hyperspectral** cubes.
17
+ - **Self-supervised denoising** — a 2.5D **Noise2Inverse** denoiser (`ct_seg.denoise`): a
18
+ no-skip U-Net trained from one noisy reconstruction (no clean reference), with a Laplacian
19
+ Contrast Loss and edge-aware model selection. The author's own implementation of the N2I
20
+ framework (upstream credit in [ct_seg/denoise/ACKNOWLEDGMENTS.md](ct_seg/denoise/ACKNOWLEDGMENTS.md)).
21
+
22
+ ## Install
23
+
24
+ ```bash
25
+ git clone https://github.com/crentb/ct-segmentation-toolkit.git
26
+ cd ct-segmentation-toolkit
27
+ python -m pip install -e ".[dev]" # core + dev tools (pytest, ruff, black, mypy)
28
+ python -m pip install -e ".[viz]" # optional: napari labeling + pyvista viewer
29
+ python -m pip install -e ".[mlops]" # optional: MLflow experiment tracking
30
+ python -m pip install -e ".[denoise]" # optional: N2I training (albumentations, PyYAML)
31
+ ```
32
+
33
+ ## Python API
34
+
35
+ ```python
36
+ import numpy as np
37
+ from ct_seg import segment_kmeans, som_segment, UNetSegmentation
38
+
39
+ volume = np.random.rand(16, 256, 256).astype("float32") # (slices, H, W) in [0, 1]
40
+
41
+ # Unsupervised intensity segmentation (no labels)
42
+ labels, info = segment_kmeans(volume, num_classes=4)
43
+
44
+ # Label-free spectral-spatial segmentation of a single slice
45
+ band_map = som_segment(volume[0], n_clusters=4)
46
+
47
+ # Supervised U-Net
48
+ model = UNetSegmentation(in_channels=1, num_classes=4)
49
+ ```
50
+
51
+ ## Command line
52
+
53
+ ```bash
54
+ # Unsupervised (otsu | kmeans | gmm)
55
+ python -m ct_seg.segment --input /path/to/tiffs --method kmeans --num_classes 4 --save_overlay
56
+
57
+ # Train a U-Net, then segment with it
58
+ python -m ct_seg.train --images /path/to/tiffs --masks /path/to/masks --num_classes 4
59
+ python -m ct_seg.segment --input /path/to/tiffs --method unet --model SegOutput/best_model.pth --num_classes 4
60
+ ```
61
+
62
+ (Interactive `ct_seg.labeling` (napari) and `ct_seg.viewer` (napari/pyvista) require the
63
+ `[viz]` extra.)
64
+
65
+ ## Experiment tracking & profiling
66
+
67
+ Training integrates optional **MLflow** logging (run parameters, per-epoch loss/mIoU,
68
+ and the best checkpoint). Install the extra and it logs automatically; without MLflow,
69
+ tracking is a harmless no-op and training is unaffected:
70
+
71
+ ```bash
72
+ pip install -e ".[mlops]"
73
+ python -m ct_seg.train --images ... --masks ... --num_classes 4 # logs to ./mlruns
74
+ mlflow ui # browse runs
75
+ ```
76
+
77
+ A reproducible **performance profile** (forward / train-step latency, throughput, and
78
+ peak GPU memory) is in [docs/PERF.md](docs/PERF.md):
79
+
80
+ ```bash
81
+ python scripts/profile_unet.py --device cuda --sizes 256 512
82
+ ```
83
+
84
+ ## Testing
85
+
86
+ ```bash
87
+ pytest -m "not slow" # fast suite (what CI runs)
88
+ pytest # everything
89
+ ```
90
+
91
+ ## Status
92
+
93
+ The supervised, unsupervised, SOM, and **Noise2Inverse denoising** paths are functional and
94
+ tested. The denoiser (`ct_seg.denoise`) is the author's own implementation of the N2I
95
+ framework (upstream credit in `ct_seg/denoise/ACKNOWLEDGMENTS.md`). Related published work on deep-learning
96
+ segmentation and self-supervised denoising of synchrotron CT is available as a preprint:
97
+ https://ssrn.com/abstract=6805001
98
+
99
+ ## Acknowledgments
100
+
101
+ `ct_seg.denoise` implements the Noise2Inverse framework (Hendriksen, Pelt & Batenburg,
102
+ *IEEE Transactions on Computational Imaging*, 2020; https://github.com/ahendriksen/noise2inverse).
103
+ See [ct_seg/denoise/ACKNOWLEDGMENTS.md](ct_seg/denoise/ACKNOWLEDGMENTS.md).
104
+
105
+ ## License
106
+
107
+ Apache-2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE).
@@ -0,0 +1,78 @@
1
+ """
2
+ ct_seg — a CT image segmentation toolkit.
3
+
4
+ Supervised (U-Net), unsupervised (multi-Otsu / k-means / GMM), and label-free
5
+ spectral-spatial (Self-Organizing Map) segmentation of scientific image stacks,
6
+ plus self-supervised denoising (2.5D Noise2Inverse).
7
+
8
+ Only the lightweight, importable APIs are exported here. The interactive tools
9
+ (`labeling`, napari; `viewer`, pyvista) require the optional ``[viz]`` extra and
10
+ are imported directly from their modules when needed.
11
+
12
+ Import policy — torch is loaded LAZILY (PEP 562):
13
+ The torch-backed symbols (``UNetSegmentation``, ``count_parameters``,
14
+ ``unet_ns_gn``, ``LCL``) are resolved on first attribute access instead of
15
+ at package import. Two reasons:
16
+ 1. Classical users (k-means / GMM / Otsu / SOM) should not pay torch's
17
+ import cost — or even need torch installed — to segment an image.
18
+ 2. Robustness: on some environments (observed on anaconda + macOS ARM,
19
+ 2026-07-15) eagerly importing torch alongside scikit-learn is FATAL —
20
+ torch's bundled libomp and MKL's libiomp5 both initialize OpenMP and
21
+ the process aborts with ``OMP: Error #179`` the moment a scikit-learn
22
+ thread pool spins up (e.g., KMeans inside ``som_segment``). Keeping
23
+ torch out of the import path unless a torch API is actually requested
24
+ means the classical paths can never trigger that clash.
25
+ """
26
+
27
+ from ct_seg.segment import (
28
+ enhance_contrast,
29
+ normalize_stack,
30
+ segment_gmm,
31
+ segment_kmeans,
32
+ segment_otsu,
33
+ segment_unet,
34
+ )
35
+ from ct_seg.som_bands import extract_features, som_segment
36
+
37
+ __version__ = "0.1.0"
38
+
39
+ # torch-backed exports, resolved lazily on first access (PEP 562).
40
+ _LAZY_TORCH_EXPORTS = {
41
+ "UNetSegmentation": ("ct_seg.model", "UNetSegmentation"),
42
+ "count_parameters": ("ct_seg.model", "count_parameters"),
43
+ "unet_ns_gn": ("ct_seg.denoise", "unet_ns_gn"),
44
+ "LCL": ("ct_seg.denoise", "LCL"),
45
+ }
46
+
47
+ __all__ = [
48
+ "UNetSegmentation",
49
+ "count_parameters",
50
+ "normalize_stack",
51
+ "enhance_contrast",
52
+ "segment_otsu",
53
+ "segment_kmeans",
54
+ "segment_gmm",
55
+ "segment_unet",
56
+ "extract_features",
57
+ "som_segment",
58
+ "unet_ns_gn",
59
+ "LCL",
60
+ "__version__",
61
+ ]
62
+
63
+
64
+ def __getattr__(name):
65
+ """Resolve torch-backed exports on first use (see module docstring)."""
66
+ if name in _LAZY_TORCH_EXPORTS:
67
+ import importlib
68
+
69
+ module_name, attr = _LAZY_TORCH_EXPORTS[name]
70
+ value = getattr(importlib.import_module(module_name), attr)
71
+ globals()[name] = value # cache so the import cost is paid once
72
+ return value
73
+ raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
74
+
75
+
76
+ def __dir__():
77
+ """Keep tab-completion/introspection honest about the lazy exports."""
78
+ return sorted(list(globals().keys()) + list(_LAZY_TORCH_EXPORTS.keys()))
@@ -0,0 +1,24 @@
1
+ """
2
+ ct_seg.denoise — self-supervised CT denoising (2.5D Noise2Inverse).
3
+
4
+ Cameron Renteria's own implementation of the Noise2Inverse (N2I) self-supervised
5
+ tomography-denoising framework: a no-skip U-Net (Group Normalization, LeakyReLU) trained
6
+ to map one sub-reconstruction (e.g. even-angle) to another (odd-angle), so it needs no
7
+ clean reference image. His additions over the base method include a 2.5D adjacent-slice
8
+ input, a Laplacian Contrast Loss (LCL) for edge preservation, edge-aware model selection,
9
+ and automatic GPU batch-size optimization.
10
+
11
+ Upstream method (credited): Noise2Inverse - Hendriksen, Pelt & Batenburg, IEEE Transactions
12
+ on Computational Imaging 6 (2020); original code https://github.com/ahendriksen/noise2inverse
13
+ (see ACKNOWLEDGMENTS.md). This subpackage is Copyright 2026 Cameron Renteria, Apache-2.0.
14
+
15
+ Only the lightweight building blocks (model, loss, edge score) are exported here. The
16
+ training/inference CLIs and dataset (`ct_seg.denoise.train`, `denoise_volume`,
17
+ `denoise_slice`, `data`) require the optional ``[denoise]`` extra (albumentations, PyYAML).
18
+ """
19
+
20
+ from ct_seg.denoise.eval import laplacian_score_batch
21
+ from ct_seg.denoise.loss import LCL
22
+ from ct_seg.denoise.model import unet_ns_gn
23
+
24
+ __all__ = ["unet_ns_gn", "LCL", "laplacian_score_batch"]