FineXAmplitudeCal

class FineXAmplitudeCal(qubit, calibrations, schedule_name, backend=None, cal_parameter_name='amp', auto_update=True)

A calibration experiment to calibrate the amplitude of the X schedule.

Analysis Class Reference

FineAmplitudeAnalysis

Experiment Options

These options can be set by set_experiment_options() method.

Parameters:

• result_index (int) – The index of the result from which to update the calibrations.

• group (str) – The calibration group to which the parameter belongs. This will default to the value “default”.

• target_angle (float) – The target angle of the pulse.

Default values

Following values are set by default.

repetitions               := [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14]
gate                      := None
normalization             := True
add_cal_circuits          := True
result_index              := -1
group                     := 'default'
target_angle              := 3.141592653589793

Transpiler Options

This option can be set by set_transpile_options() method.

This option is used for circuit optimization. See the documentation of qiskit.transpile for available options.

Default values

Following values are set by default.

optimization_level        := 0
basis_gates               := ['x', 'sx']

Backend Run Options

This option can be set by set_run_options() method.

This option is used for controlling job execution condition. Note that this option is provider dependent. See provider’s backend runner API for available options. See the documentation of IBMQBackend.run for the IBM Quantum Service.

Default values

Following values are set by default.

meas_level                := <MeasLevel.CLASSIFIED: 2>

See also

Module(s) FineAmplitude

Initialization

see class FineAmplitude for details.

Parameters:

• qubit (int) – The qubit for which to run the fine amplitude calibration.

• calibrations (Calibrations) – The calibrations instance with the schedules.

• schedule_name (str) – The name of the schedule to calibrate.

• backend (Optional[Backend]) – Optional, the backend to run the experiment on.

• cal_parameter_name (Optional[str]) – The name of the parameter in the schedule to update.

• auto_update (bool) – Whether or not to automatically update the calibrations. By default this variable is set to True.

Attributes

FineXAmplitudeCal.analysis	Return the analysis instance for the experiment
FineXAmplitudeCal.analysis_options	Return the analysis options for run() analysis.
FineXAmplitudeCal.backend	Return the backend for the experiment
FineXAmplitudeCal.calibrations	Return the calibrations.
FineXAmplitudeCal.experiment_options	Return the options for the experiment.
FineXAmplitudeCal.experiment_type	Return experiment type.
FineXAmplitudeCal.num_qubits	Return the number of qubits for the experiment.
FineXAmplitudeCal.physical_qubits	Return the device qubits for the experiment.
FineXAmplitudeCal.run_options	Return options values for the experiment run() method.
FineXAmplitudeCal.transpile_options	Return the transpiler options for the run() method.

Methods

FineXAmplitudeCal.circuits()	Create the circuits for the fine amplitude calibration experiment.
FineXAmplitudeCal.config()	Return the config dataclass for this experiment
FineXAmplitudeCal.copy()	Return a copy of the experiment
FineXAmplitudeCal.enable_restless([...])	Enables a restless experiment by setting the restless run options and the restless data processor.
FineXAmplitudeCal.from_config(config)	Initialize an experiment from experiment config
FineXAmplitudeCal.run([backend, analysis, ...])	Run an experiment, perform analysis, and update any calibrations.
FineXAmplitudeCal.set_experiment_options(...)	Set the experiment options.
FineXAmplitudeCal.set_run_options(**fields)	Set options values for the experiment run() method.
FineXAmplitudeCal.set_transpile_options(**fields)	Set the transpiler options for run() method.
FineXAmplitudeCal.update_calibrations(...)	Update the amplitude of the pulse in the calibrations.