Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve description of neuropixels calibration files #215

Merged
merged 2 commits into from
Aug 20, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions OpenEphys.Onix1/ConfigureNeuropixelsV1e.cs
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,11 @@ 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.
/// 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 Neuropixels 1.0 gain calibration file.")]
Expand All @@ -102,8 +105,11 @@ 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.
/// 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. If you have lost track of the ADC calibration file for your probe, you can
/// email IMEC at [email protected] with the probe serial number to retrieve a new copy.
/// </remarks>
[FileNameFilter("ADC calibration files (*_ADCCalibration.csv)|*_ADCCalibration.csv")]
[Description("Path to the Neuropixels 1.0 ADC calibration file.")]
Expand Down
14 changes: 10 additions & 4 deletions OpenEphys.Onix1/ConfigureNeuropixelsV2e.cs
Original file line number Diff line number Diff line change
Expand Up @@ -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.")]
Expand All @@ -60,8 +63,11 @@ 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.
/// 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.")]
Expand Down
14 changes: 10 additions & 4 deletions OpenEphys.Onix1/ConfigureNeuropixelsV2eBeta.cs
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,11 @@ 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.
/// 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.")]
Expand All @@ -70,8 +73,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.")]
Expand Down