diff --git a/OpenEphys.Onix1/ContextTask.cs b/OpenEphys.Onix1/ContextTask.cs index dfa0100..1982085 100644 --- a/OpenEphys.Onix1/ContextTask.cs +++ b/OpenEphys.Onix1/ContextTask.cs @@ -13,11 +13,11 @@ namespace OpenEphys.Onix1 /// Encapsulates a single ONI context and orchestrates interaction with ONI-compliant hardware. /// /// - /// The Open Neuro Interface (ONI) hardware - /// specification and API describe a general purpose acquisition system architecture and programming + /// The Open Neuro Interface (ONI) + /// specification describe a general purpose acquisition system architecture and programming /// interface for communication with a host PC. One requirement of ONI is that a host application must /// hold a "context" that contains handles for hardware communication, data acquisition parameters, etc. - /// for a particular hardware controller, such as the ONIX PCIe card. fulfills + /// for a particular ONI Controller, such as the ONIX PCIe card. fulfills /// this role for this library. Additionally, once data acquisition is started by the operator, performs the following: /// @@ -31,7 +31,7 @@ namespace OpenEphys.Onix1 /// Additionally, this operator exposes important information about the underlying ONI hardware such as /// the device table, clock rates, and block read and write sizes. In summary, forms a complete interface for all hardware interaction within the library: all - /// physical interaction with the ONIX system passes through this class. + /// physical interaction with the ONIX system ultimately passes through this class. /// public class ContextTask : IDisposable { @@ -82,11 +82,10 @@ public class ContextTask : IDisposable /// A string specifying the device driver used to control hardware. /// The index of the host interconnect between the ONI controller and host /// computer. For instance, 0 could correspond to a particular PCIe slot or USB port as enumerated by - /// the operating system and translated by an ONI - /// device driver translator. A value of -1 will attempt to open the default hardware index and - /// is useful if there is only a single ONI controller managed by the specified in the host computer. + /// the operating system and translated by an ONI + /// Device Driver Translator. A value of -1 will attempt to open the default hardware index and is + /// useful if there is only a single ONI controller managed by the specified + /// in the host computer. internal ContextTask(string driver, int index) { groupedFrames = frameReceived.GroupBy(frame => frame.DeviceAddress).Replay(); @@ -134,8 +133,9 @@ internal void Reset() /// Gets the acquisition clock rate in Hz. /// /// - /// This property describes the frequency of ONI controller's acquisition clock, which is used to - /// generate the Clock counter value included in all data frames + /// This property describes the frequency of the ONI Controller's Acquisition Clock, which is used + /// to generate the Clock counter value included in all data frames /// produced by Data IO operators in this library (e.g. or ). The value of this property is determined during hardware initialization. /// @@ -146,10 +146,10 @@ internal void Reset() /// /// /// This number describes the the size, in bytes, of the largest ONI Data Frame - /// produced by any device within the current device table that generates data. Therefore, it also - /// defines the lower bound for the value of . The value of this property - /// is determined during hardware initialization. + /// href="https://open-ephys.github.io/ONI/">ONI Data Frame produced by any device within the + /// current device table that generates data. Therefore, it also defines the lower bound for the value + /// of . The value of this property is determined during hardware + /// initialization. /// public uint MaxReadFrameSize { get; private set; } @@ -158,10 +158,10 @@ internal void Reset() /// /// /// This number describes the the size, in bytes, of the largest ONI Data Frame - /// consumed by any device within the current device table that accepts data. Therefore, it also - /// defines the lower bound for the value of . The value of this property - /// is determined during hardware initialization. + /// href="https://open-ephys.github.io/ONI/">ONI Data Frame consumed by any device within the + /// current device table that accepts data. Therefore, it also defines the lower bound for the value + /// of . The value of this property is determined during hardware + /// initialization. /// public uint MaxWriteFrameSize { get; private set; } @@ -169,26 +169,21 @@ internal void Reset() /// Gets the device table containing the device hierarchy of the acquisition system. /// /// - /// This dictionary provides access to the ONI Device Table, which maps - /// a set of fully-qualified ONI Device - /// Addresses to a corresponding set of ONI Device - /// Descriptors. The value of this property is determined during hardware initialization. + /// This dictionary provides access to the ONI + /// Device Table, which maps a set of fully-qualified Device Addresses to a corresponding set of + /// Device Descriptors. The value of this property is determined during hardware initialization. /// public Dictionary DeviceTable { get; private set; } internal IObservable> GroupedFrames => groupedFrames; /// - /// Gets the sequence of ONI Data Frames - /// produced by a particular device. + /// Gets the sequence of ONI Data Frames produced + /// by a particular device. /// /// The fully-qualified ONI Device - /// Address that will produce the frame sequence. + /// href="https://open-ephys.github.io/ONI/">ONI Device Address of the Device that will produce + /// the Data Frame sequence. /// The frame sequence produced by the device at address . public IObservable GetDeviceFrames(uint deviceAddress) diff --git a/OpenEphys.Onix1/CreateContext.cs b/OpenEphys.Onix1/CreateContext.cs index db01d6d..2c33081 100644 --- a/OpenEphys.Onix1/CreateContext.cs +++ b/OpenEphys.Onix1/CreateContext.cs @@ -38,10 +38,9 @@ public class CreateContext /// /// /// For instance, 0 could correspond to a particular PCIe slot or USB port as enumerated by the - /// operating system and translated by an ONI - /// device driver translator. A value of -1 will attempt to open the default index and is useful - /// if there is only a single ONI controller managed by the specified selected in + /// operating system and translated by an ONI + /// Device Driver Translator. A value of -1 will attempt to open the default index and is useful if + /// there is only a single ONI controller managed by the specified selected in /// the host computer. /// [Description("The index of the host interconnect between the ONI controller and host computer.")] diff --git a/OpenEphys.Onix1/DeviceFactory.cs b/OpenEphys.Onix1/DeviceFactory.cs index 73bee4b..f72b2ac 100644 --- a/OpenEphys.Onix1/DeviceFactory.cs +++ b/OpenEphys.Onix1/DeviceFactory.cs @@ -61,7 +61,7 @@ internal SingleDeviceFactory(Type deviceType) /// /// /// This is a fully-qualified numerical hardware address of a device within the device table produced - /// by an Open Neuro Interface (ONI) compliant + /// by an ONI-compliant /// acquisition system. This value is usually not set manually, but is assigned in a to correspond to a fixed address with a piece of hardware such as a /// headstage. This address is used for hardware communication. @@ -75,7 +75,7 @@ internal SingleDeviceFactory(Type deviceType) /// /// /// This type provides a device identity to each device within the device table produced by an Open Neuro Interface (ONI) compliant acquisition + /// href="https://open-ephys.github.io/ONI/">ONI-compliant acquisition /// system. /// [Browsable(false)] diff --git a/OpenEphys.Onix1/StartAcquisition.cs b/OpenEphys.Onix1/StartAcquisition.cs index 078f540..88a90d2 100644 --- a/OpenEphys.Onix1/StartAcquisition.cs +++ b/OpenEphys.Onix1/StartAcquisition.cs @@ -17,7 +17,7 @@ namespace OpenEphys.Onix1 /// required actions on one or more ContextTasks provided in its input /// sequence. Once acquisition is started, devices managed by a particular will /// start to produce data in a format called an ONI Data Frame. The output + /// href="https://open-ephys.github.io/ONI/">ONI Data Frame. The output /// sequence of this operator is therefore a , where /// /// @@ -35,7 +35,7 @@ namespace OpenEphys.Onix1 /// /// These pre-sorted frame sequences can be interpreted by downstream Data I/O operators (e.g. or ) that convert ONI Data Frames into + /// href="https://open-ephys.github.io/ONI/">ONI Data Frames into /// data types that are are more amenable to processing within Bonsai workflows. /// [Description("Starts data acquisition and frame distribution on a ContextTask.")]