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.

FineZXAmplitude¶

class FineZXAmplitude(physical_qubits, backend=None)[source]¶

A fine amplitude experiment for the RZXGate(np.pi / 2).

Overview

FineZXAmplitude is a subclass of FineAmplitude and is used to set the appropriate values for the default options to calibrate a RZXGate(np.pi / 2).

Analysis class reference

FineAmplitudeAnalysis

Experiment options

These options can be set by the set_experiment_options() method.

Options

Defined in the class FineZXAmplitude:
- add_cal_circuits (bool)
  
  Default value: False
  
  If set to True then two circuits to calibrate 0 and 1 points will be added. This option is set to False by default for FineZXAmplitude since the amplitude calibration can be achieved with two RZX gates and this is included in the repetitions.
- repetitions (List[int])
  
  Default value: [0, 1, 2, 3, 4, …]
  
  A list of the number of times that the gate is repeated.
Defined in the class FineAmplitude:
- gate (Gate)
  
  Default value: None
  
  This is a gate class such as XGate, so that one can obtain a gate by doing options.gate().
- normalization (bool)
  
  Default value: True
  
  If set to True the DataProcessor will normalized the measured signal to the interval [0, 1]. Defaults to True.
Defined in the class BaseExperiment:
- max_circuits (Optional[int])
  
  Default value: None
  
  The maximum number of circuits per job when running an experiment on a backend.

Example

To run this experiment, the user will have to provide the instruction schedule map in the transpile options that contains the schedule for the experiment.

qubits = (1, 2)
inst_map = InstructionScheduleMap()
inst_map.add("szx", qubits, my_schedule)

fine_amp = FineZXAmplitude(qubits, backend)
fine_amp.set_transpile_options(inst_map=inst_map)

Here, my_schedule is the pulse schedule that will implement the RZXGate(np.pi / 2) rotation.

See also

Superclass qiskit_experiments.library.characterization.fine_amplitude.FineAmplitude

Initialization

Initialize the experiment.

Attributes

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

Methods

`FineZXAmplitude.circuits`()	Create the circuits for the fine amplitude calibration experiment.
`FineZXAmplitude.config`()	Return the config dataclass for this experiment
`FineZXAmplitude.copy`()	Return a copy of the experiment
`FineZXAmplitude.enable_restless`([rep_delay, ...])	Enable restless measurements.
`FineZXAmplitude.from_config`(config)	Initialize an experiment from experiment config
`FineZXAmplitude.run`([backend, analysis, timeout])	Run an experiment and perform analysis.
`FineZXAmplitude.set_experiment_options`(**fields)	Set the experiment options.
`FineZXAmplitude.set_run_options`(**fields)	Set options values for the experiment `run()` method.
`FineZXAmplitude.set_transpile_options`(**fields)	Set the transpiler options for `run()` method.