Skip to content

Commit 4eb8fa6

Browse files
Update livefit_logger.md
1 parent 301ce6d commit 4eb8fa6

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/fitting/livefit_logger.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Fitting Files Callback
22
## Fitting Files
33

4-
The callback ([`LiveFitLogger`](ibex_bluesky_core.callbacks.fitting.LiveFit.LiveFitLogger)) exists to write all fitting metrics from [`LiveFit`](ibex_bluesky_core.callbacks.fitting.LiveFit) to file. These are designed to be human readable files rather than machine readable.
4+
The callback ([`LiveFitLogger`](ibex_bluesky_core.callbacks.fitting.livefit_logger)) exists to write all fitting metrics from [`LiveFit`](ibex_bluesky_core.callbacks.fitting.LiveFit) to file. These are designed to be human readable files rather than machine readable.
55

66
This callback provides you with useful metrics such as `R-squared` and `chi-square`, then providing you with a table of the raw collected data included modelled `y` data and `y` uncertainty.
77

@@ -32,4 +32,4 @@ def some_plan() -> Generator[Msg, None, None]:
3232

3333
This will put the all fitting data collected over the run into a `.csv` file, named after the `uid` of the scan, in the `C:\\Instrument\\Var\\logs\\bluesky\\fitting` path provided to the callback. You should provide a `postfix` to append to the end of the filename to disambiguate different fits and to avoid overwriting fitting files- it is only one file per fit completed.
3434

35-
If you provide a signal name for the `yerr` argument then an extra column for `y uncertainty` will be displayed in the fitting file. You have the option to not provide anything for this argument if you do not want to have uncertainty information in your fitting file. Keep in mind that even if you provide `yerr` in [`LiveFitLogger`](ibex_bluesky_core.callbacks.fitting.LiveFit.LiveFitLogger), you will still need to provide `yerr` in [`LiveFit`](ibex_bluesky_core.callbacks.fitting.LiveFit) if you want uncertainty/weight per point to influence the fit.
35+
If you provide a signal name for the `yerr` argument then an extra column for `y uncertainty` will be displayed in the fitting file. You have the option to not provide anything for this argument if you do not want to have uncertainty information in your fitting file. Keep in mind that even if you provide `yerr` in [`LiveFitLogger`](ibex_bluesky_core.callbacks.fitting.livefit_logger), you will still need to provide `yerr` in [`LiveFit`](ibex_bluesky_core.callbacks.fitting.LiveFit) if you want uncertainty/weight per point to influence the fit.

0 commit comments

Comments
 (0)