Skip to main content

PhotoFiTT: Phototoxicity Fitness Time Trial. Python package for assessing phototoxicity in live-cell microscopy experiments.

Project description

License Contributors GitHub stars GitHub forks

PhotoFiTT: Phototoxicity Fitness Time Trial

A Quantitative Framework for Assessing Phototoxicity in Live-Cell

General description of the workflow

PhotoFiTT was designed to quantitatively analyse the impact that fluorescence light excitation has in cell behaviour. PhotoFiTT focuses on three different measurements: (1) Identified pre-mitotic cells, (2) Cell size dynamics and (3) Cell activity. These are the steps to follow to replicate the analysis:

Deep learning based analysis

Follow these steps to detect cells and pre-mitotic rounding events in the data.

  1. Cell Detection and Quantification (deep learning-based image analysis: This processing is only applied to the first time point of each video.
    • Virtual Staining: Use ZeroCostDL4Mic/DL4MicEverywhere Pix2Pix notebook to train a virtual staining model that infers cell nuclei. Analyse the first frame of each video.
    • Nuclei Segmentation: Use ZeroCostDL4Mic/DL4MicEverywhere 2D StarDist notebook to apply the pretrained StarDist-versatile model to segment individual nuclei in the virtually stained images.
    • Initial Cell Quantification: Count the number of detected nuclei (Use notebook XXXXX.ipnynb to generate a CSV file with the counts). The number of detected nuclei serves as the baseline cell count for each field of view, enabling tracking of population dynamics over time.
  2. Pre-mitotic Cell Identification (deep learning-based image analysis):
    • For CHO cells imaged with brightfield, you can use our trained StarDist model. Otherwise, manually annotate a representative image set and train a new StarDist model using the corresponding ZeroCostDL4Mic/DL4MicEverywhere notebooks.

Image data Analysis

  1. Cell Size Analysis and Classification XXXXX.ipnynb
  2. Quantification of Cellular Activity XXXXX.ipnynb

Data structure

  1. The masks and the raw input, should be equally organised by folders, each folder for each condition to be analysed in a hierarchical manner. For example:
     -Raw-images (folder)
     |
     |--Biological-replica-date-1 (folder) [Subcaegory-00]
         |
         |--Cell density / UV Ligth / WL 475 light [Subcategory-01] 
            |
            |-- control-condition (folder) [Subcategory-02] 
            |    |  file1.tif
            |    |  file2.tif
            |    |  ...
            |
            |-- condition1 (folder) [Subcategory-02] 
            |    |  file1.tif
            |    |  file2.tif
            |    |  ...
            |
            |-- condition2 (folder) [Subcategory-02] 
            |    |  file1.tif
            |    |  file2.tif
            |    |  ...
         |
         |--Cell density / UV Ligth / WL 475 light [Subcategory-01]
         ...
     -Masks (folder)
     |
     |--Biological-replica-date-1 (folder) [Subcaegory-00]
         |
         |--Cell density / UV Ligth / WL 475 light [Subcategory-01] 
            |
            |-- control-condition (folder) [Subcategory-02] 
            |    |  file1.tif
            |    |  file2.tif
            |    |  ...
            |
            |-- condition1 (folder) [Subcategory-02] 
            |    |  file1.tif
            |    |  file2.tif
            |    |  ...
            |
            |-- condition2 (folder) [Subcategory-02] 
            |    |  file1.tif
            |    |  file2.tif
            |    |  ...
         |
         |--Cell density / UV Ligth / WL 475 light [Subcategory-01]
         ...
    

Package installation

  • The code provides an environment.yaml file to create a conda environment with all the dependencies needed. Place your terminal in the photofitt folder. Use either conda or mamba:

    git clone https://github.com/HenriquesLab/photofitt.git
    cd photofitt
    mamba env create -f environment.yml  
    mamba activate photofitt
    
  • ONCE PUBLISHED You can now install the package using pip install or conda as follows:

    • pip install photofitt
      
      or
    • conda install photofitt
      
  • Meanwhile:

    • git clone https://github.com/HenriquesLab/photofitt.git
      cd photofitt
      python setup.py
      
      or
    • git clone https://github.com/HenriquesLab/photofitt.git
      cd photofitt
      pip install .
      
      or
    • git clone https://github.com/HenriquesLab/photofitt.git
      cd photofitt
      conda build conda-recipe/meta.yaml
      

Common error messages

  • Error messages with lxml. Most probably you need to update developers tools in your system. Before anything, run in Mac M1:

    ```
    xcode-select --install
    ```
    
  • If you were in Linux, you can run
    • sudo apt-get update
      sudo apt-get install libxml2-dev libxslt-dev python-dev
      

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

photofitt-1.0.1.tar.gz (26.8 kB view details)

Uploaded Source

File details

Details for the file photofitt-1.0.1.tar.gz.

File metadata

  • Download URL: photofitt-1.0.1.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.0

File hashes

Hashes for photofitt-1.0.1.tar.gz
Algorithm Hash digest
SHA256 a0afcbde1cc66a77915d3553f22f471af6ea9fadde8a9d9c1c1a8494d4784466
MD5 39bdb03e87738564d7e0ef05abfc7fc7
BLAKE2b-256 966eb49b1d3cd51c70ae094e769a26b84627c53492216493e1b8cf9f82abebf2

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