ibex_bluesky_core.callbacks.fitting.livefit_logger

Creates a readable .csv file of Bluesky fitting metrics.

Members

LiveFitLogger

Generates files as part of a scan that describe the fit(s) which have been performed.
class ibex_bluesky_core.callbacks.fitting.livefit_logger.LiveFitLogger(livefit: LiveFit, y: str, x: str, output_dir: Path, postfix: str, yerr: str | None = None)[source]

Bases: CallbackBase

Generates files as part of a scan that describe the fit(s) which have been performed.

Initialise LiveFitLogger callback.

Parameters:

  • livefit (LiveFit) – A reference to LiveFit callback to collect fit info from.

  • y (str) – The name of the signal pointing to y counts data.

  • x (str) – The name of the signal pointing to x counts data.

  • output_dir (str) – A path to where the fitting file should be stored.

  • postfix (str) – A small string that should be placed at the end of the filename to disambiguate multiple fits and avoid overwriting.

  • yerr (str) – The name of the signal pointing to y count uncertainties data.

event(doc: Event) → Event[source]

Start collecting, y, x and yerr data.

Parameters:

doc – (Event): An event document.

start(doc: RunStart) → None[source]

Create the output directory if it doesn’t already exist then setting the filename.

Parameters:

doc (RunStart) – The start bluesky document.

stop(doc: RunStop) → None[source]

Write to the fitting file.

Parameters:

doc (RunStop) – The stop bluesky document.

write_fields_table() → None[source]

Write collected run info to the fitting file.

write_fields_table_uncertainty() → None[source]

Write collected run info to the fitting file with uncertainties.