Skip to content

Commit

Permalink
carry over initial text
Browse files Browse the repository at this point in the history
  • Loading branch information
sappelhoff committed Jan 12, 2024
1 parent db1c9ff commit 7fcd842
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ nav:
- BIDS Derivatives: derivatives/introduction.md
- Common data types and metadata: derivatives/common-data-types.md
- Imaging data types: derivatives/imaging.md
- Electrophysiology data types: derivatives/ephys.md
- Longitudinal and multi-site studies: longitudinal-and-multi-site-studies.md
- Glossary: glossary.md
- BIDS Extension Proposals: extensions.md
Expand Down
43 changes: 43 additions & 0 deletions src/derivatives/ephys.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Electrophysiology data types

This section pertains to human electrophysiological data, including EEG, MEG and iEEG, which characteristically have channels and time.
This includes minimally processed data, but excludes data that has undergone extensive processing, such as source reconstruction.

## Minimally processed electrophysiological data

A minimally processed EEG, MEG or iEEG data can be stored as a derivative, using the same file formats as specified for raw EEG, MEG, or iEEG.
Examples for this are MaxFiltered MEG data, or re-referenced and bandpass-filtered EEG data.
Certain file formats that are allowed in BIDS for raw data have limited representation to some extent,
for example the EDF and BDF formats cannot be used to store epoched (or "segmented") data in a standardized way,
whereas the BrainVision and FIF file formats can.
These limitations should be taken into account when writing derivative data back to disk.
The representation of the data MUST follow the general derivative conventions and the Common file level metadata fields,
notably the use of the [`desc` entity](../appendices/entities.md#desc).

If minimally processed data is the result from processing a BIDS dataset, then it MUST be marked as a derivative and the source data must be specified.
The processing steps MUST be indicated in the [`desc` entity](../appendices/entities.md#desc),
where the label is a description identifier that distinguishes it from the original raw data.

If minimal processing was performed on the source data,
but the raw data itself does not exist as a BIDS dataset,
then the minimally processed data MAY be marked as a raw BIDS dataset.
When represented as a raw BIDS dataset,
the [`desc` entity](../appendices/entities.md#desc) is not needed to distinguish the data and MUST NOT be used.

The description of the processing in the derivative MUST be clarified in the [descriptions.tsv](common-data-types.md#descriptions-tsv) file,
with at least two columns for desc_id and the actual description.
Other columns MAY be added but are at this moment not standardized.
The [descriptions.tsv](common-data-types.md#descriptions-tsv) file SHOULD include sufficient information to document the details of the data processing that resulted in the derivative.

The `_eeg.json`, `_meg.json`, or `_ieeg.json` sidecar files MUST be replicated alongside the respective derivative `_eeg.<ext>`, `_meg.<ext>`, or `_ieeg.<ext>` data files,
so that they can be processed as if it were a raw BIDS dataset.
The json sidecar file must be compliant with those for raw data and SHOULD NOT include fields that are specific to the processing that was done on the data.

## MaxFiltered MEG data

to be done

## Other sections (to be done)

to be done

0 comments on commit 7fcd842

Please sign in to comment.