qiskit.pulse.InstructionScheduleMap¶

class
InstructionScheduleMap
[source]¶ Mapping from
QuantumCircuit
qiskit.circuit.Instruction
names and qubits toSchedule
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.
Methods
__init__
()Initialize a circuit instruction to schedule mapper instance.
add
(instruction, qubits, schedule)Add a new known instruction for the given qubits and its mapping to a pulse schedule.
assert_has
(instruction, qubits)Error if the given instruction is not defined.
get
(instruction, qubits, *params, **kwparams)Return the defined
Schedule
for the given instruction on the given qubits.get_parameters
(instruction, qubits)Return the list of parameters taken by the given instruction on the given qubits.
has
(instruction, qubits)Is the instruction defined for the given qubits?
pop
(instruction, qubits, *params, **kwparams)Remove and return the defined
Schedule
for the given instruction on the given qubits.qubit_instructions
(qubits)Return a list of the instruction names that are defined by the backend for the given qubit or qubits.
qubits_with_instruction
(instruction)Return a list of the qubits for which the given instruction is defined.
remove
(instruction, qubits)Remove the given instruction from the listing of instructions defined in self.
Attributes
Return all instructions which have definitions.

add
(instruction, qubits, schedule)[source]¶ Add a new known instruction for the given qubits and its mapping to a pulse schedule.
 Parameters
instruction (
str
) – The name of the instruction to add.qubits (
Union
[int
,Iterable
[int
]]) – The qubits which the instruction applies to.schedule (
Union
[Schedule
,Callable
[…,Schedule
]]) – The Schedule that implements the given instruction.
 Raises
PulseError – If the qubits are provided as an empty iterable.
 Return type
None

assert_has
(instruction, qubits)[source]¶ Error if the given instruction is not defined.
 Parameters
instruction (
str
) – The instruction for which to look.qubits (
Union
[int
,Iterable
[int
]]) – The specific qubits for the instruction.
 Raises
PulseError – If the instruction is not defined on the qubits.
 Return type
None

get
(instruction, qubits, *params, **kwparams)[source]¶ Return the defined
Schedule
for the given instruction on the given qubits. Parameters
instruction (
str
) – Name of the instruction.qubits (
Union
[int
,Iterable
[int
]]) – The qubits for the instruction.*params – Command parameters for generating the output schedule.
**kwparams – Keyworded command parameters for generating the schedule.
 Return type
Schedule
 Returns
The Schedule defined for the input.

get_parameters
(instruction, qubits)[source]¶ Return the list of parameters taken by the given instruction on the given qubits.
 Parameters
instruction (
str
) – Name of the instruction.qubits (
Union
[int
,Iterable
[int
]]) – The qubits for the instruction.
 Return type
Tuple
[str
] Returns
The names of the parameters required by the instruction.

has
(instruction, qubits)[source]¶ Is the instruction defined for the given qubits?
 Parameters
instruction (
str
) – The instruction for which to look.qubits (
Union
[int
,Iterable
[int
]]) – The specific qubits for the instruction.
 Return type
bool
 Returns
True iff the instruction is defined.

property
instructions
¶ Return all instructions which have definitions.
By default, these are typically the basis gates along with other instructions such as measure and reset.
 Return type
List
[str
] Returns
The names of all the circuit instructions which have Schedule definitions in this.

pop
(instruction, qubits, *params, **kwparams)[source]¶ Remove and return the defined
Schedule
for the given instruction on the given qubits. Parameters
instruction (
str
) – Name of the instruction.qubits (
Union
[int
,Iterable
[int
]]) – The qubits for the instruction.*params – Command parameters for generating the output schedule.
**kwparams – Keyworded command parameters for generating the schedule.
 Return type
Schedule
 Returns
The Schedule defined for the input.

qubit_instructions
(qubits)[source]¶ Return a list of the instruction names that are defined by the backend for the given qubit or qubits.
 Parameters
qubits (
Union
[int
,Iterable
[int
]]) – A qubit index, or a list or tuple of indices. Return type
List
[str
] 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']
).

qubits_with_instruction
(instruction)[source]¶ 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
) – The name of the circuit instruction. Return type
List
[Union
[int
,Tuple
[int
]]] 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.
