biomedisa 24.5.23__py3-none-any.whl

biomedisa-24.5.23.dist-info/METADATA

@@ -0,0 +1,261 @@
+Metadata-Version: 2.1
+Name: biomedisa
+Version: 24.5.23
+Summary: Segmentation of 3D volumetric image data
+Author: Philipp Lösel
+Author-email: philipp.loesel@anu.edu.au
+Project-URL: Homepage, https://biomedisa.info
+Project-URL: Issues, https://github.com/biomedisa/biomedisa/issues
+Project-URL: GitHub, https://github.com/biomedisa/biomedisa
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+[![biomedisa](https://raw.githubusercontent.com/biomedisa/biomedisa/master/biomedisa_app/static/biomedisa_logo.svg)](https://biomedisa.info)
+-----------
+- [Overview](#overview)
+- [Hardware Requirements](#hardware-requirements)
+- [Installation (command-line based)](#installation-command-line-based)
+- [Installation (browser based)](#installation-browser-based)
+- [Download Data](#download-data)
+- [Revisions](#revisions)
+- [Quickstart](#quickstart)
+- [Smart Interpolation](#smart-interpolation)
+- [Deep Learning](#deep-learning)
+- [Mesh Generator](#mesh-generator)
+- [Biomedisa Features](#biomedisa-features)
+- [Authors](#authors)
+- [FAQ](#faq)
+- [Citation](#citation)
+- [License](#license)
+
+## Overview
+Biomedisa (https://biomedisa.info) is a free and easy-to-use open-source application for segmenting large volumetric images, e.g. CT and MRI scans, developed at [The Australian National University CTLab](https://ctlab.anu.edu.au/). Biomedisa's semi-automated segmentation is based on a smart interpolation of sparsely pre-segmented slices, taking into account the complete underlying image data. In addition, Biomedisa enables deep learning for the fully automated segmentation of series of similar samples. It can be used in combination with segmentation tools such as Amira/Avizo, ImageJ/Fiji and 3D Slicer. If you are using Biomedisa or the data for your research please cite: Lösel, P.D. et al. [Introducing Biomedisa as an open-source online platform for biomedical image segmentation.](https://www.nature.com/articles/s41467-020-19303-w) *Nat. Commun.* **11**, 5577 (2020).
+
+## Hardware Requirements
++ One or more NVIDIA GPUs with compute capability 3.0 or higher or an Intel CPU
+
+## Installation (command-line based)
++ [Ubuntu 22.04 + CUDA + GPU (recommended)](https://github.com/biomedisa/biomedisa/blob/master/README/ubuntu2204_cuda11.8_gpu_cli.md)
++ [Ubuntu 22.04 + OpenCL + CPU (smart interpolation only and very slow)](https://github.com/biomedisa/biomedisa/blob/master/README/ubuntu2204_opencl_cpu_cli.md)
++ [Windows 10 + CUDA + GPU (recommended)](https://github.com/biomedisa/biomedisa/blob/master/README/windows10_cuda_gpu_cli.md)
++ [Windows 10 + OpenCL + GPU (easy to install but lacks features like allaxis, smoothing, uncertainty, optimized GPU memory usage)](https://github.com/biomedisa/biomedisa/blob/master/README/windows10_opencl_gpu_cli.md)
++ [Windows 10 + OpenCL + CPU (very slow)](https://github.com/biomedisa/biomedisa/blob/master/README/windows10_opencl_cpu_cli.md)
+
+## Installation (browser based)
++ [Ubuntu 22.04](https://github.com/biomedisa/biomedisa/blob/master/README/ubuntu2204_cuda11.8.md)
+
+## Download Data
++ Download test data from our [gallery](https://biomedisa.info/gallery/)
+
+## Revisions
+24.5.22
++ Pip is the preferred installation method
++ Commands, module names and imports have been changed to conform to the Pip standard
++ For versions <=23.9.1 please check [README](https://github.com/biomedisa/biomedisa/blob/master/README/deprecated/README_2023.09.1.md)
+
+## Quickstart
+Install the Biomedisa package from the [Python Package Index](https://pypi.org/project/biomedisa/):
+```
+python -m pip install -U biomedisa
+```
+For smart interpolation and deep Learning modules, follow the installation instructions above.
+
+## Smart Interpolation
++ [Parameters and Examples](https://github.com/biomedisa/biomedisa/blob/master/README/smart_interpolation.md)
+
+#### Python example
+```python
+from biomedisa.features.biomedisa_helper import load_data, save_data
+from biomedisa.interpolation import smart_interpolation
+
+# load data
+img, _ = load_data('Downloads/trigonopterus.tif')
+labels, header = load_data('Downloads/labels.trigonopterus_smart.am')
+
+# run smart interpolation with optional smoothing result
+results = smart_interpolation(img, labels, smooth=100)
+
+# get results
+regular_result = results['regular']
+smooth_result = results['smooth']
+
+# save results
+save_data('Downloads/final.trigonopterus.am', regular_result, header=header)
+save_data('Downloads/final.trigonopterus.smooth.am', smooth_result, header=header)
+```
+
+#### Command-line based
+```
+python -m biomedisa.interpolation C:\Users\%USERNAME%\Downloads\tumor.tif C:\Users\%USERNAME%\Downloads\labels.tumor.tif
+```
+If pre-segmentation is not exclusively in the XY plane:
+```
+python -m biomedisa.interpolation C:\Users\%USERNAME%\Downloads\tumor.tif C:\Users\%USERNAME%\Downloads\labels.tumor.tif --allaxis
+```
+
+## Deep Learning
++ [Parameters and Examples](https://github.com/biomedisa/biomedisa/blob/master/README/deep_learning.md)
+
+#### Python example (training)
+```python
+from biomedisa.features.biomedisa_helper import load_data
+from biomedisa.deeplearning import deep_learning
+
+# load image data
+img1, _ = load_data('Head1.am')
+img2, _ = load_data('Head2.am')
+img_data = [img1, img2]
+
+# load label data and header information to be stored in the network file (optional)
+label1, _ = load_data('Head1.labels.am')
+label2, header, ext = load_data('Head2.labels.am',
+        return_extension=True)
+label_data = [label1, label2]
+
+# load validation data (optional)
+img3, _ = load_data('Head3.am')
+img4, _ = load_data('Head4.am')
+label3, _ = load_data('Head3.labels.am')
+label4, _ = load_data('Head4.labels.am')
+val_img_data = [img3, img4]
+val_label_data = [label3, label4]
+
+# deep learning 
+deep_learning(img_data, label_data, train=True, batch_size=12,
+        val_img_data=val_img_data, val_label_data=val_label_data,
+        header=header, extension=ext, path_to_model='honeybees.h5')
+```
+
+#### Command-line based (training)
+Start training with a batch size of 12:
+```
+python -m biomedisa.deeplearning C:\Users\%USERNAME%\Downloads\training_heart C:\Users\%USERNAME%\Downloads\training_heart_labels -t -bs=12
+```
+Monitor training progress using validation data:
+```
+python -m biomedisa.deeplearning C:\Users\%USERNAME%\Downloads\training_heart C:\Users\%USERNAME%\Downloads\training_heart_labels -t -vi=C:\Users\%USERNAME%\Downloads\val_img -vl=C:\Users\%USERNAME%\Downloads\val_labels
+```
+If running into ResourceExhaustedError due to out of memory (OOM), try to use a smaller batch size.
+
+#### Python example (prediction)
+```python
+from biomedisa.features.biomedisa_helper import load_data, save_data
+from biomedisa.deeplearning import deep_learning
+
+# load data
+img, _ = load_data('Head5.am')
+
+# deep learning
+results = deep_learning(img, predict=True,
+        path_to_model='honeybees.h5', batch_size=6)
+
+# save result
+save_data('final.Head5.am', results['regular'], results['header'])
+```
+
+#### Command-line based (prediction)
+```
+python -m biomedisa.deeplearning C:\Users\%USERNAME%\Downloads\testing_axial_crop_pat13.nii.gz C:\Users\%USERNAME%\Downloads\heart.h5 -p
+```
+
+## Mesh Generator
++ [Parameters and Examples](https://github.com/biomedisa/biomedisa/blob/master/README/save_mesh.md)
+
+#### Python example
+Create STL mesh from segmentation (label values are saved as attributes)
+```python
+from biomedisa.features.biomedisa_helper import load_data, save_data
+from biomedisa.mesh import get_voxel_spacing, save_mesh
+
+# load segmentation
+data, header, extension = load_data('final.Head5.am', return_extension=True)
+
+# get voxel spacing
+x_res, y_res, z_res = get_voxel_spacing(header, data, extension)
+print(f'Voxel spacing: x_spacing, y_spacing, z_spacing = {x_res}, {y_res}, {z_res}')
+
+# save stl file
+save_mesh('final.Head5.stl', data, x_res, y_res, z_res, poly_reduction=0.9, smoothing_iterations=15)
+```
+
+#### Command-line based
+```
+python -m biomedisa.mesh 'final.Head5.am'
+```
+
+## Biomedisa Features
+
+#### Load and save data (such as Amira Mesh, TIFF, NRRD, NIfTI or DICOM)
+For DICOM, PNG files, or similar formats, file path must reference either a directory or a ZIP file containing the image slices.
+```python
+from biomedisa.features.biomedisa_helper import load_data, save_data
+
+# load data as numpy array
+data, header = load_data('temp.tif')
+
+# save data (for TIFF, header=None)
+save_data('temp.tif', data, header)
+```
+
+#### Resize data
+```python
+from biomedisa.features.biomedisa_helper import img_resize
+
+# resize image data
+zsh, ysh, xsh = data.shape
+new_zsh, new_ysh, new_xsh = zsh//2, ysh//2, xsh//2
+data = img_resize(data, new_zsh, new_ysh, new_xsh)
+
+# resize label data
+label_data = img_resize(label_data, new_zsh, new_ysh, new_xsh, labels=True)
+```
+
+#### Remove outliers and fill holes
+```python
+from biomedisa.features.biomedisa_helper import clean, fill
+
+# delete outliers smaller than 90% of the segment
+label_data = clean(label_data, 0.9)
+
+# fill holes
+label_data = fill(label_data, 0.9)
+```
+
+#### Accuracy assessment
+```python
+from biomedisa.features.biomedisa_helper import Dice_score, ASSD
+dice = Dice_score(ground_truth, result)
+assd = ASSD(ground_truth, result)
+```
+
+## Authors
+
+* **Philipp D. Lösel**
+
+See also the list of [contributors](https://github.com/biomedisa/biomedisa/blob/master/credits.md) who participated in this project.
+
+## FAQ
+Frequently asked questions can be found at: https://biomedisa.info/faq/.
+
+## Citation
+
+If you use Biomedisa or the data, please cite the following paper:
+
+`Lösel, P.D. et al. Introducing Biomedisa as an open-source online platform for biomedical image segmentation. Nat. Commun. 11, 5577 (2020).` https://doi.org/10.1038/s41467-020-19303-w
+
+If you use Biomedisa's Deep Learning, you may also cite:
+
+`Lösel, P.D. et al. Natural variability in bee brain size and symmetry revealed by micro-CT imaging and deep learning. PLoS Comput. Biol. 19, e1011529 (2023).` https://doi.org/10.1371/journal.pcbi.1011529
+
+If you use Biomedisa's Smart Interpolation, you can also cite the initial description of this method:
+
+`Lösel, P. & Heuveline, V. Enhancing a diffusion algorithm for 4D image segmentation using local information. Proc. SPIE 9784, 97842L (2016).` https://doi.org/10.1117/12.2216202
+
+## License
+
+This project is covered under the **EUROPEAN UNION PUBLIC LICENCE v. 1.2 (EUPL)**.
+

biomedisa-24.5.23.dist-info/RECORD

@@ -0,0 +1,44 @@
+biomedisa/__init__.py,sha256=hw4mzEjGFXm-vxus2DBfKFW0nKoG0ibL5SH6ShfchrY,1526
+biomedisa/__main__.py,sha256=a1--8vhtztWEloHVtbM43FZLCfrFo4BELgdsgtWE8ls,536
+biomedisa/deeplearning.py,sha256=UG5baX58CrO8YXe9pU6_Bp2OOvbC74LQw4S33HqM2iA,27828
+biomedisa/interpolation.py,sha256=R8UbBWt7vOuiQCPSeNIpEY0_yfQUg1oBfhAjXi91Hl4,17253
+biomedisa/mesh.py,sha256=glvpTN0PPByb5j2IbLCdWQtc5O4VT-Pwu3en8EaYyTo,15819
+biomedisa/features/DataGenerator.py,sha256=bGys6UZ0bnKb_k1Y3Spo6MNPk_goSAmptdZnI39smaw,12770
+biomedisa/features/DataGeneratorCrop.py,sha256=23R4Z-8tB1CsjYTYfhHGovlJpAny_q9OV9hq8kc2GJg,5454
+biomedisa/features/PredictDataGenerator.py,sha256=JH8SPGQm-Y7_Drec2fw3jBUupvpIkQ1FvkDXP7mUjDY,4074
+biomedisa/features/PredictDataGeneratorCrop.py,sha256=HF5tJbGtlJMHr7lMT9IiIdLG2CTjXstbKoOjlZJ93Is,3431
+biomedisa/features/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+biomedisa/features/active_contour.py,sha256=n5_vAD8jvQjU6fQ6A9hxjSmtkLLo_1fl0S5q1H2pmVg,18096
+biomedisa/features/assd.py,sha256=q9NUQXEoA4Pi3d8b5fmys615CWu06Sm0N9-OGwJOFnw,6537
+biomedisa/features/biomedisa_helper.py,sha256=iLbt4RpCU3EK51uiMefkM0321AgBdeLgrT-X4d--YJY,32250
+biomedisa/features/create_slices.py,sha256=tLDJmuJFN8teTiCYvMauExfVzT2ZUF28VcPXpo4sOsE,13001
+biomedisa/features/crop_helper.py,sha256=si72n9Q-C7U0cXYOD9Ux2UqIbZdXbZSOARBYDeqRggI,24533
+biomedisa/features/curvop_numba.py,sha256=AjKQJcUBoURTB8pq1HmugQYpBwBELthhcEu51_r_xPI,7049
+biomedisa/features/django_env.py,sha256=pdiPcBpqu1BWuyvh-palIGVwHFaY-leQ4Gatlbm8hIg,8942
+biomedisa/features/keras_helper.py,sha256=muPwb_W7O63exzWACJ4oLdAc-AQitcxLeNwgHvxyhuE,50488
+biomedisa/features/nc_reader.py,sha256=RoRMwu3ELSNfoV3qZtaT2OWACnXb2EhNFu_DAF1T93o,7406
+biomedisa/features/pid.py,sha256=Jmn1VIp0fBlgBrqZ-yUIQVVb5-NAxNBdibXALVr2PPI,2545
+biomedisa/features/process_image.py,sha256=VtS3fGDvglqJiiJLPK1toe76J58j914NJ8XQKg3CRwo,11091
+biomedisa/features/pycuda_test.py,sha256=UGAGIz_dgcCJkzjyCqnMlflp-WJPzpCtFQmE9C5DwIo,3275
+biomedisa/features/remove_outlier.py,sha256=XhbFPkazMmEUZiP0FERdCkrXaLhwO095x4wcn-B3SdU,16756
+biomedisa/features/split_volume.py,sha256=UgMpHhZPvH90xFo-mJ0Oc0tBXbrf8FQF0kzVySAlO8g,8917
+biomedisa/features/amira_to_np/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+biomedisa/features/amira_to_np/amira_data_stream.py,sha256=JrZTyKP01CKDFB5d9BlGtSFwBgoAo0AJeAmn3pADH88,32618
+biomedisa/features/amira_to_np/amira_grammar.py,sha256=z1yajLHmn-GDb-rzZ5iHlKmPZDDbO9fNqP2jXf8z3KE,14324
+biomedisa/features/amira_to_np/amira_header.py,sha256=eWHECsTx3ls8c0RHjy5xO4s-BehRC-96wONj7n9IzrY,11553
+biomedisa/features/amira_to_np/amira_helper.py,sha256=giuZKkX8eI_2MVAy3wwBvcmmmDxSOo8k9eAzu2QA6uo,2218
+biomedisa/features/random_walk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+biomedisa/features/random_walk/gpu_kernels.py,sha256=IQDjq1H6iJCwdS-LCWx2S6F1TMEXjrN2veLcTLCeCoI,7191
+biomedisa/features/random_walk/pycuda_large.py,sha256=Vfvd0uFRB-qLReDFKIyAAhdWDLflKMUEUAm_ZXSkPZs,32917
+biomedisa/features/random_walk/pycuda_large_allx.py,sha256=zjy1Ai8D-foXjaT-6G33vGMANS1i00BBbLCTAMUfP5c,30677
+biomedisa/features/random_walk/pycuda_small.py,sha256=rSwjq2DdtGyNGH1_EfiRQGSgEsCZqvVUrh1UN64AEc8,15786
+biomedisa/features/random_walk/pycuda_small_allx.py,sha256=z4koEQNWqy3EYOhHbMkO8sP6mpl6R7i8mM6OEQQ4kUQ,18225
+biomedisa/features/random_walk/pyopencl_large.py,sha256=q79AxG3p3qFjxfiAZfUK9I5BAYT2prq48yEEmpP1Yjk,31015
+biomedisa/features/random_walk/pyopencl_small.py,sha256=opNlS-qzOa9qWafBNJdvf6r1aRAFf7_JXf6ISDnkdXE,17068
+biomedisa/features/random_walk/rw_large.py,sha256=ZnITvk00Y11ZZlGuBRaJO1EwU0wYBdEwdpj9vvXCqF4,19805
+biomedisa/features/random_walk/rw_small.py,sha256=RPzZe24YrEwYelJukDjvqaoD_SyhgdriEi7uV3kZGXI,14881
+biomedisa-24.5.23.dist-info/LICENSE,sha256=sehayP6UhydNnmstfL4yFR3genMRdpuUh6uZVWJN1H0,14152
+biomedisa-24.5.23.dist-info/METADATA,sha256=XIEKdnTY54QTALYPtNambyN7NP7_e76S2Mo99Ubifv8,10475
+biomedisa-24.5.23.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+biomedisa-24.5.23.dist-info/top_level.txt,sha256=opsf1Eb4vCguPSxev4HHSeiUKCccT_C_RcUCdAYbHWQ,10
+biomedisa-24.5.23.dist-info/RECORD,,

biomedisa-24.5.23.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.43.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

biomedisa-24.5.23.dist-info/top_level.txt

@@ -0,0 +1 @@
+biomedisa