mspt-toolkit

Mass-sensitive particle tracking analysis routine

https://github.com/mspt-toolkit/mspt-toolkit

Science Score: 57.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 8 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Mass-sensitive particle tracking analysis routine

Basic Info
  • Host: GitHub
  • Owner: MSPT-toolkit
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 102 KB
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 4
  • Open Issues: 1
  • Releases: 0
Created over 4 years ago · Last pushed over 3 years ago
Metadata Files
Readme License Citation

README.md

MSPT: Mass-Sensitive Particle Tracking

This toolkit provides a complete single particle tracking analysis routine for mass photometry movies, including:

  • [x] Rolling median-based background removal
  • [x] Particle detection and localization
  • [x] Linking of localizations into trajectories using trackpy
  • [x] Mean squared displacement and jump distance distribution analysis of the trajectories
  • [x] Visualizing the correlation of molecular mass and diffusion coefficient of single particles
  • [x] Fast batch-mode processing


Workflow diagram
Data analysis workflow. Reprinted from Steiert et al., J. Vis. Exp. (2022).

A detailed protocol describing the experimental and data analysis workflow can be found here:

The MSPT-toolkit was used for data analysis in:

Installation remarks

If you are new to Python, installing the Anaconda Distribution is highly recommended.

Required packages

    trackpy [`Trackpy`](http://soft-matter.github.io/trackpy/v0.5.0/) is used to link particle detections from consecutive frames into trajectories. For installation instructions, click [`here`](http://soft-matter.github.io/trackpy/v0.5.0/installation.html). fastkde or scikit-learn (for plotting)
    To compare the distributions of molecular mass and diffusion coefficient, two-dimensional kernel density estimations are generated using [`fastKDE`](https://github.com/LBL-EESA/fastkde). For installation instructions, click [`here`](https://github.com/LBL-EESA/fastkde#how-do-i-get-set-up). Alternatively, [`sklearn.neighbors.KernelDensity`](https://scikit-learn.org/stable/modules/generated/sklearn.neighbors.KernelDensity.html) could be used. bottleneck (optional but recommended, included in Anaconda)
    The package [`bottleneck`](https://bottleneck.readthedocs.io/en/latest/) speeds up the rolling median-based background removal on CPUs more than 10-fold. This option is usually faster than running the background removal on GPU. For installation instructions, click [`here`](https://bottleneck.readthedocs.io/en/latest/installing.html). CUDA version (optional)
    To be able to perform image processing on a [`CUDA-capable`](https://developer.nvidia.com/cuda-zone) GPU, [`pytorch`](https://pytorch.org/) is required. Follow the instructions [`here`](https://pytorch.org/get-started/locally/) for details regarding installation.

Usage

The data analysis workflow is integrated in the Jupyter notebook MSPT analysis.ipynb which contains descriptions about the expected input and output of each step as well as required parameters. In the complementary notebook Movie visualization.ipynb, raw or processed movies can be inspected interactively, for example to examine the membrane crowdedness or the effect of different threshold settings on particle detection.

❗ Important note

File compression needs to be turned off in the acquisition software before movies are saved to disk. Instructions on how to turn off file compression can be found in the manufacturer's user manual of the acquisition software.
If movie recordings were saved with compression and you want to recover them, please get in touch with Refeyn for a decompression module.

Owner

  • Login: MSPT-toolkit
  • Kind: user

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Steiert"
  given-names: "Frederik"
  orcid: "https://orcid.org/0000-0001-5871-8064"
- family-names: "Hundt"
  given-names: "Nikolas"
  orcid: "https://orcid.org/0000-0001-8217-671X"
title: "MSPT-toolkit"
url: "https://github.com/MSPT-toolkit/MSPT-toolkit"
preferred-citation:
  type: article
  authors:
  - family-names: "Steiert"
    given-names: "Frederik"
    orcid: "https://orcid.org/0000-0001-5871-8064"
  - family-names: "Heermann"
    given-names: "Tamara"
    orcid: "https://orcid.org/0000-0003-1607-0727"
  - family-names: "Hundt"
    given-names: "Nikolas"
    orcid: "https://orcid.org/0000-0001-8217-671X"
  - family-names: "Schwille"
    given-names: "Petra"
    orcid: "https://orcid.org/0000-0002-6106-4847"
  doi: "10.3791/63583"
  url: "https://www.jove.com/t/63583"
  journal: "Journal of Visualized Experiments"
  title: "Mass-Sensitive Particle Tracking to Characterize Membrane-Associated Macromolecule Dynamics"
  issue: "180"
  year: "2022"

GitHub Events

Total
Last Year