qiskit 1.3.0__cp39-abi3-win32.whl

qiskit/transpiler/passes/calibration/rzx_builder.py

@@ -0,0 +1,411 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""RZX calibration builders."""
+from __future__ import annotations
+
+import enum
+import math
+import warnings
+from collections.abc import Sequence
+from math import pi, erf
+
+import numpy as np
+from qiskit.circuit import Instruction as CircuitInst
+from qiskit.circuit.library.standard_gates import RZXGate
+from qiskit.exceptions import QiskitError
+from qiskit.pulse import (
+    Play,
+    Schedule,
+    ScheduleBlock,
+    ControlChannel,
+    DriveChannel,
+    GaussianSquare,
+    Waveform,
+)
+from qiskit.pulse import builder
+from qiskit.pulse.filters import filter_instructions
+from qiskit.pulse.instruction_schedule_map import InstructionScheduleMap
+from qiskit.transpiler.target import Target
+from qiskit.utils.deprecate_pulse import deprecate_pulse_dependency
+
+from .base_builder import CalibrationBuilder
+from .exceptions import CalibrationNotAvailable
+
+
+class CRCalType(enum.Enum):
+    """Estimated calibration type of backend cross resonance operations."""
+
+    ECR_FORWARD = "Echoed Cross Resonance corresponding to native operation"
+    ECR_REVERSE = "Echoed Cross Resonance reverse of native operation"
+    ECR_CX_FORWARD = "Echoed Cross Resonance CX corresponding to native operation"
+    ECR_CX_REVERSE = "Echoed Cross Resonance CX reverse of native operation"
+    DIRECT_CX_FORWARD = "Direct CX corresponding to native operation"
+    DIRECT_CX_REVERSE = "Direct CX reverse of native operation"
+
+
+class RZXCalibrationBuilder(CalibrationBuilder):
+    """
+    Creates calibrations for RZXGate(theta) by stretching and compressing
+    Gaussian square pulses in the CX gate. This is done by retrieving (for a given pair of
+    qubits) the CX schedule in the instruction schedule map of the backend defaults.
+    The CX schedule must be an echoed cross-resonance gate optionally with rotary tones.
+    The cross-resonance drive tones and rotary pulses must be Gaussian square pulses.
+    The width of the Gaussian square pulse is adjusted so as to match the desired rotation angle.
+    If the rotation angle is small such that the width disappears then the amplitude of the
+    zero width Gaussian square pulse (i.e. a Gaussian) is reduced to reach the target rotation
+    angle. Additional details can be found in https://arxiv.org/abs/2012.11660.
+    """
+
+    @deprecate_pulse_dependency
+    def __init__(
+        self,
+        instruction_schedule_map: InstructionScheduleMap = None,
+        verbose: bool = True,
+        target: Target = None,
+    ):
+        """
+        Initializes a RZXGate calibration builder.
+
+        Args:
+            instruction_schedule_map: The :obj:`InstructionScheduleMap` object representing the
+                default pulse calibrations for the target backend
+            verbose: Set True to raise a user warning when RZX schedule cannot be built.
+            target: The :class:`~.Target` representing the target backend, if both
+                 ``instruction_schedule_map`` and this are specified then this argument will take
+                 precedence and ``instruction_schedule_map`` will be ignored.
+
+        Raises:
+            QiskitError: Instruction schedule map is not provided.
+        """
+        super().__init__()
+        self._inst_map = instruction_schedule_map
+        self._verbose = verbose
+        if target:
+            self._inst_map = target._instruction_schedule_map()
+        if self._inst_map is None:
+            raise QiskitError("Calibrations can only be added to Pulse-enabled backends")
+
+    def supported(self, node_op: CircuitInst, qubits: list) -> bool:
+        """Determine if a given node supports the calibration.
+
+        Args:
+            node_op: Target instruction object.
+            qubits: Integer qubit indices to check.
+
+        Returns:
+            Return ``True`` is calibration can be provided.
+        """
+        return isinstance(node_op, RZXGate) and (
+            "cx" in self._inst_map.instructions or "ecr" in self._inst_map.instructions
+        )
+
+    @staticmethod
+    @builder.macro
+    def rescale_cr_inst(instruction: Play, theta: float, sample_mult: int = 16) -> int:
+        """A builder macro to play stretched pulse.
+
+        Args:
+            instruction: The instruction from which to create a new shortened or lengthened pulse.
+            theta: desired angle, pi/2 is assumed to be the angle that the pulse in the given
+                play instruction implements.
+            sample_mult: All pulses must be a multiple of sample_mult.
+
+        Returns:
+            Duration of stretched pulse.
+
+        Raises:
+            QiskitError: if rotation angle is not assigned.
+        """
+        try:
+            theta = float(theta)
+        except TypeError as ex:
+            raise QiskitError("Target rotation angle is not assigned.") from ex
+
+        # This method is called for instructions which are guaranteed to play GaussianSquare pulse
+        params = instruction.pulse.parameters.copy()
+        risefall_sigma_ratio = (params["duration"] - params["width"]) / params["sigma"]
+
+        # The error function is used because the Gaussian may have chopped tails.
+        # Area is normalized by amplitude.
+        # This makes widths robust to the rounding error.
+        risefall_area = params["sigma"] * math.sqrt(2 * pi) * erf(risefall_sigma_ratio)
+        full_area = params["width"] + risefall_area
+
+        # Get estimate of target area. Assume this is pi/2 controlled rotation.
+        cal_angle = pi / 2
+        target_area = abs(theta) / cal_angle * full_area
+        new_width = target_area - risefall_area
+
+        if new_width >= 0:
+            width = new_width
+            params["amp"] *= np.sign(theta)
+        else:
+            width = 0
+            params["amp"] *= np.sign(theta) * target_area / risefall_area
+
+        round_duration = (
+            round((width + risefall_sigma_ratio * params["sigma"]) / sample_mult) * sample_mult
+        )
+        params["duration"] = round_duration
+        params["width"] = width
+
+        stretched_pulse = GaussianSquare(**params)
+        builder.play(stretched_pulse, instruction.channel)
+
+        return round_duration
+
+    def get_calibration(self, node_op: CircuitInst, qubits: list) -> Schedule | ScheduleBlock:
+        """Builds the calibration schedule for the RZXGate(theta) with echos.
+
+        Args:
+            node_op: Instruction of the RZXGate(theta). I.e. params[0] is theta.
+            qubits: List of qubits for which to get the schedules. The first qubit is
+                the control and the second is the target.
+
+        Returns:
+            schedule: The calibration schedule for the RZXGate(theta).
+
+        Raises:
+            QiskitError: if rotation angle is not assigned.
+            QiskitError: If the control and target qubits cannot be identified.
+            CalibrationNotAvailable: RZX schedule cannot be built for input node.
+        """
+        theta = node_op.params[0]
+
+        try:
+            theta = float(theta)
+        except TypeError as ex:
+            raise QiskitError("Target rotation angle is not assigned.") from ex
+
+        if np.isclose(theta, 0.0):
+            return ScheduleBlock(name="rzx(0.000)")
+
+        cal_type, cr_tones, comp_tones = _check_calibration_type(self._inst_map, qubits)
+
+        if cal_type in [CRCalType.DIRECT_CX_FORWARD, CRCalType.DIRECT_CX_REVERSE]:
+            if self._verbose:
+                warnings.warn(
+                    f"CR instruction for qubits {qubits} is likely {cal_type.value} sequence. "
+                    "Pulse stretch for this calibration is not currently implemented. "
+                    "RZX schedule is not generated for this qubit pair.",
+                    UserWarning,
+                )
+            raise CalibrationNotAvailable
+
+        # The CR instruction is in the forward (native) direction
+        if cal_type in [CRCalType.ECR_CX_FORWARD, CRCalType.ECR_FORWARD]:
+            with warnings.catch_warnings():
+                warnings.simplefilter(action="ignore", category=DeprecationWarning)
+                # `InstructionScheduleMap.get` and the pulse builder emit deprecation warnings
+                # as they use classes and methods which are deprecated in Qiskit 1.3 as part of the
+                # Qiskit Pulse deprecation
+                xgate = self._inst_map.get("x", qubits[0])
+                with builder.build(
+                    default_alignment="sequential", name=f"rzx({theta:.3f})"
+                ) as rzx_theta_native:
+                    for cr_tone, comp_tone in zip(cr_tones, comp_tones):
+                        with builder.align_left():
+                            self.rescale_cr_inst(cr_tone, theta)
+                            self.rescale_cr_inst(comp_tone, theta)
+                        builder.call(xgate)
+            return rzx_theta_native
+
+        # The direction is not native. Add Hadamard gates to flip the direction.
+        xgate = self._inst_map.get("x", qubits[1])
+        szc = self._inst_map.get("rz", qubits[1], pi / 2)
+        sxc = self._inst_map.get("sx", qubits[1])
+        szt = self._inst_map.get("rz", qubits[0], pi / 2)
+        sxt = self._inst_map.get("sx", qubits[0])
+        with builder.build(name="hadamard") as hadamard:
+            # Control qubit
+            builder.call(szc, name="szc")
+            builder.call(sxc, name="sxc")
+            builder.call(szc, name="szc")
+            # Target qubit
+            builder.call(szt, name="szt")
+            builder.call(sxt, name="sxt")
+            builder.call(szt, name="szt")
+
+        with builder.build(
+            default_alignment="sequential", name=f"rzx({theta:.3f})"
+        ) as rzx_theta_flip:
+            builder.call(hadamard, name="hadamard")
+            for cr_tone, comp_tone in zip(cr_tones, comp_tones):
+                with builder.align_left():
+                    self.rescale_cr_inst(cr_tone, theta)
+                    self.rescale_cr_inst(comp_tone, theta)
+                builder.call(xgate)
+            builder.call(hadamard, name="hadamard")
+        return rzx_theta_flip
+
+
+class RZXCalibrationBuilderNoEcho(RZXCalibrationBuilder):
+    """
+    Creates calibrations for RZXGate(theta) by stretching and compressing
+    Gaussian square pulses in the CX gate.
+
+    The ``RZXCalibrationBuilderNoEcho`` is a variation of the
+    :class:`~qiskit.transpiler.passes.RZXCalibrationBuilder` pass
+    that creates calibrations for the cross-resonance pulses without inserting
+    the echo pulses in the pulse schedule. This enables exposing the echo in
+    the cross-resonance sequence as gates so that the transpiler can simplify them.
+    The ``RZXCalibrationBuilderNoEcho`` only supports the hardware-native direction
+    of the CX gate.
+    """
+
+    def get_calibration(self, node_op: CircuitInst, qubits: list) -> Schedule | ScheduleBlock:
+        """Builds the calibration schedule for the RZXGate(theta) without echos.
+
+        Args:
+            node_op: Instruction of the RZXGate(theta). I.e. params[0] is theta.
+            qubits: List of qubits for which to get the schedules. The first qubit is
+                the control and the second is the target.
+
+        Returns:
+            schedule: The calibration schedule for the RZXGate(theta).
+
+        Raises:
+            QiskitError: if rotation angle is not assigned.
+            QiskitError: If the control and target qubits cannot be identified,
+                or the backend does not natively support the specified direction of the cx.
+            CalibrationNotAvailable: RZX schedule cannot be built for input node.
+        """
+        theta = node_op.params[0]
+
+        try:
+            theta = float(theta)
+        except TypeError as ex:
+            raise QiskitError("Target rotation angle is not assigned.") from ex
+
+        if np.isclose(theta, 0.0):
+            return ScheduleBlock(name="rzx(0.000)")
+
+        cal_type, cr_tones, comp_tones = _check_calibration_type(self._inst_map, qubits)
+
+        if cal_type in [CRCalType.DIRECT_CX_FORWARD, CRCalType.DIRECT_CX_REVERSE]:
+            if self._verbose:
+                warnings.warn(
+                    f"CR instruction for qubits {qubits} is likely {cal_type.value} sequence. "
+                    "Pulse stretch for this calibration is not currently implemented. "
+                    "RZX schedule is not generated for this qubit pair.",
+                    UserWarning,
+                )
+            raise CalibrationNotAvailable
+
+        # RZXCalibrationNoEcho only good for forward CR direction
+        if cal_type in [CRCalType.ECR_CX_FORWARD, CRCalType.ECR_FORWARD]:
+            with warnings.catch_warnings():
+                warnings.simplefilter(action="ignore", category=DeprecationWarning)
+                # Pulse builder emits deprecation warnings as part of the
+                # Qiskit Pulse deprecation
+                with builder.build(default_alignment="left", name=f"rzx({theta:.3f})") as rzx_theta:
+                    stretched_dur = self.rescale_cr_inst(cr_tones[0], 2 * theta)
+                    self.rescale_cr_inst(comp_tones[0], 2 * theta)
+                    # Placeholder to make pulse gate work
+                    builder.delay(stretched_dur, DriveChannel(qubits[0]))
+            return rzx_theta
+
+        raise QiskitError("RZXCalibrationBuilderNoEcho only supports hardware-native RZX gates.")
+
+
+def _filter_cr_tone(time_inst_tup):
+    """A helper function to filter pulses on control channels."""
+    valid_types = ["GaussianSquare"]
+
+    _, inst = time_inst_tup
+    if isinstance(inst, Play) and isinstance(inst.channel, ControlChannel):
+        pulse = inst.pulse
+        if isinstance(pulse, Waveform) or pulse.pulse_type in valid_types:
+            return True
+    return False
+
+
+def _filter_comp_tone(time_inst_tup):
+    """A helper function to filter pulses on drive channels."""
+    valid_types = ["GaussianSquare"]
+
+    _, inst = time_inst_tup
+    if isinstance(inst, Play) and isinstance(inst.channel, DriveChannel):
+        pulse = inst.pulse
+        if isinstance(pulse, Waveform) or pulse.pulse_type in valid_types:
+            return True
+    return False
+
+
+def _check_calibration_type(
+    inst_sched_map: InstructionScheduleMap, qubits: Sequence[int]
+) -> tuple[CRCalType, list[Play], list[Play]]:
+    """A helper function to check type of CR calibration.
+
+    Args:
+        inst_sched_map: instruction schedule map of the backends
+        qubits: ordered tuple of qubits for cross resonance (q_control, q_target)
+
+    Returns:
+        Filtered instructions and most-likely type of calibration.
+
+    Raises:
+        QiskitError: Unknown calibration type is detected.
+    """
+    cal_type = None
+    with warnings.catch_warnings():
+        warnings.simplefilter(action="ignore", category=DeprecationWarning)
+        # `InstructionScheduleMap.get` and `filter_instructions` emit deprecation warnings
+        # as they use classes and methods which are deprecated in Qiskit 1.3 as part of the
+        # Qiskit Pulse deprecation
+        if inst_sched_map.has("cx", qubits):
+            cr_sched = inst_sched_map.get("cx", qubits=qubits)
+        elif inst_sched_map.has("ecr", qubits):
+            cr_sched = inst_sched_map.get("ecr", qubits=qubits)
+            cal_type = CRCalType.ECR_FORWARD
+        elif inst_sched_map.has("ecr", tuple(reversed(qubits))):
+            cr_sched = inst_sched_map.get("ecr", tuple(reversed(qubits)))
+            cal_type = CRCalType.ECR_REVERSE
+        else:
+            raise QiskitError(
+                f"Native direction cannot be determined: operation on qubits {qubits} "
+                f"for the following instruction schedule map:\n{inst_sched_map}"
+            )
+
+        cr_tones = [t[1] for t in filter_instructions(cr_sched, [_filter_cr_tone]).instructions]
+        comp_tones = [t[1] for t in filter_instructions(cr_sched, [_filter_comp_tone]).instructions]
+
+    if cal_type is None:
+        if len(comp_tones) == 0:
+            raise QiskitError(
+                f"{repr(cr_sched)} has no target compensation tones. "
+                "Native ECR direction cannot be determined."
+            )
+        # Determine native direction, assuming only single drive channel per qubit.
+        # This guarantees channel and qubit index equality.
+        if comp_tones[0].channel.index == qubits[1]:
+            cal_type = CRCalType.ECR_CX_FORWARD
+        else:
+            cal_type = CRCalType.ECR_CX_REVERSE
+
+    if len(cr_tones) == 2 and len(comp_tones) in (0, 2):
+        # ECR can be implemented without compensation tone at price of lower fidelity.
+        # Remarkable noisy terms are usually eliminated by echo.
+        return cal_type, cr_tones, comp_tones
+
+    if len(cr_tones) == 1 and len(comp_tones) == 1:
+        # Direct CX must have compensation tone on target qubit.
+        # Otherwise, it cannot eliminate IX interaction.
+        if comp_tones[0].channel.index == qubits[1]:
+            return CRCalType.DIRECT_CX_FORWARD, cr_tones, comp_tones
+        else:
+            return CRCalType.DIRECT_CX_REVERSE, cr_tones, comp_tones
+    raise QiskitError(
+        f"{repr(cr_sched)} is undefined pulse sequence. "
+        "Check if this is a calibration for cross resonance operation."
+    )

qiskit/transpiler/passes/calibration/rzx_templates.py

@@ -0,0 +1,51 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2021.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""
+Convenience function to load RZXGate based templates.
+"""
+
+from enum import Enum
+from typing import List, Dict
+
+from qiskit.circuit.library.templates import rzx
+
+
+def rzx_templates(template_list: List[str] = None) -> Dict:
+    """Convenience function to get the cost_dict and templates for template matching.
+
+    Args:
+        template_list: List of instruction names.
+
+    Returns:
+        Decomposition templates and cost values.
+    """
+
+    class RZXTemplateMap(Enum):
+        """Mapping of instruction name to decomposition template."""
+
+        ZZ1 = rzx.rzx_zz1()
+        ZZ2 = rzx.rzx_zz2()
+        ZZ3 = rzx.rzx_zz3()
+        YZ = rzx.rzx_yz()
+        XZ = rzx.rzx_xz()
+        CY = rzx.rzx_cy()
+
+    if template_list is None:
+        template_list = ["zz1", "zz2", "zz3", "yz", "xz", "cy"]
+
+    templates = [RZXTemplateMap[gate.upper()].value for gate in template_list]
+    cost_dict = {"rzx": 0, "cx": 6, "rz": 0, "sx": 1, "p": 0, "h": 1, "rx": 1, "ry": 1}
+
+    rzx_dict = {"template_list": templates, "user_cost_dict": cost_dict}
+
+    return rzx_dict

