ibllib.io.extractors.bpod_trials

Trials data extraction from raw Bpod output.

This module will extract the Bpod trials and wheel data based on the task protocol, i.e. habituation, training or biased.

Functions

get_bpod_extractor

Returns an extractor for a given session.
get_bpod_extractor(session_path, protocol=None, task_collection='raw_behavior_data') → BaseBpodTrialsExtractor[source]

Returns an extractor for a given session.

Parameters:

  • session_path (str, pathlib.Path) – The path to the session to be extracted.

  • protocol (str, optional) – The protocol name, otherwise uses the PYBPOD_PROTOCOL key in iblrig task settings files.

  • task_collection (str) – The folder within the session that contains the raw task data.

Returns:

An instance of the task extractor class, instantiated with the session path.

Return type:

BaseBpodTrialsExtractor