This is the repository for the source code of *Timestamp Overlay*, 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 -->
Displays a customizable time stamp over a 2D sequence.
<ahref="https://link.springer.com/chapter/10.1007%2F978-3-030-44826-4_25">This book chapter</a> proposes a <strong><ahref="https://link.springer.com/chapter/10.1007%2F978-3-030-44826-4_25#SupplementaryMaterial">video tutorial</a></strong> on the TimeStamp Overlay plugin (see tutorial 1). Images used in the tutorial are available on <ahref="https://zenodo.org/record/3594363#.Xti6AsA6-Uk">this Zenodo repository</a>.
A more detailed user documentation can be found on the Timestamp Overlay documentation page on the Icy website: http://icy.bioimageanalysis.org/plugin/timestamp-overlay/
## 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.fab.timestamp.Timestamp`
## 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
