pygsti.objects.ConfidenceRegion.get_prep_fn_confidence_interval¶
-
ConfidenceRegion.
get_prep_fn_confidence_interval
(fnOfPrep, prepLabel, eps=1e-07, returnFnVal=False, verbosity=0)¶ Compute the confidence interval for a function of a single state prep.
Parameters: - fnOfPrep (function) – A function which takes as its only argument a prepration vector. The returned confidence interval is based on linearizing this function and propagating the gateset-space confidence region.
- prepLabel (string) – The label specifying which preparation to use in evaluations of fnOfPrep.
- eps (float, optional) – Step size used when taking finite-difference derivatives of fnOfPrep.
- returnFnVal (bool, optional) – If True, return the value of fnOfPrep 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 fnOfPrep. Thus, shape of df matches that returned by fnOfPrep.
- f0 (float or numpy array) – Only returned when returnFnVal == True. Value of fnOfPrep at the state preparation specified by prepLabel.