wolfhece 2.2.32__py3-none-any.whl → 2.2.34__py3-none-any.whl

wolfhece/wolf_zi_db.py

@@ -17,11 +17,15 @@ from enum import Enum
 from pathlib import Path
 from typing import Literal, Union
 import wx
+from tqdm import tqdm
+import re
 
 from shapely.geometry import Polygon
 
 from .PyVertexvectors import Zones, zone, vector, wolfvertex
+from .textpillow import Font_Priority
 from .wolf_texture import genericImagetexture
+from .PyPictures import PictureCollection
 from .PyTranslate import _
 
 class ColNames_PlansTerriers(Enum):
@@ -38,6 +42,90 @@ class ColNames_PlansTerriers(Enum):
     LOWRES  = 'Acces2'
     RIVER   = 'River'
 
+class ColNames_Ouvrages(Enum):
+    """ Enum for the column names in the database """
+
+    KEY   = 'Clé primaire'
+    X1 = 'X Lambert gauche'
+    X2 = 'X Lambert droit'
+    Y1  = 'Y Lambert gauche'
+    Y2  = 'Y Lambert droit'
+    REMARK = 'Remarques'
+    RIVER = 'Lieu'
+    PHOTO1 = 'Photo1'
+    PHOTO2 = 'Photo2'
+    PHOTO3 = 'Photo3'
+    PHOTO4 = 'Photo4'
+    PHOTO5 = 'Photo5'
+    PHOTO6 = 'Photo6'
+    PHOTO7 = 'Photo7'
+    PHOTO8 = 'Photo8'
+    PHOTO9 = 'Photo9'
+    PHOTO10 = 'Photo10'
+    DATE = 'Date'
+
+class ColNames_Particularites(Enum):
+    """ Enum for the column names in the database """
+
+    KEY   = 'Clé primaire'
+    X = 'Xlambert'
+    Y = 'Ylambert'
+    REMARK = 'Commentaires'
+    RIVER = 'Rivière'
+    PHOTO1 = 'Photo 1'
+    PHOTO2 = 'Photo 2'
+    PHOTO3 = 'Photo 3'
+    PHOTO4 = 'Photo 4'
+    PHOTO5 = 'Photo 5'
+    ORIENTATION = 'Orientation'
+    DATE = 'Date'
+
+class ColNames_Enquetes(Enum):
+    """ Enum for the column names in the database """
+
+    KEY   = 'Clé primaire'
+    X = 'XLambert'
+    Y = 'YLambert'
+    RIVER = 'Rivière'
+    PHOTO = 'Photo'
+    ORIENTATION = 'Orientation'
+    DATE = 'Date'
+
+def _test_bounds(x:float, y:float, bounds:list[list[float, float], list[float, float]]) -> bool:
+    """ Test if the coordinates are inside the bounds
+
+    :param x: The x coordinate
+    :type x: float
+    :param y: The y coordinate
+    :type y: float
+    :param bounds: The bounds to test against - [ [xmin, xmax], [ymin, ymax] ]
+    :type bounds: list[list[float, float], list[float, float]]
+    :return: True if the coordinates are inside the bounds, False otherwise
+    :rtype: bool
+    """
+
+    if bounds is None:
+        return True
+
+    xmin, xmax = bounds[0]
+    ymin, ymax = bounds[1]
+
+    return xmin <= x <= xmax and ymin <= y <= ymax
+
+
+def _sanitize_legendtext(text:str) -> str:
+    """ Sanitize the legend text by replacing newlines and special characters
+
+    :param text: The text to sanitize
+    :type text: str
+    :return: The sanitized text
+    :rtype: str
+    """
+    text = str(text)
+    # replace newlines and special characters
+    text = re.sub(r'(_x000D_\n|\n)', ' - ', text)
+
+    return text.strip()
 class ZI_Databse_Elt():
     """ Class to store the database elements """
 
@@ -211,7 +299,9 @@ class PlansTerrier(Zones):
                 logging.error('No file selected or the file does not exist.')
                 return
 
+        logging.info(f'Reading database from {self.filename}')
         self.db = pd.read_excel(self.filename, sheet_name='Plans_Terriers')
