Amp cal refactor

qiskit_experiments/calibration_management/__init__.py

@@ -148,5 +148,6 @@
 
 from .calibrations import Calibrations
 from .backend_calibrations import BackendCalibrations
+from .base_calibration_experiment import BaseCalibrationExperiment
 
 from .update_library import Frequency, Drag, Amplitude, FineDragUpdater

qiskit_experiments/calibration_management/base_calibration_experiment.py

@@ -13,11 +13,11 @@
 """Base class for calibration-type experiments."""
 
 from abc import ABC
-from typing import Dict, Optional, Tuple, Type
+from typing import Dict, List, Optional, Tuple, Type
 import warnings
 
 from qiskit.providers.backend import Backend
-from qiskit.circuit import Parameter
+from qiskit.circuit import Parameter, QuantumCircuit
 from qiskit.pulse import ScheduleBlock
 
 from qiskit_experiments.calibration_management.calibrations import Calibrations
@@ -339,6 +339,23 @@ def get_schedule(
 
         return schedules
 
+    def circuits(self, backend: Optional[Backend] = None) -> List[QuantumCircuit]:
+        """A wrapper to introduce an optional hook to add circuit metadata."""
+        circuits = super().circuits(backend)
+
+        self._add_cal_metadata(circuits)
+
+        return circuits
+
+    def _add_cal_metadata(self, circuits: List[QuantumCircuit]):
+        """A hook to add calibration metadata to the circuits.
+
+        Many calibration experiments will not define the circuits method but rely on those defined
+        by the experiment in the characterization module. This hook allows calibration experiments
+        to add their own meta data to the circuits if needed.
+        """
+        pass
+
     def run(
         self,
         backend: Backend,

qiskit_experiments/calibration_management/update_library.py

@@ -60,7 +60,7 @@ def _time_stamp(exp_data: ExperimentData) -> datetime:
         return datetime.now(timezone.utc).astimezone()
 
     @classmethod
-    def _add_parameter_value(
+    def add_parameter_value(
         cls,
         cal: Calibrations,
         exp_data: ExperimentData,
@@ -123,7 +123,7 @@ def update(
         fit_parameter = fit_parameter or cls.__fit_parameter__
         value = BaseUpdater.get_value(exp_data, fit_parameter, result_index)
 
-        cls._add_parameter_value(
+        cls.add_parameter_value(
             calibrations, exp_data, value, parameter, schedule=schedule, group=group
         )
 
@@ -244,7 +244,7 @@ def update(
         old_beta = calibrations.get_parameter_value(parameter, qubits, schedule, group=group)
         new_beta = old_beta + d_beta
 
-        cls._add_parameter_value(calibrations, exp_data, new_beta, parameter, schedule, group)
+        cls.add_parameter_value(calibrations, exp_data, new_beta, parameter, schedule, group)
 
 
 class Amplitude(BaseUpdater):
@@ -281,7 +281,6 @@ def update(
             CalibrationError: If the experiment is not of the supported type.
         """
         from qiskit_experiments.library.calibration.rabi import Rabi
-        from qiskit_experiments.library.calibration.fine_amplitude import FineAmplitude
 
         if angles_schedules is None:
             angles_schedules = [(np.pi, "amp", "xp")]
@@ -295,19 +294,7 @@ def update(
 
                 value = np.round(angle / rate, decimals=8) * np.exp(1.0j * np.angle(prev_amp))
 
-                cls._add_parameter_value(calibrations, exp_data, value, param, schedule, group)
-
-        elif isinstance(exp_data.experiment, FineAmplitude):
-            d_theta = BaseUpdater.get_value(exp_data, "d_theta", result_index)
-
-            for target_angle, param, schedule in angles_schedules:
-                qubits = exp_data.metadata["physical_qubits"]
-
-                prev_amp = calibrations.get_parameter_value(param, qubits, schedule, group=group)
-                scale = target_angle / (target_angle + d_theta)
-                new_amp = prev_amp * scale
-
-                cls._add_parameter_value(calibrations, exp_data, new_amp, param, schedule, group)
+                cls.add_parameter_value(calibrations, exp_data, value, param, schedule, group)
 
         else:
             raise CalibrationError(f"{cls.__name__} updates from {type(Rabi.__name__)}.")

qiskit_experiments/library/__init__.py

@@ -62,6 +62,9 @@
     ~characterization.EFSpectroscopy
     ~characterization.CrossResonanceHamiltonian
     ~characterization.EchoedCrossResonanceHamiltonian
+    ~characterization.FineAmplitude
+    ~characterization.FineXAmplitude
+    ~characterization.FineSXAmplitude
 
 .. _calibration:
 
@@ -85,9 +88,9 @@ class instance to manage parameters and pulse schedules.
     ~calibration.FineSXDrag
     ~calibration.Rabi
     ~calibration.EFRabi
-    ~calibration.FineAmplitude
-    ~calibration.FineXAmplitude
-    ~calibration.FineSXAmplitude
+    ~calibration.FineAmplitudeCal
+    ~calibration.FineXAmplitudeCal
+    ~calibration.FineSXAmplitudeCal
     ~calibration.RamseyXY
 
 """
@@ -98,9 +101,9 @@ class instance to manage parameters and pulse schedules.
     FineSXDrag,
     Rabi,
     EFRabi,
-    FineAmplitude,
-    FineXAmplitude,
-    FineSXAmplitude,
+    FineAmplitudeCal,
+    FineXAmplitudeCal,
+    FineSXAmplitudeCal,
     RoughFrequencyCal,
     RamseyXY,
 )
@@ -111,6 +114,9 @@ class instance to manage parameters and pulse schedules.
     EFSpectroscopy,
     CrossResonanceHamiltonian,
     EchoedCrossResonanceHamiltonian,
+    FineAmplitude,
+    FineXAmplitude,
+    FineSXAmplitude,
 )
 from .randomized_benchmarking import StandardRB, InterleavedRB
 from .tomography import StateTomography, ProcessTomography

qiskit_experiments/library/calibration/__init__.py

@@ -45,9 +45,9 @@
     FineXDrag
     FineSXDrag
     Rabi
-    FineAmplitude
-    FineXAmplitude
-    FineSXAmplitude
+    FineAmplitudeCal
+    FineXAmplitudeCal
+    FineSXAmplitudeCal
     RamseyXY
 
 Calibration analysis
@@ -70,8 +70,8 @@
 from .rough_frequency import RoughFrequencyCal
 from .drag import DragCal
 from .fine_drag import FineDrag, FineXDrag, FineSXDrag
+from .fine_amplitude import FineAmplitudeCal, FineXAmplitudeCal, FineSXAmplitudeCal
 from .rabi import Rabi, EFRabi
-from .fine_amplitude import FineAmplitude, FineXAmplitude, FineSXAmplitude
 from .ramsey_xy import RamseyXY
 
 from .analysis.drag_analysis import DragCalAnalysis