feat: add image group serialization in html (#284)

* feat: add-image group serialization in html

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

* reformatted the code

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

---------

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

Author: PeterStaar-IBM

docling_core/transforms/serializer/html.py

@@ -370,6 +370,13 @@ def serialize(
         **kwargs: Any,
     ) -> SerializationResult:
         """Export picture to HTML format."""
+
+        def get_img_row(imgb64: str, ind: int) -> str:
+            row = '<tr><td style="border: 2px solid black; padding: 8px;">'
+            row += f'<img src="data:image/png;base64,{imgb64}" alt="image {ind}">'
+            row += "</td></tr>\n"
+            return row
+
         params = HTMLParams(**kwargs)
 
         res_parts: list[SerializationResult] = []
@@ -393,13 +400,32 @@ def serialize(
                     and item.image.uri.scheme == "data"
                 ):
                     img_text = f'<img src="{item.image.uri}">'
+                elif len(item.prov) > 1:  # more than 1 provenance
+
+                    img_text = (
+                        '<table style="border-collapse: collapse; width: 100%;">\n'
+                    )
+                    for ind, prov in enumerate(item.prov):
+                        img = item.get_image(doc, prov_index=ind)
+
+                        if img is not None:
+                            imgb64 = item._image_to_base64(img)
+                            img_text += get_img_row(imgb64=imgb64, ind=ind)
+                        else:
+                            _logger.warning("Could not get image")
+
+                    img_text += "</table>\n"
+
                 else:
                     # get the item.image._pil or crop it out of the page-image
                     img = item.get_image(doc)
 
                     if img is not None:
                         imgb64 = item._image_to_base64(img)
                         img_text = f'<img src="data:image/png;base64,{imgb64}">'
+                    else:
+                        _logger.warning("Could not get image")
+
             elif params.image_mode == ImageRefMode.REFERENCED:
                 if isinstance(item.image, ImageRef) and not (
                     isinstance(item.image.uri, AnyUrl)

docling_core/types/doc/document.py

@@ -790,7 +790,9 @@ def get_location_tokens(
 
         return location
 
-    def get_image(self, doc: "DoclingDocument") -> Optional[PILImage.Image]:
+    def get_image(
+        self, doc: "DoclingDocument", prov_index: int = 0
+    ) -> Optional[PILImage.Image]:
         """Returns the image of this DocItem.
 
         The function returns None if this DocItem has no valid provenance or
@@ -800,15 +802,15 @@ def get_image(self, doc: "DoclingDocument") -> Optional[PILImage.Image]:
         if not len(self.prov):
             return None
 
-        page = doc.pages.get(self.prov[0].page_no)
+        page = doc.pages.get(self.prov[prov_index].page_no)
         if page is None or page.size is None or page.image is None:
             return None
 
         page_image = page.image.pil_image
         if not page_image:
             return None
         crop_bbox = (
-            self.prov[0]
+            self.prov[prov_index]
             .bbox.to_top_left_origin(page_height=page.size.height)
             .scale_to_size(old_size=page.size, new_size=page.image.size)
             # .scaled(scale=page_image.height / page.size.height)
@@ -973,7 +975,9 @@ def caption_text(self, doc: "DoclingDocument") -> str:
             text += cap.resolve(doc).text
         return text
 
-    def get_image(self, doc: "DoclingDocument") -> Optional[PILImage.Image]:
+    def get_image(
+        self, doc: "DoclingDocument", prov_index: int = 0
+    ) -> Optional[PILImage.Image]:
         """Returns the image corresponding to this FloatingItem.
 
         This function returns the PIL image from self.image if one is available.
@@ -985,7 +989,7 @@ def get_image(self, doc: "DoclingDocument") -> Optional[PILImage.Image]:
         """
         if self.image is not None:
             return self.image.pil_image
-        return super().get_image(doc=doc)
+        return super().get_image(doc=doc, prov_index=prov_index)
 
 
 class CodeItem(FloatingItem, TextItem):