neuralib.atlas.data.get_children

neuralib.atlas.data.get_children(parent: int, *, dataframe: bool = False, 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'] = 'allen_mouse_10um') → list[int] | DataFrame[source]
neuralib.atlas.data.get_children(parent: str, *, dataframe: bool = False, 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'] = 'allen_mouse_10um') → list[str] | DataFrame

Get children brain region id or acronym from its parent

Parameters:

  • parent (int | str) – id or acronym

  • dataframe (bool) – return as dataframe, otherwise return as list

  • 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

Returns:

Return type:

list[int] | list[str] | DataFrame