qiskit/transpiler/passes/layout/__init__.py

@@ -0,0 +1,26 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2017, 2018.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Module containing transpiler layout passes."""
+
+from .set_layout import SetLayout
+from .trivial_layout import TrivialLayout
+from .dense_layout import DenseLayout
+from .sabre_layout import SabreLayout
+from .csp_layout import CSPLayout
+from .vf2_layout import VF2Layout
+from .vf2_post_layout import VF2PostLayout
+from .apply_layout import ApplyLayout
+from .layout_2q_distance import Layout2qDistance
+from .enlarge_with_ancilla import EnlargeWithAncilla
+from .full_ancilla_allocation import FullAncillaAllocation
+from .sabre_pre_layout import SabrePreLayout

qiskit/transpiler/passes/layout/_csp_custom_solver.py

@@ -0,0 +1,65 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2022.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""A custom python-constraint solver used by the :class:`~.CSPLayout` pass"""
+from time import time
+
+from qiskit.utils import optionals as _optionals
+
+# This isn't ideal usage because we will import constraint at import time
+# but to ensure the CustomSolver class is defined we need to do this.
+# If constraint is not installed this will not raise a missing library
+# exception until CSPLayout is initialized
+if _optionals.HAS_CONSTRAINT:
+    from constraint import RecursiveBacktrackingSolver
+
+    class CustomSolver(RecursiveBacktrackingSolver):
+        """A wrap to RecursiveBacktrackingSolver to support ``call_limit``"""
+
+        # pylint: disable=invalid-name
+
+        def __init__(self, call_limit=None, time_limit=None):
+            self.call_limit = call_limit
+            self.time_limit = time_limit
+            self.call_current = None
+            self.time_start = None
+            self.time_current = None
+            super().__init__()
+
+        def limit_reached(self):
+            """Checks if a limit is reached."""
+            if self.call_current is not None:
+                self.call_current += 1
+                if self.call_current > self.call_limit:
+                    return True
+            if self.time_start is not None:
+                self.time_current = time() - self.time_start
+                if self.time_current > self.time_limit:
+                    return True
+            return False
+
+        def getSolution(self, domains, constraints, vconstraints):
+            """Wrap RecursiveBacktrackingSolver.getSolution to add the limits."""
+            if self.call_limit is not None:
+                self.call_current = 0
+            if self.time_limit is not None:
+                self.time_start = time()
+            return super().getSolution(domains, constraints, vconstraints)
+
+        def recursiveBacktracking(self, solutions, domains, vconstraints, assignments, single):
+            """Like ``constraint.RecursiveBacktrackingSolver.recursiveBacktracking`` but
+            limited in the amount of calls by ``self.call_limit``"""
+            if self.limit_reached():
+                return None
+            return super().recursiveBacktracking(
+                solutions, domains, vconstraints, assignments, single
+            )

