API Documentation
The class and package diagrams can be found at the developer documentation.
Siibra
Main Packages and Modules
Constants, functions, and classes used commonly across siibra. |
|
Handles reconfiguration management and building instances |
|
Siibra specific exceptions |
|
Interface to create links to siibra-explorer |
|
Multimodal data features types and query mechanisms. |
|
Feature queries requiring live query or on-the-fly calculations. |
|
Handles spatial concepts and spatial operation like warping between spaces. |
|
File digestion and caching. |
|
Abbreviations and aliases. |
|
Package handling variety of volumes and volume operations |
Core Concepts
Qualification between two BrainStructures |
|
Provides reference systems for brains. |
|
Parent class to siibra main concepts. |
|
Hierarchal brain regions and metadata. |
|
Representation of a brain region. |
|
A particular brain reference space. |
|
Abstract base class for any kind of brain structure. |
Volumes
Provides spatial representations for parcellations and regions. |
|
Subpackage handling the digestion of different volume and mesh types |
|
Represents lists of probabilistic brain region maps. |
|
A specific mesh or 3D array. |
Locations
A box defined by two farthest corner coordinates on a specific space. |
|
Concepts that have primarily spatial meaning. |
|
Singular coordinate defined on a space, possibly with an uncertainty. |
|
A set of coordinates on a reference space. |
Features
Handles the relation between study targets and BrainStructures. |
|
Multimodal data features concerning connectivity data. |
|
Non-preconfigured data features published as datasets. |
|
Handles multimodal data features and related queries. |
|
Multimodal data features in volume or image formats. |
|
Multimodal data features in tabular formats. |
Live queries
Query Allen Human Brain Atlas microarray data in specified volume. |
|
Matches BigBrain intesity profiles extracted by Wagstyl et al. to volumes. |
|
Query data features published as Ebrains datasets with AtlasConcepts |
|
Handles feature queries that rely on live or on-the-fly calculations. |
Retrieval
Maintaining and handling caching files on disk. |
|
Metadata connection to EBRAINS datasets. |
|
Exceptions concerning file retrieval processes. |
|
Connect to repositories to browse and pull files within. |
|
Request files with decoders, lazy loading, and caching. |