diff --git a/articles/hardware/rhs2116/gui.md b/articles/hardware/rhs2116/gui.md index aaf1dbc..a1a36f6 100644 --- a/articles/hardware/rhs2116/gui.md +++ b/articles/hardware/rhs2116/gui.md @@ -26,7 +26,7 @@ This configuration GUI can be accessed by double-clicking on the `ConfigureHeads operator.

- +

### Stimulus parameters @@ -34,10 +34,10 @@ operator. The GUI accepts values for stimulation waveform parameters in metric units (e.g., milliseconds and microamps). In the backend, the GUI converts metric units into units that can be written to the hardware. Because the conversion between metric values and converted values is not always exact, the -GUI might automatically update the metric value initially input by the user to a metric value that +GUI might automatically update the metric value initially input to a metric value that more accurately represents the converted value that will be written to hardware. This update is -visually displayed in the same text box where the user initially input their values and happens when -the focus moves away from the active text box (e.g., the user presses Tab or clicks +visually displayed in the same text box you will initially input their values, and happens when +the focus moves away from the active text box (e.g., by pressing Tab or clicking somewhere outside of the text box). Below is a table describing the various stimulus parameters that can be applied to each channel @@ -73,7 +73,7 @@ Upon first opening the GUI, the main window will be blank if no stimulus paramet defined. The window should look something like this:

- +

### Selecting channels @@ -94,14 +94,15 @@ When channels are selected, they will be highlighted by a green circle around th and the corresponding waveforms will be plotted in the main window; any channels that are not selected will not be plotted. -### Zoom and pan limits +### Zoom When zooming in and out, there are limits in both directions. The probe can only be zoomed out to the point that the entire probe is visible within the panel and no more. Similarly, while zooming in the probe will not zoom in past a certain point. -In addition to the absolute zoom limits, the panel will automatically shift the probe to ensure it -is always in view. This is handled each time the probe is zoomed or panned. +There are no limits to where you can pan the probe, meaning that it is possible to lose track of the +probe. If it is ever needed to get the probe back in the center of the plot, press on the Reset +Zoom button. ## Define Stimuli @@ -118,15 +119,15 @@ only plot the selected channels in the main window. In the example below, channe are selected.

- +

Enter the [stimulus parameters](#stimulus-parameters) that you want to apply to the currently -selected channel(s). Note that the value initially input by the user might update when the focus -moves away from the current text box (e.g., the user presses Tab or clicks somewhere -outside of the text box) to reflect the actual value that will be written based on the resolutions -listed above. In the example below, we can see that the table listed below as well shows the typed -values compared to the actual values list. +selected channel(s). Note that the value might update when the focus moves away from the current +text box (e.g., pressing Tab or clicking somewhere outside of the text box); this change +reflects the value that will be written to the device based on the resolutions listed above. In the +example below, we can see that the table listed below shows the typed values compared to the actual +values list. | Parameter | Requested Value | Listed Value | | --- | --- | --- | @@ -137,7 +138,7 @@ values compared to the actual values list. | `Inter-Stimulus [ms]` | 100 | 99.99 |

- +

> [!TIP] @@ -146,10 +147,12 @@ values compared to the actual values list. > applied. The selected settings can be applied to the selected channels by pressing Apply, and the -waveforms will be plotted in the main window as shown below. +waveforms will be plotted in the main window as shown below. The waveforms are ordered from top to +bottom, with the top waveform corresponding to channel 0, and the bottom waveform corresponding to +channel 31.

- +

To see the values that will be written to the hardware, click on the `Table` tab in the top left, @@ -159,7 +162,7 @@ channels parameters will be reflected in this window. An example of what the emp when no parameters have been set is below.

- +

### Reading current parameters @@ -168,22 +171,14 @@ To easily copy settings from one channel to another, or to see what the current channel prior to updating then settings, click on a single channel in the channel selection window, or click-and-drag until a single channel is selected, and then press on the Read button in the bottom right. If more than one channel is selected, or no channels are selected, a window -will pop up prompting the user to select a single channel. +will pop up prompting you to select a single channel. -To test this, select a channel that has not been configured yet and press Read. The -parameter fields will be populated with zeroes as shown in the image below: +Select a channel that has been configured and press Read to read that channel's +current parameters. For example, if you are using the workflow provided in this documentation, you +should see the following parameters after selecting channel 7 and reading the parameters:

- -

- -Now select a channel that has been configured and press Read to read that channel's -current parameters. For example, if one of the channels that was configured in the [Applying -parameters](#applying-parameters) section above is selected, the image below shows the result of the -operation: - -

- +

### Clearing current parameters diff --git a/images/rhs2116-gui-tut/channel-selection-7-8-23-24.png b/images/rhs2116-gui-tut/channel-selection-7-8-23-24.png deleted file mode 100644 index 42e293b..0000000 Binary files a/images/rhs2116-gui-tut/channel-selection-7-8-23-24.png and /dev/null differ diff --git a/images/rhs2116-gui-tut/define-stimuli-a.png b/images/rhs2116-gui-tut/define-stimuli-a.png deleted file mode 100644 index 6e8893f..0000000 Binary files a/images/rhs2116-gui-tut/define-stimuli-a.png and /dev/null differ diff --git a/images/rhs2116-gui-tut/define-stimuli-read-applied-parameters.png b/images/rhs2116-gui-tut/define-stimuli-read-applied-parameters.png deleted file mode 100644 index 092158d..0000000 Binary files a/images/rhs2116-gui-tut/define-stimuli-read-applied-parameters.png and /dev/null differ diff --git a/images/rhs2116-gui-tut/define-stimuli-read-defaults.png b/images/rhs2116-gui-tut/define-stimuli-read-defaults.png deleted file mode 100644 index 742b1e7..0000000 Binary files a/images/rhs2116-gui-tut/define-stimuli-read-defaults.png and /dev/null differ diff --git a/images/rhs2116-gui-tut/define-stimuli.png b/images/rhs2116-gui-tut/define-stimuli.png new file mode 100644 index 0000000..380a7f5 Binary files /dev/null and b/images/rhs2116-gui-tut/define-stimuli.png differ diff --git a/images/rhs2116-gui-tut/gui-no-waveforms.png b/images/rhs2116-gui-tut/gui-no-waveforms.png deleted file mode 100644 index c998cbe..0000000 Binary files a/images/rhs2116-gui-tut/gui-no-waveforms.png and /dev/null differ diff --git a/images/rhs2116-gui-tut/no-waveforms.png b/images/rhs2116-gui-tut/no-waveforms.png new file mode 100644 index 0000000..0e796f2 Binary files /dev/null and b/images/rhs2116-gui-tut/no-waveforms.png differ diff --git a/images/rhs2116-gui-tut/read-parameters.png b/images/rhs2116-gui-tut/read-parameters.png new file mode 100644 index 0000000..40c35b4 Binary files /dev/null and b/images/rhs2116-gui-tut/read-parameters.png differ diff --git a/images/rhs2116-gui-tut/select-channels.png b/images/rhs2116-gui-tut/select-channels.png new file mode 100644 index 0000000..1e6d63a Binary files /dev/null and b/images/rhs2116-gui-tut/select-channels.png differ diff --git a/images/rhs2116-gui-tut/table.png b/images/rhs2116-gui-tut/table.png index 91ff9b4..f40a1ec 100644 Binary files a/images/rhs2116-gui-tut/table.png and b/images/rhs2116-gui-tut/table.png differ diff --git a/images/rhs2116-gui-tut/waveforms-7-8-23-24-a.png b/images/rhs2116-gui-tut/waveforms-7-8-23-24-a.png deleted file mode 100644 index e48dd63..0000000 Binary files a/images/rhs2116-gui-tut/waveforms-7-8-23-24-a.png and /dev/null differ diff --git a/images/rhs2116-gui-tut/waveforms.png b/images/rhs2116-gui-tut/waveforms.png new file mode 100644 index 0000000..9112044 Binary files /dev/null and b/images/rhs2116-gui-tut/waveforms.png differ diff --git a/img-src/rhs2116-gui/applying-parameters.svg b/img-src/rhs2116-gui/applying-parameters.svg new file mode 100644 index 0000000..88d1cf0 --- /dev/null +++ b/img-src/rhs2116-gui/applying-parameters.svg @@ -0,0 +1,77 @@ + + + + diff --git a/img-src/rhs2116-gui/define-stimuli.png b/img-src/rhs2116-gui/define-stimuli.png new file mode 100644 index 0000000..380a7f5 Binary files /dev/null and b/img-src/rhs2116-gui/define-stimuli.png differ diff --git a/img-src/rhs2116-gui/gui-select-channels.svg b/img-src/rhs2116-gui/gui-select-channels.svg new file mode 100644 index 0000000..59c7b39 --- /dev/null +++ b/img-src/rhs2116-gui/gui-select-channels.svg @@ -0,0 +1,53 @@ + + + + diff --git a/img-src/rhs2116-gui/no-waveforms.svg b/img-src/rhs2116-gui/no-waveforms.svg new file mode 100644 index 0000000..f2af62c --- /dev/null +++ b/img-src/rhs2116-gui/no-waveforms.svg @@ -0,0 +1,50 @@ + + + + diff --git a/img-src/rhs2116-gui/read-parameters.svg b/img-src/rhs2116-gui/read-parameters.svg new file mode 100644 index 0000000..0058117 --- /dev/null +++ b/img-src/rhs2116-gui/read-parameters.svg @@ -0,0 +1,50 @@ + + + + diff --git a/img-src/rhs2116-gui/table.svg b/img-src/rhs2116-gui/table.svg new file mode 100644 index 0000000..a2abd9a --- /dev/null +++ b/img-src/rhs2116-gui/table.svg @@ -0,0 +1,53 @@ + + + + diff --git a/img-src/rhs2116-gui/waveforms.png b/img-src/rhs2116-gui/waveforms.png new file mode 100644 index 0000000..9112044 Binary files /dev/null and b/img-src/rhs2116-gui/waveforms.png differ diff --git a/src/bonsai-onix1 b/src/bonsai-onix1 index 6dbe5b8..a7dbd50 160000 --- a/src/bonsai-onix1 +++ b/src/bonsai-onix1 @@ -1 +1 @@ -Subproject commit 6dbe5b83875fcb14d7e187d03aaf9c9e7da146df +Subproject commit a7dbd50e22897629607b7f35aa1fc4cc88599aeb