Commit 285e98cd authored by Marion  LOUVEAUX's avatar Marion LOUVEAUX
Browse files

Update README new-readme complete case when there is no README at all

parent 8757e304
\ No newline at end of file
# Active Contour
<!-- badges: start -->
[![License: GPL v3](](
[![ forum](](
<!-- badges: end -->
This is the repository for the source code of *Active Contour*, a plugin for the [bioimage analysis software Icy](, which was developed by members or former members of the [Biological Image Analysis unit at Institut Pasteur]( This plugin is licensed under GPL3 license.
Icy is developed and maintained by [Biological Image Analysis unit at Institut Pasteur]( The [source code of Icy]( is also licensed under a GPL3 license.
## Plugin description
<!-- Short description of goals of package, with descriptive links to the documentation website -->
Automatically segment the boundary of a nucleus or cell starting from an approximate ROI. It supports 2D and 3D processing and tracking of slowly moving cells. Ideal to study cell morphodynamics.
<a href="">This book chapter</a> proposes a <strong>step-by-step tutorial for the Active Contours plugin</strong> with <a href="">video tutorials</a> (see tutorial 3 to 5). Images used in the tutorial are available on <a href="">this Zenodo repository</a>.
<strong>If you use this plugin in your work, please cite the following reference</strong>: "Dufour et al., IEEE Transactions on Image Processing, 2011". This reference describes the 3D version of the algorithm, but the 2D version works exactly the same.
A more detailed user documentation can be found on the Active Contour documentation page on the Icy website:
## Installation instructions
For end-users, refer to the documentation on the Icy website on [how to install an Icy plugin](
For developers, see our [Contributing guidelines]( and [Code of Conduct](
<!-- Here we should have some explanations on how to fork this repo (for an example see Add any info related to Maven etc. How the project is build (for an example see Any additional setup required (authentication tokens, etc). -->
## Main functions and usage
<!-- list main functions, explain architecture, classname, give info on how to get started with the plugin. If applicable, how the package compares to other similar packages and/or how it relates to other packages -->
Classname: `plugins.adufour.activecontours.ActiveContours`
## Citation
Please cite this plugins as follows:
Please also cite the Icy software and mention the version of Icy you used (bottom right corner of the GUI or first lines of the Output tab):
de Chaumont, F. et al. (2012) Icy: an open bioimage informatics platform for extended reproducible research, [Nature Methods](, 9, pp. 690-696
## Author(s)
Alexandre Dufour, Daniel Felipe González Obando, Vannary Meas-Yedid, Stephane Dallongeville
## Additional information
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment