User Interface Overview¶
UI Nomenclature¶
This section provides an overview of the LabOne User Interface, its main elements and naming conventions. The LabOne User Interface is a browser-based UI provided as the primary interface to the HDAWG instrument. Multiple browser sessions can access the instrument simultaneously and the user can have displays on multiple computer screens. Parallel to the UI, the instrument can be controlled and read out by custom programs written in any of the supported languages (e.g. LabVIEW, MATLAB, Python, C) connecting through the LabOne APIs.
The LabOne User Interface automatically opens some tabs by default after a new UI session has been started. At start-up, the UI is divided into two tab rows, each containing a tab structure that gives access to the different LabOne tools. Depending on display size and application, tab rows can be freely added and deleted with the control elements on the right-hand side of each tab bar. Similarly, the individual tabs can be deleted or added by selecting app icons from the side bar on the left. A click on an icon adds the corresponding tab to the display, alternatively the icon can be dragged and dropped into one of the tab rows. Moreover, tabs can be moved by drag-and-drop within a row or across rows.
Table 1 gives a brief descriptions and naming conventions for the most important UI items.
Item name | Position | Description | Contains |
---|---|---|---|
side bar | left-hand side of the UI | contains app icons for each of the available tabs - a click on an icon adds or activates the corresponding tab in the active tab row | app icons |
status bar | bottom of the UI | contains important status and warning indicators, device and session information, and access to the command log | status indicators |
main area | center of the UI | accommodates all active tabs – new rows can be added and removed by using the control elements in the top right corner of each tab row | tab rows, each consisting of tab bar and the active tab area |
tab area | inside of each tab | provides the active part of each tab consisting of settings, controls and measurement tools | sections, plots, sub-tabs, unit selections |
Further items are highlighted in Figure 2.
Unique Set of Analysis Tools¶
All instruments feature a comprehensive tool set for signal generation and sequence programming.
The following table gives the overview of all app icons. Note that the selection of app icons may depend on the upgrade options installed on a given instrument.
provides a quick overview over the different status bar elements along with a short description.
Status bar description
Plot Functionality¶
Several tools - Waveform viewer, Plotter, Data Acquisition, and Sweeper provide a graphical display of data in the form of plots. These are multi-functional tools with zooming, panning and cursor capability. This section introduces some of the highlights.
Plot Area Elements¶
Plots consist of the plot area, the X range and the range controls. The X range (above the plot area) indicates which section of the wave is displayed by means of the blue zoom region indicators. The two ranges show the full scale of the plot which does not change when the plot area displays a zoomed view. The two axes of the plot area instead do change when zoom is applied.
The mouse functionality inside of a plot greatly simplifies and speeds up data viewing and navigation.
Name | Action | Description | Performed inside |
---|---|---|---|
Panning | left click on any location and move around | moves the waveforms | plot area |
Zoom X axis | mouse wheel | zooms in and out the X axis | plot area |
Zoom Y axis | shift + mouse wheel | zooms in and out the Y axis | plot area |
Window zoom | shift and left mouse area select | selects the area of the waveform to be zoomed in | plot area |
Absolute jump of zoom area | left mouse click | moves the blue zoom range indicators | X and Y range, but outside of the blue zoom range indicators |
Absolute move of zoom area | left mouse drag-and-drop | moves the blue zoom range indicators | X and Y range, inside of the blue range indicators |
Full Scale | double click | set X and Y axis to full scale | plot area |
Each plot area contains a legend that lists all the shown signals in the respective color. The legend can be moved to any desired position by means of drag-and-drop.
The X range and Y range plot controls are described in Table 4.
Cursors and Math¶
The plot area provides two X and two Y cursors which appear as dashed lines inside of the plot area. The four cursors are selected and moved by means of the blue handles individually by means of drag-and-drop. For each axis, there is a primary cursor indicating its absolute position and a secondary cursor indicating both absolute and relative position to the primary cursor.
Cursors have an absolute position which does not change upon pan or zoom events. In case a cursor position moves out of the plot area, the corresponding handle is displayed at the edge of the plot area. Unless the handle is moved, the cursor keeps the current position. This functionality is very effective to measure large deltas with high precision (as the absolute position of the other cursors does not move).
The cursor data can also be used to define the input data for the mathematical operations performed on plotted data. This functionality is available in the Math sub-tab of each tool. The Table 5 gives an overview of all the elements and their functionality. The chosen Signals and Operations are applied to the currently active trace only.
Note
The standard deviation is calculated using the formula \(\sqrt \frac{1}{N-1}\sum_{i=1}^{N}(x_i-\bar{x})^2\) for the unbiased estimator of the sample standard deviation with a total of N samples \(x_i\) and an arithmetic average \(\bar{x}\). The formula above is used as-is to calculate the standard deviation for the Histogram Plot Math tool. For large number of points (Cursor Area and Plot Area tools), the more accurate pairwise algorithm is used (Chan et al., "Algorithms for Computing the Sample Variance: Analysis and Recommendations", The American Statistician 37 (1983), 242-247).
Note
The fitting functions used in the Resonance Plot Math tool depend on the selected signal source. The demodulator R signal is fitted with the following function:
where \(C\) accounts for a possible offset in the output, \(A\) is the amplitude, \(Q\) is the quality factor and \(f_0\) is the center frequency. The demodulator \(\phi\) signal s fitted with the following function:
using the same parameters as above.
Tree Selector¶
The Tree selector allows one to access streamed measurement data in a hierarchical structure by checking the boxes of the signals that should be displayed. The tree selector also supports data selection from multiple instruments, where available. Depending on the tool, the Tree selector is either displayed in a separate Tree sub-tab, or it is accessible by a click on the button.
Vertical Axis Groups¶
Vertical Axis groups are available as part of the plot functionality in many of the LabOne tools. Their purpose is to handle signals with different axis properties within the same plot. This is particularly useful when operating a HDAWG together with a lock-in amplifier from the Zurich Instruments UHF, HF, or MF series. Signals with different units naturally have independent vertical scales even if they are displayed in the same plot. However, signals with the same unit should preferably share one scaling to enable quantitative comparison. To this end, the signals are assigned to specific axis group. Each axis group has its own axis system. This default behavior can be changed by moving one or more signals into a new group.
The tick labels of only one axis group can be shown at once. This is the foreground axis group. To define the foreground group click on one of the group names in the Vertical Axis Groups box. The current foreground group gets a high contrast color.
Select foreground group
Click on a signal name or group name inside the Vertical Axis Groups. If a group is empty the selection is not performed.
Split the default vertical axis group
Use drag-and-drop to move one signal on the field [Drop signal here to add a new group]. This signal will now have its own axis system.
Change vertical axis group of a signal
Use drag-and-drop to move a signal from one group into another group that has the same unit.
Group separation
In case a group hosts multiple signals and the unit of some of these signals changes, the group will be split in several groups according to the different new units.
Remove a signal from the group
In order to remove a signal from a group drag-and-drop the signal to a place outside of the Vertical Axis Groups box.
Remove a vertical axis group
A group is removed as soon as the last signal of a custom group is removed. Default groups will remain active until they are explicitly removed by drag-and-drop. If a new signal is added that match the group properties it will be added again to this default group. This ensures that settings of default groups are not lost, unless explicitly removed.
Rename a vertical axis group
New groups get a default name "Group of ...". This name can be changed by double-clicking on the group name.
Hide/show a signal
Uncheck/check the check box of the signal. This is faster than fetching a signal from a tree again.
Demodulator data is only available when using a Zurich Instruments lock-in amplifier from the SHF, UHF, HF, or MF series.
Trends¶
The Trends tool lets the user monitor the temporal evolution of signal features such as minimum and maximum values, or mean and standard deviation. This feature is available for the Plotter, and DAQ tab. Using the Trends feature, one can monitor all the parameters obtained in the Math sub-tab of the corresponding tab.
The Trends tool allows the user to analyze recorded data on a different and adjustable time scale much longer than the fast acquisition of measured signals. It saves time by avoiding post-processing of recorded signals and it facilitates fine-tuning of experimental parameters as it extracts and shows the measurement outcome in real time.
To activate the Trends plot, enable the Trends button in the Control sub-tab of the corresponding main tab. Various signal features can be added to the plot from the Trends sub-tab in the Vertical Axis Groups . The vertical axis group of Trends has its own Run/Stop button and Length setting independent from the main plot of the tab. Since the Math quantities are derived from the raw signals in the main plot, the Trends plot is only shown together with the main plot. The Trends feature is only available in the LabOne user interface and not at the API level.