Skip to main content

membrane segmentation in 3D for cryo-ET

Project description

MemBrain-Seg

License PyPI Python Version CI codecov

Membrain-Seg1 is a Python project developed by teamtomo for membrane segmentation in 3D for cryo-electron tomography (cryo-ET). This tool aims to provide researchers with an efficient and reliable method for segmenting membranes in 3D microscopic images. Membrain-Seg is currently under early development, so we may make breaking changes between releases.

Publication:

Membrain-seg's current functionalities are described on more detail in our preprint.

Membrain-Seg is currently under early development, so we may make breaking changes between releases.

Version Updates

For a detailed history of changes and updates, please refer to our CHANGELOG.md.

Overview

MemBrain-seg is a practical tool for membrane segmentation in cryo-electron tomograms. It's built on the U-Net architecture and makes use of a pre-trained model for efficient performance. The U-Net architecture and training parameters are largely inspired by nnUNet2.

Our current best model is available for download here. Please let us know how it works for you. If the given model does not work properly, you may want to try one of our previous versions:

Other (older) model versions:

If you wish, you can also train a new model using your own data, or combine it with our (soon to come!) publicly-available dataset.

To enhance segmentation, MemBrain-seg includes preprocessing functions. These help to adjust your tomograms so they're similar to the data our network was trained on, making the process smoother and more efficient.

Explore MemBrain-seg, use it for your needs, and let us know how it works for you!

Preliminary documentation is available, but far from perfect. Please let us know if you encounter any issues, and we are more than happy to help (and get feedback what does not work yet).

[1] Lamm, L., Zufferey, S., Righetto, R.D., Wietrzynski, W., Yamauchi, K.A., Burt, A., Liu, Y., Zhang, H., Martinez-Sanchez, A., Ziegler, S., Isensee, F., Schnabel, J.A., Engel, B.D., and Peng, T, 2024. MemBrain v2: an end-to-end tool for the analysis of membranes in cryo-electron tomography. bioRxiv, https://doi.org/10.1101/2024.01.05.574336

[2] Isensee, F., Jaeger, P.F., Kohl, S.A.A., Petersen, J., Maier-Hein, K.H., 2021. nnU-Net: a self-configuring method for deep learning-based biomedical image segmentation. Nature Methods 18, 203-211. https://doi.org/10.1038/s41592-020-01008-z

Installation

For detailed installation instructions, please look here.

Features

Segmentation

Segmenting the membranes in your tomograms is the main feature of this repository. Please find more detailed instructions here.

Preprocessing

Currently, we provide the following two preprocessing options:

  • Pixel size matching: Rescale your tomogram to match the training pixel sizes
  • Fourier amplitude matching: Scale Fourier components to match the "style" of different tomograms
  • Deconvolution: denoises the tomogram by applying the deconvolution filter from Warp

For more information, see the Preprocessing subsection.

Model training

It is also possible to use this package to train your own model. Instructions can be found here.

Patch annotations

In case you would like to train a model that works better for your tomograms, it may be beneficial to add some more patches from your tomograms to the training dataset. Recommendations on how to to this can be found here.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

membrain_seg-0.0.4.tar.gz (82.4 kB view details)

Uploaded Source

Built Distribution

membrain_seg-0.0.4-py3-none-any.whl (93.1 kB view details)

Uploaded Python 3

File details

Details for the file membrain_seg-0.0.4.tar.gz.

File metadata

  • Download URL: membrain_seg-0.0.4.tar.gz
  • Upload date:
  • Size: 82.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for membrain_seg-0.0.4.tar.gz
Algorithm Hash digest
SHA256 d428f1bf9eec85ab8176b0b58a449bf84315c3c1f50e273544568441f434e5b7
MD5 3b6feb7505187ecaef7c69aeb5e33a75
BLAKE2b-256 b4d25023541b840df65f5513f99695bdff009b1381e93898e4da96accab4008b

See more details on using hashes here.

File details

Details for the file membrain_seg-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: membrain_seg-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 93.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for membrain_seg-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 838383a04dc1cf6ae262614ce55b03ffaff1154a63324df6f3c9f5d78205459f
MD5 972f4f940ea824ddb0f313c391e43801
BLAKE2b-256 d12b6754e69d9fd4b7497d4ca480b56eaf41d12089f5964c467605f833a5291c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page