Update behavior while automatically searching for calibration files

- Updated tooltips and error messages
- Only update the info string once per toggle
- If the automated search checkbox is checked, gray out the individual calibration file buttons
- Only search for calibration files when the device is enabled and any other trigger is hit
- Updated for both Neuropixels 1.0 and 2.0 probes

Author: bparks13

Source/UI/NeuropixelsV1Interface.cpp

@@ -80,7 +80,7 @@ NeuropixelsV1Interface::NeuropixelsV1Interface(std::shared_ptr<Neuropixels1> d,
 		searchForCalibrationFilesButton = std::make_unique<ToggleButton>("Search for calibration files automatically");
 		searchForCalibrationFilesButton->setBounds(infoLabel->getX() + 2, infoLabel->getBottom() + 5, 350, 20);
 		searchForCalibrationFilesButton->addListener(this);
-		searchForCalibrationFilesButton->setTooltip("Open a dialog to choose the folder where calibration files exist. This can be a top-level folder which is recursively searched for a matching serial number.");
+		searchForCalibrationFilesButton->setTooltip("Open a file dialog to choose a folder that contains all calibration files. The calibration file(s) that matches your probe will automatically be selected if it exists in this folder.");
 		addAndMakeVisible(searchForCalibrationFilesButton.get());
 
 		calibrationFolderLabel = std::make_unique<Label>("calibrationFolderLabel", "Calibration Folder");
@@ -99,13 +99,11 @@ NeuropixelsV1Interface::NeuropixelsV1Interface(std::shared_ptr<Neuropixels1> d,
 		calibrationFolderButton->setBounds(calibrationFolder->getRight() + 3, calibrationFolder->getY(), 26, calibrationFolder->getHeight() + 2);
 		calibrationFolderButton->setRadius(1.0f);
 		calibrationFolderButton->addListener(this);
-		calibrationFolderButton->setTooltip("Open a file dialog to choose the gain calibration folder path to automatically search for probe calibration files.");
+		calibrationFolderButton->setTooltip("Open a file dialog to choose the calibration folder path to automatically search for probe calibration files.");
 		addAndMakeVisible(calibrationFolderButton.get());
 
 		calibrationFolderChooser = std::make_unique<FileChooser>("Select Gain Calibration Folder.", File());
 
-		setCalibrationFolderEnabledState(false);
-
 		adcCalibrationFileLabel = std::make_unique<Label>("adcCalibrationFileLabel", "ADC Calibration File");
 		adcCalibrationFileLabel->setBounds(calibrationFolder->getX(), calibrationFolder->getBottom() + 15, calibrationFolderLabel->getWidth(), calibrationFolderLabel->getHeight());
 		adcCalibrationFileLabel->setColour(Label::textColourId, Colours::black);
@@ -536,6 +534,8 @@ NeuropixelsV1Interface::NeuropixelsV1Interface(std::shared_ptr<Neuropixels1> d,
 		addAndMakeVisible(activityViewComponent.get());
 
 		updateSettings();
+
+		setCalibrationFolderEnabledState(false);
 	}
 
 	drawLegend();
@@ -581,7 +581,7 @@ void NeuropixelsV1Interface::updateInfoString()
 
 	if (searchForCalibrationFilesButton->getToggleState())
 	{
-		searchForCalibrationFiles(calibrationFolder->getText().toStdString(), std::static_pointer_cast<Neuropixels1>(device)->getProbeSerialNumber());
+		searchForCalibrationFiles(calibrationFolder->getText().toStdString(), sn);
 	}
 }
 
@@ -720,7 +720,6 @@ void NeuropixelsV1Interface::buttonClicked(Button* button)
 			deviceEnableButton->setLabel(disabledButtonText);
 		}
 
-		updateInfoString();
 		repaint();
 
 		CoreServices::updateSignalChain(editor);
