bec-widgets 0.94.7__py3-none-any.whl → 0.95.0__py3-none-any.whl

docs/user/widgets/bec_figure.md

@@ -1,146 +0,0 @@
-(user.widgets.bec_figure)=
-# BECFigure
-[`BECFigure`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure) is a widget that provides a graphical user interface for creating and managing plots. It is a versatile tool that allows users to create a wide range of plots, from simple 1D waveforms to complex 2D scatter plots. BECFigure is designed to be user-friendly and interactive, enabling users to customize plots and visualize data in real-time.
-In the following, we describe 4 different type of widgets thaat are available in BECFigure. 
-
-**Schema of the BECFigure**
-
-![BECFigure.png](BECFigure.png)
-
-## [1D Waveform Widget](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform)
-
-**Purpose:** This widget provides a straightforward visualization of 1D data. It is particularly useful for plotting positioner movements against detector readings, enabling users to observe correlations and patterns in a simple, linear format.
-
-**Key Features:**
-- Real-time plotting of positioner versus detector values.
-- Interactive controls for zooming and panning through the data.
-- Customizable visual elements such as line color and style.
-
-**Example of Use:**
-![Waveform 1D](./w1D.gif)
-
-**Code example 1 - adding curves**
-
-The following code snipped demonstrates how to create a 1D waveform plot using BEC Widgets within BEC. More details about BEC Widgets in BEC can be found in the getting started section within the [introduction to the command line.](user.command_line_introduction)
-```python
-# adds a new dock, a new BECFigure and a BECWaveForm to the dock
-plt = gui.add_dock().add_widget('BECFigure').plot(x_name='samx', y_name='bpm4i')
-# add a second curve to the same plot 
-plt.plot(x_name='samx', y_name='bpm3i')
-plt.set_title("Gauss plots vs. samx")
-plt.set_x_label("Motor X")
-plt.set_y_label("Gauss Signal (A.U.")
-```
-Note, the return value of the simulated devices *bpm4i* and *bpm3i* may not be gaussian signals, but they can be easily configured with the code snippet below. For more details please check the documentation of the [simulation](https://bec.readthedocs.io/en/latest/developer/devices/bec_sim.html).
-```python
-# bpm4i uses GaussianModel and samx as a reference; default settings
-dev.bpm4i.sim.select_sim_model("GaussianModel")
-# bpm3i uses StepModel and samx as a reference; default settings
-dev.bpm3i.sim.select_sim_model("StepModel")
-```
-
-**Code example 2 - Adding Data Processing Pipeline Curve with LMFit Models**
-
-Together with the scan curve, one 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.
-
-```python
-# Add a new dock, a new BECFigure, and a BECWaveForm to the dock with a GaussianModel DAP
-plt = gui.add_dock().add_widget('BECFigure').plot(x_name='samx', y_name='bpm4i', dap="GaussianModel")
-
-# Add a second curve to the same plot without DAP
-plt.plot(x_name='samx', y_name='bpm3a')
-
-# Add DAP to the second curve
-plt.add_dap(x_name='samx', y_name='bpm3a', dap="GaussianModel")
-
-```
-
-To get the parameters of the fit, one has to retrieve the curve objects and call the dap_params property.
-
-```python
-# Get the curve object by name from the legend
-dap_bpm4i = plt.get_curve("bpm4i-bpm4i-GaussianModel")
-dap_bpm3a = plt.get_curve("bpm3a-bpm3a-GaussianModel")
-
-# Get the parameters of the fit
-print(dap_bpm4i.dap_params)
-# Output
-{'amplitude': 197.399639720862,
- 'center': 5.013486095404885,
- 'sigma': 0.9820868875739888}
-
-print(dap_bpm3a.dap_params)
-# Output
-{'amplitude': 698.3072786185278,
- 'center': 0.9702840866173836,
- 'sigma': 1.97139754785518}
-```
-
-![Waveform 1D_DAP](./bec_figure_dap.gif)
-
-(user.widgets.scatter_2d)=
-## [2D Scatter Plot](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform)
-
-**Purpose:** 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:**
-
-- 2D scatter plot with color-coded data points based on a third variable (two positioners for x/y vs. one detector for colormap).
-- Interactive false color map for enhanced data interpretation.
-- Tools for selecting and inspecting specific data points.
-
-**Example of Use:**
-![Waveform 1D](./scatter_2D.gif)
-
-**Code example**
-The following code snipped demonstrates how to create a 2D scatter plot using BEC Widgets within BEC.
-```python
-# adds a new dock, a new BECFigure and a BECWaveForm to the dock
-plt = gui.add_dock().add_widget('BECFigure').add_plot(x_name='samx', y_name='samy', z_name='bpm4i')
-```
-
-(user.widgets.motor_map)=
-## [Motor Position Map](/api_reference/_autosummary/bec_widgets.cli.client.BECMotorMap)
-
-**Purpose:** A specialized component derived from the Motor Alignment Tool. It's focused on tracking and visualizing the position of motors, crucial for precise alignment and movement tracking during scans.
-
-**Key Features:**
-- Real-time tracking of motor positions.
-- Visual representation of motor trajectories, aiding in alignment tasks.
-
-**Example of Use:**
-![Waveform 1D](./motor.gif)
-
-**Code example**
-The following code snipped demonstrates how to create a motor map using BEC Widgets within BEC.
-```python
-# add a motor map to the gui
-mot_map = gui.add_dock().add_widget('BECFigure').motor_map('samx', 'samy')
-# change the number of points displayed
-```
-
-(user.widgets.image_2d)=
-## [Image Plot](/api_reference/_autosummary/bec_widgets.cli.client.BECImageItem)
-
-**Purpose:** A versatile widget for visualizing 2D image data, such as camera images. It provides a detailed representation of image data, with an attached color and scale bar to dynamically adjust the image display.
-
-**Key Features:**
-- Live-plotting of 2D image data from cameras (*if data stream is available in BEC*).
-- Color maps and scale bars for customizing image display.
-**Example of Use:**
-![Image 2D](./image_plot.gif)
-
-**Code example**
-The following code snipped demonstrates how to create a motor map using BEC Widgets within BEC.
-```python
-# add a camera view for the eiger camera to the gui
-cam_widget = gui.add_dock().add_widget('BECFigure').image('eiger')
-# set the title of the camera view
-cam_widget.set_title("Camera Image Eiger")
-# change the color map range, e.g. from 0 to 100, per default it is autoscaling
-# Note, the simulation has hot pixels on the detector
-cam_widget.set_vrange(vmin=0, vmax=100)
-```

docs/user/widgets/bec_status_box.md

@@ -1,30 +0,0 @@
-(user.widgets.bec_status_box)=
-# BEC Status Box
-**Purpose:**
-
-The [BECStatusBox](/api_reference/_autosummary/bec_widgets.cli.client.BECStatusBox) is a widget that allows you to monitor the status/health of the all running BEC processes. The widget generates the view automatically and updates the status of the processes in real-time. The top level indicates the overall state of the BEC core services (DeviceServer, ScanServer, SciHub, ScanBundler and FileWriter), but you can also see the status of each individual process by opening the collapsed view. In the collapsed view, you can double click on each process to get a popup window with live updates of the metrics for each process in real-time.
-
-**Key Features:**
-
-- monitor the state of individual BEC services.
-- automatically track BEC services, i.e. additional clients connecting.
-- live-updates of the metrics for each process.
-
-**Example of Use:**
-![BECStatus](./bec_status_box.gif)
-
-**Code example:**
-
-The following code snipped demonstrates how to create a `BECStatusBox` widget using BEC Widgets within BEC.
-```python
-bec_status_box = gui.add_dock().add_widget("BECStatusBox")
-```
-
-
-
-
-
-
-
-
-

docs/user/widgets/buttons.md

@@ -1,37 +0,0 @@
-(user.widgets.buttons)=
-# Buttons Widgets
-
-This section consolidates various custom buttons used within the BEC GUIs, facilitating the integration of these
-controls into different layouts.
-
-## Stop Button
-
-**Purpose:**
-
-The `Stop Button` provides a user interface control to immediately halt the execution of the current operation in the
-BEC Client. It is designed for easy integration into any BEC GUI layout.
-
-**Key Features:**
-
-- **Immediate Termination:** Halts the execution of the current script or process.
-- **Queue Management:** Clears any pending operations in the scan queue, ensuring the system is ready for new tasks.
-
-**Code example:**
-
-Integrating the `StopButton` into a BEC GUI layout is straightforward. The following example demonstrates how to embed
-a `StopButton` within a GUI layout:
-
-```python
-from qtpy.QtWidgets import QWidget, QVBoxLayout
-from bec_widgets.widgets.buttons import StopButton
-
-
-class MyGui(QWidget):
-    def __init__(self):
-        super().__init__()
-        self.setLayout(QVBoxLayout(self))  # Initialize the layout for the widget
-
-        # Create and add the StopButton to the layout
-        self.stop_button = StopButton()
-        self.layout().addWidget(self.stop_button)
-```

docs/user/widgets/ring_progress_bar.md

@@ -1,54 +0,0 @@
-(user.widgets.spiral_progress_bar)=
-# [Ring Progress Bar](/api_reference/_autosummary/bec_widgets.cli.client.RingProgressBar)
-
-**Purpose:**
-
-The ring Progress Bar widget is a circular progress bar that can be used to visualize the progress of a task. The
-widget is designed to be used in applications where the progress of a task is represented as a percentage. The Spiral
-Progress Bar widget is a part of the BEC Widgets library and can be controlled directly using its API, or hooked up to
-the progress of a device readback or scan.
-
-**Key Features:**
-
-- circular progress bar to show updates on the progress of a task.
-- hooks to update the progress bar from a device readback or scan.
-- multiple progress rings to show different tasks in parallel.
-
-**Example of Use:**
-![RingProgressBar](./progress_bar.gif)
-
-**Code example:**
-
-The following code snipped demonstrates how to create a `RingProgressBar` using BEC Widgets within BEC.
-```python
-# adds a new dock with a ring progress bar
-progress = gui.add_dock().add_widget("RingProgressBar")
-# customize the size of the ring
-progress.set_line_width(20)
-```
-
-By default, the Ring Progress Bar widget will display a single ring. To add more rings, use the add_ring method:
-
-```python
-# adds a new dock with a ring progress bar
-progress.add_ring()
-```
-
-To access rings and specify their properties, you can use `progress.rings` with an index specifying the ring index (
-starting from 0):
-
-```python
-progress.rings[0].set_line_width(20)  # set the width of the first ring
-progress.rings[1].set_line_width(10)  # set the width of the second ring
-```
-
-By default, the `RingProgressBar` widget is set with `progress.enable_auto_update(True)`, which will automatically
-update the bars in the widget. To manually set updates for each progress bar, use the set_update method. Note that
-manually updating a ring will disable the automatic update for the whole widget:
-
-```python
-progress.rings[0].set_update("scan")  # set the update of the first ring to be an overall scan progress
-progress.rings[1].set_update("device",
-                             "samx")  # set the update of the second ring to be a device readback (in this case, samx)
-```
-

docs/user/widgets/scan_control.md

@@ -1,35 +0,0 @@
-(user.widgets.scan_control)=
-
-# Scan Control
-
-**Purpose:**
-
-The `ScanControl` widget is designed to generate a graphical user interface (GUI) to control various scan operations
-based on the scan's signature and `gui_config`. The widget is used to control the scan operations, such as starting,
-stopping, and pausing the scan. The widget also provides a graphical representation of the scan progress and the scan
-status. The widget is designed to be used in conjunction with the `ScanServer` and `ScanBundler` services from the BEC
-core services.
-
-By default the widget supports only the scans which have defined `gui_config` and are inhereted from these scan classes:
-
-- [ScanBase](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_server.scan_server.scans.ScanBase.html)
-- [SyncFlyScanBase](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_server.scan_server.scans.SyncFlyScanBase.html)
-- [AsyncFlyScanBase](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_server.scan_server.scans.AsyncFlyScanBase.html)
-
-**Key Features:**
-
-- Automatically generates a control interface based on scan signatures and `gui_config`.
-- Supports adding and removing argument bundles dynamically.
-- Provides a visual representation of scan parameters grouped by functionality.
-- Integrates start and stop controls for executing and halting scans.
-
-**Example of Use:**
-
-**Code example:**
-The following code snipped demonstrates how to create a `ScanControl` widget using BEC Widgets within `BECIPythonClient`
-
-![ScanControl](./scan_control.gif)
-
-```python
-scan_control = gui.add_dock().add_widget("ScanControl")
-```

docs/user/widgets/text_box.md

@@ -1,33 +0,0 @@
-(user.widgets.text_box)=
-# [Text Box Widget](/api_reference/_autosummary/bec_widgets.cli.client.TextBox)
-**Purpose:**
-
-The Text Box Widget is a widget that allows you to display text within the BEC GUI. The widget can be used to display plain text or HTML text.
-
-**Key Features:**
-
-- set the text to display.
-- automatically detects if the text is plain text or HTML text.
-- set background color and font color.
-
-**Code example:**
-
-The following code snipped demonstrates how to create a `TextBox` widget using BEC Widgets within BEC.
-```python
-text_box = gui.add_dock().add_widget("TextBox")
-# set the text to display
-text_box.set_text("Hello, World!")
-# set the background color and font color
-text_box.set_color(backgroud_color="#FFF", font_color="#000")
-# set the text to display as HTML
-text_box.set_text("<h1>Welcome to BEC Widgets</h1><p>This is an example of displaying <strong>HTML</strong> text.</p>")
-```
-
-
-
-
-
-
-
-
-

docs/user/widgets/website.md

@@ -1,21 +0,0 @@
-(user.widgets.website)=
-# [Website Widget](/api_reference/_autosummary/bec_widgets.cli.client.WebsiteWidget)
-**Purpose:**
-
-The Website Widget is a widget that allows you to display a website within the BEC GUI. The widget can be used to display any website. 
-
-**Key Features:**
-
-- set the URL of the website to display.
-- reload the website.
-- navigate back and forward in the website history.
-
-**Code example:**
-
-The following code snipped demonstrates how to create a `WebsiteWidget` using BEC Widgets within BEC.
-```python
-# adds a new dock with a website widget
-web = gui.add_dock().add_widget("Website")
-# set the URL of the website to display
-web.set_url("https://bec.readthedocs.io/en/latest/")
-```