Skip to content

Commit 78118bf

Browse files
authored
Revise ABBA documentation for 0.25 release
Updated the documentation for the ABBA Fiji plugin, enhancing clarity on features, installation, and usage instructions.
1 parent 3f4f2fc commit 78118bf

1 file changed

Lines changed: 40 additions & 21 deletions

File tree

‎_pages/plugins/bdv/abba/abba.md‎

Lines changed: 40 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,56 @@ nav-links: true
55
toc: true
66
---
77

8-
The complete documentation of ABBA can be found here:
9-
[https://abba-documentation.readthedocs.io](https://abba-documentation.readthedocs.io).
10-
11-
You can use ABBA by activating the PTBIOP update site, but more functionalities are acessible through other installation means. Check the full documentation for instructions.
12-
13-
## [ABBA](https://www.youtube.com/watch?v=8haRfsY4-_s) - Aligning Big Brains & Atlases
14-
15-
Aligning Big Brains & Atlases or ABBA for short, is a Fiji plugin which allows to register thin serial sections to several atlases, in coronal, sagittal and horizontal orientations.
8+
Aligning Big Brains & Atlases, or ABBA for short, is a Fiji plugin to register thin serial sections of brains to
9+
3D atlases, in coronal, sagittal and horizontal orientations.
1610

17-
Within Fiji, you have access to the [3D mouse Allen Brain atlas](http://atlas.brain-map.org/atlas?atlas=602630314), and the [Waxholm Space Atlas of the Sprague Dawley Rat Brain](https://www.nitrc.org/projects/whs-sd-atlas). With [ABBA-Python](https://github.com/NicoKiaru/ABBA-Python), you can access all [BrainGlobe atlases](https://brainglobe.info/).
18-
19-
ABBA is typically used in conjunction with [QuPath](https://qupath.github.io): a QuPath project can serve as an input for ABBA, and the registration results can be imported back into QuPath for downstream processing.
20-
21-
<video autoplay loop muted style="width: 100%;">
22-
<source src="https://user-images.githubusercontent.com/20223054/149301605-07b27dd0-4010-4ca4-b415-f5a9acc8963d.mp4" type="video/mp4">
23-
Your browser does not support the video tag.
24-
</video>
11+
The complete documentation of ABBA is at
12+
[https://abba-documentation.readthedocs.io](https://abba-documentation.readthedocs.io).
2513

26-
-----
14+
## Features
2715

16+
* **Atlases**: the [Allen mouse brain atlas](http://atlas.brain-map.org/atlas?atlas=602630314) (CCFv3), the
17+
[Waxholm Space atlas of the Sprague Dawley rat brain](https://www.nitrc.org/projects/whs-sd-atlas), and all the
18+
[BrainGlobe atlases](https://brainglobe.info/), opened directly in Fiji.
19+
* **Automated registration**: [DeepSlice](https://github.com/PolarBean/DeepSlice) positions the sections along
20+
the atlas, [elastix](https://elastix.dev/) refines each one with affine and spline registrations. Both are
21+
installed by ABBA itself the first time they are used: nothing else to install or configure.
22+
* **Manual correction**: position sections by hand, and edit any registration, with
23+
[BigWarp](/plugins/bigwarp) for spline registrations.
24+
* **Large images**: ABBA uses [BigDataViewer](/plugins/bdv) to display and transform multiresolution images, the
25+
typical output of whole slide imaging, on the fly.
26+
* **QuPath**: a [QuPath](https://qupath.github.io) project can be the input of ABBA, and the registered atlas
27+
regions are imported back into QuPath for cell detection and counting per region.
28+
* **AI assistant** (experimental): through [abba-mcp](https://github.com/unige-biochem/abba-mcp), an AI
29+
assistant (in VS Code, Claude, Codex...) can run a registration in ABBA's window, where you can take over at any
30+
time.
2831

29-
ABBA uses [BigDataViewer](https://imagej.net/plugins/bdv/index) and [BigWarp](https://imagej.net/plugins/bigwarp) for the display and on-the-fly computation of spline-transformed multiresolution images (typical output of Whole Slide Imaging).
32+
## Installation
3033

31-
It has been developed by the [BioImaging & Optics Platform](https://www.epfl.ch/research/facilities/ptbiop/) at EPFL. This page contains the reference documentation of ABBA. If you require additional help, please check the troubleshooting section at the bottom of this page.
34+
In Fiji, enable the `UNIGE-Biochem` [update site](/update-sites/following), then restart Fiji. ABBA needs Java 21,
35+
which an up-to-date Fiji has.
3236

37+
ABBA can also be installed with an AI assistant, with a standalone installer, or from Python: see the
38+
[installation page](https://abba-documentation.readthedocs.io/en/stable/installation/installation.html).
3339

40+
## Getting started
3441

35-
## Documentation
42+
* [Getting started](https://abba-documentation.readthedocs.io/en/stable/getting_started/first_registration.html):
43+
a first registration, step by step, on demo sections that ABBA downloads for you.
44+
* [Video tutorial](https://abba-documentation.readthedocs.io/en/stable/resources/video_tuto.html).
45+
* Questions and bug reports: the [image.sc forum](https://forum.image.sc/tag/abba), with the `abba` tag.
3646

37-
You will find the complete documentation in [https://abba-documentation.readthedocs.io](https://abba-documentation.readthedocs.io)
47+
## Citation
3848

49+
If you use ABBA, please cite:
3950

51+
Chiaruttini, N., Castoldi, C., Requie, L. et al. **ABBA+BraiAn, an integrated suite for whole-brain mapping,
52+
reveals brain-wide differences in immediate-early genes induction upon learning**. *Cell Reports* (2025).
53+
[doi:10.1016/j.celrep.2025.115876](https://doi.org/10.1016/j.celrep.2025.115876)
4054

55+
After the registration, [BraiAn](https://silvalab.codeberg.page/BraiAn/) analyses whole-brain datasets aligned with
56+
ABBA.
4157

58+
ABBA was started at the [BioImaging & Optics Platform](https://www.epfl.ch/research/facilities/ptbiop/) of EPFL,
59+
and is developed at the University of Geneva. Its sources are on
60+
[GitHub](https://github.com/BIOP/ijp-imagetoatlas).

0 commit comments

Comments
 (0)