Skip to content

Commit ab30047

Browse files
committed
Address code review comments
- Improve clarity of neuropixesl calibration file descriptions
1 parent 44947e5 commit ab30047

File tree

3 files changed

+32
-11
lines changed

3 files changed

+32
-11
lines changed

OpenEphys.Onix1/ConfigureNeuropixelsV1e.cs

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,16 @@ public ConfigureNeuropixelsV1e()
9090
/// Gets or sets the path to the gain calibration file.
9191
/// </summary>
9292
/// <remarks>
93-
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
93+
/// <para>
94+
/// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
9495
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
9596
/// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
96-
/// If you have lost track of the gain calibration file for your probe, you can email IMEC at [email protected]
97-
/// with the probe serial number to retrieve a new copy.
97+
/// </para>
98+
/// <para>
99+
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
100+
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
101+
/// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
102+
/// </para>
98103
/// </remarks>
99104
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
100105
[Description("Path to the Neuropixels 1.0 gain calibration file.")]
@@ -105,11 +110,17 @@ public ConfigureNeuropixelsV1e()
105110
/// Gets or sets the path to the ADC calibration file.
106111
/// </summary>
107112
/// <remarks>
113+
/// <para>
108114
/// Each probe must be provided with an ADC calibration file that contains probe-specific hardware settings that is
109115
/// created by IMEC during factory calibration. These files are used to set internal bias currents, correct for ADC
110116
/// nonlinearities, correct ADC-zero crossing non-monotonicities, etc. Using the correct calibration file is mandatory
111-
/// for the probe to operate correctly. If you have lost track of the ADC calibration file for your probe, you can
112-
/// email IMEC at [email protected] with the probe serial number to retrieve a new copy.
117+
/// for the probe to operate correctly.
118+
/// </para>
119+
/// <para>
120+
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
121+
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
122+
/// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
123+
/// </para>
113124
/// </remarks>
114125
[FileNameFilter("ADC calibration files (*_ADCCalibration.csv)|*_ADCCalibration.csv")]
115126
[Description("Path to the Neuropixels 1.0 ADC calibration file.")]

OpenEphys.Onix1/ConfigureNeuropixelsV2e.cs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,11 +63,16 @@ public ConfigureNeuropixelsV2e()
6363
/// Gets or sets the path to the gain calibration file for Probe B.
6464
/// </summary>
6565
/// <remarks>
66-
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
66+
/// <para>
67+
/// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
6768
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
6869
/// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
69-
/// If you have lost track of the gain calibration file for your probe, you can email IMEC at [email protected]
70-
/// with the probe serial number to retrieve a new copy.
70+
/// </para>
71+
/// <para>
72+
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
73+
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
74+
/// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
75+
/// </para>
7176
/// </remarks>
7277
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
7378
[Description("Path to the gain calibration file for probe B.")]

OpenEphys.Onix1/ConfigureNeuropixelsV2eBeta.cs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,16 @@ public ConfigureNeuropixelsV2eBeta()
5151
/// Gets or sets the path to the gain calibration file for Probe A.
5252
/// </summary>
5353
/// <remarks>
54-
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
54+
/// <para>
55+
/// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
5556
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
5657
/// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
57-
/// If you have lost track of the gain calibration file for your probe, you can email IMEC at [email protected]
58-
/// with the probe serial number to retrieve a new copy.
58+
/// </para>
59+
/// <para>
60+
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
61+
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
62+
/// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
63+
/// </para>
5964
/// </remarks>
6065
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
6166
[Description("Path to the gain calibration file for probe A.")]

0 commit comments

Comments
 (0)