Build unbiased anatomical templates from individual images
Project description
brainglobe-template-builder
Build unbiased anatomical templates from individual images
Overview
brainglobe-template-builder
provides a streamlined process to create unbiased anatomical reference images, or templates, from multiple high-resolution brain images. While primarily designed for brain imaging, its versatility extends to any organ with available 3D digital images, especially those produced by 3D volumetric microscopy like serial two-photon tomography (STPT) and light-sheet microscopy (LSM).
brainglobe-template-builder
aims to:
- Offer an intuitive Python interface to the optimised ANTs template construction pipeline.
- Support 3D volumetric microscopy images, such as STPT and LSM.
- Generate templates compatible with the BrainGlobe ecosystem, especially the BrainGlobe Atlas API.
Warning
- Early development phase. Stay tuned
- Interface may undergo changes.
Installation
Warning
- ANTs, which we depend on, is a large package. The installation may take a while.
- ANTs is only available for Linux and macOS. If you are on Windows, you can use WSL
We recommend installing brainglobe-template-builder
within a conda or mamba environment. Instructions assume conda
usage, but mamba
/micromamba
are interchangeable.
Use the provided environment.yaml
file to create a new environment.
git clone https://github.com/brainglobe/brainglobe-template-builder
cd brainglobe-template-builder
conda env create -f environment.yaml -n template-builder
conda activate template-builder
We have called the environment template-builder
, but you can choose any name you like.
To install the latest development version of brainglobe-template-builder
,
pip install -e .[dev]
For zsh users (default shell on macOS):
pip install -e '.[dev]'
Background
On templates and atlases
In brain imaging, a template serves as a standard reference for brain anatomy, often used interchangeably with the term reference image. By aligning multiple brain images to a common template, researchers can standardize their data, facilitating easier data-sharing, cross-study comparisons, and meta-analyses.
An atlas elevates this concept by annotating a template with regions of interest, often called labels or parcellations. With an atlas, researchers can pinpoint specific brain regions and extract quantitative data from them.
The entire process, from registration to data extraction, hinges on the quality of the template image. A high-quality template can significantly improve registration accuracy and the precision of atlas label annotations.
The aim of brainglobe-template-builder
is to assist researchers in constructing such high-quality templates.
Single-subject vs population templates
Templates can be derived in two primary ways. A single-subject template is based on the brain of one individual. While this approach is simpler and may be suitable for some applications, it risks being unrepresentative, as the chosen individual might have unique anatomical features. On the other hand, population templates are constructed by aligning and averaging brain images from multiple subjects. This method captures the anatomical variability present in a population and reduces biases inherent in relying on a single subject. Population templates have become the standard in human MRI studies and are increasingly being adopted for animal brain studies.
Template construction with ANTs
brainglobe-template-builder
leverages the power of ANTs (Advanced Normalisation Tools), a widely used software suite for image registration and segmentation.
ANTs includes a template construction piepline - implemented in the antsMultivariateTemplateConstruction2.sh script - that iteratively aligns and averages multiple images to produce an unbiased population template (see this issue for details).
An optimsed implementation of the above pipeline, developed by the CoBra lab, lies at the core of the brainglobe-template-builder
's functionality.
License
⚖️ BSD 3-Clause
Package blueprint
This package layout and configuration (including pre-commit hooks and GitHub actions) have been copied from the python-cookiecutter template.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file brainglobe-template-builder-0.0.7.tar.gz
.
File metadata
- Download URL: brainglobe-template-builder-0.0.7.tar.gz
- Upload date:
- Size: 7.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9306ec18324bd33722ed1e2c3a8cae5f4c11dbd36265847c07d902618e2dfeb0 |
|
MD5 | 3bd33c96030339f691d523e20f5bf2ef |
|
BLAKE2b-256 | 67073e7a47665ffe232e80a4ffea67a7bd7fe200c0961091e03aae5d50f0b07f |
File details
Details for the file brainglobe_template_builder-0.0.7-py3-none-any.whl
.
File metadata
- Download URL: brainglobe_template_builder-0.0.7-py3-none-any.whl
- Upload date:
- Size: 5.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b64bf96f14e11aaa257892b4742fbe8dd5cebd49704e13e5c2ca027e94532e77 |
|
MD5 | e840249afe136212c0cf87137a8d9118 |
|
BLAKE2b-256 | c5bfed5b1131c633383b9b08cc38dd56fc8779e117ec574688405ac01f2c99b1 |