Skip to main content

Automatic Cut Detector

Project description

Cut Detector

License BSD-3 PyPI Python Version codecov napari hub tests

Automatic micro-tubule cut detector.

Code associated to the paper "Cut-Detector: A Tool for Automated Temporal Analysis of Late Cytokinetic Events" available from bioRxiv.

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.

Citation

If you found our work useful, please consider citing:

@article{bonte2025cut,
  title={Cut-Detector: A Tool for Automated Temporal Analysis of Late Cytokinetic Events},
  author={Bonte, Thomas and Dubois, Lucas and Gagna, Paul and Dibsy, Rayane and Petrovi{\'c}, An{\dj}ela and Advedissian, Tamara and Serres, Murielle and Cuvelier, Fr{\'e}d{\'e}rique and Crouigneau, Marie and Sassoon, Nathalie and others},
  journal={bioRxiv},
  pages={2025--06},
  year={2025},
  publisher={Cold Spring Harbor Laboratory}
}

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.6.tar.gz (337.2 kB view details)

Uploaded Source

Built Distribution

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

cut_detector-1.6.6-py3-none-any.whl (95.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cut_detector-1.6.6.tar.gz
  • Upload date:
  • Size: 337.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for cut_detector-1.6.6.tar.gz
Algorithm Hash digest
SHA256 24e64747a47b280e6d671abd76d5cb9d1b4fb67a928c58989518d791cd0f3711
MD5 d753585cb10a52f9c3af4e4742c969e7
BLAKE2b-256 7f901e411b992928963fdfbd35f7aef43986825cc11dce5f286abd5a2975a9bf

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cut_detector-1.6.6-py3-none-any.whl
  • Upload date:
  • Size: 95.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for cut_detector-1.6.6-py3-none-any.whl
Algorithm Hash digest
SHA256 9ac67f4b30edadde2d015e5ee3552f99f3925afd64492a69256bf731c53c955f
MD5 0a9e07b6f1941926fc5e56c713ca4e09
BLAKE2b-256 3c4ef5eefc59cf3e87624a154400fb48a07d6ec793c2750589e167f96f8bac0e

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