@@ -26,18 +26,18 @@ This configuration GUI can be accessed by double-clicking on the `ConfigureHeads
2626operator.
2727
2828<p align =" center " >
29- <img src =" ../../../images/rhs2116-gui-tut/bonsai-where-to-click.png " >
29+ <img src =" ../../../images/rhs2116-gui-tut/bonsai-where-to-click.png " width = 750px >
3030</p >
3131
3232### Stimulus parameters
3333
3434The GUI accepts values for stimulation waveform parameters in metric units (e.g., milliseconds and
3535microamps). In the backend, the GUI converts metric units into units that can be written to the
3636hardware. Because the conversion between metric values and converted values is not always exact, the
37- GUI might automatically update the metric value initially input by the user to a metric value that
37+ GUI might automatically update the metric value initially input to a metric value that
3838more accurately represents the converted value that will be written to hardware. This update is
39- visually displayed in the same text box where the user initially input their values and happens when
40- the focus moves away from the active text box (e.g., the user presses <kbd >Tab</kbd > or clicks
39+ visually displayed in the same text box you will initially input their values, and happens when
40+ the focus moves away from the active text box (e.g., by pressing <kbd >Tab</kbd > or clicking
4141somewhere outside of the text box).
4242
4343Below 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
7373defined. The window should look something like this:
7474
7575<p align =" center " >
76- <img src =" ../../../images/rhs2116-gui-tut/gui- no-waveforms.png " >
76+ <img src =" ../../../images/rhs2116-gui-tut/no-waveforms.png " width = 750px >
7777</p >
7878
7979### Selecting channels
@@ -94,14 +94,15 @@ When channels are selected, they will be highlighted by a green circle around th
9494and the corresponding waveforms will be plotted in the main window; any channels that are
9595not selected will not be plotted.
9696
97- ### Zoom and pan limits
97+ ### Zoom
9898
9999When zooming in and out, there are limits in both directions. The probe can only be zoomed out to
100100the point that the entire probe is visible within the panel and no more. Similarly, while zooming in
101101the probe will not zoom in past a certain point.
102102
103- In addition to the absolute zoom limits, the panel will automatically shift the probe to ensure it
104- is always in view. This is handled each time the probe is zoomed or panned.
103+ There are no limits to where you can pan the probe, meaning that it is possible to lose track of the
104+ probe. If it is ever needed to get the probe back in the center of the plot, press on the <kbd >Reset
105+ Zoom</kbd > button.
105106
106107## Define Stimuli
107108
@@ -118,15 +119,15 @@ only plot the selected channels in the main window. In the example below, channe
118119are selected.
119120
120121<p align =" center " >
121- <img src =" ../../../images/rhs2116-gui-tut/channel-selection-7-8-23-24 .png " >
122+ <img src =" ../../../images/rhs2116-gui-tut/select-channels .png " width = 750px >
122123</p >
123124
124125Enter the [ stimulus parameters] ( #stimulus-parameters ) that you want to apply to the currently
125- selected channel(s). Note that the value initially input by the user might update when the focus
126- moves away from the current text box (e.g., the user presses <kbd >Tab</kbd > or clicks somewhere
127- outside of the text box) to reflect the actual value that will be written based on the resolutions
128- listed above. In the example below, we can see that the table listed below as well shows the typed
129- values compared to the actual values list.
126+ selected channel(s). Note that the value might update when the focus moves away from the current
127+ text box (e.g., pressing <kbd >Tab</kbd > or clicking somewhere outside of the text box); this change
128+ reflects the value that will be written to the device based on the resolutions listed above. In the
129+ example below, we can see that the table listed below shows the typed values compared to the actual
130+ values list.
130131
131132| Parameter | Requested Value | Listed Value |
132133| --- | --- | --- |
@@ -137,7 +138,7 @@ values compared to the actual values list.
137138| ` Inter-Stimulus [ms] ` | 100 | 99.99 |
138139
139140<p align =" center " >
140- <img src =" ../../../images/rhs2116-gui-tut/define-stimuli-a .png " >
141+ <img src =" ../../../images/rhs2116-gui-tut/define-stimuli.png " width = 750px >
141142</p >
142143
143144> [ !TIP]
@@ -146,10 +147,12 @@ values compared to the actual values list.
146147> applied.
147148
148149The selected settings can be applied to the selected channels by pressing <kbd >Apply</kbd >, and the
149- waveforms will be plotted in the main window as shown below.
150+ waveforms will be plotted in the main window as shown below. The waveforms are ordered from top to
151+ bottom, with the top waveform corresponding to channel 0, and the bottom waveform corresponding to
152+ channel 31.
150153
151154<p align =" center " >
152- <img src =" ../../../images/rhs2116-gui-tut/waveforms-7-8-23-24-a .png " >
155+ <img src =" ../../../images/rhs2116-gui-tut/waveforms.png " width = 750px >
153156</p >
154157
155158To 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
159162when no parameters have been set is below.
160163
161164<p align =" center " >
162- <img src =" ../../../images/rhs2116-gui-tut/table.png " >
165+ <img src =" ../../../images/rhs2116-gui-tut/table.png " width = 750px >
163166</p >
164167
165168### Reading current parameters
@@ -168,22 +171,14 @@ To easily copy settings from one channel to another, or to see what the current
168171channel prior to updating then settings, click on a single channel in the channel selection window,
169172or click-and-drag until a single channel is selected, and then press on the <kbd >Read</kbd > button
170173in the bottom right. If more than one channel is selected, or no channels are selected, a window
171- will pop up prompting the user to select a single channel.
174+ will pop up prompting you to select a single channel.
172175
173- To test this, select a channel that has not been configured yet and press <kbd >Read</kbd >. The
174- parameter fields will be populated with zeroes as shown in the image below:
176+ Select a channel that has been configured and press <kbd >Read</kbd > to read that channel's
177+ current parameters. For example, if you are using the workflow provided in this documentation, you
178+ should see the following parameters after selecting channel 7 and reading the parameters:
175179
176180<p align =" center " >
177- <img src =" ../../../images/rhs2116-gui-tut/define-stimuli-read-defaults.png " >
178- </p >
179-
180- Now select a channel that has been configured and press <kbd >Read</kbd > to read that channel's
181- current parameters. For example, if one of the channels that was configured in the [ Applying
182- parameters] ( #applying-parameters ) section above is selected, the image below shows the result of the
183- operation:
184-
185- <p align =" center " >
186- <img src =" ../../../images/rhs2116-gui-tut/define-stimuli-read-applied-parameters.png " >
181+ <img src =" ../../../images/rhs2116-gui-tut/read-parameters.png " width =750px >
187182</p >
188183
189184### Clearing current parameters
0 commit comments