pygsti.objects.ConfidenceRegion.get_effect_fn_confidence_interval¶
-
ConfidenceRegion.
get_effect_fn_confidence_interval
(fnOfEffect, effectLabel, eps=1e-07, returnFnVal=False, verbosity=0)¶ Compute the confidence interval for a function of a single POVM effect.
Parameters: - fnOfEffect (function) – A function which takes as its only argument a POVM vector. The returned confidence interval is based on linearizing this function and propagating the gateset-space confidence region.
- effectLabel (string) – The label specifying which POVM to use in evaluations of fnOfEffect.
- eps (float, optional) – Step size used when taking finite-difference derivatives of fnOfEffect.
- returnFnVal (bool, optional) – If True, return the value of fnOfEffect along with it’s confidence region half-widths.
- verbosity (int, optional) – Specifies level of detail in standard output.
Returns: - df (float or numpy array) – Half-widths of confidence intervals for each of the elements in the float or array returned by fnOfEffect. Thus, shape of df matches that returned by fnOfEffect.
- f0 (float or numpy array) – Only returned when returnFnVal == True. Value of fnOfEffect at the POVM effect specified by effectLabel.