neuralib.widefield.ccf.DorsalCCF

class neuralib.widefield.ccf.DorsalCCF[source]

Bases: object

__init__(region_labels, image_shape, hemisphere='both')[source]
Parameters:

  • region_labels (list[RegionLabel])

  • image_shape (tuple[int, int])

  • hemisphere (Literal['left', 'right', 'both'])

Methods

__init__(region_labels, image_shape[, ...])

from_array(array[, hemisphere])

from_json([file, image_shape])

select_hemisphere(hemisphere)

select_region(acronym)

select a specific region or list of region

to_boundary([outlines_only])

to_numpy()

Attributes

fov_mm

hemisphere

image_shape

region_dict

region int dict

region_list

__init__(region_labels, image_shape, hemisphere='both')[source]
Parameters:

  • region_labels (list[RegionLabel])

  • image_shape (tuple[int, int])

  • hemisphere (Literal['left', 'right', 'both'])

classmethod from_json(file=None, image_shape=(512, 512))[source]
Parameters:

  • file (str | Path | PathLike[str] | None)

  • image_shape (tuple[int, int])

Return type:

Self

classmethod from_array(array, hemisphere='both')[source]
Parameters:

  • array (ndarray)

  • hemisphere (Literal['left', 'right', 'both'])

property image_shape: tuple[int, int]
property fov_mm: tuple[float, float]
property hemisphere: Literal['left', 'right', 'both']
property region_list: list[str]
property region_dict: dict[str, int]

region int dict

select_region(acronym)[source]

select a specific region or list of region

Parameters:

acronym (str | Sequence[str])

Return type:

Self

select_hemisphere(hemisphere)[source]
Parameters:

hemisphere (Literal['left', 'right', 'both'])

Return type:

Self

to_numpy()[source]
Return type:

ndarray

to_boundary(outlines_only=True)[source]
Parameters:

outlines_only (bool)

Return type:

ndarray