Widget classes

class pymeasure.display.widgets.BrowserWidget(*args, parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

class pymeasure.display.widgets.DirectoryLineEdit(parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

Widget that allows to choose a directory path. A completer is implemented for quick completion. A browse button is available.

class pymeasure.display.widgets.ImageFrame(x_axis, y_axis, z_axis=None, refresh_time=0.2, check_status=True, parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

Combines a PyQtGraph Plot with Crosshairs. Refreshes the plot based on the refresh_time, and allows the axes to be changed on the fly, which updates the plotted data

parse_axis(axis)

Returns the units of an axis by searching the string

class pymeasure.display.widgets.ImageWidget(columns, x_axis, y_axis, z_axis=None, refresh_time=0.2, check_status=True, parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

Extends the PlotFrame to allow different columns of the data to be dynamically choosen

new_image(results)

Creates a new image

class pymeasure.display.widgets.InputsWidget(procedure_class, inputs=(), parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

get_procedure()

Returns the current procedure

class pymeasure.display.widgets.LogWidget(parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

class pymeasure.display.widgets.PlotFrame(x_axis=None, y_axis=None, refresh_time=0.2, check_status=True, parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

Combines a PyQtGraph Plot with Crosshairs. Refreshes the plot based on the refresh_time, and allows the axes to be changed on the fly, which updates the plotted data

parse_axis(axis)

Returns the units of an axis by searching the string

class pymeasure.display.widgets.PlotWidget(columns, x_axis=None, y_axis=None, refresh_time=0.2, check_status=True, parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

Extends the PlotFrame to allow different columns of the data to be dynamically choosen

class pymeasure.display.widgets.ResultsDialog(columns, x_axis=None, y_axis=None, parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

exception pymeasure.display.widgets.SequenceEvaluationException

Bases: Exception

Raised when the evaluation of a sequence string goes wrong.

class pymeasure.display.widgets.SequencerWidget(inputs=None, sequence_file=None, parent=None)

Bases: sphinx.ext.autodoc.importer._MockObject

Widget that allows to generate a sequence of measurements with varying parameters. Moreover, one can write a simple text file to easily load a sequence.

Currently requires a queue function of the ManagedWindow to have a “procedure” argument.

static eval_string(string, name=None, depth=None)

Evaluate the given string. The string is evaluated using a list of pre-defined functions that are deemed safe to use, to prevent the execution of malicious code. For this purpose, also any built-in functions or global variables are not available.

Parameters:
  • string – String to be interpreted.
  • name – Name of the to-be-interpreted string, only used for error messages.
  • depth – Depth of the to-be-interpreted string, only used for error messages.
load_sequence(*, fileName=None)

Load a sequence from a .txt file.

Parameters:fileName – Filename (string) of the to-be-loaded file.
queue_sequence()

Obtain a list of parameters from the sequence tree, enter these into procedures, and queue these procedures.