task

Classes

Event()	Enumeration of Bpod event names.
Output()	Enumeration of Bpod output channels.
Task()	Base class for defining and running behavioral tasks using Bpod.

Exceptions

TaskError(message)

Exception raised for errors in the Task class.

exception TaskError(message)

Bases: Exception

Exception raised for errors in the Task class.

class Event

Bases: EventName

Enumeration of Bpod event names.

class Output

Bases: OutputChannel

Enumeration of Bpod output channels.

class Task

Bases: object

Base class for defining and running behavioral tasks using Bpod.

This class provides the infrastructure for task management, including communication with Bpod, data logging, session management, and integration with other devices like cameras and sound systems.

start() → None

Starts the task. Must be overridden by subclasses.

create_trial() → None

Creates the state machine for the current trial. Must be overridden.

after_trial() → None

Executed after each trial completes. Must be overridden.

close() → None

Closes the task and releases resources. Must be overridden.

send_softcode_to_bpod(code: int) → None

Sends a softcode to the Bpod device.

Parameters:

code (int) – The softcode value to send.

run_in_thread(daemon: bool = True) → None

Runs the task in a separate background thread.

Parameters:

daemon (bool, optional) – Whether to run as a daemon thread. Defaults to True.

run() → None

Runs the task in the main thread until completion or forced stop.

do_trial(send_to_cam: bool = False) → None

Executes a single trial.

Initializes the state machine, runs it, collects data, and performs post-trial updates.

Parameters:

send_to_cam (bool, optional) – Whether to update the camera with the trial number. Defaults to False.

get_trial_data() → None

Retrieves and processes data from the last executed trial.

Extracts timestamps, events, and states from the Bpod session and updates self.trial_data.

concatenate_trial_data() → None

Appends the current trial’s data to the session DataFrame.

register_value(name: str, value: Any) → None

Registers a custom value to be saved with the trial data.

Parameters:

• name (str) – The name of the value (column header).

• value (Any) – The value to store.

register_default_values() → None

Registers standard session metadata values (task, subject, system, date).

disconnect_and_save(run_mode: str) → Tuple[Save, float, int, int, str]

Stops the task, disconnects devices, and saves session data.

Parameters:

run_mode (str) – The mode in which the task was run (e.g., “Manual”).

Returns:

A tuple containing the save status, session duration, number of trials, water consumed, and settings string.

Return type:

Tuple[Save, float, int, int, str]

save_json(run_mode: str) → str

Saves the session settings to a JSON file.

Parameters:

run_mode (str) – The execution mode string.

Returns:

The JSON string containing the settings.

Return type:

str

save_csv(run_mode: str) → Tuple[float, int, int, bool]

Saves the session data to CSV files.

Processes raw data, saves raw and clean session files, and updates the subject’s cumulative data file.

Parameters:

run_mode (str) – The execution mode string.

Returns:

Duration, trial count, water consumed, and success status.

Return type:

Tuple[float, int, int, bool]

transform(df: pandas.DataFrame) → pandas.DataFrame

Transforms raw session data into a wide format suitable for analysis.

Parameters:

df (pd.DataFrame) – Raw dataframe.

Returns:

Transformed dataframe.

Return type:

pd.DataFrame

classmethod get_name() → str

Returns the name of the task class.

create_paths() → None

Sets up file and directory paths for the session.