qiskit.pulse.SetFrequency¶

class SetFrequency(frequency, channel, name=None)[Quellcode]¶

Set the channel frequency. This instruction operates on PulseChannel s. A PulseChannel creates pulses of the form

\[Re[\exp(i 2\pi f jdt + \phi) d_j].\]

Here, \(f\) is the frequency of the channel. The instruction SetFrequency allows the user to set the value of \(f\). All pulses that are played on a channel after SetFrequency has been called will have the corresponding frequency.

The duration of SetFrequency is 0.

Creates a new set channel frequency instruction.

Parameter

frequency (Union[float, ParameterExpression]) – New frequency of the channel in Hz.
channel (PulseChannel) – The channel this instruction operates on.
name (Optional[str]) – Name of this set channel frequency instruction.

__init__(frequency, channel, name=None)[Quellcode]¶

Creates a new set channel frequency instruction.

Parameter

frequency (Union[float, ParameterExpression]) – New frequency of the channel in Hz.
channel (PulseChannel) – The channel this instruction operates on.
name (Optional[str]) – Name of this set channel frequency instruction.

Methods

`__init__`(frequency, channel[, name])	Creates a new set channel frequency instruction.
`append`(schedule[, name])	Return a new `Schedule` with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`.
`assign_parameters`(value_dict)	Modify and return self with parameters assigned according to the input.
`ch_duration`(*channels)	Return duration of the supplied channels in this Instruction.
`ch_start_time`(*channels)	Return minimum start time for supplied channels.
`ch_stop_time`(*channels)	Return maximum start time for supplied channels.
`draw`([dt, style, filename, interp_method, …])	Plot the instruction.
`flatten`()	Return itself as already single instruction.
`insert`(start_time, schedule[, name])	Return a new `Schedule` with `schedule` inserted within `self` at `start_time`.
`shift`(time[, name])	Return a new schedule shifted forward by time.

Attributes

`channel`	Return the `Channel` that this instruction is scheduled on.
`channels`	Returns channels that this schedule uses.
`command`	The associated command.
`duration`	Duration of this instruction.
`frequency`	New frequency.
`id`	Unique identifier for this instruction.
`instructions`	Iterable for getting instructions from Schedule tree.
`name`	Name of this instruction.
`operands`	Return instruction operands.
`start_time`	Relative begin time of this instruction.
`stop_time`	Relative end time of this instruction.
`timeslots`	Occupied time slots by this instruction.

append(schedule, name=None)¶

Return a new Schedule with schedule inserted at the maximum time over all channels shared between self and schedule.

Parameter

schedule (ScheduleComponent) – schedule to be appended
name (Optional[str]) – Name of the new schedule. Defaults to name of self

Rückgabetyp

Schedule

assign_parameters(value_dict)¶

Modify and return self with parameters assigned according to the input.

Parameter: value_dict (Dict[ParameterExpression, Union[ParameterExpression, float, int]]) – A mapping from Parameters to either numeric values or another Parameter expression.
Rückgabetyp: Instruction
Rückgabe: Self with updated parameters.

ch_duration(*channels)¶

Return duration of the supplied channels in this Instruction.

Parameter: *channels – Supplied channels
Rückgabetyp: int

ch_start_time(*channels)¶

Return minimum start time for supplied channels.

Parameter: *channels – Supplied channels
Rückgabetyp: int

ch_stop_time(*channels)¶

Return maximum start time for supplied channels.

Parameter: *channels – Supplied channels
Rückgabetyp: int

property channel¶

Return the Channel that this instruction is scheduled on.

Rückgabetyp: PulseChannel

property channels¶

Returns channels that this schedule uses.

Rückgabetyp: Tuple[Channel]

property command¶

The associated command. Commands are deprecated, so this method will be deprecated shortly.

Rückgabe: The deprecated command if available.
Rückgabetyp: Command

draw(dt=1, style=None, filename=None, interp_method=None, scale=1, plot_all=False, plot_range=None, interactive=False, table=True, label=False, framechange=True, channels=None)¶

Plot the instruction.

Parameter

dt (float) – Time interval of samples
style (Optional[SchedStyle]) – A style sheet to configure plot appearance
filename (Optional[str]) – Name required to save pulse image
interp_method (Optional[Callable]) – A function for interpolation
scale (float) – Relative visual scaling of waveform amplitudes
plot_all (bool) – Plot empty channels
plot_range (Optional[Tuple[float]]) – A tuple of time range to plot
interactive (bool) – When set true show the circuit in a new window (this depends on the matplotlib backend being used supporting this)
table (bool) – Draw event table for supported instructions
label (bool) – Label individual instructions
framechange (bool) – Add framechange indicators
channels (Optional[List[Channel]]) – A list of channel names to plot

Rückgabe

A matplotlib figure object of the pulse schedule

Rückgabetyp

matplotlib.figure

property duration¶

Duration of this instruction.

Rückgabetyp: int

flatten()¶

Return itself as already single instruction.

Rückgabetyp: Instruction

property frequency¶

New frequency.

Rückgabetyp: Union[float, ParameterExpression]

property id¶

Unique identifier for this instruction.

Rückgabetyp: int

insert(start_time, schedule, name=None)¶

Return a new Schedule with schedule inserted within self at start_time.

Parameter

start_time (int) – Time to insert the schedule schedule
schedule (ScheduleComponent) – Schedule to insert
name (Optional[str]) – Name of the new schedule. Defaults to name of self

Rückgabetyp

Schedule

property instructions¶

Iterable for getting instructions from Schedule tree.

Rückgabetyp: Tuple[Tuple[int, Instruction]]

property name¶

Name of this instruction.

Rückgabetyp: str

property operands¶

Return instruction operands.

Rückgabetyp: Tuple

shift(time, name=None)¶

Return a new schedule shifted forward by time.

Parameter

time (int) – Time to shift by
name (Optional[str]) – Name of the new schedule. Defaults to name of self

Rückgabetyp

Schedule

property start_time¶

Relative begin time of this instruction.

Rückgabetyp: int

property stop_time¶

Relative end time of this instruction.

Rückgabetyp: int

property timeslots¶

Occupied time slots by this instruction.

Rückgabetyp: Dict[Channel, List[Tuple[int, int]]]