Skip to content

Commit 44947e5

Browse files
committed
Improve description of neuropixels calibration files
- More explaination - More emphasis on their importance - Path to getting a new one if yours is lost
1 parent 7ac700f commit 44947e5

File tree

3 files changed

+30
-12
lines changed

3 files changed

+30
-12
lines changed

OpenEphys.Onix1/ConfigureNeuropixelsV1e.cs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,11 @@ public ConfigureNeuropixelsV1e()
9090
/// Gets or sets the path to the gain calibration file.
9191
/// </summary>
9292
/// <remarks>
93-
/// Each probe must be provided with a gain calibration file that contains calibration data
94-
/// specific to each probe. This file is mandatory for accurate recordings.
93+
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
94+
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
95+
/// 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.
9598
/// </remarks>
9699
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
97100
[Description("Path to the Neuropixels 1.0 gain calibration file.")]
@@ -102,8 +105,11 @@ public ConfigureNeuropixelsV1e()
102105
/// Gets or sets the path to the ADC calibration file.
103106
/// </summary>
104107
/// <remarks>
105-
/// Each probe must be provided with an ADC calibration file that contains calibration data
106-
/// specific to each probe. This file is mandatory for accurate recordings.
108+
/// Each probe must be provided with an ADC calibration file that contains probe-specific hardware settings that is
109+
/// created by IMEC during factory calibration. These files are used to set internal bias currents, correct for ADC
110+
/// 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.
107113
/// </remarks>
108114
[FileNameFilter("ADC calibration files (*_ADCCalibration.csv)|*_ADCCalibration.csv")]
109115
[Description("Path to the Neuropixels 1.0 ADC calibration file.")]

OpenEphys.Onix1/ConfigureNeuropixelsV2e.cs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,11 @@ public ConfigureNeuropixelsV2e()
4141
/// Gets or sets the path to the gain calibration file for Probe A.
4242
/// </summary>
4343
/// <remarks>
44-
/// Each probe must be provided with a gain calibration file that contains calibration data
45-
/// specific to each probe. This file is mandatory for accurate recordings.
44+
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
45+
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
46+
/// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
47+
/// If you have lost track of the gain calibration file for your probe, you can email IMEC at [email protected]
48+
/// with the probe serial number to retrieve a new copy.
4649
/// </remarks>
4750
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
4851
[Description("Path to the gain calibration file for probe A.")]
@@ -60,8 +63,11 @@ public ConfigureNeuropixelsV2e()
6063
/// Gets or sets the path to the gain calibration file for Probe B.
6164
/// </summary>
6265
/// <remarks>
63-
/// Each probe must be provided with a gain calibration file that contains calibration data
64-
/// specific to each probe. This file is mandatory for accurate recordings.
66+
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
67+
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
68+
/// 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.
6571
/// </remarks>
6672
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
6773
[Description("Path to the gain calibration file for probe B.")]

OpenEphys.Onix1/ConfigureNeuropixelsV2eBeta.cs

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,11 @@ public ConfigureNeuropixelsV2eBeta()
5151
/// Gets or sets the path to the gain calibration file for Probe A.
5252
/// </summary>
5353
/// <remarks>
54-
/// Each probe must be provided with a gain calibration file that contains calibration data
55-
/// specific to each probe. This file is mandatory for accurate recordings.
54+
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
55+
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
56+
/// 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.
5659
/// </remarks>
5760
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
5861
[Description("Path to the gain calibration file for probe A.")]
@@ -70,8 +73,11 @@ public ConfigureNeuropixelsV2eBeta()
7073
/// Gets or sets the path to the gain calibration file for Probe B.
7174
/// </summary>
7275
/// <remarks>
73-
/// Each probe must be provided with a gain calibration file that contains calibration data
74-
/// specific to each probe. This file is mandatory for accurate recordings.
76+
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
77+
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
78+
/// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
79+
/// If you have lost track of the gain calibration file for your probe, you can email IMEC at [email protected]
80+
/// with the probe serial number to retrieve a new copy.
7581
/// </remarks>
7682
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
7783
[Description("Path to the gain calibration file for probe B.")]

0 commit comments

Comments
 (0)