Skip to content

Commit

Permalink
Minor documentation for update for regexps when floating params
Browse files Browse the repository at this point in the history
  • Loading branch information
kcormi committed Oct 10, 2023
1 parent d36c486 commit 23087a3
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/part3/runningthetool.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ There are a number of useful command line options which can be used to alter the

- `--freezeParameters name1[,name2,...]` Will freeze the parameters with the given names to their set values. This option supports the use of regexps via by replacing `name` with `rgx{some regular expression}` for matching to *constrained nuisance parameters* or `var{some regular expression}` for matching to *any* parameter. For example `--freezeParameters rgx{CMS_scale_j.*}` will freeze all constrained nuisance parameters with the prefix `CMS_scale_j`, while `--freezeParameters var{.*rate_scale}` will freeze any parameter (constrained nuisance or otherwise) with the suffix `rate_scale`.
- use the option `--freezeParameters allConstrainedNuisances` to freeze all nuisance parameters that have a constraint term (i.e not `flatParams` or `rateParams` or other freely floating parameters).
- similarly the option `--floatParameters` sets the parameter floating (and also accepts regexps, as of version > 9.1.0).
- similarly the option `--floatParameters` sets the parameter floating and also accepts regular expressions.
- groups of nuisances (constrained or otherwise), as defined in the datacard, can be frozen using `--freezeNuisanceGroups`. You can also specify to freeze nuisances which are *not* contained in a particular group using a **^** before the group name (`--freezeNuisanceGroups=^group_name` will freeze everything except nuisance parameters in the group "group_name".)
- all *constrained* nuisance parameters (not `flatParam` or `rateParam`) can be set floating using `--floatAllNuisances`.

Expand Down

0 comments on commit 23087a3

Please sign in to comment.