feat: add improved table serializer and visualizer (#328)

* feat: add improved table serializer and visualizer

Signed-off-by: Peter Staar <[email protected]>

* visualizer for rows and columns

Signed-off-by: Peter Staar <[email protected]>

---------

Signed-off-by: Peter Staar <[email protected]>

Author: PeterStaar-IBM

.flake8

@@ -4,5 +4,5 @@ max-line-length = 120
 exclude = test/*
 max-complexity = 25
 docstring-convention = google
-ignore = W503,E203
+ignore = W503,E203,E741
 classmethod-decorators = classmethod,validator

docling_core/transforms/serializer/html.py

@@ -340,7 +340,7 @@ def serialize(
 
                     content = html.escape(cell.text.strip())
                     celltag = "td"
-                    if cell.column_header:
+                    if cell.column_header or cell.row_header or cell.row_section:
                         celltag = "th"
 
                     opening_tag = f"{celltag}"

docling_core/transforms/visualizer/table_visualizer.py

@@ -23,8 +23,23 @@ class Params(BaseModel):
 
         # show_Label: bool = False
         show_cells: bool = True
-        # show_rows: bool = False
-        # show_cols: bool = False
+        show_rows: bool = False
+        show_cols: bool = False
+
+        cell_color: tuple[int, int, int, int] = (256, 0, 0, 32)
+        cell_outline: tuple[int, int, int, int] = (256, 0, 0, 128)
+
+        row_color: tuple[int, int, int, int] = (256, 0, 0, 32)
+        row_outline: tuple[int, int, int, int] = (256, 0, 0, 128)
+
+        row_header_color: tuple[int, int, int, int] = (0, 256, 0, 32)
+        row_header_outline: tuple[int, int, int, int] = (0, 256, 0, 128)
+
+        col_color: tuple[int, int, int, int] = (0, 256, 0, 32)
+        col_outline: tuple[int, int, int, int] = (0, 256, 0, 128)
+
+        col_header_color: tuple[int, int, int, int] = (0, 0, 256, 32)
+        col_header_outline: tuple[int, int, int, int] = (0, 0, 256, 128)
 
     base_visualizer: Optional[BaseVisualizer] = None
     params: Params = Params()
@@ -45,7 +60,21 @@ def _draw_table_cells(
 
                 tl_bbox = cell.bbox.to_top_left_origin(page_height=page_height)
 
-                cell_color = (256, 0, 0, 32)  # Transparent black for cells
+                cell_color = self.params.cell_color  # Transparent black for cells
+                cell_outline = self.params.cell_outline
+                if cell.column_header:
+                    cell_color = (
+                        self.params.col_header_color
+                    )  # Transparent black for cells
+                    cell_outline = self.params.col_header_outline
+                if cell.row_header:
+                    cell_color = (
+                        self.params.row_header_color
+                    )  # Transparent black for cells
+                    cell_outline = self.params.row_header_outline
+                if cell.row_section:
+                    cell_color = self.params.row_header_color
+                    cell_outline = self.params.row_header_outline
 
                 cx0, cy0, cx1, cy1 = tl_bbox.as_tuple()
                 cx0 *= scale_x
@@ -55,10 +84,68 @@ def _draw_table_cells(
 
                 draw.rectangle(
                     [(cx0, cy0), (cx1, cy1)],
-                    outline=(256, 0, 0, 128),
+                    outline=cell_outline,
                     fill=cell_color,
                 )
 
+    def _draw_table_rows(
+        self,
+        table: TableItem,
+        page_image: Image,
+        page_height: float,
+        scale_x: float,
+        scale_y: float,
+    ):
+        """Draw individual table cells."""
+        draw = ImageDraw.Draw(page_image, "RGBA")
+
+        rows = table.data.get_row_bounding_boxes()
+
+        for rid, bbox in rows.items():
+
+            tl_bbox = bbox.to_top_left_origin(page_height=page_height)
+
+            cx0, cy0, cx1, cy1 = tl_bbox.as_tuple()
+            cx0 *= scale_x
+            cx1 *= scale_x
+            cy0 *= scale_y
+            cy1 *= scale_y
+
+            draw.rectangle(
+                [(cx0, cy0), (cx1, cy1)],
+                outline=self.params.row_outline,
+                fill=self.params.row_color,
+            )
+
+    def _draw_table_cols(
+        self,
+        table: TableItem,
+        page_image: Image,
+        page_height: float,
+        scale_x: float,
+        scale_y: float,
+    ):
+        """Draw individual table cells."""
+        draw = ImageDraw.Draw(page_image, "RGBA")
+
+        cols = table.data.get_column_bounding_boxes()
+
+        for cid, bbox in cols.items():
+
+            tl_bbox = bbox.to_top_left_origin(page_height=page_height)
+
+            cx0, cy0, cx1, cy1 = tl_bbox.as_tuple()
+            cx0 *= scale_x
+            cx1 *= scale_x
+            cy0 *= scale_y
+            cy1 *= scale_y
+
+            draw.rectangle(
+                [(cx0, cy0), (cx1, cy1)],
+                outline=self.params.col_outline,
+                fill=self.params.col_color,
+            )
+
     def _draw_doc_tables(
         self,
         doc: DoclingDocument,
@@ -108,6 +195,24 @@ def _draw_doc_tables(
                             scale_y=image.height / doc.pages[page_nr].size.height,
                         )
 
+                    if self.params.show_rows:
+                        self._draw_table_rows(
+                            table=elem,
+                            page_height=doc.pages[page_nr].size.height,
+                            page_image=image,
+                            scale_x=image.width / doc.pages[page_nr].size.width,
+                            scale_y=image.height / doc.pages[page_nr].size.height,
+                        )
+
+                    if self.params.show_cols:
+                        self._draw_table_cols(
+                            table=elem,
+                            page_height=doc.pages[page_nr].size.height,
+                            page_image=image,
+                            scale_x=image.width / doc.pages[page_nr].size.width,
+                            scale_y=image.height / doc.pages[page_nr].size.height,
+                        )
+
                 else:
                     raise RuntimeError(f"Cannot visualize page-image for {page_nr}")
 

docling_core/types/doc/document.py

@@ -38,7 +38,7 @@
 from docling_core.search.package import VERSION_PATTERN
 from docling_core.types.base import _JSON_POINTER_REGEX
 from docling_core.types.doc import BoundingBox, Size
-from docling_core.types.doc.base import ImageRefMode
+from docling_core.types.doc.base import CoordOrigin, ImageRefMode
 from docling_core.types.doc.labels import (
     CodeLanguageLabel,
     DocItemLabel,
@@ -372,6 +372,119 @@ def grid(
 
         return table_data
 
+    def get_row_bounding_boxes(self) -> dict[int, BoundingBox]:
+        """Get the minimal bounding box for each row in the table.
+
+        Returns:
+        List[Optional[BoundingBox]]: A list where each element is the minimal
+        bounding box that encompasses all cells in that row, or None if no
+        cells in the row have bounding boxes.
+        """
+        coords = []
+        for cell in self.table_cells:
+            if cell.bbox is not None:
+                coords.append(cell.bbox.coord_origin)
+
+        if len(set(coords)) > 1:
+            raise ValueError(
+                "All bounding boxes must have the same \
+                CoordOrigin to compute their union."
+            )
+
+        row_bboxes: dict[int, BoundingBox] = {}
+
+        for row_idx in range(self.num_rows):
+            row_cells_with_bbox: dict[int, list[BoundingBox]] = {}
+
+            # Collect all cells in this row that have bounding boxes
+            for cell in self.table_cells:
+
+                if (
+                    cell.bbox is not None
+                    and cell.start_row_offset_idx <= row_idx < cell.end_row_offset_idx
+                ):
+
+                    row_span = cell.end_row_offset_idx - cell.start_row_offset_idx
+                    if row_span in row_cells_with_bbox:
+                        row_cells_with_bbox[row_span].append(cell.bbox)
+                    else:
+                        row_cells_with_bbox[row_span] = [cell.bbox]
+
+            # Calculate the enclosing bounding box for this row
+            if len(row_cells_with_bbox) > 0:
+                min_row_span = min(row_cells_with_bbox.keys())
+                row_bbox: BoundingBox = BoundingBox.enclosing_bbox(
+                    row_cells_with_bbox[min_row_span]
+                )
+
+                for rspan, bboxs in row_cells_with_bbox.items():
+                    for bbox in bboxs:
+                        row_bbox.l = min(row_bbox.l, bbox.l)
+                        row_bbox.r = max(row_bbox.r, bbox.r)
+
+                row_bboxes[row_idx] = row_bbox
+
+        return row_bboxes
+
+    def get_column_bounding_boxes(self) -> dict[int, BoundingBox]:
+        """Get the minimal bounding box for each column in the table.
+
+        Returns:
+            List[Optional[BoundingBox]]: A list where each element is the minimal
+            bounding box that encompasses all cells in that column, or None if no
+            cells in the column have bounding boxes.
+        """
+        coords = []
+        for cell in self.table_cells:
+            if cell.bbox is not None:
+                coords.append(cell.bbox.coord_origin)
+
+        if len(set(coords)) > 1:
+            raise ValueError(
+                "All bounding boxes must have the same \
+                CoordOrigin to compute their union."
+            )
+
+        col_bboxes: dict[int, BoundingBox] = {}
+
+        for col_idx in range(self.num_cols):
+            col_cells_with_bbox: dict[int, list[BoundingBox]] = {}
+
+            # Collect all cells in this row that have bounding boxes
+            for cell in self.table_cells:
+
+                if (
+                    cell.bbox is not None
+                    and cell.start_col_offset_idx <= col_idx < cell.end_col_offset_idx
+                ):
+
+                    col_span = cell.end_col_offset_idx - cell.start_col_offset_idx
+                    if col_span in col_cells_with_bbox:
+                        col_cells_with_bbox[col_span].append(cell.bbox)
+                    else:
+                        col_cells_with_bbox[col_span] = [cell.bbox]
+
+            # Calculate the enclosing bounding box for this row
+            if len(col_cells_with_bbox) > 0:
+                min_col_span = min(col_cells_with_bbox.keys())
+                col_bbox: BoundingBox = BoundingBox.enclosing_bbox(
+                    col_cells_with_bbox[min_col_span]
+                )
+
+                for rspan, bboxs in col_cells_with_bbox.items():
+                    for bbox in bboxs:
+                        if bbox.coord_origin == CoordOrigin.TOPLEFT:
+                            col_bbox.b = max(col_bbox.b, bbox.b)
+                            col_bbox.t = min(col_bbox.t, bbox.t)
+
+                        elif bbox.coord_origin == CoordOrigin.BOTTOMLEFT:
+                            col_bbox.b = min(col_bbox.b, bbox.b)
+                            col_bbox.t = max(col_bbox.t, bbox.t)
+
+                col_bboxes[col_idx] = col_bbox
+
+        return col_bboxes
+
 
 class PictureTabularChartData(PictureChartData):
     """Base class for picture chart data.