NIMH ML: Docs

bhv_code

This function assigns string labels to numeric behavioral codes.

Syntax:

bhv_code(code_number1, code_name1, code_number2, code_name2, ...);

Example:

'Fixation cue on'

'Sample'

'Delay'

'Go'

'Reward'

bhv_variable

This function stores the current values of variables to the data file.

Syntax:

bhv_variable(var_name1, var_value1, var_name2, var_value2, ...);

Example:

'direction'

'choice'

Remarks:

If the function is called multiple times for the same variable, only the value at the very last call is stored.

dashboard

This function displays user texts on the control screen.

Syntax:

dashboard(line_number, text, color); dashboard(line_number, text, color, property1, value1, property2, value2, ...); dashboard(line_number, text, property1, value1, property2, value2, ...);

Input arguments:

line_number: Ten lines of strings can be displayed.

Example:

'DMS Task'

'Choice: %d'

'bgcolor'

Remarks:

This function does not update the screen itself. For the text to be displayed, one of screen update commands (toggleobject, eyejoytrack, idle or run_scene) should be followed.
The text stays on the screen even after the end of a trial, until it is modified by another dashboard call. To delete it, assign an empty string ('').

editable

This function registers variables to the edit menu.

Syntax:

editable(var_name1, var_name2, ...); editable(type, var_name); editable(type, {var_name1, var_name2, ...});

Input arguments:

type: '-file', '-dir', '-color', '-category' or '-range'

Example:

'fix_duration'

'-file'

'parameter_file'

% 'parameter_file' is a file type

% color should be between 0 and 1

'-color'

'face_color'

'edge_color'

% multiple variables with one type indicator

'Red'

'Green'

'Blue'

% the last element indicates the selected item

'-category'

'category1'

% [min max step value]

'-range'

'range1'

% adjust the value (the 4th element) with a slider control

Remarks:

Editable variables must be initialized in the timing script with specific values (numbers or characters). They cannot be initialized with other variables or return values of functions.

var1 = 1000;
editable('var1');  % okay

var1 = 1000;
var2 = var1;       % initialized with another variable
editable('var2');  % error!!!

Variables with no type should be logical or double with 6 elements or fewer.
The type argument allows users to invoke MATLAB GUI controls to pick up a filename, a directory name or a color.
The variable types for '-file' and '-dir' should be char.
The '-color' variable should be a 1-by-3 vector, [R G B], between 0 and 1.
The '-category' type must be a cell char array. Its last element is the currently selected item.
The '-range' type must be a 1-by-4 vector, [min max step value]. Its last element is the currently determined value.
For editable variables, trial-by-trial change histories are recorded in the data file. Check the VariableChanges field in the data file.

See the 'task\runtime v1\9 editable demo' directory for more examples.
Editable variables can be accessed in the user functions (e.g., userloop), like TrialRecord.Editable.var_name. See 'task\userloop\3 access editables from userloop'.
'reward_dur' is an editable, by default. It is inherited from the original MonkeyLogic. The value of reward_dur can be adjusted with the '-' and '+' keys by 10 (msec).

escape_screen

This function pauses the task after the current trial.

Syntax:

escape_screen;

eventmarker

This function marks the current time with eventcodes. The eventcodes can also be sent to external devices, if Behavioral Codes and Strobe Bit are assigned on the main menu I/O panel.

To more accurately mark onset times of stimuli or rewards, use the eventmarker option of toggleobject and goodmonkey or the eventcode argument of run_scene, instead of this function.

Syntax:

eventmarker(eventcodes);

Example:

eventmarker([10 20 30]);

eye_position / eye2_position / joystick_position / joystick2_position

These functions return the current eye or joystick position. The return values are in degrees.

Syntax:

xy_deg = eye_position; [x_deg y_deg] = eye_position;

forced_eye_drift_correction

This function translates the current eye calibration grid to a new origin.

Syntax:

forced_eye_drift_correction; forced_eye_drift_correction(origin); forced_eye_drift_correction(origin, eye_num);

Input arguments:

origin: [x y] in degrees
eye_num: 1 for eye1 (default), 2 for eye2

Example:

% correct eye 1. see the remarks.

% correct eye 2. see the remarks.

% [1 0] will be the new center of eye2

Remarks:

In case the origin argument is not provided or is empty, this function determines the new origin based on these rules.

- [0 0], if there is no visual TaskObject on the screen
- The position of the visual TaskObject, if there is only one object on the screen
- The position of the visual TaskObject closest to the current eye position, if there are multiple objects on the screen

The position of the new origin will be recorded in the VariableChanges field of the data file at the end of each trial.

get_analog_data

This function returns the most recently acquired analog samples of the specified signal.

Syntax:

data = get_analog_data(sig_name); data = get_analog_data(sig_name, num_samples); [data, sample_rate] = get_analog_data(__);

Input arguments:

sig_name: Case-insensitive.

'eye'
'eye2'
'eyeextra' (extra eye data received via TCP/IP)
'joy' or 'joystick'
'joy2' or 'joystick2'
'touch'
'mouse'
'mousebutton'
'key'
'gen#' or 'general#' (e.g., 'gen1', 'general1')
'btn#' or 'button#' (e.g., 'btn1', 'button1')
'high#' or 'highfrequency#' (e.g., 'high1', 'highfrequency1')
'voice'
'lsl#' (data received from the lab streaming layer)

num_samples: Number of samples to return. 1 by default.

Return values:

data is an n-by-m matrix where n is the number of samples and m is the number of channels, depending on the signal type.
sample_rate is the actual sample rate of the signal. See the remarks below for more information.

Example:

'eye'

% data will be a 1000-by-2 matrix

Remarks:

This function takes a snapshot of the most recently acquired data backward in time and returns immediately.
The size of data can be less than num_samples, if the number of recorded samples is small.
Check sample_rate for the actual sample rate of the data. Most analog signals are sampled at 1 kHz, regardless of the [AI sample rate] setting on the main menu. High frequency channels, voice and the lab streaming layer are sampled at their own rates, not at 1 kHz.

get_object_duration

This function returns the durations of MOV and SND objects.

Syntax:

duration = get_object_duration(taskobjects);

Example:

% get durations (in milliseconds) of TaskObject#1 and #2

getkeypress

This function waits for a key input.

Syntax:

[scancode, rt] = getkeypress(max_time);

Remarks:

To retrieve the scancode of a particular key, call the kbdkeycode function on the MATLAB command window.

goodmonkey

This function initiates timed reward pulses to reward devices.

Syntax:

goodmonkey(duration); goodmonkey(duration, option1, value1, option2, value2, ...);

Input arguments:

duration: In milliseconds
options: Case-insensitive. All options should be paired with values.

NumReward - Number of drops
PauseTime - Interval between drops, in milliseconds
TriggerVal - Triggering voltage, for analogoutput only
JuiceLine - Reward channel to trigger, for digital output only. Multiple lines need to be assigned to Reward in the Input/Output menu.
EventMarker - Behavioral(s) code to stamp for each drop. Multiple codes can be given. For example, [10 20 30] will mark 10 for the 1st drop, 20 for the 2nd and 30 for the 3rd.
NonBlocking - Deliver reward in the background so that the task is not blocked.
- 0 (blocking, by default)
- 1 (non-blocking, yield to other threads)
- 2 (non-blocking, do not yield, more precise timing)

Example:

'juiceline'

'numreward'

'pausetime'

'eventmarker'

'nonblocking'

hotkey

This function defines a key macro.

Syntax:

hotkey(key, things-to-do);

Input arguments:

key: one letter among '`1234567890-=qwertyuiop[]\asdfghjkl;''zxcvbnm,./'
or 'esc', 'rarr', 'larr', 'uarr', 'darr', 'numrarr', 'numlarr', 'numuarr', 'numdarr', 'space', 'bksp', 'f1' - 'f12'

Example:

'r'

'goodmonkey(reward_dur, ''juiceline'', MLConfig.RewardFuncArgs.JuiceLine,'