+        logging.info(f'Database read successfully from {self.filename}')
 
         rivers = list(self.db[ColNames_PlansTerriers.RIVER.value].unique())
         rivers.sort()
@@ -289,7 +379,7 @@ class PlansTerrier(Zones):
                         curvector.add_vertex(wolfvertex(x=curelt.origx, y=curelt.endy))
                         curvector.close_force()
                     else:
-                        logging.error(f'File {fullpath} does not exist')
+                        logging.debug(f'File {fullpath} does not exist')
 
                     break
 
@@ -348,4 +438,498 @@ class PlansTerrier(Zones):
         super().plot(sx, sy, xmin, ymin, xmax, ymax, size)
 
         for curtexture in self.textures.values():
-            curtexture.plot(sx, sy, xmin, ymin, xmax, ymax, size)
+            curtexture.plot(sx, sy, xmin, ymin, xmax, ymax, size)
+
+
+class Ouvrages(PictureCollection):
+    """ Class to handle the "Ouvrages" -- Pictures of the structures in the ZI. """
+
+    def __init__(self, parent=None, idx: str = '', plotted: bool = True, mapviewer=None, rivers:list[str] = None) -> None:
+        """
+        Constructor for the Ouvrages class.
+
+        :param parent: The wx parent of the object
+        :type parent: wx.Window
+        :param idx: The index of the object
+        :type idx: str
+        :param plotted: If the object is plotted
+        :type plotted: bool
+        :param mapviewer: The mapviewer object
+        :type mapviewer: MapViewer
+        :param rivers: The list of rivers to display
+        :type rivers: list[str]
+        """
+
+        super().__init__(parent = parent, idx = idx, plotted = plotted, mapviewer = mapviewer)
+
+        self.wx_exists = wx.GetApp() is not None
+        self.db = None
+        self.rivers = rivers
+        self.initialized = False
+
+        self._columns = ColNames_Ouvrages
+
+    def check_plot(self):
+        """ Activate the plot if the object is initialized """
+
+        if not self.initialized:
+
+            # try to get the filename from the parent mapviewer
+            if self.mapviewer is not None:
+                self.filename = self.mapviewer.default_hece_database
+                bounds = self.mapviewer.get_bounds()
+
+            if 'bridge' in self.idx.lower() or 'pont' in self.idx.lower():
+                self.read_db(self.filename, sel_rivers=self.rivers, sheet_name='Ponts', bounds=bounds)
+            elif 'weir' in self.idx.lower() or 'seuil' in self.idx.lower():
+                self.read_db(self.filename, sel_rivers=self.rivers, sheet_name='Seuils', bounds=bounds)
+            elif 'survey' in self.idx.lower() or 'enquete' in self.idx.lower():
+                self.read_db(self.filename, sel_rivers=self.rivers, sheet_name='Photos', bounds=bounds)
+            elif 'features' in self.idx.lower() or 'particularit' in self.idx.lower():
+                self.read_db(self.filename, sel_rivers=self.rivers, sheet_name='Particularités', bounds=bounds)
+
+        if self.initialized:
+            super().check_plot()
+
+    def read_db(self, filename:str | Path,
+                sel_rivers: list[str] = None,
+                sheet_name: str = 'Ponts',
+                bounds: list[list[float, float], list[float, float]] = None):
+        """ Read the database (Excel file) and create the zones and the vectors.
+
+        The user will be prompted to select the rivers to display.
+
+        :param filename: The path to the Excel file containing the database
+        :type filename: str | Path
+        :param sel_rivers: The list of rivers to display, if None, the user will be prompted to select the rivers
+        :type sel_rivers: list[str] | None
+        :param sheet_name: The name of the sheet in the Excel file to read
+        :type sheet_name: str
+        :param bounds: The bounds of the area to display, if None, no test on coordinates will be done - [ [xmin, xmax], [ymin, ymax] ]
+        :type bounds: list[list[float, float], list[float, float]] | None
+        """
+
+        self.filename = Path(filename)
+
+        if not self.filename.exists() or filename == '':
+
+            if self.wx_exists:
+
+                dlg= wx.FileDialog(None, _("Choose a file"), defaultDir= "", wildcard="Excel (*.xlsx)|*.xlsx", style = wx.FD_OPEN)
+                ret = dlg.ShowModal()
+                if ret == wx.ID_OK:
+                    self.filename = Path(dlg.GetPath())
+                    dlg.Destroy()
+                else:
+                    logging.error('No file selected')
+                    dlg.Destroy()
+                    return
+
+            else:
+                logging.error('No file selected or the file does not exist.')
+                return
+
+        try:
+            logging.info(f'Reading database from {self.filename}')
+            self.db = pd.read_excel(self.filename, sheet_name=sheet_name)
+            logging.info(f'Database read successfully from {self.filename}')
+        except ValueError as e:
+            logging.error(f"Error reading the Excel file: {e}")
+            return
+
+        rivers = list(self.db[ColNames_Ouvrages.RIVER.value].unique())
+        rivers.sort()
+
+        self.rivers = []
+
+        if sel_rivers is None and self.wx_exists:
+
+            with wx.MessageDialog(None, _("Choose the rivers to display"), _("Rivers"), wx.YES_NO | wx.ICON_QUESTION) as dlg:
+
+                if dlg.ShowModal() == wx.ID_YES:
+
+                    with wx.MultiChoiceDialog(None, _("Choose the rivers to display"), _("Rivers"), rivers) as dlg_river:
+                        ret = dlg_river.ShowModal()
+
+                        if ret == wx.ID_OK:
+                            for curidx in dlg_river.GetSelections():
+                                self.rivers.append(rivers[curidx])
+                else:
+                    self.rivers = rivers
+
+        elif sel_rivers is not None:
+
+            for curruver in sel_rivers:
+                if curruver in rivers:
+                    self.rivers.append(curruver)
+                else:
+                    logging.error(f'River {curruver} not found in the database -- Ignoring !')
+
+        self._filter_db(bounds)
+
+        self.initialized = True
+
+    def _filter_db(self, bounds: list[list[float, float], list[float, float]] = None):
+        """ Filter the database based on the selected rivers and bounds.
+
+        :param bounds: The bounds of the area to display, if None, no test on coordinates will be done - [ [xmin, xmax], [ymin, ymax] ]
+        :type bounds: list[list[float, float], list[float, float]] | None
+        """
+
+        if len(self.rivers) == 0:
+            locdb = self.db
+        else:
+            locdb = self.db[self.db[ColNames_Ouvrages.RIVER.value].isin(self.rivers)]
+
+        for id, curline in tqdm(locdb.iterrows()):
+            river = curline[ColNames_Ouvrages.RIVER.value]
+
+            paths = []
+            for col in [ColNames_Ouvrages.PHOTO1,
+                        ColNames_Ouvrages.PHOTO2,
+                        ColNames_Ouvrages.PHOTO3,
+                        ColNames_Ouvrages.PHOTO4,
+                        ColNames_Ouvrages.PHOTO5,
+                        ColNames_Ouvrages.PHOTO6,
+                        ColNames_Ouvrages.PHOTO7,
+                        ColNames_Ouvrages.PHOTO8,
+                        ColNames_Ouvrages.PHOTO9,
+                        ColNames_Ouvrages.PHOTO10]:
+
+                fullpath = curline[col.value]
+
+                fullpath = fullpath.replace(r'\\192.168.2.185\Intranet\Data\Données et Photos de crues\Ouvrages',
+                                            str(self.filename.parent) +r'\Ouvrages')
+                if fullpath == '0':
+                    break
+
+                fullpath = Path(fullpath)
+
+                if fullpath.exists():
+                    paths.append(fullpath)
+                else:
+                    logging.debug(f'File {fullpath} does not exist')
+
+            if not paths:
+                logging.debug(f'No valid paths found for river {river} in the database')
+                continue
+
+            nb = len(paths)
+            x1 = curline[ColNames_Ouvrages.X1.value]
+            x2 = curline[ColNames_Ouvrages.X2.value]
+            y1 = curline[ColNames_Ouvrages.Y1.value]
+            y2 = curline[ColNames_Ouvrages.Y2.value]
+
+            keyzone = river.strip() + '_' + paths[0].stem
+            # make a mosaic - max 3 pictures per row
+
+            xref = (x1 + x2) / 2
+            yref = (y1 + y2) / 2
+
+            if bounds is not None and not _test_bounds(xref, yref, bounds):
+                logging.debug(f'Coordinates are out of bounds -- Skipping line {id}')
+                continue
+
+            for i in range(nb):
+                picture = paths[i]
+
+                x = xref + (i % 3)  * self._default_size
+                y = yref + (i // 3) * self._default_size
+
+                if x < 1000. and y < 1000.:
+                    logging.error(f'Coordinates for river {river} are not set -- Skipping picture {picture}')
+                    continue
+
+                self.add_picture(picture, x=x, y=y, name=picture.stem, keyzone=keyzone)
+
+                pic = self[(keyzone, picture.stem)]
+                pic.myprop.legendtext = _sanitize_legendtext(curline[ColNames_Ouvrages.REMARK.value])
+                pic.myprop.legendx = pic.centroid.x
+                pic.myprop.legendy = pic.centroid.y
+                pic.myprop.legendpriority = Font_Priority.WIDTH
+                pic.myprop.legendlength = 100
+
+        self.find_minmax(True)
+
+class Particularites(Ouvrages):
+    """ Class to handle the "Particularités" -- Pictures of the particularities in the ZI. """
+
+    def __init__(self, parent=None, idx = '', plotted = True, mapviewer=None, rivers = None):
+        super().__init__(parent = parent, idx = idx, plotted = plotted, mapviewer = mapviewer, rivers = rivers)
+
+        self._columns = ColNames_Particularites
+
+    def read_db(self, filename:str | Path,
+                sel_rivers: list[str] = None,
+                sheet_name: str = 'Particularités',
+                bounds: list[list[float, float], list[float, float]] = None):
+        """ Read the database (Excel file) and create the zones and the vectors.
+
+        The user will be prompted to select the rivers to display.
+
+        :param filename: The path to the Excel file containing the database
+        :type filename: str | Path
+        :param sel_rivers: The list of rivers to display, if None, the user will be prompted to select the rivers
+        :type sel_rivers: list[str] | None
+        :param sheet_name: The name of the sheet in the Excel file to read
+        :type sheet_name: str
+        :param bounds: The bounds of the area to display, if None, no test on coordinates will be done - [ [xmin, xmax], [ymin, ymax] ]
+        :type bounds: list[list[float, float], list[float, float]] | None
+        """
+
+        self.filename = Path(filename)
+
+        if not self.filename.exists() or filename == '':
+
+            if self.wx_exists:
+
+                dlg= wx.FileDialog(None, _("Choose a file"), defaultDir= "", wildcard="Excel (*.xlsx)|*.xlsx", style = wx.FD_OPEN)
+                ret = dlg.ShowModal()
+                if ret == wx.ID_OK:
+                    self.filename = Path(dlg.GetPath())
+                    dlg.Destroy()
+                else:
+                    logging.error('No file selected')
+                    dlg.Destroy()
+                    return
+
+            else:
+                logging.error('No file selected or the file does not exist.')
+                return
+
+        try:
+            logging.info(f'Reading database from {self.filename}')
+            self.db = pd.read_excel(self.filename, sheet_name=sheet_name)
+            logging.info(f'Database read successfully from {self.filename}')
+        except ValueError as e:
+            logging.error(f"Error reading the Excel file: {e}")
+            return
+
+        rivers = list(self.db[ColNames_Particularites.RIVER.value].unique())
+        rivers.sort()
+
+        self.rivers = []
+
+        if sel_rivers is None and self.wx_exists:
+
+            with wx.MessageDialog(None, _("Choose the rivers to display"), _("Rivers"), wx.YES_NO | wx.ICON_QUESTION) as dlg:
+
+                if dlg.ShowModal() == wx.ID_YES:
+
+                    with wx.MultiChoiceDialog(None, _("Choose the rivers to display"), _("Rivers"), rivers) as dlg_river:
+                        ret = dlg_river.ShowModal()
+
+                        if ret == wx.ID_OK:
+                            for curidx in dlg_river.GetSelections():
+                                self.rivers.append(rivers[curidx])
+                else:
+                    self.rivers = rivers
+
+        elif sel_rivers is not None:
+
+            for curruver in sel_rivers:
+                if curruver in rivers:
+                    self.rivers.append(curruver)
+                else:
+                    logging.error(f'River {curruver} not found in the database -- Ignoring !')
+
+        self._filter_db(bounds)
+
+        self.initialized = True
+
+    def _filter_db(self, bounds: list[list[float, float], list[float, float]] = None):
+        """ Filter the database based on the selected rivers and bounds.
+
+        :param bounds: The bounds of the area to display, if None, no test on coordinates will be done - [ [xmin, xmax], [ymin, ymax] ]
+        :type bounds: list[list[float, float], list[float, float]] |
+        """
+
+        if len(self.rivers) == 0:
+            locdb = self.db
+        else:
+            locdb = self.db[self.db[ColNames_Particularites.RIVER.value].isin(self.rivers)]
+
+        for id, curline in tqdm(locdb.iterrows()):
+            river = curline[ColNames_Particularites.RIVER.value]
+
+            paths = []
+            for col in [ColNames_Particularites.PHOTO1,
+                        ColNames_Particularites.PHOTO2,
+                        ColNames_Particularites.PHOTO3,
+                        ColNames_Particularites.PHOTO4,
+                        ColNames_Particularites.PHOTO5]:
+
+                fullpath = curline[col.value]
+
+                fullpath = fullpath.replace(r'\\192.168.2.185\Intranet\Data\Données et Photos de crues',
+                                            str(self.filename.parent))
+                fullpath = Path(fullpath)
+
+                if fullpath.exists():
+                    paths.append(fullpath)
+                else:
+                    logging.debug(f'File {fullpath} does not exist')
+
+            if not paths:
+                logging.debug(f'No valid paths found for river {river} in the database')
+                continue
+
+            nb = len(paths)
+            xref = curline[ColNames_Particularites.X.value]
+            yref = curline[ColNames_Particularites.Y.value]
+
+            keyzone = river.strip() + '_' + paths[0].stem
+            # make a mosaic - max 3 pictures per row
+
+            if bounds is not None and not _test_bounds(xref, yref, bounds):
+                logging.info(f'Coordinates are out of bounds -- Skipping line {id}')
+                continue
+
+            for i in range(nb):
+                picture = paths[i]
+                x = xref + (i % 3)  * self._default_size
+                y = yref + (i // 3) * self._default_size
+
+                self.add_picture(picture, x=x, y=y, name=picture.stem, keyzone=keyzone)
+
+                pic = self[(keyzone, picture.stem)]
+                pic.myprop.legendtext = _sanitize_legendtext(curline[ColNames_Particularites.REMARK.value])
+                pic.myprop.legendx = pic.centroid.x
+                pic.myprop.legendy = pic.centroid.y
+                pic.myprop.legendpriority = Font_Priority.WIDTH
+                pic.myprop.legendlength = 100
+
+
+        self.find_minmax(True)
+
+class Enquetes(Ouvrages):
+    """ Class to handle the "Enquêtes" -- Pictures of the surveys in the ZI. """
+    def __init__(self, parent=None, idx = '', plotted = True, mapviewer=None, rivers = None):
+        super().__init__(parent = parent, idx = idx, plotted = plotted, mapviewer = mapviewer, rivers = rivers)
+
+        self._columns = ColNames_Enquetes
+
+    def read_db(self, filename:str | Path,
+                sel_rivers: list[str] = None,
+                sheet_name: str = 'Photos',
+                bounds: list[list[float, float], list[float, float]] = None):
+        """ Read the database (Excel file) and create the zones and the vectors.
+
+        The user will be prompted to select the rivers to display.
+
+        :param filename: The path to the Excel file containing the database
+        :type filename: str | Path
+        :param sel_rivers: The list of rivers to display, if None, the user will be prompted to select the rivers
+        :type sel_rivers: list[str] | None
+        :param sheet_name: The name of the sheet in the Excel file to read
+        :type sheet_name: str
+        :param bounds: The bounds of the area to display, if None, no test on coordinates will be done - [ [xmin, xmax], [ymin, ymax] ]
+        :type bounds: list[list[float, float], list[float, float]] |
+        """
+
+        self.filename = Path(filename)
+
+        if not self.filename.exists() or filename == '':
+
+            if self.wx_exists:
+
+                dlg= wx.FileDialog(None, _("Choose a file"), defaultDir= "", wildcard="Excel (*.xlsx)|*.xlsx", style = wx.FD_OPEN)
+                ret = dlg.ShowModal()
+                if ret == wx.ID_OK:
+                    self.filename = Path(dlg.GetPath())
+                    dlg.Destroy()
+                else:
+                    logging.error('No file selected')
+                    dlg.Destroy()
+                    return
+
+            else:
+                logging.error('No file selected or the file does not exist.')
+                return
+
+        try:
+            logging.info(f'Reading database from {self.filename}')
+            self.db = pd.read_excel(self.filename, sheet_name=sheet_name)
+            logging.info(f'Database read successfully from {self.filename}')
+        except ValueError as e:
+            logging.error(f"Error reading the Excel file: {e}")
+            return
+
+        rivers = list(self.db[ColNames_Enquetes.RIVER.value].unique())
+        rivers.sort()
+
+        self.rivers = []
+
+        if sel_rivers is None and self.wx_exists:
+
+            with wx.MessageDialog(None, _("Choose the rivers to display"), _("Rivers"), wx.YES_NO | wx.ICON_QUESTION) as dlg:
+
+                if dlg.ShowModal() == wx.ID_YES:
+
+                    with wx.MultiChoiceDialog(None, _("Choose the rivers to display"), _("Rivers"), rivers) as dlg_river:
+                        ret = dlg_river.ShowModal()
+
+                        if ret == wx.ID_OK:
+                            for curidx in dlg_river.GetSelections():
+                                self.rivers.append(rivers[curidx])
+                else:
+                    self.rivers = rivers
+
+        elif sel_rivers is not None:
+
+            for curruver in sel_rivers:
+                if curruver in rivers:
+                    self.rivers.append(curruver)
+                else:
+                    logging.error(f'River {curruver} not found in the database -- Ignoring !')
+
+        self._filter_db(bounds)
+
+        self.initialized = True
+
+    def _filter_db(self, bounds: list[list[float, float], list[float, float]] = None):
+        """ Filter the database based on the selected rivers and bounds.
+
+        :param bounds: The bounds of the area to display, if None, no test on coordinates will be done - [ [xmin, xmax], [ymin, ymax] ]
+        :type bounds: list[list[float, float], list[float, float]] |
+        """
+
+        if len(self.rivers) == 0:
+            locdb = self.db
+        else:
+            locdb = self.db[self.db[ColNames_Enquetes.RIVER.value].isin(self.rivers)]
+
+        for id, curline in tqdm(locdb.iterrows()):
+            river = curline[ColNames_Enquetes.RIVER.value]
+
+            fullpath = curline[ColNames_Enquetes.PHOTO.value]
+
+            fullpath = fullpath.replace(r'\\192.168.2.185\Intranet\Data\Données et Photos de crues',
+                                        str(self.filename.parent))
+            fullpath = Path(fullpath)
+
+            if not fullpath.exists():
+                logging.debug(f'File {fullpath} does not exist')
+                continue
+
+            x = curline[ColNames_Enquetes.X.value]
+            y = curline[ColNames_Enquetes.Y.value]
+
+            if bounds is not None and not _test_bounds(x, y, bounds):
+                logging.info(f'Coordinates are out of bounds -- Skipping line {id}')
+                continue
+
+            keyzone = river.strip()
+
+            picture = fullpath
+            self.add_picture(picture, x=x, y=y, name=picture.stem, keyzone=keyzone)
+
+            pic = self[(keyzone, picture.stem)]
+            pic.myprop.legendtext = _sanitize_legendtext(curline[ColNames_Enquetes.DATE.value])
+            pic.myprop.legendx = pic.centroid.x
+            pic.myprop.legendy = pic.centroid.y
+            pic.myprop.legendpriority = Font_Priority.WIDTH
+            pic.myprop.legendlength = 100
+
+
+        self.find_minmax(True)

{wolfhece-2.2.32.dist-info → wolfhece-2.2.34.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wolfhece
-Version: 2.2.32
+Version: 2.2.34
 Author-email: Pierre Archambeau <pierre.archambeau@uliege.be>
 Project-URL: Homepage, https://uee.uliege.be/hece
 Project-URL: Issues, https://uee.uliege.be/hece