Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
99 commits
Select commit Hold shift + click to select a range
94dc332
remove bep006 from list of extensions
sappelhoff Dec 16, 2018
b49faba
add contributions @sappelhoff
sappelhoff Dec 16, 2018
ec1a9ce
edit changes for BEP006 merge
sappelhoff Dec 16, 2018
b4bf291
add BEP006 to mkdocs config
sappelhoff Dec 16, 2018
8230c87
start working on EEG document
sappelhoff Dec 16, 2018
a2020b1
initial text
sappelhoff Dec 16, 2018
e537fa1
add first section bep006 spec
sappelhoff Dec 17, 2018
4c71fe4
edit link pointing to BEP006
sappelhoff Dec 18, 2018
90150c9
add sidecar table
sappelhoff Dec 18, 2018
02f0444
fix typo
sappelhoff Dec 18, 2018
32c7c64
fix contributors after rebase
sappelhoff Dec 18, 2018
8bb681c
linter fixes
sappelhoff Dec 18, 2018
f233464
dont manually update changes
sappelhoff Dec 18, 2018
dd752d0
add channels section
sappelhoff Dec 20, 2018
e7c4e5b
add electrodes description table
sappelhoff Jan 3, 2019
54aa1f2
fix typo
sappelhoff Jan 4, 2019
27b0b94
add coordsystem and photo
sappelhoff Jan 4, 2019
61f5752
remove redundant line
chrisgorgo Jan 4, 2019
c5ccb4c
renaming previous files so that ordering fits 03 04 05 ...
sappelhoff Jan 4, 2019
ba31753
add value and sample as non-custom keys for events.tsv
sappelhoff Jan 4, 2019
0db1e4f
add links and document examples
sappelhoff Jan 4, 2019
753bc07
address @gllmflndn comments
sappelhoff Jan 7, 2019
8bf08a8
address @arnodelorme comments
sappelhoff Jan 7, 2019
578089b
made link to extension protocol consistent between MEG and EEG
robertoostenveld Jan 9, 2019
7ec0b25
some small changes to the specification and description of the fields…
robertoostenveld Jan 9, 2019
b00246a
small clarification of SI units
robertoostenveld Jan 9, 2019
bdea24d
cleaned up some spaces
robertoostenveld Jan 9, 2019
81666a0
align table pipe
sappelhoff Jan 9, 2019
576c4b1
EEGChannelCount RECOMMENDED ... GSR = response, not resistance
sappelhoff Jan 9, 2019
5483835
add fiducial information
sappelhoff Jan 9, 2019
c0f32cf
ascii tables with tabs in markdown are not rendered properly in html
robertoostenveld Jan 10, 2019
3fdde6e
field name --> column name ... in tables for TSV files
sappelhoff Jan 10, 2019
3ac0533
add missing contributors
sappelhoff Jan 10, 2019
3b3fa15
mention common channel types for MEG *and* iEEG, see https://github.c…
robertoostenveld Jan 10, 2019
b57d191
adding first BEP010 spec
choldgraf Dec 22, 2018
079d24a
reorganized the first section, in line with MEG and EEG spec
robertoostenveld Jan 9, 2019
2fbe081
cleaned up come of teh tables (format only, no content changes)
robertoostenveld Jan 9, 2019
9fdc445
small formatting, provide link to sourcedata documentation
robertoostenveld Jan 10, 2019
a1ee06f
removed physio files from file/directory listing
robertoostenveld Jan 10, 2019
3e2cb36
removed surface data derivatives that were mentioned in the file/dire…
robertoostenveld Jan 10, 2019
a3122ba
once more removed surface derivatives data, removed CT data (those ar…
robertoostenveld Jan 10, 2019
11c87c6
start with a short template with only ieeg file and ieeg.json, just l…
robertoostenveld Jan 10, 2019
b98f562
split the tables differently, one section is shared with all modaliti…
robertoostenveld Jan 10, 2019
cb871c4
don't use square brackets in tables to indicate optional items, use (…
robertoostenveld Jan 10, 2019
5be8579
insert optional ses-label in the file/directory strucure
robertoostenveld Jan 10, 2019
611d15f
reorganized the must/should/may sections of the gheneric and ieeg spe…
robertoostenveld Jan 10, 2019
2e03386
added channel.tsv section, removed space from iEEG data filename (sin…
robertoostenveld Jan 10, 2019
7380acf
cleaned up channel.tsv section, show example as a text block, not as …
robertoostenveld Jan 10, 2019
af890da
further cleanups to channel section
robertoostenveld Jan 10, 2019
c435155
cleaned up the electrodes section
robertoostenveld Jan 10, 2019
3094de0
cleaned up whilespace in tables
robertoostenveld Jan 10, 2019
0e400e8
cleaned up section on coordsystem.json
robertoostenveld Jan 10, 2019
30ccf63
reorganized section on photo's
robertoostenveld Jan 10, 2019
8a8daf1
include template filename for electrodes, coordsystem and photos
robertoostenveld Jan 10, 2019
2f73873
included section on electrical stimulation
robertoostenveld Jan 10, 2019
2ab3d46
wrap the text of some long lines to a decent page width
robertoostenveld Jan 10, 2019
6be2b84
used https://prettier.io to clean up and reflow the text and make the…
robertoostenveld Jan 10, 2019
4592b8a
Update src/04-modality-specific-files/06-intracranial-electroencephal…
choldgraf Jan 10, 2019
a3c3664
Update src/04-modality-specific-files/06-intracranial-electroencephal…
choldgraf Jan 10, 2019
7beb3c5
Update src/04-modality-specific-files/06-intracranial-electroencephal…
choldgraf Jan 10, 2019
73370e8
Update src/04-modality-specific-files/06-intracranial-electroencephal…
choldgraf Jan 10, 2019
73a7568
Update src/04-modality-specific-files/06-intracranial-electroencephal…
choldgraf Jan 10, 2019
db2e5dd
Update src/04-modality-specific-files/06-intracranial-electroencephal…
choldgraf Jan 10, 2019
b5b407d
Update src/04-modality-specific-files/06-intracranial-electroencephal…
choldgraf Jan 10, 2019
2c798ee
Update src/04-modality-specific-files/06-intracranial-electroencephal…
choldgraf Jan 10, 2019
b018ad2
Update src/04-modality-specific-files/06-intracranial-electroencephal…
choldgraf Jan 10, 2019
17e7500
use iEEG instead of EEG in text
robertoostenveld Jan 10, 2019
6827970
removed the "remainder" section, and copied it to https://docs.google…
robertoostenveld Jan 10, 2019
6d4d12d
resolve conflicts
sappelhoff Jan 12, 2019
0d63b04
integrate bep010 into bep006 branch
sappelhoff Jan 12, 2019
00fd0df
fix iEEG formatting
sappelhoff Jan 12, 2019
0ed5d14
streamlining eeg and ieeg part 1 of n
sappelhoff Jan 12, 2019
47deced
cut length of headings
sappelhoff Jan 14, 2019
a87f02f
add ieeg brain electrode photos, add ieeg preprint reference
sappelhoff Jan 16, 2019
84a8030
add ieeg brain electrode photos, add ieeg preprint reference
sappelhoff Jan 16, 2019
4be9cb8
improved consistency between EEG and iEEG specification. See #108
robertoostenveld Jan 16, 2019
4f150de
added HardwareFilter as optional field to meg.json
robertoostenveld Jan 16, 2019
f8dcbe5
document HardwareFilter better for the iEEG specification
robertoostenveld Jan 16, 2019
c73c81f
linter fixes
sappelhoff Jan 18, 2019
3e3375f
updated _ieeg.json _channels.tsv and _electrodes.tsv examples
Jan 22, 2019
d0b821c
electrical_stimulation tag in _events.tsv should have underscores
Jan 22, 2019
84193b3
removed _space-<label> option and reference to BEP003 to ensure backw…
Jan 23, 2019
f48c6f3
linter fixes
sappelhoff Jan 23, 2019
9649096
update to have _space-label without link to BEP003
dorahermes Jan 27, 2019
ef7b823
add talk contrib badge @sappelhoff
sappelhoff Jan 30, 2019
cbbb75d
fix typo
chrisgorgo Feb 8, 2019
c026ed2
list all authors ieeg
sappelhoff Feb 8, 2019
a5de719
harmonize part about file formats and use already existing language
sappelhoff Feb 8, 2019
ac9474d
rebase and add @sappelhoff to notification system (CODEOWNERS)
sappelhoff Feb 13, 2019
72ff41a
rename behavioural -> behavorial (UK -> US) ... leftover from rebase
sappelhoff Feb 13, 2019
5ff82bd
clarify optional space label for electrodes and coordsystem
sappelhoff Feb 13, 2019
bb2b6e2
linter fixes
sappelhoff Feb 13, 2019
093c610
address review @robertoostenveld @dorahermes : no orig space
sappelhoff Feb 13, 2019
af12262
add ACPC coordinate system to list
sappelhoff Feb 14, 2019
53a43da
fix typos and make string emphasis signs consistent
sappelhoff Feb 14, 2019
d64d019
fix ACPC, overhaul coordinates appendix, clarify iEEG coordsystem field
sappelhoff Feb 14, 2019
23ea300
add link to fieldtrip wikifor ACPC, linter fixes
sappelhoff Feb 14, 2019
637740c
adjust heading in coords appendix to be more specific
chrisgorgo Feb 14, 2019
15668dc
add CPernet to Codeowners
sappelhoff Feb 20, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# This files DOES NOT list people responsible for maintanance of different parts of
# This files DOES NOT list people responsible for maintenance of different parts of
# the specification. It merely serves the purpose of notifying interested
# contributors when a new Pull Request that proposes changes to a particular file
# is submitted. If you would like to subscribe to such notifications (in a form of a
# Request for Review) please add your github username next to the file you want to
# Request for Review) please add your GitHub username next to the file you want to
# monitor below.

# Add your github name below to get notified about proposed releases
/src/CHANGES.md @chrisfilo
/src/CHANGES.md @chrisfilo @sappelhoff @CPernet

# Individual sections
/src/01-common-principles.md @chrisfilo
/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md @chrisfilo
/src/04-modality-specific-files/03-electroencephalography.md @sappelhoff
8 changes: 5 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ nav:
- Modality specific files:
- Magnetic Resonance Imaging: 04-modality-specific-files/01-magnetic-resonance-imaging-data.md
- Magnetoencephalography: 04-modality-specific-files/02-magnetoencephalography.md
- Task events: 04-modality-specific-files/03-task-events.md
- Physiological and other continous recordings: 04-modality-specific-files/04-physiological-and-other-continous-recordings.md
- Behavioral experiments (with no MRI): 04-modality-specific-files/05-behavioral-experiments.md
- Electroencephalography: 04-modality-specific-files/03-electroencephalography.md
- intracranial Electroencephalography: 04-modality-specific-files/04-intracranial-electroencephalography.md
- Task events: 04-modality-specific-files/05-task-events.md
- Physiological and other continous recordings: 04-modality-specific-files/06-physiological-and-other-continous-recordings.md
- Behavioral experiments (with no MRI): 04-modality-specific-files/07-behavioral-experiments.md
- Longitudinal and multi-site studies: 05-longitudinal-and-multi-site-studies.md
- Extending the BIDS specification: 06-extensions.md
- Appendix:
Expand Down
72 changes: 36 additions & 36 deletions src/04-modality-specific-files/02-magnetoencephalography.md

Large diffs are not rendered by default.

431 changes: 431 additions & 0 deletions src/04-modality-specific-files/03-electroencephalography.md

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ REQUIRED and OPTIONAL columns:
| :------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| onset | REQUIRED. Onset (in seconds) of the event measured from the beginning of the acquisition of the first volume in the corresponding task imaging data file. If any acquired scans have been discarded before forming the imaging data file, ensure that a time of 0 corresponds to the first image stored. In other words negative numbers in "onset" are allowed<sup>5</sup>. |
| duration | REQUIRED. Duration of the event (measured from onset) in seconds. Must always be either zero or positive. A "duration" value of zero implies that the delta function or event is so short as to be effectively modeled as an impulse. |
| sample | OPTIONAL. Onset of the event according to the sampling scheme of the recorded modality (i.e., referring to the raw data file that the `events.tsv` file accompanies). |
| trial_type | OPTIONAL. Primary categorisation of each trial to identify them as instances of the experimental conditions. For example: for a response inhibition task, it could take on values "go" and "no-go" to refer to response initiation and response inhibition experimental conditions. |
| response_time | OPTIONAL. Response time measured in seconds. A negative response time can be used to represent preemptive responses and "n/a" denotes a missed response. |
| stim_file | OPTIONAL. Represents the location of the stimulus file (image, video, sound etc.) presented at the given onset time. There are no restrictions on the file formats of the stimuli files, but they should be stored in the /stimuli folder (under the root folder of the dataset; with optional subfolders). The values under the stim_file column correspond to a path relative to "/stimuli". For example "images/cat03.jpg" will be translated to "/stimuli/images/cat03.jpg". |
| value | OPTIONAL. Marker value associated with the event (e.g., the value of a TTL trigger that was recorded at the onset of the event). |
| HED | OPTIONAL. Hierarchical Event Descriptor (HED) Tag. See [Appendix III](../99-appendices/03-hed.md) for details. |

<sup>5</sup> For example in case there is an in scanner training phase that
Expand Down
26 changes: 26 additions & 0 deletions src/04-modality-specific-files/07-behavioral-experiments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Behavioral experiments (with no MRI)

Template:

```Text
sub-<label>/[ses-<label>/]
beh/
sub-<label>[_ses-<label>]_task-<task_name>_events.tsv
sub-<label>[_ses-<label>]_task-<task_name>_events.json
sub-<label>[_ses-<label>]_task-<task_name>_beh.tsv
sub-<label>[_ses-<label>]_task-<task_name>_beh.json
sub-<label>[_ses-<label>]_task-<task_name>_physio.tsv.gz
sub-<label>[_ses-<label>]_task-<task_name>_physio.json
sub-<label>[_ses-<label>]_task-<task_name>_stim.tsv.gz
sub-<label>[_ses-<label>]_task-<task_name>_stim.json
```

In addition to logs from behavioral experiments performed along imaging data
acquisitions one can also include data from experiments performed outside of the
scanner. The results of those experiments can be stored in the beh folder using
the same formats for event timing (`_events.tsv`), metadata (`_events.json`),
physiological (`_physio.tsv.gz`, `_physio.json`) and other continuous recordings
(`_stim.tsv.gz`, `_stim.json`) as for tasks performed during MRI acquisitions.
Additionally, events files that do not include the mandatory `onset` and
`duration` columns can still be included, but should be labelled `_beh.tsv`
rather than `_events.tsv`.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions src/06-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ Below is a table of currently-active BEPs.
| [BEP003](https://docs.google.com/document/d/1Wwc4A6Mow4ZPPszDIWfCUCRNstn7d_zzaWPcfcHmgI4) | [Common Derivatives](https://docs.google.com/document/d/1Wwc4A6Mow4ZPPszDIWfCUCRNstn7d_zzaWPcfcHmgI4) | Chris Gorgolewski |
| [BEP004](https://docs.google.com/document/d/1kyw9mGgacNqeMbp4xZet3RnDhcMmf4_BmRgKaOkO2Sc) | [Susceptibility Weighted Imaging (SWI)](https://docs.google.com/document/d/1kyw9mGgacNqeMbp4xZet3RnDhcMmf4_BmRgKaOkO2Sc) | Fidel Alfaro Almagro |
| [BEP005](https://docs.google.com/document/d/15tnn5F10KpgHypaQJNNGiNKsni9035GtDqJzWqkkP6c) | [Arterial Spin Labeling (ASL)](https://docs.google.com/document/d/15tnn5F10KpgHypaQJNNGiNKsni9035GtDqJzWqkkP6c) | Henk-Jan Mutsaerts and Michael Chappell |
| [BEP006](https://docs.google.com/document/d/1ArMZ9Y_quTKXC-jNXZksnedK2VHHoKP3HCeO5HPcgLE) | [Electroencephalography (EEG)](https://docs.google.com/document/d/1ArMZ9Y_quTKXC-jNXZksnedK2VHHoKP3HCeO5HPcgLE) | Cyril R Pernet, Robert Oostenveld, Stefan Appelhoff |
| [BEP009](https://docs.google.com/document/d/1mqMLnxVdLwZjDd4ZiWFqjEAmOmfcModA_R535v3eQs0) | [Positron Emission Tomography (PET)](https://docs.google.com/document/d/1mqMLnxVdLwZjDd4ZiWFqjEAmOmfcModA_R535v3eQs0) | Melanie Ganz |
| [BEP010](https://docs.google.com/document/d/1qMUkoaXzRMlJuOcfTYNr3fTsrl4SewWjffjMD5Ew6GY) | [intracranial Electroencephalography (iEEG)](https://docs.google.com/document/d/1qMUkoaXzRMlJuOcfTYNr3fTsrl4SewWjffjMD5Ew6GY) | Dora Hermes and Chris Holdgraf |
| [BEP011](https://docs.google.com/document/d/1YG2g4UkEio4t_STIBOqYOwneLEs1emHIXbGKynx7V0Y) | [The structural preprocessing derivatives](https://docs.google.com/document/d/1YG2g4UkEio4t_STIBOqYOwneLEs1emHIXbGKynx7V0Y) | Andrew Hoopes |
| [BEP012](https://docs.google.com/document/d/16CvBwVMAs0IMhdoKmlmcm3W8254dQmNARo-7HhE-lJU) | [The functional preprocessing derivatives](https://docs.google.com/document/d/16CvBwVMAs0IMhdoKmlmcm3W8254dQmNARo-7HhE-lJU) | Camille Maumet and Chris Markiewicz |
| [BEP013](https://docs.google.com/document/d/1qBNQimDx6CuvHjbDvuFyBIrf2WRFUOJ-u50canWjjaw) | [The resting state fMRI derivatives](https://docs.google.com/document/d/1qBNQimDx6CuvHjbDvuFyBIrf2WRFUOJ-u50canWjjaw) | Steven Giavasis |
Expand Down
4 changes: 3 additions & 1 deletion src/99-appendices/01-contributors.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following individuals have contributed to the Brain Imaging Data Structure
ecosystem (in alphabetical order). If you contributed to the BIDS ecosystem and
your name is not listed, please add it.

- Stefan Appelhoff 📖💬🤔🐛💡💻
- Stefan Appelhoff 📖💬🤔🐛💡💻👀⚠️📢
- Tibor Auer 💬📖💡🔧📢
- Sylvain Baillet 📖🔍
- Elizabeth Bock 📖💡
Expand All @@ -42,6 +42,7 @@ your name is not listed, please add it.
- R. Cameron Craddock 📖📢
- Samir Das 📖
- Alejandro de la Vega 🐛💻⚠️
- Arnaud Delorme 📖💡
- Eugene P. Duff 📖
- Elizabeth DuPre 📖💡🔍🤔
- Eric A. Earl 🤔
Expand Down Expand Up @@ -94,6 +95,7 @@ your name is not listed, please add it.
- Cyril Pernet 💬📖💡📋
- Franco Pestilli 📖
- Dmitry Petrov 📖💻
- Christophe Philips 📖
- Russell A. Poldrack 📖🔍📢
- Jean-Baptiste Poline 📖📢🤔🎨
- Vasudev Raguram 💻🎨📖🔧
Expand Down
83 changes: 52 additions & 31 deletions src/99-appendices/08-coordinate-systems.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Appendix VIII: preferred names of Coordinate systems
# Appendix VIII: Preferred Names of Coordinate Systems

To interpret a coordinate (x, y, z), it is required that you know relative to
which origin the coordinates are expressed, you have to know the interpretation
Expand All @@ -7,7 +7,9 @@ expressed. This information is sometimes called the coordinate system.

These letters help describe the coordinate system definition:

A/P means anterior/posterior L/R means left/right S/I means superior/inferior
- A/P means anterior/posterior
- L/R means left/right
- S/I means superior/inferior

For example: `RAS` means that the first dimension (X) points towards the right
hand side of the head, the second dimension (Y) points towards the Anterior
Expand All @@ -16,7 +18,7 @@ head.

Besides coordinate systems, defined by their origin and direction of the axes,
BIDS defines "spaces" as an artificial frame of reference, created to describe
different anatomies in a unifying manner (see e.g.
different anatomies in a unifying manner (see e.g.,
[https://doi.org/10.1016/j.neuroimage.2012.01.024](https://www.sciencedirect.com/science/article/pii/S1053811912000419?via%3Dihub)).
The "space" and all coordinates expressed in this space are by design a
transformation of the real world geometry, and nearly always different from the
Expand All @@ -30,41 +32,41 @@ The coordinate systems below all relate to neuroscience and therefore to the
head or brain coordinates. Please be aware that all data acquisition starts with
"device coordinates" (scanner), which does not have to be identical to the
initial "file format coordinates" (DICOM), which are again different from the
"head" coordinates (e.g. NIFTI). Not only do device coordinate vary between
"head" coordinates (e.g., NIFTI). Not only do device coordinate vary between
hardware manufacturers, but also the head coordinates differ, mostly due to
different conventions used in specific software packages developed by different
(commercial or academic) groups.

## MEG specific Coordinate Systems
## Coordinate Systems applicable to MEG, EEG, and iEEG

The first two pieces of information (origin, orientation) are specified in
`XXXCoordinateSystem`, the units are specified in `XXXCoordinateSystemUnits`.
Generally, across the MEG, EEG, and iEEG modalities, the first two pieces of
information (origin, orientation) are specified in `XXXCoordinateSystem`, and
the units are specified in `XXXCoordinateSystemUnits`.

Restricted keywords for the XXXCoordinateSystem field in the
`coordinatesystem.json` file for MEG datasets:

- CTF: ALS orientation and the origin between the ears

- ElektaNeuromag: RAS orientation and the origin between the ears
Allowed values for the `XXXCoordinateSystem` field come from a list of
restricted keywords, as listed in the sections below. If no value from the
list of restricted keywords fits, there is always the option to specify the
value as follows:

- 4DBti: ALS orientation and the origin between the ears
- `Other`: Use this for other coordinate systems and specify further details
in the `XXXCoordinateSystemDescription` field

- KitYokogawa: ALS orientation and the origin between the ears
## MEG Specific Coordinate Systems

- ChietiItab: RAS orientation and the origin between the ears

- Other: Use this for other coordinate systems and specify further details in
the `XXXCoordinateSystemDescription` field
Restricted keywords for the `XXXCoordinateSystem` field in the
`coordinatesystem.json` file for MEG datasets:

Note that the short descriptions above do not capture all details, there are
detailed descriptions of these coordinate systems on the FieldTrip toolbox web
page:
[http://www.fieldtriptoolbox.org/faq/how_are_the_different_head_and_mri_coordinate_systems_defined](http://www.fieldtriptoolbox.org/faq/how_are_the_different_head_and_mri_coordinate_systems_defined)
- `CTF`: ALS orientation and the origin between the ears
- `ElektaNeuromag`: RAS orientation and the origin between the ears
- `4DBti`: ALS orientation and the origin between the ears
- `KitYokogawa`: ALS orientation and the origin between the ears
- `ChietiItab`: RAS orientation and the origin between the ears

## EEG specific Coordinate Systems
Note that the short descriptions above do not capture all details, There are
detailed extensive descriptions of these EEG coordinate systems on the
[FieldTrip toolbox web page](http://www.fieldtriptoolbox.org/faq/how_are_the_different_head_and_mri_coordinate_systems_defined)

The first two pieces of information (origin, orientation) are specified in
`XXXCoordinateSystem`, the units are specified in `XXXCoordinateSystemUnits`.
## EEG Specific Coordinate Systems

Restricted keywords for the `XXXCoordinateSystem` field in the
`coordsystem.json` file for EEG datasets:
Expand All @@ -78,12 +80,31 @@ Restricted keywords for the `XXXCoordinateSystem` field in the
- `Captrak`: RAS orientation and the origin between the ears

Note that the short descriptions above do not capture all details, There are
detailed extensive descriptions of these EEG coordinate systems on the FieldTrip
toolbox web page and on the BESA wiki:
[http://www.fieldtriptoolbox.org/faq/how_are_the_different_head_and_mri_coordinate_systems_defined](http://www.fieldtriptoolbox.org/faq/how_are_the_different_head_and_mri_coordinate_systems_defined)
[http://wiki.besa.de/index.php?title=Electrodes_and_Surface_Locations\#Coordinate_systems](http://wiki.besa.de/index.php?title=Electrodes_and_Surface_Locations#Coordinate_systems)
detailed extensive descriptions of these EEG coordinate systems on the
[FieldTrip toolbox web page](http://www.fieldtriptoolbox.org/faq/how_are_the_different_head_and_mri_coordinate_systems_defined)
and on the [BESA wiki](http://wiki.besa.de/index.php?title=Electrodes_and_Surface_Locations#Coordinate_systems).

## Template based Coordinate Systems
## iEEG Specific Coordinate Systems

Restricted keywords for the `XXXCoordinateSystem` field in the
`coordsystem.json` file for iEEG datasets:

- `Pixels`: If electrodes are localized in 2D space (only x and y are
specified and z is n/a), then the positions in this file must correspond to
the locations expressed in pixels on the photo/drawing/rendering of the
electrodes on the brain. In this case, coordinates must be (row,column)
pairs, with (0,0) corresponding to the upper left pixel and (N,0)
corresponding to the lower left pixel.

- `ACPC`: The origin of the coordinate system is at the Anterior Commissure
and the negative y-axis is passing through the Posterior Commissure. The
positive z-axis is passing through a mid-hemispheric point in the superior
direction. The anatomical landmarks are determined in the individual's
anatomical scan and no scaling or deformations have been applied to the
individual's anatomical scan. For more information, see the [ACPC site](http://www.fieldtriptoolbox.org/faq/acpc/)
on the FieldTrip toolbox wiki.

## Template Based Coordinate Systems

The transformation of the real world geometry to an artificial frame of
reference is described in `XXXCoordinateSystem`. Unless otherwise specified
Expand Down
2 changes: 1 addition & 1 deletion src/CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Changelog

- Added support for MEG data (merged BEP008)
- Added SequenceName field.
- Added support for describing events with Hierarchical Event Descriptors \[[4.3 Task events](04-modality-specific-files/03-task-events.md)].
- Added support for describing events with Hierarchical Event Descriptors \[[4.3 Task events](04-modality-specific-files/05-task-events.md)].
- Added VolumeTiming and AcquisitionDuration fields \[[4.1 Task (including resting state) imaging data](04-modality-specific-files/01-magnetic-resonance-imaging-data.md#task-including-resting-state-imaging-data)].
- Added DwellTime field.

Expand Down
Loading