Skip to main content

CarbOn FIlm detector for cryo-EM images

Project description

cryoCOFI

Overview

cryoCOFI (CarbOn FIlm detector for cryo-EM images) is a script designed for cryo-EM images & cryo-ET tomograms to detect carbon films and get rid of particles inside them.

Features

  • Carbon film detection and particle screening in cryo-EM images
  • Improved algorithm for edge detection (Bilateral filter + Canny detector, aka Bicanny)
  • Integration with Dynamo data formats (.doc and .tbl files)
  • GPU-accelerated image processing using CuPy and CUDA

Requirements

  • Python 3.9+
  • CUDA-compatible GPU, >=12.2
  • CuPy, >=13.3.0
  • NumPy, >=2.0.2
  • pandas, >=2.2.3

Installation

Via git clone

  1. Clone the repository:

    git clone https://github.com/ZhenHuangLab/cryoCOFI.git
    
  2. Navigate to the project directory:

    cd cryoCOFI
    
  3. Install the package:

    pip install .
    

Via pip

pip install cryoCOFI

Usage

cryoCOFI can be used as a command-line tool:

cryoCOFI [command] [options]

Available commands:

  • readmrc: Process a single MRC file
  • readdynamo: Process Dynamo .doc and .tbl files

For detailed usage instructions, run:

cryoCOFI [command] --help

License

This script is licensed under GPLv3.

Contributing

Contributions to cryoCOFI are welcome! Please feel free to submit a Pull Request.

Contact

For questions or support, please contact: zhen.victor.huang@gmail.com

For more information, visit: https://github.com/ZhenHuangLab/cryoCOFI

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

cryocofi-0.1.1.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

cryoCOFI-0.1.1-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file cryocofi-0.1.1.tar.gz.

File metadata

  • Download URL: cryocofi-0.1.1.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for cryocofi-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c5229f9403660fc35a211bc3e3d4a38649a01776070ec313d538be9f4f3fd70f
MD5 4b8984fb873e7657b416c209b5bfdeff
BLAKE2b-256 17f58a8b3d50dab54830c318695351d3181a967462d6bb13651b840d104dfe14

See more details on using hashes here.

File details

Details for the file cryoCOFI-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: cryoCOFI-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for cryoCOFI-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe0d8ec216f59e1164473ad23a62c402e76aa3f9d46b9a9900ac74c3ce043038
MD5 a3b09ca0f448771c884caf29f151525a
BLAKE2b-256 d9a719142810d001cb8bb6c36a7e500409393bff7f6862c483dc33380c4befc0

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