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

InstructionScheduleMap

qiskit.pulse.InstructionScheduleMap

GitHub(opens in a new tab)

Bases: object(opens in a new tab)

Mapping from QuantumCircuit qiskit.circuit.Instruction names and qubits to Schedule s. In particular, the mapping is formatted as type:

Dict[str, Dict[Tuple[int], Schedule]]

where the first key is the name of a circuit instruction (e.g. 'u1', 'measure'), the second key is a tuple of qubit indices, and the final value is a Schedule implementing the requested instruction.

These can usually be seen as gate calibrations.

Initialize a circuit instruction to schedule mapper instance.


Attributes

instructions

Return all instructions which have definitions.

By default, these are typically the basis gates along with other instructions such as measure and reset.

Returns

The names of all the circuit instructions which have Schedule definitions in this.


Methods

add

add(instruction, qubits, schedule, arguments=None)

Add a new known instruction for the given qubits and its mapping to a pulse schedule.

Parameters

Raises

PulseError – If the qubits are provided as an empty iterable.

assert_has

assert_has(instruction, qubits)

Error if the given instruction is not defined.

Parameters

Raises

PulseError – If the instruction is not defined on the qubits.

get

get(instruction, qubits, *params, **kwparams)

Return the defined Schedule or ScheduleBlock for the given instruction on the given qubits.

If all keys are not specified this method returns schedule with unbound parameters.

Parameters

Returns

The Schedule defined for the input.

Return type

Schedule | ScheduleBlock

get_parameters

get_parameters(instruction, qubits)

Return the list of parameters taken by the given instruction on the given qubits.

Parameters

Returns

The names of the parameters required by the instruction.

Return type

Tuple(opens in a new tab)[str(opens in a new tab)]

has

has(instruction, qubits)

Is the instruction defined for the given qubits?

Parameters

Returns

True iff the instruction is defined.

Return type

bool(opens in a new tab)

has_custom_gate

has_custom_gate()

Return True if the map has user provided instruction.

Return type

bool(opens in a new tab)

pop

pop(instruction, qubits, *params, **kwparams)

Remove and return the defined schedule for the given instruction on the given qubits.

Parameters

Returns

The Schedule defined for the input.

Return type

Schedule | ScheduleBlock

qubit_instructions

qubit_instructions(qubits)

Return a list of the instruction names that are defined by the backend for the given qubit or qubits.

Parameters

qubits (int(opens in a new tab) |Iterable(opens in a new tab)[int(opens in a new tab)]) – A qubit index, or a list or tuple of indices.

Returns

All the instructions which are defined on the qubits.

For 1 qubit, all the 1Q instructions defined. For multiple qubits, all the instructions which apply to that whole set of qubits (e.g. qubits=[0, 1] may return ['cx']).

Return type

List(opens in a new tab)[str(opens in a new tab)]

qubits_with_instruction

qubits_with_instruction(instruction)

Return a list of the qubits for which the given instruction is defined. Single qubit instructions return a flat list, and multiqubit instructions return a list of ordered tuples.

Parameters

instruction (str(opens in a new tab) |Instruction) – The name of the circuit instruction.

Returns

Qubit indices which have the given instruction defined. This is a list of tuples if the instruction has an arity greater than 1, or a flat list of ints otherwise.

Raises

PulseError – If the instruction is not found.

Return type

List(opens in a new tab)[int(opens in a new tab) | Tuple(opens in a new tab)[int(opens in a new tab)]]

remove

remove(instruction, qubits)

Remove the given instruction from the listing of instructions defined in self.

Parameters

Was this page helpful?
Report a bug or request content on GitHub.