---
title: Sin (v0.46)
description: API reference for qiskit.pulse.library.Sin in qiskit v0.46
source: https://eu-de.quantum.cloud.ibm.com/docs/en/api/qiskit/0.46/qiskit.pulse.library.Sin_class.rst
---

# qiskit.pulse.library.Sin

`qiskit.pulse.library.Sin(duration, amp, phase, freq=None, angle=0.0, name=None, limit_amplitude=None)`

[GitHub](https://github.com/qiskit/qiskit/tree/stable/0.46/qiskit/pulse/library/symbolic_pulses.py)

A sinusoidal pulse.

The envelope of the pulse is given by:

$$
f(x) = \text{A}\sin\left(2\pi\text{freq}x+\text{phase}\right)  ,  0 <= x < duration
$$

where $\text{A} = \text{amp} \times\exp\left(i\times\text{angle}\right)$.

**Parameters**

- **duration** ([*int*](https://docs.python.org/3/library/functions.html#int)  *|*[*ParameterExpression*](/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")) – Pulse length in terms of the sampling period dt.
- **amp** ([*float*](https://docs.python.org/3/library/functions.html#float)  *|*[*ParameterExpression*](/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")) – The magnitude of the amplitude of the sinusoidal wave. Wave range is \[-amp,\`amp\`].
- **phase** ([*float*](https://docs.python.org/3/library/functions.html#float)  *|*[*ParameterExpression*](/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")) – The phase of the sinusoidal wave (note that this is not equivalent to the angle of the complex amplitude)
- **freq** ([*ParameterExpression*](/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")  *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – The frequency of the sinusoidal wave, in terms of 1 over sampling period. If not provided defaults to a single cycle (i.e :math:’frac\{1}\{text\{duration}}’). The frequency is limited to the range $\left(0,0.5\right]$ (the Nyquist frequency).
- **angle** ([*ParameterExpression*](/docs/api/qiskit/0.46/qiskit.circuit.ParameterExpression "qiskit.circuit.parameterexpression.ParameterExpression")  *|*[*float*](https://docs.python.org/3/library/functions.html#float) *| None*) – The angle in radians of the complex phase factor uniformly scaling the pulse. Default value 0.
- **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str) *| None*) – Display name for this pulse envelope.
- **limit\_amplitude** ([*bool*](https://docs.python.org/3/library/functions.html#bool) *| None*) – If `True`, then limit the amplitude of the waveform to 1. The default is `True` and the amplitude is constrained to 1.

**Returns**

ScalableSymbolicPulse instance.

**Return type**

*ScalableSymbolicPulse*