# {py:mod}`dawsonia.typing`

```{py:module} dawsonia.typing
```

```{autodoc2-docstring} dawsonia.typing
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`Preproc <dawsonia.typing.Preproc>`
  -
* - {py:obj}`PreprocConfig <dawsonia.typing.PreprocConfig>`
  - ```{autodoc2-docstring} dawsonia.typing.PreprocConfig
    :summary:
    ```
* - {py:obj}`Transforms <dawsonia.typing.Transforms>`
  -
* - {py:obj}`TransformsConfig <dawsonia.typing.TransformsConfig>`
  - ```{autodoc2-docstring} dawsonia.typing.TransformsConfig
    :summary:
    ```
* - {py:obj}`TableFormatYear <dawsonia.typing.TableFormatYear>`
  - ```{autodoc2-docstring} dawsonia.typing.TableFormatYear
    :summary:
    ```
* - {py:obj}`TableFormatFileVersion <dawsonia.typing.TableFormatFileVersion>`
  - ```{autodoc2-docstring} dawsonia.typing.TableFormatFileVersion
    :summary:
    ```
* - {py:obj}`TableFormatFile <dawsonia.typing.TableFormatFile>`
  -
* - {py:obj}`TableFormatMerged <dawsonia.typing.TableFormatMerged>`
  - ```{autodoc2-docstring} dawsonia.typing.TableFormatMerged
    :summary:
    ```
* - {py:obj}`TableFormat <dawsonia.typing.TableFormat>`
  - ```{autodoc2-docstring} dawsonia.typing.TableFormat
    :summary:
    ```
````

### Data

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

* - {py:obj}`MarkArray <dawsonia.typing.MarkArray>`
  - ```{autodoc2-docstring} dawsonia.typing.MarkArray
    :summary:
    ```
* - {py:obj}`TimeUnits <dawsonia.typing.TimeUnits>`
  - ```{autodoc2-docstring} dawsonia.typing.TimeUnits
    :summary:
    ```
* - {py:obj}`PreprocMethods <dawsonia.typing.PreprocMethods>`
  - ```{autodoc2-docstring} dawsonia.typing.PreprocMethods
    :summary:
    ```
* - {py:obj}`BBoxTuple <dawsonia.typing.BBoxTuple>`
  - ```{autodoc2-docstring} dawsonia.typing.BBoxTuple
    :summary:
    ```
* - {py:obj}`ClusterLabel <dawsonia.typing.ClusterLabel>`
  - ```{autodoc2-docstring} dawsonia.typing.ClusterLabel
    :summary:
    ```
* - {py:obj}`TablePositions <dawsonia.typing.TablePositions>`
  - ```{autodoc2-docstring} dawsonia.typing.TablePositions
    :summary:
    ```
* - {py:obj}`TablePosArrays <dawsonia.typing.TablePosArrays>`
  - ```{autodoc2-docstring} dawsonia.typing.TablePosArrays
    :summary:
    ```
* - {py:obj}`TableSizes <dawsonia.typing.TableSizes>`
  - ```{autodoc2-docstring} dawsonia.typing.TableSizes
    :summary:
    ```
* - {py:obj}`TableSizesGeneric <dawsonia.typing.TableSizesGeneric>`
  - ```{autodoc2-docstring} dawsonia.typing.TableSizesGeneric
    :summary:
    ```
* - {py:obj}`TableRowIndex <dawsonia.typing.TableRowIndex>`
  - ```{autodoc2-docstring} dawsonia.typing.TableRowIndex
    :summary:
    ```
* - {py:obj}`Prediction <dawsonia.typing.Prediction>`
  - ```{autodoc2-docstring} dawsonia.typing.Prediction
    :summary:
    ```
* - {py:obj}`Probability <dawsonia.typing.Probability>`
  - ```{autodoc2-docstring} dawsonia.typing.Probability
    :summary:
    ```
````

### API

````{py:data} MarkArray
:canonical: dawsonia.typing.MarkArray
:value: >
   'Enum(...)'

```{autodoc2-docstring} dawsonia.typing.MarkArray
```

````

````{py:data} TimeUnits
:canonical: dawsonia.typing.TimeUnits
:value: >
   'Enum(...)'

```{autodoc2-docstring} dawsonia.typing.TimeUnits
```

````

````{py:data} PreprocMethods
:canonical: dawsonia.typing.PreprocMethods
:value: >
   'Enum(...)'

```{autodoc2-docstring} dawsonia.typing.PreprocMethods
```

````

````{py:data} BBoxTuple
:canonical: dawsonia.typing.BBoxTuple
:value: >
   'NewType(...)'

```{autodoc2-docstring} dawsonia.typing.BBoxTuple
```

````

````{py:data} ClusterLabel
:canonical: dawsonia.typing.ClusterLabel
:value: >
   'NewType(...)'

```{autodoc2-docstring} dawsonia.typing.ClusterLabel
```

````

````{py:data} TablePositions
:canonical: dawsonia.typing.TablePositions
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TablePositions
```

