registry¶
Static registry of atlases hosted at nltools/niftis/atlases.
Each entry describes an atlas’s kind (deterministic vs probabilistic) and
the citation users should cite when they use it. The actual NIfTI + label
files are fetched lazily by load_atlas via
fetch_resource.
Atlases were sourced from atlasreader (BSD-3-Clause) and are subject to
their original upstream licenses — see LICENSES.md in the HF dataset.
Attributes:
| Name | Type | Description |
|---|---|---|
ATLASES | dict [ str , AtlasMetadata ] | |
AtlasKind | ||
DEFAULT_ATLASES | tuple [ str , ...] |
Classes:
| Name | Description |
|---|---|
AtlasMetadata | Static description of a registered atlas. |
Methods:
| Name | Description |
|---|---|
list_atlases | Return the sorted list of registered atlas names. |
Classes¶
AtlasMetadata¶
AtlasMetadata(kind: AtlasKind, citation: str) -> NoneStatic description of a registered atlas.
Attributes:
| Name | Type | Description |
|---|---|---|
kind | AtlasKind | "deterministic" (3D integer-labeled) or "probabilistic" (4D, last axis indexes regions). |
citation | str | Short citation string for the original atlas. |
Methods¶
list_atlases¶
list_atlases() -> list[str]Return the sorted list of registered atlas names.
Returns:
| Type | Description |
|---|---|
list [ str ] | Sorted list of atlas names usable with |
list [ str ] | load_atlas. |