mirror of
https://github.com/bec-project/bec_widgets.git
synced 2025-07-14 11:41:49 +02:00
docs: updated docs for v2 (#531)
This commit is contained in:
BIN
docs/user/widgets/scatter_waveform/scatter_2D.gif
Normal file
BIN
docs/user/widgets/scatter_waveform/scatter_2D.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 13 MiB |
39
docs/user/widgets/scatter_waveform/scatter_waveform.md
Normal file
39
docs/user/widgets/scatter_waveform/scatter_waveform.md
Normal file
@ -0,0 +1,39 @@
|
||||
(user.widgets.scatter_waveform_widget)=
|
||||
|
||||
# Scatter Waveform Widget
|
||||
|
||||
````{tab} Overview
|
||||
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.
|
||||
|
||||
## Key Features:
|
||||
- **Real-Time Data Visualization**: Display 2D scatter plots with a third dimension represented by color.
|
||||
- **Flexible Integration**: Can be integrated into [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`.
|
||||
|
||||
````
|
||||
|
||||
````{tab} Examples - CLI
|
||||
|
||||
`ScatterWaveform` widget can be embedded in [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`. The command-line API is consistent across these contexts.
|
||||
|
||||
## Example
|
||||
|
||||
```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')
|
||||
|
||||
```
|
||||
|
||||

|
||||
|
||||
|
||||
```{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
|
||||
```{eval-rst}
|
||||
.. include:: /api_reference/_autosummary/bec_widgets.cli.client.ScatterWaveform.rst
|
||||
```
|
||||
````
|
Reference in New Issue
Block a user