protocol

Classes:

`Graduation_Widget`(self, /[, parent, f, ...])	A widget used in `Protocol_Wizard` to define graduation parameters.
`Sound_Widget`(self, /[, parent, f, modal, ...])	A widget that allows sounds to be parameterized.

Bases: QWidget

A widget used in Protocol_Wizard to define graduation parameters.

See tasks.graduation .

A protocol is composed of multiple tasks (steps), and graduation criteria define when a subject should progress through those steps.

eg. a subject should graduate one stage after 300 trials, or after it reaches 75% accuracy over the last 500 trials.

Variables:

type_selection (QtWidgets.QComboBox) – A box to select from the available graduation types listed in autopilot.get_task() . Has its currentIndexChanged signal connected to Graduation_Widget.populate_params()
param_dict (dict) – Stores the type of graduation and the relevant params, fetched by Protocol_Wizard when defining a protocol.
set_graduation (Protocol_Wizard.set_graduation()) – Passed to us after we’re inited.

Initialize self. See help(type(self)) for accurate signature.

Methods:

`populate_params`([params])	Repopulate the widget with fields to edit graduation parameters, fill fields if we are passed params.
`clear_params`()	Clear any parameter widgets we have.
`store_param`()	When a parameter is edited, save it in our param_dict, and also call our set_graduation method, which should be `Protocol_Wizard.set_graduation()` passed to us after instantiation.

Attributes:

staticMetaObject

populate_params(params=None)[source]

Repopulate the widget with fields to edit graduation parameters, fill fields if we are passed params.

Each QtWidgets.QLineEdit ‘s QLineEdit.editingFinished() signal is connected to Graduation_Widget.store_param() .

Todo

For now we assume all parameters are defined with a text edit box, so it’s not clear how we’d do boolean parameters for example. This will be fixed with refactoring the parameter scheme.

Parameters:: params (dict) – In the case that Protocol_Wizard switches us back to a step where we have already defined graduation parameters, it will pass them so we can repopulate the relevant widgets with them.

clear_params()[source]: Clear any parameter widgets we have.

store_param()[source]

When a parameter is edited, save it in our param_dict, and also call our set_graduation method, which should be Protocol_Wizard.set_graduation() passed to us after instantiation.

If we were not passed set_graduation, just saves in param_dict.

staticMetaObject = PySide6.QtCore.QMetaObject("Graduation_Widget" inherits "QWidget": )

Bases: QWidget

A widget that allows sounds to be parameterized.

Used in Protocol_Wizard .

Has two Drag_List s for left and right sounds (for a 2afc task), given Buttons beneath them allow adding and removing sounds.

Adding a sound will open a Add_SoundDialog

Todo

Sounds will eventually be more elegantly managed by a … sound manager.. For now sound managers are rudimentary and only support random presentation with correction trials and bias correction.

Variables:

sound_dict (dict) –

Dictionary with the structure:

{'L': [{'param_1':'param_1', ... }], 'R': [...]}

where multiple sounds can be present in either ‘L’ or ‘R’ list.

Initialize self. See help(type(self)) for accurate signature.

Methods:

`pass_set_param_function`(set_param_fnxn)	Receives `Protocol_Wizard.set_sounds()`
`add_sound`(side)	When the "+" button on either side is pressed, open an `Add_Sound_Dialog`.
`remove_sound`(side)	When the "-" button is pressed, remove the currently highlighted sound.
`populate_lists`(sound_dict)	Populates the sound lists after re-selecting a step.
`files_dropped`(files)

Classes:

Add_Sound_Dialog(self, /[, parent, f, ...])

Presents a dialog to define a new sound.

Attributes:

staticMetaObject

pass_set_param_function(set_param_fnxn)[source]

Receives Protocol_Wizard.set_sounds()

Parameters:: set_param_fnxn (Protocol_Wizard.set_sounds()) – Called when sounds are changed.

add_sound(side)[source]

When the “+” button on either side is pressed, open an Add_Sound_Dialog.

Parameters:: side (str) – The buttons are connected with a lambda function, this will be either ‘L’ or ‘R’. Used to add sounds to the sound_dict

remove_sound(side)[source]

When the “-” button is pressed, remove the currently highlighted sound.

Parameters:: side (str) – The buttons are connected with a lambda function, this will be either ‘L’ or ‘R’. Selects that list so we can remove the currently selected row.

populate_lists(sound_dict)[source]

Populates the sound lists after re-selecting a step.

Parameters:: sound_dict (dict) – passed to us by Protocol_Wizard upon reselecting a step.

files_dropped(files)[source]

Warning

This was programmed hastily and is pretty idiosyncratic to my use.

It does work for general files but has some extra logic built in to handle my stimuli.

To be made more general in v0.3

Note

Sounds must be in the folder specified in prefs.get(‘SOUNDDIR’).

When files are dropped on the lists, strips prefs.get(‘SOUNDDIR’) from them to make them relative paths, adds them to the sound_dict

Parameters:: files (list) – List of absolute paths.

class Add_Sound_Dialog(self, /, parent: PySide6.QtWidgets.QWidget | None = None, f: PySide6.QtCore.Qt.WindowType = Default(Qt.WindowFlags), *, sizeGripEnabled: bool | None = None, modal: bool | None = None)[source]

Bases: QDialog

Presents a dialog to define a new sound.

Makes a selection box to choose the sound type from autopilot.get_names('sound'), and then populates edit boxes so we can fill in its PARAMS .

Variables:

type_selection (QtWidgets.QComboBox) – Select from a list of available sounds
param_dict (dict) – Parameters that are retreived by the calling Sound_Widget.

Initialize self. See help(type(self)) for accurate signature.

Methods:

`populate_params`()	When a sound type is selected, make a `QtWidgets.QLineEdit` for each PARAM in its definition.
`clear_params`()	Clear all current widgets
`store_param`()	When one of our edit boxes is edited, stash the parameter in param_dict

Attributes:

staticMetaObject

populate_params()[source]: When a sound type is selected, make a QtWidgets.QLineEdit for each PARAM in its definition.

clear_params()[source]: Clear all current widgets

store_param()[source]: When one of our edit boxes is edited, stash the parameter in param_dict

staticMetaObject = PySide6.QtCore.QMetaObject("Add_Sound_Dialog" inherits "QDialog": )

staticMetaObject = PySide6.QtCore.QMetaObject("Sound_Widget" inherits "QWidget": )