-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathapplet_commands.txt
97 lines (85 loc) · 4.06 KB
/
applet_commands.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
Applets for the ARTIQ dashboard
===============================
[Current Scan]
# The current scan applet displays the average value returned from the measure() method at each scan point.
# Each point displayed is for a single scan point. Scans configured to calculate statistics will automatically
# write statistics to the `current_scan` namespace. The current scan applet plots this contained in the
# `current_scan` namespace. This plot is updated as the scan executes.
$python -m scan_framework.applets.plot_xy current_scan.plots.y
--x current_scan.plots.x
--fit current_scan.plots.fitline
--title current_scan.plots.plot_title
--x_scale current_scan.plots.x_scale
--x_units current_scan.plots.x_units
--y_scale current_scan.plots.y_scale
--x_label current_scan.plots.x_label
--y_units current_scan.plots.y_units
--y_label current_scan.plots.y_label
--rid current_scan.rid
--error current_scan.plots.error
[Count Monitor]
# The count monitor applet displays the average value returned by the measure() method after each scan point
# completes.
${artiq_applet}big_number counts
[Current Histogram]
# The current histogram applet plots a histogram of all values returned by the measure() during a single scan point.
# The histogram gives the distribution in measurement values only for the current scan point. This plot is updated
# as the scan executes.
$python -m scan_framework.applets.plot_hist current_hist.bins
--x current_hist.bin_boundaries
--x_units current_hist.x_units
--x_label current_hist.x_label
--plot_title current_hist.plot_title
[Current Aggregate Histogram]
# The current aggregate histogram applet plots a histogram of all values returned by the measure() during the entire
# scan. The histogram is aggregate over all scan points. This plot is updated as the scan executes.
$python -m scan_framework.applets.plot_hist current_hist.aggregate_bins
--x current_hist.bin_boundaries
--x_units current_hist.x_units
--x_label current_hist.x_label
--plot_title current_hist.plot_title
[Current Sub Scan (for 2D scans)]
# The current sub scan applet plots the mean value returned by the measure() method of the sub-scan of a 2D scan.
# This plot is updated as the scan executes and is cleared after each sub-scan completes.
$python -m scan_framework.applets.plot_xy current_scan.plots.dim1.y
--x current_scan.plots.dim1.x
--fit current_scan.plots.dim1.fitline
--title current_scan.plots.dim1.plot_title
--x_scale current_scan.plots.dim1.x_scale
--x_units current_scan.plots.dim1.x_units
--x_label current_scan.plots.dim1.x_label
--y_units current_scan.plots.dim1.y_units
--y_label current_scan.plots.dim1.y_label
--trigger current_scan.plots.trigger
--rid current_scan.rid
--i_plot current_scan.plots.subplot.i_plot
[Current Sub Scan No Fits (for 2D scans)]
# Same as the current sub-scan applet, except the curve of the best fit is not plotted.
$python -m scan_framework.applets.plot_xy current_scan.plots.dim1.y
--x current_scan.plots.dim1.x
--title current_scan.plots.dim1.plot_title
--x_scale current_scan.plots.dim1.x_scale
--x_units current_scan.plots.dim1.x_units
--x_label current_scan.plots.dim1.x_label
--y_units current_scan.plots.dim1.y_units
--y_label current_scan.plots.dim1.y_label
--trigger current_scan.plots.trigger
--rid current_scan.rid
--i_plot current_scan.plots.subplot.i_plot
Applets for the ARTIQ browser
=============================
[Current Scan For The ARTIQ Browser]
# Same as the current_scan appleta bove, but for the ARTIQ browser.
$python -m scan_framework.applets.plot_xy current_scan.plots.y
--x current_scan.plots.x
--fit current_scan.plots.fitline
--title current_scan.plots.plot_title
--x_scale current_scan.plots.x_scale
--x_units current_scan.plots.x_units
--y_scale current_scan.plots.y_scale
--x_label current_scan.plots.x_label
--y_units current_scan.plots.y_units
--y_label current_scan.plots.y_label
--rid current_scan.rid
--error current_scan.plots.error
--trigger 1