Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 8.83 KB

README.md

File metadata and controls

80 lines (60 loc) · 8.83 KB

CiliaQ

A set of three ImageJ plugins to quantify ciliary shape, length, and fluorescence in 2D, 3D, and 4D images. Scroll down for information on how to use, cite, report ideas, issues, improve CiliaQ. Visit our CiliaQ wiki with Tutorials and a Q&A section or try out CiliaQ using an example image.

The ImageJ plugins are published along:

Jan N. Hansen, Sebastian Rassmann, Birthe Stueven, Nathalie Jurisch-Yaksi, Dagmar Wachten. CiliaQ: a simple, open-source software for automated quantification of ciliary morphology and fluorescence in 2D, 3D, and 4D images. Eur. Phys. J. E 44, 18 (2021). https://doi.org/10.1140/epje/s10189-021-00031-y

Included tools (ImageJ plugins)

  • CiliaQ_Preparator: An ImageJ plugin to preprocess and segment images for CiliaQ analysis.
  • CiliaQ_Editor: An ImageJ plugin to edit the segmented channel in images output by CiliaQ_Preparator before analysis with CiliaQ.
  • CiliaQ: An ImageJ plugin to quantify the ciliary shape, length, and fluorescence in images that were pre-processed with CiliaQ_Preparator (and eventually edited with CiliaQ_Editor).

Tools for post-hoc analysis of the output data

See our R scripts for combining results produced with CiliaQ.

How to cite?

When using any of the CiliaQ plugins, please cite:

Jan N. Hansen, Sebastian Rassmann, Birthe Stueven, Nathalie Jurisch-Yaksi, Dagmar Wachten. CiliaQ: a simple, open-source software for automated quantification of ciliary morphology and fluorescence in 2D, 3D, and 4D images. Eur. Phys. J. E 44, 18 (2021). https://doi.org/10.1140/epje/s10189-021-00031-y

Copyright notice and contacts

Copyright (C) 2017-2024: Jan N. Hansen.

CiliaQ has been developed in the research group Biophysical Imaging, Institute of Innate Immunity, Bonn, Germany (https://www.iiibonn.de/dagmar-wachten-lab/dagmar-wachten-lab-science).

The project was mainly funded by the DFG priority program SPP 1726 "Microswimmers".

Contacts:

  • jan.hansen (at) uni-bonn.de
  • dwachten (at) uni-bonn.de

Using CiliaQ

Getting started

For information on hardware and software requirements and a guide on how to get CiliaQ running on your computer, please follow the installation instructions in the CiliaQ Wiki.

User Guide / Manual

A very detailed User Guide for the whole CiliaQ pipeline is available here as a PDF. Please also take a look at the tutorials, instructions, examples, and Q&As in the CiliaQ wiki.

How to stay up-to-date?

You want to be always up-to-date about CiliaQ and get news on CiliaQ (new features, updates, etc.)? Watch this repository on GitHub (see Watch button on upper right) or send an email with "Subscribe CiliaQ" to jan.hansen (at) uni-bonn.de.

Ideas? Missing functions? Issues? Bugs? Unclear in the User Guide?

Are you missing a function or a parameter in CiliaQ? Is an explanation missing in the User Guide? Are you encountering problems with CiliaQ?

Please let us know and report this by submitting an issue using the issue tracking systems for the github repositories or sending a message to jan.hansen (at) uni-bonn.de:

Source code

The source code for the individual ImageJ plugins and java tools is available at the respective repositories:

Licenses

The three CiliaQ plugins are published under the GNU General Public License v3.0.

Some CiliaQ plugins include packages developed by others, for which different licenses may apply:

Some functions of CiliaQ Preparator (Hysteresis thresholding, Canny3D) require additional installation of the '3D ImageJ Suite' to your ImageJ / FIJI distribution. The '3D ImageJ Suite' is licensed via a GPL - for license details visit the main page of the '3D ImageJ Suite'.

Publications presenting an analysis based on CiliaQ