Merge pull request #536 from open-ephys/issue-506

Ensure gain correction always exists for NeuropixelsV2e devices

Author: bparks13

OpenEphys.Onix1/NeuropixelsV2eBetaData.cs

@@ -51,17 +51,21 @@ public unsafe override IObservable<NeuropixelsV2eBetaDataFrame> Generate()
             return DeviceManager.GetDevice(DeviceName).SelectMany(deviceInfo =>
             {
                 var info = (NeuropixelsV2eDeviceInfo)deviceInfo;
-                var metadata = ProbeIndex switch
+                var (metadata, gainCorrection) = ProbeIndex switch
                 {
-                    NeuropixelsV2Probe.ProbeA => info.ProbeMetadataA,
-                    NeuropixelsV2Probe.ProbeB => info.ProbeMetadataB,
+                    NeuropixelsV2Probe.ProbeA => (info.ProbeMetadataA, info.GainCorrectionA),
+                    NeuropixelsV2Probe.ProbeB => (info.ProbeMetadataB, info.GainCorrectionB),
                     _ => throw new InvalidEnumArgumentException($"Unexpected {nameof(ProbeIndex)} value: {ProbeIndex}")
                 };
 
                 if (metadata.ProbeSerialNumber == null)
                 {
                     throw new InvalidOperationException($"{ProbeIndex} is not detected. Ensure that the flex connection is properly seated.");
                 }
+                else if (gainCorrection == null)
+                {
+                    throw new NullReferenceException($"Gain correction value is null for {ProbeIndex}.");
+                }
 
                 var device = info.GetDeviceContext(typeof(NeuropixelsV2eBeta));
                 var passthrough = device.GetPassthroughDeviceContext(typeof(DS90UB9x));
@@ -70,13 +74,6 @@ public unsafe override IObservable<NeuropixelsV2eBetaDataFrame> Generate()
                     .Where(frame => NeuropixelsV2eBetaDataFrame.GetProbeIndex(frame) == (int)ProbeIndex);
                 var invertPolarity = info.InvertPolarity;
 
-                var gainCorrection = ProbeIndex switch
-                {
-                    NeuropixelsV2Probe.ProbeA => (double)info.GainCorrectionA,
-                    NeuropixelsV2Probe.ProbeB => (double)info.GainCorrectionB,
-                    _ => throw new InvalidEnumArgumentException($"Unexpected {nameof(ProbeIndex)} value: {ProbeIndex}")
-                };
-
                 return Observable.Create<NeuropixelsV2eBetaDataFrame>(observer =>
                 {
                     var sampleIndex = 0;
@@ -89,7 +86,7 @@ public unsafe override IObservable<NeuropixelsV2eBetaDataFrame> Generate()
                         frame =>
                         {
                             var payload = (NeuropixelsV2BetaPayload*)frame.Data.ToPointer();
-                            NeuropixelsV2eBetaDataFrame.CopyAmplifierBuffer(payload->SuperFrame, amplifierBuffer, frameCounter, sampleIndex, gainCorrection, invertPolarity);
+                            NeuropixelsV2eBetaDataFrame.CopyAmplifierBuffer(payload->SuperFrame, amplifierBuffer, frameCounter, sampleIndex, gainCorrection.Value, invertPolarity);
                             hubClockBuffer[sampleIndex] = payload->HubClock;
                             clockBuffer[sampleIndex] = frame.Clock;
                             if (++sampleIndex >= bufferSize)

OpenEphys.Onix1/NeuropixelsV2eData.cs

@@ -55,17 +55,21 @@ public unsafe override IObservable<NeuropixelsV2eDataFrame> Generate()
             return DeviceManager.GetDevice(DeviceName).SelectMany(deviceInfo =>
             {
                 var info = (NeuropixelsV2eDeviceInfo)deviceInfo;
-                var metadata = ProbeIndex switch
+                var (metadata, gainCorrection) = ProbeIndex switch
                 {
-                    NeuropixelsV2Probe.ProbeA => info.ProbeMetadataA,
-                    NeuropixelsV2Probe.ProbeB => info.ProbeMetadataB,
+                    NeuropixelsV2Probe.ProbeA => (info.ProbeMetadataA, info.GainCorrectionA),
+                    NeuropixelsV2Probe.ProbeB => (info.ProbeMetadataB, info.GainCorrectionB),
                     _ => throw new InvalidEnumArgumentException($"Unexpected {nameof(ProbeIndex)} value: {ProbeIndex}")
                 };
 
                 if (metadata.ProbeSerialNumber == null)
                 {
                     throw new InvalidOperationException($"{ProbeIndex} is not detected. Ensure that the flex connection is properly seated.");
                 }
+                else if (gainCorrection == null)
+                {
+                    throw new NullReferenceException($"Gain correction value is null for {ProbeIndex}.");
+                }
 
                 var device = info.GetDeviceContext(typeof(NeuropixelsV2e));
                 var passthrough = device.GetPassthroughDeviceContext(typeof(DS90UB9x));
@@ -74,13 +78,6 @@ public unsafe override IObservable<NeuropixelsV2eDataFrame> Generate()
                     .Where(frame => NeuropixelsV2eDataFrame.GetProbeIndex(frame) == (int)ProbeIndex);
                 var invertPolarity = info.InvertPolarity;
 
-                var gainCorrection = ProbeIndex switch
-                {
-                    NeuropixelsV2Probe.ProbeA => (double)info.GainCorrectionA,
-                    NeuropixelsV2Probe.ProbeB => (double)info.GainCorrectionB,
-                    _ => throw new InvalidEnumArgumentException($"Unexpected {nameof(ProbeIndex)} value: {ProbeIndex}")
-                };
-
                 return Observable.Create<NeuropixelsV2eDataFrame>(observer =>
                 {
                     var sampleIndex = 0;
@@ -92,7 +89,7 @@ public unsafe override IObservable<NeuropixelsV2eDataFrame> Generate()
                         frame =>
                         {
                             var payload = (NeuropixelsV2Payload*)frame.Data.ToPointer();
-                            NeuropixelsV2eDataFrame.CopyAmplifierBuffer(payload->AmplifierData, amplifierBuffer, sampleIndex, gainCorrection, invertPolarity);
+                            NeuropixelsV2eDataFrame.CopyAmplifierBuffer(payload->AmplifierData, amplifierBuffer, sampleIndex, gainCorrection.Value, invertPolarity);
                             hubClockBuffer[sampleIndex] = payload->HubClock;
                             clockBuffer[sampleIndex] = frame.Clock;
                             if (++sampleIndex >= bufferSize)