Skip to content

Commit

Permalink
Merge pull request #187 from aglowacki/master
Browse files Browse the repository at this point in the history
minor update to documentation for custom optimizer presets
  • Loading branch information
aglowacki authored Mar 12, 2024
2 parents 6cec135 + eac0bbb commit 621fee7
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/custom_optimizer_presets.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,30 +12,37 @@ Note that 0 means user specified custom preset from the override file
For each fit parameter you can add the following

fit_param_name + the following

```
fit_param_name + _MIN
fit_param_name + _MAX
fit_param_name + _STEPSIZE
fit_param_name + _FITTING
```

### _FITTING
```
fixed : do not fit this parameters
limit_lo_hi : If using mpfit, limit to the _MIN and _MAX ranges
limit_lo : If using mpfit, limit to the _MIN range
limit_hi : If using mpfit, limit to the _MAX range
fit : Fit this parameters with out an constraints.
```

### Example
#### Energy offset fit it with limits
#### Energy offset fit it with limits
```
CAL_OFFSET_[E_OFFSET]: -0.0054764490
CAL_OFFSET_[E_OFFSET]_MAX: 0.50000000
CAL_OFFSET_[E_OFFSET]_MIN: -0.50000000
CAL_OFFSET_[E_OFFSET]_STEPSIZE: 0.001
CAL_OFFSET_[E_OFFSET]_FITTING: limit_lo_hi
```

#### F_TAIL_OFFSET set limits but don't use them since we set FITTING to fit, will use step size if calling mpfit
```
F_TAIL_OFFSET: 0.003
F_TAIL_OFFSET_MAX: 0.100
F_TAIL_OFFSET_MIN: 0.00001
F_TAIL_OFFSET_STEPSIZE: 0.00001
F_TAIL_OFFSET_FITTING: fit
```

0 comments on commit 621fee7

Please sign in to comment.