SetFrequency

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

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.

Parameters
  • 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.

Attributes

SetFrequency.channel

Return the Channel that this instruction is scheduled on.

SetFrequency.channels

Returns channels that this schedule uses.

SetFrequency.command

The associated command.

SetFrequency.duration

Duration of this instruction.

SetFrequency.frequency

New frequency.

SetFrequency.id

Unique identifier for this instruction.

SetFrequency.instructions

Iterable for getting instructions from Schedule tree.

SetFrequency.name

Name of this instruction.

SetFrequency.operands

Return instruction operands.

SetFrequency.start_time

Relative begin time of this instruction.

SetFrequency.stop_time

Relative end time of this instruction.

SetFrequency.timeslots

Occupied time slots by this instruction.

Methods

SetFrequency.append(schedule[, name])

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

SetFrequency.assign_parameters(value_dict)

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

SetFrequency.ch_duration(*channels)

Return duration of the supplied channels in this Instruction.

SetFrequency.ch_start_time(*channels)

Return minimum start time for supplied channels.

SetFrequency.ch_stop_time(*channels)

Return maximum start time for supplied channels.

SetFrequency.draw([dt, style, filename, …])

Plot the instruction.

SetFrequency.flatten()

Return itself as already single instruction.

SetFrequency.insert(start_time, schedule[, name])

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

SetFrequency.shift(time[, name])

Return a new schedule shifted forward by time.