allensdk.internal.brain_observatory.mouse module

class allensdk.internal.brain_observatory.mouse.Mouse(mouse_id: str)[source]

Bases: object

A mouse

classmethod from_behavior_session_id(behavior_session_id: int) Mouse[source]

Instantiates Mouse from behavior_session_id

get_behavior_sessions(exclude_invalid_sessions: bool = True) List[BehaviorMetadata][source]

Gets all behavior sessions for mouse

Parameters:
exclude_invalid_sessions:

Whether to exclude invalid sessions

Returns:
List[BehaviorMetadata]
get_images_shown(up_to_behavior_session_id: int | None = None, n_workers: int | None = None)[source]

Gets all images presented to mouse up to (not including) up_to_behavior_session_id if provided

Parameters:
up_to_behavior_session_id

Filters stimulus presentations to all those up to (not including) this behavior session, if provided

n_workers

Number of processes to spawn for reading image names from stimulus files

property mouse_id: str