Skip to content

Commit

Permalink
qiskit.pulse.library.Square_fun.rst (#13007)
Browse files Browse the repository at this point in the history
(cherry picked from commit 6f48240)
  • Loading branch information
1ucian0 authored and mergify[bot] committed Aug 21, 2024
1 parent 3413861 commit 49af382
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions qiskit/pulse/library/symbolic_pulses.py
Original file line number Diff line number Diff line change
Expand Up @@ -1773,12 +1773,13 @@ def Square(
is the sign function with the convention :math:`\\text{sign}\\left(0\\right)=1`.
Args:
duration: Pulse length in terms of the sampling period `dt`.
amp: The magnitude of the amplitude of the square wave. Wave range is [-`amp`,`amp`].
duration: Pulse length in terms of the sampling period ``dt``.
amp: The magnitude of the amplitude of the square wave. Wave range is
:math:`\\left[-\\texttt{amp},\\texttt{amp}\\right]`.
phase: The phase of the square wave (note that this is not equivalent to the angle of
the complex amplitude).
freq: The frequency of the square wave, in terms of 1 over sampling period.
If not provided defaults to a single cycle (i.e :math:'\\frac{1}{\\text{duration}}').
If not provided defaults to a single cycle (i.e :math:`\\frac{1}{\\text{duration}}`).
The frequency is limited to the range :math:`\\left(0,0.5\\right]` (the Nyquist frequency).
angle: The angle in radians of the complex phase factor uniformly
scaling the pulse. Default value 0.
Expand Down

0 comments on commit 49af382

Please sign in to comment.