BG-atlasAPI
A Python API for downloading and processing neuroanatomical atlas data from multiple sources.
What is BG-atlasAPI?
BrainGlobe Atlas API (brainglobe-atlasapi) is a Python library that provides a common interface to download, access, and process neuroanatomical atlas data from multiple public sources. It solves the problem of fragmented and inconsistent atlas data formats by offering a unified API for researchers working with brain atlases across different species and imaging techniques.
Neuroscientists, bioinformaticians, and researchers who need programmatic access to standardized brain atlas data for analysis, visualization, or integration into computational pipelines.
Developers choose BrainGlobe Atlas API because it consolidates access to dozens of atlases through a single, well-documented Python interface, eliminating the need to write custom parsers for each data source and ensuring consistency in coordinate handling and data structures.
Overview
A Python interface to access neuroanatomical atlases
Use Cases
Best For
- Programmatically downloading and caching neuroanatomical atlas data
- Standardizing brain region analysis across multiple atlas sources
- Accessing 3D mesh files and annotations for specific brain structures
- Integrating atlas data into computational neuroscience pipelines
- Visualizing brain regions and reference images in research applications
- Contributing new publicly available atlases to a shared ecosystem
Not Ideal For
- Real-time or high-throughput processing of live brain imaging data where low latency is critical
- Projects relying exclusively on proprietary, custom, or unpublished atlas datasets not in the public repository
- Teams needing a graphical user interface for atlas exploration without writing any code
- Environments with strict air-gapped or offline constraints where downloading atlas data from the internet is impossible
Pros & Cons
Pros
Provides a single BrainGlobeAtlas class to interact with over 20 atlases from sources like Allen, Max Planck, and Kim Lab, eliminating the need to learn separate APIs for each dataset.
Offers easy access to brain region IDs, acronyms, names, and 3D meshes through attributes like atlas.lookup_df and atlas.structures, as shown in the usage examples for region lookup.
Includes tools and guidelines in the atlas_generation submodule for contributing new atlases, with script examples and dependency management, fostering ecosystem growth.
Addresses common neuroimaging pain points by documenting image (ij) vs. cartesian coordinates and integrating with brainglobe-space for transformations, though external package use is required.
Cons
Requires downloading atlas data from public repositories at runtime, which can be slow, fail due to network issues, and ties availability to external server uptime.
Confined to Python environments, excluding researchers who use R, MATLAB, or other languages, and may complicate integration with non-Python tools or pipelines.
Adding a new atlas involves creating a script, managing optional dependencies in pyproject.toml, and hosting raw data publicly, which can be a barrier for casual contributors.
High-resolution atlases (e.g., 1-micron zebrafish) result in large file sizes; loading entire datasets into memory may cause issues, though the README doesn't address optimization strategies.
Frequently Asked Questions
Related Projects
NeuroglancerWebGL-based viewer for volumetric data
CaImAnComputational toolbox for large scale Calcium Imaging Analysis, including movie handling, motion correction, source extraction, spike deconvolution and result visualization.
BrainrenderA Python package to visualise neuroanatomical data in atlas space
CellfinderAutomated 3D cell detection in very large images
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.