Before acquisition, check if the probe type and probe part number match

- Confirms if the selected probe type is the same as the connected hardware. Used to confirm if a probe is connected that is not implemented (such as the 1.0 UHD probe), or to confirm that the correct probe is selected (2.0 single- or quad-shank probes)

Author: bparks13

Source/Devices/Neuropixels1.cpp

@@ -175,20 +175,20 @@ void Neuropixels1::defineMetadata (ProbeSettings* settings, ProbeType probeType)
     settings->probeMetadata.name = "Neuropixels 1.0";
 
     std::vector<std::array<float, 2>> shankOutline {
-        {      27,  31 },
-        {      27, 514 },
-        {  27 + 5, 522 },
-        { 27 + 10, 514 },
-        { 27 + 10,  31 }
+        {     27,  31},
+        {     27, 514},
+        { 27 + 5, 522},
+        {27 + 10, 514},
+        {27 + 10,  31}
     };
 
     std::vector<std::array<float, 2>> probeContour {
-        {  0,  155 },
-        { 35,    0 },
-        { 70,  155 },
-        { 70, 9770 },
-        {  0, 9770 },
-        {  0,  155 }
+        { 0,  155},
+        {35,    0},
+        {70,  155},
+        {70, 9770},
+        { 0, 9770},
+        { 0,  155}
     };
 
     settings->probeMetadata.shank_count = 1;
@@ -520,3 +520,15 @@ void Neuropixels1::setGainCalibrationFilePath (std::string filepath)
 {
     gainCalibrationFilePath = filepath;
 }
+
+bool Neuropixels1::validateProbeTypeAndPartNumber ()
+{
+    if (! NeuropixelsProbeMetadata::validateProbeTypeAndPartNumber (settings[0]->probeType, probeMetadata.getProbePartNumber()))
+    {
+        Onix1::showWarningMessageBoxAsync ("Probe Type / Number Mismatch", "The selected probe type is " + ProbeTypeString.at (settings[0]->probeType) + ", but the probe part number is " + probeMetadata.getProbePartNumber() + ".");
+        return false;
+    }
+
+    return true;
+}
+

Source/Devices/Neuropixels1.h

@@ -133,6 +133,8 @@ class Neuropixels1 : public INeuropixel<NeuropixelsV1Values::numberOfChannels, N
     void updateLfpOffsets (std::array<float, numLfpSamples>&, int64);
     void updateApOffsets (std::array<float, numApSamples>&, int64);
 
