Save probe configurations for both probe types

- Instead of reverting to the default settings for a probe type if the user switches types, hold both configurations in memory and swap between them so that the user does not lose any configurations accidentally

Author: bparks13

OpenEphys.Onix1.Design/ChannelConfigurationDialog.cs

@@ -18,7 +18,17 @@ public abstract partial class ChannelConfigurationDialog : Form
     {
         internal event EventHandler OnResizeZedGraph;
 
-        internal ProbeGroup ProbeGroup;
+        ProbeGroup probeGroup;
+
+        internal ProbeGroup ProbeGroup
+        {
+            get => probeGroup;
+            set
+            {
+                probeGroup = value;
+                SelectedContacts = new bool[probeGroup.NumberOfContacts];
+            }
+        }
 
         internal readonly List<int> ReferenceContacts = new();
 
@@ -42,8 +52,6 @@ public ChannelConfigurationDialog(ProbeGroup probeGroup)
                 ProbeGroup = probeGroup;
             }
 
-            SelectedContacts = new bool[ProbeGroup.NumberOfContacts];
-
             ReferenceContacts = new List<int>();
 
             zedGraphChannels.MouseDownEvent += MouseDownEvent;
@@ -73,7 +81,6 @@ public ChannelConfigurationDialog(ProbeGroup probeGroup)
         internal virtual void LoadDefaultChannelLayout()
         {
             ProbeGroup = DefaultChannelLayout();
-            SelectedContacts = new bool[ProbeGroup.NumberOfContacts];
         }
 
         /// <summary>
@@ -437,8 +444,8 @@ internal virtual bool OpenFile<T>() where T : ProbeGroup
 
             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);
+                var result = MessageBox.Show($"There is a mismatch between the current probe type ({ProbeGroup.Probes.First().Annotations.Name})" +
+                    $" and the new probe type ({newConfiguration.Probes.First().Annotations.Name}). Continue loading?", "Probe Type Mismatch", MessageBoxButtons.YesNo);
 
                 if (result == DialogResult.No)
                     return false;
@@ -452,7 +459,6 @@ internal virtual bool OpenFile<T>() where T : ProbeGroup
                 newConfiguration.Validate();
 
                 ProbeGroup = newConfiguration;
-                SelectedContacts = new bool[ProbeGroup.NumberOfContacts];
 
                 return true;
             }

OpenEphys.Onix1.Design/NeuropixelsV2eProbeConfigurationDialog.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 using System.Drawing;
 using System.IO;
@@ -70,6 +71,8 @@ public NeuropixelsV2ProbeConfiguration ProbeConfiguration
             get => ChannelConfiguration.ProbeConfiguration;
         }
 
+        readonly Dictionary<NeuropixelsV2ProbeType, NeuropixelsV2ProbeConfiguration> probeConfigurations;
+
         /// <inheritdoc cref="ConfigureNeuropixelsV2e.InvertPolarity"/>
         public bool InvertPolarity { get; set; }
 
