SanitisedVolumes#

class brainglobe_atlasapi.atlas_generation.atlas_packaging_data.SanitisedVolumes(resolution: List[Tuple[int | float, int | float, int | float]], space_convention: AnatomicalSpace, reference_stack: list[ndarray[tuple[Any, ...], dtype[_ScalarT]]], annotation_stack: list[ndarray[tuple[Any, ...], dtype[_ScalarT]]], hemispheres_stack: list[ndarray[tuple[Any, ...], dtype[_ScalarT]]], symmetric: bool, additional_references: list[tuple[TemplateInfo, list[ndarray[tuple[Any, ...], dtype[_ScalarT]]]]])[source]#

Bases: NamedTuple

Volumetric atlas data normalised for AtlasPackagingData.

resolution#

One resolution tuple per scale, highest resolution first.

Type:

ResolutionList

space_convention#

Anatomical space of the original data.

Type:

bgs.AnatomicalSpace

reference_stack#

Reference stack per scale, reoriented to the BrainGlobe orientation.

Type:

list[npt.NDArray]

annotation_stack#

Annotation stack per scale, reoriented to the BrainGlobe orientation.

Type:

list[npt.NDArray]

hemispheres_stack#

Hemispheres stack per scale, either provided and reoriented or auto-generated for symmetric atlases.

Type:

list[npt.NDArray]

symmetric#

Whether the atlas is symmetric (no hemispheres stack was provided).

Type:

bool

additional_references#

Additional templates, each loaded and reoriented.

Type:

list[tuple[TemplateInfo, list[npt.NDArray]]]

Methods

count(value, /)

Return number of occurrences of value.

index(value[, start, stop])

Return first index of value.

Attributes

additional_references

Alias for field number 6

annotation_stack

Alias for field number 3

hemispheres_stack

Alias for field number 4

reference_stack

Alias for field number 2

resolution

Alias for field number 0

space_convention

Alias for field number 1

symmetric

Alias for field number 5

additional_references: list[tuple[TemplateInfo, list[ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]]]]]#

Alias for field number 6

annotation_stack: list[ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]]]#

Alias for field number 3

count(value, /)#

Return number of occurrences of value.

hemispheres_stack: list[ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]]]#

Alias for field number 4

index(value, start=0, stop=9223372036854775807, /)#

Return first index of value.

Raises ValueError if the value is not present.

reference_stack: list[ndarray[tuple[Any, ...], dtype[TypeVar(_ScalarT, bound= generic)]]]#

Alias for field number 2

resolution: List[Tuple[int | float, int | float, int | float]]#

Alias for field number 0

space_convention: AnatomicalSpace#

Alias for field number 1

symmetric: bool#

Alias for field number 5