````

````{py:data} TablePosArrays
:canonical: dawsonia.typing.TablePosArrays
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TablePosArrays
```

````

````{py:data} TableSizes
:canonical: dawsonia.typing.TableSizes
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableSizes
```

````

````{py:data} TableSizesGeneric
:canonical: dawsonia.typing.TableSizesGeneric
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableSizesGeneric
```

````

````{py:data} TableRowIndex
:canonical: dawsonia.typing.TableRowIndex
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableRowIndex
```

````

````{py:data} Prediction
:canonical: dawsonia.typing.Prediction
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.Prediction
```

````

````{py:data} Probability
:canonical: dawsonia.typing.Probability
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.Probability
```

````

`````{py:class} Preproc()
:canonical: dawsonia.typing.Preproc

Bases: {py:obj}`typing.TypedDict`

````{py:attribute} table_modif
:canonical: dawsonia.typing.Preproc.table_modif
:type: bool
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.Preproc.table_modif
```

````

````{py:attribute} corr_rotate
:canonical: dawsonia.typing.Preproc.corr_rotate
:type: bool
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.Preproc.corr_rotate
```

````

````{py:attribute} row_idx_unit
:canonical: dawsonia.typing.Preproc.row_idx_unit
:type: str | dawsonia.typing.TimeUnits
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.Preproc.row_idx_unit
```

````

````{py:attribute} method
:canonical: dawsonia.typing.Preproc.method
:type: str | dawsonia.typing.PreprocMethods
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.Preproc.method
```

````

````{py:attribute} idx_tables_size_verify
:canonical: dawsonia.typing.Preproc.idx_tables_size_verify
:type: list[int]
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.Preproc.idx_tables_size_verify
```

````

`````

`````{py:class} PreprocConfig
:canonical: dawsonia.typing.PreprocConfig

Bases: {py:obj}`typing.NamedTuple`

```{autodoc2-docstring} dawsonia.typing.PreprocConfig
```

````{py:attribute} table_modif
:canonical: dawsonia.typing.PreprocConfig.table_modif
:type: bool
:value: >
   True

```{autodoc2-docstring} dawsonia.typing.PreprocConfig.table_modif
```

````

````{py:attribute} corr_rotate
:canonical: dawsonia.typing.PreprocConfig.corr_rotate
:type: bool
:value: >
   True

```{autodoc2-docstring} dawsonia.typing.PreprocConfig.corr_rotate
```

````

````{py:attribute} row_idx_unit
:canonical: dawsonia.typing.PreprocConfig.row_idx_unit
:type: dawsonia.typing.TimeUnits
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.PreprocConfig.row_idx_unit
```

````

````{py:attribute} method
:canonical: dawsonia.typing.PreprocConfig.method
:type: dawsonia.typing.PreprocMethods
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.PreprocConfig.method
```

````

````{py:attribute} idx_tables_size_verify
:canonical: dawsonia.typing.PreprocConfig.idx_tables_size_verify
:type: list[int]
:value: >
   [0, 1]

```{autodoc2-docstring} dawsonia.typing.PreprocConfig.idx_tables_size_verify
```

````

`````

`````{py:class} Transforms()
:canonical: dawsonia.typing.Transforms

Bases: {py:obj}`typing.TypedDict`

````{py:attribute} rotate
:canonical: dawsonia.typing.Transforms.rotate
:type: int
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.Transforms.rotate
```

````

`````

`````{py:class} TransformsConfig
:canonical: dawsonia.typing.TransformsConfig

Bases: {py:obj}`typing.NamedTuple`

```{autodoc2-docstring} dawsonia.typing.TransformsConfig
```

````{py:attribute} rotate
:canonical: dawsonia.typing.TransformsConfig.rotate
:type: int
:value: >
   0

```{autodoc2-docstring} dawsonia.typing.TransformsConfig.rotate
```

````

`````

`````{py:class} TableFormatYear()
:canonical: dawsonia.typing.TableFormatYear

Bases: {py:obj}`typing.TypedDict`

```{autodoc2-docstring} dawsonia.typing.TableFormatYear
```

```{rubric} Initialization
```

```{autodoc2-docstring} dawsonia.typing.TableFormatYear.__init__
```

````{py:attribute} version
:canonical: dawsonia.typing.TableFormatYear.version
:type: int | str
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatYear.version
```

