Skip to content

Commit 88d8ae1

Browse files
Remi-GauRemi-Gau
committed
update README
1 parent edc8d57 commit 88d8ae1

File tree

1 file changed

+69
-55
lines changed

1 file changed

+69
-55
lines changed

‎README.md‎

Lines changed: 69 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,35 @@
11
[![](https://img.shields.io/badge/Octave-CI-blue?logo=Octave&logoColor=white)](https://github.com/cpp-lln-lab/localizer_auditory_motion/actions)
2+
23
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
4+
35
[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
6+
47
<!-- ALL-CONTRIBUTORS-BADGE:END -->
5-
![](https://github.com/cpp-lln-lab/localizer_auditory_motion/workflows/CI/badge.svg)
68

9+
![](https://github.com/cpp-lln-lab/localizer_auditory_motion/workflows/CI/badge.svg)
710
[![codecov](https://codecov.io/gh/cpp-lln-lab/localizer_auditory_motion/branch/master/graph/badge.svg)](https://codecov.io/gh/cpp-lln-lab/localizer_auditory_motion)
8-
911
[![Build Status](https://travis-ci.com/cpp-lln-lab/localizer_auditory_motion.svg?branch=master)](https://travis-ci.com/cpp-lln-lab/localizer_auditory_motion)
1012

11-
1213
# Auditory Translational Motion
1314

14-
<!-- vscode-markdown-toc -->
15-
16-
- 1. [Requirements](#Requirements)
17-
- 2. [Installation](#Installation)
18-
- 3. [Structure and function details](#Structureandfunctiondetails)
19-
_ 3.1. [audioLocTranslational](#audioLocTranslational)
20-
_ 3.2. [setParameters](#setParameters)
21-
_ 3.3. [subfun/expDesign](#subfunexpDesign)
22-
_ 3.3.1. [EVENTS](#EVENTS)
23-
_ 3.3.2. [TARGETS:](#TARGETS:)
24-
_ 3.3.3. [Input:](#Input:)
25-
_ 3.3.4. [Output:](#Output:)
26-
_ 3.4. [subfun/eyeTracker](#subfuneyeTracker) \* 3.5. [subfun/wait4Trigger](#subfunwait4Trigger)
27-
28-
<!-- vscode-markdown-toc-config
29-
numbering=true
30-
autoSave=true
31-
/vscode-markdown-toc-config -->
32-
<!-- /vscode-markdown-toc -->
33-
34-
## 1. <a name='Requirements'></a>Requirements
35-
36-
Make sure that the following toolboxes are installed and added to the matlab / octave path.
15+
- [Auditory Translational Motion](#auditory-translational-motion)
16+
- [Requirements](#requirements)
17+
- [Installation](#installation)
18+
- [Structure and function details](#structure-and-function-details)
19+
- [audioLocTranslational](#audioloctranslational)
20+
- [setParameters](#setparameters)
21+
- [Let the scanner pace the experiment](#let-the-scanner-pace-the-experiment)
22+
- [subfun/expDesign](#subfunexpdesign)
23+
- [EVENTS](#events)
24+
- [TARGETS](#targets)
25+
- [Input](#input)
26+
- [Output](#output)
27+
- [Contributors ✨](#contributors-)
28+
29+
## Requirements
30+
31+
Make sure that the following toolboxes are installed and added to the matlab /
32+
octave path.
3733

3834
For instructions see the following links:
3935

@@ -43,28 +39,32 @@ For instructions see the following links:
4339
| [Matlab](https://www.mathworks.com/products/matlab.html) | >=2017b |
4440
| or [octave](https://www.gnu.org/software/octave/) | >=4.? |
4541

46-
## 2. <a name='Installation'></a>Installation
42+
## Installation
4743

48-
The CPP_BIDS and CPP_PTB dependencies are already set up as submodule to this repository.
49-
You can install it all with git by doing.
44+
The CPP_BIDS and CPP_PTB dependencies are already set up as submodule to this
45+
repository. You can install it all with git by doing.
5046

5147
```bash
5248
git clone --recurse-submodules https://github.com/cpp-lln-lab/localizer_auditory_motion.git
5349
```
5450

55-
## 3. <a name='Structureandfunctiondetails'></a>Structure and function details
51+
## Structure and function details
5652

57-
### 3.1. <a name='audioLocTranslational'></a>audioLocTranslational
53+
### audioLocTranslational
5854

59-
Running this script will play blocks of motion/static sounds. Motion blocks will play sounds moving in one of four directions (up-, down-, left-, and right-ward)
55+
Running this script will play blocks of motion/static sounds. Motion blocks will
56+
play sounds moving in one of four directions (up-, down-, left-, and right-ward)
6057

61-
By default it is run in `Debug mode` meaning that it does not care about subjID, run n., fMRI triggers, Eye Tracker, etc..
58+
By default it is run in `Debug mode` meaning that it does not care about subjID,
59+
run n., fMRI triggers, Eye Tracker, etc..
6260

63-
Any details of the experiment can be changed in `setParameters.m` (e.g., experiment mode, motion stimuli details, exp. design, etc.)
61+
Any details of the experiment can be changed in `setParameters.m` (e.g.,
62+
experiment mode, motion stimuli details, exp. design, etc.)
6463

65-
### 3.2. <a name='setParameters'></a>setParameters
64+
### setParameters
6665

67-
`setParameters.m` is the core engine of the experiment. It contains the following tweakable sections:
66+
`setParameters.m` is the core engine of the experiment. It contains the
67+
following tweakable sections:
6868

6969
- Debug mode setting
7070
- Engine parameters:
@@ -78,10 +78,11 @@ Any details of the experiment can be changed in `setParameters.m` (e.g., experim
7878
- Task(s)
7979
- Instructions
8080
- Task #1 parameters
81-
81+
8282
#### Let the scanner pace the experiment
8383

84-
Set `cfg.pacedByTriggers.do` to `true` and you can then set all the details in this `if` block
84+
Set `cfg.pacedByTriggers.do` to `true` and you can then set all the details in
85+
this `if` block
8586

8687
```matlab
8788
% Time is here in in terms of number repetition time (i.e MRI volumes)
@@ -104,38 +105,48 @@ if cfg.pacedByTriggers.do
104105
end
105106
```
106107

107-
### 3.3. <a name='subfunexpDesign'></a>subfun/expDesign
108+
### subfun/expDesign
108109

109-
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 a possible design.
110+
Creates the sequence of blocks and the events in them. The conditions are
111+
consecutive static and motion blocks (Gives better results than randomised). It
112+
can be run as a stand alone without inputs to display a visual example of a
113+
possible design.
110114

111-
#### 3.3.1. <a name='EVENTS'></a>EVENTS
115+
#### EVENTS
112116

113-
The `numEventsPerBlock` should be a multiple of the number of "base" listed in the `motionDirections` and `staticDirections` (4 at the moment).
117+
The `numEventsPerBlock` should be a multiple of the number of "base" listed in
118+
the `motionDirections` and `staticDirections` (4 at the moment).
114119

115-
#### 3.3.2. <a name='TARGETS:'></a>TARGETS:
120+
#### TARGETS
116121

117-
- If there are 2 targets per block we make sure that they are at least 2 events apart.
122+
- If there are 2 targets per block we make sure that they are at least 2 events
123+
apart.
118124
- Targets cannot be on the first or last event of a block
119125

120-
#### 3.3.3. <a name='Input:'></a>Input:
126+
#### Input
121127

122128
- `expParameters`: parameters returned by `setParameters`
123-
- `displayFigs`: a boolean to decide whether to show the basic design matrix of the design
129+
- `displayFigs`: a boolean to decide whether to show the basic design matrix of
130+
the design
124131

125-
#### 3.3.4. <a name='Output:'></a>Output:
132+
#### Output
126133

127-
- `expParameters.designBlockNames` is a cell array `(nr_blocks, 1)` with the name for each block
128-
- `expParameters.designDirections` is an array `(nr_blocks, numEventsPerBlock)` with the direction to present in a given block
134+
- `expParameters.designBlockNames` is a cell array `(nr_blocks, 1)` with the
135+
name for each block
136+
- `expParameters.designDirections` is an array `(nr_blocks, numEventsPerBlock)`
137+
with the direction to present in a given block
129138
- `0 90 180 270` indicate the angle
130139
- `-1` indicates static
131-
- `expParameters.designSpeeds` is an array `(nr_blocks, numEventsPerBlock) * speedEvent`
132-
- `expParameters.designFixationTargets` is an array `(nr_blocks, numEventsPerBlock)` showing for each event if it should be accompanied by a target
133-
134-
140+
- `expParameters.designSpeeds` is an array
141+
`(nr_blocks, numEventsPerBlock) * speedEvent`
142+
- `expParameters.designFixationTargets` is an array
143+
`(nr_blocks, numEventsPerBlock)` showing for each event if it should be
144+
accompanied by a target
135145

136146
## Contributors ✨
137147

138-
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
148+
Thanks goes to these wonderful people
149+
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
139150

140151
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
141152
<!-- prettier-ignore-start -->
@@ -150,6 +161,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
150161

151162
<!-- markdownlint-enable -->
152163
<!-- prettier-ignore-end -->
164+
153165
<!-- ALL-CONTRIBUTORS-LIST:END -->
154166

155-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
167+
This project follows the
168+
[all-contributors](https://github.com/all-contributors/all-contributors)
169+
specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)