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.

Sign up for GitHub

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

Edits to XML comments: issues 355-357 #382

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Edits to XML comments: issues 355-357 #382

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
652784a
Edits to XML comments: issues 355-357
cjsha Dec 10, 2024
085998a
Review feedback
cjsha Dec 10, 2024
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
13 changes: 7 additions & 6 deletions OpenEphys.Onix1/ConfigureHeadstage64.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ namespace OpenEphys.Onix1
/// Configures an ONIX headstage-64 on the specified port.
/// </summary>
/// <remarks>
/// 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:
/// <list type="bullet">
/// <item><description>64 analog ephys channels and 3 auxiliary channels sampled at 30 kHz per
/// channel.</description></item>
Expand All @@ -32,9 +32,10 @@ public class ConfigureHeadstage64 : MultiDeviceFactory
/// Initializes a new instance of the <see cref="ConfigureHeadstage64"/> class.
/// </summary>
/// <remarks>
/// 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:
/// <list type="bullet">
/// <item><description>64 analog ephys channels and 3 auxiliary channels sampled at 30 kHz per channel.</description></item>
/// <item><description>A Bno055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
Expand Down
8 changes: 4 additions & 4 deletions OpenEphys.Onix1/ConfigureHeadstageNric1384.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ namespace OpenEphys.Onix1
/// Configures a Nric1384 headstage on the specified port.
/// </summary>
/// <remarks>
/// 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:
/// <list type="bullet">
/// <item><description>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. </description></item>
Expand Down
8 changes: 4 additions & 4 deletions OpenEphys.Onix1/ConfigureHeadstageRhs2116.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ namespace OpenEphys.Onix1
/// Configures an ONIX Rhs2116 Headstage on the specified port.
/// </summary>
/// <remarks>
/// 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:
cjsha marked this conversation as resolved.
Show resolved Hide resolved
/// <list type="bullet">
/// <item><description>Two, synchronized Rhs2116 ICs for a combined 32 bidirectional ephys channels.</description></item>
/// <item><description>Real-time control of stimulation sequences.</description></item>
Expand Down
4 changes: 2 additions & 2 deletions OpenEphys.Onix1/ConfigureNeuropixelsV1eHeadstage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ namespace OpenEphys.Onix1
/// Configures a NeuropixelsV1e headstage on the specified port.
/// </summary>
/// <remarks>
/// 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:
/// <list type="bullet">
/// <item><description>Support for a single IMEC Neuropixels 1.0 probe that features:
/// <list type="bullet">
Expand Down
4 changes: 2 additions & 2 deletions OpenEphys.Onix1/ConfigureNeuropixelsV1fHeadstage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ namespace OpenEphys.Onix1
/// Configures a NeuropixelsV1f headstage on the specified port.
/// </summary>
/// <remarks>
/// 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:
/// <list type="bullet">
/// <item><description>Support for a 2x IMEC Neuropixels 1.0 probes, each of which features:
cjsha marked this conversation as resolved.
Show resolved Hide resolved
/// <list type="bullet">
Expand Down
4 changes: 2 additions & 2 deletions OpenEphys.Onix1/ConfigureNeuropixelsV2eBetaHeadstage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ namespace OpenEphys.Onix1
/// Configures a NeuropixelsV2eBeta headstage on the specified port.
/// </summary>
/// <remarks>
/// 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 NeuropixelsV2e-Beta Headstage is a 0.64g serialized, multifunction headstage designed to
/// function with IMEC Neuropixels V2Beta probes. It provides the following features:
cjsha marked this conversation as resolved.
Show resolved Hide resolved
/// <list type="bullet">
/// <item><description>Support for dual IMEC Neuropixels 2.0-Beta probes, each of which features:
/// <list type="bullet">
Expand Down
4 changes: 2 additions & 2 deletions OpenEphys.Onix1/ConfigureNeuropixelsV2eHeadstage.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ namespace OpenEphys.Onix1
/// Configures a NeuropixelsV2e headstage on the specified port.
/// </summary>
/// <remarks>
/// 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:
/// <list type="bullet">
/// <item><description>Support for dual IMEC Neuropixels 2.0 probes, each of which features:
/// <list type="bullet">
Expand Down
5 changes: 3 additions & 2 deletions OpenEphys.Onix1/Rhd2164Data.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@
namespace OpenEphys.Onix1
{
/// <summary>
/// Produces a sequence of electrophysiology data frames from an Intan Rhd2164 bioacquisition chip.
/// Produces a sequence of <see cref="Rhd2164DataFrame"/> objects with data from an Intan
/// Rhd2164 bioacquisition chip.
/// </summary>
/// <remarks>
/// This data IO operator must be linked to an appropriate configuration, such as a <see
/// cref="ConfigureRhd2164"/>, using a shared <c>DeviceName</c>.
/// </remarks>
[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<Rhd2164DataFrame>
{
/// <inheritdoc cref = "SingleDeviceFactory.DeviceName"/>
Expand Down
4 changes: 3 additions & 1 deletion OpenEphys.Onix1/Rhs2116Data.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@
namespace OpenEphys.Onix1
{
/// <summary>
/// Produces a sequence of <see cref="Rhs2116DataFrame"/> objects from a NeuropixelsV2e headstage.
/// Produces a sequence of <see cref="Rhs2116DataFrame"/> objects with data from an Intan
/// Rhs2116 bioacquisition chip.
/// </summary>
/// <remarks>
/// This data IO operator must be linked to an appropriate configuration, such as a <see
/// cref="ConfigureRhs2116"/>, using a shared <c>DeviceName</c>.
/// </remarks>
[Description("Produces a sequence of Rhs2116DataFrame objects with data from an Intan Rhs2116 bioacquisition chip.")]
public class Rhs2116Data : Source<Rhs2116DataFrame>
{
/// <inheritdoc cref = "SingleDeviceFactory.DeviceName"/>
Expand Down
6 changes: 3 additions & 3 deletions OpenEphys.Onix1/Rhs2116DataFrame.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <see cref="DataFrame.Clock"/> and <see cref="DataFrame.HubClock"/>.
/// 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:
/// <code>
/// V_electrode (uV) = 0.195 µV × (ADC result – 32768)
/// V_electrode (µV) = 0.195 µV × (ADC result – 32768)
/// </code>
/// </remarks>
public Mat AmplifierData { get; }
Expand All @@ -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 <see cref="DataFrame.Clock"/> and <see cref="DataFrame.HubClock"/>.
/// 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:
/// <code>
/// V_electrode (mV) = -19.23 mV × (ADC result – 512)
/// </code>
Expand Down
Loading