Skip to content

laboneq_applications.analysis.options

Experiment task and workflow options.

T = TypeVar('T') module-attribute

BasePlottingOptions

Base options for a plotting task.

Attributes:

Name Type Description
save_figures bool

Whether to save the figures. Default: True.
close_figures bool

Whether to close the figures. Default: True.

DoFittingOption

The do_fitting option.

Attributes:

Name Type Description
do_fitting bool

Whether to perform the fit. Default: True.

ExtractEdgeParametersOptions

Base options for tasks that extract edge parameters.

do_fitting

Whether to perform the fit. Default: True.

do_fitting = option_field(True, description='Whether to perform the fit.') class-attribute instance-attribute

ExtractQubitParametersTransitionOptions

Base options for tasks that extract qubit parameters.

Attributes:

Name Type Description
transition Literal['ge', 'ef']

Transition to perform the experiment on. May be any transition supported by the quantum operations. Default: "ge" (i.e. ground to first excited state).
do_fitting bool

Whether to perform the fit. Default: True.

FitDataOptions

Base options for data fitting tasks.

Attributes:

Name Type Description
do_rotation bool

Whether to rotate the raw data based on calibration traces or principal component analysis. Default: True.
do_fitting bool

Whether to perform the fit. Default: True.
fit_parameters_hints dict | None

Parameters hints accepted by lmfit Default: None.

PlotPopulationOptions

Bases: ExtractQubitParametersTransitionOptions, BasePlottingOptions

Options for the plot_population task.

Attributes:

Name Type Description
do_rotation bool

Whether to rotate the raw data based on calibration traces or principal component analysis. Default: True.
do_pca bool

Whether to perform principal component analysis on the raw data independent of whether there were calibration traces in the experiment. Default: False.
cal_states str | tuple

The states to prepare in the calibration traces. Can be any string or tuple made from combining the characters 'g', 'e', 'f'. Default: same as transition
transition Literal['ge', 'ef']

Transition to perform the experiment on. May be any transition supported by the quantum operations. Default: "ge" (i.e. ground to first excited state).
do_fitting bool

Whether to perform the fit. Default: True.
save_figures bool

Whether to save the figures. Default: True.
close_figures bool

Whether to close the figures. Default: True.

TuneUpAnalysisWorkflowOptions

Option class for tune-up analysis workflows.

Attributes:

Name Type Description
do_fitting bool

Whether to perform the fit. Default: True.
do_plotting bool

Whether to make plots. Default: 'True'.
do_raw_data_plotting bool

Whether to plot the raw data. Default: 'True'.
do_qubit_population_plotting bool

Whether to plot the qubit population. Default: 'True'.