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: extend waveform docs

Browse Source
This commit is contained in:
appel_c
2024-09-06 12:46:00 +02:00
parent b1aff6d791
commit e6976dc151
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -75,7 +75,7 @@ dev.bpm3i.sim.select_sim_model("StepModel")
``` ```
## Example 4 - Adding Data Processing Pipeline Curve with LMFit Models ## Example 4 - Adding Data Processing Pipeline Curve with LMFit Models
In addition to the scan curve, you can also add a second curve that fits the signal using a specified model from [LMFit](https://lmfit.github.io/lmfit-py/builtin_models.html). The following code snippet demonstrates how to create a 1D waveform curve with an attached DAP process, or how to add a DAP process to an existing curve using the BEC CLI. Please note that for this example, both devices were set as Gaussian signals. In addition to the scan curve, you can also add a second curve that fits the signal using a specified model from [LMFit](https://lmfit.github.io/lmfit-py/builtin_models.html). The following code snippet demonstrates how to create a 1D waveform curve with an attached DAP process, or how to add a DAP process to an existing curve using the BEC CLI. Please note that for this example, both devices were set as Gaussian signals. You can also add a region of interest (roi) to the plot which will respected by all running DAP processes.
```python ```python
# Add a new dock, a new BECFigure, and a BECWaveForm to the dock with a GaussianModel DAP # Add a new dock, a new BECFigure, and a BECWaveForm to the dock with a GaussianModel DAP
@ -87,6 +87,13 @@ plt.plot(x_name='samx', y_name='bpm3a')
# Add DAP to the second curve # Add DAP to the second curve
plt.add_dap(x_name='samx', y_name='bpm3a', dap="GaussianModel") plt.add_dap(x_name='samx', y_name='bpm3a', dap="GaussianModel")
# Add roi to the plot, this limits the DAP fit to the selected region x_min=-1, x_max=1
# The fit will automatically update
plt.select_roi(region=(-1, 1))
# To remove the DAP from the curve, you can use the toggle button in the toolbar or the following command
plt.toggle_roi(False)
``` ```
To get the parameters of the fit, you need to retrieve the curve objects and call the `dap_params` property. To get the parameters of the fit, you need to retrieve the curve objects and call the `dap_params` property.