Sweep

From SweepMe! Wiki
Jump to navigation Jump to search

The Sweep module creates arbitrary variations of values and hands them over to other modules. It does not control an instrument.

Since SweepMe! 1.5.8.2, Sweep is a Pro module.

Sweep value

Select in the field "Sweep value" how the values are defined:

  • SweepEditor: create values with the SweepEditor.
  • SweepBox: enter comma-separated values in the SweepBox.
  • List: select a list-like variable of another module in the field "List input:". The module sweeps over the items of this list. The field also accepts a JSON array, e.g. [1, 2, 3], or comma-separated values (since SweepMe! 1.5.8.2).

Dynamic values

Since SweepMe! 1.5.8.2, the values of the SweepEditor and the SweepBox can contain parameters of other modules using the curly parameter syntax {...} of the Parameter system. Such values are evaluated each time the branch of the Sweep module is entered, so the values and even the number of values can change during the measurement. The same applies to the List input, which is read each time the branch is entered.

If the selected list is empty, the run is stopped with a message. Use the Parameters widget to check the current value of each variable.

Variables

The module returns "Value" (the current sweep value) and "Index" (the index of the current sweep value). Use the check boxes "Plot" and "Save" to define whether these variables are plotted and saved.

Because the module "Sweep" does not measure anything and already knows the next set value early, it makes it readily available to the Parameter system, e.g. for use as set value by other modules. The parameter is "<module label>_Value". In the parameter system, "<module label>_Value" and "<module label>_SweepValue" are equivalent.

Applications

  • Define sweep values and hand them over to multiple other modules. For example, two source-measuring units (SMUs) could always apply the same voltage.
  • Define string type sweep values that are more descriptive than given by the Loop module.
  • Sweep over a list returned by another module, e.g. a list of positions or file names.