# {py:mod}`elasticai.preprocessor.framing.frame_generator`

```{py:module} elasticai.preprocessor.framing.frame_generator
```

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`FrameWaveform <elasticai.preprocessor.framing.frame_generator.FrameWaveform>`
  - ```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameWaveform
    :summary:
    ```
* - {py:obj}`SettingsFrame <elasticai.preprocessor.framing.frame_generator.SettingsFrame>`
  - ```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame
    :summary:
    ```
* - {py:obj}`FrameGenerator <elasticai.preprocessor.framing.frame_generator.FrameGenerator>`
  - ```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameGenerator
    :summary:
    ```
````

### Data

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

* - {py:obj}`DefaultSettingsFrame <elasticai.preprocessor.framing.frame_generator.DefaultSettingsFrame>`
  - ```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.DefaultSettingsFrame
    :summary:
    ```
````

### API

`````{py:class} FrameWaveform
:canonical: elasticai.preprocessor.framing.frame_generator.FrameWaveform

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameWaveform
```

````{py:attribute} waveform
:canonical: elasticai.preprocessor.framing.frame_generator.FrameWaveform.waveform
:type: numpy.ndarray
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameWaveform.waveform
```

````

````{py:attribute} xpos
:canonical: elasticai.preprocessor.framing.frame_generator.FrameWaveform.xpos
:type: numpy.ndarray
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameWaveform.xpos
```

````

````{py:attribute} label
:canonical: elasticai.preprocessor.framing.frame_generator.FrameWaveform.label
:type: numpy.ndarray
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameWaveform.label
```

````

````{py:attribute} sampling_rate
:canonical: elasticai.preprocessor.framing.frame_generator.FrameWaveform.sampling_rate
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameWaveform.sampling_rate
```

````

````{py:property} length
:canonical: elasticai.preprocessor.framing.frame_generator.FrameWaveform.length
:type: int

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameWaveform.length
```

````

````{py:property} num_samples
:canonical: elasticai.preprocessor.framing.frame_generator.FrameWaveform.num_samples
:type: int

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameWaveform.num_samples
```

````

````{py:property} is_data_labeled
:canonical: elasticai.preprocessor.framing.frame_generator.FrameWaveform.is_data_labeled
:type: bool

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameWaveform.is_data_labeled
```

````

`````

`````{py:class} SettingsFrame
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame
```

````{py:attribute} mode_align
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.mode_align
:type: str
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.mode_align
```

````

````{py:attribute} mode_thr
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.mode_thr
:type: str
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.mode_thr
```

````

````{py:attribute} sampling_rate
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.sampling_rate
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.sampling_rate
```

````

````{py:attribute} window_sec
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.window_sec
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.window_sec
```

````

````{py:attribute} offset_sec
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.offset_sec
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.offset_sec
```

````

````{py:attribute} align_sec
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.align_sec
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.align_sec
```

````

````{py:attribute} thr_gain
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.thr_gain
:type: float
:value: >
   None

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.thr_gain
```

````

````{py:property} length_frame_int
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.length_frame_int
:type: int

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.length_frame_int
```

````

````{py:property} length_align_position
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.length_align_position
:type: int

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.length_align_position
```

````

````{py:property} length_offset_int
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.length_offset_int
:type: int

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.length_offset_int
```

````

````{py:property} length_total_frame
:canonical: elasticai.preprocessor.framing.frame_generator.SettingsFrame.length_total_frame
:type: int

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.SettingsFrame.length_total_frame
```

````

`````

````{py:data} DefaultSettingsFrame
:canonical: elasticai.preprocessor.framing.frame_generator.DefaultSettingsFrame
:value: >
   'SettingsFrame(...)'

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.DefaultSettingsFrame
```

````

`````{py:class} FrameGenerator(settings: elasticai.preprocessor.framing.frame_generator.SettingsFrame)
:canonical: elasticai.preprocessor.framing.frame_generator.FrameGenerator

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameGenerator
```

```{rubric} Initialization
```

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameGenerator.__init__
```

````{py:method} get_methods_frame_aligning() -> list
:canonical: elasticai.preprocessor.framing.frame_generator.FrameGenerator.get_methods_frame_aligning

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameGenerator.get_methods_frame_aligning
```

````

````{py:method} get_aligning_position(frame_in: numpy.ndarray) -> int
:canonical: elasticai.preprocessor.framing.frame_generator.FrameGenerator.get_aligning_position

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameGenerator.get_aligning_position
```

````

````{py:method} get_threshold(xin: numpy.ndarray, do_abs: bool = False, **kwargs) -> numpy.ndarray
:canonical: elasticai.preprocessor.framing.frame_generator.FrameGenerator.get_threshold

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameGenerator.get_threshold
```

````

````{py:method} get_threshold_position(xin: numpy.ndarray, do_abs: bool = False, **kwargs) -> numpy.ndarray
:canonical: elasticai.preprocessor.framing.frame_generator.FrameGenerator.get_threshold_position

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameGenerator.get_threshold_position
```

````

````{py:method} frame_generation(xraw: numpy.ndarray, xsda: numpy.ndarray, do_abs: bool = False, **kwargs) -> elasticai.preprocessor.framing.frame_generator.FrameWaveform
:canonical: elasticai.preprocessor.framing.frame_generator.FrameGenerator.frame_generation

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameGenerator.frame_generation
```

````

````{py:method} frame_generation_with_position(xraw: numpy.ndarray, xpos: numpy.ndarray, xoffset: int) -> elasticai.preprocessor.framing.frame_generator.FrameWaveform
:canonical: elasticai.preprocessor.framing.frame_generator.FrameGenerator.frame_generation_with_position

```{autodoc2-docstring} elasticai.preprocessor.framing.frame_generator.FrameGenerator.frame_generation_with_position
```

````

`````