Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[FIX] clarify TriggerChannelCount and TRIG type #1342

Merged
merged 2 commits into from
Nov 3, 2022
Merged

[FIX] clarify TriggerChannelCount and TRIG type #1342

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de9d0ed
[FIX] clarify TriggerChannelCount and TRIG type
sappelhoff Oct 25, 2022
eaa0dfb
address feedback: analog and digital ttl
sappelhoff Oct 25, 2022
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
68 changes: 30 additions & 38 deletions src/04-modality-specific-files/02-magnetoencephalography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,47 +226,39 @@ and a guide for using macros can be found at
-->
{{ MACROS___make_columns_table("meg.MEGChannels") }}

Example:

```Text
name type units description sampling_frequency low_cutoff high_cutoff notch software_filters status
UDIO001 TRIG V analogue trigger 1200 0.1 300 0 n/a good
MLC11 MEGGRADAXIAL T sensor 1st-order grad 1200 0 n/a 50 SSS bad
```
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this example, because a channels.tsv example is already present below the channel types table


Restricted keyword list for field `type`.
Note that upper-case is REQUIRED:

| **Keyword** | **Description** |
| ---------------- | ---------------------------------------------------- |
| MEGMAG | MEG magnetometer |
| MEGGRADAXIAL | MEG axial gradiometer |
| MEGGRADPLANAR | MEG planargradiometer |
| MEGREFMAG | MEG reference magnetometer |
| MEGREFGRADAXIAL | MEG reference axial gradiometer |
| MEGREFGRADPLANAR | MEG reference planar gradiometer |
| MEGOTHER | Any other type of MEG sensor |
| EEG | Electrode channel |
| ECOG | Electrode channel |
| SEEG | Electrode channel |
| DBS | Electrode channel |
| VEOG | Vertical EOG (electrooculogram) |
| HEOG | Horizontal EOG |
| EOG | Generic EOG channel |
| ECG | ElectroCardioGram (heart) |
| EMG | ElectroMyoGram (muscle) |
| TRIG | System Triggers |
| AUDIO | Audio signal |
| PD | Photodiode |
| EYEGAZE | Eye Tracker gaze |
| PUPIL | Eye Tracker pupil diameter |
| MISC | Miscellaneous |
| SYSCLOCK | System time showing elapsed time since trial started |
| ADC | Analog to Digital input |
| DAC | Digital to Analog output |
| HLU | Measured position of head and head coils |
| FITERR | Fit error signal from each head localization coil |
| OTHER | Any other type of channel |
| **Keyword** | **Description** |
| ---------------- | ----------------------------------------------------------- |
| MEGMAG | MEG magnetometer |
| MEGGRADAXIAL | MEG axial gradiometer |
| MEGGRADPLANAR | MEG planargradiometer |
| MEGREFMAG | MEG reference magnetometer |
| MEGREFGRADAXIAL | MEG reference axial gradiometer |
| MEGREFGRADPLANAR | MEG reference planar gradiometer |
| MEGOTHER | Any other type of MEG sensor |
| EEG | Electrode channel |
| ECOG | Electrode channel |
| SEEG | Electrode channel |
| DBS | Electrode channel |
| VEOG | Vertical EOG (electrooculogram) |
| HEOG | Horizontal EOG |
| EOG | Generic EOG channel |
| ECG | ElectroCardioGram (heart) |
| EMG | ElectroMyoGram (muscle) |
| TRIG | Analog (in volt) or digital (TTL bit level) trigger channel |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The "TTL" convention applies to both the analog representation as the binary interpretation. Even in memory of a computer a bit is still represented as a voltage.

I suggest to write "Analog (TTL in Volt) or digital (binary TTL) trigger channel".

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, and I would not write "bit level", as that suggests that every bit is to be represented in a separate channel. Some systems do that (like Neuromag, only for backward compatibility), but it is not so common. Most represent the bits jointly in a single numeric value.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! implemented in eaa0dfb

| AUDIO | Audio signal |
| PD | Photodiode |
| EYEGAZE | Eye Tracker gaze |
| PUPIL | Eye Tracker pupil diameter |
| MISC | Miscellaneous |
| SYSCLOCK | System time showing elapsed time since trial started |
| ADC | Analog to Digital input |
| DAC | Digital to Analog output |
| HLU | Measured position of head and head coils |
| FITERR | Fit error signal from each head localization coil |
| OTHER | Any other type of channel |

Examples of free text for field `description`:

Expand Down
2 changes: 1 addition & 1 deletion src/04-modality-specific-files/03-electroencephalography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ Note that upper-case is REQUIRED:
| RESP | Respiration |
| SYSCLOCK | System time showing elapsed time since trial started |
| TEMP | Temperature |
| TRIG | System triggers |
| TRIG | Analog (in volt) or digital (TTL bit level) trigger channel |
| VEOG | Vertical EOG (eye) |

Examples of free-form text for field `description`
Expand Down
2 changes: 1 addition & 1 deletion src/04-modality-specific-files/04-intracranial-electroencephalography.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ Note that upper-case is REQUIRED:
| EOG | Generic EOG channel if HEOG or VEOG information not available |
| ECG | ElectroCardioGram (heart) |
| EMG | ElectroMyoGram (muscle) |
| TRIG | System Triggers |
| TRIG | Analog (in volt) or digital (TTL bit level) trigger channel |
| AUDIO | Audio signal |
| PD | Photodiode |
| EYEGAZE | Eye Tracker gaze |
Expand Down
5 changes: 4 additions & 1 deletion src/schema/objects/metadata.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3241,7 +3241,10 @@ TriggerChannelCount:
name: TriggerChannelCount
display_name: Trigger Channel Count
description: |
Number of channels for digital (TTL bit level) triggers.
Number of channels for digital (TTL bit level) triggers or
analog equivalents that could unambiguously be converted to
a digital format (step function-like voltage differences).
Corresponds to the `TRIG` channel type.
type: integer
minimum: 0
TubingLength:
Expand Down