Skip to content

Commit a3ae880

Browse files
committed
doc
1 parent 542829f commit a3ae880

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

doc/fitting/standard_fits.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,4 +160,26 @@ g(x) = \max(f(x), \text{background})
160160
y = \min(g(x), \text{background} + \text{height})
161161
```
162162

163-
![TrapezoidModel](../_static/images_fits/trapezoid.png)
163+
![TrapezoidModel](../_static/images_fits/trapezoid.png)
164+
165+
## Negative Trapezoid
166+
167+
API Reference: [`NegativeTrapezoid`](ibex_bluesky_core.fitting.NegativeTrapezoid)
168+
169+
This model is the same shape as the trapezoid described above, but with a negative height.s
170+
171+
- `cen` - The centre (x) of the model
172+
- `gradient` - How steep the edges of the trapezoid are
173+
- `height` - The maximum height of the model below `background`
174+
- `background` - The maximum value (y) of the model
175+
- `y_offset` - Acts as a width factor for the trapezoid. If you extrapolate the sides of the trapezoid until they meet, this value represents the y coord of this point minus height and background.
176+
177+
```{math}
178+
f(x) = \text{y_offset} - \text{height} + \text{background} + \text{gradient} * |x - \text{cen}|
179+
```
180+
```{math}
181+
g(x) = \max(f(x), \text{background} - \text{height})
182+
```
183+
```{math}
184+
y = \min(g(x), \text{background})
185+
```

0 commit comments

Comments
 (0)