pyhf.utils.qmu

pyhf.utils.qmu(mu, data, pdf, init_pars, par_bounds)[source]

The test statistic, \(q_{\mu}\), for establishing an upper limit on the strength parameter, \(\mu\), as defiend in Equation (14) in arXiv:1007.1727 .

\begin{equation} q_{\mu} = \left\{\begin{array}{ll} -2\ln\lambda\left(\mu\right), &\hat{\mu} < \mu,\\ 0, & \hat{\mu} > \mu \end{array}\right. \end{equation}
Parameters
  • mu (Number or Tensor) – The signal strength parameter

  • data (Tensor) – The data to be considered

  • pdf (pyhf.pdf.Model) – The HistFactory statistical model used in the likelihood ratio calculation

  • init_pars (Tensor) – The initial parameters

  • par_bounds (Tensor) – The bounds on the paramter values

Returns

The calculated test statistic, \(q_{\mu}\)

Return type

Float