+    bool validateProbeTypeAndPartNumber ();
+
     enum class ElectrodeConfiguration : int32_t
     {
         BankA = 0,

Source/Devices/Neuropixels1e.cpp

@@ -197,6 +197,9 @@ void Neuropixels1e::resetProbe()
 
 bool Neuropixels1e::updateSettings()
 {
+    if (! validateProbeTypeAndPartNumber())
+        return false;
+
     auto updater = NeuropixelsV1eBackgroundUpdater (this);
 
     return updater.updateSettings() && adcValues.size() == NeuropixelsV1Values::AdcCount;

Source/Devices/Neuropixels1f.cpp

@@ -153,6 +153,9 @@ int Neuropixels1f::configureDevice()
 
 bool Neuropixels1f::updateSettings()
 {
+    if (! validateProbeTypeAndPartNumber())
+        return false;
+
     auto updater = NeuropixelsV1fBackgroundUpdater (this);
 
     return updater.updateSettings() && adcValues.size() == NeuropixelsV1Values::AdcCount;

Source/Devices/Neuropixels2e.cpp

@@ -342,6 +342,12 @@ bool Neuropixels2e::updateSettings()
     {
         if (probeMetadata[i].getProbeSerialNumber() != 0)
         {
+            if (! NeuropixelsProbeMetadata::validateProbeTypeAndPartNumber (settings[i]->probeType, probeMetadata[i].getProbePartNumber()))
+            {
+                Onix1::showWarningMessageBoxAsync ("Probe Type / Number Mismatch", "The selected probe type is " + ProbeTypeString.at (settings[i]->probeType) + ", but the probe part number is " + probeMetadata[i].getProbePartNumber() + ".");
+                return false;
+            }
+
             if (gainCorrectionFilePath[i] == "None" || gainCorrectionFilePath[i] == "")
             {
                 Onix1::showWarningMessageBoxAsync ("Missing File", "Missing gain correction file for probe " + std::to_string (probeMetadata[i].getProbeSerialNumber()));

Source/Devices/NeuropixelsProbeMetadata.cpp

@@ -86,6 +86,39 @@ NeuropixelsProbeMetadata::NeuropixelsProbeMetadata(I2CRegisterContext* flex, Oni
 	}
 }
 
+bool NeuropixelsProbeMetadata::validateProbeTypeAndPartNumber (ProbeType probeType, std::string partNumber)
+{
+    if (probeType == ProbeType::NONE)
+        return false;
+
+    else if (probeType == ProbeType::NPX_V1)
+    {
+        if (partNumber == "PRB_1_4_0480_1" || partNumber == "PRB_1_4_0480_1_C" || partNumber == "PRB_1_2_0480_2")
+            return true;
+
+        else
+            return false;
+    }
+    else if (probeType == ProbeType::NPX_V2_SINGLE_SHANK)
+    {
+        if (partNumber == "NP2003" || partNumber == "NP2004")
+            return true;
+
+        else
+            return false;
+    }
+    else if (probeType == ProbeType::NPX_V2_QUAD_SHANK)
+    {
+        if (partNumber == "NP2013" || partNumber == "NP2014")
+            return true;
+
+        else
+            return false;
+    }
+    else
+        return false;
+}
+
 const uint64_t NeuropixelsProbeMetadata::getProbeSerialNumber() const
 {
 	return probeSerialNumber;

Source/Devices/NeuropixelsProbeMetadata.h

@@ -23,6 +23,7 @@
 #pragma once
 
 #include "../I2CRegisterContext.h"
+#include "../NeuropixelsComponents.h"
 #include "../OnixDevice.h"
 
 namespace OnixSourcePlugin
@@ -38,6 +39,8 @@ namespace OnixSourcePlugin
 		const std::string getFlexPartNumber() const;
 		const std::string getFlexVersion() const;
 
+		static bool validateProbeTypeAndPartNumber (ProbeType probeType, std::string partNumber);
+
 	private:
 		OnixDeviceType deviceType = OnixDeviceType::UNKNOWN;
 

Source/NeuropixelsComponents.h

@@ -39,6 +39,13 @@ enum class ProbeType
     NPX_V2_QUAD_SHANK,
 };
 
+const std::map<ProbeType, std::string> ProbeTypeString = {
+    {               ProbeType::NONE,                           "None"},
+    {             ProbeType::NPX_V1,                "Neuropixels 1.0"},
+    {ProbeType::NPX_V2_SINGLE_SHANK, "Neuropixels 2.0 - single shank"},
+    {  ProbeType::NPX_V2_QUAD_SHANK,   "Neuropixels 2.0 - multishank"},
+};
+
 enum class Bank
 {
     NONE = -1,
@@ -212,7 +219,14 @@ struct NeuropixelsV1Adc
     const int threshold;
 
     NeuropixelsV1Adc (int compP_ = 16, int compN_ = 16, int slope_ = 0, int coarse_ = 0, int fine_ = 0, int cfix_ = 0, int offset_ = 0, int threshold_ = 512)
-        : compP (compP_), compN (compN_), slope (slope_), coarse (coarse_), fine (fine_), cfix (cfix_), offset (offset_), threshold (threshold_)
+        : compP (compP_),
+          compN (compN_),
+          slope (slope_),
+          coarse (coarse_),
+          fine (fine_),
+          cfix (cfix_),
+          offset (offset_),
+          threshold (threshold_)
     {
     }
 };
@@ -241,9 +255,10 @@ struct NeuropixelsV2eValues
 
 struct ProbeSettings
 {
-    ProbeSettings (int numChannels, int numElectrodes, ProbeType type) : numberOfChannels (numChannels), numberOfElectrodes (numElectrodes)
+    ProbeSettings (int numChannels, int numElectrodes, ProbeType type) : numberOfChannels (numChannels),
+                                                                         numberOfElectrodes (numElectrodes)
     {
-        selectedBank = std::vector<Bank>(numChannels, Bank::A);
+        selectedBank = std::vector<Bank> (numChannels, Bank::A);
         selectedShank = std::vector<int> (numChannels, 0);
         selectedElectrode = std::vector<int> (numChannels);