Skip to main contentIBM Quantum Documentation
You are viewing the API reference for an old version of Qiskit SDK. Switch to latest version

PulseGates

PulseGates(inst_map) GitHub(opens in a new tab)

Bases: qiskit.transpiler.passes.calibration.builders.CalibrationBuilder

Pulse gate adding pass.

This pass adds gate calibrations from the supplied InstructionScheduleMap to a quantum circuit.

This pass checks each DAG circuit node and acquires a corresponding schedule from the instruction schedule map object that may be provided by the target backend. Because this map is a mutable object, the end-user can provide a configured backend to execute the circuit with customized gate implementations.

This mapping object returns a schedule with “publisher” metadata which is an integer Enum value representing who created the gate schedule. If the gate schedule is provided by end-users, this pass attaches the schedule to the DAG circuit as a calibration.

This pass allows users to easily override quantum circuit with custom gate definitions without directly dealing with those schedules.

References

Create new pass.

Parameters

inst_map (InstructionScheduleMap) – Instruction schedule map that user may override.


Methods

get_calibration

PulseGates.get_calibration(node_op, qubits)

Gets the calibrated schedule for the given instruction and qubits.

Parameters

  • node_op (Instruction) – Target instruction object.
  • qubits (List) – Integer qubit indices to check.

Return type

Union[Schedule, ScheduleBlock]

Returns

Return Schedule of target gate instruction.

name

PulseGates.name()

Return the name of the pass.

run

PulseGates.run(dag)

Run the calibration adder pass on dag.

Parameters

dag (DAGCircuit) – DAG to schedule.

Return type

DAGCircuit

Returns

A DAG with calibrations added to it.

supported

PulseGates.supported(node_op, qubits)

Determine if a given node supports the calibration.

Parameters

  • node_op (Instruction) – Target instruction object.
  • qubits (List) – Integer qubit indices to check.

Return type

bool

Returns

Return True is calibration can be provided.


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).

Was this page helpful?