# {py:mod}`dawsonia.label`

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

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

## Module Contents

### Functions

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

* - {py:obj}`command <dawsonia.label.command>`
  - ```{autodoc2-docstring} dawsonia.label.command
    :summary:
    ```
* - {py:obj}`labelling_gui <dawsonia.label.labelling_gui>`
  - ```{autodoc2-docstring} dawsonia.label.labelling_gui
    :summary:
    ```
* - {py:obj}`save_labelled_image <dawsonia.label.save_labelled_image>`
  - ```{autodoc2-docstring} dawsonia.label.save_labelled_image
    :summary:
    ```
* - {py:obj}`label_page <dawsonia.label.label_page>`
  - ```{autodoc2-docstring} dawsonia.label.label_page
    :summary:
    ```
* - {py:obj}`label_table <dawsonia.label.label_table>`
  - ```{autodoc2-docstring} dawsonia.label.label_table
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <dawsonia.label.logger>`
  - ```{autodoc2-docstring} dawsonia.label.logger
    :summary:
    ```
* - {py:obj}`app <dawsonia.label.app>`
  - ```{autodoc2-docstring} dawsonia.label.app
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: dawsonia.label.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} dawsonia.label.logger
```

````

````{py:data} app
:canonical: dawsonia.label.app
:value: >
   'Typer(...)'

```{autodoc2-docstring} dawsonia.label.app
```

````

````{py:function} command(path_file: pathlib.Path, first_page: typing.Annotated[int, typer.Option('-f', '--first-page')] = 0, last_page: typing.Annotated[int, typer.Option('-l', '--last-page')] = 0, page_middle: typing.Annotated[int, typer.Option('-m', '--page-middle', help='X coordinate of middle of page to help the rotation correction')] = -1, size_cell: tuple[float, float, float, float] = (1.0, 1.0, 1.0, 1.0), interactive: bool = True, table_fmt_dir: pathlib.Path = Path('table_formats'), output_path: pathlib.Path = Path('output', 'label'), config: pathlib.Path = typer.Option('dawsonia.toml', *config_cli_names, **config_kwargs))
:canonical: dawsonia.label.command

```{autodoc2-docstring} dawsonia.label.command
```
````

````{py:function} labelling_gui(output_path: pathlib.Path, key_name)
:canonical: dawsonia.label.labelling_gui

```{autodoc2-docstring} dawsonia.label.labelling_gui
```
````

````{py:function} save_labelled_image(entry1: tkinter.Entry, key_name: str, root: tkinter.Tk, output_path: pathlib.Path)
:canonical: dawsonia.label.save_labelled_image

```{autodoc2-docstring} dawsonia.label.save_labelled_image
```
````

````{py:function} label_page(book: dawsonia.io.Book, page_number: int, output_path: pathlib.Path, interactive: bool)
:canonical: dawsonia.label.label_page

```{autodoc2-docstring} dawsonia.label.label_page
```
````

````{py:function} label_table(book: dawsonia.io.Book, image_page: dawsonia.typing.NDArray, output_path: pathlib.Path, interactive: bool, page_number: int, table_nb: int, table_size: collections.abc.Sequence[int], table_pos_array: dawsonia.typing.NDArray)
:canonical: dawsonia.label.label_table

```{autodoc2-docstring} dawsonia.label.label_table
```
````