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:30:24 -07:00
parent 68d726d239
commit 46fd46de5e
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
@@ -68,21 +68,21 @@ Identifies the heart rate of the participant. Heart rate in fNIRS is considered
- ⚠️SMOOTHING_WINDOW_HR (int, default=100): Number of unique datapoints to be averaged into a single data point to create a smoother heart rate.
- HEART_RATE_WINDOW (int, default=25): Purely for visualization. Will create an estimation window ± this value for the BPM calculation.
Note: If HEART_RATE is set to false, SECONDS_TO_STRIP_HR, ⚠️HR_LOW_FREQ, ⚠️HR_HIGH_FREQ, ⚠️HR_SEARCH_MIN, ⚠️HR_SEARCH_MAX, MAX_LOW_HR, MAX_HIGH_HR, SMOOTHING_WINDOW_HR, HEART_RATE_WINDOW, & SCI_USE_HEAR_RATE_BAND will be ignored.
Note: If HEART_RATE is set to False, SECONDS_TO_STRIP_HR, ⚠️HR_LOW_FREQ, ⚠️HR_HIGH_FREQ, ⚠️HR_SEARCH_MIN, ⚠️HR_SEARCH_MAX, MAX_LOW_HR, MAX_HIGH_HR, SMOOTHING_WINDOW_HR, HEART_RATE_WINDOW, & SCI_USE_HEART_RATE_BAND will be ignored.
## Scalp Coupling Index
Calculates the scalp coupling index of the participant over multiple time windows, and will report a pass or fail for each channel and time window based on a user defined threshold. The scalp coupling index is an important quality metric that calculates the quality of the connection between the participants scalp and the fNIRS cap. This process is documented better here at <this link>. The time windows start at time 0, and if the end of the file is not a complete window, the SCI is simply calculated over the remaining time. If the entire channel averaged across all windows do not meet the threshold value, then the channel will be marked as a bad channel.
**Parameters:**
- SCI (bool, default=True): True if SCI should be calculated, False if SCI should not be calculated.
- SCI_USE_HEAR_RATE_BAND (bool, default=True): TBD.
- SCI_USE_HEART_RATE_BAND (bool, default=True): TBD.
- ⚠️SCI_LOW_FREQ (float, default=0.7): TBD.
- ⚠️SCI_HIGH_FREQ (float, default=1.5): TBD.
- SCI_TIME_WINDOW (int, default=3): Value in seconds to evaluate the signal over repeatedly.
- SCI_THRESHOLD (float, default=0.6): Value between 0-1 where 1 is perfect coupling and 0 is poor coupling. A good threshold value would be at least over 0.5.
Note: If SCI is set to False, SCI_USE_HEAR_RATE_BAND, SCI_TIME_WINDOW, & SCI_THRESHOLD will be ignored.
Note: If SCI_USE_HEAR_RATE_BAND is set to False, ⚠️SCI_LOW_FREQ & ⚠️SCI_HIGH_FREQ will be ignored.
Note: If SCI_USE_HEART_RATE_BAND is set to False, ⚠️SCI_LOW_FREQ & ⚠️SCI_HIGH_FREQ will be ignored.
## Signal to Noise Ratio
Calculates the signal to noise ratio, and will report a pass or fail for each channel based on a user defined threshold. The signal to noise ratio is an important quality metric that calculates how much of the observed signal was noise versus how much of it was a useful signal. This process is documented better here at <this link>. There is no concrete value at which there is minimal noise, with different individuals reporting varying thresholding values. If the entire channel does not meet the threshold value, then the channel will be marked as a bad channel.