`dawsonia.typing`#

Note

is used as a sentinel value when a table’s position is not detected.

Module Contents#

Classes#

`Preproc`
`PreprocConfig`	Default values for preproc. Used in `dawsonia.image_preproc`
`Transforms`
`TransformsConfig`
`TableFormatYear`	Dictionary items specified under TOML section `[YEAR]`. Where YEAR is an string. It has a special meaning when `[default]` is used as YEAR.
`TableFormatFileVersion`	Dictionary items specified under TOML section `[version.XX]`, where XX is a string. For example:
`TableFormatFile`
`TableFormatMerged`	Dictionary items once default and a specific version are merged
`TableFormat`	Specific table format configuration corresponding to year. Some attributes are merged from `default` configuration (See `TableFormatMerged`).

Data#

`MarkArray`
`TimeUnits`
`PreprocMethods`
`BBoxTuple`
`ClusterLabel`
`TablePositions`
`TablePosArrays`
`TableSizes`
`TableSizesGeneric`
`TableRowIndex`
`Prediction`
`Probability`

API#

dawsonia.typing.MarkArray#: ‘Enum(…)’

dawsonia.typing.TimeUnits#: ‘Enum(…)’

dawsonia.typing.PreprocMethods#: ‘Enum(…)’

dawsonia.typing.BBoxTuple#: ‘NewType(…)’

dawsonia.typing.ClusterLabel#: ‘NewType(…)’

dawsonia.typing.TablePositions#: None

dawsonia.typing.TablePosArrays#: None

dawsonia.typing.TableSizes#: None

dawsonia.typing.TableSizesGeneric#: None

dawsonia.typing.TableRowIndex#: None

dawsonia.typing.Prediction#: None

dawsonia.typing.Probability#: None

class dawsonia.typing.Preproc[source]#

Bases: typing.TypedDict

table_modif: bool#: None

corr_rotate: bool#: None

row_idx_unit: str | dawsonia.typing.TimeUnits#: None

method: str | dawsonia.typing.PreprocMethods#: None

idx_tables_size_verify: list[int]#: None

class dawsonia.typing.PreprocConfig[source]#

Bases: typing.NamedTuple

Default values for preproc. Used in dawsonia.image_preproc

Parameters

table_modif: bool Allow modification of tables, for eg. remove leading columns or rows. See dawsonia.image_preproc.get_pos().

corr_rotate: bool Correct skewness of books by using the --page-middle value and rotating the pages in opposite directions. See dawsonia.image_preproc.corr_rotate()

row_idx_unit: TimeUnits Specifies the row index units (i.e. the leading column) so can be cast into datetime.time type.

idx_tables_size_verify: int Indices of tables to verify sizes

table_modif: bool#: True

corr_rotate: bool#: True

row_idx_unit: dawsonia.typing.TimeUnits#: None

method: dawsonia.typing.PreprocMethods#: None

idx_tables_size_verify: list[int]#: [0, 1]

class dawsonia.typing.Transforms[source]#

Bases: typing.TypedDict

rotate: int#: None

class dawsonia.typing.TransformsConfig[source]#

Bases: typing.NamedTuple

rotate: int#: 0

class dawsonia.typing.TableFormatYear[source]#

Bases: typing.TypedDict

Dictionary items specified under TOML section [YEAR]. Where YEAR is an string. It has a special meaning when [default] is used as YEAR.

Usage

… code-block::toml

[1942]
version = "0b"

The section may optionally contain its own preproc and transforms sections

… code-block::toml

[1942.preproc]
corr_rotate = false

[1942.transforms]
rotate = 90

Initialization

Initialize self. See help(type(self)) for accurate signature.

version: int | str#: None

preproc: dawsonia.typing.Preproc#: None

transforms: dawsonia.typing.Transforms#: None

class dawsonia.typing.TableFormatFileVersion[source]#

Bases: typing.TypedDict

Dictionary items specified under TOML section [version.XX], where XX is a string. For example:

Usage

… code-block::toml

[version.0b]
columns = [
  [
    "term_på_baro",
    "barom",
    "torra_term",
    "våta_term",
    "moln_slag_lägre",
    "moln_mängd_lägre",
    "moln_slag_medel",
    "moln_slag_högre"
  ],
  [
    "moln_het_sol_dimma_nederbörd_total",
    "vind_riktning",
    "vind_beaufort",
    "vind_m_sek",
    "sikt",
    "sjögang",
    "maximi_term",
    "minimi_term",
    "nederbörd_mängd",
    "nederbörd_slag"
  ]
]
name_idx = "tid"
rows = [10:30:00, 8, 14, 19, 21]
tables = [
  [5, 8],
  [5, 10],
  [3, 1],
  [4, 2],
  [4, 5]
]

Initialization

Initialize self. See help(type(self)) for accurate signature.

name_idx: str#: None

columns: tuple[str, ...]#: None

rows: dawsonia.typing.TableRowIndex#: None

tables: tuple[tuple[int, int], ...]#: None

preproc: typing_extensions.NotRequired[dawsonia.typing.Preproc]#: None

transforms: typing_extensions.NotRequired[dawsonia.typing.Transforms]#: None

class dawsonia.typing.TableFormatFile[source]#

Bases: typing.TypedDict

default: typing_extensions.Required[dawsonia.typing.TableFormatYear]#: None

version: typing_extensions.Required[dict[str, dawsonia.typing.TableFormatFileVersion]]#: None

class dawsonia.typing.TableFormatMerged[source]#

Bases: dawsonia.typing.TableFormatYear, dawsonia.typing.TableFormatFileVersion

Dictionary items once default and a specific version are merged

Initialization

Initialize self. See help(type(self)) for accurate signature.

class dawsonia.typing.TableFormat[source]#

Bases: typing.NamedTuple

Specific table format configuration corresponding to year. Some attributes are merged from default configuration (See TableFormatMerged).

name_idx: str#: None

columns: tuple[str, ...]#: None

rows: dawsonia.typing.TableRowIndex#: None

tables: tuple[tuple[int, int], ...]#: None

preproc: dawsonia.typing.PreprocConfig#: None

transforms: dawsonia.typing.TransformsConfig | None#: None

version: str#: None

station: str#: None

dawsonia.typing#

Module Contents#

Classes#

Data#

API#

Parameters

Usage

Usage

`dawsonia.typing`#