Protocol Operation¶

Allows generation of predefined series of stimuli, with ability to automaticaly manipulate stimuli parameters through ranges of given values. Provides an interface for the construction of custom composite stimuli.

The central table is a list of the tests to be presented, in order. At the bottom are different editors for creating/editing tests.

To add a test, drag an editor type into the protocol list area
To remove a test, drag it to the trash icon
To reorder a test, drag it to the desired location
To edit a test, double click anywhere in its row, an editor should pop up in its own window

Once you have all your tests set up, select the Start button and all the the prepared stimlui will be presented in the appropriate order. The currently playing stimulus will be detailed in the Stimulus Details subwindow. Which details appear in the window may be customized under the view menu. A progress of the spike counts will display in the progress subwindow.

Editor Types¶

Builder¶

Components¶

Construction Tool for creating composite stimuli. Components are arranged in tracks in the central area. The tracks allow the overlapping of components. The order of the tracks(top-bottom) makes no difference to the end signal. The order of components in the tracks (left-right) does matter, and is temporal.

To add a component, drag its label from the area on the right into the central area. Its editor will automatically pop up. To accept press enter or use the x in the corner of the window.
To remove a component, click and drag it to the trash icon
To reorder a component, click and drag it to the desired location
To edit a component, double click it
To create space between components, add and interval of silence, from the components list
The reps field represents how many repetitions of each unique stimulus will be presented (Batab sweeps).
The Preview Spectrogram button will generate a spectrogram of the current components in the view.
To accept, press the ok button or x in the corner of the window
Save As will allow you to save this stimulus, so that you may reload it another time. Stimuli are save in JSON format.
The info field will provide hints on how to use this editor

Auto-Parameters¶

Known as an autotest in Batlab. There are two ways to set up the auto-parameters depending on which parameter you are manipulating. If you wish to loop through different vocalizations by file, skip ahead to Auto-filenames. For all other parameters just keep reading.

Click the arrow at the bottom of the editor to expand this section. This will place the editor into selection mode, which does not allow re-ordering or editing of components.

First, add a new auto-parameter by dragging the add label into the now revealed and empty table area.
Then you must first select at least one component for this parameter to affect. The selected component will highlight itself blue, when it is selected. You may select as many components as you want for a parameter, and they are toggled out of the selection by clicking them again. The component must be selected before the parameters are set because the available parameters depend on the component type.
Now select the type of parameter to manipulate by clicking the leftmost cell in the table, and selecting from the drop-down menu. This menu will only display available parameters for the component types you have in the selection. You may have different types of parameters in a single selection, and it will only display the parameters which these stimulus types have in common.
Enter the desired start, stop, and step increments. Hovering your mouse over these field should display the units. The units should also match the rest of the program, so If you are using frequency in kHz elsewhere, it will be in kHz here too. The number of steps this results in will update in the last field. The number of steps is automatically determined, and cannot be edited.

To remove a parameter, click and drag it to the trash icon
To reorder a parameter, click and drag it to the desired location
You can add as many auto-parameters as desired, they will combine and loop through in the order listed. E.g. If you have a range of 5 frequency changes, followed by 3 Intensity changes, the stimuli generated will present each frequency for the first intensity, then move on and present each frequency for the second intensity, and likewise for the third. Unless However, you tick the randomize box, then the stimuli will be shuffled to be presented in a random order. This will change for repeat presentations of a test. Trace repetitions (the same stimulus) are always presented in succession.
Notice that when you click different parameters (rows of the parameter table), the selections change in the component view to reflect which components belong to what parameter.
If you enter a start value that is different from the value in the component(s) selected, it will automatically update in the main view, when exiting auto-parameter mode.
Collapse the Auto-parameter area to go back to component editor mode.

Auto-filenames¶

An exception to how auto-parameters are assembled, is when looping by filename for audio recordings. Instead, in the editor for the vocalization component, select multiple files by either: click and drag, Shift+click, or Ctrl+click.

To arrange the order in which there are presented click the order button. An entry in the regular auto-parameters editor (described above), will be made, and you can re-arrange this auto-parameter’s order with respect to other auto-parameters there.

Tuning Curve¶

Creates tuning curve out of pure tones, by running through a series of frequency and intensity settings.

Duration field is for tone duration
Reps field is number of repetitions for each frequency-intensity combo (Batlab sweeps)
Risefall field is the rise and fall value (combined) for the generated tone

This exact tuning curve can actually be created using the builder, this editor is a shortcut.

Saved¶

Stimuli that were created previous and saved, may be loaded using this option. When you drag the Saved tile onto the protocol list, a file dialog will appear for you to select the stimulus file.

Note that saved stimuli that contain audio file recordings in them will expect that file to be in the same place in the file system from when it was saved.