neurocarto.util.atlas_struct

class neurocarto.util.atlas_struct.Structures
__init__(atlas, structure)
Parameters:

  • atlas (BrainGlobeAtlas)

  • structure (list[Structure])

classmethod of(atlas)
Parameters:

atlas (BrainGlobeAtlas)

Return type:

Structures

property regions: list[str]
alias(acronym, *name)
Parameters:

  • acronym (str)

  • name (str)

is_subregion(parent, child)

Do both have relationship: parent / child?

Parameters:
Returns:

Return type:

bool

iter_subregions(region)
Parameters:

region (int | str | Structure)

Return type:

Iterator[Structure]

sort_structure(regions)

For sorted list, two elements r[i] and r[j] for i, j in N, i < j, that either r[i]/r[j] or not(r[i]/r[j]).

Parameters:

regions (list[int | str])

Returns:

Return type:

list[int | str]

image_annotation(annotation, merge, other)
Parameters:

  • annotation (ndarray[tuple[int, ...], dtype[uint64]])

  • merge (dict[int | str, int])

  • other (int)

Return type:

ndarray[tuple[int, …], dtype[uint64]]

class neurocarto.util.atlas_struct.Structure

Structure(acronym, id, name, color, id_path)

acronym: str

Alias for field number 0

id: int

Alias for field number 1

name: str

Alias for field number 2

color: tuple[int, int, int]

Alias for field number 3

id_path: tuple[int, ...]

Alias for field number 4

static __new__(_cls, acronym, id, name, color, id_path)

Create new instance of Structure(acronym, id, name, color, id_path)

Parameters:

  • acronym (ACRONYM)

  • id (STRUCTURE)

  • name (str)

  • color (tuple[int, int, int])

  • id_path (tuple[STRUCTURE, ...])