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

Update Home

tyler
2026-07-13 13:33:20 -07:00
parent 2cda42f018
commit 8c97d94b7d
1 changed files with 24 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Home.md
+24 -21
@@ -11,14 +11,14 @@ In order to use FLARES, you will need a device with the following hardware speci
Download the appropriate version from the [Releases](https://git.research.dezeeuw.ca/tyler/flares/releases) tab and extract the zip file once it has completed downloading. Once the folder has been extracted, run the "flares" executable. The first launch of FLARES will take some time, so please be patient. FLARES will automatically check and download available updates every time the application starts. If you do not want FLARES to perform this action, you can block the app in your devices firewall or set your internet options to be a metered connection. FLARES does not currently run on ARM powered Windows devices.
# Getting used to FLARES #
Once FLARES opens, you will be greeted with many options on the screen. To remain simple this guide will break down what is visible on the screen into four distinct sections:
Once FLARES opens, you will be greeted with a welcome popup that will contain all of the new features in your version of FLARES. Once this popup has been dismissed, you will encounter many options visible on the screen. To remain simple, this guide will break down what is visible on the screen into four distinct sections:
- Navigation Bar (Top of screen)
- File Information (Top left area)
- Loaded Files (Bottom left area)
- Parameters (Right area)
These names will be reused throughout the Wiki to refer to content in these physical locations.
These names will be reused throughout the Wiki to refer to content present in these physical locations.
## Navigation Bar ##
The navigation bar stores most of the actions that you will want to use. There are 6 buttons available and all of them have submenus. Here is a high level overview of the buttons and what they do:
@@ -48,34 +48,37 @@ The navigation bar stores most of the actions that you will want to use. There a
- Reset to Default Configuration - Resets all saved Preferences, Window Layout, and Recent Files / Projects back to their original values
- About - Pops out information about the application in a new window
- Preferences
- 2D Data Bypass
- Incompatible Save Bypass
- Missing Events Bypass
- Analysis Clearing Bypass
- Folding Bypass
- 2D Data Bypass - TBD
- Incompatible Save Bypass - TBD
- Missing Events Bypass - TBD
- Analysis Clearing Bypass - TBD
- Folding Bypass - TBD
- Terminal
- New Terminal... - Opens a text based terminal to interact with the software using commands
## 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
This area is designated to providing information about a singular file. For information to be visible here, a file has to be loaded using File > Open File or File > Open Folder. Once a file has been opened and finishes initial processing, it will be visible in the Loaded files area. Selecting this file with a left click will cause generic information to be visible in the File Information area. This includes:
- File name - Name of the loaded file
- File size - Size of the file in bytes
- Creation date - Date the file was created
- Modified date - Date the file was last modified
- Full file path - Full path of the file that was loaded
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
- Annotations - Onset time, Duration, and Description of an event that occured in the file
- Digitization Points - Kind, ID, and Coordinates (Location) of optodes
- Measurement Date - Date that the data was written into the snirf
- Short Channels - Likely if short channel exists, Unlikely if a short channel does not exist. This is an educated guess based on distance, and may not be accurate
- Source-Detector Distances - Distances of channels in metres
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 - Used 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.
This information panel is purely for validation purposes and it is not possible to change any of the values from this area since this is data from inside the file that was made when the file was created. There are three parameters that do get added to the File Information area once a file has been selected that can be changed. None of these additional parameters need to be set for the analysis to function. These parameters are:
- Age - Used to calculate the DPF of the participant. If Age is not specified, the value will be set to 25 automatically
- Gender - Used as a filter option to filter results at the end of the analysis. This is not currently implemented and will have no effect
- 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"
A "Why are these useful?" button can be found below this area and when clicked will restate this information in a popup window.
## 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