Add validation of Neuropixels calibration files #291
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonnew
requested changes
Sep 6, 2024
jonnew
reviewed
Sep 6, 2024
jonnew
requested changes
Sep 10, 2024
- Refactored code (moved to helper class) and made names consistent - Added TryParse methods for NeuropixelsV2e and NeuropixelsV1e calibration files - Refactored code to return a nullable type instead of following the conventional TryParse pattern - Added dialog elements that displays the current gain correction value from the gain calibration file - Added V2 gain correction class for easier passing of correction and SN - Display the serial number after parsing calibration files - Add a button to open a new window for the ADC values in NeuropixelsV1eDialog - Small update to size of controls and panels - Added status strip for Neuropixels V1e - Make code more concise, utilizing reactive patterns - Add try-catch when reading from file for very specific exceptions - Rename variables to use full names instead of abbreviations
- IsExternalInit is now placed is its own file, since it only needs to be defined once in a namespace for records to work
- Starting folder when browsing for calibration files is set to the previous location if it exists - File IO and access exceptions presented as MessageBoxs with error styling
jonnew
approved these changes
Sep 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this PR, the calibration files for
NeuropixelsV1e,NeuropixelsV2e, andNeuropixelsV2eBetaare now validated using a customTryParsemethod. This applies to the ADC / gain calibration files forNeuropixelsV1e, and the gain calibration file forNeuropixelsV2e/NeuropixelsV2eBeta.The
TryParsemethod will validate that the file exists and can be opened, that there are the correct number of elements, and that each element is able to be parsed into the correct type. For example, the first line in each file should contain a single element, and it should beulongfor the serial number. Other elements include the channel number, gain correction value at different gain levels, or ADC values.Fixes #228
Related to #283, existing public methods for
NeuropixelsV1ehave been marked as obsolete, since they took aStreamReaderas an argument instead of the filepath. These methods are not removed or modified, since doing so would be a major revision.In addition to creating the
TryParsemethod, this PR also takes advantage of these new methods by adding the correction values back into the various dialogs so that the user can view the ADC values and gain corrections that will be applied to the data based on the current gains selected. These are added at all dialog levels, so that anytime a file is selected, the gain will be updated in a textbox. For ADC values, instead of being in a tab like they were previously, they are now opened in a new window when a button is pressed. This window is modal, so the rest of the GUI is nonfunctional until the ADC window is closed.Fixes #232
While adding control elements, including a status bar to display the serial number, there were some small quality-of-life changes made to control sizes.