Parameters

From SweepMe! Wiki
Jump to navigation Jump to search

The widget 'Parameters' shows a list of all parameters of the system together with their current value, type and length or shape. All these parameters can be used in the Parameter system as variables in text input fields. Parameters of modules that are unchecked in the sequencer are not listed.

The Parameters widget is a permanent widget of the Dashboard. Show or hide it via the menu Widgets or with F3.

Right-click on a parameter key to copy the key, e.g. Copy Time_elapsed_s, or the key including curly brackets, e.g. Copy {Time_elapsed_s}. Right-click on a value to copy the value.

All parameters can be filtered by entering strings that the searched parameters should contain. Several filter strings can be separated by spaces, and a parameter is shown if its key contains one of them. The filter is not case-sensitive and can make use of regular expressions.

From version 1.6.1, the Parameter picker ("{}" button in input fields) offers a faster way to insert parameters into input fields.

Parameter types

System parameters

SweepMe! adds parameters such as datapath, profile, folder, filename, run_index and date and time parameters like Y, m, d, H, M and S, as they are needed e.g. to create custom save paths and data file names including timestamps.

Measurement variables

Variables returned by each module are added to the Parameter system based on the module label, the variable and the unit. They are joined with underscores, and spaces are replaced by underscores. For example, the elapsed time of the Time module translates into the parameter key 'Time_elapsed_s'. These parameters represent measurement variables that are acquired during a measurement point and returned at the end of a measurement point.

Sweep state parameters

Each module further adds information about its sweep state: the current set value is named '<module label>_SweepValue' and the index of the set value step is named '<module label>_SweepIndex' (starting from 1). Further, the parameter '<module label>_is_active' is a boolean indicating whether the module is currently in an active branch. See When are values available? for when these values are set.