bec/bec_widgets
0
0
Fork 0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-14 03:31:50 +02:00
Code Activity

docs: updated docs for v2 (#531)

Browse Source
This commit is contained in:
wakonig_k
2025-04-24 17:37:10 +02:00
parent 25bd905cef
commit b4af2cc77a
13 changed files with 105 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/user/widgets/waveform/scatter_2D.gif
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 13 MiB

25
docs/user/widgets/waveform/waveform_widget.md
View File

@ -36,9 +36,9 @@ plt1.plot(x_name='samx', y_name='bpm4i')
plt2.plot(x_name='samx', y_name='bpm3i')
# set axis labels
plt1.set_title("Gauss plots vs. samx")
plt1.set_x_label("Motor X")
plt1.set_y_label("Gauss Signal (A.U.")
plt1.title = "Gauss plots vs. samx"
plt1.x_label = "Motor X"
plt1.y_label = "Gauss Signal (A.U.)"
```
@ -97,25 +97,6 @@ print(dap_bpm3a.dap_params)
![Waveform 1D_DAP](./bec_figure_dap.gif)
## Example 3 - 2D ScatterWaveform plot
The 2D scatter plot widget is designed for more complex data visualization. It employs a false color map to represent a third dimension (z-axis), making it an ideal tool for visualizing multidimensional data sets.
```python
# Add a new dock_area, a new dock and a BECWaveForm to the dock
plt = gui.new().new().new(gui.available_widgets.ScatterWaveform)
plt.plot(x_name='samx', y_name='samy', z_name='bpm4i')
plt = gui.add_dock().add_widget('BECFigure').add_plot(x_name='samx', y_name='samy', z_name='bpm4i')
```
![Scatter 2D](./scatter_2D.gif)
```{note}
The ScatterWaveform widget only plots the data points if both x and y axis motors are moving. Or more generally, if all signals are of readout type *monitored*.
```
````
````{tab} API