From 8e7f59e3ff426e2c1e3cf0357426ccbe2f288339 Mon Sep 17 00:00:00 2001 From: cjsha <36574350+cjsha@users.noreply.github.com> Date: Wed, 18 Dec 2024 12:10:15 -0500 Subject: [PATCH] Edits to XML comments: issues 355-357 (#382) * Edits to XML comments: issues 355-357 - remove hyphens used for unit prefixes - "microvolts" -> "millivolts" for DCData - "NeuropixelsV2e headstage" to "Intan Rhs2116 bioacquisition chip" in Rhs2116Data (like how it's done in Rhd2164Data summary) - add "" in Rhd2164Data summary (like how it's done in Rhs2116Data summary) - add description attribute to Rhs2116Data class - remove "for small animals" and combine 1st & 2nd sentences in summaries for all ConfigureXyzHeadstage classes * Review feedback --- OpenEphys.Onix1/ConfigureHeadstage64.cs | 13 +++++++------ OpenEphys.Onix1/ConfigureHeadstageNric1384.cs | 8 ++++---- OpenEphys.Onix1/ConfigureHeadstageRhs2116.cs | 8 ++++---- OpenEphys.Onix1/ConfigureNeuropixelsV1eHeadstage.cs | 4 ++-- OpenEphys.Onix1/ConfigureNeuropixelsV1fHeadstage.cs | 6 +++--- .../ConfigureNeuropixelsV2eBetaHeadstage.cs | 4 ++-- OpenEphys.Onix1/ConfigureNeuropixelsV2eHeadstage.cs | 4 ++-- OpenEphys.Onix1/Rhd2164Data.cs | 5 +++-- OpenEphys.Onix1/Rhs2116Data.cs | 4 +++- OpenEphys.Onix1/Rhs2116DataFrame.cs | 6 +++--- 10 files changed, 33 insertions(+), 29 deletions(-) diff --git a/OpenEphys.Onix1/ConfigureHeadstage64.cs b/OpenEphys.Onix1/ConfigureHeadstage64.cs index 08e9607..1507f45 100644 --- a/OpenEphys.Onix1/ConfigureHeadstage64.cs +++ b/OpenEphys.Onix1/ConfigureHeadstage64.cs @@ -8,9 +8,9 @@ namespace OpenEphys.Onix1 /// Configures an ONIX headstage-64 on the specified port. /// /// - /// Headstage-64 is a 1.5g serialized, multifunction headstage for small animals. This headstage is - /// designed to function with passive probes such as tetrode microdrives, silicon arrays, EEG/ECOG arrays, - /// etc. It provides the following features: + /// Headstage-64 is a 1.5g serialized, multifunction headstage designed to function with passive + /// probes such as tetrode microdrives, silicon arrays, EEG/ECOG arrays, etc. It provides the + /// following features: /// /// 64 analog ephys channels and 3 auxiliary channels sampled at 30 kHz per /// channel. @@ -32,9 +32,10 @@ public class ConfigureHeadstage64 : MultiDeviceFactory /// Initializes a new instance of the class. /// /// - /// Headstage-64 is a 1.5g serialized, multifunction headstage for small animals. This headstage is designed to function - /// with tetrode microdrives. Alternatively it can be used with other passive probes (e.g. silicon arrays, EEG/ECOG arrays, - /// etc.). It provides the following features on the headstage: + /// Headstage-64 is a 1.5g serialized, multifunction headstage designed to function with + /// tetrode microdrives. Alternatively it can be used with other passive probes (e.g. + /// silicon arrays, EEG/ECOG arrays, etc.). It provides the following features on the + /// headstage: /// /// 64 analog ephys channels and 3 auxiliary channels sampled at 30 kHz per channel. /// A Bno055 9-axis IMU for real-time, 3D orientation tracking. diff --git a/OpenEphys.Onix1/ConfigureHeadstageNric1384.cs b/OpenEphys.Onix1/ConfigureHeadstageNric1384.cs index 0d053d6..8c3645c 100644 --- a/OpenEphys.Onix1/ConfigureHeadstageNric1384.cs +++ b/OpenEphys.Onix1/ConfigureHeadstageNric1384.cs @@ -8,10 +8,10 @@ namespace OpenEphys.Onix1 /// Configures a Nric1384 headstage on the specified port. /// /// - /// The Nric1384 Headstage is a 2.5g serialized, multifunction headstage for small animals built around the - /// IMEC Nric1384 bioacquisition chip. This headstage is designed to function with passive probes of the - /// user's choosing (e.g. silicon probe arrays, high-density tetrode drives, etc). It provides the - /// following features: + /// The Nric1384 Headstage is a 2.5g serialized, multifunction headstage built around the IMEC + /// Nric1384 bioacquisition chip and designed to function with passive probes of + /// the user's choosing (e.g. silicon probe arrays, high-density tetrode drives, etc). It + /// provides the following features: /// /// 384 analog ephys channels sampled at 30 kHz per channel and exposed via an array of /// 12x ultra-high density Molex 203390-0323 quad-row connectors. diff --git a/OpenEphys.Onix1/ConfigureHeadstageRhs2116.cs b/OpenEphys.Onix1/ConfigureHeadstageRhs2116.cs index 9d20d5a..8fa417e 100644 --- a/OpenEphys.Onix1/ConfigureHeadstageRhs2116.cs +++ b/OpenEphys.Onix1/ConfigureHeadstageRhs2116.cs @@ -8,10 +8,10 @@ namespace OpenEphys.Onix1 /// Configures an ONIX Rhs2116 Headstage on the specified port. /// /// - /// The Rhs2116 Headstage is a serialized headstage for small animals with 32 bi-directional channels - /// which each can be used to deliver electrical stimuli. The Rhs2116 Headstage can be used with passive - /// probes (e.g. silicon arrays, EEG/ECOG arrays, etc) using a 36-Channel Omnetics EIB. It provides the - /// following features: + /// The Rhs2116 Headstage is a serialized headstage with 32 bi-directional channels that are + /// independently configurable to record electrophysiological signals or deliver electrical + /// stimuli. The Rhs2116 Headstage can be used with passive probes (e.g. silicon arrays, + /// EEG/ECOG arrays, etc) using a 36-Channel Omnetics EIB. It provides the following features: /// /// Two, synchronized Rhs2116 ICs for a combined 32 bidirectional ephys channels. /// Real-time control of stimulation sequences. diff --git a/OpenEphys.Onix1/ConfigureNeuropixelsV1eHeadstage.cs b/OpenEphys.Onix1/ConfigureNeuropixelsV1eHeadstage.cs index 3257067..97c8c00 100644 --- a/OpenEphys.Onix1/ConfigureNeuropixelsV1eHeadstage.cs +++ b/OpenEphys.Onix1/ConfigureNeuropixelsV1eHeadstage.cs @@ -8,8 +8,8 @@ namespace OpenEphys.Onix1 /// Configures a NeuropixelsV1e headstage on the specified port. /// /// - /// The NeuropixelsV1e Headstage is a 0.68g serialized, multifunction headstage for small animals. This - /// headstage is designed to function with IMEC Neuropixels V1 probes. It provides the following features: + /// The NeuropixelsV1e Headstage is a 0.68g serialized, multifunction headstage designed to + /// function with IMEC Neuropixels V1 probes. It provides the following features: /// /// Support for a single IMEC Neuropixels 1.0 probe that features: /// diff --git a/OpenEphys.Onix1/ConfigureNeuropixelsV1fHeadstage.cs b/OpenEphys.Onix1/ConfigureNeuropixelsV1fHeadstage.cs index 2000da2..ce74277 100644 --- a/OpenEphys.Onix1/ConfigureNeuropixelsV1fHeadstage.cs +++ b/OpenEphys.Onix1/ConfigureNeuropixelsV1fHeadstage.cs @@ -8,10 +8,10 @@ namespace OpenEphys.Onix1 /// Configures a NeuropixelsV1f headstage on the specified port. /// /// - /// The NeuropixelsVf Headstage is a 1g serialized, multifunction headstage for small animals. This - /// headstage is designed to function with IMEC Neuropixels V1 probes. It provides the following features: + /// The NeuropixelsVf Headstage is a 1g serialized, multifunction headstage designed to function + /// with IMEC Neuropixels V1 probes. It provides the following features: /// - /// Support for a 2x IMEC Neuropixels 1.0 probes, each of which features: + /// Support for up to 2x IMEC Neuropixels 1.0 probes, each of which features: /// /// A single 1 cm long shank probe with a 70 x 24 µm shank cross-section. /// 960-electrode low-impedance TiN electrodes. diff --git a/OpenEphys.Onix1/ConfigureNeuropixelsV2eBetaHeadstage.cs b/OpenEphys.Onix1/ConfigureNeuropixelsV2eBetaHeadstage.cs index 62477db..92f7d9b 100644 --- a/OpenEphys.Onix1/ConfigureNeuropixelsV2eBetaHeadstage.cs +++ b/OpenEphys.Onix1/ConfigureNeuropixelsV2eBetaHeadstage.cs @@ -7,8 +7,8 @@ namespace OpenEphys.Onix1 /// Configures a NeuropixelsV2eBeta headstage on the specified port. /// /// - /// The NeuropixelsV2e-Beta Headstage is a 0.64g serialized, multifunction headstage for small animals. This - /// headstage is designed to function with IMEC Neuropixels V2Beta probes. It provides the following features: + /// The NeuropixelsV2eBeta Headstage is a 0.64g serialized, multifunction headstage designed to + /// function with IMEC Neuropixels V2Beta probes. It provides the following features: /// /// Support for dual IMEC Neuropixels 2.0-Beta probes, each of which features: /// diff --git a/OpenEphys.Onix1/ConfigureNeuropixelsV2eHeadstage.cs b/OpenEphys.Onix1/ConfigureNeuropixelsV2eHeadstage.cs index 2a1c202..0bf066c 100644 --- a/OpenEphys.Onix1/ConfigureNeuropixelsV2eHeadstage.cs +++ b/OpenEphys.Onix1/ConfigureNeuropixelsV2eHeadstage.cs @@ -7,8 +7,8 @@ namespace OpenEphys.Onix1 /// Configures a NeuropixelsV2e headstage on the specified port. /// /// - /// The NeuropixelsV2e Headstage is a 0.64g serialized, multifunction headstage for small animals. This - /// headstage is designed to function with IMEC Neuropixels V2 probes. It provides the following features: + /// The NeuropixelsV2e Headstage is a 0.64g serialized, multifunction headstage designed to + /// function with IMEC Neuropixels V2 probes. It provides the following features: /// /// Support for dual IMEC Neuropixels 2.0 probes, each of which features: /// diff --git a/OpenEphys.Onix1/Rhd2164Data.cs b/OpenEphys.Onix1/Rhd2164Data.cs index 3f3522f..0507642 100644 --- a/OpenEphys.Onix1/Rhd2164Data.cs +++ b/OpenEphys.Onix1/Rhd2164Data.cs @@ -10,13 +10,14 @@ namespace OpenEphys.Onix1 { /// - /// Produces a sequence of electrophysiology data frames from an Intan Rhd2164 bioacquisition chip. + /// Produces a sequence of objects with data from an Intan + /// Rhd2164 bioacquisition chip. /// /// /// This data IO operator must be linked to an appropriate configuration, such as a , using a shared DeviceName. /// - [Description("Produces a sequence of electrophysiology data frames from an Intan Rhd2164 bioacquisition chip.")] + [Description("Produces a sequence of Rhd2164DataFrame objects with data from an Intan Rhd2164 bioacquisition chip.")] public class Rhd2164Data : Source { /// diff --git a/OpenEphys.Onix1/Rhs2116Data.cs b/OpenEphys.Onix1/Rhs2116Data.cs index 58d5a36..fdd8d0f 100644 --- a/OpenEphys.Onix1/Rhs2116Data.cs +++ b/OpenEphys.Onix1/Rhs2116Data.cs @@ -10,12 +10,14 @@ namespace OpenEphys.Onix1 { /// - /// Produces a sequence of objects from a NeuropixelsV2e headstage. + /// Produces a sequence of objects with data from an Intan + /// Rhs2116 bioacquisition chip. /// /// /// This data IO operator must be linked to an appropriate configuration, such as a , using a shared DeviceName. /// + [Description("Produces a sequence of Rhs2116DataFrame objects with data from an Intan Rhs2116 bioacquisition chip.")] public class Rhs2116Data : Source { /// diff --git a/OpenEphys.Onix1/Rhs2116DataFrame.cs b/OpenEphys.Onix1/Rhs2116DataFrame.cs index ac292fd..895c64d 100644 --- a/OpenEphys.Onix1/Rhs2116DataFrame.cs +++ b/OpenEphys.Onix1/Rhs2116DataFrame.cs @@ -29,9 +29,9 @@ public Rhs2116DataFrame(ulong[] clock, ulong[] hubClock, Mat amplifierData, Mat /// Each row corresponds to a channel. Each column corresponds to a sample whose time is indicated by /// the corresponding element and . /// Samples are 16-bits each and are represented using unsigned 16-bit integers. To convert to - /// micro-volts, the following equation can be used: + /// microvolts, the following equation can be used: /// - /// V_electrode (uV) = 0.195 µV × (ADC result – 32768) + /// V_electrode (µV) = 0.195 µV × (ADC result – 32768) /// /// public Mat AmplifierData { get; } @@ -43,7 +43,7 @@ public Rhs2116DataFrame(ulong[] clock, ulong[] hubClock, Mat amplifierData, Mat /// Each row corresponds to a channel. Each column corresponds to a sample whose time is indicated by /// the corresponding element and . /// Samples are 10-bits each and are represented using unsigned 16-bit integers. To convert to - /// micro-volts, the following equation can be used: + /// millivolts, the following equation can be used: /// /// V_electrode (mV) = -19.23 mV × (ADC result – 512) ///