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.

SeriesDef

class SeriesDef(*args, **kwargs)

A dataclass to describe the definition of the curve.

fit_func

A callable that defines the fit model of this curve. The argument names in the callable are parsed to create the fit parameter list, which will appear in the analysis results. The first argument should be x that represents X-values that the experiment sweeps.

Type:

Callable

filter_kwargs

Optional. Dictionary of properties that uniquely identifies this series. This dictionary is used for data processing. This must be provided when the curve analysis consists of multiple series.

Type:

Dict[str, Any]

name

Optional. Name of this series.

Type:

str

plot_color

Optional. String representation of the color that is used to draw fit data and data points in the output figure. This depends on the drawer class being set to the curve analysis options. Usually this conforms to the Matplotlib color names.

Type:

str

plot_symbol

Optional. String representation of the marker shape that is used to draw data points in the output figure. This depends on the drawer class being set to the curve analysis options. Usually this conforms to the Matplotlib symbol names.

Type:

str

canvas

Optional. Index of sub-axis in the output figure that draws this curve. This option is valid only when the drawer instance provides multi-axis drawing.

Type:

int | None

model_description

Optional. Arbitrary string representation of this fit model. This string will appear in the analysis results as a part of metadata.

Type:

str | None

Deprecated since version 0.5: The class qiskit_experiments.curve_analysis.curve_data.SeriesDef is deprecated as of qiskit-experiments 0.5. It will be removed after 0.6. SeriesDef has been replaced by the LMFIT module.