Python Toolkit API SHFQA Sweeper Module¶
zhinst.toolkit.driver.modules.shfqa_sweeper.SHFQASweeper(session)
¶
Bases: Node
Toolkit adaption for the zhinst.utils.SHFSweeper.
For now the general sweeper module does not support the SHFQA. However a
python based implementation called SHFSweeper does already provide
this functionality. The SHFSweeper is part of the zhinst module
and can be found in the utils.
Toolkit wraps around the SHFSweeper and exposes a interface that is
similar to the LabOne modules, meaning the parameters are exposed in a
node tree like structure.
All parameters can be accessed through their corresponding node: * device: Device to run the sweeper with * sweep: Frequency range settings for a sweep * rf: RF in- and output settings for a sweep * average: Averaging settings for a sweep * trigger: Settings for the trigger * envelope: Settings for defining a complex envelope for pulsed spectroscopy
The underlying module is updated with the parameter changes automatically. Every functions from the underlying SHFSweeper module is exposed and can be used in the same way.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
daq_server |
Client Session that should be used by the sweeper. |
required | |
session |
Session
|
Session to the Data Server. |
required |
get_offset_freq_vector()
¶
Get vector of frequency points.
This method wraps around the get_offset_freq_vector method of
zhinst.utils.shf_sweeper
Returns:
| Type | Description |
|---|---|
Any
|
Vector of frequency points. |
get_result()
¶
Get the measurement data of the last sweep.
This method wraps around the get_result method of
zhinst.utils.shf_sweeper
Returns:
| Type | Description |
|---|---|
dict
|
A dictionary with measurement data of the last sweep. |
plot()
¶
Plot power over frequency for last sweep.
This method wraps around the plot method of
zhinst.utils.shf_sweeper