# {py:mod}`elasticai.preprocessor.windower.window`

```{py:module} elasticai.preprocessor.windower.window
```

```{autodoc2-docstring} elasticai.preprocessor.windower.window
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`SettingsWindow <elasticai.preprocessor.windower.window.SettingsWindow>`
  - ```{autodoc2-docstring} elasticai.preprocessor.windower.window.SettingsWindow
    :summary:
    ```
* - {py:obj}`WindowSequencer <elasticai.preprocessor.windower.window.WindowSequencer>`
  - ```{autodoc2-docstring} elasticai.preprocessor.windower.window.WindowSequencer
    :summary:
    ```
````

### Functions

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

* - {py:obj}`transformation_window_method <elasticai.preprocessor.windower.window.transformation_window_method>`
  - ```{autodoc2-docstring} elasticai.preprocessor.windower.window.transformation_window_method
    :summary:
    ```
````

### Data

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

* - {py:obj}`DefaultSettingsWindow <elasticai.preprocessor.windower.window.DefaultSettingsWindow>`
  - ```{autodoc2-docstring} elasticai.preprocessor.windower.window.DefaultSettingsWindow
    :summary:
    ```
````

### API

````{py:function} transformation_window_method(window_size: int, method: str = 'hamming') -> numpy.ndarray
:canonical: elasticai.preprocessor.windower.window.transformation_window_method

```{autodoc2-docstring} elasticai.preprocessor.windower.window.transformation_window_method
```
````

`````{py:class} SettingsWindow
:canonical: elasticai.preprocessor.windower.window.SettingsWindow

```{autodoc2-docstring} elasticai.preprocessor.windower.window.SettingsWindow
```

````{py:attribute} sampling_rate
:canonical: elasticai.preprocessor.windower.window.SettingsWindow.sampling_rate
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.windower.window.SettingsWindow.sampling_rate
```

````

````{py:attribute} window_sec
:canonical: elasticai.preprocessor.windower.window.SettingsWindow.window_sec
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.windower.window.SettingsWindow.window_sec
```

````

````{py:attribute} overlap_sec
:canonical: elasticai.preprocessor.windower.window.SettingsWindow.overlap_sec
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.windower.window.SettingsWindow.overlap_sec
```

````

````{py:property} window_length
:canonical: elasticai.preprocessor.windower.window.SettingsWindow.window_length
:type: int

```{autodoc2-docstring} elasticai.preprocessor.windower.window.SettingsWindow.window_length
```

````

````{py:property} overlap_length
:canonical: elasticai.preprocessor.windower.window.SettingsWindow.overlap_length
:type: int

```{autodoc2-docstring} elasticai.preprocessor.windower.window.SettingsWindow.overlap_length
```

````

`````

````{py:data} DefaultSettingsWindow
:canonical: elasticai.preprocessor.windower.window.DefaultSettingsWindow
:value: >
   'SettingsWindow(...)'

```{autodoc2-docstring} elasticai.preprocessor.windower.window.DefaultSettingsWindow
```

````

`````{py:class} WindowSequencer(settings: elasticai.preprocessor.windower.window.SettingsWindow)
:canonical: elasticai.preprocessor.windower.window.WindowSequencer

```{autodoc2-docstring} elasticai.preprocessor.windower.window.WindowSequencer
```

```{rubric} Initialization
```

```{autodoc2-docstring} elasticai.preprocessor.windower.window.WindowSequencer.__init__
```

````{py:method} sequence(signal: numpy.ndarray) -> numpy.ndarray
:canonical: elasticai.preprocessor.windower.window.WindowSequencer.sequence

```{autodoc2-docstring} elasticai.preprocessor.windower.window.WindowSequencer.sequence
```

````

````{py:method} slide(signal: numpy.ndarray) -> numpy.ndarray
:canonical: elasticai.preprocessor.windower.window.WindowSequencer.slide

```{autodoc2-docstring} elasticai.preprocessor.windower.window.WindowSequencer.slide
```

````

````{py:method} window_event_detected(signal: numpy.ndarray, thr: float, pre_time: float, do_abs: bool = False) -> numpy.ndarray
:canonical: elasticai.preprocessor.windower.window.WindowSequencer.window_event_detected

```{autodoc2-docstring} elasticai.preprocessor.windower.window.WindowSequencer.window_event_detected
```

````

`````