wolfhece 2.2.45__py3-none-any.whl → 2.2.46__py3-none-any.whl

wolfhece/report/common.py

@@ -3,9 +3,12 @@ import wx
 import os
 import platform
 
+import pandas as pd
 import pymupdf as pdf
 from tempfile import NamedTemporaryFile
 from tempfile import TemporaryDirectory
+from functools import cached_property
+from PIL import Image
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -159,6 +162,81 @@ li {{
 
     return html, css
 
+
+def dict_to_html(data_dict:dict, font_size="10pt", font_family="Helvetica"):
+    """ Convert a dictionary to an HTML table with dataframe_image """
+
+    df = pd.DataFrame.from_dict(data_dict)
+
+    # Convert the DataFrame to an HTML table
+    html = df.to_html(index=False, border=0, justify='left')
+
+    # Generate the CSS
+    css = f"""
+    table {{
+        font-size: {font_size};
+        font-family: {font_family};
+        color: #2C3E50;
+        border-collapse: collapse;
+    }}
+    th, td {{
+        padding: 8px 12px;
+        border: 1px solid #BDC3C7;
+    }}
+    """
+
+    return html, css
+
+def dataframe_to_html(data:pd.DataFrame, font_size="10pt", font_family="Helvetica"):
+    """ Convert a DataFrame to an HTML table with dataframe_image """
+
+    # Convert the DataFrame to an HTML table
+    html = data.to_html(index=False, border=0, justify='left')
+
+    # Generate the CSS
+    css = f"""
+    table {{
+        font-size: {font_size};
+        font-family: {font_family};
+        color: #2C3E50;
+        border-collapse: collapse;
+    }}
+    th, td {{
+        padding: 8px 12px;
+        border: 1px solid #BDC3C7;
+    }}
+    """
+
+    return html, css
+
+def convert_report_to_images(pdf_path: str | Path, dpi=150) -> list[Image.Image]:
+    """ Convert the PDF report to a list of images (one per page).
+
+    :param dpi: Dots per inch for the output images.
+    :return: List of Images, one per page.
+    """
+
+    if pdf_path is None:
+        raise ValueError("PDF report has not been saved yet. Please save the report before converting to images.")
+
+    pdf_path = Path(pdf_path)
+    if not pdf_path.exists():
+        raise FileNotFoundError(f"PDF report not found at {pdf_path}. Please check the path.")
+
+    doc = pdf.open(pdf_path)
+    images = []
+
+    zoom = dpi / 72  # 72 dpi is the default resolution
+    mat = pdf.Matrix(zoom, zoom)
+
+    for page_num in range(len(doc)):
+        page = doc.load_page(page_num)
+        pix = page.get_pixmap(matrix=mat, alpha=False)
+        img = Image.frombytes("RGB", [pix.width, pix.height], pix.samples)
+        images.append(img)
+
+    return images
+
 # A4 format
 PAGE_WIDTH = 21  # cm
 PAGE_HEIGHT = 29.7  # cm
@@ -169,7 +247,10 @@ SLIDE_WIDTH = inches2cm(13.3333)  # cm
 
 class DefaultLayoutA4(Zones):
     """
-    Enum for default layout options.
+    Global layout for A4 report.
+
+    This class inherits from Zones and defines a standard layout for A4 reports.
+    It includes predefined areas for the title, versions, logo, and footer.
     """
 
     def __init__(self, title:str, filename = '', ox = 0, oy = 0, tx = 0, ty = 0, parent=None, is2D=True, idx = '', plotted = True, mapviewer=None, need_for_wx = False, bbox = None, find_minmax = True, shared = False, colors = None):
@@ -260,14 +341,21 @@ class DefaultLayoutA4(Zones):
         vec_footer.find_minmax()
         elts.add_vector(vec_footer, forceparent=True)
 
-        self._layout = {}
         self._doc = None # Placeholder for the PDF document
         self._pdf_path = None  # Placeholder for the PDF file path
 
     def add_element(self, name:str, width:float, height:float, x:float = 0, y:float = 0) -> vector:
         """
-        Add an element to the layout.
+        Add a single element to the page.
+
+        :param name: Name of the element.
+        :param width: Width of the element in cm.
+        :param height: Height of the element in cm.
+        :param x: X coordinate of the bottom-left corner in cm.
+        :param y: Y coordinate of the bottom-left corner in cm.
+        :return: The created vector representing the element.
         """
+
         vec = vector(name=name)
         vec.add_vertex(wv(x, y))
         vec.add_vertex(wv(x + width, y))
@@ -287,6 +375,19 @@ class DefaultLayoutA4(Zones):
                              first_x:float = 0, first_y:float = 0,
                              count_x:int = 1, count_y:int = 1,
                              padding:float = None) -> zone:
+        """
+        Add multiple elements to the page in a grid.
+
+        :param name: Base name for the elements.
+        :param width: Width of each element in cm.
+        :param height: Height of each element in cm.
+        :param first_x: X coordinate of the first element in cm.
+        :param first_y: Y coordinate of the first element in cm.
+        :param count_x: Number of elements in the X direction (positive for right, negative for left).
+        :param count_y: Number of elements in the Y direction (positive for up, negative for down).
+        :param padding: Padding between elements in cm. If None, use self.padding.
+        :return: A zone containing the added elements.
+        """
 
         if padding is None:
             padding = self.padding
@@ -315,7 +416,10 @@ class DefaultLayoutA4(Zones):
 
     def check_if_overlap(self, vec:vector) -> bool:
         """
-        Check if the vector overlaps with any existing vector in the layout.
+        Check if the vector overlaps with any existing vector in the page layout.
+
+        :param vec: The vector to check.
+        :return: True if there is an overlap, False otherwise.
         """
         for existing_vec in self['Elements'].myvectors:
             if vec.linestring.overlaps(existing_vec.linestring):
@@ -327,6 +431,7 @@ class DefaultLayoutA4(Zones):
         """
         Get the useful part of the page, excluding margins.
         """
+
         vec = self[('Page', _('Page'))]
         vec.find_minmax()
 
@@ -355,6 +460,7 @@ class DefaultLayoutA4(Zones):
         """
         Get the dimensions of the page in centimeters.
         """
+
         vec = self[('Page', _('Page'))]
         vec.find_minmax()
         width = vec.xmax - vec.xmin
@@ -364,25 +470,47 @@ class DefaultLayoutA4(Zones):
     @property
     def keys(self) -> list[str]:
         """
-        Get the keys of the layout.
+        Get the keys of the page layout.
         """
+
         return [vec.myname for vec in self['Elements'].myvectors]
 
-    def to_dict(self):
+    @cached_property
+    def layout(self) -> dict:
+        """
+        Get the layout as a dictionary.
+        """
+
+        return self._to_dict()
+
+    def get_item_in_layout(self, name:str):
+        """ Override the indexing to access layout elements by name. """
+        if isinstance(name, str):
+            if name not in self.layout:
+                raise KeyError(f"Element '{name}' not found in layout.")
+
+        return self.layout[name]
+
+    def _to_dict(self):
         """
         Convert the layout Zones to a dictionary.
         """
+
         layout = {}
 
         for vec in self['Elements'].myvectors:
             vec.find_minmax()
             layout[vec.myname] = rect_cm(vec.xmin, PAGE_HEIGHT - vec.ymax, vec.xmax - vec.xmin, vec.ymax - vec.ymin)
 
+        return layout
+
     def plot(self, scale=1.):
         """
-        Plot the layout using matplotlib.
+        Plot the page layout using matplotlib.
+
         :param scale: Scale factor for the plot.
         """
+
         fig, ax = plt.subplots(figsize=(cm2inches(PAGE_WIDTH) * scale, cm2inches(PAGE_HEIGHT)*scale))
 
         self['Elements'].plot_matplotlib(ax = ax)
@@ -401,17 +529,6 @@ class DefaultLayoutA4(Zones):
 
         return fig, ax
 
-    def _create_layout_pdf(self) -> dict:
-        """
-        Create the layout dictionary for the report.
-        :return: A dictionary with layout information.
-        """
-        for vec in self['Elements'].myvectors:
-            vec.find_minmax()
-            self._layout[vec.myname] = rect_cm(vec.xmin, PAGE_HEIGHT - vec.ymax, vec.xmax - vec.xmin, vec.ymax - vec.ymin)
-
-        return self._layout
-
     def _summary_versions(self):
         """ Find the versions of the simulation, wolfhece and the wolfgpu package """
         import json
@@ -426,24 +543,23 @@ class DefaultLayoutA4(Zones):
         return group_title, text
 
     def _insert_to_page(self, page: pdf.Page):
+        """ Insert the layout into the PDF page. """
 
-        layout = self._create_layout_pdf()
-
-        page.insert_htmlbox(layout['Title'], f"<h1>{self.title}</h1>",
+        page.insert_htmlbox(self.layout['Title'], f"<h1>{self.title}</h1>",
                                 css='h1 {font-size:16pt; font-family:Helvetica; color:#333}')
 
         # versions box
         try:
             text = self._summary_versions()
             html, css = list_to_html_aligned(text[1], font_size="10pt", font_family="Helvetica")
-            spare_height, scale = page.insert_htmlbox(layout['Versions'], html, css=css, scale_low  = 0.1)
+            spare_height, scale = page.insert_htmlbox(self.layout['Versions'], html, css=css, scale_low=0.1)
 
             if spare_height < 0.:
                 logging.warning("Text overflow in versions box. Adjusting scale.")
         except:
             logging.error("Failed to insert versions text. Using fallback method.")
 
-        rect = layout['Logo']
+        rect = self.layout['Logo']
         # Add the logo to the top-right corner
         logo_path = Path(__file__).parent / 'wolf_report.png'
         if logo_path.exists():
@@ -454,7 +570,7 @@ class DefaultLayoutA4(Zones):
         # Footer
         # ------
         # Insert the date and time of the report generation, the user and the PC name
-        footer_rect = layout['Footer']
+        footer_rect = self.layout['Footer']
         footer_text = f"<p>Report generated on {dt.now()} by {os.getlogin()} on {platform.uname().node} - {platform.uname().machine} - {platform.uname().release} - {platform.uname().version}</br> \
         This report does not guarantee the quality of the model and in no way commits the software developers.</p>"
         page.insert_htmlbox(footer_rect, footer_text,
@@ -490,6 +606,7 @@ class DefaultLayoutA4(Zones):
             self._pdf_path = None
             return
 
+
     @property
     def pdf_path(self):
         """ Return the PDF document """

wolfhece/report/compare_arrays.py

@@ -9,8 +9,9 @@ import pymupdf as pdf
 import wx
 from tqdm import tqdm
 from matplotlib import use, get_backend
+from PIL.Image import Image
 
-from .common import A4_rect, rect_cm, list_to_html, list_to_html_aligned, get_rect_from_text
+from .common import A4_rect, rect_cm, list_to_html, list_to_html_aligned, get_rect_from_text, convert_report_to_images
 from .common import inches2cm, pts2cm, cm2pts, cm2inches, DefaultLayoutA4, NamedTemporaryFile, pt2inches, TemporaryDirectory
 from ..wolf_array import WolfArray, header_wolf, vector, zone, Zones, wolfvertex as wv, wolfpalette
 from ..PyTranslate import _
@@ -39,11 +40,11 @@ class ArrayDifferenceLayout(DefaultLayoutA4):
         width = useful.xmax - useful.xmin
         height = useful.ymax - useful.ymin
 
-        self._hitograms = self.add_element_repeated(_("Histogram"), width=width, height=2.5,
+        self._hitograms = self.add_element_repeated("Histogram", width=width, height=2.5,
                                                     first_x=useful.xmin, first_y=useful.ymax,
                                                     count_x=1, count_y=-2, padding=0.5)
 
-        self._arrays = self.add_element_repeated(_("Arrays"), width= (width-self.padding) / 2, height=5.5,
+        self._arrays = self.add_element_repeated("Arrays", width= (width-self.padding) / 2, height=5.5,
                                                  first_x=useful.xmin, first_y=self._hitograms.ymin - self.padding,
                                                 count_x=2, count_y=-3, padding=0.5)
 
@@ -73,10 +74,10 @@ class CompareArraysLayout2(DefaultLayoutA4):
         width = useful.xmax - useful.xmin
         height = useful.ymax - useful.ymin
 
-        self._summary = self.add_element_repeated(_("Histogram"), width=(width-self.padding) / 2, height=6., first_x=useful.xmin, first_y=useful.ymax-6, count_x=2, count_y=1)
+        self._summary = self.add_element_repeated("Histogram", width=(width-self.padding) / 2, height=6., first_x=useful.xmin, first_y=useful.ymax-6, count_x=2, count_y=1)
 
-        self._arrays = self.add_element_repeated(_("Arrays"), width= (width-self.padding) / 2, height=6., count_x=2, count_y=1, first_x=useful.xmin, first_y=14)
-        self._diff_rect = self.add_element(_("Position"), width= width, height=11.5, x=useful.xmin, y=useful.ymin)
+        self._arrays = self.add_element_repeated("Arrays", width= (width-self.padding) / 2, height=6., count_x=2, count_y=1, first_x=useful.xmin, first_y=14)
+        self._diff_rect = self.add_element("Position", width= width, height=11.5, x=useful.xmin, y=useful.ymin)
 
 
 class ArrayDifference():
@@ -402,12 +403,12 @@ class ArrayDifference():
 
         return fig, ax
 
-    def _complete_report(self, layout:ArrayDifferenceLayout):
+    def _complete_report(self, page:ArrayDifferenceLayout):
 
         """
         Complete the report with the arrays and histograms.
         """
-        useful = layout.useful_part
+        useful = page.useful_part
 
         # Plot reference array
         key_fig = [('Histogram_0-0', self.plot_histograms),
@@ -418,11 +419,11 @@ class ArrayDifference():
                    ('Arrays_1-1', self.plot_to_compare),
                    ('Arrays_0-2', self.plot_difference),]
 
-        keys = layout.keys
+        keys = page.keys
         for key, fig_routine in key_fig:
             if key in keys:
 
-                rect = layout._layout[key]
+                rect = page.get_item_in_layout(key)
 
                 fig, ax = fig_routine()
 
@@ -435,7 +436,7 @@ class ArrayDifference():
                 # convert canvas to PNG and insert it into the PDF
                 temp_file = NamedTemporaryFile(delete=False, suffix='.png')
                 fig.savefig(temp_file, format='png', bbox_inches='tight', dpi=self._dpi)
-                layout._page.insert_image(layout._layout[key], filename = temp_file.name)
+                page._page.insert_image(page.get_item_in_layout(key), filename=temp_file.name)
                 # delete the temporary file
                 temp_file.delete = True
                 temp_file.close()
@@ -448,7 +449,7 @@ class ArrayDifference():
         key = 'Arrays_1-2'
         if key in keys:
             text, css = list_to_html(self._summary_text, font_size='8pt')
-            layout._page.insert_htmlbox(layout._layout[key], text,
+            page._page.insert_htmlbox(page.get_item_in_layout(key), text,
                                 css=css)
 
     def create_report(self, output_file: str | Path = None) -> Path:
@@ -461,10 +462,10 @@ class ArrayDifference():
         if output_file.exists():
             logging.warning(f"Output file {output_file} already exists. It will be overwritten.")
 
-        layout = ArrayDifferenceLayout(f"Differences - Index n°{self.index}")
-        layout.create_report()
-        self._complete_report(layout)
-        layout.save_report(output_file)
+        page = ArrayDifferenceLayout(f"Differences - Index n°{self.index}")
+        page.create_report()
+        self._complete_report(page)
+        page.save_report(output_file)
         sleep(0.2)  # Ensure the file is saved before returning
 
         return output_file
@@ -788,18 +789,18 @@ class CompareArrays:
         ]
         return text_left, text_right
 
-    def _complete_report(self, layout:CompareArraysLayout):
+    def _complete_report(self, page:CompareArraysLayout):
         """ Complete the report with the global summary and individual differences. """
 
         key_fig = [('Arrays_0-0', self.plot_reference),
                    ('Arrays_1-0', self.plot_to_compare),
                    ('Difference', self.plot_difference),]
 
-        keys = layout.keys
+        keys = page.keys
         for key, fig_routine in key_fig:
             if key in keys:
 
-                rect = layout._layout[key]
+                rect = page.get_item_in_layout(key)
 
                 fig, ax = fig_routine()
 
@@ -809,7 +810,7 @@ class CompareArrays:
                 # convert canvas to PNG and insert it into the PDF
                 temp_file = NamedTemporaryFile(delete=False, suffix='.png')
                 fig.savefig(temp_file, format='png', bbox_inches='tight', dpi=self._dpi)
-                layout._page.insert_image(layout._layout[key], filename=temp_file.name)
+                page._page.insert_image(page.get_item_in_layout(key), filename=temp_file.name)
                 # delete the temporary file
                 temp_file.delete = True
                 temp_file.close()
@@ -821,12 +822,12 @@ class CompareArrays:
 
         tleft, tright = self.summary_text
 
-        rect = layout._layout['Summary_0-0']
+        rect = page.get_item_in_layout('Summary_0-0')
         text_left, css_left = list_to_html(tleft, font_size='8pt')
-        layout._page.insert_htmlbox(rect, text_left, css=css_left)
-        rect = layout._layout['Summary_1-0']
+        page._page.insert_htmlbox(rect, text_left, css=css_left)
+        rect = page.get_item_in_layout('Summary_1-0')
         text_right, css_right = list_to_html(tright, font_size='8pt')
-        layout._page.insert_htmlbox(rect, text_right, css=css_right)
+        page._page.insert_htmlbox(rect, text_right, css=css_right)
 
     def plot_histogram_features(self, figax:tuple[plt.Figure, plt.Axes]=None, density = True, alpha = 0.5, **kwargs) -> tuple[plt.Figure, plt.Axes]:
         """
@@ -901,7 +902,7 @@ class CompareArrays:
 
         return fig, ax
 
-    def _complete_report2(self, layout:CompareArraysLayout):
+    def _complete_report2(self, page:CompareArraysLayout):
         """ Complete the report with the individual differences. """
 
         key_fig = [('Histogram_0-0', self.plot_histogram_features),
@@ -911,11 +912,11 @@ class CompareArrays:
                    ('Position', self.plot_topo_grey),
                    ]
 
-        keys = layout.keys
+        keys = page.keys
         for key, fig_routine in key_fig:
             if key in keys:
 
-                rect = layout._layout[key]
+                rect = page.get_item_in_layout(key)
 
                 fig, ax = fig_routine()
 
@@ -926,7 +927,7 @@ class CompareArrays:
                 # convert canvas to PNG and insert it into the PDF
                 temp_file = NamedTemporaryFile(delete=False, suffix='.png')
                 fig.savefig(temp_file, format='png', bbox_inches='tight', dpi=self._dpi)
-                layout._page.insert_image(layout._layout[key], filename=temp_file.name)
+                page._page.insert_image(page.get_item_in_layout(key), filename=temp_file.name)
                 # delete the temporary file
                 temp_file.delete = True
                 temp_file.close()
@@ -949,9 +950,9 @@ class CompareArrays:
         if output_file.exists():
             logging.warning(f"Output file {output_file} already exists. It will be overwritten.")
 
-        layout = CompareArraysLayout("Comparison Report")
-        layout.create_report()
-        self._complete_report(layout)
+        page = CompareArraysLayout("Comparison Report")
+        page.create_report()
+        self._complete_report(page)
 
         if nb_max_differences < 0:
             nb_max_differences = len(self.difference_parts)
@@ -975,12 +976,12 @@ class CompareArrays:
                 all_pdfs.extend([self.difference_parts[idx].create_report(Path(temp_dir) / f"array_difference_{idx}.pdf") for idx in tqdm(features_to_treat, desc="Creating individual difference reports")])
 
             for pdf_file in tqdm(all_pdfs, desc="Compiling PDFs"):
-                layout._doc.insert_file(pdf_file)
+                page._doc.insert_file(pdf_file)
 
         # create a TOC
-        layout._doc.set_toc(layout._doc.get_toc())
+        page._doc.set_toc(page._doc.get_toc())
 
-        layout.save_report(output_file)
+        page.save_report(output_file)
         self._pdf_path = output_file
 
     @property
@@ -991,6 +992,14 @@ class CompareArrays:
         else:
             raise AttributeError("PDF path not set. Please create the report first.")
 
+    def convert_report_to_images(self, dpi:int = 150) -> list[Image]:
+        """ Convert the PDF report to a list of images (one per page). """
+        if self.pdf_path is None or not self.pdf_path.exists():
+            raise FileNotFoundError("PDF report not found. Please create the report first.")
+
+        images = convert_report_to_images(self.pdf_path, dpi=dpi)
+        return images
+
 class CompareArrays_wx(PDFViewer):
 
     def __init__(self, reference: WolfArray | str | Path,