Tools/EStiMo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Adam Ryszczuk 2023-06-14 12:45:25 +00:00
parent ac20180d47
commit 830238fa4c
1 changed files with 21 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -27,22 +27,23 @@ The software provides a number of available features, and the user is able to ad
### TMS_Protocol.txt structure ### TMS_Protocol.txt structure
This file includes several settings that can be changed by adjusting the value that follows the colon. The settings you can change are: This file includes several settings that can be changed by adjusting the value that follows the colon. The settings you can change are:
```
time_between_trains: This is the time between consecutive trains, measured in seconds. - time_between_trains: This is the time between consecutive trains, measured in seconds.
cut_time: This is the time segment of the signal between consecutive trains that is ignored. The signal is cut from both sides by half of the given value. This value should be set in seconds. - cut_time: This is the time segment of the signal between consecutive trains that is ignored. The signal is cut from both sides by half of the given value. This value should be set in seconds.
number_of_channels: This is the number of used channels, excluding the channels that represent the trigger indicator. - number_of_channels: This is the number of used channels, excluding the channels that represent the trigger indicator.
number_of_lines: This is the number of measurements from past segments that are presented during the readout phase. - number_of_lines: This is the number of measurements from past segments that are presented during the readout phase.
eog_channel: This is the index of the EOG channel. It can be set as an index from the end by using the minus sign (please note that the last channel, or -1, is always reserved for the trigger indicator). - eog_channel: This is the index of the EOG channel. It can be set as an index from the end by using the minus sign (please note that the last channel, or -1, is always reserved for the trigger indicator).
emg_channel: This is the index of the EMG channel. It can be set as an index from the end by using the minus sign (again, note that the last channel, or -1, is always reserved for the trigger indicator). - emg_channel: This is the index of the EMG channel. It can be set as an index from the end by using the minus sign (again, note that the last channel, or -1, is always reserved for the trigger indicator).
included_channels: These are the indexes of channels that are used to calculate features, from 0 (which is the first channel) to N (N represents the number of EEG channels). EOG, EMG, and trigger indicator channels are not included. Indexes correspond to the order of channels streamed from the EEG system. This should be filled as a list of integers. - included_channels: These are the indexes of channels that are used to calculate features, from 0 (which is the first channel) to N (N represents the number of EEG channels). EOG, EMG, and trigger indicator channels are not included. Indexes correspond to the order of channels streamed from the EEG system. This should be filled as a list of integers.
names: These are the names of the channels that are streamed. This should be filled as a list of integers or strings. - names: These are the names of the channels that are streamed. This should be filled as a list of integers or strings.
alpha_range: This is the range of the alpha band in Hz. It should be filled as a list of integers (for example, [5, 16]). - alpha_range: This is the range of the alpha band in Hz. It should be filled as a list of integers (for example, [5, 16]).
beta_range: This is the range of the beta band in Hz. It should be filled as a list of integers (for example, [16,30]). - beta_range: This is the range of the beta band in Hz. It should be filled as a list of integers (for example, [16,30]).
theta_range: This is the range of the theta band in Hz. It should be filled as a list of integers (for example, [4,8]). - theta_range: This is the range of the theta band in Hz. It should be filled as a list of integers (for example, [4,8]).
expected_triggers: This is the number of triggers within a single train. - expected_triggers: This is the number of triggers within a single train.
expected_time: This is the time of the single train, measured in milliseconds. - expected_time: This is the time of the single train, measured in milliseconds.
```
✅ Example:
> ✅ **Example**:
``` ```
time_between_trains: 8 time_between_trains: 8
cut_time: 1 cut_time: 1
@ -63,11 +64,11 @@ plot_len: 4
### Structure of the Electrode_selection.txt ### Structure of the Electrode_selection.txt
You can set paths for the files that contain spatial information in this file. The following are the available settings: You can set paths for the files that contain spatial information in this file. The following are the available settings:
``` - full_cap_file_path: This is the path to the file showing the spatial location for the full cap.
full_cap_file_path: This is the path to the file showing the spatial location for the full cap. - cap_file_path: This is the path to the file showing the spatial location only for the streamed channels.
cap_file_path: This is the path to the file showing the spatial location only for the streamed channels.
```
The requirement for both files is purely based on practical reasons to make potential edits to the protocol easier. It's designed for users who only want to use a select number of channels from a larger EEG cap montage. The requirement for both files is purely based on practical reasons to make potential edits to the protocol easier. It's designed for users who only want to use a select number of channels from a larger EEG cap montage.
> :warning: **Please note**: If you're using the entire cap, set both settings to the same path. If you don't have access to any of these files, use one of them for both options. However, this might require manual adjustment in the program settings. > :warning: **Please note**: If you're using the entire cap, set both settings to the same path. If you don't have access to any of these files, use one of them for both options. However, this might require manual adjustment in the program settings.
### Spatial Locations file structure ### Spatial Locations file structure