Add information about psychopy variables to use in builder
One of the more difficult things in generating the psychopy bids events from the builder elements is knowing how to get the right information in the event file. The variable names and objects that psychopy stores this information in is not very transparent and without any coding experience or ability to write python code it is difficult to figure this out.
I suggest we add a section with a table where we lay out the variables that store relevant information for each component.
It could look something like this:
Variable name | Written by | Meaning |
---|---|---|
thisExp.thisEntry['<ROUTINE_NAME>.started'] |
Any routine | Clock time when the routine preparation starts. |
thisExp.thisEntry['<ROUTINE_NAME>.stopped'] |
Any routine | Clock time when the routine ends. Closest estimation to offset time of visual stimuli that end with the end of the routine. |
thisExp.thisEntry['<COMPONENT_NAME>.started'] |
Any visual component (but also keyboard component etc. have to look into) | Exact onset time of a visually presented stimuli |
thisExp.thisEntry[<COMPONENT_NAME>.stopped] |
Any visual component when its ending falls within a routine (so is not equal to the end of a Routine) | Can provide exact offset time, but only if the end of this component is not equal to the end of the routine[^1]. |
<COMPONENT_NAME>.tStartRefresh |
Any visual component | Exact onset time |
<COMPONENT_NAME>.tStop |
Any visual component | Approximate offset time, underestimated |
<COMPONENT_NAME>.rt |
Any input component | The time between the start of the input component and the time first input was received. (#TODO Check what happens when multiple inputs...) |
<COMPONENT_NAME>.keys |
Keyboard component | The keys that were pressed |
<COMPONENT_NAME>.lastPos |
Mouse component | The coordinates of the mouse position at response. Variable is an array with x,y,z coordinates |