qiskit/transpiler/passes/layout/apply_layout.py

@@ -0,0 +1,123 @@
+# This code is part of Qiskit.
+#
+# (C) Copyright IBM 2019.
+#
+# This code is licensed under the Apache License, Version 2.0. You may
+# obtain a copy of this license in the LICENSE.txt file in the root directory
+# of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.
+#
+# Any modifications or derivative works of this code must retain this
+# copyright notice, and modified files need to carry a notice indicating
+# that they have been altered from the originals.
+
+"""Transform a circuit with virtual qubits into a circuit with physical qubits."""
+
+from qiskit.circuit import QuantumRegister
+from qiskit.dagcircuit import DAGCircuit, DAGOpNode
+from qiskit.transpiler.basepasses import TransformationPass
+from qiskit.transpiler.exceptions import TranspilerError
+from qiskit.transpiler.layout import Layout
+
+
+class ApplyLayout(TransformationPass):
+    """Transform a circuit with virtual qubits into a circuit with physical qubits.
+
+    Transforms a DAGCircuit with virtual qubits into a DAGCircuit with physical qubits
+    by applying the Layout given in `property_set`.
+    Requires either of passes to set/select Layout, e.g. `SetLayout`, `TrivialLayout`.
+    Assumes the Layout has full physical qubits.
+
+    If a post layout pass is run and sets the ``post_layout`` property set field with
+    a new layout to use after ``ApplyLayout`` has already run once this pass will
+    compact the layouts so that we apply
+    ``original_virtual`` -> ``existing_layout`` -> ``new_layout`` -> ``new_physical``
+    so that the output circuit and layout combination become:
+    ``original_virtual`` -> ``new_physical``
+    """
+
+    def run(self, dag):
+        """Run the ApplyLayout pass on ``dag``.
+
+        Args:
+            dag (DAGCircuit): DAG to map.
+
+        Returns:
+            DAGCircuit: A mapped DAG (with physical qubits).
+
+        Raises:
+            TranspilerError: if no layout is found in ``property_set`` or no full physical qubits.
+        """
+        layout = self.property_set["layout"]
+        if not layout:
+            raise TranspilerError(
+                "No 'layout' is found in property_set. Please run a Layout pass in advance."
+            )
+        if len(layout) != (1 + max(layout.get_physical_bits())):
+            raise TranspilerError("The 'layout' must be full (with ancilla).")
+
+        post_layout = self.property_set["post_layout"]
+        q = QuantumRegister(len(layout), "q")
+
+        new_dag = DAGCircuit()
+        new_dag.add_qreg(q)
+        for var in dag.iter_input_vars():
+            new_dag.add_input_var(var)
+        for var in dag.iter_captured_vars():
+            new_dag.add_captured_var(var)
+        for var in dag.iter_declared_vars():
+            new_dag.add_declared_var(var)
+        new_dag.metadata = dag.metadata
+        new_dag.add_clbits(dag.clbits)
+        for creg in dag.cregs.values():
+            new_dag.add_creg(creg)
+        if post_layout is None:
+            self.property_set["original_qubit_indices"] = {
+                bit: index for index, bit in enumerate(dag.qubits)
+            }
+            for qreg in dag.qregs.values():
+                self.property_set["layout"].add_register(qreg)
+            virtual_physical_map = layout.get_virtual_bits()
+            for node in dag.topological_op_nodes():
+                qargs = [q[virtual_physical_map[qarg]] for qarg in node.qargs]
+                new_dag._apply_op_node_back(
+                    DAGOpNode.from_instruction(
+                        node._to_circuit_instruction().replace(qubits=qargs)
+                    ),
+                    check=False,
+                )
+        else:
+            # First build a new layout object going from:
+            # old virtual -> old physical -> new virtual -> new physical
+            # to:
+            # old virtual -> new physical
+            full_layout = Layout()
+            old_phys_to_virtual = layout.get_physical_bits()
+            new_virtual_to_physical = post_layout.get_virtual_bits()
+            phys_map = list(range(len(new_dag.qubits)))
+            for new_virt, new_phys in new_virtual_to_physical.items():
+                old_phys = dag.find_bit(new_virt).index
+                old_virt = old_phys_to_virtual[old_phys]
+                phys_map[old_phys] = new_phys
+                full_layout.add(old_virt, new_phys)
+            for reg in layout.get_registers():
+                full_layout.add_register(reg)
+            # Apply new layout to the circuit
+            for node in dag.topological_op_nodes():
+                qargs = [q[new_virtual_to_physical[qarg]] for qarg in node.qargs]
+                new_dag._apply_op_node_back(
+                    DAGOpNode.from_instruction(
+                        node._to_circuit_instruction().replace(qubits=qargs)
+                    ),
+                    check=False,
+                )
+            self.property_set["layout"] = full_layout
+            if (final_layout := self.property_set["final_layout"]) is not None:
+                final_layout_mapping = {
+                    new_dag.qubits[phys_map[dag.find_bit(old_virt).index]]: phys_map[old_phys]
+                    for old_virt, old_phys in final_layout.get_virtual_bits().items()
+                }
+                out_layout = Layout(final_layout_mapping)
+                self.property_set["final_layout"] = out_layout
+        new_dag.global_phase = dag.global_phase
+
+        return new_dag