diff --git a/README.md b/README.md index ac07817c2027ab99f714c56b361cc18e615ff04b..4264f3079d07ea2a217abca07326df4134a38e5c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,62 @@ -# Path Profiler +# Path Intensity Profil + +<!-- badges: start --> +[](https://www.gnu.org/licenses/gpl-3.0) +[](https://twitter.com/Icy_BioImaging) +[](https://forum.image.sc/tag/icy) +<!-- badges: end --> + +This is the repository for the source code of *Path Intensity Profil*, 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 --> + +This plugin will compute the intensity profile of ROI contour along Z (3D) and T (timelaps) dimension. It generates a workbook document containing all the intensity values for each point of the contour which can be displayed as graph or exported in XLSX / CSV format. +The plugin is compatible with Protocols. +A more detailed user documentation can be found on the Path Intensity Profil documentation page on the Icy website: http://icy.bioimageanalysis.org/plugin/path-intensity-profil/ + + +## 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.stef.roi.quantify.PathIntensityProfiler` + + + +## 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) + +Stephane Dallongeville + + +## Additional information + + + + +