@@ -87,7 +90,15 @@ public NeuropixelsV2eProbeConfigurationDialog(NeuropixelsV2ProbeConfiguration co
 
             textBoxProbeCalibrationFile.Text = calibrationFile;
 
-            ChannelConfiguration = new(configuration)
+            probeConfigurations = new()
+            {
+                [NeuropixelsV2ProbeType.SingleShank] = new(configuration.Probe, NeuropixelsV2ProbeType.SingleShank, configuration.Reference),
+                [NeuropixelsV2ProbeType.QuadShank] = new(configuration.Probe, NeuropixelsV2ProbeType.QuadShank, configuration.Reference)
+            };
+
+            probeConfigurations[configuration.ProbeType].SelectElectrodes(configuration.ChannelMap);
+
+            ChannelConfiguration = new(probeConfigurations[configuration.ProbeType])
             {
                 TopLevel = false,
                 FormBorderStyle = FormBorderStyle.None,
@@ -111,21 +122,17 @@ public NeuropixelsV2eProbeConfigurationDialog(NeuropixelsV2ProbeConfiguration co
             else
                 comboBoxProbeType.SelectedIndexChanged += SelectedProbeTypeChanged;
 
-            comboBoxReference.DataSource = NeuropixelsV2ProbeConfiguration.FilterNeuropixelsV2ShankReference(ProbeConfiguration.ProbeType);
-            comboBoxReference.SelectedItem = ProbeConfiguration.Reference;
-            comboBoxReference.SelectedIndexChanged += SelectedReferenceChanged;
-
             comboBoxChannelPresets.DataSource = GetComboBoxChannelPresets(ProbeConfiguration.ProbeType);
             comboBoxChannelPresets.SelectedIndexChanged += SelectedChannelPresetChanged;
 
             checkBoxInvertPolarity.Checked = InvertPolarity;
             checkBoxInvertPolarity.CheckedChanged += InvertPolarityIndexChanged;
 
-            CheckForExistingChannelPreset();
-
             CheckStatus();
 
             Text += ": " + ProbeConfiguration.Probe.ToString();
+
+            UpdateProbeConfiguration();
         }
 
         static Array GetComboBoxChannelPresets(NeuropixelsV2ProbeType probeType)
@@ -184,27 +191,30 @@ private void ResizeTrackBar(object sender, EventArgs e)
 
         void UpdateProbeConfiguration()
         {
+            var probeType = (NeuropixelsV2ProbeType)comboBoxProbeType.SelectedItem;
+
+            ChannelConfiguration.ProbeConfiguration = probeConfigurations[probeType];
+            ChannelConfiguration.ProbeGroup = ProbeConfiguration.ProbeGroup;
+
             ChannelConfiguration.DrawProbeGroup();
             ChannelConfiguration.ResetZoom();
             ChannelConfiguration.RefreshZedGraph();
 
-            comboBoxReference.DataSource = NeuropixelsV2ProbeConfiguration.FilterNeuropixelsV2ShankReference(ProbeConfiguration.ProbeType);
-
             comboBoxChannelPresets.SelectedIndexChanged -= SelectedChannelPresetChanged; // NB: Temporarily detach handler so the loaded electrode configuration is respected
             comboBoxChannelPresets.DataSource = GetComboBoxChannelPresets(ProbeConfiguration.ProbeType);
             comboBoxChannelPresets.SelectedIndexChanged += SelectedChannelPresetChanged;
+
+            comboBoxReference.SelectedIndexChanged -= SelectedReferenceChanged;
+            comboBoxReference.DataSource = NeuropixelsV2ProbeConfiguration.FilterNeuropixelsV2ShankReference(ProbeConfiguration.ProbeType);
+            comboBoxReference.SelectedItem = ProbeConfiguration.Reference;
+            comboBoxReference.SelectedIndexChanged += SelectedReferenceChanged;
+
+            CheckForExistingChannelPreset();
         }
 
         void SelectedProbeTypeChanged(object sender, EventArgs e)
         {
-            var probeType = (NeuropixelsV2ProbeType)((ComboBox)sender).SelectedItem;
-
-            if (probeType != ProbeConfiguration.ProbeType)
-            {
-                ProbeConfiguration.ProbeType = probeType;
-                ChannelConfiguration.LoadDefaultChannelLayout();
-                UpdateProbeConfiguration();
-            }
+            UpdateProbeConfiguration();
         }
 
         private void SelectedReferenceChanged(object sender, EventArgs e)
@@ -658,10 +668,25 @@ void CheckQuadShankForChannelPreset(NeuropixelsV2Electrode[] channelMap)
 
         private void OnFileLoadEvent(object sender, EventArgs e)
         {
-            ProbeConfiguration.ProbeType = NeuropixelsV2eProbeGroup.GetProbeTypeFromProbeName(ChannelConfiguration.ProbeGroup.Probes.First().Annotations.Name);
-            comboBoxProbeType.SelectedItem = ProbeConfiguration.ProbeType;
+            NeuropixelsV2ProbeType probeType;
+
+            try
+            {
+                probeType = NeuropixelsV2eProbeGroup.GetProbeTypeFromProbeName(ChannelConfiguration.ProbeGroup.Probes.First().Annotations.Name);
+            }
+            catch (ArgumentException ex)
+            {
+                MessageBox.Show(ex.Message);
+                return;
+            }
+
+            probeConfigurations[probeType] = new((NeuropixelsV2eProbeGroup)ChannelConfiguration.ProbeGroup,
+                probeConfigurations[probeType].Probe,
+                probeConfigurations[probeType].ProbeType,
+                probeConfigurations[probeType].Reference);
+
+            comboBoxProbeType.SelectedItem = probeType;
             UpdateProbeConfiguration();
-            CheckForExistingChannelPreset();
         }
 
         private void FileTextChanged(object sender, EventArgs e)

OpenEphys.Onix1/NeuropixelsV2eProbeGroup.cs

@@ -50,7 +50,7 @@ internal static NeuropixelsV2ProbeType GetProbeTypeFromProbeName(string name)
                 return NeuropixelsV2ProbeType.QuadShank;
 
             else
-                throw new ArgumentException($"The name '{name}' does not match any known Neuropixels 2.0 probe names.");
+                throw new ArgumentException($"The type '{name}' does not match any implemented Neuropixels 2.0 probe types.");
         }
 
         private static Probe[] DefaultProbes(NeuropixelsV2ProbeType probeType)