StateMachineBase

class StateMachineBase(bpod)

Bases: object

Each Bpod trial is programmed as a virtual finite state machine. This ensures precise timing of events - for any state machine you program, state transitions will be completed in less than 250 microseconds - so inefficient coding won’t reduce the precision of events in your data.

Warning

A lot of data structures are kept here for compatibility

with original matlab library which are not

so python-like. Anyone is welcome to enhance this class but keep in mind that it will affect the whole pybpodapi library.

Variables:

hardware (Hardware) – bpod box hardware description associated with this

state machine :ivar Channels channels: bpod box channels handling :ivar list(str) state_names: list that holds state names added to this state machine :ivar list(float) state_timers: list that holds state timers :ivar int total_states_added: holds all states added, even if name is repeated :ivar list(int) state_timer_matrix: TODO: :ivar Conditions conditions: holds conditions :ivar GlobalCounters global_counters: holds global timers :ivar GlobalTimers global_timers: holds global counters :ivar list(tuple(int)) input_matrix: TODO: :ivar list(str) manifest: list of states names that have been added to the state machine :ivar list(str) undeclared: list of states names that have been referenced but not yet added :ivar tuple(str) meta_output_names: TODO: :ivar list(tuple(int)) output_matrix: TODO: :ivar bool is_running: whether this state machine is being run on bpod box

__init__(bpod)

Parameters:

hardware (Hardware) – hardware description associated with this

state machine

Methods

__init__(bpod)
add_state(state_name[, state_timer, ...])	Adds a state to an existing state matrix.
set_condition(condition_number, ...)	Set condition
set_global_counter([counter_number, ...])	Sets the threshold and monitored event for one of the 5 global counters.
set_global_timer(timer_id, timer_duration[, ...])	Sets the duration of a global timer.
set_global_timer_legacy([timer_id, ...])	Set global timer (legacy version)

add_state(state_name, state_timer=0, state_change_conditions={}, output_actions=())

Adds a state to an existing state matrix.

Parameters:

name (str) – A character string containing the unique name of the state.

The state will automatically be assigned a number for internal use and state synchronization via the sync port :param float timer: The state timer value, given in seconds. This value must be zero or positive, and can range between 0-3600s. If set to 0s and linked to a state transition, the state will still take ~100us to execute the state’s output actions before the transition completes :param dict state_change_conditions: Dictionary whose keys are names of a valid input event (state change) and values are names of states to enter if the previously listed event occurs (or ‘exit’ to exit the matrix and return all captured data) :param list(tuple) output_actions: a list of binary tuples where first value should contain the name of a valid output action and the second value should contain the value of the previously listed output action (see output actions for valid values).

Example:

sma.add_state(
    state_name='Port1Lit',
    state_timer=.25,
    state_change_conditions={'_Tup': 'Port3Lit'},
    output_actions=[('PWM1', 255)])

set_condition(condition_number, condition_channel, channel_value)

Set condition

Parameters:

• condition_number (int)

• condition_channel (str)

• channel_value (int)

set_global_counter(counter_number=None, target_event=None, threshold=None)

Sets the threshold and monitored event for one of the 5 global counters. Global counters can count instances of events, and handle when the count exceeds a threshold from any state (by triggering a state change).

Parameters:

counter_number (int) – the number of the counter you are setting

(an integer, 1-5). :param str target_event: port where to listen for event to count :param int threshold: number of times that should be count until trigger timer

set_global_timer(timer_id, timer_duration, on_set_delay=0, channel=None, on_message=1, off_message=0, loop_mode=0, loop_intervals=0, send_events=1, oneset_triggers=None)

Sets the duration of a global timer. Unlike state timers, global timers can be triggered from any state (as an output action), and handled from any state (by causing a state change).

Parameters:

• timer_ID (int) – the number of the timer you are setting (an integer, 1-5).

• timer_duration (float) – the duration of the timer,

following timer start (0-3600 seconds) :param float on_set_delay: :param str channel: channel/port name Ex: ‘PWM2’ :param int on_message:

set_global_timer_legacy(timer_id=None, timer_duration=None)

Set global timer (legacy version)

Parameters:

• timer_ID (int)

• timer_duration (float) – timer duration in seconds