Welcome Guest, you are in: <root>Elements • Login

Page History: Button Element

Compare Page Revisions

31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0 Current 31 30 29 28 27 26 25 24 23 22 21 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0

« Older Revision - Back to Page History - Newer Revision »

Page Revision: 2015/01/16 08:52

Button element detects button presses/releases on standard input devices recognized by DirectInput API. The DirectInput devices include the system keyboard, mouse, joysticks and gamepads. If you need to record keys on supplementary input devices, e.g. on the secondary keyboard, or when a device does not support DirectInput, use the HID input element. The Button element collects very accurate timing statistics of key presses and releases, hence, it is recommended for recording reaction time of participant responses, when an experiment in run on a standard PC. Multiple button elements can be used to record for one or several input devices in the same time. The button element monitors button presses only within a scope of it's parent event and return local timing statistics, e.g. a press time as the number of milliseconds since the onset of the parent event.

Table of Contents [Hide/Show] Actions aligned with epochs of the parent event Properties     Generic properties Snapshots Selection of the monitored button Triggering modes Button Names Triggered Snippet Practical Use     Implementing the "Press any button to continue" design pattern     Implementing the reaction time measurement with a single button     Recording times of multiple button presses within a single event Notes

Snapshots ¶

Event with two buttons elements detecting presses of 'Z' and '/' keys

Selection of the monitored button ¶

Button element can monitor either one specific button, or all buttons in the same time (when 'Any Button' is selected in the Monitored Button property). In many experimental tasks, e.g.2AFC, there are two response buttons for a participant. Given flexibility of the button element, for the 2ADC tasks you can use different design patterns:

1. Create two button elements, each monitoring one of the predefined response buttons
2. Create one button element monitoring 'Any' button and write a code that checks, what button is pressed. The name of the pressed button is returned by the Triggered Button property
   

The first pattern allows to automatically ignore presses of irrelevant buttons. The second pattern is more convenient for collecting a reaction time in trial, because you can get from a single proxy variable link to the Triggering Time property of the button element.

Triggering modes ¶

The button element is not limited to registering a single key press. There are 5 'triggering' modes, in which the Button element can operate. You need to select the triggering mode in advance, according to your requirements:

• First Press Only
• First Release Only
• Multiple Presses
• Multiple Releases
• Holding Down
  

Depending on the working mode, the element becomes 'triggered' when a specific input pattern is detected. The First Press Only mode is the default choice for registering the fastest reaction time, because in this mode the element ignores all successive presses. Other modes are self-explanatory, save for the holding down mode, which detects continuously presses, common in the game-like activities.

Button Names ¶

The button elements uses the DirectInput button naming, which is different to the conventional button naming. For example, the keyboard number buttons in the horizontal row are denoted as 'D1','D2'..'D0'. There is some inconsistency in the DI naming. For example, the left arrow button is called "LeftArrow", whereas the right arrow button is called just "Right". Be aware that you need to maintain capital letter in the button names, when checking them in C# code. You can easily find out the DI button name, using the design-time press detector on the button element. Open an editor for the Monitored Button property and move the mouse cursor over the picture with a web. Then press the desired button and check its name in the top row.

Triggered Snippet ¶

The button element can invoke custom user code each time it becomes triggered (e.g. on a button press). To engage the snippet, open it via the snippet panel and write your code there. Note that the triggered snippet is invoked only once, on the first press, when the 'First Press Only' triggering mode is selected. The triggered snippet can be used for checking a name of the pressed button:

if (TriggeringButton=="LeftArrow")
    Positon.X=PositionX-1;
if (TriggeringButton=="Right")
    Positon.X=PositionX+1;

Using the press detector to find out the correct button name

Practical Use ¶

Implementing the "Press any button to continue" design pattern ¶

1. Add the button element to the 'stop' event
2. Browse the button element properties in the property panel
3. Select the Input Device, for example, a keyboard
4. Leave Triggering Mode and Monitored Button with the default values, 'First Press Only' and 'Any Button'
5. Create a proxy variable linked to the Is Triggered property of the element
6. Go back to the parent event and add the conditional flow route leading to a successive event.
7. Write an expression for the conditional route as (IsTriggered==true), where the first part is a name of the proxy variable linked to the button element
   

Implementing the reaction time measurement with a single button ¶

1. Add the button element to the 'measurement' event, normally one where the stimulus is presented
2. Browse the button element properties in the property panel
3. Select the Input Device, for example, a keyboard
4. Leave Triggering Mode with the default value, 'First Press Only'
5. Select Monitored Button
6. Create a proxy variable linked to the Is Triggered property of the element
7. Create a proxy variable linked to the Triggering Time property
8. Go back to the parent event and add the conditional flow route leading to a successive event, if you want to terminate the event on a button press.
9. Write an expression for the conditional route as (IsTriggered==true), where the first part is a name of the proxy variable linked to the Is Triggered property
10. After offset of the 'measurement' event, pick up the value of the Triggering Time proxy variable. For example, you can save it to the data report via the Reporter Element
    

Recording times of multiple button presses within a single event ¶

1. Add the button element to the 'measurement' event, normally one where the stimulus is presented
2. Browse the button element properties in the property panel
3. Select the Input Device, for example, a keyboard
4. Set Triggering Mode to 'Multiple presses'
5. Select Monitored Button
6. Create a proxy variable linked to the Triggering Time property
7. Open the triggered snippet of the button element via the snippet panel
8. Add the following code to the snippet. The code adds a time of the current button press to a dedicated array list.
   

/// PressTime is a list declared in the header, e.g.
/// ArrayList PressTimes=new ArrayList();

PressTimes.Add(TriggeringTime);

Notes ¶

• The Triggering Time, Is Triggered and Triggered Button properties are nullified on the onset of the parent event. However, you can read these values in other events after the offset of the parent event
• Is Down property can be used a button state flag, independently of the selected triggering mode