Skip to main content

Napari plugin to manually correct epithelia segmentation in movies

Project description

EpiCure

License BSD-3 PyPI Python Version napari hub DOI



Napari plugin to ease manual correction of epithelia segmentation in movies.



To analyse individual cell trajectory from epithelia movies marked for cell-cell junctions, a very precise segmentation and tracking is required. Several tools such as TissuAnalyzer, Epyseg, CellPose or Dist2Net perform very good segmentation (~5% of errors). However, this still implies a high amount of cells to correct manually.

EpiCure allows to decrease the burden of this task. Several features are proposed to ease the manual correction of the segmented movies, such as error detection, numerous shortcuts for editing the segmentation, option for tracking, display and measure/export options. EpiCure detect segmentation errors by taking advantage of temporal information. When a correction is done at a given frame, EpiCure relink the track to adjust for the changes.

See the full documentation here

EpiCure interface

Installation

Install plugin

To install EpiCure on a fresh python virtual environment, type inside the environement:

pip install epicure

Then launch Napari, and the plugin should be visible in the Plugins list.

If you already have an environment with Napari installed, you can also install it directly in Napari>Plugins>Install/Uninstall plugins

Install code

To have the code to be able to modify it, clone this repository. You can use pip install -e . so that everytime you update the code, the plugin will be updated.

Dependencies

The input files of EpiCure can be already tracked or not. Tracking options are proposed in EpiCure:

  • Laptrack centroids
  • Laptrack overlaps

Usage

Refer to the documentation for documentation of the different steps possible in the pipeline.

References

If you use EpiCure, thank you for citing our work:

EpiCure is not published yet, you can cite it using Zenodo for now: https://doi.org/10.5281/zenodo.13952184

Dataset

The dataset presented in our main EpiCure publication is available on zenodo: 10.5281/zenodo.20607705.

Contributing and Feedback

EpiCure is mainly developed in CNRS UMR3738, in the Developmental and Stem Cell Biology Department of Institut Pasteur. If you have a question on using EpiCure or ask to add a feature, either file an issue or write in the imagesc forum.

Any contribution is most welcome. Do not hesitate to contact us beforehand through filing an issue (choose "Other questions/comments" type). To suggest the addition of a new feature, you can also contact us by filing an issue choosing the "Feature request" option.

If you encounter a code related issue using EpiCure, please file an issue in this repository.

To facilitate contributions, we added a pixi file in the repository. Developers can run:

  • pixi run build to install locally the plugin and test it manually
  • pixi run test to run locally the tests from the src/tests directory
  • pixi run build-doc to locally build the documentation pages. The documentation will be build in the site folder in the repository. The file site\index.html can be open in a browser to see the generated documentation.

The code API can be found here in the online documentation. Examples of using EpiCure without opening the interface can be found in the test files and the repository notebooks.

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

epicure-1.6.1.tar.gz (2.1 MB view details)

Uploaded Source

Built Distribution

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

epicure-1.6.1-py3-none-any.whl (147.5 kB view details)

Uploaded Python 3

File details

Details for the file epicure-1.6.1.tar.gz.

File metadata

  • Download URL: epicure-1.6.1.tar.gz
  • Upload date:
  • Size: 2.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.0 CPython/3.10.12

File hashes

Hashes for epicure-1.6.1.tar.gz
Algorithm Hash digest
SHA256 148a95ae0d71385001f71adbef2e1b324d44c458fe6e9821bf6a6ec336974f4c
MD5 3685cfbb4d030774828f08fa0a0be09e
BLAKE2b-256 ca376ba05d84a5a988ef3603f3ac4b2c7d50f58b6fad491fd35e633bce269770

See more details on using hashes here.

File details

Details for the file epicure-1.6.1-py3-none-any.whl.

File metadata

  • Download URL: epicure-1.6.1-py3-none-any.whl
  • Upload date:
  • Size: 147.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.0 CPython/3.10.12

File hashes

Hashes for epicure-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 62c4f8afb4a0581b6dba6c4c9c6dcbcc732f421ec464c0948914b7e01782b713
MD5 416b3dca55f467ded9638ed7be98136f
BLAKE2b-256 52809f2321032dad6989565c24a87da88b1f010825e61f55c5e3c51b3146816c

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