plotting

plotting.line

A plotting module for line plots

plotting.line.plotHistogram(param, hmin=None, hmax=None, bins=100, label='', density=False, vline=None, history=100, mask=None, log10=False, name_extension='', name=None, group=None)

Plotting a histogram.

Args:

param(Record):The histogram is based on param.data.flat

Kwargs:

hmin(float):Minimum, default = record.data.min() hmax(float):Maximum, default = record.data.max() bins(int):Nr. of bins, default = 100 label(str):Label for param density(bool):If True, the integral of the histogram is 1 history(int):Length of history buffer

plotting.line.plotHistory(param, label='', history=100, hline=None, runningHistogram=False, window=20, bins=100, hmin=0, hmax=100, name_extension='', name=None, group=None, **kwargs)

Plotting history of a parameter.

Args:

param(Record):The history is based on param.data

Kwargs:

label(str):Label for param history(int):Length of history buffer

plotting.line.plotTimestamp(timestamp, name=None, group=None, **kwargs)

plotting.line.plotTrace(paramY, paramX=None, label='', history=100, tracelen=None, name=None, group=None)

Plotting a trace.

Args:

paramY(Record):The data for the ordinate is paramY.data.ravel()

Kwargs:

paramX(Record):The data for the abscissa is paramX.data.ravel() if paramX is not None label(str):Label for param history(int):Length of history buffer

plotting.image

A plotting module for images

plotting.image.plotImage(record, history=10, vmin=None, vmax=None, log=False, mask=None, msg=None, alert=False, name=None, group=None, send_rate=None)

Plotting an image.

Args:

record(Record):record.data is plotted as an image

Kwargs:

history(int):Length of history buffer vmin(float):Minimum value vmax(float):Maximum value log(boolean):Plot image in log scale (needs restart of GUI, only works with grayscale colormap) mask(boolean or int):  Multiply image with mask

plotting.correlation

A plotting module for correlations and maps

plotting.correlation.plotCorrelation(X, Y, history=100, name=None, group=None)

Plotting the correlation of two parameters X and Y over time. (Using a buffer in the backend).

Args:

X(Record):An event parameter, e.g. hit rate Y(Record):An event parameter, e.g. some motor position

Kwargs:

history(int):Buffer length

plotting.correlation.plotHeatmap(X, Y, xmin=0, xmax=1, xbins=10, ymin=0, ymax=1, ybins=10, name=None, group=None)

Plotting the heatmap of two parameters X and Y. Has been tested in MPI mode. (Using a buffer in the backend).

Args:

X(Record):An event parameter, e.g. hit rate Y(Record):An event parameter, e.g. some motor position

Kwargs:

xmin(int):default = 0 xmax(int):default = 1 xbins(int):default = 10 ymin(int):default = 0 ymax(int):default = 1 ybins(int):default = 10

plotting.correlation.plotMeanMap(X, Y, Z, xmin=0, xmax=10, xbins=10, ymin=0, ymax=10, ybins=10, xlabel=None, ylabel=None, msg='', dynamic_extent=False, initial_reset=False, name=None, group=None)

Plotting the meanmap of Z as a function of two parameters X and Y. (No buffer in the backend).

Args:

X(Record,float):  An event parameter, e.g. injector position in x Y(Record,float):  An event parameter, e.g. injector position in y Z(Record,float):  Some metric, e.g. hit rate, size, etc...

Kwargs:

xmin(int):default = 0 xmax(int):default = 10 xbins(int):default = 10 ymin(int):default = 0 ymax(int):default = 10 ybins(int):default = 10 name(str):The key that appears in the interface (default = MeanMap(X.name, Y.name)) xlabel(str): ylabel(str): msg(msg):Any message to be displayed in the plot

plotting.correlation.plotMeanMapDynamic(X, Y, Z, norm=1.0, msg='', update=100, xmin=0, xmax=100, ymin=0, ymax=100, step=10, localRadius=100, overviewStep=100, xlabel=None, ylabel=None, name=None, group=None)

Plotting the mean of parameter Z as a function of parameters X and Y. (Using a buffer in the backend).

Args:

X(Record):An event parameter e.g. Motor position in X Y(Record):An event parameter e.g. Motor position in Y Z(Record):An event parameter e.g. Intensity

Kwargs:

norm(int):Z is normalized by a given value, e.g. gmd (default = 1) msg (str):A message to be displayed in the plot update (int):After how many new data points, an update is send to the frontend (default = 100) xmin (int):(default = 0) xmax (int):(default = 100) ymin (int):(default = 0) ymax (int):(default = 100) step (int):The resolution of the map in units of x,y (default = 10) xlabel (str):(default = X.name) ylabel (str):(default = Y.name) localRadius (int):  The radius of a square neighborehood around the current position (X.data, Y.data) (default = 100) overviewStep (int):  The resolution of the overiew map (default = 100)

plotting.correlation.plotScatter(X, Y, name=None, history=100, xlabel=None, ylabel=None, group=None)

Plotting the scatter of two parameters X and Y. (No buffer in the backend).

Args:

X(Record):An event parameter, e.g. injector position in x Y(Record):An event parameter, e.g. injector position in y

Kwargs:

name(str):The key that appears in the interface (default = MeanMap(X.name, Y.name)) xlabel(str): ylabel(str):

plotting.correlation.plotScatterBg(X, Y, name=None, history=100, xlabel=None, ylabel=None, bg_filename=None, bg_xmin=0.0, bg_xmax=1.0, bg_ymin=0.0, bg_ymax=0.0, bg_angle=0.0, group=None)

Plotting the scatter of two parameters X and Y.

plotting.correlation.plotScatterColor(X, Y, Z, name=None, history=100, xlabel=None, ylabel=None, zlabel=None, vmin=None, vmax=None, group=None)

Plotting the scatter of two parameters X and Y and use Z for color. (No buffer in the backend).

Args:

X(Record):An event parameter, e.g. injector position in x Y(Record):An event parameter, e.g. injector position in y Z(Record):An event parameter, e.g. injector position in z

Kwargs:

name(str):The key that appears in the interface (default = MeanMap(X.name, Y.name)) xlabel(str): ylabel(str):