@@ -911,8 +910,15 @@ std::string NeuropixelsV1Interface::searchDirectoryForCalibrationFile(std::strin
 
 	if (calibrationFiles.size() != 1)
 	{
-		Onix1::showWarningMessageBoxAsync("Wrong Number of Calibration Files", "Expected to find 1 file matching '" + filename +
-			"', but found " + std::to_string(calibrationFiles.size()) + " instead. Check logs for all files discovered.");
+		std::string msg = "Expected to find 1 file matching '" + filename +
+			"', but found " + std::to_string(calibrationFiles.size()) + " instead.";
+
+		if (calibrationFiles.size() > 1)
+		{
+			msg += " Check logs for all files discovered.";
+		}
+
+		Onix1::showWarningMessageBoxAsync("Wrong Number of Calibration Files", msg);
 		return "";
 	}
 
@@ -921,20 +927,37 @@ std::string NeuropixelsV1Interface::searchDirectoryForCalibrationFile(std::strin
 
 void NeuropixelsV1Interface::setCalibrationFolderEnabledState(bool enabledState)
 {
+	float alphaEnabled = 1.0, alphaDisabled = 0.25;
+
 	if (!enabledState)
 	{
-		calibrationFolder->setAlpha(0.25);
+		calibrationFolder->setAlpha(alphaDisabled);
 		calibrationFolderButton->setEnabled(false);
+
+		adcCalibrationFile->setAlpha(alphaEnabled);
+		adcCalibrationFileButton->setEnabled(true);
+
+		gainCalibrationFile->setAlpha(alphaEnabled);
+		gainCalibrationFileButton->setEnabled(true);
 	}
 	else
 	{
-		calibrationFolder->setAlpha(1.0);
+		calibrationFolder->setAlpha(alphaEnabled);
 		calibrationFolderButton->setEnabled(true);
+
+		adcCalibrationFile->setAlpha(alphaDisabled);
+		adcCalibrationFileButton->setEnabled(false);
+
+		gainCalibrationFile->setAlpha(alphaDisabled);
+		gainCalibrationFileButton->setEnabled(false);
 	}
 }
 
 void NeuropixelsV1Interface::searchForCalibrationFiles(std::string folder, uint64_t sn)
 {
+	if (!device->isEnabled())
+		return;
+
 	auto file = searchDirectoryForGainCalibrationFile(folder, sn);
 
 	if (file != "")

Source/UI/NeuropixelsV2eInterface.cpp

@@ -102,7 +102,6 @@ void NeuropixelsV2eInterface::buttonClicked(Button* button)
 			deviceEnableButton->setLabel(disabledButtonText);
 		}
 
-		updateInfoString();
 		repaint();
 
 		CoreServices::updateSignalChain(editor);

Source/UI/NeuropixelsV2eProbeInterface.cpp

@@ -68,10 +68,10 @@ NeuropixelsV2eProbeInterface::NeuropixelsV2eProbeInterface(std::shared_ptr<Neuro
 		searchForCorrectionFilesButton = std::make_unique<ToggleButton>("Search for calibration files automatically");
 		searchForCorrectionFilesButton->setBounds(infoLabel->getX() + 2, infoLabel->getBottom() + 5, 350, 20);
 		searchForCorrectionFilesButton->addListener(this);
-		searchForCorrectionFilesButton->setTooltip("Open a dialog to choose the folder where calibration files exist. This can be a top-level folder which is recursively searched for a matching serial number.");
+		searchForCorrectionFilesButton->setTooltip("Open a file dialog to choose a folder that contains all calibration files. The calibration file that matches your probe will automatically be selected if it exists in this folder.");
 		addAndMakeVisible(searchForCorrectionFilesButton.get());
 
-		gainCorrectionFolderLabel = std::make_unique<Label>("gainCorrectionFolderLabel", "Gain Correction Folder");
+		gainCorrectionFolderLabel = std::make_unique<Label>("gainCorrectionFolderLabel", "Calibration Folder");
 		gainCorrectionFolderLabel->setBounds(searchForCorrectionFilesButton->getX(), searchForCorrectionFilesButton->getBottom() + 5, 240, 16);
 		gainCorrectionFolderLabel->setColour(Label::textColourId, Colours::black);
 		addAndMakeVisible(gainCorrectionFolderLabel.get());
@@ -92,8 +92,6 @@ NeuropixelsV2eProbeInterface::NeuropixelsV2eProbeInterface(std::shared_ptr<Neuro
 
 		gainCorrectionFolderChooser = std::make_unique<FileChooser>("Select Gain Correction Folder.", File());
 
-		setGainCorrectionFolderEnabledState(false);
-
 		gainCorrectionFileLabel = std::make_unique<Label>("gainCorrectionFileLabel", "Gain Correction File");
 		gainCorrectionFileLabel->setBounds(gainCorrectionFolder->getX(), gainCorrectionFolder->getBottom() + 15, gainCorrectionFolderLabel->getWidth(), gainCorrectionFolderLabel->getHeight());
 		gainCorrectionFileLabel->setColour(Label::textColourId, Colours::black);
@@ -352,6 +350,8 @@ NeuropixelsV2eProbeInterface::NeuropixelsV2eProbeInterface(std::shared_ptr<Neuro
 		addAndMakeVisible(activityViewComponent.get());
 
 #pragma endregion
+
+		setGainCorrectionFolderEnabledState(false);
 	}
 
 	drawLegend();
@@ -380,7 +380,7 @@ void NeuropixelsV2eProbeInterface::updateInfoString()
 	deviceLabel->setText(deviceString, dontSendNotification);
 	infoLabel->setText(infoString, dontSendNotification);
 
-	if (searchForCorrectionFilesButton->getToggleState())
+	if (searchForCorrectionFilesButton->getToggleState() && device->isEnabled())
 	{
 		auto file = searchDirectoryForCalibrationFile(gainCorrectionFolder->getText().toStdString(), sn);
 
@@ -470,8 +470,6 @@ void NeuropixelsV2eProbeInterface::buttonClicked(Button* button)
 
 		if (fileChooser.browseForFileToOpen())
 		{
-			auto npx = std::static_pointer_cast<Neuropixels2e>(device);
-
 			if (ProbeInterfaceJson::readProbeSettingsFromJson(fileChooser.getResult(), npx->settings[probeIndex].get()))
 			{
 				applyProbeSettings(npx->settings[probeIndex].get());
@@ -485,8 +483,6 @@ void NeuropixelsV2eProbeInterface::buttonClicked(Button* button)
 
 		if (fileChooser.browseForFileToSave(true))
 		{
-			auto npx = std::static_pointer_cast<Neuropixels2e>(device);
-
 			if (!ProbeInterfaceJson::writeProbeSettingsToJson(fileChooser.getResult(), npx->settings[probeIndex].get()))
 				CoreServices::sendStatusMessage("Failed to write probe channel map.");
 			else
@@ -530,9 +526,9 @@ void NeuropixelsV2eProbeInterface::buttonClicked(Button* button)
 	{
 		setGainCorrectionFolderEnabledState(button->getToggleState());
 
-		if (button->getToggleState())
+		if (button->getToggleState() && device->isEnabled())
 		{
-			auto calibrationFile = searchDirectoryForCalibrationFile(gainCorrectionFolder->getText().toStdString(), std::static_pointer_cast<Neuropixels2e>(device)->getProbeSerialNumber(probeIndex));
+			auto calibrationFile = searchDirectoryForCalibrationFile(gainCorrectionFolder->getText().toStdString(), npx->getProbeSerialNumber(probeIndex));
 
 			if (calibrationFile != "")
 				gainCorrectionFile->setText(calibrationFile);
@@ -543,10 +539,14 @@ void NeuropixelsV2eProbeInterface::buttonClicked(Button* button)
 		if (gainCorrectionFolderChooser->browseForDirectory())
 		{
 			gainCorrectionFolder->setText(gainCorrectionFolderChooser->getResult().getFullPathName());
-			auto calibrationFile = searchDirectoryForCalibrationFile(gainCorrectionFolder->getText().toStdString(), std::static_pointer_cast<Neuropixels2e>(device)->getProbeSerialNumber(probeIndex));
 
-			if (calibrationFile != "")
-				gainCorrectionFile->setText(calibrationFile);
+			if (device->isEnabled())
+			{
+				auto calibrationFile = searchDirectoryForCalibrationFile(gainCorrectionFolder->getText().toStdString(), npx->getProbeSerialNumber(probeIndex));
+
+				if (calibrationFile != "")
+					gainCorrectionFile->setText(calibrationFile);
+			}
 		}
 	}
 }
@@ -583,8 +583,15 @@ std::string NeuropixelsV2eProbeInterface::searchDirectoryForCalibrationFile(std:
 
 	if (calibrationFiles.size() != 1)
 	{
-		Onix1::showWarningMessageBoxAsync("Wrong Number of Calibration Files", "Expected to find 1 file matching '" + filename +
-			"', but found " + std::to_string(calibrationFiles.size()) + " instead. Check logs for all files discovered.");
+		std::string msg = "Expected to find 1 file matching '" + filename +
+			"', but found " + std::to_string(calibrationFiles.size()) + " instead.";
+
+		if (calibrationFiles.size() > 1)
+		{
+			msg += " Check logs for all files discovered.";
+		}
+
+		Onix1::showWarningMessageBoxAsync("Wrong Number of Calibration Files", msg);
 		return "";
 	}
 
@@ -593,15 +600,23 @@ std::string NeuropixelsV2eProbeInterface::searchDirectoryForCalibrationFile(std:
 
 void NeuropixelsV2eProbeInterface::setGainCorrectionFolderEnabledState(bool enabledState)
 {
+	float alphaEnabled = 1.0, alphaDisabled = 0.25;
+
 	if (!enabledState)
 	{
-		gainCorrectionFolder->setAlpha(0.25);
+		gainCorrectionFolder->setAlpha(alphaDisabled);
 		gainCorrectionFolderButton->setEnabled(false);
+
+		gainCorrectionFile->setAlpha(alphaEnabled);
+		gainCorrectionFileButton->setEnabled(true);
 	}
 	else
 	{
-		gainCorrectionFolder->setAlpha(1.0);
+		gainCorrectionFolder->setAlpha(alphaEnabled);
 		gainCorrectionFolderButton->setEnabled(true);
+
+		gainCorrectionFile->setAlpha(alphaDisabled);
+		gainCorrectionFileButton->setEnabled(false);
 	}
 }