Skip to content

Commit

Permalink
Merge remote-tracking branch 'upstream/master' into common-derivatives
Browse files Browse the repository at this point in the history
  • Loading branch information
@effigies
effigies committed Nov 4, 2019
2 parents 33de3f1 + e7af029 commit 45d93f9
Show file tree
Hide file tree
Showing 6 changed files with 120 additions and 103 deletions.
58 changes: 29 additions & 29 deletions src/04-modality-specific-files/02-magnetoencephalography.md
View file

Large diffs are not rendered by default.

54 changes: 30 additions & 24 deletions src/04-modality-specific-files/03-electroencephalography.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,33 +112,33 @@ Whenever possible, please avoid using ad hoc wording.

Specific EEG fields MUST be present:

| Field name | Definition |
| :----------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| EEGReference | REQUIRED. General description of the reference scheme used and (when applicable) of location of the reference electrode in the raw recordings (e.g., "left mastoid", "Cz", "CMS"). If different channels have a different reference, this field should have a general description and the channel specific reference should be defined in the \_channels.tsv file. |
| SamplingFrequency | REQUIRED. Sampling frequency (in Hz) of all the data in the recording, regardless of their type (e.g., 2400). |
| PowerLineFrequency | REQUIRED. Frequency (in Hz) of the power grid at the geographical location of the EEG instrument (i.e., 50 or 60). |
| SoftwareFilters | REQUIRED. List of temporal software filters applied. Ideally key:value pairs of pre-applied software filters and their parameter values: e.g., `{"Anti-aliasing filter": {"half-amplitude cutoff (Hz)": 500, "Roll-off": "6dB/Octave"}}`. Write `n/a` if no software filters applied. |
| Field name | Definition |
| :----------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| EEGReference | REQUIRED. General description of the reference scheme used and (when applicable) of location of the reference electrode in the raw recordings (e.g., "left mastoid", "Cz", "CMS"). If different channels have a different reference, this field should have a general description and the channel specific reference should be defined in the \_channels.tsv file. |
| SamplingFrequency | REQUIRED. Sampling frequency (in Hz) of all the data in the recording, regardless of their type (e.g., 2400). |
| PowerLineFrequency | REQUIRED. Frequency (in Hz) of the power grid at the geographical location of the EEG instrument (i.e., 50 or 60). |
| SoftwareFilters | REQUIRED. A [JSON object](https://www.w3schools.com/js/js_json_objects.asp) of temporal software filters applied, or `"n/a"` if the data is not available. Each key:value pair in the JSON object is a name of the filter and an object in which its parameters are defined as key:value pairs. E.g., `{"Anti-aliasing filter": {"half-amplitude cutoff (Hz)": 500, "Roll-off": "6dB/Octave"}}`. |

SHOULD be present:

| Field name | Definition |
| :--------------------------| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CapManufacturer | RECOMMENDED. Name of the cap manufacturer (e.g., "EasyCap"). |
| CapManufacturersModelName | RECOMMENDED. Manufacturer's designation of the EEG cap model (e.g., "actiCAP 64 Ch Standard-2"). |
| EEGChannelCount | RECOMMENDED. Number of EEG channels included in the recording (e.g., 128). |
| ECGChannelCount | RECOMMENDED. Number of ECG channels. |
| EMGChannelCount | RECOMMENDED. Number of EMG channels. |
| EOGChannelCount | RECOMMENDED. Number of EOG channels. |
| MiscChannelCount | RECOMMENDED. Number of miscellaneous analog channels for auxiliary signals. |
| TriggerChannelCount | RECOMMENDED. Number of channels for digital (TTL bit level) trigger. |
| RecordingDuration | RECOMMENDED. Length of the recording in seconds (e.g., 3600). |
| RecordingType | RECOMMENDED. Defines whether the recording is `continuous`, `discontinuous` or `epoched`. |
| EpochLength | RECOMMENDED. Duration of individual epochs in seconds (e.g., 1) in case of epoched data. |
| HeadCircumference | RECOMMENDED. Circumference of the participants head, expressed in cm (e.g., 58). |
| EEGPlacementScheme | RECOMMENDED. Placement scheme of EEG electrodes. Either the name of a standardized placement system (e.g., "10-20") or a list of standardized electrode names (e.g., `["Cz", "Pz"]`). |
| EEGGround | RECOMMENDED. Description of the location of the ground electrode (e.g., "placed on right mastoid (M2)"). |
| HardwareFilters | RECOMMENDED. List of temporal hardware filters applied. Ideally key:value pairs of pre-applied hardware filters and their parameter values: e.g., `{"HardwareFilters": {"Highpass RC filter": {"Half amplitude cutoff (Hz)": 0.0159, "Roll-off": "6dB/Octave"}}}`. Write `n/a` if no hardware filters applied. |
| SubjectArtefactDescription | RECOMMENDED. Free-form description of the observed subject artifact and its possible cause (e.g., "Vagus Nerve Stimulator", "non-removable implant"). If this field is set to `n/a`, it will be interpreted as absence of major source of artifacts except cardiac and blinks. |
| Field name | Definition |
| :--------------------------| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CapManufacturer | RECOMMENDED. Name of the cap manufacturer (e.g., "EasyCap"). |
| CapManufacturersModelName | RECOMMENDED. Manufacturer's designation of the EEG cap model (e.g., "actiCAP 64 Ch Standard-2"). |
| EEGChannelCount | RECOMMENDED. Number of EEG channels included in the recording (e.g., 128). |
| ECGChannelCount | RECOMMENDED. Number of ECG channels. |
| EMGChannelCount | RECOMMENDED. Number of EMG channels. |
| EOGChannelCount | RECOMMENDED. Number of EOG channels. |
| MiscChannelCount | RECOMMENDED. Number of miscellaneous analog channels for auxiliary signals. |
| TriggerChannelCount | RECOMMENDED. Number of channels for digital (TTL bit level) trigger. |
| RecordingDuration | RECOMMENDED. Length of the recording in seconds (e.g., 3600). |
| RecordingType | RECOMMENDED. Defines whether the recording is `continuous`, `discontinuous` or `epoched`. |
| EpochLength | RECOMMENDED. Duration of individual epochs in seconds (e.g., 1) in case of epoched data. |
| EEGGround | RECOMMENDED. Description of the location of the ground electrode (e.g., "placed on right mastoid (M2)"). |
| HeadCircumference | RECOMMENDED. Circumference of the participants head, expressed in cm (e.g., 58). |
| EEGPlacementScheme | RECOMMENDED. Placement scheme of EEG electrodes. Either the name of a standardized placement system (e.g., "10-20") or a list of standardized electrode names (e.g., `["Cz", "Pz"]`). |
| HardwareFilters | RECOMMENDED. A [JSON object](https://www.w3schools.com/js/js_json_objects.asp) of temporal hardware filters applied, or `"n/a"` if the data is not available. Each key:value pair in the JSON object is a name of the filter and an object in which its parameters are defined as key:value pairs. E.g., `{"Highpass RC filter": {"Half amplitude cutoff (Hz)": 0.0159, "Roll-off": "6dB/Octave"}}` |
| SubjectArtefactDescription | RECOMMENDED. Free-form description of the observed subject artifact and its possible cause (e.g., "Vagus Nerve Stimulator", "non-removable implant"). If this field is set to `n/a`, it will be interpreted as absence of major source of artifacts except cardiac and blinks. |

Example:

Expand All @@ -163,6 +163,12 @@ Example:
"EEGPlacementScheme":"10 percent system",
"EEGReference":"single electrode placed on FCz",
"EEGGround":"placed on AFz",
"SoftwareFilters":{
"Anti-aliasing filter":{
"half-amplitude cutoff (Hz)": 500,
"Roll-off": "6dB/Octave"
}
},
"HardwareFilters":{
"ADC's decimation filter (hardware bandwidth limit)":{
"-3dB cutoff point (Hz)":480,
Expand Down
Loading

0 comments on commit 45d93f9

Please sign in to comment.