feabas-workbench 0.3.2__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 (91) hide show
  1. feabas_workbench-0.3.2/LICENSE +202 -0
  2. feabas_workbench-0.3.2/NOTICE +15 -0
  3. feabas_workbench-0.3.2/PKG-INFO +250 -0
  4. feabas_workbench-0.3.2/README.md +199 -0
  5. feabas_workbench-0.3.2/THIRD_PARTY_NOTICES.md +21 -0
  6. feabas_workbench-0.3.2/feabas_workbench/__init__.py +9 -0
  7. feabas_workbench-0.3.2/feabas_workbench/__main__.py +4 -0
  8. feabas_workbench-0.3.2/feabas_workbench/app.py +165 -0
  9. feabas_workbench-0.3.2/feabas_workbench/core/__init__.py +1 -0
  10. feabas_workbench-0.3.2/feabas_workbench/core/configs.py +332 -0
  11. feabas_workbench-0.3.2/feabas_workbench/core/envs.py +559 -0
  12. feabas_workbench-0.3.2/feabas_workbench/core/histmatch.py +158 -0
  13. feabas_workbench-0.3.2/feabas_workbench/core/httpserve.py +50 -0
  14. feabas_workbench-0.3.2/feabas_workbench/core/images.py +381 -0
  15. feabas_workbench-0.3.2/feabas_workbench/core/jobs.py +436 -0
  16. feabas_workbench-0.3.2/feabas_workbench/core/masks.py +697 -0
  17. feabas_workbench-0.3.2/feabas_workbench/core/maskstore.py +396 -0
  18. feabas_workbench-0.3.2/feabas_workbench/core/pipeline.py +104 -0
  19. feabas_workbench-0.3.2/feabas_workbench/core/project.py +362 -0
  20. feabas_workbench-0.3.2/feabas_workbench/core/steps.py +673 -0
  21. feabas_workbench-0.3.2/feabas_workbench/core/synthetic.py +164 -0
  22. feabas_workbench-0.3.2/feabas_workbench/core/testruns.py +243 -0
  23. feabas_workbench-0.3.2/feabas_workbench/core/tiles.py +805 -0
  24. feabas_workbench-0.3.2/feabas_workbench/resources/fold_unet_resnet34_inference_only_fp16.ckpt +4 -0
  25. feabas_workbench-0.3.2/feabas_workbench/ui/__init__.py +1 -0
  26. feabas_workbench-0.3.2/feabas_workbench/ui/bridge.py +207 -0
  27. feabas_workbench-0.3.2/feabas_workbench/ui/dialogs.py +173 -0
  28. feabas_workbench-0.3.2/feabas_workbench/ui/external.py +52 -0
  29. feabas_workbench-0.3.2/feabas_workbench/ui/main_window.py +410 -0
  30. feabas_workbench-0.3.2/feabas_workbench/ui/pages/__init__.py +3 -0
  31. feabas_workbench-0.3.2/feabas_workbench/ui/pages/base.py +117 -0
  32. feabas_workbench-0.3.2/feabas_workbench/ui/pages/page_align.py +867 -0
  33. feabas_workbench-0.3.2/feabas_workbench/ui/pages/page_export.py +290 -0
  34. feabas_workbench-0.3.2/feabas_workbench/ui/pages/page_masks.py +1068 -0
  35. feabas_workbench-0.3.2/feabas_workbench/ui/pages/page_preprocess.py +470 -0
  36. feabas_workbench-0.3.2/feabas_workbench/ui/pages/page_project.py +541 -0
  37. feabas_workbench-0.3.2/feabas_workbench/ui/pages/page_setup.py +315 -0
  38. feabas_workbench-0.3.2/feabas_workbench/ui/pages/page_stitch.py +469 -0
  39. feabas_workbench-0.3.2/feabas_workbench/ui/theme.py +78 -0
  40. feabas_workbench-0.3.2/feabas_workbench/ui/threads.py +97 -0
  41. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/__init__.py +12 -0
  42. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/common.py +174 -0
  43. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/config_editor.py +195 -0
  44. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/imageview.py +392 -0
  45. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/log_panel.py +102 -0
  46. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/paths.py +50 -0
  47. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/section_picker.py +153 -0
  48. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/step_card.py +145 -0
  49. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/steps_panel.py +113 -0
  50. feabas_workbench-0.3.2/feabas_workbench/ui/widgets/tile_grid.py +88 -0
  51. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/LICENSE +21 -0
  52. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/VERSION.txt +1 -0
  53. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/configs/default_alignment_configs.yaml +107 -0
  54. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/configs/default_material_table.yaml +57 -0
  55. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/configs/default_stitching_configs.yaml +82 -0
  56. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/configs/default_thumbnail_configs.yaml +82 -0
  57. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/scripts/align_main.py +628 -0
  58. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/scripts/stitch_main.py +292 -0
  59. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/scripts/thumbnail_main.py +660 -0
  60. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/tools/compute_alignment_residues.py +76 -0
  61. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/tools/convert_manual_thumbnail_matches.py +43 -0
  62. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/tools/edit_bigwarp.ijm +39 -0
  63. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/tools/export_match_to_bigwarp_csv.py +61 -0
  64. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/tools/merge_manual_match.py +65 -0
  65. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/tools/normalize_aligned_meshes.py +87 -0
  66. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/tools/render_aligned_thumbnails.py +140 -0
  67. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/tools/split_wrinkles.py +39 -0
  68. feabas_workbench-0.3.2/feabas_workbench/vendor/feabas_3_0_5/tools/visualize_align_match_coverage.py +165 -0
  69. feabas_workbench-0.3.2/feabas_workbench/vendor/winfix/sitecustomize.py +148 -0
  70. feabas_workbench-0.3.2/feabas_workbench/workers/__init__.py +7 -0
  71. feabas_workbench-0.3.2/feabas_workbench/workers/common.py +38 -0
  72. feabas_workbench-0.3.2/feabas_workbench/workers/export_vast.py +216 -0
  73. feabas_workbench-0.3.2/feabas_workbench/workers/fold_predict.py +178 -0
  74. feabas_workbench-0.3.2/feabas_workbench/workers/fold_train.py +177 -0
  75. feabas_workbench-0.3.2/feabas_workbench/workers/histmatch_worker.py +35 -0
  76. feabas_workbench-0.3.2/feabas_workbench/workers/n2v_predict.py +74 -0
  77. feabas_workbench-0.3.2/feabas_workbench/workers/n2v_train.py +102 -0
  78. feabas_workbench-0.3.2/feabas_workbench/workers/reweight_matches.py +88 -0
  79. feabas_workbench-0.3.2/feabas_workbench/workers/structure_match.py +246 -0
  80. feabas_workbench-0.3.2/feabas_workbench/workers/yolo_detect.py +138 -0
  81. feabas_workbench-0.3.2/feabas_workbench/workers/yolo_train.py +58 -0
  82. feabas_workbench-0.3.2/feabas_workbench.egg-info/PKG-INFO +250 -0
  83. feabas_workbench-0.3.2/feabas_workbench.egg-info/SOURCES.txt +89 -0
  84. feabas_workbench-0.3.2/feabas_workbench.egg-info/dependency_links.txt +1 -0
  85. feabas_workbench-0.3.2/feabas_workbench.egg-info/entry_points.txt +5 -0
  86. feabas_workbench-0.3.2/feabas_workbench.egg-info/requires.txt +26 -0
  87. feabas_workbench-0.3.2/feabas_workbench.egg-info/top_level.txt +1 -0
  88. feabas_workbench-0.3.2/pyproject.toml +87 -0
  89. feabas_workbench-0.3.2/setup.cfg +4 -0
  90. feabas_workbench-0.3.2/tests/test_core.py +771 -0
  91. feabas_workbench-0.3.2/tests/test_gui_smoke.py +285 -0
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,15 @@
1
+ FEABAS Workbench
2
+ Copyright 2026 Georg Kislinger
3
+ German Center for Neurodegenerative Diseases (DZNE) and Technical University of Munich (TUM)
4
+ https://github.com/georgkislinger/feabas-workbench
5
+ ORCID: https://orcid.org/0000-0002-6559-7421
6
+
7
+ This product is licensed under the Apache License, Version 2.0 (see LICENSE).
8
+ Redistributions of this software, or of substantial portions of it, in source or
9
+ binary form, must retain this NOTICE file.
10
+
11
+ This product is a front end for, and bundles the driver scripts, tools and default
12
+ configuration files of, FEABAS 3.0.5:
13
+ Copyright (c) 2022 Yuelong Wu, Center for Brain Science, Harvard University
14
+ Licensed under the MIT License (see feabas_workbench/vendor/feabas_3_0_5/LICENSE
15
+ and THIRD_PARTY_NOTICES.md).
@@ -0,0 +1,250 @@
1
+ Metadata-Version: 2.4
2
+ Name: feabas-workbench
3
+ Version: 0.3.2
4
+ Summary: Desktop workbench around FEABAS: data prep, preprocessing, stitching, masks, structure-guided alignment and export for serial-section EM
5
+ Author-email: Georg Kislinger <georg.kislinger@dzne.de>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/georgkislinger/feabas-workbench
8
+ Project-URL: User guide, https://github.com/georgkislinger/feabas-workbench/blob/main/docs/USER_GUIDE.md
9
+ Project-URL: Issues, https://github.com/georgkislinger/feabas-workbench/issues
10
+ Project-URL: FEABAS, https://github.com/YuelongWu/feabas
11
+ Project-URL: FEABAS paper, https://doi.org/10.64898/2026.06.07.730510
12
+ Project-URL: Changelog, https://github.com/georgkislinger/feabas-workbench/blob/main/CHANGELOG.md
13
+ Keywords: electron-microscopy,connectomics,stitching,alignment,FEABAS,serial-section
14
+ Classifier: Development Status :: 3 - Alpha
15
+ Classifier: Environment :: X11 Applications :: Qt
16
+ Classifier: Environment :: Win32 (MS Windows)
17
+ Classifier: Intended Audience :: Science/Research
18
+ Classifier: Operating System :: Microsoft :: Windows
19
+ Classifier: Operating System :: POSIX :: Linux
20
+ Classifier: Programming Language :: Python :: 3
21
+ Classifier: Topic :: Scientific/Engineering :: Image Processing
22
+ Requires-Python: >=3.10
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ License-File: NOTICE
26
+ License-File: THIRD_PARTY_NOTICES.md
27
+ Requires-Dist: PySide6>=6.5
28
+ Requires-Dist: numpy
29
+ Requires-Dist: scipy
30
+ Requires-Dist: PyYAML>=6.0
31
+ Requires-Dist: Pillow>=10
32
+ Requires-Dist: tifffile
33
+ Requires-Dist: imagecodecs
34
+ Requires-Dist: h5py
35
+ Requires-Dist: psutil
36
+ Requires-Dist: opencv-python-headless
37
+ Requires-Dist: tensorstore
38
+ Provides-Extra: dl
39
+ Requires-Dist: torch; extra == "dl"
40
+ Requires-Dist: torchvision; extra == "dl"
41
+ Requires-Dist: segmentation-models-pytorch; extra == "dl"
42
+ Requires-Dist: ultralytics; extra == "dl"
43
+ Requires-Dist: careamics==0.3.2; extra == "dl"
44
+ Requires-Dist: scikit-image; extra == "dl"
45
+ Provides-Extra: viewer
46
+ Requires-Dist: tensorstore; extra == "viewer"
47
+ Provides-Extra: dev
48
+ Requires-Dist: pytest; extra == "dev"
49
+ Requires-Dist: pyinstaller; extra == "dev"
50
+ Dynamic: license-file
51
+
52
+ <h1 align="center">FEABAS Workbench</h1>
53
+
54
+ <p align="center">
55
+ A desktop app for stitching and aligning serial-section EM volumes with
56
+ <a href="https://github.com/YuelongWu/feabas">FEABAS</a> – for people who do not want to touch YAML files or a terminal.
57
+ </p>
58
+
59
+ <p align="center">
60
+ <a href="https://github.com/georgkislinger/feabas-workbench/actions/workflows/ci.yml"><img alt="CI" src="https://github.com/georgkislinger/feabas-workbench/actions/workflows/ci.yml/badge.svg"></a>
61
+ <img alt="Python 3.10+" src="https://img.shields.io/badge/python-3.10%2B-blue">
62
+ <img alt="Windows | Linux" src="https://img.shields.io/badge/platform-Windows%20%7C%20Linux-lightgrey">
63
+ <img alt="FEABAS 3.0.5" src="https://img.shields.io/badge/FEABAS-3.0.5-8a2be2">
64
+ <a href="https://github.com/georgkislinger/feabas-workbench/blob/v0.3.2/LICENSE"><img alt="Apache-2.0 license" src="https://img.shields.io/badge/license-Apache--2.0-green"></a>
65
+ </p>
66
+
67
+ <p align="center">
68
+ <img src="https://raw.githubusercontent.com/georgkislinger/feabas-workbench/v0.3.2/docs/img/window3_stitching.png" alt="Stitching window" width="880">
69
+ </p>
70
+
71
+ [FEABAS](https://github.com/YuelongWu/feabas) – *Finite-Element Assisted Brain Assembly System*, by Yuelong Wu and Jeff W. Lichtman
72
+ (Harvard; MIT licence) and described in [Wu & Lichtman, 2026](https://doi.org/10.64898/2026.06.07.730510) – is a state-of-the-art
73
+ pipeline for stitching and elastically aligning serial-section electron-microscopy data. It is driven
74
+ from the command line by YAML files. The workbench
75
+ wraps it in seven windows, one per stage, and adds the parts the command line leaves to you: reading tile
76
+ positions out of microscope metadata, building the masks, test runs on subsets, quality overlays, rolling
77
+ back, and exporting to a viewer.
78
+
79
+ FEABAS itself is not modified: its driver scripts (3.0.5) are vendored and run as subprocesses in your
80
+ FEABAS environment with the project folder as working directory.
81
+
82
+ ## What it does
83
+
84
+ | Window | What happens there |
85
+ |---|---|
86
+ | **0 Setup** | Finds or installs the Python environments (FEABAS; PyTorch + CAREamics + ultralytics + segmentation-models-pytorch), checks the GPU, remembers where Fiji and VASTlite are. |
87
+ | **1 Project & data** | Points at the raw tiles, guesses how filenames encode row/column/section (Thermo Maps, Zeiss Atlas, sequential numbers, custom pattern), reads pixel size and stage positions from the TIFF metadata, previews the layout, writes FEABAS's `stitch_coord` files. |
88
+ | **2 Preprocessing** | Optional histogram matching to a template and CAREamics Noise2Void / N2V2 / StructN2V denoising trained on tiles you pick. |
89
+ | **3 Stitching** | Tile matching, montage optimisation and rendering with the settings that matter up front; test runs on a few sections and tiles in a sandbox; a full-resolution viewer for seams; every other setting in a documented tree editor. |
90
+ | **4 Masks** | Thumbnails, tissue-vs-background masks (tile footprint, a black/white frame peeled from the outside in, fixed margins, or texture/intensity — each method shows only its own settings), fold detection with the bundled U-Net (or one you train here), import of masks made elsewhere, composition into FEABAS's material mask, split lines for broken sections, hand editing in Fiji. |
91
+ | **5 Alignment** | Coarse (thumbnail) and fine (finite-element) alignment with its own compare distance, sandbox test runs, red/green and checkerboard overlays, and — optional, switched on in Setup — **structure-guided alignment**: a YOLO-seg model finds nuclei / mitochondria / vessels and the alignment is driven from them. |
92
+ | **6 Export & view** | Full-resolution PNG tiles or a Neuroglancer precomputed volume, mipmaps, VASTlite export (`.vsvi`, hard-linked, instant), OME-Zarr, open in VASTlite / Fiji / Neuroglancer. |
93
+
94
+ Across all of them: pipeline state is read from the files on disk (done / partly done / stale / errors /
95
+ blocked), **clear a step and everything after it**, **snapshots** to roll back to, a log with FEABAS's
96
+ own messages, cancellable jobs, and subset runs (`--start/--stop/--step`) for spreading work over machines.
97
+
98
+ ## What the result looks like
99
+
100
+ The example dataset used during development: 10 serial sections, 8 × 5 tiles of 6144 × 4096 px at
101
+ 10 nm as written by a Thermo Fisher microscope, through the whole pipeline with default settings.
102
+
103
+ <table>
104
+ <tr>
105
+ <td align="center"><img src="https://raw.githubusercontent.com/georgkislinger/feabas-workbench/v0.3.2/docs/img/result_stitched_section.jpg" width="420" alt="Stitched section"><br><sub>One stitched section, 32 768 × 32 768 px, from 40 tiles.</sub></td>
106
+ <td align="center"><img src="https://raw.githubusercontent.com/georgkislinger/feabas-workbench/v0.3.2/docs/img/result_aligned_overlay.jpg" width="420" alt="Aligned sections overlay"><br><sub>Two consecutive aligned sections in red and green: yellow where they coincide.</sub></td>
107
+ </tr>
108
+ </table>
109
+
110
+ <details>
111
+ <summary>More windows</summary>
112
+ <p align="center">
113
+ <img src="https://raw.githubusercontent.com/georgkislinger/feabas-workbench/v0.3.2/docs/img/window1_project.png" width="700" alt="Project & data window"><br>
114
+ <img src="https://raw.githubusercontent.com/georgkislinger/feabas-workbench/v0.3.2/docs/img/window4_masks.png" width="700" alt="Masks window"><br>
115
+ <img src="https://raw.githubusercontent.com/georgkislinger/feabas-workbench/v0.3.2/docs/img/window5_alignment.png" width="700" alt="Alignment window"><br>
116
+ <img src="https://raw.githubusercontent.com/georgkislinger/feabas-workbench/v0.3.2/docs/img/window6_export.png" width="700" alt="Export window">
117
+ </p>
118
+ </details>
119
+
120
+ ## Install
121
+
122
+ The heavy parts – FEABAS and PyTorch – go into separate environments that the app creates for you from
123
+ its **Setup** page afterwards (internet needed; the deep-learning one is several GB; without conda the
124
+ Setup page downloads micromamba for that). So this only concerns the GUI. Pick the row that matches your
125
+ machine:
126
+
127
+ | You have | Do this |
128
+ |---|---|
129
+ | **a Windows PC with nothing on it** (no Python, no conda) | Download `FEABAS-Workbench-<version>-windows-x64.zip` from the [Releases page](https://github.com/georgkislinger/feabas-workbench/releases), unpack it, start `FEABAS-Workbench\FEABAS-Workbench.exe` (SmartScreen warns once: *More info → Run anyway*). Or get the source (below) and double-click `tools\install.bat`: with no package manager on the PC it downloads a standalone micromamba and continues. |
130
+ | **micromamba / Miniforge / Miniconda / Anaconda** | Get the source (**Code → Download ZIP**, or `git clone`), unpack, then Windows: double-click `tools\install.bat` · Linux/macOS: `bash tools/install.sh`. The script finds the package manager, creates the `feabas-workbench` env, installs the app and hard-wires `start_gui.bat` / `start_gui.sh` to it. |
131
+ | **plain Python ≥ 3.10**, no conda | `pip install feabas-workbench` into any environment of yours ([PyPI](https://pypi.org/project/feabas-workbench/); the same wheel is attached to every GitHub release). Or, in the unpacked source: `python -m venv .venv` then `.venv\Scripts\python -m pip install -e .` (Linux: `.venv/bin/python`). |
132
+
133
+ Start with **`start_gui.bat`** (Windows) or **`./start_gui.sh`** (Linux/macOS) – both find the
134
+ environment on their own – or, after a pip install, with `feabas-workbench` (`feabas-workbench-cli`
135
+ keeps a console window, for tracebacks). Then open **Setup**: *Detect
136
+ environments* finds existing FEABAS / PyTorch environments, otherwise *Install fw-feabas* and *Install
137
+ fw-dl* create them.
138
+
139
+ > **Tip:** Linux desktops have the Qt libraries already. On a minimal server install add
140
+ > `sudo apt install libegl1 libopengl0 libxkbcommon0 libdbus-1-3 libxcb-cursor0 libfontconfig1`.
141
+
142
+ **Try it without data:** `python -m feabas_workbench.core.synthetic D:\demo` makes a small synthetic
143
+ serial-section dataset with a ready project; open it in the workbench, or run the whole pipeline on it
144
+ with `python tools/run_demo_pipeline.py D:\demo --feabas-python <fw-feabas python>` (this is what CI does).
145
+
146
+ The full version with every option, and every window and setting explained – what it does, when to
147
+ change it, what it makes stale – is the **[user guide](https://github.com/georgkislinger/feabas-workbench/blob/v0.3.2/docs/USER_GUIDE.md)**. The same text as a page
148
+ with a contents rail and search is [`docs/user_guide.html`](https://github.com/georgkislinger/feabas-workbench/blob/v0.3.2/docs/user_guide.html): open it in a browser
149
+ from your download.
150
+
151
+ ## A typical run
152
+
153
+ 1. **Project & data** – *New project* (an empty folder on a big disk) → tile folder → *Guess rule* →
154
+ *Read from image metadata* → *Scan tiles* → check the preview → *Write stitch_coord files*.
155
+ 2. **Stitching** – set workers and render driver → *Run all*. For a new dataset, first *Test on subset*
156
+ with one section and a few tiles, look at the seams, then run for real.
157
+ 3. **Masks** – *Make thumbnails* (about 500–2000 px; the suggested mip does that) → tissue rule →
158
+ *Detect folds* → *Compose*. Check a few sections with the overlay; paint split lines through broken sections.
159
+ 4. **Alignment** – *Match thumbnails* → *Optimize coarse stack* → *Render coarse stack* → check red/green →
160
+ *Generate meshes* → *Fine matching* → *Optimize stack*.
161
+ 5. **Export & view** – render PNG tiles + mipmaps → *Export* (VAST) → *Open in VASTlite*; or render the
162
+ precomputed volume and open it in Neuroglancer.
163
+
164
+ For the plain case, **Pipeline → Run the standard pipeline…** (Ctrl+R) queues steps 2–4 in one go and
165
+ stops at the first failure.
166
+
167
+ When something upstream changes, the affected steps show **stale**; *Clear…* on the earliest affected step
168
+ lists what will be deleted, then re-run. Make a snapshot first if the previous state was valuable.
169
+
170
+ ### Structure-guided alignment
171
+
172
+ Off by default (Setup → Interface shows the tab). With a YOLO-seg model (bring `.pt` weights, or train on a YOLO-format dataset from the
173
+ Alignment window): *Detect structures* on thumbnails, then *Match structures* – centroids of the same
174
+ structures in neighbouring sections become coarse matches, either added to FEABAS's feature matches with a
175
+ weight or used instead of them where they succeed. For fine alignment, *restrict* turns tissue outside the
176
+ structures into a low-stiffness material, or *Re-weight fine matches* damps the matches outside them.
177
+ The idea: let the user say what the alignment should be driven from – nuclei, mitochondria, vessels –
178
+ instead of features they cannot see.
179
+
180
+ <details>
181
+ <summary>Layout of a project folder</summary>
182
+
183
+ ```
184
+ project/
185
+ workbench_project.json workbench state (source folder, naming rule, voxel size, settings)
186
+ configs/ general_configs.yaml (points FEABAS here), default_*.yaml, your overrides
187
+ stitch/stitch_coord/ one TSV per section (input to FEABAS)
188
+ stitch/, stitched_sections/, thumbnail_align/, align/, aligned_stack/, logs/ FEABAS outputs
189
+ preprocessed/{histmatch,denoised}/ preprocessed tiles mirroring the raw folder
190
+ masks/{tissue,folds,structures}/ intermediate masks; manifest.json marks hand-edited ones
191
+ models/{n2v,folds,yolo}/ trained models
192
+ tests/<name>/ sandbox working directories for subset test runs
193
+ snapshots/<stamp>/ rollback copies of matches/meshes/transforms/configs
194
+ exports/ VAST / OME-Zarr exports
195
+ ```
196
+
197
+ The project folder *is* the FEABAS working directory. Your raw tiles stay where they are.
198
+ </details>
199
+
200
+ ## Development
201
+
202
+ ```bash
203
+ python -m pytest tests -q # core tests + offscreen GUI smoke test
204
+ python -m feabas_workbench --project X --screenshot out/ # render every window offscreen
205
+ python -m build # wheel + sdist
206
+ pyinstaller tools/feabas_workbench.spec # GUI-only executable (environments stay external)
207
+ ```
208
+
209
+ `feabas-workbench --selfcheck report.json` verifies an installation (vendored FEABAS, checkpoint, worker
210
+ staging) without opening a window.
211
+
212
+ CI, on every commit: lint (ruff, pyflakes level), the tests, the offscreen render of every window on a
213
+ synthetic project and the wheel build on Ubuntu and Windows for Python 3.11 and 3.12; the **whole
214
+ FEABAS pipeline** on a synthetic 4-section dataset on Linux (`tools/run_demo_pipeline.py`, and once more
215
+ through the GUI's job queue with `tools/run_demo_pipeline_gui.py`); and the frozen Windows build with
216
+ its self-check. A `v*` tag builds the wheel, sdist and Windows zip, publishes the GitHub Release and
217
+ uploads the wheel and sdist to PyPI (trusted publishing, no stored token; the README goes through
218
+ `tools/absolutize_readme.py` first because PyPI does not resolve relative links).
219
+
220
+ Code map: `feabas_workbench/core` (Qt-free: project, tiles, configs, steps, jobs, pipeline, masks, images,
221
+ test runs, environments, synthetic data), `feabas_workbench/workers` (subprocess workers: histogram matching, N2V, fold U-Net, YOLO,
222
+ structure matching, match re-weighting, export), `feabas_workbench/ui` (PySide6 pages and widgets),
223
+ `feabas_workbench/vendor/feabas_3_0_5` (FEABAS driver scripts, tools and default configs),
224
+ `feabas_workbench/resources` (the bundled fold U-Net weights: an fp16 export with every model weight, so it
225
+ detects and can be fine-tuned; only the original training run's optimizer state is not included, which
226
+ only matters for resuming that run — the full 280 MB checkpoint is not bundled).
227
+
228
+ ## Credits and license
229
+
230
+ This is a front end for **[FEABAS](https://github.com/YuelongWu/feabas)** by Yuelong Wu (Center for
231
+ Brain Science, Harvard University), which does the actual stitching and alignment; the method is
232
+ described in Wu & Lichtman (2026), [doi:10.64898/2026.06.07.730510](https://doi.org/10.64898/2026.06.07.730510). FEABAS is MIT-licensed;
233
+ its driver scripts and default configuration files are vendored here unchanged, with their license, under
234
+ `feabas_workbench/vendor/feabas_3_0_5/` (see [THIRD_PARTY_NOTICES.md](https://github.com/georgkislinger/feabas-workbench/blob/v0.3.2/THIRD_PARTY_NOTICES.md)).
235
+
236
+ The workbench is released under the [Apache License 2.0](https://github.com/georgkislinger/feabas-workbench/blob/v0.3.2/LICENSE). Its [NOTICE](https://github.com/georgkislinger/feabas-workbench/blob/v0.3.2/NOTICE) file carries the
237
+ author attribution; anyone who redistributes the workbench, or substantial parts of it, has to keep it.
238
+
239
+ ## How to cite
240
+
241
+ Cite FEABAS for the stitching and alignment – that is where the science is:
242
+
243
+ > Wu, Y. & Lichtman, J. W. (2026). *FEABAS: A Stitching and Alignment Tool for Serial EM Data.*
244
+ > bioRxiv. https://doi.org/10.64898/2026.06.07.730510
245
+
246
+ and, if the workbench was useful in your work, the workbench too (GitHub's *Cite this repository*
247
+ button uses [CITATION.cff](https://github.com/georgkislinger/feabas-workbench/blob/v0.3.2/CITATION.cff)):
248
+
249
+ > Kislinger, G. (2026). *FEABAS Workbench* (version 0.3.2) [Computer software].
250
+ > https://github.com/georgkislinger/feabas-workbench — ORCID 0000-0002-6559-7421