Skip to content

Commit 1d088d7

Browse files
committed
Fix x-refs
1 parent dd63557 commit 1d088d7

File tree

3 files changed

+26
-14
lines changed

3 files changed

+26
-14
lines changed

doc/callbacks/fitting/fitting.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -58,19 +58,19 @@ def plan():
5858

5959
We support **standard fits** for the following trends in data. See [Standard Fits](./standard_fits.md) for more information on the behaviour of these fits.
6060

61-
| Trend | Class Name in {py:obj}`ibex_bluesky_core.fitting` | Arguments |
62-
| ----- |--------------------------------------------------------------| ----------|
63-
| Linear | [Linear](./standard_fits.md#linear) | None |
64-
| Polynomial | [Polynomial](./standard_fits.md#polynomial) | Polynomial Degree (int) |
65-
| Gaussian | [Gaussian](./standard_fits.md#gaussian) | None |
66-
| Lorentzian | [Lorentzian](./standard_fits.md#lorentzian) | None |
67-
| Damped Oscillator | [DampedOsc](./standard_fits.md#damped-oscillator-dampedosc) | None |
68-
| Slit Scan Fit | [SlitScan](./standard_fits.md#slit-scan-slitscan) | None |
69-
| Error Function | [ERF](./standard_fits.md#error-function-erf) | None |
70-
| Complementary Error Function | [ERFC](./standard_fits.md/#complementary-error-function-erfc) | None |
71-
| Top Hat | [TopHat](./standard_fits.md#top-hat-tophat) | None |
72-
| Trapezoid | [Trapezoid](./standard_fits.md#trapezoid) | None |
73-
| PeakStats (COM) **\*** | - | -
61+
| Trend | Class Name in {py:obj}`ibex_bluesky_core.fitting` | Arguments |
62+
| ----- |---------------------------------------------------| ----------|
63+
| Linear | [Linear](#fit_linear) | None |
64+
| Polynomial | [Polynomial](#fit_polynomial) | Polynomial Degree (int) |
65+
| Gaussian | [Gaussian](#fit_gaussian) | None |
66+
| Lorentzian | [Lorentzian](#fit_lorentzian) | None |
67+
| Damped Oscillator | [DampedOsc](#fit_damped_osc) | None |
68+
| Slit Scan Fit | [SlitScan](#fit_slitscan) | None |
69+
| Error Function | [ERF](#fit_erf) | None |
70+
| Complementary Error Function | [ERFC](#fit_erfc) | None |
71+
| Top Hat | [TopHat](#fit_tophat) | None |
72+
| Trapezoid | [Trapezoid](#fit_trapezoid) | None |
73+
| PeakStats (COM) **\*** | - | - |
7474

7575
Bluesky additionally provides a {py:obj}`bluesky.callbacks.fitting.PeakStats` callback which computes peak statistics after a run finishes. Similar to {py:obj}`~ibex_bluesky_core.callbacks.LiveFit`, {py:obj}`~bluesky.callbacks.fitting.PeakStats` does not plot by itself. The {py:obj}`~bluesky.callbacks.mpl_plotting.plot_peak_stats` function can be used to draw results of a {py:obj}`~bluesky.callbacks.fitting.PeakStats` on a plot.
7676

doc/callbacks/fitting/standard_fits.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
{#standard_fitting_models}
22
# Standard Fitting Models
33

4+
{#fit_linear}
45
## {py:obj}`~ibex_bluesky_core.fitting.Linear`
56

67
- `c1` - Gradient
@@ -10,6 +11,7 @@
1011
y = c_1x + c_0
1112
```
1213

14+
{#fit_polynomial}
1315
## {py:obj}`~ibex_bluesky_core.fitting.Polynomial`
1416

1517
- `cn` ... `c0` - Polynomial coefficients
@@ -19,6 +21,7 @@ For a polynomial degree `n`:
1921
y = c_{n}x^n + c_{n-1}x^{n-1} + ... + c_1 * x^1 + c_0
2022
```
2123

24+
{#fit_gaussian}
2225
## {py:obj}`~ibex_bluesky_core.fitting.Gaussian`
2326

2427
- `amp` - The maximum height of the Gaussian above `background`
@@ -32,6 +35,7 @@ y = \text{amp} * e^{-\frac{(x - x0) ^ 2}{2 * \text{sigma}^2}} + \text{background
3235

3336
![GaussianModel](./images_fits/gaussian.png)
3437

38+
{#fit_lorentzian}
3539
## {py:obj}`~ibex_bluesky_core.fitting.Lorentzian`
3640

3741
- `amp` - The maximum height of the Lorentzian above `background`
@@ -45,6 +49,7 @@ y = \frac{\text{amp}}{1 + \frac{x - \text{center}}{\text{sigma}}^2} + \text{back
4549

4650
![LorentzianModel](./images_fits/lorentzian.png)
4751

52+
{#fit_damped_osc}
4853
## Damped Oscillator ({py:obj}`~ibex_bluesky_core.fitting.DampedOsc`)
4954

5055
- `center` - The centre (x) of the oscillation
@@ -58,6 +63,7 @@ y = \text{amp} * \cos((x - \text{center}) * \text{freq}) * e^{-\frac{x - \text{c
5863

5964
![DampedOscModel](./images_fits/damped_osc.png)
6065

66+
{#fit_slitscan}
6167
## Slit Scan ({py:obj}`~ibex_bluesky_core.fitting.SlitScan`)
6268

6369
- `background` $b$ - The minimum value (y) of the model
@@ -80,6 +86,7 @@ y = \min(\text{lin_seg}, \text{exp_seg})
8086

8187
![SlitScanModel](./images_fits/slit_scan.png)
8288

89+
{#fit_erf}
8390
## Error Function ({py:obj}`~ibex_bluesky_core.fitting.ERF`)
8491

8592
- `cen` - The centre (x) of the model
@@ -93,6 +100,7 @@ y = background + scale * erf(stretch * (x - cen))
93100

94101
![ERFModel](./images_fits/erf.png)
95102

103+
{#fit_erfc}
96104
## Complementary Error Function ({py:obj}`~ibex_bluesky_core.fitting.ERFC`)
97105

98106
- `cen` - The centre (x) of the model
@@ -106,6 +114,7 @@ y = background + scale * erfc(stretch * (x - cen))
106114

107115
![ERFCModel](./images_fits/erfc.png)
108116

117+
{#fit_tophat}
109118
## Top Hat ({py:obj}`~ibex_bluesky_core.fitting.TopHat`)
110119

111120
- `cen` - The centre (x) of the model
@@ -123,6 +132,7 @@ y =
123132

124133
![TopHatModel](./images_fits/tophat.png)
125134

135+
{#fit_trapezoid}
126136
## {py:obj}`~ibex_bluesky_core.fitting.Trapezoid`
127137

128138
- `cen` - The centre (x) of the model
@@ -143,6 +153,7 @@ y = \min(g(x), \text{background} + \text{height})
143153

144154
![TrapezoidModel](./images_fits/trapezoid.png)
145155

156+
{#fit_neg_trapezoid}
146157
## {py:obj}`~ibex_bluesky_core.fitting.NegativeTrapezoid`
147158

148159
This model is the same shape as the trapezoid described above, but with a negative height.
@@ -163,6 +174,7 @@ g(x) = \max(f(x), \text{background} - \text{height})
163174
y = \min(g(x), \text{background})
164175
```
165176

177+
{#fit_muon_momentum}
166178
## Muon Momentum ({py:obj}`~ibex_bluesky_core.fitting.MuonMomentum`)
167179

168180
Fits data from a momentum scan, it is designed for the specific use case of scanning over magnet current on muon instruments.

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
# Mermaid diagrams
4747
"sphinxcontrib.mermaid",
4848
# Collapsible sections
49-
'sphinx_toolbox.collapse',
49+
"sphinx_toolbox.collapse",
5050
]
5151
mermaid_d3_zoom = True
5252
napoleon_google_docstring = True

0 commit comments

Comments
 (0)