Skip to main content

Automatic Cut Detector

Project description

Cut Detector

License BSD-3 PyPI Python Version tests codecov napari hub

Automatic micro-tubule cut detector.

https://github.com/user-attachments/assets/2af2e1a6-adf9-4d63-a353-e190c4814d83


This napari plugin was generated with Cookiecutter using @napari's cookiecutter-napari-plugin template.

Your browser does not support the video tag.

Installation

Conda environment

It is highly recommended to create a dedicated conda environment, by following these few steps:

  1. Install an Anaconda distribution of Python. Note you might need to use an anaconda prompt if you did not add anaconda to the path.

  2. Open an Anaconda prompt as admin to create a new environment using conda. We advice to use python 3.10 and conda 23.10.0, to get conda-libmamba-solver as default solver.

conda create --name cut_detector python=3.10 conda=23.10.0
conda activate cut_detector

Package installation

Once in a dedicated environment, our package can be installed via pip:

pip install cut_detector

Alternatively, you can clone the github repo to access to playground scripts.

git clone https://github.com/15bonte/cut-detector.git
cd cut-detector
pip install -e .

GPU

We highly recommend to use GPU to speed up segmentation. To use your NVIDIA GPU, the first step is to download the dedicated driver from NVIDIA.

Next we need to remove the CPU version of torch:

pip uninstall torch

The GPU version of torch to be installed can be found here. You may choose the CUDA version supported by your GPU, and install it with conda. This package has been developed with the version 11.6, installed with this command:

conda install pytorch==1.12.1 torchvision pytorch-cuda=11.6 -c pytorch -c nvidia

Update

To update cut-detector to the latest version, open an Anaconda prompt and use the following commands:

conda activate cut_detector
pip install cut-detector --upgrade

Definitions

Each detected cell division is labeled with one of the following categories:

  • NORMAL: Division happening as expected, where (at least) 1 micro-tubule cut is detected.
  • NO_MID_BODY_DETECTED: Along the cell division, no mid-body was detected on the MKLP1 channel. This category encompasses different cases: the detection may have failed, the mid-body may not express the fluorescence, or this may not actually be a division.
  • MORE_THAN_TWO_DAUGHTER_TRACKS: Tripolar division. This category encompasses both actual tripolar divisions and wrong identifications of daughter cells (mainly caused by segmentation issues).
  • NEAR_BORDER: Division close to the border of the image, hence ignored as it is likely to be difficult to detect micro-tubule cuts. A division is classified as NEAR_BORDER as soon as the distance between 1 detected mid-body and the border of the image is less than 20px.
  • NO_CUT_DETECTED: Division whose mid-body was detected, but with all micro-tubule bridges classified as "No cut". Likely to be at the end of the video, cells dying before the end of division, or cells going out of frame.
  • TOO_SHORT_CUT: First micro-tubule cut detected before or at 50 minutes. Ignored as this is very unlikely, so it is probably caused by a wrong division detection.

Division movies start at the maximum between:

  • Mother cell start frame
  • 10 frames before the end of metaphase

Division movies end at the minimum between:

  • Last frame of any of the daughter cells
  • Metaphase of any of the daughter cells

Contributing

Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.

Scripts required to improve any of Cut Detector tasks can be found in the folder developers.

License

Distributed under the terms of the BSD-3 license, "cut-detector" is free and open source software

Issues

If you encounter any problems, please file an issue along with a detailed description.

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

cut_detector-1.6.5.tar.gz (334.7 kB view details)

Uploaded Source

Built Distribution

cut_detector-1.6.5-py3-none-any.whl (92.5 kB view details)

Uploaded Python 3

File details

Details for the file cut_detector-1.6.5.tar.gz.

File metadata

  • Download URL: cut_detector-1.6.5.tar.gz
  • Upload date:
  • Size: 334.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for cut_detector-1.6.5.tar.gz
Algorithm Hash digest
SHA256 d5698904a67dac95baa86bbfd53cac3c2c539ea741470c0ac030f1682acf2ea5
MD5 eba24c49a91d3954b7cedca32cfd0e71
BLAKE2b-256 77fdbbda2e0fab551300d6f96947362a32ff119a03fffafaddf7ebf821e6b545

See more details on using hashes here.

File details

Details for the file cut_detector-1.6.5-py3-none-any.whl.

File metadata

  • Download URL: cut_detector-1.6.5-py3-none-any.whl
  • Upload date:
  • Size: 92.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for cut_detector-1.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fdf49874f16feb1231a97c7bdc1263280ad8aa042e42fae416f429447b442503
MD5 8443d70a3effff88e266d839253dd010
BLAKE2b-256 78cdf8f9d49ba4c99b5d899e17f2881068d354ea79182d2390ed251cafa73839

See more details on using hashes here.

Supported by

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