Skip to main content

U-Net for 2D fiducial segmentation in cryo-EM

Project description

fidder

License PyPI Python Version CI codecov

fidder is a Python package for detecting and erasing gold fiducials in cryo-EM images.

Fiducials are detected using a pre-trained residual 2D U-Net at 8 Å/px. Segmented regions are replaced with white noise matching the local mean and global standard deviation of the image.

The package can be used from both Python and the command line.


Quickstart

Python

import mrcfile
import torch
from fidder.predict import predict_fiducial_mask
from fidder.erase import erase_masked_region

# load your image
image = torch.tensor(mrcfile.read('my_image_file.mrc'))

# use a pretrained model to predict a mask
mask, probabilities = predict_fiducial_mask(
    image, pixel_spacing=1.35, probability_threshold=0.5
)

# erase fiducials
erased_image = erase_masked_region(image=image, mask=mask)

Command Line

# predict fiducial mask
fidder predict \
--input-image example.mrc \
--probability-threshold 0.5 \
--output-mask mask.mrc

# erase masked region
fidder erase \
--input-image example.mrc \
--input-mask mask.mrc \
--output-image erased.mrc

Installation

pip:

pip install fidder

Compatibility

If trying to use an 10.X CUDA runtime you may have to install older versions of torch and pytorch-lightning, see teamtomo/fidder#17 for details.

Notes

This package provides similar functionality to BoxNet from Warp when retrained for gold fiducial segmentation.

This package was developed to make this functionality available in a standalone, easy to install Python package. The architecture and training data preprocessing are based on the description in the Warp paper.

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

fidder-0.0.8.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

fidder-0.0.8-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

Details for the file fidder-0.0.8.tar.gz.

File metadata

  • Download URL: fidder-0.0.8.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for fidder-0.0.8.tar.gz
Algorithm Hash digest
SHA256 09a3c82006b719a43250a72aa48c046b39459da529266336dcf0c8ebc010b5c2
MD5 818808a0697f1da2ec3dd44760a22804
BLAKE2b-256 5911ed509f30ddd9a0eeb1008024fc7c61f216a51659dcb9a20256441ed9cd0c

See more details on using hashes here.

Provenance

File details

Details for the file fidder-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: fidder-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 24.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.3

File hashes

Hashes for fidder-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 b4ebbdd89f1e7cefde0d06779d3216b6370996989c68caffc3ca2f4efd8fabc4
MD5 c653aa802a4d6d4b07bfd01d63da5cab
BLAKE2b-256 759b01f49d68f1b18f28bef2569050924d0b0427fe3a0a50b122dc6e02bfcc97

See more details on using hashes here.

Provenance

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