````

````{py:attribute} preproc
:canonical: dawsonia.typing.TableFormatYear.preproc
:type: dawsonia.typing.Preproc
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatYear.preproc
```

````

````{py:attribute} transforms
:canonical: dawsonia.typing.TableFormatYear.transforms
:type: dawsonia.typing.Transforms
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatYear.transforms
```

````

`````

`````{py:class} TableFormatFileVersion()
:canonical: dawsonia.typing.TableFormatFileVersion

Bases: {py:obj}`typing.TypedDict`

```{autodoc2-docstring} dawsonia.typing.TableFormatFileVersion
```

```{rubric} Initialization
```

```{autodoc2-docstring} dawsonia.typing.TableFormatFileVersion.__init__
```

````{py:attribute} name_idx
:canonical: dawsonia.typing.TableFormatFileVersion.name_idx
:type: str
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatFileVersion.name_idx
```

````

````{py:attribute} columns
:canonical: dawsonia.typing.TableFormatFileVersion.columns
:type: tuple[str, ...]
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatFileVersion.columns
```

````

````{py:attribute} rows
:canonical: dawsonia.typing.TableFormatFileVersion.rows
:type: dawsonia.typing.TableRowIndex
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatFileVersion.rows
```

````

````{py:attribute} tables
:canonical: dawsonia.typing.TableFormatFileVersion.tables
:type: tuple[tuple[int, int], ...]
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatFileVersion.tables
```

````

````{py:attribute} preproc
:canonical: dawsonia.typing.TableFormatFileVersion.preproc
:type: typing_extensions.NotRequired[dawsonia.typing.Preproc]
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatFileVersion.preproc
```

````

````{py:attribute} transforms
:canonical: dawsonia.typing.TableFormatFileVersion.transforms
:type: typing_extensions.NotRequired[dawsonia.typing.Transforms]
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatFileVersion.transforms
```

````

`````

`````{py:class} TableFormatFile()
:canonical: dawsonia.typing.TableFormatFile

Bases: {py:obj}`typing.TypedDict`

````{py:attribute} default
:canonical: dawsonia.typing.TableFormatFile.default
:type: typing_extensions.Required[dawsonia.typing.TableFormatYear]
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatFile.default
```

````

````{py:attribute} version
:canonical: dawsonia.typing.TableFormatFile.version
:type: typing_extensions.Required[dict[str, dawsonia.typing.TableFormatFileVersion]]
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormatFile.version
```

````

`````

````{py:class} TableFormatMerged()
:canonical: dawsonia.typing.TableFormatMerged

Bases: {py:obj}`dawsonia.typing.TableFormatYear`, {py:obj}`dawsonia.typing.TableFormatFileVersion`

```{autodoc2-docstring} dawsonia.typing.TableFormatMerged
```

```{rubric} Initialization
```

```{autodoc2-docstring} dawsonia.typing.TableFormatMerged.__init__
```

````

`````{py:class} TableFormat
:canonical: dawsonia.typing.TableFormat

Bases: {py:obj}`typing.NamedTuple`

```{autodoc2-docstring} dawsonia.typing.TableFormat
```

````{py:attribute} name_idx
:canonical: dawsonia.typing.TableFormat.name_idx
:type: str
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormat.name_idx
```

````

````{py:attribute} columns
:canonical: dawsonia.typing.TableFormat.columns
:type: tuple[str, ...]
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormat.columns
```

````

````{py:attribute} rows
:canonical: dawsonia.typing.TableFormat.rows
:type: dawsonia.typing.TableRowIndex
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormat.rows
```

````

````{py:attribute} tables
:canonical: dawsonia.typing.TableFormat.tables
:type: tuple[tuple[int, int], ...]
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormat.tables
```

````

````{py:attribute} preproc
:canonical: dawsonia.typing.TableFormat.preproc
:type: dawsonia.typing.PreprocConfig
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormat.preproc
```

````

````{py:attribute} transforms
:canonical: dawsonia.typing.TableFormat.transforms
:type: dawsonia.typing.TransformsConfig | None
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormat.transforms
```

````

````{py:attribute} version
:canonical: dawsonia.typing.TableFormat.version
:type: str
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormat.version
```

````

````{py:attribute} station
:canonical: dawsonia.typing.TableFormat.station
:type: str
:value: >
   None

```{autodoc2-docstring} dawsonia.typing.TableFormat.station
```

````

`````