Merge pull request #491 from open-ephys/issue-294

Add Ground as reference option for Neuropixels 2.0 probes

Author: bparks13

OpenEphys.Onix1/ConfigureNeuropixelsV2eBeta.cs

@@ -200,6 +200,12 @@ public override IObservable<ContextTask> Process(IObservable<ContextTask> source
                 // configure probe A streaming
                 if (probeAMetadata.ProbeSerialNumber != null)
                 {
+                    if (ProbeConfigurationA.Reference == NeuropixelsV2QuadShankReference.Ground)
+                    {
+                        throw new InvalidOperationException($"Neuropixels 2.0-Beta probes do not provide a Ground reference selection. Please select a different reference" +
+                            $" for {NeuropixelsV2Probe.ProbeA}.");
+                    }
+
                     var gainCorrection = NeuropixelsV2Helper.TryParseGainCalibrationFile(GainCalibrationFileA);
 
                     if (!gainCorrection.HasValue)
@@ -221,8 +227,14 @@ public override IObservable<ContextTask> Process(IObservable<ContextTask> source
                 }
 
                 // configure probe B streaming
-                if (probeAMetadata.ProbeSerialNumber != null)
+                if (probeBMetadata.ProbeSerialNumber != null)
                 {
+                    if (ProbeConfigurationB.Reference == NeuropixelsV2QuadShankReference.Ground)
+                    {
+                        throw new InvalidOperationException($"Neuropixels 2.0-Beta probes do not provide a Ground reference selection. Please select a different reference" +
+                            $" for {NeuropixelsV2Probe.ProbeB}.");
+                    }
+
                     var gainCorrection = NeuropixelsV2Helper.TryParseGainCalibrationFile(GainCalibrationFileB);
 
                     if (!gainCorrection.HasValue)

OpenEphys.Onix1/NeuropixelsV2.cs

@@ -99,6 +99,7 @@ internal static BitArray[] GenerateBaseBits(NeuropixelsV2QuadShankProbeConfigura
                 NeuropixelsV2QuadShankReference.Tip2 => 2,
                 NeuropixelsV2QuadShankReference.Tip3 => 2,
                 NeuropixelsV2QuadShankReference.Tip4 => 2,
+                NeuropixelsV2QuadShankReference.Ground => 3,
                 _ => throw new InvalidOperationException("Invalid reference selection."),
             };
 

OpenEphys.Onix1/NeuropixelsV2QuadShankProbeConfiguration.cs

@@ -34,7 +34,11 @@ public enum NeuropixelsV2QuadShankReference : uint
         /// <summary>
         /// Specifies that the tip reference of shank 4 will be used.
         /// </summary>
-        Tip4
+        Tip4,
+        /// <summary>
+        /// Specifies that the ground reference will be used.
+        /// </summary>
+        Ground
     }
 
     /// <summary>