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

Update Home

tyler
2026-01-05 11:26:44 -08:00
parent bc349d8545
commit 963d6119c9
1 changed files with 30 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
Home.md

@@ -21,7 +21,7 @@ Once FLARES opens, you will be greeted with many options on the screen. To remai
These names will be reused throughout the Wiki to refer to content in these physical locations.
# Navigation Bar #
The navigation bar stores most of the actions that you will want to use. There are 5 buttons availabe to the user and most of them have submenus. Here is a high level overview of the buttons and what they do:
The navigation bar stores most of the actions that you will want to use. There are 5 buttons availabe and all of them have submenus. Here is a high level overview of the buttons and what they do:
- File
- Open File... - Opens a singular file into the application
- Open Folder... - Opens all files in a singular folder into the application
@@ -30,15 +30,38 @@ The navigation bar stores most of the actions that you will want to use. There a
- Save Project As... - Same as above, but asks for the destination to save the project every time
- Exit - Exits the application
- Edit
- Cut - Copies the highlighted text
- Cut - Cuts the highlighted text
- Copy - Copies the highlighted text
- Paste - Pastes text from the clipboard
- View
- Toggle Status Bar - Turns on or off visibility of text notifications at the bottom of the application
- Options
- User Guide -
- Check for updates... - Checks the Gt repository for any available updates. If an update is found, it is downloaded and extracted automatically
- Update optodes in snirf file... -
- Update events in snirf file... -
- User Guide - Opens a pop-up window containing some information about processing stages
- Check for updates... - Checks the Git repository for any available updates. If an update is found, it is downloaded and extracted automatically
- Update optodes in snirf file... - See Updating Optodes in SNIRF File
- Update events in snirf file... - See Updating Events in SNIRF File
- Terminal
- New Terminal... - Opens a text based terminal
- New Terminal... - Opens a text based terminal
# File Information #
This area is designated to providing information about a singular file. Once a file has been opened and selected from the Loaded files area, generic information will be visible. This includes:
- File name
- File size
- Creation date
- Modifies date
- Full file path
On top of this generic information, there is also some data that is unique to SNIRF files:
- Measurement date
- Short channels (this is a guess based on distance)
- Source-Detector distances
- Digitization points
- Annotations
This information panel is purely for validation purposes, and it is not possible to change any of the values from this area. There is three parameters that do get added when a file is selected that can be changed. None of these values need to be set for the analysis to function. These parameters are:
- Age - Needed to calculate the DPF of the participant. If Age is not specified, the value will be set to 25
- Gender - Used as a filter option to filter results at the end of the analysis. Not currently implemented.
- Group - Used as a filter option to filter results at the end of the analysis.. If Group is not specified, the value will be set to "Default"
# Loaded files #
When files are loaded either from opening a singular file or opening a whole folder, all valid files will be shown in this area, along with a progress bar. Clicking on a file will bring up its information in the File Information area and allow for changes to the participants Age, Gender, and Group. When the analysis is running, the progress bar will update based on how far the participant has been processed. Right clicking the file will bring up two buttons:
- Reveal - Opens a file browser to the location that this file is stored on disk
- Remove - Unloads and removes the file, preventing it from being processed. This does not modify the file on disk. If the participant is removes after an analysis, their data will be still included in the analysis. To get data without this file, the analysis will have to be run again