'''eventmarker'', 14, ''nonblocking'', 1);'

% manual reward

'x'

'escape_screen(); assignin(''caller'',''continue_'',false);'

% stop the task immediately

idle

Syntax:

idle(duration); idle(duration, screen_color); idle(duration, screen_color, eventcodes);

Input arguments:

duration: In milliseconds
screen_color: New background color, [R G B]; can be an empty vector ([]) if the change is not necessary
eventcode: Code(s) to stamp when the screen color changes

Remarks:

When the screen_color is given, the background color changes for the duration and goes back to the initial color. See set_bgcolor, for how to change it permanently.

include

This function includes other script files into the timing script.

Syntax:

include(filepath1, filepath2, ...);

Example:

'common_hotkeys.txt'

'common_editables.m'

Remarks:

The script names must be statsic strings. They cannot be determined dynamically.

istouching

Syntax:

tf = istouching;

Return values:

tf: true if the screen is being touched. Otherwise, false.

mouse_position

This function returns the current mouse position and the button/key state.

Syntax:

xy_deg = mouse_position; [xy_deg, buttons, keys] = mouse_position; xy = mouse_position('raw');

Return values:

buttons: A 1-by-2 logical vector, [left right]; 1 - clicked, 0 - not clicked
keys: States of keys registered in the main menu, a 1-by-n logical vector; 1 - pressed, 0 - not pressed

Remarks:

If any argument is provided, the function returns Windows coordinates of the mouse cursor ("raw" values). Otherwise, the return value is in degrees.

reposition_object

This function moves graphic objects to new locations.

Syntax:

reposition_object(taskobjects, xy_degs);

Input arguments:

xy_degs: An n-by-2 matrix.

Example:

% move TaskObject#1 to [-5 0] and TaskObject#2 to [5 0]

rescale_object

This function changes the size of graphic objects to the given scale.

Syntax:

rescale_object(taskobjects, scale);

Input arguments:

scale: Ratio. 1 indicates the original size. Use two-element vectors to apply different scales to width and height.

Example:

% make TaskObject#1 & #2 twice larger in both X and Y directions.

% TaskObject#1 twice larger in X and TaskObject#2 three times in Y

rotate_object

This function rotates graphic objects.

Syntax:

rotate_object(taskobjects, angle);

Input arguments:

angle: In degrees.

Example:

% rotate TaskObject#1 & #2 by 45 and 60 degrees, respectively

rewind_object

This function moves the playback positions of MOV and SND TaskObjects.

Syntax:

rewind_object(taskobjects); rewind_object(taskobjects, position);

Input arguments:

position: In milliseconds. 0, by default, if not given.

Example:

% rewind TaskObject#1 & #2 to 0 sec

% move their playback positions to 0.5 sec and 1 sec, respectively

set_bgcolor

This function changes the background color of the subject screen.

Syntax:

set_bgcolor(bgcolor);

Input arguments:

bgcolor: New background color, [R G B]; can be an empty vector ([]) to switch back to the original background

Example:

% change the background color to red

% change it back to the original color

% show the original background

Remarks:

To make this color change shown, one of screen update commands (toggleobject, eyejoytrack, idle or run_scene) should be followed

set_iti

This function overwrites the default inter-trial interval set on the main menu.

Syntax:

set_iti(duration);

Remarks:

If this function is not called, the ITI is reset to the value provided on the main menu.

touch_position

This function returns xy coordinates of the places that are currently being touched.

Syntax:

xy_deg = touch_position;

Return values:

xy_deg: a 1-by-(2 * # of touches) vector, like [x1 y1 x2 y2 x3 y3 ...]. If the touchscreen is not enabled, it is empty.

Remarks:

The total number of touches that can be simultaneously tracked can be set on the main menu. It is also dependent on the touchscreen's capability.
Untouched/detached coordinates are filled with NaN.

trialerror

This function records the error code of the current trial to the TrialRecord structure.

Syntax:

% overwrite the default error labels

% put a single number to mark the error code

% use a text label, instead; case-insensitive

Example:

'Error 1'

'Error 2'

'Error 3'

% change the labels of error codes 1, 2 and 3

% mark the current trial as Correct

'Correct'

% the same as above

Input arguments:

Error code:

0 - Correct
1 - No response
2 - Late response
3 - Break fixation
4 - No fixation
5 - Early response
6 - Incorrect
7 - Lever break
8 - Ignored
9 - Aborted

Remarks:

The first syntax can be used to overwrite the default error labels. The input argument should be number/label pairs. This has to be done before calling the function again for marking an error code.
The numeric code 0 always indicates a correct/succeeded trial, irrespective of its label.

trialtime

This function returns the time elapsed from the trial start in milliseconds.

Syntax:

time = trialtime;

user_text / user_warning

This function displays user texts on the control screen GUI at the end of a trial.

Syntax:

user_text(message); user_warning(message);

Remarks:

user_text displays messages in blue and user_warning, in red.

eyejoytrack

This function monitors behavioral signal inputs.

Syntax:

% single tracking

% multi-tracking

% multiple return values; see Remarks.

Input arguments:

tracking_type: Choose one according to the signal type and the behavior type (Acquisition or Hold). The difference between Acquisition and Hold is whether the XY input is outside the threshold window or inside at the beginning. eyejoytrack terminates immediately, if the signal crosses the threshold window. Otherwise, it runs for the entire duration.

Signal type	Acquisition	Hold	Inverse acquisition
eye	'acquirefix'	'holdfix'
eye2	'acquirefix2'	'holdfix2'
joystick	'acquiretarget'	'holdtarget'
joystick2	'acquiretarget2'	'holdtarget2'
touch	'touchtarget'	'releasetarget'	'~touchtarget'
button	'acquiretouch'	'holdtouch'
function	'acquirefunc'	'holdfunc'

taskobject: TaskObject# (for eye, joystick, touch) or Button# (for button)
threshold: The target window size (for eye, joystick, touch) or voltage threshold (for button). A scalar creates a circular window; and a 1-by-2 vector, a rectangular window. Multiple rectangular windows can be set with a matrix [w1 h1; w2 h2; ...].
duration: In milliseconds

Example 1: single tracking

'acquirefix'

% ontarget will be 1 if the eye comes in the 3-deg

% window around TaskObject#1 within 5000 ms.

Example 2: multi-tracking

'acquirefix'

% eyejoytrack ends immediatly when eye fixation is

'holdtouch'

% acquired or either button is released. ontarget

'holdtouch'

% will be a 1-by-3 vector.

Remarks:

For the usage of the additional return values (rt & t_resp), see Migrating from the Original MonkeyLogic, Reaction time.
For Acquisition, multiple TaskObjects can be assigned as a vector. In that case, the return value is the ordinal number of the acquired target. Only one TaskObject should be used for Hold.

ontarget = eyejoytrack('acquirefix', [2 3 5], 3, 5000);  % eyejoytrack will return 3, if the eye
                % fixates on TaskObject#5, because TaskObject#5 is the third object in the list.

For button input, use Button# from the main menu I/O panel, instead of TaskObject#. The threshold can be either a voltage level or an empty vector (default threshold). The default threshold is 3 for analog buttons and 0.5 for digital buttons.

ontarget = eyejoytrack('acquiretouch', 2, 5, 500);  % Button #2; input voltage should be larger
                                                    % than 5V when the button is pushed.
													
ontarget = eyejoytrack('holdtouch', 1, [], 500);    % Button #1; use the default threshold.

'~touchtarget' is a tracking type available for touch input only. eyejoytrack will return 1 when the outside of the threshold window is touched.
'acquirefunc' and 'holdfunc' allow using a user function as a signal source. The user function should return true (inside the threshold window) or false (outside the threshold) to mimic the Acquisition and Hold behavior. The threshold variable (input_args below) is used as input arguments to the user function. Use a cell to provide multiple arguments to the function.

ontarget = eyejoytrack('acquirefunc', @function_handle, input_args, duration);

To monitor more than one behavior types simultaneously, you must use the syntax for multi-tracking (Example 2) and put them in one eyejoytrack command. If multiple tracking types are provided, eyejoytrack returns a vector, in which each element indicates the success state of those tracking types. eyejoytrack will stop when threshold crossing occurs in any of them.

ontarget = eyejoytrack('acquirefix', 1, 3, 'holdtouch', 1, [], 2000); % track for 2 sec

Eye fixation	Button state	eyejoytrack returns	ontarget
not acquired	released	immediately on release	[0 0]
not acquired	held down	after 2 sec	[0 1]
acquired	released	immediately on fixation/release	[1 0]
acquired	held down	immediately on fixation	[1 1]

set_frame_event

This function marks the time with eventcodes when particular frames are presented.

Syntax:

set_frame_event(taskobject, frame_numbers, eventcodes);

Input arguments:

frame_numbers & eventcodes: The lengths of both vectors must be the same.

set_frame_order

This function rearranges the order of movie frames.

Syntax:

set_frame_event(taskobject, frame_order);

Input arguments:

frame_order: If empty, the frames are reset to the original order.

set_object_path

This function translates a graphic object through a given path.

Syntax:

set_object_path(taskobject, xy_deg); set_object_path(taskobject, x_deg, y_deg);

Remarks:

To show the motion, either idle or eyejoytrack needs to be called.

showcursor / showcursor2

This function turns on and off the joystick cursor on the subject screen. By default, it is off. showcursor2 is for the 2nd joystick.

Syntax:

showcursor(status);

Input arguments:

status: Can be 'on'/'off' (char) or true/false (logical).

Example:

showcursor(true);

Remarks:

Turning off the cursor when it is already off removes the cursor from the control screen as well.
For the scene framework (v2), use joy_.showcursor() and joy2_.showcursor(), instead.

showtouch

This function turns on and off the touch cursor on the subject screen. By default, it is off.

Syntax:

showtouch(status);

Input arguments:

status: Can be 'on'/'off' (char) or true/false (logical).

Example:

showtouch(true);

Remarks:

Turning off the cursor when it is already off removes the cursor from the control screen as well.
For the scene framework (v2), use touch_.showcursor().

toggleobject

This function turns on and off TaskObjects.

Syntax:

fliptime = toggleobject(taskobjects); fliptime = toggleobject(taskobjects, option1, value1, option2, value2, ...);

Input arguments:

options: Case-insensitive. All options should be paired with values.

EventMarker - Behavioral code(s) to stamp at the presentation of the taskobject.
Status - 'on' or 'off'. Manually determines the status of the taskobjects
MovieStartFrame, MovieStep, StartPosition, PositionStep - These options are deprecated. To adjust the speed of movies, change their frame time with movie editing software.

Return values:

fliptime: The trialtime at which the screen "flip" occurs. In milliseconds.

Example:

'eventmarker'

'status'

'off'

% turn off both objects

Remarks:

If only non-visual stimuli (SND, STM and TTL) are provided, they are presented immediately without waiting for the screen flip.
When non-visual and visual stimuli are given together, the presentation of non-visual stimuli is synchronized with the screen flip timing.
If the Status option is not used, the state of each object is toggled individually.

% Example 1
toggleobject(1, 'status', 'off');     % TaskObject#1 OFF
toggleobject(2, 'status', 'on');      % TaskObject#2 ON
toggleobject([1 2], 'status', 'on');  % Both TaskObject#1 and #2 are ON

% Example 2
toggleobject(1, 'status', 'off');
toggleobject(2, 'status', 'on');
toggleobject([1 2]);                  % TaskObject#1 ON; TaskObject#2 OFF

Do not put the stimuli that should be presented simultaneously in separate toggleobject commands.

% Example 1
toggleobject(1);
toggleobject(2);      % TaskObject#2 is turned on one frame later than TaskObject#1

% Example 2
toggleobject([1 2]);  % TaskObject#1 & #2 are turned on simultaneously

create_scene

This function collects the information of the adapter chain for the offline trial replay.

Syntax:

scene = create_scene(adapter, taskobjects);

Input arguments:

taskobjects: TaskObject# to present during the scene; can be a vector of multiple TaskObjects

Example:

% TaskObject#1

% 3 degrees

% present TaskObject#2 additionally

Remarks:

The "adapter" argument provided to create_scene is important, because run_scene ends when that adapter stops.
TaskObjects inserted to the scene by create_scene are terminated at the end of the scene, unless they are inserted in the next scene as well.
Also see How to create adapter chains.

run_scene

This function runs the adapter chain.

Syntax:

fliptime = run_scene(scene, eventcodes);

Input arguments:

scene: This is the return value of create_scene.
eventcodes: Eventcode(s) to send out when the first frame of the scene is presented.

Return values:

fliptime: The trialtime (in milliseconds) at which the first frame of the screen is presented

Example:

% graphic object

% 3 degrees

% Eventcode 10 will be marked when the first frame is presented

Remarks:

This function does not end until the top-most adapter in the chain (the one provided to create_scene) stops. For the stop conditions of adapters, see the description of each adapter.

EyeTracker, Eye2Tracker, JoyTracker, Joy2Tracker, TouchTracker, ButtonTracker, MouseTracker, NullTracker

Users do not need to create tracker objects. They are pre-defined with reserved names in the timing script: eye_, eye2_, joy_, joy2_, touch_, button_, mouse_ and null_.

Success Condition:

Success: true if there are data samples read; otherwise, false

Stop Condition:

Trackers never stop the scene and should be used with other adapters.

Tracker Properties:

All trackers have common properties like the following.

Signal: The name of the signal that it reads ('Eye', 'Eye2', 'Joystick', 'Joystick2', 'Touch', 'Button', 'Mouse', 'Null')
Screen: The instance of the mlscreen object
DAQ: Data acquisition object
TaskObject: Task objects
CalFun: Calibration object

Every adapter in a chain can access the above objects via its Tracker property, which is a convenient way to get the information about screens, data sources and TaskObjects from the inside of the adapter.

obj.Tracker.Signal obj.Tracker.Screen obj.Tracker.DAQ obj.Tracker.TaskObject obj.Tracker.CalFun

The trackers also have the following data fields for different types.

eye_, eye2_ joy_, joy2_ touch_ button_ mouse_ null_

XYData
LastSamplePosition XYData
LastSamplePosition XYData
LastSamplePosition ClickData
LastSamplePosition XYData
ClickData
KeyInput
LastSamplePosition

XYData: An n-by-2 XY position matrix in screen pixels. In case of touch, 2 more columns are added for each additional touch (e.g., [x1 y1 x2 y2 ...]) and they are filled with [NaN NaN] when there is no touch.
ClickData: States of buttons; logical true (pressed) or false (released)
KeyInput: States of keys specified in the Mouse/Key menu; logical true (pressed) or false (released)
LastSamplePosition: Cumulative number of samples acquired before XYData, MouseData and ClickData were read. So the total number of samples read so far is LastSamplePosition + size(XYData,1).

These fields are continuously updated with data acquired during the previous frame (or data acquired before the scene start, if it is the very first frame of the scene). So, at a refresh rate of 60 Hz, about 16-17 samples are kept in each of them (except LastSamplePosition) from moment to moment.

The joystick cursors can be modified in the timing file via the following properties. Use joy2_ for the second joystick.

joy_

% image filename; when this is set, the other properties are ignored.

joy_

% cursor shape; 'Circle' or 'Square'

joy_

% [R G B] between 0 and 1

joy_

% in pixels

Tracker Methods:

joy_

% show the cursor of the 1st joystick to the subject; false, by default

joy2_

% show the cursor of the 2nd joystick to the subject; false, by default

touch_

% show the touch cursor on the subject screen; false, by default

Calling joy_.showcursor(false) or touch_.showcursor(false) one more time while the cursor is hidden removes the cursor from the control screen as well.

button_

% change the threshold of the analog button

button_

% invert the polarity of the button

button_

% rename the button icon on the control screen

When a button is inverted with button_.invert(), the input from the button is saved as inverted in the data file. If you want to change the polarity of a button but not the saved values, use NotAdapter (see its usage example for details).

mouse_

% hide the mouse cursor from the subject; true, by default

mouse_

% move the mouse cursor to the given location

SingleTarget

This adapter tells whether the position of a XY tracker (eye_, joy_, touch_ and mouse_) is within or outside the threshold window.

Success Condition:

Success: true while the position of the XY tracker is within the threshold window; otherwise, false

Stop Condition:

When Success becomes true

Input properties:

Target: Graphic adapter, TaskObject# or a 2-element vector, [x y], in degrees
Threshold: Size of the threshold window around the Target; a scalar (circle radius) or [width height] (rectangle) in degrees.
Color: Color of the threshold window shown on the control screen; [R G B]

Output properties:

Time: trialtime when the XY tracker crossed the threshold window; in milliseconds

Methods:

setTarget(graphic_obj, index): If the graphic adapter contains multiple objects, use the optional index argument to indicate which object should be used.

Example 1:

% red square

% green square

% blue square

% SingleTarget needs only one target and will use the red square.

% rectangular window

% The scene will end when the fixation is acquired.

Example 2:

% red square

% green square

% blue square

% Set the blue square as a target.

% moving target with CurveTracer

Example 3:

% Use XY coordinates to create an off-center window.

% Display the box, since SingleTarget won't do.

Remarks:

To prevent a jitter from being detected as a fixation, SingleTarget does not change its Success state until the tracker stays within the threshold window at least for one frame.
If Target is a graphic adapter or a TaskObject, the target graphic will appear and disappear automatically. When [x y] is the target, nothing is displayed by SingleTarget.
To implement a moving target, SingleTarget's Target property must be empty. Use the Target property of CurveTracer instead, as shown in Example 2.

MultiTarget

This adapter monitors the capture of an XY tracker for multiple targets.

Success Condition:

Success: true when one target is chosen AND the choice is maintained for HoldTime

Stop Condition:

When Success becomes true
When WaitTime is expired without any fixation attempt or, if AllowFixBreak is false, when the acquired fixation is broken before HoldTime passes
When AllowEarlyFix is false and a fixation is made before the first frame of the scene

Input properties:

Target: Graphic adapter(s), TaskObjects, or an n-by-2 matrix ([x1 y1; x2 y2; ...]) in degrees
Threshold: Radius or [width height] of the detection window around the Target; in degrees
WaitTime: Maximum time to wait until one of the targets is chosen; in milliseconds
HoldTime: Duration for which the choice should be maintained; in milliseconds
Color: Color of the threshold window shown on the control screen; [R G B]
AllowFixBreak: true or false (by default); if true, fixation break is allowed before commiting to one target
TurnOffUnchosen: true (by default) or false to determine whether to turn off unchosen targets during HoldTime. It is meaningful only when AllowFixBreak is false.
AllowEarlyFix: true (by default) or false. When it is false, the scene stops immediately if a fixation is made before the scene starts.

Output properties:

Waiting: true if the choice was never made
AcquiredTime: trialtime when the XY tracker crossed the threshold window of the chosen target
RT: Reaction (or response) time, which is the difference between the time of the first frame of the scene and the AcquiredTime
ChosenTarget: TaskObject#, if the targets were TaskObjects; the ordinal number of the chosen target, if the targets were graphic adapters or XY coordinates. This property is set only when MultiTarget succeeded.
ChoiceHistory: [ChosenTarget1 AcquiredTime1; ChosenTarget2 AcquiredTime2; ...]; this property is set whether MultiTarget succeeded or not.

Methods:

setTarget(graphic_obj, index): This method assigns the first target graphic adapter. If the adapter contains multiple objects and only some of them should be included, use the optional index argument.
addTarget(graphic_obj, index): Any additional adapter target should be assigned with this method.

Example 1:

% red square

% green square

% blue square

% white square

% The four squares

Example 2:

% Target #1

% Target #2

'A.bmp'

'B.bmp'

% Target #3 & #4

% first target

% additional target

% additional targets

Remarks:

To prevent a jitter from being detected as a fixation, MultiTarget does not change its Waiting state until the tracker stays within the threshold window at least for one frame.
When stacking multiple adapter targets, the first adapter is assigned with setTarget() but subsequent assigments must use addTarget(). See Example 2 above.
The meaning of ChosenTarget is different, depending on the Target type. If the targets are TaskObjects, the number that ChosenTarget returns is TaskObject#; for graphic adapters and XY coordinates, it is the ordinal number of the selected target.
MultiTarget can work with one target, when a graphic adapter is used as the target. For TaskObjects or XY coordinates, it requires at least two targets.

WaitThenHold

This adapter checks if the Success state of the child adapter becomes true within WaitTime and stays true for HoldTime. It can be used to test if eye fixation or touch is acquired and maintained.

Success Condition:

Success: true if the Success of the child adapter becomes true within WaitTime AND stays true for HoldTime; false, until then.

Stop Condition:

When Success becomes true
When WaitTime is over without any fixation attempt or when the acquired fixation is broken before HoldTime passes
When AllowEarlyFix is false and a fixation is made before the first frame of the scene

Input properties:

WaitTime: Maximum time to wait until the XY tracker enters the threshold window; in milliseconds
HoldTime: Duration for which the fixation should be held; in milliseconds
AllowEarlyFix: true (by default) or false. When it is false, the scene stops immediately if a fixation is made before the scene starts.

Output properties:

Waiting: true if the fixation is never made
AcquiredTime: trialtime when the fixation is made
RT: Reaction (or response) time, which is the difference between the time of the first frame of the scene and the AcquiredTime

Example:

'Success'

elseif

'No fixation'

else

'Fixation break'

end

Remarks:

Although SingleTarget is used as an example, WaitThenHold can track any adapter in which the Success property indicates its state change. See the "task\runtime v2\17 multi-input tracking 1" example.

FreeThenHold

This adapter is similar to WaitThenHold. The difference is that FreeThenHold allows breaking fixation and trying again, as long as WaitTime is not expired.

Success Condition:

Success: true if the fixation is made, before WaitTime passes, and maintained for HoldTime; false, until then.

Stop Condition:

When Success becomes true
When WaitTime is over without a successful fixation
When AllowEarlyFix is false and a fixation is made before the first frame of the scene

Input properties:

WaitTime: Maximum time to allow trying fixation for; in milliseconds
HoldTime: Duration for which the fixation should be held; in milliseconds.
AllowEarlyFix: true (by default) or false. When it is false, the scene stops immediately if a fixation is made before the scene starts.

Output properties:

BreakCount: Number of fixations that are made before the fixation succeeds or WaitTime is expired.
AcquiredTime: trialtime when the last fixation is made (i.e., the time of the last fixation window crossing)
RT: Reaction (or response) time, which is the difference between the time of the first frame of the scene and the AcquiredTime

Example:

'Success'

elseif

'No fixation'

else

'Fixation break'

end

Remarks:

Although SingleTarget is used as an example, FreeThenHold can track any adapter in which the Success property indicates its state change.

LooseHold

This adapter checks to see if the Success state of the child adapter stays true for HoldTime. It allows brief state changes (i.e., to be false), as long as the change is shorter than BreakTime. This is useful to test if the previously acquired eye fixation is maintained while allowing for temporary breaks due to blinking.

Success Condition:

Success: true when the Success property of the child adapter remains true for HoldTime; false, until then.

Stop Condition:

When Success becomes true
When the fixation is broken for longer than BreakTime

Input properties:

HoldTime: Duration for which the fixation should be held; in milliseconds
BreakTime: Maximum duration to allow breaking fixation; in milliseconds

Example:

'Success'

else

'Fixation break'

end

else

'No fixation'

end

ComplementaryWindow

This adapter sets a complementary window around the target(s) to detect XY input outside the window.

Success Condition:

Success: true if the outside of the window is touched; false, otherwise.

Stop Condition:

When Success becomes true

Input properties:

Target: TaskObject# or [x y] coordinates in degrees. Either SingleTarget or MultiTarget object can be assigned instead, to copy their target(s) and threshold (see the example below).
Threshold: Size of the window; a scalar or [w h] in degrees

Example:

'The window is touched.'

elseif

'The outside of the window is touched.'

else

'The window is not touched.'

end

Remarks:

This adapter works with touch input only. For the other signals, adding NotAdapter after SingleTarget will do the same.

BlinkDetector

This adapter checks if the XY tracker enters a specified area during the scene. Since eye trackers typically send out some extreme values for blinks, it can be used to detect the blinks by setting a forbidden area around the extreme coordinates.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the forbidden area is trespassed (if StopOnDetection is true); or when the child adapter stops (if StopOnDetection is false)

Input properties:

XRange: [left right] of the forbidden area in degrees
YRange: [bottom top] of the forbidden area in degrees
StopOnDetection: If this property is true (by default), the adapter stops when the forbidden area is trespassed.

Output properties:

Detected: true, if the XY tracker entered the forbidden area; false, otherwise

Example:

% Let's say that we receive (90, -90) when blinking occurs.

% Then set the area defined by 80<X & Y<-80 as a forbidden place.

Remarks:

Users need to know what numbers they get when blinking occurs and set XRange and YRange appropriately. Note that those numbers are calibrated values, not the raw values from the eye tracker/joystick.

SingleButton

This adapter checks if the specified button was pressed.

Success Condition:

Success: true while the button is pressed; false, otherwise.

Stop Condition:

When Success becomes true

Input properties:

Button: Button #
TouchMode: true or false. See the remarks below.

Output properties:

Time: trialtime when the button state changed for the last time; in milliseconds

Example:

% Button#1

% The scene will end when the button is pressed

Remarks:

The responsiveness of SingleButton differs, depending on whether the input is analog or digital. For analog input, SingleButton does not change its Success state until the button is pressed/released for at least one frame, to prevent a jitter from being detected as a normal button press/release. For digital buttons that are less susceptible to noise, the Success state changes without waiting for one frame.
To force SingleButton to change its Success state immediately for analog input as well, set the TouchMode property to true after assigning the Button number, like the following. btn.Button = 1; btn.TouchMode = true; % After assigning Button
To make SingleButton respond to the button release, instead of the press, invert the input via ButtonTracker (button_) as below. The inverted button is colored in red on the control screen and treated as a button sending out 0 when pressed. Note that this makes the saved button signal inverted as well.

button_.invert(1);     % Invert Button#1

The button threshold for analog input can be adjusted like the following.

button_.threshold(button#, buttonThreshold);

PulseCounter

This adapter counts the number of TTL pulses (or # of button presses).

Success Condition:

Success: true once a pulse is detected

Stop Condition:

When Success becomes true

Input properties:

Button: Button #

Output properties:

Count: Number of pulses (or button presses)

Example:

% Button#1

'Count: %d'

Remarks:

Unlike SingleButton, PulseCounter does not require the button state to be stable for one frame and works with high-frequency input (<500Hz).
PulseCounter detects rising edges, not high levels. If the button is already being pushed at the beginning of the scene, the first pulse does not count until it is released and pushed again.

OnsetDetector

This adapter detects when the child adapter's Success becomes true for the first time.

Success Condition:

Success: true once the Success of the child adapter becomes true

Stop Condition:

When Success becomes true

Output properties:

AcquiredTime: trialtime of the first signal change
RT: Reaction (or response) time, which is the difference between the time of the first frame of the scene and the AcquiredTime

Example:

% Button#1

% The scene will end when a signal change is detected

'Onset time: %d ms'

Remarks:

If the child adapter's Success is true from the start of the scene, the OnserDetector will not indicate true. The adapter waits for a change from false to true.
Exception to the first rule. If the child adapter is one of the trackers, OnsetDetector becomes true from the beginning, since the trackers never become false.
AcquiredTime is in millisecond resolution only when the child adapter is SingleTarget, SingleButton, PulseCounter or KeyChecker. Otherwise, the precision drops to a multiple of the refresh rate.

KeyChecker

This adapter checks the state of a key. Key code(s) to monitor must be set in the [Other device settings] menu first.

Success Condition:

Success: true once a key stroke is detected

Stop Condition:

When Success becomes true

Input properties:

KeyNum: Keycode number to track (the order in the keycodes given in the 'Mouse / Key' menu)

Output properties:

Count: Counts of key strokes
Time: trialtime(s) when the key was pressed

Example:

% 1st keycode

'Key press time: %d ms'

end

Remarks:

This adapter requires MouseTracker (mouse_). To activate mouse_, check on 'Mouse / Key' in the [Other device settings] menu and type the keycodes to monitor there.
See the keycode table for available keys.

TimeCounter

This adapter measures a duration.

Success Condition:

Success: true when Duration has passed

Stop Condition:

When Success becomes true

Input properties:

Duration: In milliseconds

Example:

% clear screen

Remarks:

The stimuli will be presented for one frame even if Duration is 0.
If Duration is not a multiple of the frame length, the actual duration can be longer up to one frame.
Stimuli will not disappear, even after TimeCounter finishes. To remove the stimuli from the screen, call the idle command or present next scene.

FrameCounter

This adapter measures a duration in terms of the number of frames.

Success Condition:

Success: true when the given number of frames (NumFrame) is presented

Stop Condition:

When Success becomes true

Input properties:

NumFrame: Number of frames

Example:

'Scene start'

'Image end'

'A.bmp'

% 60 frames. Corresponds to 1 sec at a 60-Hz refresh rate

% Clear screen. This is time when the image goes off

Remarks:

FrameCounter will spend at least one frame, even if NumFrame is 0.
Stimuli will not turn themselves off, even after TimeCounter finishes. To turn off the stimuli, call the idle command or present next scene.

AnalogInputMonitor

This adapter draws a trace of a selected signal (General Input, High Frequency and Voice) on the control screen for a monitoring purpose.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Channel: General Input number from the I/O menu (scalar) or signal name such as 'general1', 'gen2', 'highfrequency3', 'high4', 'voice', etc.
Position: [left top width height] of the monitor panel in pixels. When not resized, the left-top corner of the control screen is [0 0] and the right-bottom is [800 600]. Alternatively normalized units (0 to 1) can be used.
YLim: Voltage range ([ymin ymax]) of the selected General Input to display
Title: Name of the selected General Input
Color: [R G B]
UpdateInterval: Update intervals in frames. 1, by default.

Example:

% General Input 1

% [left top width height] in normalized units

'Heart beat'

% redraw every 2 frames

PropertyMonitor

This adapter displays the value of a child adapter property on the dashboard during run_scene().

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Dashboard: Dashboard line number
Color: Dashboard color
ChildProperty: A property of the child adapter to monitor. 'Success', by default.
Format: String format for dashboard (the same as formatSpec of the sprintf command). if empty, [property_name ': ' property_value] is displayed, by default.
UpdateInterval: Update intervals in frames. 30, by default.

Example:

% Button#1

% display the state of Button#1 on the screen

WebcamMonitor

This adapter displays images captured by webcams on the screen.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

CamNumber: Webcam number, 1 to 4
Position: [left top width height] of the monitor panel in pixels. When not resized, the left-top corner of the control screen is [0 0] and the right-bottom is [800 600]. Alternatively normalized units (0 to 1) can be used.
UpdateInterval: Update intervals in frames. 2, by default.
Screen: 1 (subject screen) or 2 (control screen; default value)

Example:

% [left top width height] in normalized units

FrameMarker

This adapter stamps eventcode(s) when a particular frame is presented.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

FrameEvent: An n-by-2 cell or matrix. The 1st column is the frame number (1-based) and the 2nd column is the event(s).

Example:

'Frame 10'

'Frame 20'

% 2 when the 10th frame is presented and 4 when the 20th is presented

Remarks:

Multiple codes can be provided as a cell.

OnOffMarker

This adapter sends out pre-set eventcodes when the state of a child adapter property changes.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

OnMarker: Eventcode to send when the state of the child adapter changes from false to true
OffMarker: Eventcode to send when the state of the child adapter changes from true to false
ChildProperty: A property of the child adapter to monitor. 'Success', by default.

Example:

'Released'

'Pressed'

% Button#1

Remarks:

The cycle of calling OnOffMarker is synchronized with the screen refresh rate, so the actual time of the state change can be earlier than the time of events by up to one frame length.

OnOffDisplay

This adapter displays pre-set messages depending on the state of a child adapter property.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Dashboard: Dashboard line number
OnMessage: Message to show when the state of the child adapter is true
OffMessage: Message to show when the state of the child adapter is false
OnColor: Color of OnMessage
OffColor: Color of OffMessage
ChildProperty: A property of the child adapter to monitor. 'Success', by default.

Example:

% Button#1

'Pressed'

'Not pressed'

OnOffGraphic

This adapter draws pre-set graphics depending on the state of a child adapter property.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

OnGraphic: TaskObjects# or a graphic adapter to display while the state of the child adapter is true
OffGraphic: TaskObjects# or a graphic adapter to display while the state of the child adapter is false
ChildProperty: A property of the child adapter to monitor. 'Success', by default.

Methods:

setOnGraphic(graphic_obj, index): Either graphic TaskObjects or a graphic adapter. If the graphic adapter has multiple objects created with the List property, use the optional index argument, to indicate which one(s) should be used.
setOffGraphic(graphic_obj, index): The same as setOnGraphic.

Example:

crc = CircleGraphic(null_); crc.List = { [1 1 1], [1 1 1], 1, [-3 3]; [1 1 1], [1 1 1], 1, [3 3]; ... [1 0 0], [1 0 0], 1, [-3 -3]; [1 0 0], [1 0 0], 1, [3 -3] }; fix = SingleTarget(eye_); fix.Target = [0 0]; fix.Threshold = 3; on = OnOffGraphic(fix); on.setOnGraphic(crc,[2 3]); on.setOffGraphic(crc,[1 4]); tc = TimeCounter(on); tc.Duration = 5000; scene = create_scene(tc); run_scene(scene);

PhotoDiode

Normally the photodiode trigger is toggled only at the beginning of a scene, but this adapter makes it toggled every frame during the scene (Example 1) or when an eventcode is issued (Example 2).

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Mode: 'Frame' (default) or 'Event'. This option determines whether to toggle the trigger per frame or eventcode.

Example 1:

% toggle the trigger every frame ('Frame' mode)

Example 2:

'A.bmp'

% ImageChanger sends out eventcodes when new images are presented.

'B.bmp'

'C.bmp'

'D.bmp'

'Event'

% toggle the trigger when an eventcode is sent out ('Event' mode)

Remarks:

The photodiode trigger option should be selected on the main menu.
For the event mode, this adapter should be the parent of another adapter that produces eventcodes, as in Example 2, or added to the aggregators at the very last.

BoxGraphic

This adapter draws a square/rectangle.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Enable: true (by default) or false
EdgeColor: [R G B]
FaceColor: [R G B]
Size: A scalar (square) or a 1-by-2 vector (rectangle), [width height] in degrees
Position: [X Y] in degrees
Scale: Magnification. 1, by default. Use a two-element vector to apply X & Y scales separately, like [x_scale y_scale].
Angle: Rotation in degrees. 0, by default.
Zorder: z-order; 0 (back; by default) to 2147483647 (front)

List: Use this property, instead of the above ones, to create multiple objects at once. See Example 2.

box.List = { edgecolor1, facecolor1, size1, position1, scale1, angle1; ...
edgecolor2, facecolor2, size2, position2, scale2, angle2; ... }

Example 1:

box = BoxGraphic(null_); box.EdgeColor = [1 0 0]; box.FaceColor = [0 0 1]; box.Size = [4 3]; box.Position = [-5 5]; fix = SingleTarget(eye_); fix.Target = box; fix.Threshold = 3; wth = WaitThenHold(fix); wth.WaitTime = 5000; wth.HoldTime = 500; scene = create_scene(wth); run_scene(scene);

Example 2:

% The same shape as in the above example

Remarks:

Previously, graphic adapters could not be directly assigned as Target, but it is now possible as shown in the above example. Update to the latest version, if it does not work.

CircleGraphic

This adapter is the same as BoxGraphic except that this one draws a circle/oval.

Remarks:

For the Size argument, use a scalar for a circle (diameter, not radius) or a 1-by-2 vector for an ellipse ([major_axis minor_axis]).

PieGraphic

This adapter draws a filled arc.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Enable: true (by default) or false
EdgeColor: [R G B]
FaceColor: [R G B]
Size: A scalar (square) or a 1-by-2 vector (rectangle), [width height] in degrees
Position: [X Y] in degrees
StartDegree: Angle measured in degrees counter-clockwise from the x-axis to the first side of the pie shape
CenterAngle: Angle measured in degrees counter-clockwise from StartDegree to the second size of the pie shape
Scale: Magnification. 1, by default. Use a two-element vector to apply X & Y scales separately, like [x_scale y_scale].
Angle: Rotation in degrees. 0, by default.
Zorder: z-order; 0 (back; by default) to 2147483647 (front)

List: Use this property, instead of the above ones, to create multiple objects at once. See Example 2.

pie.List = { edgecolor1, facecolor1, size1, position1, startdeg1, centerang1, scale1, angle1; ...
edgecolor2, facecolor2, size2, position2, startdeg2, centerang2, scale2, angle2; ... }

Example 1:

pie = PieGraphic(null_); pie.EdgeColor = [1 0 0]; pie.FaceColor = [1 1 0]; pie.Size = [4 3]; pie.Position = [-5 5]; pie.StartDegree = 45; pie.CenterAngle = 270; fix = SingleTarget(eye_); fix.Target = pie; fix.Threshold = 3; wth = WaitThenHold(fix); wth.WaitTime = 5000; wth.HoldTime = 500; scene = create_scene(wth); run_scene(scene);

Example 2:

% The same shape as in Example 1

Remarks:

Previously, graphic adapters could not be directly assigned as Target, but it is now possible as shown in the above example. Update to the latest version, if it does not work.

PolygonGraphic

This adapter draws a user-defined polygon.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Enable: true (by default) or false
EdgeColor: [R G B]
FaceColor: [R G B]
Size: A scalar (square) or a 1-by-2 vector (rectangle), [width height] in degrees
Position: [X Y] in degrees
Vertex: An n-by-2 matrix (n = number of vertices), [X1 Y1; X2 Y2; ...] in normalized coordinates (0 to 1)
Scale: Magnification. 1, by default. Use a two-element vector to apply X & Y scales separately, like [x_scale y_scale].
Angle: Rotation in degrees. 0, by default.
Zorder: z-order; 0 (back; by default) to 2147483647 (front)

List: Use this property, instead of the above ones, to create multiple objects at once. See Example 2.

poly.List = { edgecolor1, facecolor1, size1, position1, vertex1, scale1, angle1; ...
edgecolor2, facecolor2, size2, position2, vertex2, scale2, angle2; ... }

Example 1:

star = PolygonGraphic(null_); star.EdgeColor = [0 1 0]; star.FaceColor = [0 1 0]; star.Size = 2; star.Position = [0 0]; star.Vertex = [0.5 1; 0.375 0.625; 0 0.625; 0.25 0.375; 0.125 0; 0.5 0.25; 0.875 0; 0.75 0.375; ... 1 0.625; 0.625 0.625]; fix = SingleTarget(eye_); fix.Target = star; fix.Threshold = 3; wth = WaitThenHold(fix); wth.WaitTime = 5000; wth.HoldTime = 500; scene = create_scene(wth); run_scene(scene);

Example 2:

% The same shape as in Example 1

Remarks:

Previously, graphic adapters could not be directly assigned as Target, but it is now possible as shown in the above example. Update to the latest version, if it does not work.

TextGraphic

This adapter draws a user string.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Enable: true (by default) or false
Text: Text to display
Position: [X Y] in degrees
FontFace: Font name ('Arial', by default).
FontSize: In points (10, by default)
FontColor: [R G B] ([1 1 1], by default)
FontStyle: 'normal' (default), 'bold', 'italic', 'underline' or 'strikeout'
HorizontalAlignment: 'left' (default), 'center' or 'right'
VerticalAlignment: 'top' (default), 'middle' or 'bottom'
Scale: Magnification. 1, by default. Use a two-element vector to apply X & Y scales separately, like [x_scale y_scale].
Angle: Rotation in degrees. 0, by default.
Zorder: z-order; 0 (back; by default) to 2147483647 (front)

List: Use this property, instead of the above ones, to create multiple objects at once. See Example 2.

text.List = { text1, position1, fontface1, fontsize1, fontcolor1, fontstyle1, halign1, valign1, scale1, angle1; ...
text2, position2, fontface2, fontsize2, fontcolor2, fontstyle2, halign2, valign2, scale2, angle2; ... }

Output properties:

Size: Size of the created text. In degrees.

Example 1:

'This is a test.'

'italic'

'center'

'middle'

% Clean up

Example 2:

'This is a test.'

'Arial'

'italic'

'center'

'middle'

ImageGraphic

This adapter presents static images.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Enable: true (by default) or false
Position: [X Y] in degrees
Scale: Magnification. 1, by default. Use a two-element vector to apply X & Y scales separately, like [x_scale y_scale].
Angle: Rotation in degrees. 0, by default.
Zorder: z-order; 0 (back; by default) to 2147483647 (front)

List: An n-by-2, n-by-3 or n-by-4 cell matrix. Use this property to create multiple image objects. Their Position, Scale and Angle properties can be changed afterward.

1st column: Image filename, function string (see Remarks) or image matrix (Y-by-X-by-3 or Y-by-X-by-4)
2nd column: Image XY position in visual angles, an n-by-2 matrix ([x1 y1; x2 y2; ...])
3rd column (optional): Colorkey, [R G B] that should look transparent
4th column (optional): Resize parameter. [Xsize Ysize] in pixels or a scalar (scale).
5th column (optional): Angle. In degrees.

Output properties:

Size: Size of the created graphic in degrees ([x1 y1; x2 y2; ...]).

Example 1:

'A.bmp'

'B.bmp'

% put only one image in each row

% clear the screen

Example 2:

'make_circle(100, [1 1 1], 1)'

% function string

% clear the screen

Remarks:

To show multiple images at the same time, put each of them in a different row of the List property.
The function string must be a char array that contains a function name and its argument(s), like 'make_circle(300,[1 1 1],1)'.
In case that the image matrix contains 4 color panes, the first one is alpha and the other three are RGB. See "MonkeyLogic Graphics Library" for the details.
Using image matrices can increase the size of the data file, because they are kept in the data file. Consider using image files or function strings, if possible.
When the scene ends, the image(s) will stay on the screen. They are overwritten by the next scene or can be manually cleared with idle.

MovieGraphic

This adapter presents movies.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Enable: true (by default) or false
Position: [X Y] in degrees
Looping: false (do not repeat) or true (repeat)
Scale: Magnification. 1, by default. Use a two-element vector to apply X & Y scales separately, like [x_scale y_scale].
Angle: Rotation in degrees. 0, by default.
Zorder: z-order; 0 (back; by default) to 2147483647 (front)
PlayPosition: Play position in milliseconds

List: An n-by-2 or n-by-3 cell matrix. Use this property to create multiple movie objects. The other properties can be changed afterward.

1st column: Movie filename, function string or movie matrix (Y-by-X-by-3-by-N or Y-by-X-by-4-by-N, N: # of frames)
2nd column: XY position in visual angles, an n-by-2 matrix ([x1 y1; x2 y2; ...])
3rd column (optional): Repeat (true) or not (false, by default) when the end of the movie is reached
4th column (optional): Scale. A scalar. 1 means no change in size.
5th column (optional): Angle. In degrees.

Output properties:

Size: Size of the created graphic in degrees ([x1 y1; x2 y2; ...]).
Duration: Length of the movie in milliseconds ([d1; d2; d3; ...]).

Example 1:

'testmovie.avi'

% movie filename

% clear the screen

Example 2:

'rand(100, 200, 3, 3 * %d)'

% function string

% clear the screen

Example 3:

% Y-by-X-by-3-by-N

% clear the screen

Remarks:

If the scene ends before the movie finishes, the last shown frame will stay on the screen. It will be cleared when the next scene starts or with idle(0).
Although a movie can be created from a matrix like Example 3, it increases the size of the data file rapidly because the matrix is saved for reconstructing initial conditions. Consider using a movie file or a function, like Example 1 & 2, to avoid such an issue.

SineGrating

This adapter draws a sine grating.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Enable: true (by default) or false
Position: [X Y] in degrees
Radius: Radius of the aperture in degrees
Direction: Degree
SpatialFrequency: Cycles per degree
TemporalFrequency: Cycles per second
Phase: Degree; 0, by default.
Color1: 1-by-3 RGB vector
Color2: 1-by-3 RGB vector
WindowType: 'none', 'circular' (default), 'triangular', 'sine' (or 'cosine'), 'hann', 'hamming', 'gaussian'
WindowSize: sigma for 'gaussian' (optional). 1/3 of Radius, by default.
Zorder: z-order; 0 (back; by default) to 2147483647 (front)

List: Use this property, instead of the above ones, to create multiple objects at once. See Example 2.

grat.List = { position1, radius1, direction1, spatialfreq1, temporalfreq1, phase1, color11, color21, wintype1, winsize1; ...
position2, radius2, direction2, spatialfreq2, temporalfreq2, phase2, color12, color22, wintype2, winsize2; ... }

Example 1:

'gaussian'

% SineGrating cannot be assigned directly, unlike graphic adapters.

Example 2:

'gaussian'

% The same as above

RandomDotMotion

This adapter draws a random dot motion stimulus.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Enable: true (by default) or false
Position: [X Y] in degrees
Radius: Radius of the aperture in degrees
Coherence: 0 to 100
Direction: Degree
Speed: Degrees per sec
NumDot: Numbers of dots; 100, by default
DotSize: In degrees; 0.15, by default
DotColor: [R G B]; [1 1 1], by default
DotShape: 'square' (by default) or 'circle'
Interleaf: Number of frames interleaving; 3, by default
Zorder: z-order; 0 (back; by default) to 2147483647 (front)

List: Use this property, instead of the above ones, to create multiple objects at once. See Example 2.

rdm.List = { position1, radius1, coherence1, direction1, speed1, numdot1, dotsize1, dotcolor1, dotshape1, interleaf1; ...
position2, radius2, coherence2, direction2, speed2, numdot2, dotsize2, dotcolor2, dotshape2, interleaf2; ... }

Example 1:

% RandomDotMotion cannot be assigned directly, unlike graphic adapters.

Example 2:

The same stimulus as above

Remarks:

RectangularRDM is the same as this adapter. Just its aperture size is specified by the Size property ([width height] in degrees), instead of Radius.

GraphicContainer

This adapter combines various graphic adapters into one.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

Enable: true (by default) or false
Position: [X Y] in degrees
Zorder: z-order; 0 (back; by default) to 2147483647 (front)

Methods:

add(graphic_obj, index): Add a graphic adapter to stack

Example:

% red box

% green box

% blue box

'A.bmp'

'B.bmp'

'This is a test.'

'center'

% compose a set of various objects

% add just the first two boxes

% The target number is in the order as they are added. That is,

% 1. pie, 2. red box, 3. green box, 4. A.bmp, 5. B.bmp, 6. txt.

CurveTracer

This adapter translates the position of a graphic object along the given path.

Success Condition:

Success: true when all x & y positions are traced to the end

Stop Condition:

When Success becomes true

Input properties:

Target: Either a graphic TaskObject or a graphic adapter. To select one object from a graphic adapter that contains multiple objects, use setTarget().
DurationUnit: 'frame' (by default) or 'msec'
Repetition: The number of times to trace the path. 1, by default.

List: An n-by-2, n-by-3 or n-by-4 numeric matrix

1st column: X in degrees
2nd column: Y in degrees
3rd column: Duration (in frames or milliseconds; 1, if not provided)
4th column: Eventmarker (optional)

Output properties:

Time: trialtime (an n-by-1 vector) when the object is moved to each position during the scene. NaN for skipped positions.

Methods:

setTarget(graphic_obj, index): If the graphic adapter has multiple objects created with the List property, set the optional index argument to indicate which one should be used.

Example 1:

% TaskObject#1

Example 2:

% red & green circles

% use the 2nd circle in crc

Remarks:

If DurationUnit is 'msec', the duration is rounded to the nearest multiple of the frame length.
This adapter can be linked with SingleTarget to create a moving target. See Example 2 of SingleTarget for details.

ImageChanger

This adapter presents multiple image sets in series.

Success Condition:

Success: true when all the images in the list are presented

Stop Condition:

When Success becomes true

Input properties:

List: An n-by-3 or n-by-4 or n-by-5 cell matrix

1st column: Image filename(s) or function string(s) (see Remarks)
2nd column: Image XY position(s) in visual angles, an n-by-2 matrix ([x1 y1; x2 y2; ...])
3rd column: Duration in number of frames (or in milliseconds. See the DurationUnit property below.)
4th column: Eventmarker(s); optional
5th column: Resize parameter, [Xsize Ysize] in pixels; optional

DurationUnit: 'frame' (by default) or 'msec'
Repetition: The number of times to repeat the image list. 1, by default.

Output properties:

Time: trialtime (an n-by-1 vector) when each image was presented during the scene. NaN for images not shown.

Example:

'A.bmp'

'C.bmp'

% 15 frames' blank

'B.bmp'

'D.bmp'

'C.bmp'

'A.bmp'

'D.bmp'

'B.bmp'

% The images in each row will be shown for 15 frames in turn.

Remarks:

If multiple images are assigned in the same row of List, they will be displayed simultaneously.
The function string is a char array that contains a function name and its argument(s), like 'make_circle(300,[1 1 1],1)'.
Column 4-5 of List are optional. An n-by-3 (or n-by-4 or n-by-5) matrix is sufficient. However, to assign something to Column 5, Column 4 must be defined.
If DurationUnit is 'msec', the duration of each image is rounded to the nearest multiple of the frame length.

GraphicProperty

This adapter changes properties of a graphic object over the course of the scene.

Success Condition:

Success: true when all the given property values are used

Stop Condition:

When Success becomes true

Input properties:

Target: Either a graphic TaskObject or a graphic adapter. To select the objects in a graphic adapter that contains multiple objects, use setTarget() as in Example 2 below.
Property: Name of the property to manipulate, such as 'EdgeColor', 'FaceColor', 'Size', 'Position', 'Scale', 'Angle' and 'Zorder'. In case of TaskObject, only 'Position', 'Scale', 'Angle' and 'Zorder' can be altered. To list multiple properties, use a cell array (see Example 2).

List: A 1-by-p cell. p is the number of properties listed in Property. Two extra columns can be added for duration and eventmarkers.

1st cell: New values for the 1st property (n-row matrix). Its number of columns is dependent on the property.
...
p-th cell: New values for the p-th property (n-row matrix). Its number of rows must be the same as the other cells.
(p+1)-th cell: Duration (in frames or milliseconds); 1, by default (optional)
(p+2)-th cell: Eventmarker (optional)

DurationUnit: 'frame' (by default) or 'msec'
Repetition: The number of times to repeat the value list. 1, by default.

Output properties:

Time: trialtime (an n-by-1 vector) when new property values were applied during the scene. NaN for not shown.

Methods:

setTarget(graphic_obj, index): If the graphic adapter has multiple objects created with the List property, set the optional index argument to indicate which one should be used.

Example 1:

'size'

% [width height] for size

Example 2:

% two boxes

% the 2nd box

'size'

'angle'

'facecolor'

% multiple properties

Remarks:

If DurationUnit is 'msec', the duration of each color is rounded to the nearest multiple of the frame length.

BackgroundColorChanger

This adapter changes the background color of the subject screen according to the given schedule.

Success Condition:

Success: true when all changes are made as scheduled

Stop Condition:

When Success becomes true

Input properties:

List: An n-by-4 or n-by-5 numeric matrix

1st column: Red (0 to 1)
2nd column: Green (0 to 1)
3rd column: Blue (0 to 1)
4th column: Duration (in frames or milliseconds)
5th column: Eventmarker; optional

DurationUnit: 'frame' (by default) or 'msec'
Repetition: The number of times to repeat the color list. 1, by default.

Output properties:

Time: trialtime (an n-by-1 vector) when each color change was made during the scene. NaN for skipped colors.

Example:

% alternate white and black every 100 ms

Remarks:

If DurationUnit is 'msec', the duration of each color is rounded to the nearest multiple of the frame length.

AudioSound

This adapter presents audio sounds.

Success Condition:

Success: true when all sounds are finished

Stop Condition:

When Success becomes true

Input properties:

Enable: true (by default) or false
Looping: false (do not repeat) or true (repeat)
PlayPosition: Play position in milliseconds

List: An n-by-1 or n-by-2 cell matrix. Use this property to create multiple sounds at the same time.

1st column: Audio filename, function string, or 1-by-2 vector of [duration frequency]
2nd column (optional): Looping; repeat (true) or not (false, by default) when the end of the sound is reached

Output properties:

Duration: Length of the sound in milliseconds ([d1; d2; d3; ...]).

Example 1: Audio filename

'Alarm01.wav'

% wav file

% play from 1 sec

Example 2: Function string

'load_waveform({''sin'', 2, 1000})'

% 1-kHz sine wave for 2 sec

Example 3: [duration frequency]

% only 1st sound will last for 3 s b/c of looping

% cut after 3 s

Remarks:

Function strings must be char and contain all input arguments in the strings, as in Example 2 above.
If the List is [duration frequency], a sine-wave tone of the given duration and frequency will be played
If Looping is true, the sound never ends and therefore the Success property does not become true.

Stimulator

This adapter delivers electrical stimulation via analog output.

Success Condition:

Success: true when the delivery of the current waveform is done

Stop Condition:

When Success becomes true

Input properties:

Channel: Stimulation# (scalar or vector) assigned on the I/O menu.
Waveform: can be one of the following.
- 1. A column vector (if only one channel was assigned to the Channel property)
- 2. A matrix (n-by-NumOfChannels) if multiple channels were assigned to the Channel property
- 3. A cell array that contains waveform data (1 or 2 above), to select a waveform on the fly
- 4. A MAT filename that contains one of the above waveform data. The waveform must be stored in a variable named 'y'. If there exists a variable, 'fs', in the MAT file, it will overwrite the Frequency property.
- 5. A char array that contains a function name and arguments (a.k.a. a funcion string), like 'load_waveform({''sin'',1,1000})'. The function must return [y, fs].
Frequency: The rate of the waveform sample generation, samples per second
WaveformNumber: In case that multiple waveforms are loaded (as a cell array), this property indicates which waveform will be used.
OffAtSceneEnd: When true, the signal output is turned off at the end of the scene; false, by default.

Example:

% Stimulation #1 & #2

% two sets of waveforms

% waveform set #1

% send out the waveform set #1

% waveform set #2

% Do not create the Stimulator twice. Just recycle the same object.

Remarks:

It is possible to trigger more than one analogoutput channel at a time, but all must be triggered together. This is a limitation of the DAQ device. Two independent stimulations will require two DAQ boards.
Using numeric arrays/matrices for Waveform can increase the size of the data file quickly, since they are saved in the data file. Consider using a MAT file or a function string to avoid it.

TTLOutput

This adapter sends out TTL pulses via digital lines.

Success Condition:

Success: true when all pulses are sent out

Stop Condition:

When Success becomes true

Input properties:

Port: TTL # assigned in the I/O menu. Multiple ports can be assigned as a vector.
Duration: Pulse lengths in milliseconds; optional.
Delay: Delay (milliseconds) in starting the pulses; optional.

Example 1:

'TTL on'

'TTL off'

% TTL #1 must be assigned in the I/O menu.

% TTL duration is determined by TimeCounter.

% on

% off

Example 2:

% TTL #1 & #2 must be assigned in the I/O menu.

% The 1st pulse is 500 ms long and the 2nd pulse is 1000 ms.

Remarks:

If Duration is not specified, the pulse is turned off at the end of the scene.
If Delay or Duration is set, a background process is created to count the elapsed time. This allows presenting TTLs of which duration is not a multiple of a frame length, but the onset time may vary due to the background process creation.
If the background TTLs are not triggered before the trial end, they are cancelled automatically.
See Main Menu, DAQ board settings, regarding to inverted TTLs.

AllContinue

This adapter combines multiple adapter chains and continues the scene while all the child chains continue.

Success Condition:

Success: true if none of the child chains stopped.

Stop Condition:

When any child chain stops.

Methods:

add(adapter): Add another adapter chain

Example:

% The scene ends upon either eye fixation, button press or time over

Remarks:

Note that AllContinue's behavior is dependent on the child chains' stop conditions, not the success conditions.

AnyContinue

This adapter combines multiple adapter chains and continues the scene if any of the child chains continues.

Success Condition:

Success: true if not all child chains stopped.

Stop Condition:

When all child chains stop.

Methods:

add(adapter): Add another adapter chain

Example:

% The scene ends upon either eye fixation & button press or time over

Remarks:

Note that AnyContinue's behavior is dependent on the child chains' stop conditions, not the success conditions.

Concurrent

This adapter runs multiple adapter chains simultaneously but watches only the first chain added. This adapter is useful to add extra graphics.

Success Condition:

Success: true when the first chain succeeds

Stop Condition:

When the first chain stops

Methods:

add(adapter): Add another adapter chain

Example:

% Child chain 1: check eye fixation on the center

% Child chain 2: display a grating and a fixation point

% This scene will end when the fixation is acquired (i.e., when Child

% chain 1 succeeds). Chain 2 is just for graphics.

Sequential

This adapter runs multiple chains sequentially.

Success Condition:

Success: true when the last chain is finished succesfully

Stop Condition:

When any chain stops with its Success false or when the last chain is finished

Input properties:

EventMarker: Event marker(s) to send out, when each chain begins. Use NaN to skip a particular chain.

Output properties:

CurrentChain: Chain # that is currently running or the last chain that ran, if the adapter stopped before finishing all the chains.

Methods:

add(adapter): Add another adapter chain

Example:

% any1 -- seq1a -- tc1a -- box1 % | +--- tc1b % | % +--- seq1b -- tc1c % +--- tc1d -- crc1

% 1st chain of seq1a

% 2nd chain of seq1a

% seq1a runs two chains sequentially. A box for 2 s and a blank for 1 s

% 1st chain of seq1b

% 2nd chain of seq1b

% seq1b runs two chains sequentially. A blank for 1 s and then a circle for 2 s

% Run both seq1a and seq1b simultaneously.

% The box and the circle will be overlapped in time for 1 s.

Remarks:

This adapter can be used to combine multiple scenes into one.

AndAdapter

This adapter combines multiple adapter chains and finishes the scene when all the chains succeed.

Success Condition:

Success: true when all child chains' Success property become true

Stop Condition:

When Success becomes true

Methods:

add(adapter): Add another adapter chain

Example:

% The scene ends when the eye fixation is made AND the button is pressed

Remarks:

Note that AndAdapter's behavior is dependent on the child chains' success conditions, not the stop conditions.

OrAdapter

This adapter combines multiple adapter chains and finishes the scene when any one of them succeeds.

Success Condition:

Success: true when the Success property of any one adapter chain becomes true

Stop Condition:

When Success becomes true

Methods:

add(adapter): Add another adapter chain

Example:

% The scene ends when the eye fixation is made OR the button is pressed

Remarks:

Note that OrAdapter's behavior is dependent on the child chains' success conditions, not the stop conditions.

NotAdapter

This adapter negates the Success state of the child adapter.

Success Condition:

Success: the opposite of the child adapter's Success

Stop Condition:

When the child adapter stops

Example:

% invert the Success state of SingleTarget

% The scene ends when the button is pressed AND the eye fixation is NOT acquired

DragAndDrop

This adapter tracks the selected graphic stimulus until it is released from the previous hold. If the released location is close to the destination, the stimulus is pulled to the destination like a magnet. Otherwise, it goes back to the initial location.

Success Condition:

Success: true when the stimulus is dropped on one of the destinations

Stop Condition:

When the stimulus is released from the hold (i.e., dropped) and moved to either destination or initial location.

Input properties:

Target: Either a graphic TaskObject or a graphic adapter. To select one object from a graphic adapter that contains multiple objects, use setTarget().
Destination: [x1 y1; x2 y2; ...] in degrees
Gravity: Degrees per second
GravityWindow: Radius in degrees; [width height] for a rectangular window
Color: Color of the gravity window

Output properties:

DropTime: trialtime when the stimulus is released
DroppedDestination: Index # of the dropped destination. 0, if not dropped on any destination.

Methods:

setTarget(graphic_obj, index): If the graphic adapter has multiple objects created with the List property, set the optional index argument to indicate which one should be used.
reset(): Return the target to its initial position.

Example:

'+'

'center'

'middle'

end

'Not picked!'

elseif

'Not on the destination!'

else

'Good job!'

end

Remarks:

This adapter requires touch input.
Before DragAndDrop is called, the target should already be touched. Confirm the finger touch first in the previous scene, as shown in the above example.

FixTimeAnalyzer

This adapter counts how long a XY tracker stays in the threshold window.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Output properties:

FixTime: Total accumulated fixation time in milliseconds

Example:

'Fixation time: %d ms'

Remarks:

FixTime can be different from the actual duration if the fixation already started before the scene or the task runs in the simulation mode.

RewardScheduler

This adapter delivers rewards at given intervals while its child adapter's Success state is true.

Success Condition:

Success: The same value as the child adapter's Success

Stop Condition:

When the child adapter stops

Input properties:

JuiceLine: Reward channel to trigger; 1, by default.
Schedule: An n-by-5 matrix.

1st column: Min Success duration for the schedule in that row to be selected (in milliseconds)
2nd column: Min reward interval to next reward (in milliseconds)
3rd column: Max reward interval to next reward (in milliseconds)
4th column: Reward pulse length (in milliseconds)
5th column: Eventcode for reward (optional)

Example:

% Once fixation starts, deliver a 100-ms reward every seconds

% if fix is maintained longer than 5 s, give a 200-ms reward every 800 ms

Remarks:

The success duration and reward intervals given in the 1st to 3rd columns in Schedule are rounded to the nearest multiple of the frame length. The reward duration in the 4th column is not.

behaviorsummary

This function reads data files and shows a performance summary.

convert_format (also bhv2bhvz / bhv2h5 / bhv2mat)

This function rewrites NIMH ML data files (*.bhv2, *.bhvz, *.h5, *.mat) in a different format.

Syntax:

% target file format: 'bhv2', 'bhvz', 'h5' or 'mat'

% filelist can be a cell array for multiple files

% the same as convert_format('bhvz')

Remarks:

New files are created in the current directory.
The format of the source file is automatically determined from the file extension.
bhv2bhvz, bhv2h5 and bhv2mat are just a wrapper of convert_format(). They convert source files of any extension, not just BHV2.

mlconcatenate

This function combines trial-by-trial analog data into one large matrix and adjusts all timestamps accordingly, as if they are recorded in one single trial. It is useful when reading data files that are continuously recorded through inter-trial intervals. This command does not process webcams and high frequency channels, since loading them all at once can cause an out-of-memory error.

Syntax:

data = mlconcatenate; data = mlconcatenate(filename); [data, MLConfig, TrialRecord, filename] = mlconcatenate;

mlexportstim

This function extracts saved stimuli from the data file.

Syntax:

% open dialogs to pick up a data file and a destination folder

mlexportwebcam

This function reads webcam videos from the data file and saves them as MP4. It is possible to strip off the videos completely from the data file by setting the delete_video option true. The original files will be kept in the "orig" folder.

Syntax:

mlexportwebcam mlexportwebcam(datafile) mlexportwebcam(datafile, delete_video)

mlimportwebcam

This function attaches exported webcam videos (MP4s) back to the data file. If the video files are not in the same folder as the data file, a path to the videos can be provided.

Syntax:

mlimportwebcam mlimportwebcam(datafile) mlimportwebcam(datafile, video_folder)

mlplayer

This function opens a trial-replay and video-exporting dialog.

mlread

This function provides a unified read interface for all the data formats (*.bhv2; *.bhvz; *.h5; *.mat). It returns trial-by-trial data in a 1-by-n array of structures.

Syntax:

data = mlread; data = mlread(filename); [data, MLConfig, TrialRecord, filename] = mlread(__);

mlreadsignal

This function reads signals recorded at unconventional sample rates (i.e., not 1 kHz), such as High Frequency, Voice and Webcam. These data usually have a large size, so loading them up all at once may cause an out-of-memory error. For that reason, mlread and mlconcatenate do not load them. Use this function instead.

Syntax:

% 'highfrequency1' (or 'high1'), 'voice', % 'webcam1' (or 'cam1'), etc.

% trial_number is 1, if not assigned

% webcam returns timestamps as well

eye_, eye2_	joy_, joy2_	touch_	button_	mouse_	null_
XYData LastSamplePosition	XYData LastSamplePosition	XYData LastSamplePosition	ClickData LastSamplePosition	XYData ClickData KeyInput LastSamplePosition

Timing script functions

Runtime functions

Version 1 specific

Version 2 specific

Adapters for Version 2

Command window functions

bhv_code

bhv_variable

dashboard

editable

escape_screen

eventmarker

eye_position / eye2_position / joystick_position / joystick2_position

forced_eye_drift_correction

get_analog_data

get_object_duration

getkeypress

goodmonkey

hotkey

idle

include

istouching

mouse_position

reposition_object

rescale_object

rotate_object

rewind_object

set_bgcolor

set_iti

touch_position

trialerror

trialtime

user_text / user_warning

eyejoytrack

set_frame_event

set_frame_order

set_object_path

showcursor / showcursor2

showtouch

toggleobject

create_scene

run_scene

EyeTracker, Eye2Tracker, JoyTracker, Joy2Tracker, TouchTracker, ButtonTracker, MouseTracker, NullTracker

SingleTarget

MultiTarget

WaitThenHold

FreeThenHold

LooseHold

ComplementaryWindow

BlinkDetector

SingleButton

PulseCounter

OnsetDetector

KeyChecker

TimeCounter

FrameCounter

AnalogInputMonitor

PropertyMonitor

WebcamMonitor

FrameMarker

OnOffMarker

OnOffDisplay

OnOffGraphic

PhotoDiode

BoxGraphic

CircleGraphic

PieGraphic

PolygonGraphic

TextGraphic

ImageGraphic

MovieGraphic

SineGrating

RandomDotMotion

GraphicContainer

CurveTracer

ImageChanger

GraphicProperty

BackgroundColorChanger

AudioSound

Stimulator