mahos.meas.sweeper.Sweeper#

class mahos.meas.sweeper.Sweeper(gconf: dict, name: NodeName, context=None)#

One-dimensional parameter sweep measurement node.

Sweeper controls one instrument parameter (x config section) and reads one measurement quantity (measure section) at each point. Each run produces line data (SweeperData) with optional repeated sweeps.

Parameters:
  • x (dict) – Sweep-axis instrument configuration dictionary.

  • x.inst (str) – Instrument name to control for the sweep axis.

  • measure (dict) – Measurement instrument configuration dictionary.

  • measure.inst (str) – Instrument name to read at each sweep point.

  • pub_interval_sec (float) – Maximum interval between periodic status/data publications.

Runtime behavior:

  • Uses set() and get() APIs for target instruments.

  • At each sweep point, calls set(x.key, value, label=x.label) on x.inst, waits for delay, and calls get(measure.key, label=measure.label) on measure.inst.

  • Does not call get_param_dict(), configure(), start(), or stop() for target instruments by design.

If a target instrument requires pre-configuration or start/stop signaling, users should invoke those APIs manually via Tweaker, scripts, or interactive sessions before running Sweeper.

Supported basic requests are inherited from BasicMeasNode: start / stop, parameter dict query, save / load / export, and fit / clear_fit.

__init__(gconf: dict, name: NodeName, context=None)#

Methods

__init__(gconf, name[, context])

change_state(msg)

Change state to msg.state.

close_resources()

Close custom resources.

export_data(msg)

Export data.

get_param_dict(msg)

Get parameter dict.

get_param_dict_labels(msg)

Get parameter dict labels.

load_data(msg)

Load data.

main()

Main procedure that will be looped.

save_data(msg)

Save data.

wait()

Wait until required resources are ready.

Attributes