ConvertToMidCircuitMeasure
class ConvertToMidCircuitMeasure(*args, **kwargs)
Bases: TransformationPass
Transpiler pass replacing mid-circuit measure instructions.
Transpiler pass that replaces terminal measure instructions in non-terminal locations with MidCircuitMeasure instructions. By default, these will be measure_2, but the pass accepts custom measure_ definitions. This pass is expected to run after routing, as it will check that MidCircuitMeasure is supported in the corresponding physical qubit.
This pass is similar to ConvertToMidCircuitResetAndMeasure but only handles measurements, not resets. It internally calls ConvertToMidCircuitResetAndMeasure with a no-op reset name.
Note that the pass will only act on non-terminal measure instances, and won’t replace existing mid-circuit measurement instructions (e.g., "measure_2" -> "measure_3") or convert any MidCircuitMeasure instance into a Measure.
Parameters
- target – Backend’s target instance.
- mcm_name – Name of the instruction used to replace non-terminal Measure instructions. The name must start with “measure”, and the instruction must be contained in the target. The default name is
measure_2.
Raises
ValueError – If the specified mcm_name does not start with measure or is not contained in the provided target.
Attributes
is_analysis_pass
Check if the pass is an analysis pass.
If the pass is an AnalysisPass, that means that the pass can analyze the DAG and write the results of that analysis in the property set. Modifications on the DAG are not allowed by this kind of pass.
is_transformation_pass
Check if the pass is a transformation pass.
If the pass is a TransformationPass, that means that the pass can manipulate the DAG, but cannot modify the property set (but it can be read).
Methods
__call__
__call__(circuit, property_set=None)
Runs the pass on circuit.
Parameters
- circuit (QuantumCircuit) – The dag on which the pass is run.
- property_set (PropertySet | dict | None) – Input/output property set. An analysis pass might change the property set in-place. If not given, the existing
property_setattribute of the pass will be used (if set).
Returns
If a transformation pass, the resulting QuantumCircuit. If analysis pass, the input circuit.
Return type
execute
execute(passmanager_ir, state, callback=None)
Execute optimization task for input Qiskit IR.
Parameters
- passmanager_ir (DAGCircuit) – Qiskit IR to optimize.
- state (DAGCircuit) – State associated with workflow execution by the pass manager itself.
- callback (Callable[[Task, DAGCircuit, PropertySet, float, int], None] | None) – A callback function which is called per execution of optimization task.
Returns
Optimized Qiskit IR and state of the workflow.
Return type
tuple[DAGCircuit, PassManagerState]
name
name()
Name of the pass.
Return type
str
run
update_status
update_status(state, run_state)
Update workflow status.
Parameters
- state (PassManagerState) – Pass manager state to update.
- run_state (RunState) – Completion status of current task.
Returns
Updated pass manager state.
Return type