ISIS Standard Callbacks (ISISCallbacks)

ISISCallbacks is a helper to add common callbacks to 1-dimensional scans with a single dependent variable with an optional uncertainty and a single independent variable. This should avoid some repetition as you don’t need to pass x and y to each callback.

In most cases, ISISCallbacks should be all that you need to use for callbacks.

It is composed from the following callbacks:

• ibex_bluesky_core.callbacks.LiveFit

• ibex_bluesky_core.callbacks.LivePlot

• bluesky.callbacks.LiveTable

• bluesky.callbacks.fitting.PeakStats

• bluesky.callbacks.mpl_plotting.LiveFitPlot

• ibex_bluesky_core.callbacks.CentreOfMass

• ibex_bluesky_core.callbacks.PlotPNGSaver

• ibex_bluesky_core.callbacks.LiveFitLogger

• ibex_bluesky_core.callbacks.HumanReadableFileCallback

Live table

A LiveTable is enabled by default. This will show the values of X and Y according to their seq_num or event order.

You can pass optional fields to be displayed in the LiveTable with the fields_for_live_table argument or the measured_fields argument if you want the fields to be put in the human-readable file (see below.)

Plotting

Plotting is enabled by default and running a plan with ISISCallbacks will close any current active plots.

Fitting

If a fitting method is given via the fit argument (this is optional), fitting will be enabled. By default, this fit will be shown on a plot.

After a scan has run you can get the fitting results by using the live_fit property.

Centre of mass and Peak Stats

These are both enabled by default. To access Centre of Mass information after a plan, use the com property.

To access Peak Stats after a plan use the peak_stats property.

File output

Fit output

These are enabled by default when a fit method is given. See Saving fit results to file (LiveFitLogger) for more information.

Human readable files

These are enabled by default and are appended to throughout a bluesky run. See Human readable files for more information.

Plot PNGs

These are enabled by default. They are saved on the end of a bluesky run. See Saving plots to PNG files for more information.

Raw Bluesky Events

These are enabled, but not by ISISCallbacks. See Bluesky Event documents for more information.

Accessing callbacks directly

A list of callbacks used by the current instance can be obtained through the subs property.