tyler/flares
2
0
Fork 0
Code Issues 24 Pull Requests Actions Packages Projects Releases 25 Wiki Activity

Update Understanding Parameters

tyler
2026-08-19 13:23:02 -07:00
parent 0e809c5b6e
commit 68d726d239
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Understanding-Parameters.md
+3 -3
@@ -45,12 +45,12 @@ Note: If OPTODE_PLACEMENT is set to False, SHOW_OPTODE_NAMES will be ignored.
Identifies both short and long channels. A channel is the inter-optode distance between a source (transmitter) and detector (receiver) optode. Different fNIRS caps will vary in spatial resolution, and as such the requirements for what constitutes a short or long channel will vary depending on the hardware design and/or user preference. If your design has a short channel included, you will need to use this method. If a channel is longer than the allowable distance, it will be removed entirely. If a short channel is requested but no channels are found below the set threshold, the processing of the participant will fail.
**Parameters:**
- SHORT_CHANNELS (bool, deafult=True): True if the data has at least one short channel, False if the data does not have at least one short channel.
- ⚠️LONG_CHANNELS (bool, deafult=True): True if channels exceeding LONG_CHANNELS_THRESH should be removed, False if the channels exceeding LONG_CHANNELS_THRESH should not be removed.
- SHORT_CHANNELS (bool, default=True): True if the data has at least one short channel, False if the data does not have at least one short channel.
- ⚠️LONG_CHANNELS (bool, default=True): True if channels exceeding LONG_CHANNELS_THRESH should be removed, False if the channels exceeding LONG_CHANNELS_THRESH should not be removed.
- SHORT_CHANNELS_THRESH (float, default=0.015): Maximum distance that short channels can be in metres.
- LONG_CHANNELS_THRESH (float, default=0.045): Maximum distance that long channels can be in metres.
Note: If SHORT_CHANNEL is set to False, SHORT_CHANNEL_THRESH & SHORT_CHANNEL_REGRESSION will be ignored.
Note: If SHORT_CHANNELS is set to False, SHORT_CHANNELS_THRESH & SHORT_CHANNEL_REGRESSION will be ignored.
Note: If ⚠️LONG_CHANNELS is set to False, LONG_CHANNELS_THRESH will be ignored.
## Heart Rate