- Go to the fp_analysis folder on OneDrive. Contact Yue if you can't access it.
- Download fp_analysis_app_vx.zip (the "x" in the suffix "vx" denotes the current version). Note that if you unzip it to the same location where the zip file is, you may end up with a nested folder, ie., a "fp_analysis_app_vx" inside a "fp_analysis_app_vx". If this is the case , it may be better to peel it and move the inner "fp_analysis_app_vx" somewhere else and delete the outer "fp_analysis_app_vx".
- Examine the content of the unzipped "fp_analysis_app_vx". It should contain three folders and an .exe file: 1) _internal, 2) fp_analysis_app, and 3) run_fp_analysis_app.exe.
- NEW!!! after you download and unzip, you MUST open PowerShell and run the following command
cd PATH_TO_YOUR_APP_FOLDER
Get-ChildItem -Recurse | Unblock-FileThe first line navigates to the unzipped app folder. You need to supply the actual path to the app folder on your computer. The second line unblocks the dependencies related to webview, which provides the window to the app interface, as Windows blocks them when the zip file is downloaded from OneDrive. Without unblocking it, you may not be able to run the app.
To open the app, double click "run_fp_analysis_app.exe" and it will open the app's home page in a tab in your web browser. You don't need internet connection to run the app. The app only uses the web browser as the interface.
Click "Click here to select File". After you select a file, the app will briefly validate the file selected and then show you the figures of the signals. Once the figures are shown, you can navigate and zoom in or out on the figures.
Zooming is done by scrolling your mouse around the center of interest. Navigation can be done using the left/right arrow key or just dragging the figure. To zoom or navigate along X-Axis only, move your cursor to the last figure and then operate. To zoom in or navigate along Y-Axis only, move your cursor to the left edge of the figure of interest and operate.
After annotations are loaded, go to the analysis page, choose the signal(s) and analysis windows, and click Show Results. When the analysis results are generated, the app also writes the analysis spreadsheets automatically.
The app first tries to save the spreadsheets next to the selected .mat file. If that location is not writable, it saves them to the app spreadsheet folder under fp_analysis_app/assets/spreadsheets/.
Spreadsheet exports are grouped into a setup-specific subfolder based on:
- the selected signal or signal pair
- the baseline window size
- the analysis window size
For the same analysis setup, different subjects append into the same workbook set. If the same subject is exported again with the same setup, that subject's columns are updated instead of duplicated. Each export folder also includes a data_description.txt file that records the analyzed data source and setup details.
- When adding a second or removing a second signal, clicking Show Results may not update the results even when the analyses are done (indicated by the Show Results button becomes available again), when this happens, switch to any other tab. That should help update the results. Fix to this issue is in progress.
The input files to the app must be .mat (matlab) files preprocessed using sleep_data_preprocessing_app (although called sleep data, it also works with fp data), and contain the following fields.
| Field Name | Data Type |
|---|---|
| fp_signal_names | N x 1 string |
| fp_frequency | float |
| signal_A | 1 x N single |
| ... | 1 x N single |
Explanations
- signal_A is just an example name for a fp signal. You can name it by its real signal name such as NE, but it must be listed as a name in fp_signal_names, in order to be visualized by the app.