Link: github.com/tennesseeBonner1/PiBlink

As of 6/10/2020, the project is comprised of the files listed below.
The general categories of files are:

• Main Files
• Reference Files
• UI & UI Manager Files
• Session Files

These files (along with the ones listed in "Reference Files") are responsible for the primary functionality of the program: Reading in data to session files and opening session files for viewing.

• main.py: File responsible for starting the program. Also contains the catch-all error handler for clean up.

• DataAnalysis.py: This file contains funtions that are used by the JSON Converter in order to make stat calculations. These include calculations for the eyeblinks as well as all the calculations needed for it.

• DataWizard.py: Handles all of the analog input and outputs.

• GraphExporter.py: Exports a screenshot of the graph as an image file.

• InputManager.py: Controls the majority of the main window's interactivity. Handles user input regarding any of the 3 main buttons at the top and any menu bar items. Once the settings for the session are set, the program will mostly operate through TheGraph.py.

• JSONConverter.py: Used to save sessions as JSON files and open them back up for playback. TheGraph.py uses this file to save/read trials and InputManager.py uses this file to save/read session settings and start/end the save/read process for the whole session. This file is also responsible for saving/loading parameter files.

• MainWindow.py: All of the settings for the main window are initialized and all of the various text elements are modified and updated in this file.

• NoiseWizard.py: Used instead of DataWizard to generate a set of random data to test the program without the use of the data read from the ADC and DAC converter.

• ParameterValidator.py: Used to determine whether the parameters currently in the GUI panel are valid. When the user attempts to lock the settings, InputManager.py calls the verifySettingsValid function in this file which uses the rest of the functions in this file to check validity, prompt the user of any problems, and return the answer to the caller.

• SuperNoiseWizard.py: Same thing as NoiseWizard.py except it attempts to emulate real eye blinks instead of generate random noise. This is useful when trying to debug analysis functionalities.

• TheGraph.py: This file controls all of the visuals for both the trial graph and real-time voltage bar graph and displays the information as it updates. It is the place in the main process where samples are received from the sampling process.

• TheSession.py: Contains TheSession class which is used to encapsulate session information. Various instances of this class are made throughout the program for different purposes. The most common instance is the singleton "currentSession", used to represent the currently running data acquisition session or loaded playback session (if applicable). This singleton is stored at the top of this file as a global variable. This file contains the constructors/functions for reading from/writing to both the GUI parameter panel and JSON files. Both saved session files and parameter files use this class.

• TimeCriticalOperations.py: The file that has all the code for managing/running the sampling/time-critical process. This process controls the timing of data acquisition trials. So it runs both trials and ITIs. This does not include the act of retrieving the sample, that is done in DataWizard.py. Also responsible for sending samples at all times to the main process, regardless of if a trial is running, to update the real-time voltage bar.

These files are listed separately from the main files as they come directly from an external library and are much less interconnected to the previous set of files, having been created for a broad range of implementations. Still, they are crucial to the program, as these files are directly responsible for the A/D and D/A conversion.

• DAC8552_default_config.py: Part of the default files included for the DAC conversion (needed to output the signals for the CS and US).

• dac8552.py: Part of the default files included for the DAC conversion (needed to output the signals for the US and UCS).

These files are responsible for the look and function of all windows in the program (save the functionality of the main window, which InputManager.py handles). The UI files (exampleUI.ui) are created in Qt Designer and then converted to their python equivalents (exampleWindow.py) using PyQt's "pyuic" command. They define the look of the program. There are also image files for the buttons used in GUIs that are included in the project but not listed.

The manager files (exampleManager.py) are responsible for the function of their respective UI files. They handle the opening of the GUI window itself and define the functionality within it.

• AnalysisSettingsUI.ui & AnalysisSettingsWindow.py: GUI window for displaying/editing the parameters for re-analyzing a session.

• AnalysisSettingsManager.py: Manages the re-analysis feature of the program including the re-analysis window.

• DisplaySettingsUI.ui & DisplaySettingsWindow.py: All the settings for the display settings window are initialized and all of the various text elements of this window are modified and updated.

• DisplaySettingsManager.py: Sets up all the display settings and parses the display settings text file to set them.

• Display Settings.txt: This is read to set the settings for the graph. This file is edited by the display settings window. The file is currently regenerated on save.

• MainUI.ui & MainWindow.py: Main GUI window for the program.

• MatrixParametersUI.ui & MatrixParametersWindow.py: GUI window for displaying/editing the parameters for the matrix view.

• MatrixViewUI.ui & MatrixViewWindow.py: GUI window for displaying the actual matrix.

• MatrixManager.py: Manages everything to do with the matrix view of trials. This includes the parameters window, view window, and the process of acquiring the images that occurs in between the two windows.

These files hold session information (i.e. trial data, session settings, etc). The JSON files are The session files, as all other files in this category are a subset of and/or are generated from a JSON file. They hold all session information.

• Saved Session Files: These files save the entirety of a single session as one JSON file. If the user tries to save a session with the same name as an already saved session, a numbering scheme will ensure the new session is given a new name and the old one is not overwritten.

• Parameter Files: These files save whatever is in the GUI parameter panel for later use. They are JSON files identical to saved session files except the trial data list is blank. These files are not required to reopen saved sessions. They are provided as a mere option for convenience.

• Capture & Matrix View Files These are simple PNG or JPG/JPEG files of the item in question.