Skip to content

debug_utils.viewer

Displays or saves debug images for page-dewarp.

If cfg.DEBUG_OUTPUT is "file", the debug image is saved to disk with a filename indicating name, step, and text. Otherwise (if cfg.DEBUG_OUTPUT is "screen" or "both"), the image is displayed in an OpenCV window with an overlaid label, and the script waits for a keypress to close the window.

debug_show 

debug_show(name: str, step: float | int | str, text: str, display: ndarray) -> None

Show or save a debug image, possibly with an overlay of text.

Parameters:

Name Type Description Default
name str

A string identifier for this debug image (e.g. "dewarp" or "contours").

 required
step float | int | str

A numeric or string code indicating the processing step.

 required
text str

A description to overlay on the image or use in the filename.

 required
display ndarray

A NumPy array (image) to show or save.

 required
Source code in src/page_dewarp/debug_utils/viewer.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
def debug_show(
    name: str,
    step: float | int | str,
    text: str,
    display: np.ndarray,
) -> None:
    """Show or save a debug image, possibly with an overlay of text.

    Args:
        name: A string identifier for this debug image (e.g. "dewarp" or "contours").
        step: A numeric or string code indicating the processing step.
        text: A description to overlay on the image or use in the filename.
        display: A NumPy array (image) to show or save.

    """
    if cfg.DEBUG_OUTPUT != "screen":
        filetext = text.replace(" ", "_")
        outfile = f"{name}_debug_{step}_{filetext}.png"
        imwrite(outfile, display)

    if cfg.DEBUG_OUTPUT != "file":
        image = display.copy()
        height = image.shape[0]

        putText(
            image,
            text,
            (16, height - 16),
            FONT_HERSHEY_SIMPLEX,
            1.0,
            (0, 0, 0),
            3,
            LINE_AA,
        )
        putText(
            image,
            text,
            (16, height - 16),
            FONT_HERSHEY_SIMPLEX,
            1.0,
            (255, 255, 255),
            1,
            LINE_AA,
        )
        imshow("Dewarp", image)

        while waitKey(5) < 0:
            pass