sanitise_volumetric_data#
- brainglobe_atlasapi.atlas_generation.atlas_packaging_data.sanitise_volumetric_data(resolution, orientation, reference_stack, annotation_stack, hemispheres_stack=None, additional_references=None)[source]#
Load and reorient all volumetric atlas data.
Stacks given as file paths are read with tifffile, single arrays are wrapped in a list, and every stack is reoriented from
orientationto the BrainGlobe orientation. If no hemispheres stack is provided, the atlas is treated as symmetric and one is generated.- Parameters:
resolution (Resolution | ResolutionList) – Resolution on three axes, or a list of such tuples for multi-scale.
orientation (str) – Orientation of the original atlas data.
reference_stack (ValidComponentData) – Reference stack, as a path, array, or list of these per scale.
annotation_stack (ValidComponentData) – Annotation stack, as a path, array, or list of these per scale.
hemispheres_stack (ValidComponentData | None, optional) – Hemispheres stack. If None, the atlas is assumed symmetric.
additional_references (list[tuple[TemplateInfo, ValidComponentData]] | None, optional) – Additional templates and their stacks.
- Returns:
The normalised volumetric data.
- Return type: