Function draw_text

src/layoutparser/visualization.py:418–571

Draw the (detected) text in the `layout` according to their coordinates next to the input `canvas` (image) for better comparison. Args: canvas (:obj:`~np.ndarray` or :obj:`~PIL.Image.Image`): The canvas to draw the layout boxes. layout (:obj:`Layout` or :obj:`lis

(
    canvas,
    layout,
    arrangement: str = "lr",
    font_size: Optional[int] = None,
    font_path: Optional[str] = None,
    text_color: Optional[str] = None,
    text_background_color: Optional[str] = None,
    text_background_alpha: Optional[float] = None,
    vertical_text: bool = False,
    with_box_on_text: bool = False,
    text_box_width: Optional[int] = None,
    text_box_color: Optional[str] = None,
    text_box_alpha: Optional[float] = None,
    with_layout: bool = False,
    **kwargs,
)

@image_loader
def draw_text(
    canvas,
    layout,
    arrangement: str = "lr",
    font_size: Optional[int] = None,
    font_path: Optional[str] = None,
    text_color: Optional[str] = None,
    text_background_color: Optional[str] = None,
    text_background_alpha: Optional[float] = None,
    vertical_text: bool = False,
    with_box_on_text: bool = False,
    text_box_width: Optional[int] = None,
    text_box_color: Optional[str] = None,
    text_box_alpha: Optional[float] = None,
    with_layout: bool = False,
    **kwargs,
):
    """Draw the (detected) text in the `layout` according to
    their coordinates next to the input `canvas` (image) for better comparison.

    Args:
        canvas (:obj:`~np.ndarray` or :obj:`~PIL.Image.Image`):
            The canvas to draw the layout boxes.
        layout (:obj:`Layout` or :obj:`list`):
            The layout of the canvas to show.
        arrangement (`{'lr', 'ud'}`, optional):
            The arrangement of the drawn text canvas and the original
            image canvas:
            * `lr` - left and right
            * `ud` - up and down
            Defaults to 'lr'.
        font_size (:obj:`str`, optional):
            Set to change the size of the font used for
            drawing `block.text`.
            Defaults to None, when the size is set to
            :const:`DEFAULT_FONT_SIZE`.
        font_path (:obj:`str`, optional):
            Set to change the font used for drawing `block.text`.
            Defaults to None, when the :const:`DEFAULT_FONT_OBJECT` is used.
        text_color ([type], optional):
            Set to change the text color used for drawing `block.text`.
            Defaults to None, when the color is set to
            :const:`DEFAULT_TEXT_COLOR`.
        text_background_color ([type], optional):
            Set to change the text region background used for drawing
            `block.text`.
            Defaults to None, when the color is set to
            :const:`DEFAULT_TEXT_BACKGROUND`.
        text_background_alpha (:obj:`float`, optional):
            A float range from 0 to 1. Set to change the alpha of the
            background of the canvas.
            Defaults to 1 - the text box will be solid.
        vertical_text (bool, optional):
            Whether the text in a block should be drawn vertically.
            Defaults to False.
        with_box_on_text (bool, optional):
            Whether to draw the layout box boundary of a text region
            on the text canvas.