Skip to content

Commit a16e4fe

Browse files
committed
add and improve information to subfunctions in the readme
1 parent 3986b83 commit a16e4fe

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,22 +105,27 @@ end
105105

106106
### subfun/doDotMo
107107

108+
Wrapper function that present the dot stimulation (static or motion) per event.
109+
108110
#### Input
109111

110-
- `cfg`: PTB/machine configurations returned by `setParameters` and `initPTB`
111-
- `expParameters`: parameters returned by `setParameters`
112-
- `logFile`: structure that stores the experiment logfile to be saved
112+
- `cfg`: PTB/machine and experiment configurations returned by `setParameters` and `initPTB`
113+
- `thisEvent`: structure that stores information about the event to present regarding the dots (static or motion, direction, etc.)
114+
- `thisFixation`: structure that stores information about the fixation cross task to present
115+
- `dots`: [...]
116+
- `iEvent`: index of the event of the block at the moment of the presentation
113117

114118
#### Output
115119

116120
- Event `onset`
117121
- Event `duration`
122+
- `dots`: [...]
118123

119-
The dots are drawn on a square that contains the round aperture, then any dots outside of the aperture is turned into a NaN so effectively the actual number of dots on the screen at any given time is not the one that you input but a smaller number (nDots / Area of aperture) on average.
124+
> NB: The dots are drawn on a square that contains the round aperture, then any dots outside of the aperture is turned into a NaN so effectively the actual number of dots on the screen at any given time is not the one that you input but a smaller number (nDots / Area of aperture) on average.
120125
121-
### subfun/expDesign
126+
### subfun/expDesign(MtMst)
122127

123-
Creates the sequence of blocks and the events in them. The conditions are consecutive static and motion blocks (Gives better results than randomised). It can be run as a stand alone without inputs to display a visual example of possible design.
128+
These functions, one per MT+ and one per MT/MST localizer, create the sequence of blocks and the events in them. The conditions are consecutive static and motion blocks (Gives better results than randomised). It can be run as a stand alone with input `cfg` from `setParamenters.m` to display a visual example of possible design.
124129

125130
#### EVENTS
126131

0 commit comments

Comments
 (0)