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.

ResonanceAnalysis¶

class ResonanceAnalysis(name=None)[source]¶

A class to analyze a resonance peak with a square rooted Lorentzian function.

Overview

This analysis takes only single series. This series is fit to the square root of a Lorentzian function.

Fit Model

The fit is based on the following Lorentzian function.

\[F(x) = a{\rm abs}\left(\frac{1}{1 + 2i(x - x0)/\kappa}\right) + b\]

Fit Parameters

\(a\): Peak height.
\(b\): Base line.
\(x0\): Center value. This is typically the fit parameter of interest.
\(\kappa\): Linewidth.

Initial Guesses

\(a\): Calculated by max_height().
\(b\): Calculated by constant_spectral_offset().
\(x0\): The max height position is calculated by the function max_height().
\(\kappa\): Calculated from FWHM of the peak using full_width_half_max().

Bounds

\(a\): [-2, 2] scaled with maximum signal value.
\(b\): [-1, 1] scaled with maximum signal value.
\(f\): [min(x), max(x)] of x-value scan range.
\(\kappa\): [0, \(\Delta x\)] where \(\Delta x\) represents the x-value scan range.

Analysis options

These are the keyword arguments of the run() method.

Options

Defined in the class BaseCurveAnalysis:
- plotter (BasePlotter)
  
  Default value: Instance of CurvePlotter
  
  A curve plotter instance to visualize the analysis result.
- plot_raw_data (bool)
  
  Default value: False
  
  Set True to draw processed data points, dataset without formatting, on canvas. This is False by default.
- plot_residuals (bool)
  
  Default value: False
  
  Set True to draw the residuals data for the fitting model. This is False by default.
- return_fit_parameters (bool)
  
  Default value: True
  
  (Deprecated) Set True to return all fit model parameters with details of the fit outcome. Default to False.
- data_processor (Callable)
  
  Default value: None
  
  A callback function to format experiment data. This can be a DataProcessor instance that defines the self.__call__ method.
- normalization (bool)
  
  Default value: True
  
  Set True to normalize y values within range [-1, 1]. Default to False.
- average_method (Literal[“sample”, “iwv”, “shots_weighted”])
  
  Default value: "shots_weighted"
  
  Method to average the y values when the same x values appear multiple times. One of “sample”, “iwv” (i.e. inverse weighted variance), “shots_weighted”. See mean_xy_data() for details. Default to “shots_weighted”.
- p0 (Dict[str, float])
  
  Default value: {}
  
  Initial guesses for the fit parameters. The dictionary is keyed on the fit parameter names.
- bounds (Dict[str, Tuple[float, float]])
  
  Default value: {}
  
  Boundary of fit parameters. The dictionary is keyed on the fit parameter names and values are the tuples of (min, max) of each parameter.
- fit_method (str)
  
  Default value: "least_squares"
  
  Fit method that LMFIT minimizer uses. Default to least_squares method which implements the Trust Region Reflective algorithm to solve the minimization problem. See LMFIT documentation for available options.
- lmfit_options (Dict[str, Any])
  
  Default value: {}
  
  Options that are passed to the LMFIT minimizer. Acceptable options depend on fit_method.
- x_key (str)
  
  Default value: "xval"
  
  Circuit metadata key representing a scanned value.
- fit_category (str)
  
  Default value: "formatted"
  
  Name of dataset in the scatter table to fit.
- result_parameters (List[Union[str, ParameterRepr])
  
  Default value: [Instance of ParameterRepr]
  
  Parameters reported in the database as a dedicated entry. This is a list of parameter representation which is either string or ParameterRepr object. If you provide more information other than name, you can specify [ParameterRepr("alpha", "α", "a.u.")] for example. The parameter name should be defined in the series definition. Representation should be printable in standard output, i.e. no latex syntax.
- extra (Dict[str, Any])
  
  Default value: {}
  
  A dictionary that is appended to all database entries as extra information.
- fixed_parameters (Dict[str, Any])
  
  Default value: {}
  
  Fitting model parameters that are fixed during the curve fitting. This should be provided with default value keyed on one of the parameter names in the series definition.
- filter_data (Dict[str, Any])
  
  Default value: {}
  
  Dictionary of experiment data metadata to filter. Experiment outcomes with metadata that matches with this dictionary are used in the analysis. If not specified, all experiment data are input to the curve fitter. By default, no filtering condition is set.
- data_subfit_map (Dict[str, Dict[str, Any]])
  
  Default value: {}
  
  The mapping of experiment result data to sub-fit models. This dictionary is keyed on the LMFIT model name, and the value is a sorting key-value pair that filters the experiment results, and the filtering is done based on the circuit metadata.
Defined in the class BaseAnalysis:
- figure_names (str or List[str])
  
  Default value: None
  
  Identifier of figures that appear in the experiment data to sort figures by name.