Skip to main content

Cell cortex segmentation in C. elegans PAR protein images

Project description

PAR Segmentation

CC BY 4.0 TensorFlow Black pre-commit Tests PyPi version Documentation Status run with docker run with conda Binder codecov

Tools for segmenting, straightening and quantifying the cortex of cells. Works by combining spline-based segmentation with a custom quantification model, using a gradient descent optimisation procedure. Designed primarily for membrane-bound PAR proteins in C. elegans zygotes.

Advantages:

  • Combine segmentation and membrane quantification in a single step
  • No ground truth training data required
  • Works for single snapshots or timelapse movies

Disadvantages:

  • Requires a small amount of manual annotation for every image
  • A little slow compared to some other segmentation methods

Instructions

As a first step, I would recommend checking out the tutorial notebook. To run the notebook interactively you have a few options:

Option 1: Binder

To run in the cloud using Binder, click here: Binder

(Please note that it may take several minutes to open the notebook)

Option 2: Docker

Step 1: Make sure Docker is installed and open on your machine

Step 2: Download and run the Docker container:

docker run --rm -p 8888:8888 tsmbland/par-segmentation

Once the Docker image has finished downloading, this will print two URLs at the bottom for you to copy and paste into your web browser to open up Jupyter (please try both)

Step 3: Navigate to scripts/Tutorial.ipynb to run the notebook

Step 4: When finished, delete the image:

docker image rm tsmbland/par-segmentation

Option 3: Conda

You can use the environment.yml file to set up a Conda environment on your machine from which the notebook can be run

conda env create -f environment.yml
conda activate par-segmentation
jupyter notebook

Installation

To explore further and incorporate into your own analysis pipelines, you can install the package using pip:

pip install par-segmentation

Methods

Starting with an initial rough manual ROI of the cell edge, the cortex of the image is straightened (Step 1). The program then attempts to mimic this straightened image by differentiable simulation (Step 2). In doing so, it learns the position of the cortex, which enables the ROI to be adjusted (Step 3) and the cortex re-straightened.

Cortex positions are modelled as a spline with a user-specified number of evenly spaced knots which are optimised by gradient descent:

Cross-cortex intensity profiles at each position around the cortex are modelled as the sum of distinct cytoplasmic and membrane signal components: an error function and Gaussian function respectively, representing the expected shape of a step and a point convolved by a Gaussian point spread function (PSF) in one dimension:

The program learns the amplitude of these two components at each position around the cortex, so can serve as a quantification tool as well as a segmentation tool:

Modelling the PSF as a Gaussian, and ignoring out-of-focus contributions, is a clear simplification of reality, but is a close enough approximation for many purposes (e.g. if you're interested in relative concentrations rather than absolute concentrations). Nevertheless, one can relax these assumptions (with some added caveats) if higher accuracy is required. See here.

Publications

This package has been used in the following publications:

To add your paper to this list, please use the issues form, or create a pull request

License

This work is licensed under a Creative Commons Attribution 4.0 International License.

CC BY 4.0

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

par_segmentation-0.1.11.tar.gz (37.3 kB view hashes)

Uploaded Source

Built Distribution

par_segmentation-0.1.11-py3-none-any.whl (41.0 kB view hashes)

Uploaded Python 3

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