Skip to content

Commit

Permalink
Remove links to specific pages of ONI docs (#415)
Browse files Browse the repository at this point in the history 
* Remove links to specific pages of ONI docs

Only leave links with functional redirects to the main page.

* Link all oni-docs references to oni home page

* Removed ONI specification link text false advertising

- ONI is now the only linked part of the text since the link leads to the top level ONI specification
- ONI keywords are capitalized

---------

Co-authored-by: jonnew <[email protected]>
  • Loading branch information
@cjsha @jonnew
cjsha and jonnew authored Feb 22, 2025
1 parent 4a6fec3 commit e4d8998
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 39 deletions.
57 changes: 26 additions & 31 deletions OpenEphys.Onix1/ContextTask.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ namespace OpenEphys.Onix1
/// Encapsulates a single ONI context and orchestrates interaction with ONI-compliant hardware.
/// </summary>
/// <remarks>
/// The <see href="https://open-ephys.github.io/ONI/">Open Neuro Interface (ONI)</see> hardware
/// specification and API describe a general purpose acquisition system architecture and programming
/// The <see href="https://open-ephys.github.io/ONI/">Open Neuro Interface (ONI)</see>
/// 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. <see cref="ContextTask"/> fulfills
/// for a particular ONI Controller, such as the ONIX PCIe card. <see cref="ContextTask"/> fulfills
/// this role for this library. Additionally, once data acquisition is started by the <see
/// cref="StartAcquisition"/> operator, <see cref="ContextTask"/> performs the following:
/// <list type="bullet">
Expand All @@ -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. <strong>In summary, <see
/// cref="ContextTask"/> forms a complete interface for all hardware interaction within the library: all
/// physical interaction with the ONIX system passes through this class.</strong>
/// physical interaction with the ONIX system ultimately passes through this class.</strong>
/// </remarks>
public class ContextTask : IDisposable
{
Expand Down Expand Up @@ -82,11 +82,10 @@ public class ContextTask : IDisposable
/// <param name="driver"> A string specifying the device driver used to control hardware. </param>
/// <param name="index">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 <see
/// href="https://open-ephys.github.io/ONI/api/liboni/driver-translators/index.html#drivers">ONI
/// device driver translator</see>. 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 <paramref
/// name="driver"/> in the host computer.</param>
/// the operating system and translated by an <see href="https://open-ephys.github.io/ONI/">ONI</see>
/// 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 <paramref name="driver"/>
/// in the host computer.</param>
internal ContextTask(string driver, int index)
{
groupedFrames = frameReceived.GroupBy(frame => frame.DeviceAddress).Replay();
Expand Down Expand Up @@ -134,8 +133,9 @@ internal void Reset()
/// Gets the acquisition clock rate in Hz.
/// </summary>
/// <remarks>
/// This property describes the frequency of ONI controller's acquisition clock, which is used to
/// generate the <see cref="DataFrame.Clock">Clock</see> counter value included in all data frames
/// This property describes the frequency of the <see
/// href="https://open-ephys.github.io/ONI/">ONI</see> Controller's Acquisition Clock, which is used
/// to generate the <see cref="DataFrame.Clock">Clock</see> counter value included in all data frames
/// produced by Data IO operators in this library (e.g. <see cref="NeuropixelsV1eData"/> or <see
/// cref="Bno055Data"/>). The value of this property is determined during hardware initialization.
/// </remarks>
Expand All @@ -146,10 +146,10 @@ internal void Reset()
/// </summary>
/// <remarks>
/// This number describes the the size, in bytes, of the largest <see
/// href="https://open-ephys.github.io/ONI/hw-spec/controller.html#data-frames">ONI Data Frame</see>
/// produced by any device within the current device table that generates data. Therefore, it also
/// defines the lower bound for the value of <see cref="BlockReadSize"/>. The value of this property
/// is determined during hardware initialization.
/// href="https://open-ephys.github.io/ONI/">ONI</see> 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 <see cref="BlockReadSize"/>. The value of this property is determined during hardware
/// initialization.
/// </remarks>
public uint MaxReadFrameSize { get; private set; }

Expand All @@ -158,37 +158,32 @@ internal void Reset()
/// </summary>
/// <remarks>
/// This number describes the the size, in bytes, of the largest <see
/// href="https://open-ephys.github.io/ONI/hw-spec/controller.html#data-frames">ONI Data Frame</see>
/// consumed by any device within the current device table that accepts data. Therefore, it also
/// defines the lower bound for the value of <see cref="BlockWriteSize"/>. The value of this property
/// is determined during hardware initialization.
/// href="https://open-ephys.github.io/ONI/">ONI</see> 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 <see cref="BlockWriteSize"/>. The value of this property is determined during hardware
/// initialization.
/// </remarks>
public uint MaxWriteFrameSize { get; private set; }

/// <summary>
/// Gets the device table containing the device hierarchy of the acquisition system.
/// </summary>
/// <remarks>
/// This dictionary provides access to the <see
/// href="https://open-ephys.github.io/ONI/hw-spec/dev_table.html">ONI Device Table</see>, which maps
/// a set of fully-qualified <see
/// href="https://open-ephys.github.io/ONI/hw-spec/dev_table.html#dev-address"> ONI Device
/// Addresses</see> to a corresponding set of <see
/// href="https://open-ephys.github.io/ONI/hw-spec/devices.html#dev-desc">ONI Device
/// Descriptors</see>. The value of this property is determined during hardware initialization.
/// This dictionary provides access to the <see href="https://open-ephys.github.io/ONI/">ONI</see>
/// 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.
/// </remarks>
public Dictionary<uint, oni.Device> DeviceTable { get; private set; }

internal IObservable<IGroupedObservable<uint, oni.Frame>> GroupedFrames => groupedFrames;

/// <summary>
/// Gets the sequence of <see
/// href="https://open-ephys.github.io/ONI/hw-spec/controller.html#data-frames">ONI Data Frames</see>
/// produced by a particular device.
/// Gets the sequence of <see href="https://open-ephys.github.io/ONI/">ONI</see> Data Frames produced
/// by a particular device.
/// </summary>
/// <param name="deviceAddress">The fully-qualified <see
/// href="https://open-ephys.github.io/ONI/hw-spec/dev_table.html#dev-address"> ONI Device
/// Address</see> that will produce the frame sequence.</param>
/// href="https://open-ephys.github.io/ONI/">ONI</see> Device Address of the Device that will produce
/// the Data Frame sequence.</param>
/// <returns>The frame sequence produced by the device at address <paramref
/// name="deviceAddress"/>.</returns>
public IObservable<oni.Frame> GetDeviceFrames(uint deviceAddress)
Expand Down
7 changes: 3 additions & 4 deletions OpenEphys.Onix1/CreateContext.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,9 @@ public class CreateContext
/// </summary>
/// <remarks>
/// For instance, 0 could correspond to a particular PCIe slot or USB port as enumerated by the
/// operating system and translated by an <see
/// href="https://open-ephys.github.io/ONI/api/liboni/driver-translators/index.html#drivers">ONI
/// device driver translator</see>. 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 <see cref="Driver"/> in
/// operating system and translated by an <see href="https://open-ephys.github.io/ONI/">ONI</see>
/// 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 <see cref="Driver"/> in
/// the host computer.
/// </remarks>
[Description("The index of the host interconnect between the ONI controller and host computer.")]
Expand Down
4 changes: 2 additions & 2 deletions OpenEphys.Onix1/DeviceFactory.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ internal SingleDeviceFactory(Type deviceType)
/// </summary>
/// <remarks>
/// This is a fully-qualified numerical hardware address of a device within the device table produced
/// by an <see href="https://open-ephys.github.io/ONI/">Open Neuro Interface (ONI)</see> compliant
/// by an <see href="https://open-ephys.github.io/ONI/">ONI</see>-compliant
/// acquisition system. This value is usually not set manually, but is assigned in a <see
/// cref="MultiDeviceFactory"/> to correspond to a fixed address with a piece of hardware such as a
/// headstage. This address is used for hardware communication.
Expand All @@ -75,7 +75,7 @@ internal SingleDeviceFactory(Type deviceType)
/// </summary>
/// <remarks>
/// This type provides a device identity to each device within the device table produced by an <see
/// href="https://open-ephys.github.io/ONI/">Open Neuro Interface (ONI)</see> compliant acquisition
/// href="https://open-ephys.github.io/ONI/">ONI</see>-compliant acquisition
/// system.
/// </remarks>
[Browsable(false)]
Expand Down
4 changes: 2 additions & 2 deletions OpenEphys.Onix1/StartAcquisition.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ namespace OpenEphys.Onix1
/// required actions on one or more <see cref="ContextTask">ContextTasks</see> provided in its input
/// sequence. Once acquisition is started, devices managed by a particular <see cref="ContextTask"/> will
/// start to produce data in a format called an <see
/// href="https://open-ephys.github.io/ONI/hw-spec/controller.html#data-frames">ONI Data Frame</see>. The output
/// href="https://open-ephys.github.io/ONI/">ONI</see> Data Frame. The output
/// sequence of this operator is therefore a <see cref="IGroupedObservable{TKey, TElement}"/>, where
/// <list type="table">
/// <item>
Expand All @@ -35,7 +35,7 @@ namespace OpenEphys.Onix1
/// </list>
/// These pre-sorted frame sequences can be interpreted by downstream Data I/O operators (e.g. <see
/// cref="AnalogInput"/> or <see cref="Bno055Data"/>) that convert <see
/// href="https://open-ephys.github.io/ONI/hw-spec/controller.html#data-frames">ONI Data Frames</see> into
/// href="https://open-ephys.github.io/ONI/">ONI</see> Data Frames into
/// data types that are are more amenable to processing within Bonsai workflows.
/// </remarks>
[Description("Starts data acquisition and frame distribution on a ContextTask.")]
Expand Down

0 comments on commit e4d8998

Please sign in to comment.