Closed sstucker closed 3 years ago
As @sstucker indicates, BIDS-fNIRS defines a restricted keyword list for channel types that include some commonly used auxiliary channels. It will be beneficial to adopt these same keywords in SNIRF for the aux(j)/name field. Our keyword (or Tag Name as we call it in the SNIRF spec) list is not complete and thus not required, but it would be recommended to use the keyword if it represents the given aux channel so that software packages and users may then automatically know what to do with the given aux channel.
Here are the aux keywords defined in BIDS-fNIRS
ACCEL | Accelerometer channel, one channel for each orientation. I assume this means ACCEL_X, ACCEL_Y, ACCEL_Z, but I need to check with Rob Luke.
GYRO | Gyrometer channel, one channel for each orientation.
MAGN | Magnetomenter channel, one channel for each orientation.
@sstucker, do you want to create a PR? I can tag this to V1 milestone if it is straightforward.
would be recommended to use the keyword if it represents the given aux channel so that software packages and users may then automatically know what to do with the given aux channel.
+1 from me. Has anyone started work on this? If so, let me know (assign yourself?). If not, I can take a crack in the coming week.
@rob-luke , go ahead and take a crack at this. Thanks
I started looking at this and hit some questions.
How should we define multiple axes for sensors like those defined by BIDS? Like so:
### Supported `/nirs(i)/aux(j)/name` values
| Tag Name | Meanings |
|-----------|------------------------------------------------------------------|
|"ACCEL_X" | Accelerometer data, first axis of orientation |
|"ACCEL_Y" | Accelerometer data, second axis of orientation |
|"ACCEL_Z" | Accelerometer data, third axis of orientation |
|"GYRO_X" | Gyrometer data, first axis of orientation |
|"GYRO_Y" | Gyrometer data, second axis of orientation |
|"GYRO_Z" | Gyrometer data, third axis of orientation |
|"MAGN_X" | Magnetometer data, first axis of orientation |
|"MAGN_Y" | Magnetometer data, second axis of orientation |
|"MAGN_Z" | Magnetometer data, third axis of orientation |
Is this clunky?
I imagine there are some other standard aux data to include in the table? Perhaps for electrophysiology signals?
I am not aware of any other easy way to define it. One could define it relative to the axial, sagittal, and coronal axes of the head, but that will require more knowledge about operation of the sensors than most users will have.
So, I am fine with the definition you suggest.
From: stephen scott tucker @.> Date: Thursday, September 2, 2021 at 10:28 AM To: fNIRS/snirf @.> Cc: Boas, David @.>, Comment @.> Subject: Re: [fNIRS/snirf] Standardized aux channel names (#55)
I started looking at this and hit some questions.
How should we define multiple axes for sensors like those defined by BIDS? Like so:
/nirs(i)/aux(j)/name
values| Tag Name | Meanings |
|-----------|------------------------------------------------------------------|
|"ACCEL_X" | Accelerometer data, first axis of orientation |
|"ACCEL_Y" | Accelerometer data, second axis of orientation |
|"ACCEL_Z" | Accelerometer data, third axis of orientation |
|"GYRO_X" | Gyrometer data, first axis of orientation |
|"GYRO_Y" | Gyrometer data, second axis of orientation |
|"GYRO_Z" | Gyrometer data, third axis of orientation |
|"MAGN_X" | Magnetometer data, first axis of orientation |
|"MAGN_Y" | Magnetometer data, second axis of orientation |
|"MAGN_Z" | Magnetometer data, third axis of orientation |
Is this clunky?
I imagine there are some other standard aux data to include in the table? Perhaps for electrophysiology signals?
— You are receiving this because you commented. Reply to this email directly, view it on GitHubhttps://github.com/fNIRS/snirf/issues/55#issuecomment-911746840, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AHFCP5E7L5ULMXHQIYRAXETT76CYDANCNFSM5AYT3RVA. Triage notifications on the go with GitHub Mobile for iOShttps://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Androidhttps://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.
It would be good to have a standardized list of aux channel identifiers in the appendix. Other formats like BIDS have these and it would be nice to have defined conversion.