pyhf.infer.utils.create_calculator¶

pyhf.infer.utils.create_calculator(calctype, *args, **kwargs)[source]¶

Creates a calculator object of the specified calctype.

See AsymptoticCalculator and ToyCalculator on additional arguments to be specified.

Example

>>> import pyhf
>>> import numpy.random as random
>>> random.seed(0)
>>> model = pyhf.simplemodels.hepdata_like(
...     signal_data=[12.0, 11.0], bkg_data=[50.0, 52.0], bkg_uncerts=[3.0, 7.0],
... )
>>> observations = [51, 48]
>>> data = observations + model.config.auxdata
>>> mu_test = 1.0
>>> toy_calculator = pyhf.infer.utils.create_calculator(
...     "toybased", data, model, ntoys=100, test_stat="qtilde", track_progress=False
... )
>>> qmu_sig, qmu_bkg = toy_calculator.distributions(mu_test)
>>> qmu_sig.pvalue(mu_test), qmu_bkg.pvalue(mu_test)
(array(0.14), array(0.76))

Parameters

calctype (str) – The calculator to create. Choose either
or 'toybased'. ('asymptotics') –

Returns

A calculator.

Return type

calculator (object)