# {py:mod}`dawsonia.io._book`

```{py:module} dawsonia.io._book
```

```{autodoc2-docstring} dawsonia.io._book
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`Book <dawsonia.io._book.Book>`
  - ```{autodoc2-docstring} dawsonia.io._book.Book
    :summary:
    ```
````

### Functions

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

* - {py:obj}`read_specific_table_format <dawsonia.io._book.read_specific_table_format>`
  - ```{autodoc2-docstring} dawsonia.io._book.read_specific_table_format
    :summary:
    ```
````

### Data

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

* - {py:obj}`logger <dawsonia.io._book.logger>`
  - ```{autodoc2-docstring} dawsonia.io._book.logger
    :summary:
    ```
* - {py:obj}`ZarrGroup <dawsonia.io._book.ZarrGroup>`
  - ```{autodoc2-docstring} dawsonia.io._book.ZarrGroup
    :summary:
    ```
````

### API

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

```{autodoc2-docstring} dawsonia.io._book.logger
```

````

````{py:data} ZarrGroup
:canonical: dawsonia.io._book.ZarrGroup
:type: typing_extensions.TypeAlias
:value: >
   None

```{autodoc2-docstring} dawsonia.io._book.ZarrGroup
```

````

`````{py:class} Book
:canonical: dawsonia.io._book.Book

```{autodoc2-docstring} dawsonia.io._book.Book
```

````{py:attribute} file
:canonical: dawsonia.io._book.Book.file
:type: pathlib.Path | zarr.hierarchy.Group
:value: >
   None

```{autodoc2-docstring} dawsonia.io._book.Book.file
```

````

````{py:attribute} page_middle
:canonical: dawsonia.io._book.Book.page_middle
:type: int | None
:value: >
   None

```{autodoc2-docstring} dawsonia.io._book.Book.page_middle
```

````

````{py:attribute} table_format
:canonical: dawsonia.io._book.Book.table_format
:type: dawsonia.typing.TableFormat
:value: >
   None

```{autodoc2-docstring} dawsonia.io._book.Book.table_format
```

````

````{py:attribute} size_cell
:canonical: dawsonia.io._book.Book.size_cell
:type: list[float]
:value: >
   None

```{autodoc2-docstring} dawsonia.io._book.Book.size_cell
```

````

````{py:attribute} preprocessor
:canonical: dawsonia.io._book.Book.preprocessor
:type: dawsonia.image_preproc.Preprocessor
:value: >
   'field(...)'

```{autodoc2-docstring} dawsonia.io._book.Book.preprocessor
```

````

````{py:property} station_name
:canonical: dawsonia.io._book.Book.station_name

```{autodoc2-docstring} dawsonia.io._book.Book.station_name
```

````

````{py:method} read_page(page_number: int) -> numpy.typing.NDArray
:canonical: dawsonia.io._book.Book.read_page

```{autodoc2-docstring} dawsonia.io._book.Book.read_page
```

````

````{py:method} read_image(page_number: int) -> PIL.Image.Image
:canonical: dawsonia.io._book.Book.read_image

```{autodoc2-docstring} dawsonia.io._book.Book.read_image
```

````

````{py:method} page_and_tables(page_number: int) -> tuple[numpy.typing.NDArray[numpy.uint8], dawsonia.typing.TablePosArrays, dawsonia.typing.TableSizes]
:canonical: dawsonia.io._book.Book.page_and_tables

```{autodoc2-docstring} dawsonia.io._book.Book.page_and_tables
```

````

````{py:method} apply_image_transformations(image: numpy.typing.NDArray[numpy.int16], transforms: dawsonia.typing.TransformsConfig) -> numpy.typing.NDArray[numpy.int16]
:canonical: dawsonia.io._book.Book.apply_image_transformations

```{autodoc2-docstring} dawsonia.io._book.Book.apply_image_transformations
```

````

````{py:method} crop_image_to_cell(image_page, table_pos_array, row, col, size_cell=None)
:canonical: dawsonia.io._book.Book.crop_image_to_cell

```{autodoc2-docstring} dawsonia.io._book.Book.crop_image_to_cell
```

````

`````

````{py:function} read_specific_table_format(table_fmt_dir: pathlib.Path, path_file: pathlib.Path | None = None, zarr_group: dawsonia.io._book.ZarrGroup | None = None) -> dawsonia.typing.TableFormat
:canonical: dawsonia.io._book.read_specific_table_format

```{autodoc2-docstring} dawsonia.io._book.read_specific_table_format
```
````