Add support for single-shank Neuropixels 2.0 probes

- Deprecate the QuadShank classes in favor of the more generic configuration classes that can be either quad- or single-shank
- Update shift register bit setting for single-shank probes
- Add combo box to the 2.0 GUIs allowing the user to change the probe type

Author: bparks13

OpenEphys.Onix1.Design/ChannelConfigurationDialog.cs

@@ -22,7 +22,7 @@ public abstract partial class ChannelConfigurationDialog : Form
 
         internal readonly List<int> ReferenceContacts = new();
 
-        internal readonly bool[] SelectedContacts = null;
+        internal bool[] SelectedContacts { get; private set; } = null;
 
         /// <summary>
         /// Constructs the dialog window using the given probe group, and plots all contacts after loading.
@@ -73,6 +73,7 @@ public ChannelConfigurationDialog(ProbeGroup probeGroup)
         internal virtual void LoadDefaultChannelLayout()
         {
             ProbeGroup = DefaultChannelLayout();
+            SelectedContacts = new bool[ProbeGroup.NumberOfContacts];
         }
 
         /// <summary>
@@ -432,13 +433,26 @@ internal virtual bool OpenFile<T>() where T : ProbeGroup
                 return false;
             }
 
-            if (ProbeGroup.NumberOfContacts == newConfiguration.NumberOfContacts)
+            bool skipContactNumberMismatchCheck = false;
+
+            if (ProbeGroup.Probes.First().Annotations.Name != newConfiguration.Probes.First().Annotations.Name)
+            {
+                var result = MessageBox.Show($"There is a mismatch between the current probe name ({ProbeGroup.Probes.First().Annotations.Name})" +
+                    $" and the new probe name ({newConfiguration.Probes.First().Annotations.Name}). Continue loading?", "Probe Name Mismatch", MessageBoxButtons.YesNo);
+
+                if (result == DialogResult.No)
+                    return false;
+
+                skipContactNumberMismatchCheck = true; // NB: If the probe names do not match, skip the check to see if the number of contacts match.
+                                                       // Example: loading a Neuropixels single-shank 2.0 probe, but the current probe is a quad-shank 2.0 probe.
+            }
+
+            if (skipContactNumberMismatchCheck || ProbeGroup.NumberOfContacts == newConfiguration.NumberOfContacts)
             {
                 newConfiguration.Validate();
 
                 ProbeGroup = newConfiguration;
-                DrawProbeGroup();
-                RefreshZedGraph();
+                SelectedContacts = new bool[ProbeGroup.NumberOfContacts];
 
                 return true;
             }
@@ -1075,6 +1089,8 @@ private void MenuItemOpenFile(object sender, EventArgs e)
             if (OpenFile<ProbeGroup>())
             {
                 DrawProbeGroup();
+                ResetZoom();
+                UpdateFontSize();
                 RefreshZedGraph();
             }
         }
@@ -1083,6 +1099,7 @@ private void MenuItemLoadDefaultConfig(object sender, EventArgs e)
         {
             LoadDefaultChannelLayout();
             DrawProbeGroup();
+            ResetZoom();
             UpdateFontSize();
             RefreshZedGraph();
         }
