Usage¶

To call plotting functions one should import general function module inside a script:

import atomize.general_modules.general_functions as general

1D plotting¶

plot_1d('name', Xdata, Ydata, label='label', xname='NameXaxis',
        xscale='XaxisDimension', yname='NameYaxis', yscale='YaxisDimension',
        scatter='False', timeaxis='False', vline='False',
        pr='None', text='')

Argument	Description
`Xdata`, `Ydata`	numpy arrays or python lists of data
`name`	String of the plot name
`label`	String of the curve name
`text`	Label of the plot (for multithreading only)
`scatter`	`['False', 'True']`. Enables scatter plot
`timeaxis`	`['False', 'True']`. Enables time axis
`vline`	`'False'` or a tuple `(vline1, vline2)`. Shows up to two vertical lines
`pr`	Name of process for plotting in another thread

Other arguments are optional and used for automatic scaling (i.e. V to mV, etc.). Please, note that it is impossible to redraw a line with scatters if they have the same name.

There is a possibility to draw data in parallel with the main script. To do this, a keyargument pr should be used. In this mode, the function returns the thread that starts the drawing, and check on the next call whether the process has completed or not. A minimal working example for parallel drawing with dynamic label is the following:

import atomize.general_modules.general_functions as general
process = 'None'
for i in range(10):

    # draw one curve (x_axis, data_x) with a vertical line and a dynamic label "text"
    process = general.plot_1d('NAME_1', x_axis, data_1, xname='Delay',
        xscale='ns', yname='Area', yscale='V*s', label='curve',
        vline=(i, ), pr=process, text=str(i))

    # draw two curves (x_axis, data_x) and (x_axis, data_y) simultaneously
    process = general.plot_1d('NAME_2', x_axis, (data_1, data_2), label='curve',
        xname='Delay', xscale='ns', yname='Area', yscale='V*s',
        vline=(i, ), text=str(i))

A tuple (data_1, data_2) can be used as Ydata. In this case two curves will be plot simultaneously (see example above). A dynamic label based on the text keyword argument works only for parallel drawing. For a standard drawing mode a function general.text_label() should be used.

1D plotting in the test run¶

plot_1d_test('name', Xdata, Ydata, label='label', xname='NameXaxis',
        xscale='XaxisDimension', yname='NameYaxis', yscale='YaxisDimension',
        scatter='False', timeaxis='False', vline='False',
        pr='None', text='')

Same arguments and parallel-drawing semantics as plot_1d(), but the curve is drawn only when the script is launched in test mode (i.e. when the GUI's Test Scripts checkbox is on, or the script is invoked as python script.py test). In a normal experimental run plot_1d_test() is a no-op and returns None.

Use it to inspect intermediate data — generated waveforms, computed pulse shapes, derived sequences — during the pre-flight check without cluttering plots during real acquisition. It mirrors the message_test() idiom.

2D plotting¶

plot_2d('name', data, start_step=((Xstart, Xstep), (Ystart, Ystep)),
        xname='NameXaxis', xscale='XaxisDimension',
        yname='NameYaxis Field', yscale='YaxisDimension',
        zname='NameZaxis', zscale='ZaxisDimension',
        pr='None', text='')

Argument	Description
`data`	Multidimensional numpy array; example = `[[1,1,1,..],[2,2,2,..],[3,3,3,..],..]`
`name`	String of the plot name
`label`	String of the curve name
`text`	Label of the plot (for multithreading only)
`pr`	Name of process for plotting in another thread
`start_step`	List of starting points and steps for the X and Y axis

Other arguments are optional and used for automatic scaling (i.e. V to mV, etc.).

There is a possibility to draw data in parallel with the main script. To do this, a key argument pr should be used. In this mode, the function returns the thread that starts the drawing, and check on the next call whether the process has completed or not. A minimal working example for parallel drawing with dynamic label is the following:

import atomize.general_modules.general_functions as general
process = 'None'
for i in range(10):

    process = general.plot_2d('NAME', data, start_step=((0, 1), (0, 1)),
        xname='Time', xscale='ns', yname='Delay', yscale='ns',
        zname='Intensity', zscale='V', pr=process, text=str(i))

2D plotting in the test run¶

plot_2d_test('name', data, start_step=((Xstart, Xstep), (Ystart, Ystep)),
        xname='NameXaxis', xscale='XaxisDimension',
        yname='NameYaxis Field', yscale='YaxisDimension',
        zname='NameZaxis', zscale='ZaxisDimension',
        pr='None', text='')

Same arguments and parallel-drawing semantics as plot_2d(), but the surface is drawn only when the script is launched in test mode. In a normal experimental run plot_2d_test() is a no-op and returns None. Use it for diagnostic 2D inspection during the pre-flight check without polluting plots during real acquisition.

Dynamic labeling¶

text_label('label', DynamicValue)

Argument	Description
`label`	String
`DynamicValue`	Number that will change dynamically

Clearing¶

plot_remove('name_of_plot')