Merge pull request #215 from open-ephys/issue-200

Improve description of neuropixels calibration files

Author: jonnew

OpenEphys.Onix1/ConfigureNeuropixelsV1e.cs

@@ -90,8 +90,16 @@ public ConfigureNeuropixelsV1e()
         /// Gets or sets the path to the gain calibration file.
         /// </summary>
         /// <remarks>
-        /// Each probe must be provided with a gain calibration file that contains calibration data
-        /// specific to each probe. This file is mandatory for accurate recordings.
+        /// <para>
+        /// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
+        /// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
+        /// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
+        /// </para>
+        /// <para>
+        /// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the 
+        /// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration 
+        /// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
+        /// </para>
         /// </remarks>
         [FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
         [Description("Path to the Neuropixels 1.0 gain calibration file.")]
@@ -102,8 +110,17 @@ public ConfigureNeuropixelsV1e()
         /// Gets or sets the path to the ADC calibration file.
         /// </summary>
         /// <remarks>
-        /// Each probe must be provided with an ADC calibration file that contains calibration data
-        /// specific to each probe. This file is mandatory for accurate recordings.
+        /// <para>
+        /// Each probe must be provided with an ADC calibration file that contains probe-specific hardware settings that is
+        /// created by IMEC during factory calibration. These files are used to set internal bias currents, correct for ADC
+        /// nonlinearities, correct ADC-zero crossing non-monotonicities, etc. Using the correct calibration file is mandatory
+        /// for the probe to operate correctly. 
+        /// </para>
+        /// <para>
+        /// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the 
+        /// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration 
+        /// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
+        /// </para>
         /// </remarks>
         [FileNameFilter("ADC calibration files (*_ADCCalibration.csv)|*_ADCCalibration.csv")]
         [Description("Path to the Neuropixels 1.0 ADC calibration file.")]

OpenEphys.Onix1/ConfigureNeuropixelsV2e.cs

@@ -41,8 +41,11 @@ public ConfigureNeuropixelsV2e()
         /// Gets or sets the path to the gain calibration file for Probe A.
         /// </summary>
         /// <remarks>
-        /// Each probe must be provided with a gain calibration file that contains calibration data
-        /// specific to each probe. This file is mandatory for accurate recordings.
+        /// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
+        /// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
+        /// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
+        /// If you have lost track of the gain calibration file for your probe, you can email IMEC at [email protected]
+        /// with the probe serial number to retrieve a new copy.
         /// </remarks>
         [FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
         [Description("Path to the gain calibration file for probe A.")]
@@ -60,8 +63,16 @@ public ConfigureNeuropixelsV2e()
         /// Gets or sets the path to the gain calibration file for Probe B.
         /// </summary>
         /// <remarks>
-        /// Each probe must be provided with a gain calibration file that contains calibration data
-        /// specific to each probe. This file is mandatory for accurate recordings.
+        /// <para>
+        /// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
+        /// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
+        /// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
+        /// </para>
+        /// <para>
+        /// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the 
+        /// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration 
+        /// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
+        /// </para>
         /// </remarks>
         [FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
         [Description("Path to the gain calibration file for probe B.")]

OpenEphys.Onix1/ConfigureNeuropixelsV2eBeta.cs

@@ -51,8 +51,16 @@ public ConfigureNeuropixelsV2eBeta()
         /// Gets or sets the path to the gain calibration file for Probe A.
         /// </summary>
         /// <remarks>
-        /// Each probe must be provided with a gain calibration file that contains calibration data
-        /// specific to each probe. This file is mandatory for accurate recordings.
+        /// <para>
+        /// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
+        /// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
+        /// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
+        /// </para>
+        /// <para>
+        /// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the 
+        /// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration 
+        /// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
+        /// </para>
         /// </remarks>
         [FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
         [Description("Path to the gain calibration file for probe A.")]
@@ -70,8 +78,11 @@ public ConfigureNeuropixelsV2eBeta()
         /// Gets or sets the path to the gain calibration file for Probe B.
         /// </summary>
         /// <remarks>
-        /// Each probe must be provided with a gain calibration file that contains calibration data
-        /// specific to each probe. This file is mandatory for accurate recordings.
+        /// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
+        /// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
+        /// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
+        /// If you have lost track of the gain calibration file for your probe, you can email IMEC at [email protected]
+        /// with the probe serial number to retrieve a new copy.
         /// </remarks>
         [FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
         [Description("Path to the gain calibration file for probe B.")]