Skip to content

Commit

Permalink
Add proposal for missing estimator quantities
Browse files Browse the repository at this point in the history
  • Loading branch information
adonath committed Mar 19, 2021
1 parent b3e80f3 commit e4fcdce
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions docs/estimators/index.rst
Expand Up @@ -50,14 +50,10 @@ Quantity Definition
e_ref Reference energy
e_min Minimum energy
e_max Maximum energy
norm Norm with respect to the reference spectral model
norm_err Symmetric rrror on the norm derived from the Hessian matrix
ts Difference in fit statistics (`stat_sum - null_value` )
sqrt_ts Square root of TS, corresponds to significance (Wilk's theorem)
================= =================================================
npred Predicted counts
npred_signal Predicted counts from the signal
npred_background Predicted counts from the background
norm Best fit norm with respect to the reference spectral model
norm_err Symmetric error on the norm derived from the Hessian matrix
ts Difference in fit statistics (`stat - stat_null` )
sqrt_ts Square root of ts, in case of one degree of freedom, corresponds to significance (Wilk's theorem)
================= =================================================


Expand All @@ -69,13 +65,17 @@ Quantity Definition
norm_errp Positive error of the norm
norm_errn Negative error of the norm
norm_ul Upper limit of the norm
stat Fit statistics value of the best fit hypothesis
stat_null Fit statistics value of the null hypothesis
================= =================================================
npred Predicted counts of the best fit hypothesis
npred_null Predicted counts of the null hypothesis
npred_signal Predicted counts of the signal over `npred_bull`, equivalent to (`npred - npred_null`)
================= =================================================
norm_scan Norm scan
stat_scan Fit statistics scan
stat Fit statistics value of the best fit model
null_value Fit statistics value of the null hypothesis
================= =================================================


To compute the assymetric errors as well as upper limits one can
specify the arguments ``n_sigma`` and ``n_sigma_ul``. The ``n_sigma``
arguments are translated into a TS value assuming ``ts = sigma ** 2``.
Expand Down

0 comments on commit e4fcdce

Please sign in to comment.