---
title: ShiftFrequency (v1.0)
description: API reference for qiskit.pulse.instructions.ShiftFrequency in qiskit v1.0
source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit/1.0/qiskit.pulse.instructions.ShiftFrequency
---

# ShiftFrequency

*class* `qiskit.pulse.instructions.ShiftFrequency(frequency, channel, name=None)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/frequency.py#L85-L132)

Bases: [`Instruction`](/docs/api/qiskit/1.0/pulse#qiskit.pulse.instructions.Instruction "qiskit.pulse.instructions.instruction.Instruction")

Shift the channel frequency away from the current frequency.

Creates a new shift frequency instruction.

**Parameters**

- **frequency** ([*float*](https://docs.python.org/3/library/functions.html#float)  *|*[*ParameterExpression*](/docs/api/qiskit/1.0/qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")) – Frequency shift of the channel in Hz.
- **channel** (*PulseChannel*) – The channel this instruction operates on.
- **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Name of this set channel frequency instruction.

## Attributes

### channel

Return the [`Channel`](/docs/api/qiskit/1.0/pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel") that this instruction is scheduled on.

### channels

Returns the channels that this schedule uses.

### duration

Duration of this instruction.

### frequency

Frequency shift from the set frequency.

### id

Unique identifier for this instruction.

### instructions

Iterable for getting instructions from Schedule tree.

### name

Name of this instruction.

### operands

Return instruction operands.

### parameters

Parameters which determine the instruction behavior.

### start\_time

Relative begin time of this instruction.

### stop\_time

Relative end time of this instruction.

## Methods

### append

`append(schedule, name=None)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py#L185-L198)

Return a new [`Schedule`](/docs/api/qiskit/1.0/qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted at the maximum time over all channels shared between `self` and `schedule`.

**Parameters**

- **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to be appended
- **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Name of the new schedule. Defaults to name of self

**Returns**

A new schedule with `schedule` a this instruction at t=0.

**Return type**

[Schedule](/docs/api/qiskit/1.0/qiskit.pulse.Schedule "qiskit.pulse.Schedule")

### ch\_duration

`ch_duration(*channels)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py#L112-L118)

Return duration of the supplied channels in this Instruction.

**Parameters**

**\*channels** ([*Channel*](/docs/api/qiskit/1.0/pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Supplied channels

**Return type**

[int](https://docs.python.org/3/library/functions.html#int)

### ch\_start\_time

`ch_start_time(*channels)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py#L120-L127)

Return minimum start time for supplied channels.

**Parameters**

**\*channels** ([*Channel*](/docs/api/qiskit/1.0/pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Supplied channels

**Return type**

[int](https://docs.python.org/3/library/functions.html#int)

### ch\_stop\_time

`ch_stop_time(*channels)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py#L129-L137)

Return maximum start time for supplied channels.

**Parameters**

**\*channels** ([*Channel*](/docs/api/qiskit/1.0/pulse#qiskit.pulse.channels.Channel "qiskit.pulse.channels.Channel")) – Supplied channels

**Return type**

[int](https://docs.python.org/3/library/functions.html#int)

### insert

`insert(start_time, schedule, name=None)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py#L167-L183)

Return a new [`Schedule`](/docs/api/qiskit/1.0/qiskit.pulse.Schedule "qiskit.pulse.Schedule") with `schedule` inserted within `self` at `start_time`.

**Parameters**

- **start\_time** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Time to insert the schedule schedule
- **schedule** (*Union\['Schedule', 'Instruction']*) – Schedule or instruction to insert
- **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Name of the new schedule. Defaults to name of self

**Returns**

A new schedule with `schedule` inserted with this instruction at t=0.

**Return type**

[Schedule](/docs/api/qiskit/1.0/qiskit.pulse.Schedule "qiskit.pulse.Schedule")

### is\_parameterized

`is_parameterized()`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py#L219-L221)

Return True iff the instruction is parameterized.

**Return type**

[bool](https://docs.python.org/3/library/functions.html#bool)

### shift

`shift(time, name=None)`

[GitHub](https://github.com/Qiskit/qiskit/tree/stable/1.0/qiskit/pulse/instructions/instruction.py#L151-L165)

Return a new schedule shifted forward by time.

**Parameters**

- **time** ([*int*](https://docs.python.org/3/library/functions.html#int)) – Time to shift by
- **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Name of the new schedule. Defaults to name of self

**Returns**

The shifted schedule.

**Return type**

[Schedule](/docs/api/qiskit/1.0/qiskit.pulse.Schedule "qiskit.pulse.Schedule")