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.

CurvePlotter.expected_supplementary_data_keys

classmethod CurvePlotter.expected_supplementary_data_keys()

Returns the expected figures data keys supported by this plotter.

This plotter generates a single text box, i.e. fit report, by digesting the provided supplementary data. The style and position of the report is controlled by textbox_rel_pos and textbox_text_size style parameters in PlotStyle.

Data Keys:

• primary_results – A list of AnalysisResultData objects to be shown in the fit report window. Typically, these are fit parameter values or secondary quantities computed from multiple fit parameters.

• fit_red_chi – The best reduced-chi squared value of the fit curves. If the fit consists of multiple sub-fits, this will be a dictionary keyed on the analysis name. Otherwise, this is a single float value of a particular analysis.

Return type:

List[str]