mahos.meas.grid_sweeper.GridSweeper#

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

Two-dimensional grid sweep measurement node.

GridSweeper controls two independent sweep parameters (x and y config sections) and reads one measurement quantity (measure section) on each grid point. The acquired result is stored as image stack data (GridSweeperData) with optional repeated 2D sweeps.

Parameters:

  • x (dict) – X-axis instrument configuration dictionary.

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

  • y (dict) – Y-axis instrument configuration dictionary.

  • y.inst (str) – Instrument name to control for the y-axis.

  • measure (dict) – Measurement instrument configuration dictionary.

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

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

Runtime behavior:

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

  • For each grid point, calls set(y.key, value, label=y.label) and set(x.key, value, label=x.label) (with configured delays), then calls get(measure.key, label=measure.label).

  • 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 GridSweeper.

__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