neuralib.atlas.data.load_bg_volumes

neuralib.atlas.data.load_bg_volumes(atlas_name='allen_mouse_10um', cached_file=None, force=False)[source]

Load structure tree dataframe with volume for each region volume_mm3

┌─────────┬─────┬─────────────────┬─────────────────┬────────────────┬────────────────┬────────────┐
│ acronym ┆ id  ┆ name            ┆ structure_id_pa ┆ parent_structu ┆ parent_acronym ┆ volume_mm3 │
│ ---     ┆ --- ┆ ---             ┆ th              ┆ re_id          ┆ ---            ┆ ---        │
│ str     ┆ i64 ┆ str             ┆ ---             ┆ ---            ┆ str            ┆ f64        │
│         ┆     ┆                 ┆ str             ┆ i64            ┆                ┆            │
╞═════════╪═════╪═════════════════╪═════════════════╪════════════════╪════════════════╪════════════╡
│ VI      ┆ 653 ┆ Abducens        ┆ /997/8/343/1065 ┆ 370            ┆ MY-mot         ┆ 0.030332   │
│         ┆     ┆ nucleus         ┆ /354/370/653/   ┆                ┆                ┆            │
│ AOB     ┆ 151 ┆ Accessory       ┆ /997/8/567/688/ ┆ 698            ┆ OLF            ┆ 0.652032   │
│         ┆     ┆ olfactory bulb  ┆ 695/698/151/    ┆                ┆                ┆            │
│ …       ┆ …   ┆ …               ┆ …               ┆ …              ┆ …              ┆ …          │
│ von     ┆ 949 ┆ vomeronasal     ┆ /997/1009/967/9 ┆ 967            ┆ cm             ┆ 0.013428   │
│         ┆     ┆ nerve           ┆ 49/             ┆                ┆                ┆            │
└─────────┴─────┴─────────────────┴─────────────────┴────────────────┴────────────────┴────────────┘
Parameters:

  • atlas_name (Literal['allen_mouse_10um', 'allen_mouse_25um', 'allen_mouse_50um', 'allen_mouse_100um', 'kim_mouse_10um', 'kim_mouse_25um', 'kim_mouse_50um', 'kim_mouse_100um', 'perens_lsfm_mouse_20um', 'perens_stereotaxic_mouse_mri_25um', 'princeton_mouse_20um']) – ATLAS_NAME

  • cached_file (str | Path | PathLike[str] | None) – Cached file path.

  • force (bool) – Force overwrite the cached file

Returns:

Return type:

DataFrame