@@ -1342,8 +1359,8 @@ internal static bool HasContactAnnotations(ProbeGroup probeGroup)
         {
             foreach (var probe in probeGroup.Probes)
             {
-                if (probe.ContactAnnotations != null 
-                    && probe.ContactAnnotations.Annotations != null 
+                if (probe.ContactAnnotations != null
+                    && probe.ContactAnnotations.Annotations != null
                     && probe.ContactAnnotations.Annotations.Length > 0)
                 {
                     return true;

OpenEphys.Onix1.Design/NeuropixelsV2eChannelConfigurationDialog.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Collections.Generic;
 using System.Drawing;
 using System.Linq;
 using System.Windows.Forms;
@@ -17,24 +16,24 @@ public partial class NeuropixelsV2eChannelConfigurationDialog : ChannelConfigura
         internal event EventHandler OnFileLoad;
 
         /// <summary>
-        /// Public <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> object that is manipulated by
+        /// Public <see cref="NeuropixelsV2ProbeConfiguration"/> object that is manipulated by
         /// <see cref="NeuropixelsV2eChannelConfigurationDialog"/>.
         /// </summary>
-        public NeuropixelsV2QuadShankProbeConfiguration ProbeConfiguration;
+        public NeuropixelsV2ProbeConfiguration ProbeConfiguration;
 
         /// <summary>
         /// Initializes a new instance of <see cref="NeuropixelsV2eChannelConfigurationDialog"/>.
         /// </summary>
-        /// <param name="probeConfiguration">A <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> object holding the current configuration settings.</param>
-        public NeuropixelsV2eChannelConfigurationDialog(NeuropixelsV2QuadShankProbeConfiguration probeConfiguration)
+        /// <param name="probeConfiguration">A <see cref="NeuropixelsV2ProbeConfiguration"/> object holding the current configuration settings.</param>
+        public NeuropixelsV2eChannelConfigurationDialog(NeuropixelsV2ProbeConfiguration probeConfiguration)
             : base(probeConfiguration.ProbeGroup)
         {
             zedGraphChannels.ZoomButtons = MouseButtons.None;
             zedGraphChannels.ZoomButtons2 = MouseButtons.None;
 
             zedGraphChannels.ZoomStepFraction = 0.5;
 
-            ProbeConfiguration = probeConfiguration;
+            ProbeConfiguration = new(probeConfiguration);
 
             ZoomInBoundaryX = 600;
             ZoomInBoundaryY = 600;
@@ -44,25 +43,21 @@ public NeuropixelsV2eChannelConfigurationDialog(NeuropixelsV2QuadShankProbeConfi
             RefreshZedGraph();
         }
 
-        internal override ProbeGroup DefaultChannelLayout()
+        internal override void LoadDefaultChannelLayout()
         {
-            return new NeuropixelsV2eProbeGroup();
+            base.LoadDefaultChannelLayout();
+            OnFileOpenHandler();
         }
 
-        internal override void LoadDefaultChannelLayout()
+        internal override ProbeGroup DefaultChannelLayout()
         {
-            ProbeConfiguration = new(ProbeConfiguration.Probe, ProbeConfiguration.Reference);
-            ProbeGroup = ProbeConfiguration.ProbeGroup;
-
-            OnFileOpenHandler();
+            return new NeuropixelsV2eProbeGroup(ProbeConfiguration.ProbeType);
         }
 
         internal override bool OpenFile<T>()
         {
             if (base.OpenFile<NeuropixelsV2eProbeGroup>())
             {
-                ProbeConfiguration = new((NeuropixelsV2eProbeGroup)ProbeGroup, ProbeConfiguration.Reference, ProbeConfiguration.Probe);
-
                 OnFileOpenHandler();
 
                 return true;
@@ -173,7 +168,7 @@ internal override void DrawScale()
 
             const float scaleBarWidth = 1;
 
-            curve.Line.Width = scaleBarWidth; 
+            curve.Line.Width = scaleBarWidth;
             curve.Label.IsVisible = false;
             curve.Symbol.IsVisible = false;
             curve.Tag = ScalePointsTag;
@@ -197,7 +192,7 @@ internal override void HighlightEnabledContacts()
             var contactsToEnable = contactObjects.Where(c =>
                                                         {
                                                             var tag = c.Tag as ContactTag;
-                                                            var channel = NeuropixelsV2QuadShankElectrode.GetChannelNumber(tag.ContactIndex);
+                                                            var channel = NeuropixelsV2Electrode.GetChannelNumber(tag.ContactIndex, ProbeConfiguration.ProbeType);
                                                             return ProbeConfiguration.ChannelMap[channel].Index == tag.ContactIndex;
                                                         });
 
@@ -227,7 +222,7 @@ internal override void UpdateContactLabels()
             textObjsToUpdate = textObjs.Where(c =>
                                               {
                                                   var tag = c.Tag as ContactTag;
-                                                  var channel = NeuropixelsV2QuadShankElectrode.GetChannelNumber(tag.ContactIndex);
+                                                  var channel = NeuropixelsV2Electrode.GetChannelNumber(tag.ContactIndex, ProbeConfiguration.ProbeType);
                                                   return ProbeConfiguration.ChannelMap[channel].Index == tag.ContactIndex;
                                               });
 
@@ -242,7 +237,7 @@ internal override string ContactString(int deviceChannelIndex, int index)
             return index.ToString();
         }
 
-        internal void EnableElectrodes(NeuropixelsV2QuadShankElectrode[] electrodes)
+        internal void EnableElectrodes(NeuropixelsV2Electrode[] electrodes)
         {
             ProbeConfiguration.SelectElectrodes(electrodes);
         }