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

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

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

## Module Contents

### Classes

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

* - {py:obj}`SettingsSDA <elasticai.preprocessor.sda.sda.SettingsSDA>`
  - ```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA
    :summary:
    ```
* - {py:obj}`SpikeDetection <elasticai.preprocessor.sda.sda.SpikeDetection>`
  - ```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SpikeDetection
    :summary:
    ```
````

### Data

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

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

### API

`````{py:class} SettingsSDA
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA
```

````{py:attribute} mode_sda
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.mode_sda
:type: str
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.mode_sda
```

````

````{py:attribute} mode_thr
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.mode_thr
:type: str
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.mode_thr
```

````

````{py:attribute} mode_align
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.mode_align
:type: str
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.mode_align
```

````

````{py:attribute} dx_sda
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.dx_sda
:type: list
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.dx_sda
```

````

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

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.sampling_rate
```

````

````{py:attribute} t_frame_length
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.t_frame_length
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.t_frame_length
```

````

````{py:attribute} t_frame_start
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.t_frame_start
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.t_frame_start
```

````

````{py:attribute} dt_offset
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.dt_offset
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.dt_offset
```

````

````{py:attribute} thr_gain
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.thr_gain
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.thr_gain
```

````

````{py:property} get_integer_offset
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.get_integer_offset
:type: int

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.get_integer_offset
```

````

````{py:property} get_integer_offset_total
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.get_integer_offset_total
:type: int

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.get_integer_offset_total
```

````

````{py:property} get_integer_spike_frame
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.get_integer_spike_frame
:type: int

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.get_integer_spike_frame
```

````

````{py:property} get_integer_spike_start
:canonical: elasticai.preprocessor.sda.sda.SettingsSDA.get_integer_spike_start
:type: int

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SettingsSDA.get_integer_spike_start
```

````

`````

````{py:data} DefaultSettingsSDA
:canonical: elasticai.preprocessor.sda.sda.DefaultSettingsSDA
:value: >
   'SettingsSDA(...)'

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.DefaultSettingsSDA
```

````

`````{py:class} SpikeDetection(settings: elasticai.preprocessor.sda.sda.SettingsSDA)
:canonical: elasticai.preprocessor.sda.sda.SpikeDetection

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SpikeDetection
```

```{rubric} Initialization
```

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SpikeDetection.__init__
```

````{py:method} get_methods_sda() -> list
:canonical: elasticai.preprocessor.sda.sda.SpikeDetection.get_methods_sda

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SpikeDetection.get_methods_sda
```

````

````{py:method} apply_spike_detection(xraw: numpy.ndarray, **kwargs) -> numpy.ndarray
:canonical: elasticai.preprocessor.sda.sda.SpikeDetection.apply_spike_detection

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SpikeDetection.apply_spike_detection
```

````

````{py:method} get_spike_waveforms(xraw: numpy.ndarray, do_abs: bool, **kwargs) -> elasticai.preprocessor.framing.FrameWaveform
:canonical: elasticai.preprocessor.sda.sda.SpikeDetection.get_spike_waveforms

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SpikeDetection.get_spike_waveforms
```

````

````{py:method} get_spike_waveforms_from_positions(xraw: numpy.ndarray, xpos: numpy.ndarray, xoffset: int) -> elasticai.preprocessor.framing.FrameWaveform
:canonical: elasticai.preprocessor.sda.sda.SpikeDetection.get_spike_waveforms_from_positions

```{autodoc2-docstring} elasticai.preprocessor.sda.sda.SpikeDetection.get_spike_waveforms_from_positions
```

````

`````