Merge pull request #418 from open-ephys/issue-371

Modify Neuropixels aggregate names

OpenEphys.Onix1.Design/NeuropixelsV1eHeadstageDialog.cs

@@ -3,10 +3,10 @@
 namespace OpenEphys.Onix1.Design
 {
     /// <summary>
-    /// Partial class to create a GUI for <see cref="ConfigureNeuropixelsV1eHeadstage"/>.
+    /// Partial class to create a GUI for <see cref="ConfigureHeadstageNeuropixelsV1e"/>.
     /// </summary>
     /// <remarks>
-    /// Within the GUI, there is a tab for both devices encapsulated by a <see cref="ConfigureNeuropixelsV1eHeadstage"/>,
+    /// Within the GUI, there is a tab for both devices encapsulated by a <see cref="ConfigureHeadstageNeuropixelsV1e"/>,
     /// specifically a <see cref="ConfigureNeuropixelsV1e"/> and a <see cref="ConfigurePolledBno055"/>. 
     /// </remarks>
     public partial class NeuropixelsV1eHeadstageDialog : Form

OpenEphys.Onix1.Design/NeuropixelsV1eHeadstageEditor.cs

@@ -6,7 +6,7 @@
 namespace OpenEphys.Onix1.Design
 {
     /// <summary>
-    /// Class that opens a new dialog for a <see cref="ConfigureNeuropixelsV1eHeadstage"/>.
+    /// Class that opens a new dialog for a <see cref="ConfigureHeadstageNeuropixelsV1e"/>.
     /// </summary>
     public class NeuropixelsV1eHeadstageEditor : WorkflowComponentEditor
     {
@@ -17,7 +17,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon
             {
                 var editorState = (IWorkflowEditorState)provider.GetService(typeof(IWorkflowEditorState));
 
-                if (editorState != null && !editorState.WorkflowRunning && component is ConfigureNeuropixelsV1eHeadstage configureHeadstage)
+                if (editorState != null && !editorState.WorkflowRunning && component is ConfigureHeadstageNeuropixelsV1e configureHeadstage)
                 {
                     using var editorDialog = new NeuropixelsV1eHeadstageDialog(configureHeadstage.NeuropixelsV1e, configureHeadstage.Bno055);
 

OpenEphys.Onix1.Design/NeuropixelsV1fHeadstageDialog.cs

@@ -3,10 +3,10 @@
 namespace OpenEphys.Onix1.Design
 {
     /// <summary>
-    /// Partial class to create a GUI for <see cref="ConfigureNeuropixelsV1fHeadstage"/>.
+    /// Partial class to create a GUI for <see cref="ConfigureHeadstageNeuropixelsV1f"/>.
     /// </summary>
     /// <remarks>
-    /// Within the GUI, there is a tab for all devices encapsulated by a <see cref="ConfigureNeuropixelsV1fHeadstage"/>,
+    /// Within the GUI, there is a tab for all devices encapsulated by a <see cref="ConfigureHeadstageNeuropixelsV1f"/>,
     /// specifically two <see cref="ConfigureNeuropixelsV1f"/> devices and one <see cref="ConfigureBno055"/>. 
     /// </remarks>
     public partial class NeuropixelsV1fHeadstageDialog : Form

OpenEphys.Onix1.Design/NeuropixelsV1fHeadstageEditor.cs

@@ -6,7 +6,7 @@
 namespace OpenEphys.Onix1.Design
 {
     /// <summary>
-    /// Class that opens a new dialog for a <see cref="ConfigureNeuropixelsV1eHeadstage"/>.
+    /// Class that opens a new dialog for a <see cref="ConfigureHeadstageNeuropixelsV1e"/>.
     /// </summary>
     public class NeuropixelsV1fHeadstageEditor : WorkflowComponentEditor
     {
@@ -17,7 +17,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon
             {
                 var editorState = (IWorkflowEditorState)provider.GetService(typeof(IWorkflowEditorState));
 
-                if (editorState != null && !editorState.WorkflowRunning && component is ConfigureNeuropixelsV1fHeadstage configureHeadstage)
+                if (editorState != null && !editorState.WorkflowRunning && component is ConfigureHeadstageNeuropixelsV1f configureHeadstage)
                 {
                     using var editorDialog = new NeuropixelsV1fHeadstageDialog(configureHeadstage.NeuropixelsV1A, configureHeadstage.NeuropixelsV1B, configureHeadstage.Bno055);
 

OpenEphys.Onix1.Design/NeuropixelsV2eHeadstageDialog.cs

@@ -3,7 +3,7 @@
 namespace OpenEphys.Onix1.Design
 {
     /// <summary>
-    /// Partial class to create a GUI for <see cref="ConfigureNeuropixelsV2eHeadstage"/>.
+    /// Partial class to create a GUI for <see cref="ConfigureHeadstageNeuropixelsV2e"/>.
     /// </summary>
     public partial class NeuropixelsV2eHeadstageDialog : Form
     {

OpenEphys.Onix1.Design/NeuropixelsV2eHeadstageEditor.cs

@@ -6,7 +6,7 @@
 namespace OpenEphys.Onix1.Design
 {
     /// <summary>
-    /// Class that opens a new dialog for a <see cref="ConfigureNeuropixelsV2eHeadstage"/>.
+    /// Class that opens a new dialog for a <see cref="ConfigureHeadstageNeuropixelsV2e"/>.
     /// </summary>
     public class NeuropixelsV2eHeadstageEditor : WorkflowComponentEditor
     {
@@ -17,7 +17,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon
             {
                 var editorState = (IWorkflowEditorState)provider.GetService(typeof(IWorkflowEditorState));
 
-                if (editorState != null && !editorState.WorkflowRunning && component is ConfigureNeuropixelsV2eHeadstage configureV2eHeadstage)
+                if (editorState != null && !editorState.WorkflowRunning && component is ConfigureHeadstageNeuropixelsV2e configureV2eHeadstage)
                 {
                     using var editorDialog = new NeuropixelsV2eHeadstageDialog(configureV2eHeadstage.NeuropixelsV2e, configureV2eHeadstage.Bno055);
 
@@ -34,7 +34,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon
                         return true;
                     }
                 }
-                else if (editorState != null && !editorState.WorkflowRunning && component is ConfigureNeuropixelsV2eBetaHeadstage configureV2eBetaHeadstage)
+                else if (editorState != null && !editorState.WorkflowRunning && component is ConfigureHeadstageNeuropixelsV2eBeta configureV2eBetaHeadstage)
                 {
                     using var editorDialog = new NeuropixelsV2eHeadstageDialog(configureV2eBetaHeadstage.NeuropixelsV2eBeta, configureV2eBetaHeadstage.Bno055);
 

OpenEphys.Onix1/ConfigureHeadstage64.cs

@@ -5,14 +5,14 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// Configures an ONIX headstage-64 on the specified port.
+    /// Configures an ONIX multifunction 64-channel headstage on the specified port.
     /// </summary>
     /// <remarks>
     /// 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
+    /// <item><description>64 electrophysiology 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>
     /// <item><description>Three TS4231 light to digital converters for real-time, 3D position tracking with
@@ -22,7 +22,7 @@ namespace OpenEphys.Onix1
     /// <item><description>Two optical stimulators (800 mA peak current per channel).</description></item>
     /// </list>
     /// </remarks>
-    [Description("Configures an ONIX headstage-64 in the specified port.")]
+    [Description("Configures an ONIX multifunction 64-channel headstage.")]
     public class ConfigureHeadstage64 : MultiDeviceFactory
     {
         PortName port;
@@ -31,19 +31,6 @@ public class ConfigureHeadstage64 : MultiDeviceFactory
         /// <summary>
         /// Initializes a new instance of the <see cref="ConfigureHeadstage64"/> class.
         /// </summary>
-        /// <remarks>
-        /// 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>
-        /// <item><description>Three TS4231 light to digital converters for real-time, 3D position tracking with HTC Vive base stations.</description></item>
-        /// <item><description>A single electrical stimulator (current controlled, +/-15V compliance, automatic electrode discharge).</description></item>
-        /// <item><description>Two optical stimulators (800 mA peak current per channel).</description></item>
-        /// </list>
-        /// </remarks>
         public ConfigureHeadstage64()
         {
             // WONTFIX: The issue with this headstage is that its locking voltage is far, far lower than the

OpenEphys.Onix1/ConfigureNeuropixelsV1eHeadstage.cs → OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV1e.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 using System.Threading;
 
@@ -21,17 +22,17 @@ namespace OpenEphys.Onix1
     /// <item><description>A BNO055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
     /// </list>
     /// </remarks>
-    [Description("Configures a NeuropixelsV1e headstage.")]
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV1eHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
-    public class ConfigureNeuropixelsV1eHeadstage : MultiDeviceFactory
+    [Description("Configures a NeuropixelsV1e headstage.")]
+    public class ConfigureHeadstageNeuropixelsV1e : MultiDeviceFactory
     {
         PortName port;
         readonly ConfigureNeuropixelsV1ePortController PortControl = new();
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ConfigureNeuropixelsV1eHeadstage"/> class.
+        /// Initializes a new instance of the <see cref="ConfigureHeadstageNeuropixelsV1e"/> class.
         /// </summary>
-        public ConfigureNeuropixelsV1eHeadstage()
+        public ConfigureHeadstageNeuropixelsV1e()
         {
             Port = PortName.PortA;
             PortControl.HubConfiguration = HubConfiguration.Passthrough;
@@ -133,4 +134,8 @@ void SetVoltage(DeviceContext device, double voltage)
             }
         }
     }
+
+    /// <inheritdoc cref="ConfigureHeadstageNeuropixelsV1e"/>
+    [Obsolete("This operator is obsolete. Use ConfigureHeadstageNeuropixelsV1e instead. Will be removed in version 1.0.0.")]
+    public class ConfigureNeuropixelsV1eHeadstage : ConfigureHeadstageNeuropixelsV1e { }
 }

OpenEphys.Onix1/ConfigureNeuropixelsV1fHeadstage.cs → OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV1f.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 using System.Threading;
 
@@ -25,15 +26,15 @@ namespace OpenEphys.Onix1
     /// </remarks>
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV1fHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
     [Description("Configures a NeuropixelsV1f headstage.")]
-    public class ConfigureNeuropixelsV1fHeadstage : MultiDeviceFactory
+    public class ConfigureHeadstageNeuropixelsV1f : MultiDeviceFactory
     {
         PortName port;
         readonly ConfigureNeuropixels1fHeadstageLinkController PortControl = new();
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ConfigureNeuropixelsV1eHeadstage"/> class.
+        /// Initializes a new instance of the <see cref="ConfigureHeadstageNeuropixelsV1f"/> class.
         /// </summary>
-        public ConfigureNeuropixelsV1fHeadstage()
+        public ConfigureHeadstageNeuropixelsV1f()
         {
             Port = PortName.PortA;
             PortControl.HubConfiguration = HubConfiguration.Standard;
@@ -178,4 +179,8 @@ void SetVoltage(DeviceContext device, double voltage)
             }
         }
     }
+
+    /// <inheritdoc cref="ConfigureHeadstageNeuropixelsV1f"/>
+    [Obsolete("This operator is obsolete. Use ConfigureHeadstageNeuropixelsV1f instead. Will be removed in version 1.0.0.")]
+    public class ConfigureNeuropixelsV1fHeadstage : ConfigureHeadstageNeuropixelsV1f { }
 }

OpenEphys.Onix1/ConfigureNeuropixelsV2eHeadstage.cs → OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV2e.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 
 namespace OpenEphys.Onix1
@@ -21,16 +22,16 @@ namespace OpenEphys.Onix1
     /// </list>
     /// </remarks>
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV2eHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
-    [Description("Configures a NeuropixelsV2e headstage on the specified port.")]
-    public class ConfigureNeuropixelsV2eHeadstage : MultiDeviceFactory
+    [Description("Configures a NeuropixelsV2e headstage.")]
+    public class ConfigureHeadstageNeuropixelsV2e : MultiDeviceFactory
     {
         PortName port;
         readonly ConfigureNeuropixelsV2ePortController PortControl = new();
 
         /// <summary>
         /// Initializes a new instance of the <see cref="ConfigureNeuropixelsV2e"/> class.
         /// </summary>
-        public ConfigureNeuropixelsV2eHeadstage()
+        public ConfigureHeadstageNeuropixelsV2e()
         {
             Port = PortName.PortA;
             PortControl.HubConfiguration = HubConfiguration.Passthrough;
@@ -100,4 +101,8 @@ internal override IEnumerable<IDeviceConfiguration> GetDevices()
             yield return Bno055;
         }
     }
+
+    /// <inheritdoc cref="ConfigureHeadstageNeuropixelsV2e"/>
+    [Obsolete("This operator is obsolete. Use ConfigureHeadstageNeuropixelsV2e instead. Will be removed in version 1.0.0.")]
+    public class ConfigureNeuropixelsV2eHeadstage : ConfigureHeadstageNeuropixelsV2e{ }
 }

OpenEphys.Onix1/ConfigureNeuropixelsV2eBetaHeadstage.cs → OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV2eBeta.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.ComponentModel;
 
 namespace OpenEphys.Onix1
@@ -20,17 +21,17 @@ namespace OpenEphys.Onix1
     /// <item><description>A BNO055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
     /// </list>
     /// </remarks>
-    [Description("Configures a NeuropixelsV2eBeta headstage.")]
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV2eHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
-    public class ConfigureNeuropixelsV2eBetaHeadstage : MultiDeviceFactory
+    [Description("Configures a NeuropixelsV2eBeta headstage.")]
+    public class ConfigureHeadstageNeuropixelsV2eBeta : MultiDeviceFactory
     {
         PortName port;
         readonly ConfigureNeuropixelsV2ePortController PortControl = new();
 
         /// <summary>
-        /// Initializes a new instance of the <see cref="ConfigureNeuropixelsV2eBetaHeadstage"/> class.
+        /// Initializes a new instance of the <see cref="ConfigureHeadstageNeuropixelsV2eBeta"/> class.
         /// </summary>
-        public ConfigureNeuropixelsV2eBetaHeadstage()
+        public ConfigureHeadstageNeuropixelsV2eBeta()
         {
             Port = PortName.PortA;
             PortControl.HubConfiguration = HubConfiguration.Passthrough;
@@ -100,4 +101,8 @@ internal override IEnumerable<IDeviceConfiguration> GetDevices()
             yield return Bno055;
         }
     }
+
+    /// <inheritdoc cref="ConfigureHeadstageNeuropixelsV2eBeta"/>
+    [Obsolete("This operator is obsolete. Use ConfigureHeadstageNeuropixelsV2eBeta instead. Will be removed in version 1.0.0.")]
+    public class ConfigureNeuropixelsV2eBetaHeadstage : ConfigureHeadstageNeuropixelsV2eBeta { }
 }

OpenEphys.Onix1/ConfigureHeadstageNric1384.cs

@@ -23,7 +23,7 @@ namespace OpenEphys.Onix1
     /// electrode discharge).</description></item>
     /// </list>
     /// </remarks>
-    [Description("Configures a Nric1384 Headstage headstage.")]
+    [Description("Configures a Nric1384 headstage.")]
     public class ConfigureHeadstageNric1384 : MultiDeviceFactory
     {
         PortName port;

OpenEphys.Onix1/ConfigureHeadstageRhs2116.cs

@@ -13,17 +13,17 @@ namespace OpenEphys.Onix1
     /// 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:
     /// <list type="bullet">
-    /// <item><description>Two, synchronized Rhs2116 ICs for a combined 32 bidirectional ephys channels.</description></item>
+    /// <item><description>Two, synchronized Rhs2116 ICs for a combined 32 bidirectional ephys channels
+    /// sampled at 30.1932367 kHz per channel.</description></item>
     /// <item><description>Real-time control of stimulation sequences.</description></item>
-    /// <item><description>Real-time control of filter settings and artifact recovery parameters.</description></item>
-    /// <item><description>~1 millisecond active stimulus artifact recovery.</description></item>
+    /// <item><description>Real-time control of filter settings.</description></item>
+    /// <item><description>Active post-stimulus electrode discharge and filtering allowing ~1 ms artifact recovery.</description></item>
     /// <item><description>Max stimulator current: 2.55mA @ +/-7V compliance.</description></item>
-    /// <item><description>Sample rate: 30193.2367 Hz.</description></item>
     /// <item><description>Stimulus active and stimulus trigger pins.</description></item>
-    /// <item><description>On-board Lattice Crosslink FPGA for real-time data arbitration.</description></item>
     /// </list>
     /// </remarks>
     [Editor("OpenEphys.Onix1.Design.HeadstageRhs2116Editor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
+    [Description("Configures an ONIX Rhs2116 headstage.")]
     public class ConfigureHeadstageRhs2116 : MultiDeviceFactory
     {
         PortName port;

OpenEphys.Onix1/ConfigureNeuropixelsV2e.cs

@@ -50,7 +50,7 @@ public ConfigureNeuropixelsV2e(ConfigureNeuropixelsV2e configureNode)
         /// <remarks>
         /// Configuration is accomplished using a GUI to aid in channel selection and relevant configuration properties.
         /// To open a probe configuration GUI, select the ellipses next the <see cref="ProbeConfigurationA"/> variable
-        /// in the property pane, or double-click <see cref="ConfigureNeuropixelsV2eHeadstage"/> to configure both
+        /// in the property pane, or double-click <see cref="ConfigureHeadstageNeuropixelsV2e"/> to configure both
         /// probes and the <see cref="ConfigurePolledBno055"/> simultaneously.
         /// </remarks>
         [Category(ConfigurationCategory)]
@@ -81,7 +81,7 @@ public ConfigureNeuropixelsV2e(ConfigureNeuropixelsV2e configureNode)
         /// <remarks>
         /// Configuration is accomplished using a GUI to aid in channel selection and relevant configuration properties.
         /// To open a probe configuration GUI, select the ellipses next the <see cref="ProbeConfigurationB"/> variable
-        /// in the property pane, or double-click <see cref="ConfigureNeuropixelsV2eHeadstage"/> to configure both
+        /// in the property pane, or double-click <see cref="ConfigureHeadstageNeuropixelsV2e"/> to configure both
         /// probes and the <see cref="ConfigurePolledBno055"/> simultaneously.
         /// </remarks>
         [Category(ConfigurationCategory)]

OpenEphys.Onix1/ConfigureNeuropixelsV2eBeta.cs

@@ -65,7 +65,7 @@ public ConfigureNeuropixelsV2eBeta(ConfigureNeuropixelsV2eBeta configureNode)
         /// <remarks>
         /// Configuration is accomplished using a GUI to aid in channel selection and relevant configuration properties.
         /// To open a probe configuration GUI, select the ellipses next the <see cref="ProbeConfigurationA"/> variable
-        /// in the property pane, or double-click <see cref="ConfigureNeuropixelsV2eBetaHeadstage"/> to configure both
+        /// in the property pane, or double-click <see cref="ConfigureHeadstageNeuropixelsV2eBeta"/> to configure both
         /// probes and the <see cref="ConfigurePolledBno055"/> simultaneously.
         /// </remarks>
         [Category(ConfigurationCategory)]
@@ -96,7 +96,7 @@ public ConfigureNeuropixelsV2eBeta(ConfigureNeuropixelsV2eBeta configureNode)
         /// <remarks>
         /// Configuration is accomplished using a GUI to aid in channel selection and relevant configuration properties.
         /// To open a probe configuration GUI, select the ellipses next the <see cref="ProbeConfigurationB"/> variable
-        /// in the property pane, or double-click <see cref="ConfigureNeuropixelsV2eBetaHeadstage"/> to configure both
+        /// in the property pane, or double-click <see cref="ConfigureHeadstageNeuropixelsV2eBeta"/> to configure both
         /// probes and the <see cref="ConfigurePolledBno055"/> simultaneously.
         /// </remarks>
         [Category(ConfigurationCategory)]