# {py:mod}`elasticai.preprocessor.downsampling.downsampling`

```{py:module} elasticai.preprocessor.downsampling.downsampling
```

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`SettingsDownSampling <elasticai.preprocessor.downsampling.downsampling.SettingsDownSampling>`
  - ```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.SettingsDownSampling
    :summary:
    ```
* - {py:obj}`DownSampling <elasticai.preprocessor.downsampling.downsampling.DownSampling>`
  - ```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DownSampling
    :summary:
    ```
````

### Data

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

* - {py:obj}`DefaultSettingsDownSampling <elasticai.preprocessor.downsampling.downsampling.DefaultSettingsDownSampling>`
  - ```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DefaultSettingsDownSampling
    :summary:
    ```
````

### API

`````{py:class} SettingsDownSampling
:canonical: elasticai.preprocessor.downsampling.downsampling.SettingsDownSampling

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.SettingsDownSampling
```

````{py:attribute} sampling_rate
:canonical: elasticai.preprocessor.downsampling.downsampling.SettingsDownSampling.sampling_rate
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.SettingsDownSampling.sampling_rate
```

````

````{py:attribute} dsr
:canonical: elasticai.preprocessor.downsampling.downsampling.SettingsDownSampling.dsr
:type: int
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.SettingsDownSampling.dsr
```

````

`````

````{py:data} DefaultSettingsDownSampling
:canonical: elasticai.preprocessor.downsampling.downsampling.DefaultSettingsDownSampling
:value: >
   'SettingsDownSampling(...)'

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DefaultSettingsDownSampling
```

````

`````{py:class} DownSampling(settings: elasticai.preprocessor.downsampling.downsampling.SettingsDownSampling)
:canonical: elasticai.preprocessor.downsampling.downsampling.DownSampling

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DownSampling
```

```{rubric} Initialization
```

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DownSampling.__init__
```

````{py:property} sampling_rate_out
:canonical: elasticai.preprocessor.downsampling.downsampling.DownSampling.sampling_rate_out
:type: float

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DownSampling.sampling_rate_out
```

````

````{py:method} do_subsampling(data: numpy.ndarray, augment: bool = False) -> numpy.ndarray
:canonical: elasticai.preprocessor.downsampling.downsampling.DownSampling.do_subsampling

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DownSampling.do_subsampling
```

````

````{py:method} create_design(target: str, bitwidth: int, id: str, path2save: pathlib.Path, signed: bool = True) -> None
:canonical: elasticai.preprocessor.downsampling.downsampling.DownSampling.create_design

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DownSampling.create_design
```

````

````{py:method} do_simple(uin: numpy.ndarray) -> numpy.ndarray
:canonical: elasticai.preprocessor.downsampling.downsampling.DownSampling.do_simple

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DownSampling.do_simple
```

````

````{py:method} do_cic(uin: numpy.ndarray, num_stages: int = 5) -> numpy.ndarray
:canonical: elasticai.preprocessor.downsampling.downsampling.DownSampling.do_cic

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DownSampling.do_cic
```

````

````{py:method} do_decimation_polyphase(uin: numpy.ndarray, take_first_order: bool) -> numpy.ndarray
:canonical: elasticai.preprocessor.downsampling.downsampling.DownSampling.do_decimation_polyphase

```{autodoc2-docstring} elasticai.preprocessor.downsampling.downsampling.DownSampling.do_decimation_polyphase
```

````

`````