add fitting methods as free functions

Author: rerpha

doc/fitting/fitting.md

@@ -15,7 +15,7 @@ Below is a full example showing how to use standard `matplotlib` & `bluesky` fun
 ```py
 import matplotlib.pyplot as plt
 from ibex_bluesky_core.callbacks import LiveFit, LivePlot
-from ibex_bluesky_core.fitting import Gaussian
+from ibex_bluesky_core.fitting import gaussian
 from bluesky.callbacks import LiveFitPlot
 
 # Create a new figure to plot onto.
@@ -25,7 +25,7 @@ ax = plt.gca()
 # ax is shared by fit_callback and plot_callback 
 
 plot_callback = LivePlot(y="y_signal", x="x_signal", ax=ax, yerr="yerr_signal")
-fit_callback = LiveFit(Gaussian.fit(), y="y_signal", x="x_signal", yerr="yerr_signal", update_every=0.5)
+fit_callback = LiveFit(gaussian(), y="y_signal", x="x_signal", yerr="yerr_signal", update_every=0.5)
 # Using the yerr parameter allows you to use error bars.
 # update_every = in seconds, how often to recompute the fit. If `None`, do not compute until the end. Default is 1.
 fit_plot_callback = LiveFitPlot(fit_callback, ax=ax, color="r")
@@ -71,6 +71,7 @@ We support **standard fits** for the following trends in data. See [Standard Fit
 -------
 
 Each of the above fit classes has a `.fit()` which returns an object of type [`FitMethod`](ibex_bluesky_core.fitting.FitMethod). This tells [`LiveFit`](ibex_bluesky_core.callbacks.LiveFit) how to perform fitting on the data. [`FitMethod`](ibex_bluesky_core.fitting.FitMethod) is defined in `ibex_bluesky_core.fitting`.
+Shorthand for this is just to use the lower-case version ie. `gaussian()` instead of `Gaussian().fit()`.
 
 There are *two* ways that you can choose how to fit a model to your data:
 
@@ -92,7 +93,7 @@ The `[FIT].fit()` function will pass the [`FitMethod`](ibex_bluesky_core.fitting
 **Note:** that for the fits in the above table that require parameters, you will need to pass value(s) to their `.fit` method. For example Polynomial fitting:
 
 ```py
-lf = LiveFit(Polynomial.fit(3),  y="y_signal", x="x_signal", update_every=0.5)
+lf = LiveFit(polynomial(3),  y="y_signal", x="x_signal", update_every=0.5)
 # For a polynomial of degree 3
 ```
 

manual_system_tests/dae_scan.py

@@ -19,7 +19,7 @@
     RunPerPointController,
     SimpleDae,
 )
-from ibex_bluesky_core.fitting import Linear
+from ibex_bluesky_core.fitting import linear
 from ibex_bluesky_core.run_engine import get_run_engine
 from ibex_bluesky_core.utils import get_pv_prefix
 
@@ -71,7 +71,7 @@ def dae_scan_plan() -> Generator[Msg, None, None]:
         x=block.name,
         y=reducer.intensity.name,
         yerr=reducer.intensity_stddev.name,
-        fit=Linear.fit(),
+        fit=linear(),
         measured_fields=[
             controller.run_number.name,
             reducer.det_counts.name,

src/ibex_bluesky_core/callbacks/__init__.py

@@ -93,7 +93,7 @@ def dae_scan_plan():
                     x=block.name,
                     y=reducer.intensity.name,
                     yerr=reducer.intensity_stddev.name,
-                    fit=Linear.fit(),
+                    fit=linear(),
                     ...
                 )
                 ...

src/ibex_bluesky_core/fitting.py

@@ -24,6 +24,16 @@
     "SlitScan",
     "TopHat",
     "Trapezoid",
+    "dampedosc",
+    "erf",
+    "erfc",
+    "gaussian",
+    "linear",
+    "lorentzian",
+    "polynomial",
+    "slitscan",
+    "tophat",
+    "trapezoid",
 ]
 
 
@@ -593,3 +603,24 @@ def guess(
             return init_guess
 
         return guess
+
+
+gaussian = Gaussian.fit
+
+lorentzian = Lorentzian.fit
+
+linear = Linear.fit
+
+polynomial = Polynomial.fit
+
+dampedosc = DampedOsc.fit
+
+slitscan = SlitScan.fit
+
+erf = ERF.fit
+
+erfc = ERFC.fit
+
+tophat = TopHat.fit
+
+trapezoid = Trapezoid.fit

src/ibex_bluesky_core/plans/reflectometry/_det_map_align.py

@@ -29,7 +29,7 @@
     Waiter,
     check_dae_strategies,
 )
-from ibex_bluesky_core.fitting import Gaussian
+from ibex_bluesky_core.fitting import gaussian
 from ibex_bluesky_core.plan_stubs import call_qt_aware
 
 __all__ = ["DetMapAlignResult", "angle_scan_plan", "height_and_angle_scan_plan"]
@@ -52,7 +52,7 @@ def _height_scan_callback_and_fit(
         x=height.name,
         y=intensity,
         yerr=f"{intensity}_err",
-        fit=Gaussian().fit(),
+        fit=gaussian(),
         add_peak_stats=False,
         ax=ax,
         live_fit_logger_postfix="_height",
@@ -81,7 +81,7 @@ def _angle_scan_callback_and_fit(
         x=angle_name,
         y=counts_name,
         yerr=f"{counts_name}_err",
-        fit=Gaussian().fit(),
+        fit=gaussian(),
         add_peak_stats=False,
         add_table_cb=False,
         ax=ax,