Skip to content

Latest commit

 

History

History
150 lines (99 loc) · 6.11 KB

README.md

File metadata and controls

150 lines (99 loc) · 6.11 KB
Raw

AQuA Logo

AQuA (Astrocyte Quantification and Analysis) is a tool to detect signalling events from microscopic time-lapse imaging data of astrocytes or other cell types. The algorithm is data-driven and based on machine learning principles, so, potentially, it can be applied across model organisms, fluorescent indicators, experimental modes, cell types, and imaging resolutions and speeds. If you have any feedback or issue, you can either post issue here or send email to Guoqiang Yu ([email protected]).

More about AQuA

From raw data to events

  • In vivo and ex vivo
  • GCaMP, GluSnFr
  • And more

Event detection pipeline of AQuA

Extract features from events

  • Size and location
  • Duration, delta F/F, rising/falling time, decay time constant
  • Propagation direction, speed
  • And more

Feature extraction

Graphical user interface

  • Step by step guide
  • Event viewer
  • Feature visualizer
  • Proofreading and filtering
  • Side by side view
  • Region and landmark tool
  • And more

User interface

Download and installation

MATLAB GUI

  1. Download latest version here.
  2. Unzip the downloaded file.
  3. Start MATLAB.
  4. Switch the current folder to AQuA's folder.
  5. Double click aqua_gui.m, or type aqua_gui in MATLAB command line.

We tested on MATLAB versions later than 2017a. Earlier versions are not supported.

MATLAB Without GUI

Use aqua_cmd.m file

  1. Double click aqua_cmd.m file.
  2. Set the folder path 'p0' and target dataset name 'f0'.
  3. Run the file.
  4. The output files will be saved in a subfolder of 'p0'.

Use aqua_batch.m file

  1. Double click aqua_batch.m file.
  2. Set the folder path 'p0', and for each target dataset, set the parameters in AQuA/cfg/parameters_for_batch.csv. Each dataset is corresponding to one parameter setting.
  3. Run the file.
  4. The output files will be saved in subfolders of 'p0'.

Fiji plugin

  1. Download here.
  2. Put the downloaded Aqua.jar to the plugins folder of Fiji.
  3. Open Fiji.
  4. In the Plugins menu, click Aqua.
  5. Open movie and choose project path in AQuA GUI.

Some browsers may show a warning when downloading the 'jar' file. Please choose 'keep file'. Note: The Fiji version do not save the results in 'res' data structure in 'mat' file. If users want to obtain the results and process by themselves, please use MATLAB version.

Getting started

If you are using AQuA for the first time, please read the step by step user guide.

Or you can check the details on output files, extracted features, and parameter settings.

Example datasets

You can try these real data sets in AQuA. These data sets are used in the supplemental of the paper.

Ex-vivo GCaMP dataset

In-vivo GCaMP dataset

GluSnFr dataset

We also provide some synthetic data sets. These are used in the simulation part of the paper.

Synthetic data sets

Reference

Yizhi Wang$, Nicole V. DelRosso$, Trisha V. Vaidyanathan, Michelle K. Cahill, Michael E. Reitman, Silvia Pittolo, Xuelong Mi, Guoqiang Yu#, Kira E. Poskanzer#, Accurate quantification of astrocyte and neurotransmitter fluorescence dynamics for single-cell and population-level physiology, Nature Neuroscience, 2019, https://www.nature.com/articles/s41593-019-0492-2 ($ co-first authors, # co-corresponding authors)

Yizhi Wang, Nicole V. DelRosso, Trisha Vaidyanathan, Michael Reitman, Michelle K. Cahill, Xuelong Mi, Guoqiang Yu, Kira E. Poskanzer, An event-based paradigm for analyzing fluorescent astrocyte activity uncovers novel single-cell and population-level physiology, BioRxiv 504217; doi: https://doi.org/10.1101/504217. [Link to BioRxiv]

Updates

12/20/2019:

Add new functin for cell regions and landmark reigons. The button "->" in the top-left corner of the GUI can let users to drag regions.

12/19/2019:

Solve the issue that the detected events are forced to merge in "aqua_cmd.m" and "aqua_cmd_batch.m".

12/18/2019:

The update fixes one bug existing in 'fix_events'.

12/3/2019:

The update fixes one bug. Now each time "Update features" in GUI is clicked , the proof reading table will be updated.

11/25/2019:

The update changes the GUI panel. Now users could select whether to output feature table or not.

11/22/2019:

The update saves the use of memory, while the results will not change.

10/30/2019:

The update adds the random seed and makes the random variables controllable. Now with same parameter setting, AQuA will give same results. (Due to the randomness, the results will have a little difference before.)

10/19/2019:

Repair the bug in Fiji version that 'minimum correlation' in merging step cannot be set to float data.

10/17/2019:

  1. The update avoids the error report when nothing is detected for aqua_batch.m.

  2. Allow aqua_batch.m to read a batch of cell boundaries and landmarks.

10/16/2019:

The update adds the new script aqua_batch.m which can let users deal with multiple files. MATLAB Without GUI shows how to use it.