# {py:mod}`dawsonia.viz`

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

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

## Module Contents

### Functions

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

* - {py:obj}`debug_image <dawsonia.viz.debug_image>`
  - ```{autodoc2-docstring} dawsonia.viz.debug_image
    :summary:
    ```
* - {py:obj}`debug_threshold <dawsonia.viz.debug_threshold>`
  - ```{autodoc2-docstring} dawsonia.viz.debug_threshold
    :summary:
    ```
* - {py:obj}`debug_tables_detected <dawsonia.viz.debug_tables_detected>`
  - ```{autodoc2-docstring} dawsonia.viz.debug_tables_detected
    :summary:
    ```
* - {py:obj}`debug_table_positions <dawsonia.viz.debug_table_positions>`
  - ```{autodoc2-docstring} dawsonia.viz.debug_table_positions
    :summary:
    ```
* - {py:obj}`make_patch_collection_from_bboxes <dawsonia.viz.make_patch_collection_from_bboxes>`
  - ```{autodoc2-docstring} dawsonia.viz.make_patch_collection_from_bboxes
    :summary:
    ```
* - {py:obj}`debug_image_table_detect_opencv_contours <dawsonia.viz.debug_image_table_detect_opencv_contours>`
  - ```{autodoc2-docstring} dawsonia.viz.debug_image_table_detect_opencv_contours
    :summary:
    ```
* - {py:obj}`_get_bbox_extent <dawsonia.viz._get_bbox_extent>`
  - ```{autodoc2-docstring} dawsonia.viz._get_bbox_extent
    :summary:
    ```
* - {py:obj}`debug_clustered_bboxes <dawsonia.viz.debug_clustered_bboxes>`
  - ```{autodoc2-docstring} dawsonia.viz.debug_clustered_bboxes
    :summary:
    ```
````

### Data

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

* - {py:obj}`DAWSONIA_DEBUG <dawsonia.viz.DAWSONIA_DEBUG>`
  - ```{autodoc2-docstring} dawsonia.viz.DAWSONIA_DEBUG
    :summary:
    ```
* - {py:obj}`DAWSONIA_DEBUG_TABLE_DETECT <dawsonia.viz.DAWSONIA_DEBUG_TABLE_DETECT>`
  - ```{autodoc2-docstring} dawsonia.viz.DAWSONIA_DEBUG_TABLE_DETECT
    :summary:
    ```
* - {py:obj}`logger <dawsonia.viz.logger>`
  - ```{autodoc2-docstring} dawsonia.viz.logger
    :summary:
    ```
````

### API

````{py:data} DAWSONIA_DEBUG
:canonical: dawsonia.viz.DAWSONIA_DEBUG
:value: >
   'getenv(...)'

```{autodoc2-docstring} dawsonia.viz.DAWSONIA_DEBUG
```

````

````{py:data} DAWSONIA_DEBUG_TABLE_DETECT
:canonical: dawsonia.viz.DAWSONIA_DEBUG_TABLE_DETECT
:value: >
   'getenv(...)'

```{autodoc2-docstring} dawsonia.viz.DAWSONIA_DEBUG_TABLE_DETECT
```

````

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

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

````

````{py:function} debug_image(im: numpy.typing.NDArray, title: str = '', gray=True)
:canonical: dawsonia.viz.debug_image

```{autodoc2-docstring} dawsonia.viz.debug_image
```
````

````{py:function} debug_threshold(image: numpy.typing.NDArray, title: str = 'debug_threshold')
:canonical: dawsonia.viz.debug_threshold

```{autodoc2-docstring} dawsonia.viz.debug_threshold
```
````

````{py:function} debug_tables_detected(image: numpy.typing.NDArray, label_image: numpy.typing.NDArray[numpy.int64], min_area: int)
:canonical: dawsonia.viz.debug_tables_detected

```{autodoc2-docstring} dawsonia.viz.debug_tables_detected
```
````

````{py:function} debug_table_positions(image_filter, pos_list, size_list, label_tables=None, printer=False, override_debug_mode=False)
:canonical: dawsonia.viz.debug_table_positions

```{autodoc2-docstring} dawsonia.viz.debug_table_positions
```
````

````{py:function} make_patch_collection_from_bboxes(bboxes, facecolor: str | numpy.typing.NDArray[numpy.float64] = 'r') -> matplotlib.collections.PatchCollection
:canonical: dawsonia.viz.make_patch_collection_from_bboxes

```{autodoc2-docstring} dawsonia.viz.make_patch_collection_from_bboxes
```
````

````{py:function} debug_image_table_detect_opencv_contours(filtered_image, thresh_value, dilated_value, original_image, bboxes)
:canonical: dawsonia.viz.debug_image_table_detect_opencv_contours

```{autodoc2-docstring} dawsonia.viz.debug_image_table_detect_opencv_contours
```
````

````{py:function} _get_bbox_extent(bboxes: collections.abc.Sequence[dawsonia.typing.BBoxTuple]) -> tuple[float, tuple[slice, slice]]
:canonical: dawsonia.viz._get_bbox_extent

```{autodoc2-docstring} dawsonia.viz._get_bbox_extent
```
````

````{py:function} debug_clustered_bboxes(ref_image: numpy.typing.NDArray, bboxes: collections.abc.Sequence[dawsonia.typing.BBoxTuple], sorted_cluster_bboxes: dict[dawsonia.typing.ClusterLabel, collections.abc.Iterable[int] | numpy.typing.NDArray[numpy.int64]]) -> None
:canonical: dawsonia.viz.debug_clustered_bboxes

```{autodoc2-docstring} dawsonia.viz.debug_clustered_bboxes
```
````