# {py:mod}`qcheff.utils.pulses`

```{py:module} qcheff.utils.pulses
```

```{autodoc2-docstring} qcheff.utils.pulses
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`ControlPulse <qcheff.utils.pulses.ControlPulse>`
  - ```{autodoc2-docstring} qcheff.utils.pulses.ControlPulse
    :summary:
    ```
* - {py:obj}`FourierPulse <qcheff.utils.pulses.FourierPulse>`
  - ```{autodoc2-docstring} qcheff.utils.pulses.FourierPulse
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`cos_ramp <qcheff.utils.pulses.cos_ramp>`
  - ```{autodoc2-docstring} qcheff.utils.pulses.cos_ramp
    :summary:
    ```
````

### API

````{py:function} cos_ramp(t, a=0.2)
:canonical: qcheff.utils.pulses.cos_ramp

```{autodoc2-docstring} qcheff.utils.pulses.cos_ramp
```
````

`````{py:class} ControlPulse
:canonical: qcheff.utils.pulses.ControlPulse

```{autodoc2-docstring} qcheff.utils.pulses.ControlPulse
```

````{py:attribute} coeffs
:canonical: qcheff.utils.pulses.ControlPulse.coeffs
:type: list[float]
:value: >
   None

```{autodoc2-docstring} qcheff.utils.pulses.ControlPulse.coeffs
```

````

````{py:attribute} basis_funcs
:canonical: qcheff.utils.pulses.ControlPulse.basis_funcs
:type: list[collections.abc.Callable[[float], float]]
:value: >
   None

```{autodoc2-docstring} qcheff.utils.pulses.ControlPulse.basis_funcs
```

````

````{py:attribute} frequency
:canonical: qcheff.utils.pulses.ControlPulse.frequency
:type: float
:value: >
   1.0

```{autodoc2-docstring} qcheff.utils.pulses.ControlPulse.frequency
```

````

````{py:attribute} phase
:canonical: qcheff.utils.pulses.ControlPulse.phase
:type: float
:value: >
   0.0

```{autodoc2-docstring} qcheff.utils.pulses.ControlPulse.phase
```

````

````{py:attribute} amplitude
:canonical: qcheff.utils.pulses.ControlPulse.amplitude
:type: float
:value: >
   1.0

```{autodoc2-docstring} qcheff.utils.pulses.ControlPulse.amplitude
```

````

````{py:attribute} name
:canonical: qcheff.utils.pulses.ControlPulse.name
:type: dataclasses.InitVar[str | None]
:value: >
   None

```{autodoc2-docstring} qcheff.utils.pulses.ControlPulse.name
```

````

````{py:method} envelope(tlist)
:canonical: qcheff.utils.pulses.ControlPulse.envelope

```{autodoc2-docstring} qcheff.utils.pulses.ControlPulse.envelope
```

````

`````

`````{py:class} FourierPulse(coeffs, gate_time, ramp_ratio=0.2, backend='cpu', **kwargs)
:canonical: qcheff.utils.pulses.FourierPulse

Bases: {py:obj}`qcheff.utils.pulses.ControlPulse`

```{autodoc2-docstring} qcheff.utils.pulses.FourierPulse
```

```{rubric} Initialization
```

```{autodoc2-docstring} qcheff.utils.pulses.FourierPulse.__init__
```

````{py:method} envelope(tlist)
:canonical: qcheff.utils.pulses.FourierPulse.envelope

```{autodoc2-docstring} qcheff.utils.pulses.FourierPulse.envelope
```

````

`````