SetFrequency

SetFrequency(frequency, channel, name=None)

Set the channel frequency. This command 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 command 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.

Parameters

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

Attributes

channel

qiskit.pulse.channels.PulseChannel

Return the Channel that this instruction is scheduled on.

Return type

PulseChannel

channels

Tuple[qiskit.pulse.channels.Channel]

Returns channels that this schedule uses.

Return type

Tuple[Channel]

command

qiskit.pulse.commands.command.Command

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

Return type

Command

duration

int

Duration of this instruction.

Return type

int

frequency

float

New frequency.

Return type

float

id

int

Unique identifier for this instruction.

Return type

int

instructions

Tuple[Tuple[int, qiskit.pulse.instructions.instruction.Instruction]]

Iterable for getting instructions from Schedule tree.

Return type

Tuple[Tuple[int, Instruction]]

name

str

Name of this instruction.

Return type

str

operands

Tuple

Return instruction operands.

Return type

Tuple

start_time

int

Relative begin time of this instruction.

Return type

int

stop_time

int

Relative end time of this instruction.

Return type

int

timeslots

Dict[qiskit.pulse.channels.Channel, List[Tuple[int, int]]]

Occupied time slots by this instruction.

Return type

Dict[Channel, List[Tuple[int, int]]]

Methods

append

SetFrequency.append(schedule, name=None)

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

Parameters

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

Return type

Schedule

ch_duration

SetFrequency.ch_duration(*channels)

Return duration of the supplied channels in this Instruction.

Parameters

*channels – Supplied channels

Return type

int

ch_start_time

SetFrequency.ch_start_time(*channels)

Return minimum start time for supplied channels.

Parameters

*channels – Supplied channels

Return type

int

ch_stop_time

SetFrequency.ch_stop_time(*channels)

Return maximum start time for supplied channels.

Parameters

*channels – Supplied channels

Return type

int

draw

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

Plot the instruction.

Parameters

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
channels_to_plot (Optional[List[Channel]]) – Deprecated, see channels
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
scaling (Optional[float]) – Deprecated, see scale
channels (Optional[List[Channel]]) – A list of channel names to plot

Returns

A matplotlib figure object of the pulse schedule

Return type

matplotlib.figure

flatten

SetFrequency.flatten()

Return itself as already single instruction.

Return type

Instruction

insert

SetFrequency.insert(start_time, schedule, name=None)

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

Parameters

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

Return type

Schedule

shift

SetFrequency.shift(time, name=None)

Return a new schedule shifted forward by time.

Parameters

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

Return type

Schedule

union

SetFrequency.union(*schedules, name=None)

Return a new schedule which is the union of self and schedule.

Parameters

*schedules – Schedules to be take the union with this Instruction.
name (Optional[str]) – Name of the new schedule. Defaults to name of self

Return type

Schedule

Was this page helpful?

Report a bug or request content on GitHub.