Skip to content

Commit 7c19c76

Browse files
authored
Merge pull request #418 from open-ephys/issue-371
Modify Neuropixels aggregate names
2 parents a66bd1c + 6e4fca7 commit 7c19c76

15 files changed

+63
-56
lines changed

OpenEphys.Onix1.Design/NeuropixelsV1eHeadstageDialog.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
namespace OpenEphys.Onix1.Design
44
{
55
/// <summary>
6-
/// Partial class to create a GUI for <see cref="ConfigureNeuropixelsV1eHeadstage"/>.
6+
/// Partial class to create a GUI for <see cref="ConfigureHeadstageNeuropixelsV1e"/>.
77
/// </summary>
88
/// <remarks>
9-
/// Within the GUI, there is a tab for both devices encapsulated by a <see cref="ConfigureNeuropixelsV1eHeadstage"/>,
9+
/// Within the GUI, there is a tab for both devices encapsulated by a <see cref="ConfigureHeadstageNeuropixelsV1e"/>,
1010
/// specifically a <see cref="ConfigureNeuropixelsV1e"/> and a <see cref="ConfigurePolledBno055"/>.
1111
/// </remarks>
1212
public partial class NeuropixelsV1eHeadstageDialog : Form

OpenEphys.Onix1.Design/NeuropixelsV1eHeadstageEditor.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace OpenEphys.Onix1.Design
77
{
88
/// <summary>
9-
/// Class that opens a new dialog for a <see cref="ConfigureNeuropixelsV1eHeadstage"/>.
9+
/// Class that opens a new dialog for a <see cref="ConfigureHeadstageNeuropixelsV1e"/>.
1010
/// </summary>
1111
public class NeuropixelsV1eHeadstageEditor : WorkflowComponentEditor
1212
{
@@ -17,7 +17,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon
1717
{
1818
var editorState = (IWorkflowEditorState)provider.GetService(typeof(IWorkflowEditorState));
1919

20-
if (editorState != null && !editorState.WorkflowRunning && component is ConfigureNeuropixelsV1eHeadstage configureHeadstage)
20+
if (editorState != null && !editorState.WorkflowRunning && component is ConfigureHeadstageNeuropixelsV1e configureHeadstage)
2121
{
2222
using var editorDialog = new NeuropixelsV1eHeadstageDialog(configureHeadstage.NeuropixelsV1e, configureHeadstage.Bno055);
2323

OpenEphys.Onix1.Design/NeuropixelsV1fHeadstageDialog.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
namespace OpenEphys.Onix1.Design
44
{
55
/// <summary>
6-
/// Partial class to create a GUI for <see cref="ConfigureNeuropixelsV1fHeadstage"/>.
6+
/// Partial class to create a GUI for <see cref="ConfigureHeadstageNeuropixelsV1f"/>.
77
/// </summary>
88
/// <remarks>
9-
/// Within the GUI, there is a tab for all devices encapsulated by a <see cref="ConfigureNeuropixelsV1fHeadstage"/>,
9+
/// Within the GUI, there is a tab for all devices encapsulated by a <see cref="ConfigureHeadstageNeuropixelsV1f"/>,
1010
/// specifically two <see cref="ConfigureNeuropixelsV1f"/> devices and one <see cref="ConfigureBno055"/>.
1111
/// </remarks>
1212
public partial class NeuropixelsV1fHeadstageDialog : Form

OpenEphys.Onix1.Design/NeuropixelsV1fHeadstageEditor.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace OpenEphys.Onix1.Design
77
{
88
/// <summary>
9-
/// Class that opens a new dialog for a <see cref="ConfigureNeuropixelsV1eHeadstage"/>.
9+
/// Class that opens a new dialog for a <see cref="ConfigureHeadstageNeuropixelsV1e"/>.
1010
/// </summary>
1111
public class NeuropixelsV1fHeadstageEditor : WorkflowComponentEditor
1212
{
@@ -17,7 +17,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon
1717
{
1818
var editorState = (IWorkflowEditorState)provider.GetService(typeof(IWorkflowEditorState));
1919

20-
if (editorState != null && !editorState.WorkflowRunning && component is ConfigureNeuropixelsV1fHeadstage configureHeadstage)
20+
if (editorState != null && !editorState.WorkflowRunning && component is ConfigureHeadstageNeuropixelsV1f configureHeadstage)
2121
{
2222
using var editorDialog = new NeuropixelsV1fHeadstageDialog(configureHeadstage.NeuropixelsV1A, configureHeadstage.NeuropixelsV1B, configureHeadstage.Bno055);
2323

OpenEphys.Onix1.Design/NeuropixelsV2eHeadstageDialog.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
namespace OpenEphys.Onix1.Design
44
{
55
/// <summary>
6-
/// Partial class to create a GUI for <see cref="ConfigureNeuropixelsV2eHeadstage"/>.
6+
/// Partial class to create a GUI for <see cref="ConfigureHeadstageNeuropixelsV2e"/>.
77
/// </summary>
88
public partial class NeuropixelsV2eHeadstageDialog : Form
99
{

OpenEphys.Onix1.Design/NeuropixelsV2eHeadstageEditor.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
namespace OpenEphys.Onix1.Design
77
{
88
/// <summary>
9-
/// Class that opens a new dialog for a <see cref="ConfigureNeuropixelsV2eHeadstage"/>.
9+
/// Class that opens a new dialog for a <see cref="ConfigureHeadstageNeuropixelsV2e"/>.
1010
/// </summary>
1111
public class NeuropixelsV2eHeadstageEditor : WorkflowComponentEditor
1212
{
@@ -17,7 +17,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon
1717
{
1818
var editorState = (IWorkflowEditorState)provider.GetService(typeof(IWorkflowEditorState));
1919

20-
if (editorState != null && !editorState.WorkflowRunning && component is ConfigureNeuropixelsV2eHeadstage configureV2eHeadstage)
20+
if (editorState != null && !editorState.WorkflowRunning && component is ConfigureHeadstageNeuropixelsV2e configureV2eHeadstage)
2121
{
2222
using var editorDialog = new NeuropixelsV2eHeadstageDialog(configureV2eHeadstage.NeuropixelsV2e, configureV2eHeadstage.Bno055);
2323

@@ -34,7 +34,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon
3434
return true;
3535
}
3636
}
37-
else if (editorState != null && !editorState.WorkflowRunning && component is ConfigureNeuropixelsV2eBetaHeadstage configureV2eBetaHeadstage)
37+
else if (editorState != null && !editorState.WorkflowRunning && component is ConfigureHeadstageNeuropixelsV2eBeta configureV2eBetaHeadstage)
3838
{
3939
using var editorDialog = new NeuropixelsV2eHeadstageDialog(configureV2eBetaHeadstage.NeuropixelsV2eBeta, configureV2eBetaHeadstage.Bno055);
4040

OpenEphys.Onix1/ConfigureHeadstage64.cs

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
namespace OpenEphys.Onix1
66
{
77
/// <summary>
8-
/// Configures an ONIX headstage-64 on the specified port.
8+
/// Configures an ONIX multifunction 64-channel headstage on the specified port.
99
/// </summary>
1010
/// <remarks>
1111
/// Headstage-64 is a 1.5g serialized, multifunction headstage designed to function with passive
1212
/// probes such as tetrode microdrives, silicon arrays, EEG/ECOG arrays, etc. It provides the
1313
/// following features:
1414
/// <list type="bullet">
15-
/// <item><description>64 analog ephys channels and 3 auxiliary channels sampled at 30 kHz per
15+
/// <item><description>64 electrophysiology channels and 3 auxiliary channels sampled at 30 kHz per
1616
/// channel.</description></item>
1717
/// <item><description>A BNO055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
1818
/// <item><description>Three TS4231 light to digital converters for real-time, 3D position tracking with
@@ -22,7 +22,7 @@ namespace OpenEphys.Onix1
2222
/// <item><description>Two optical stimulators (800 mA peak current per channel).</description></item>
2323
/// </list>
2424
/// </remarks>
25-
[Description("Configures an ONIX headstage-64 in the specified port.")]
25+
[Description("Configures an ONIX multifunction 64-channel headstage.")]
2626
public class ConfigureHeadstage64 : MultiDeviceFactory
2727
{
2828
PortName port;
@@ -31,19 +31,6 @@ public class ConfigureHeadstage64 : MultiDeviceFactory
3131
/// <summary>
3232
/// Initializes a new instance of the <see cref="ConfigureHeadstage64"/> class.
3333
/// </summary>
34-
/// <remarks>
35-
/// Headstage-64 is a 1.5g serialized, multifunction headstage designed to function with
36-
/// tetrode microdrives. Alternatively it can be used with other passive probes (e.g.
37-
/// silicon arrays, EEG/ECOG arrays, etc.). It provides the following features on the
38-
/// headstage:
39-
/// <list type="bullet">
40-
/// <item><description>64 analog ephys channels and 3 auxiliary channels sampled at 30 kHz per channel.</description></item>
41-
/// <item><description>A Bno055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
42-
/// <item><description>Three TS4231 light to digital converters for real-time, 3D position tracking with HTC Vive base stations.</description></item>
43-
/// <item><description>A single electrical stimulator (current controlled, +/-15V compliance, automatic electrode discharge).</description></item>
44-
/// <item><description>Two optical stimulators (800 mA peak current per channel).</description></item>
45-
/// </list>
46-
/// </remarks>
4734
public ConfigureHeadstage64()
4835
{
4936
// WONTFIX: The issue with this headstage is that its locking voltage is far, far lower than the

OpenEphys.Onix1/ConfigureNeuropixelsV1eHeadstage.cs renamed to OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV1e.cs

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
using System.Collections.Generic;
1+
using System;
2+
using System.Collections.Generic;
23
using System.ComponentModel;
34
using System.Threading;
45

@@ -21,17 +22,17 @@ namespace OpenEphys.Onix1
2122
/// <item><description>A BNO055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
2223
/// </list>
2324
/// </remarks>
24-
[Description("Configures a NeuropixelsV1e headstage.")]
2525
[Editor("OpenEphys.Onix1.Design.NeuropixelsV1eHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
26-
public class ConfigureNeuropixelsV1eHeadstage : MultiDeviceFactory
26+
[Description("Configures a NeuropixelsV1e headstage.")]
27+
public class ConfigureHeadstageNeuropixelsV1e : MultiDeviceFactory
2728
{
2829
PortName port;
2930
readonly ConfigureNeuropixelsV1ePortController PortControl = new();
3031

3132
/// <summary>
32-
/// Initializes a new instance of the <see cref="ConfigureNeuropixelsV1eHeadstage"/> class.
33+
/// Initializes a new instance of the <see cref="ConfigureHeadstageNeuropixelsV1e"/> class.
3334
/// </summary>
34-
public ConfigureNeuropixelsV1eHeadstage()
35+
public ConfigureHeadstageNeuropixelsV1e()
3536
{
3637
Port = PortName.PortA;
3738
PortControl.HubConfiguration = HubConfiguration.Passthrough;
@@ -133,4 +134,8 @@ void SetVoltage(DeviceContext device, double voltage)
133134
}
134135
}
135136
}
137+
138+
/// <inheritdoc cref="ConfigureHeadstageNeuropixelsV1e"/>
139+
[Obsolete("This operator is obsolete. Use ConfigureHeadstageNeuropixelsV1e instead. Will be removed in version 1.0.0.")]
140+
public class ConfigureNeuropixelsV1eHeadstage : ConfigureHeadstageNeuropixelsV1e { }
136141
}

OpenEphys.Onix1/ConfigureNeuropixelsV1fHeadstage.cs renamed to OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV1f.cs

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
using System.Collections.Generic;
1+
using System;
2+
using System.Collections.Generic;
23
using System.ComponentModel;
34
using System.Threading;
45

@@ -25,15 +26,15 @@ namespace OpenEphys.Onix1
2526
/// </remarks>
2627
[Editor("OpenEphys.Onix1.Design.NeuropixelsV1fHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
2728
[Description("Configures a NeuropixelsV1f headstage.")]
28-
public class ConfigureNeuropixelsV1fHeadstage : MultiDeviceFactory
29+
public class ConfigureHeadstageNeuropixelsV1f : MultiDeviceFactory
2930
{
3031
PortName port;
3132
readonly ConfigureNeuropixels1fHeadstageLinkController PortControl = new();
3233

3334
/// <summary>
34-
/// Initializes a new instance of the <see cref="ConfigureNeuropixelsV1eHeadstage"/> class.
35+
/// Initializes a new instance of the <see cref="ConfigureHeadstageNeuropixelsV1f"/> class.
3536
/// </summary>
36-
public ConfigureNeuropixelsV1fHeadstage()
37+
public ConfigureHeadstageNeuropixelsV1f()
3738
{
3839
Port = PortName.PortA;
3940
PortControl.HubConfiguration = HubConfiguration.Standard;
@@ -178,4 +179,8 @@ void SetVoltage(DeviceContext device, double voltage)
178179
}
179180
}
180181
}
182+
183+
/// <inheritdoc cref="ConfigureHeadstageNeuropixelsV1f"/>
184+
[Obsolete("This operator is obsolete. Use ConfigureHeadstageNeuropixelsV1f instead. Will be removed in version 1.0.0.")]
185+
public class ConfigureNeuropixelsV1fHeadstage : ConfigureHeadstageNeuropixelsV1f { }
181186
}

OpenEphys.Onix1/ConfigureNeuropixelsV2eHeadstage.cs renamed to OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV2e.cs

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
using System.Collections.Generic;
1+
using System;
2+
using System.Collections.Generic;
23
using System.ComponentModel;
34

45
namespace OpenEphys.Onix1
@@ -21,16 +22,16 @@ namespace OpenEphys.Onix1
2122
/// </list>
2223
/// </remarks>
2324
[Editor("OpenEphys.Onix1.Design.NeuropixelsV2eHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
24-
[Description("Configures a NeuropixelsV2e headstage on the specified port.")]
25-
public class ConfigureNeuropixelsV2eHeadstage : MultiDeviceFactory
25+
[Description("Configures a NeuropixelsV2e headstage.")]
26+
public class ConfigureHeadstageNeuropixelsV2e : MultiDeviceFactory
2627
{
2728
PortName port;
2829
readonly ConfigureNeuropixelsV2ePortController PortControl = new();
2930

3031
/// <summary>
3132
/// Initializes a new instance of the <see cref="ConfigureNeuropixelsV2e"/> class.
3233
/// </summary>
33-
public ConfigureNeuropixelsV2eHeadstage()
34+
public ConfigureHeadstageNeuropixelsV2e()
3435
{
3536
Port = PortName.PortA;
3637
PortControl.HubConfiguration = HubConfiguration.Passthrough;
@@ -100,4 +101,8 @@ internal override IEnumerable<IDeviceConfiguration> GetDevices()
100101
yield return Bno055;
101102
}
102103
}
104+
105+
/// <inheritdoc cref="ConfigureHeadstageNeuropixelsV2e"/>
106+
[Obsolete("This operator is obsolete. Use ConfigureHeadstageNeuropixelsV2e instead. Will be removed in version 1.0.0.")]
107+
public class ConfigureNeuropixelsV2eHeadstage : ConfigureHeadstageNeuropixelsV2e{ }
103108
}

0 commit comments

Comments
 (0)