Note

This is the documentation for the current state of the development branch of Qiskit Experiments. The documentation or APIs here can change prior to being released.

CurveFitResult¶

class CurveFitResult(method=None, model_repr=None, success=True, nfev=None, message='', dof=None, init_params=None, chisq=None, reduced_chisq=None, aic=None, bic=None, params=None, var_names=None, x_data=None, y_data=None, covar=None)[source]¶

Result of Qiskit Experiment curve analysis.

Create new Qiskit curve analysis result object.

Parameters:

method (Optional[str]) – A name of fitting algorithm used for the curve fitting.
model_repr (Optional[Dict[str, str]]) – String representation of fit functions of each curve.
success (Optional[bool]) – True when the fitting is successfully performed.
nfev (Optional[int]) – Number of fit function evaluation until the solution is obtained.
message (Optional[str]) – Any message from the fitting software.
dof (Optional[float]) – Degree of freedom in this fitting, i.e. number of free parameters.
init_params (Optional[Dict[str, float]]) – Initial parameters provided to the fitter.
chisq (Optional[float]) – Chi-squared value.
reduced_chisq (Optional[float]) – Reduced Chi-squared value.
aic (Optional[float]) – Akaike’s information criterion.
bic (Optional[float]) – Bayesian information criterion.
params (Optional[Dict[str, float]]) – Estimated fitting parameters keyed on the parameter names in the fit function.
var_names (Optional[List[str]]) – Name of variables, i.e. fixed parameters are excluded from the list.
x_data (Optional[ndarray]) – X values used for the fitting.
y_data (Optional[ndarray]) – Y values used for the fitting.
covar (Optional[ndarray]) – Covariance matrix of fitting variables.

Attributes

`CurveFitResult.correl`	Correlation matrix of fit parameters.
`CurveFitResult.ufloat_params`	UFloat representation of fit parameters.
`CurveFitResult.x_range`	Range of x_data values.
`CurveFitResult.y_range`	Range of y_data values.

Methods

CurveFitResult.fitval(key)

Deprecated.