Skip to content
Snippets Groups Projects
Commit a86f5a07 authored by Marion  LOUVEAUX's avatar Marion LOUVEAUX
Browse files

Merge branch 'new-readme' into 'master'

Add information to the README

See merge request !1
parents f8d49c11 646bcb60
No related branches found
No related tags found
1 merge request!1Add information to the README
# ROI intensity evolution
<!-- badges: start -->
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Twitter](https://img.shields.io/twitter/follow/Icy_BioImaging?style=social)](https://twitter.com/Icy_BioImaging)
[![Image.sc forum](https://img.shields.io/badge/discourse-forum-brightgreen.svg?style=flat)](https://forum.image.sc/tag/icy)
<!-- badges: end -->
This is the repository for the source code of *ROI intensity evolution*, a plugin for the [bioimage analysis software Icy](http://icy.bioimageanalysis.org/), which was developed by members or former members of the [Biological Image Analysis unit at Institut Pasteur](https://research.pasteur.fr/en/team/bioimage-analysis/). This plugin is licensed under GPL3 license.
Icy is developed and maintained by [Biological Image Analysis unit at Institut Pasteur](https://research.pasteur.fr/en/team/bioimage-analysis/). The [source code of Icy](https://gitlab.pasteur.fr/bia/icy) is also licensed under a GPL3 license.
## Plugin description
<!-- Short description of goals of package, with descriptive links to the documentation website -->
Compute and display the intensity evolution for regions of interests (ROIs) through time. Results can be refreshed automatically as ROIs are changed.
Multiple channels are handled separately. Multiple criteria can be computed: mean intensity in the ROI, total intensity, variance, median, etc.
The results are displayed in a dedicated GUI and can be exported to some Excel files.
A more detailed user documentation can be found on the ROI intensity evolution documentation page on the Icy website: http://icy.bioimageanalysis.org/plugin/roi-intensity-evolution/
## Installation instructions
For end-users, refer to the documentation on the Icy website on [how to install an Icy plugin](http://icy.bioimageanalysis.org/tutorial/how-to-install-an-icy-plugin/).
For developers, see our [Contributing guidelines](https://gitlab.pasteur.fr/bia/icy/-/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://gitlab.pasteur.fr/bia/icy/-/blob/master/CODE-OF-CONDUCT.md).
<!-- Here we should have some explanations on how to fork this repo (for an example see https://gitlab.pasteur.fr/bia/wellPlateReader). Add any info related to Maven etc. How the project is build (for an example see https://gitlab.pasteur.fr/bia/wellPlateReader). 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.nchenouard.roiintensityevolution.ROIIntensityEvolution`
## 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](https://www.nature.com/articles/nmeth.2075), 9, pp. 690-696
http://icy.bioimageanalysis.org
## Author(s)
Nicolas Chenouard, Stephane Dallongeville
## Additional information
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment