Skip to main content

Particle Picking of Cryo-EM Datasets

Project description

PyPI Downloads Python 3.11+ License: MIT PyPI version DOI Code style: black Tests codecov Documentation Documentation Status

cryoblob

cryoblob is a JAX-based, JIT-compiled, scalable package for detection of amorphous blobs in low SNR cryo-EM images. It provides both traditional circular blob detection and advanced multi-method detection for complex morphologies including elongated objects and overlapping structures.

Features

  • JAX-powered: Leverages JAX for high-performance computing with automatic differentiation
  • GPU acceleration: Can utilize both CPUs and GPUs for processing
  • Multi-method detection: Advanced detection algorithms for diverse blob morphologies:
    • Traditional LoG: Excellent for circular blobs
    • Ridge detection: Specialized for elongated (pill-shaped) objects
    • Watershed segmentation: Separates overlapping circular structures
    • Hessian-based detection: Superior boundary localization
  • Adaptive filtering: Includes adaptive Wiener filtering and thresholding
  • Batch processing: Memory-optimized batch processing for large datasets
  • Validation: Comprehensive parameter validation using Pydantic models

Installation

pip install cryoblob

Quick Start

Basic Blob Detection

import cryoblob as cb

# Load an MRC file
mrc_image = cb.load_mrc("your_file.mrc")

# Traditional circular blob detection
blobs = cb.blob_list_log(mrc_image)

# Process a folder of images
results = cb.folder_blobs("path/to/folder/")

# Plot results
cb.plot_mrc(mrc_image)

Enhanced Multi-Method Detection

# For complex scenarios with multiple blob types
circular, elongated, overlapping = cb.enhanced_blob_detection(
    mrc_image,
    use_ridge_detection=True,    # Detect elongated objects
    use_watershed=True           # Separate overlapping blobs
)

print(f"Found {len(circular)} circular, {len(elongated)} elongated, "
      f"and {len(overlapping)} overlapping blobs")

Specialized Detection

from cryoblob.valid import (create_elongated_objects_pipeline, 
                           create_overlapping_blobs_pipeline,
                           create_comprehensive_pipeline)

# For elongated (pill-shaped) objects
config = create_elongated_objects_pipeline()
_, elongated_blobs, _ = cb.enhanced_blob_detection(mrc_image, **config.to_enhanced_kwargs())

# For overlapping circular structures  
config = create_overlapping_blobs_pipeline()
circular, _, separated_blobs = cb.enhanced_blob_detection(mrc_image, **config.to_enhanced_kwargs())

# For comprehensive analysis (all methods)
config = create_comprehensive_pipeline()
all_results = cb.enhanced_blob_detection(mrc_image, **config.to_enhanced_kwargs())

Detection Methods

Blob Type Method Best For Key Function
Circular LoG Standard round particles blob_list_log()
Elongated Ridge Detection Pill-shaped, rod-like objects ridge_detection()
Overlapping Watershed Touching circular structures watershed_segmentation()
Mixed/Complex Enhanced Detection Multiple morphologies enhanced_blob_detection()

Package Structure

The cryoblob package is organized into the following modules:

  • adapt: Adaptive image processing with gradient descent optimization
  • blobs: Core blob detection algorithms and preprocessing
  • files: File I/O operations and batch processing
  • image: Basic image processing functions (filtering, resizing, etc.)
  • multi: Multi-method detection for elongated objects and overlapping blobs
  • plots: Visualization functions for MRC images and results
  • types: Type definitions and PyTree structures
  • valid: Parameter validation using Pydantic models

Use Cases

Standard Cryo-EM Particles

# Traditional circular blob detection
blobs = cb.blob_list_log(mrc_image, min_blob_size=5, max_blob_size=20)

Elongated Biological Structures

# Detect pill-shaped, rod-like, or filamentous objects
_, elongated, _ = cb.enhanced_blob_detection(
    mrc_image, use_ridge_detection=True, use_watershed=False
)

Overlapping or Touching Particles

# Separate overlapping circular structures
_, _, separated = cb.enhanced_blob_detection(
    mrc_image, use_ridge_detection=False, use_watershed=True
)

Complex Heterogeneous Samples

# Comprehensive analysis for mixed morphologies
circular, elongated, overlapping = cb.enhanced_blob_detection(
    mrc_image, use_ridge_detection=True, use_watershed=True
)

Performance

  • Memory Efficient: Automatic batch size optimization and memory management
  • Scalable: Multi-device and multi-host processing support
  • Fast: JIT compilation and GPU acceleration where available
  • Flexible: Selective method usage to optimize speed vs. comprehensiveness

Package Organization

  • The codes are located in /src/cryoblob/
  • The notebooks are located in /tutorials/

Documentation

For detailed API documentation and tutorials, visit: https://cryoblob.readthedocs.io

License

This project is licensed under the MIT License - see the LICENSE file for details.

Authors

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

cryoblob-2025.8.2.tar.gz (39.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cryoblob-2025.8.2-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

Details for the file cryoblob-2025.8.2.tar.gz.

File metadata

  • Download URL: cryoblob-2025.8.2.tar.gz
  • Upload date:
  • Size: 39.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for cryoblob-2025.8.2.tar.gz
Algorithm Hash digest
SHA256 7815e7b1110c3626b4bc071038e0ea1f6588ac828ff5fa5e933f37f0b990fd49
MD5 e5adfa4e565c856125d0d3b7d194ad41
BLAKE2b-256 b4c0b7f0417be97231f8a4b151db699451be47585b88b70b9348c98dec598516

See more details on using hashes here.

File details

Details for the file cryoblob-2025.8.2-py3-none-any.whl.

File metadata

  • Download URL: cryoblob-2025.8.2-py3-none-any.whl
  • Upload date:
  • Size: 48.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.11

File hashes

Hashes for cryoblob-2025.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1329365e0e398a19938e311b637d110a3b21f88dc1aa95d97b0e52652e0f50e6
MD5 0ac8fc6498975d601fd83788c063b079
BLAKE2b-256 c567d8cc2d64f16ecef1fc545177a5572f2cfd4f1bb92bfc041d06e1fc7738be

See more details on using hashes here.

Supported by

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