wolfhece.PyDraw

Author: HECE - University of Liege, Pierre Archambeau Date: 2024

Copyright (c) 2024 University of Liege. All rights reserved.

This script and its content are protected by copyright law. Unauthorized copying or distribution of this file, via any medium, is strictly prohibited.

Module Contents

wolfhece.PyDraw.msg

wolfhece.PyDraw.ID_SELECTCS = 1000

wolfhece.PyDraw.ID_SORTALONG = 1001

wolfhece.PyDraw.ID_LOCMINMAX = 1002

wolfhece.PyDraw.ID_PLOTCS = 1003

wolfhece.PyDraw.LIST_1TO9

class wolfhece.PyDraw.draw_type

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

ARRAYS = 'arrays'

BRIDGES = 'bridges'

WEIRS = 'weirs'

VECTORS = 'vectors'

CLOUD = 'clouds'

TRIANGULATION = 'triangulations'

PARTICLE_SYSTEM = 'particle systems'

CROSS_SECTIONS = 'cross_sections'

OTHER = 'others'

VIEWS = 'views'

RES2D = 'wolf2d'

WMSBACK = 'wms-background'

WMSFORE = 'wms-foreground'

TILES = 'tiles'

class wolfhece.PyDraw.Colors_1to9(parent)

Bases: wx.Frame

property directory

property file

change_colors(e)

Apply()

OnOK(event)

OnCancel(event)

OnSetDefault(event)

OnSave(event)

OnLoad(event)

class wolfhece.PyDraw.DragdropFileTarget(window: WolfMapViewer)

Bases: wx.FileDropTarget

OnDropFiles(x, y, filenames)

class wolfhece.PyDraw.WolfMapViewer(wxparent=None, title: str = _('Default Wolf Map Viewer'), w: int = 500, h: int = 500, treewidth: int = 200, wolfparent=None, wxlogging=None)

Bases: wx.Frame

Fenêtre de visualisation de données WOLF grâce aux WxWidgets

property wxlogging

property bkg_color

Return the background color from configs

property ticks_size: float

Return the ticks spacing from configs

property ticks_bounds: bool

Return the ticks bounds from configs

property palette_for_copy: wolfhece.PyPalette.wolfpalette

Return the palette for copy from configs

TIMER_ID = 100

mybc: list[wolfhece.mesh2d.bc_manager.BcManager]

myarrays: list

myvectors: list[wolfhece.PyVertexvectors.Zones]

myclouds: list[wolfhece.PyVertex.cloud_vertices]

mytri: list[wolfhece.PyVertexvectors.Triangulation]

myothers: list

myviews: list[wolfhece.wolfresults_2D.views_2D]

mywmsback: list

mywmsfore: list

myres2D: list

mytiles: list[wolfhece.wolf_tiles.Tiles]

mypartsystems: list[wolfhece.lagrangian.particle_system_ui.Particle_system_to_draw]

myviewers3d: list[wolfhece.opengl.py3d.Wolf_Viewer3D]

canvas: wx.glcanvas.GLCanvas

context: wx.glcanvas.GLContext

mytooltip: wolfhece.PyVertexvectors.Wolf_Param

treelist: wx.dataview.TreeListCtrl

_lbl_selecteditem: wx.core.StaticText

leftbox: wx.core.BoxSizer

active_vector: wolfhece.PyVertexvectors.vector

active_zone: wolfhece.PyVertexvectors.zone

active_zones: wolfhece.PyVertexvectors.Zones

active_array: wolfhece.wolf_array.WolfArray

active_bc: wolfhece.mesh2d.bc_manager.BcManager

active_view: wolfhece.pyviews.WolfViews

active_vertex: wolfhece.PyVertexvectors.wolfvertex

active_cs: wolfhece.PyCrosssections.crosssections

active_tri: wolfhece.PyVertexvectors.Triangulation

active_tile: wolfhece.wolf_tiles.Tiles

active_particle_system: wolfhece.lagrangian.particle_system_ui.Particle_system_to_draw

active_viewer3d: wolfhece.opengl.py3d.Wolf_Viewer3D

check_logging()

Check if logging window is shown

check_tooltip()

Check if tooltip window is shown

open_hydrological_model()

Open a hydrological model

create_2D_MB_model()

Create a 2D model

check_2D_MB_headers()

Check headers of a 2D simulation without opening viewer

get_mapviewer()

Retourne une instance WolfMapViewer

do_quit()

create_cloud_menu()

get_choices_arrays()

Boîte de dialogue permettant de choisir une ou plusieurs matrices parmi celles chargées

menu_tiles()

Menu for tiles

pick_tile(event: wx.Event)

create_data_from_tiles_activevec(event: wx.Event)

_create_data_from_tiles_common()

create_data_from_tiles_tmpvec(event: wx.Event)

menu_laz()

Menu for LAZ Data

menu_wolf2d()

menu_walous()

get_canvas_bounds(gridsize: float = None)

Retourne les limites de la zone d’affichage

Returns:

[xmin, ymin, xmax, ymax]

Onmenuwalous(event: wx.MenuEvent)

Onmenuwolf2d(event: wx.MenuEvent)

menu_2dgpu()

menu_landmaps()

change_transparent_color_landmap(event: wx.Event)

set_tolerance_landmap(event: wx.Event)

change_colors_landmap(event: wx.Event)

pick_landmap_full(event: wx.Event)

pick_landmap_low(event: wx.Event)

menu_particlesystem()

action_menu_particlesystem(event: wx.Event)

Action to perform when the timer is triggered

update_particlesystem(event: wx.Event)

Animation of the particle system

menu_sim2D()

Menu for 2D simulations

Onmenusim2D(event: wx.MenuEvent)

Action to perform whern menu 2D entry is selected

get_configuration() → OpenGL.GLUT.Union[wolfhece.PyConfig.WolfConfiguration, None]

Get global configuration parameters

GlobalOptionsDialog(event)

triangulate_cs()

interpolate_cloud()

Interpolation d’un nuage de point sur une matrice

Il est possible d’utiliser une autre valeur que la coordonnées Z des vertices

interpolate_cs()

interpolate_triangulation()

compare_cloud2array()

Compare the active cloud points to the active array

compare_tri2array()

copy_canvasogl(mpl: bool = True, ds: float = 0.0, figsizes=[10.0, 10.0], palette: wolfhece.PyPalette.wolfpalette = None)

Generate image based on UI context and copy to the Clipboard

Parameters:

mpl (bool, optional) – Using Matplolib as renderer. Defaults to True.

Parem ds:

Ticks size. Defaults to 0..

Parem figsizes:

fig size in inches

display_canvasogl(mpl=True, ds=0.0, fig: wolfhece.PyVertexvectors.Figure = None, ax: wolfhece.PyVertexvectors.Axes = None, clear=True, redraw=True, palette=False, title='')

This method takes a matplotlib figure and axe and, returns a clear screenshot of the information displayed in the wolfpy GUI.

get_mpl_plot(center=[0.0, 0.0], width=500.0, height=500.0, title='', toshow=True) → tuple[wolfhece.PyVertexvectors.Figure, wolfhece.PyVertexvectors.Axes]

Récupère un graphique matplotlib sur base de la fenêtre OpenGL et de la palette de la matrice/résultat actif.

create_video(fn: str = '', framerate: int = 0, start_step: int = 0, end_step: int = 0, every: int = 0)

Création d’une vidéo sur base des résultats

get_canvas_as_image() → PIL.Image.Image

Récupère la fenêtre OpenGL sous forme d’image

save_canvasogl(fn: str = '', mpl: bool = True, ds: float = 0.0, dpi: int = 300)

Sauvegarde de la fenêtre d’affichage dans un fichier

Parameters:

• fn – File name (.png or .jpg file)

• mpl – Using Matplotlib as renderer

• ds – Ticks interval

reporting(dir='')

Firsdt attempr to create a reporting. !! Must be improved !!

InitUI()

Initialisation de l’interface utilisateur

OnSize(e)

Redimensionnement de la fenêtre

ManageActions(id)

Gestion des actions via les menus

TODO : A généraliser?

center_view_on(cx, cy)

Center the view on the point of (map) coordinates (x,y)

setbounds(updatescale=True)

Calcule les limites visibles de la fenêtrte graphique sur base des facteurs d’échelle courants

setsizecanvas(width, height)

Redimensionne la fenêtre graphique

updatescalefactors()

Mise à jour des facteurs d’échelle This one updates the scale factors based on the relative sizes of the GLCanvas and the footprint that should fit in it.

add_viewer_and_link()

Ajout d’une nouvelle fenêtre de visualisation et liaison avec la fenêtre courante

add_grid()

Ajout d’une grille

add_WMS()

Ajout de couches WMS

set_compare(ListArrays: list[wolfhece.wolf_array.WolfArray] = None, share_colormap: bool = True)

Comparison of 2 arrays

Parameters:

• ListArrays – List of 2 arrays to compare

• share_colormap – Share the colormap between the 2 arrays

set_compare_all(ListArrays=None, names: WolfMapViewer.set_compare_all.list[str] = None)

Comparison of 2 or 3 arrays

set_blender_sculpting()

Mise en place de la structure nécessaire pour comparer la donnée de base avec la donnée sculptée sous Blender

La donnée de base est la matrice contenue dans la fenêtre actuelle

Fenêtres additionnelles :

• information sur les volumes de déblai/remblai et bilan

• matrice sculptée

• différentiel entre scultage - source

• gradient

• laplacien

• masque de modification

update_blender_sculpting()

Mise à jour des fenêtres de visualisation pour la comparaison avec Blender

zoomon_activevector(size: float = 500.0, forceupdate: bool = True)

Zoom on active vector

Parameters:

• size – size of the zoomed window

• forceupdate – force the update of the window

zoomon_active_vertex(size: float = 20, forceupdate: bool = True)

Zoom on active vertex.

Parameters:

• size – size of the zoomed window

• forceupdate – force the update of the window

zoom_on_id(id: str, drawtype: draw_type = draw_type.ARRAYS, forceupdate=True, canvas_height=1024)

Zoom on id

Parameters:

• id – id of the object to zoom on

• drawtype – type of object to zoom on - Different types elements can have the same id

zoom_on_array(array: wolfhece.wolf_array.WolfArray, forceupdate=True, canvas_height=1024)

Zoom on array

zoom_on_vector(vector: WolfMapViewer.zoom_on_vector.vector, forceupdate=True, canvas_height=1024)

Zoom on vector

create_Zones_from_arrays(arrays: list[wolfhece.wolf_array.WolfArray], id: str = None, add_legend: bool = True) → wolfhece.PyVertexvectors.Zones

Create a Zones instance from list of WolfArrays

One zone per array.

One vector per zone with the masked contour.

Parameters:

• arrays – list of WolfArrays

• id – id of the Zones instance

• add_legend – add legend to the vector – centroid of the contour

zoom_on(zoom_dict=None, width=500, height=500, center=None, xll=None, yll=None, forceupdate=True, canvas_height=1024)

Zoom on a specific area

It is possible to zoom on a specific area by providing the zoom parameters in :

• a dictionnary

• width and height of the zoomed window and the lower left corner coordinates

• width and height of the zoomed window and the center coordinates

Parameters:

• zoom_dict – dictionnary containing the zoom parameters - possible keys : ‘width’, ‘height’, ‘center’, ‘xmin’, ‘ymin’, ‘xmax’, ‘ymax’

• width – width of the zoomed window [m]

• height – height of the zoomed window [m]

• center – center of the zoomed window [m] - tuple (x,y)

• xll – lower left X coordinate of the zoomed window [m]

• yll – lower left Y coordinate of the zoomed window [m]

• forceupdate – force the update of the window

• canvas_height – height of the canvas [pixels]

Examples :

• zoom_on(zoom_dict = {‘center’:(500,500), ‘width’:1000, ‘height’:1000})

• zoom_on(width = 1000, height = 1000, xll = 500, yll = 500)

• zoom_on(width = 1000, height = 1000, center = (500,500))

zoom_on_active_profile(size: float = 500.0, forceupdate: bool = True)

Zoom on active profile

read_project(fn)

Projet WOLF GUI

Fichier de paramètres contenant les types et chemins d’accès aux données à ajouter

A compléter…

save_project(fn)

plot_laz_around_active_vec()

clip_laz_gridded()

Clip laz grid on current zoom

select_active_array_from_laz(array: wolfhece.wolf_array.WolfArray = None, used_codes: list = None, chunk_size: float = 500.0)

select some nodes from laz data

Parameters:

• array – array to fill

• used_codes – codes to use

fill_active_array_from_laz(array: wolfhece.wolf_array.WolfArray = None, used_codes: list = [], operator: int = -1, chunk_size: float = 500.0)

Fill active array with laz data

Parameters:

• array – array to fill

• used_codes – codes to use

• operator – operator to use

count_active_array_from_laz(array: wolfhece.wolf_array.WolfArray = None, used_codes: list = [], chunk_size: float = 500.0)

Fill active array with laz data

Parameters:

• array – array to fill

• used_codes – codes to use

• operator – operator to use

init_laz_from_numpy(fn=None)

Read LAZ data stored in numpy array

init_laz_from_gridinfos(dirlaz: str = None)

managebanks()

_set_fn_fnpos_gltf()

Définition du nom de fichier GLTF/GLB à lire pour réaliser la comparaison Utilisation d’une fenêtre de dialogue WX

Cette fonction n’est a priori appelée que depuis set_fn_fnpos_gltf

set_fn_fnpos_gltf()

Définition ou récupération du nom de fichier GLTF/GLB à lire pour réaliser la comparaison

Le nom de fichier est stocké dans la liste des paramètres partagés de façon à ce que l’appel de mise à jour puisse s’effectuer dans n’importe quel frame

read_last_result()

Lecture du dernier résultat pour les modèles ajoutés et plottés

read_one_result(which: int)

Lecture d’un résultat spécific pour les modèles ajoutés et plottés

simul_previous_step()

Mise à jour au pas précédent

particle_next_step()

Mise à jour au pas suivant

particle_previous_step()

Mise à jour au pas précédent

simul_next_step()

Mise à jour au pas suivant

OnMenuHighlight(event: wx.MenuEvent)

_select_laz_source()

Select laz source

OnMenubar(event: wx.MenuEvent)

Gestion des clicks sur le menu quel que soit le niveau

Idée générale :

• récupérer le label du menu sur base de l’id de l’event WX passé en argument –> itemlabel

• tester le label du menu sur base de la chaîne traduite

• a priori appeler une autre routine spécifique au traitement choisi

• éviter autant que possible de coder des fonctions directement dans cette routine ce qui la rendrait complexe à lire

AUTRE POSSIBILITE:

• mettre en place un dictionnaire avec key==label, value==action qui se contenterait de tester la présence du label dans les clés et d’appeler l’action

• dans ce dernier cas, il faudrait que les routines possèdent idéalement une interface unique

pop_boundary_manager(which: wolfhece.mesh2d.bc_manager.BcManager)

Pop a boundary condition manager after Destroying

get_boundary_manager(which: wolfhece.wolf_array.WolfArray)

Get a boundary manager

uniquecolormap(loadfromfile=False)

Compute unique colormap from all (arrays, 2D results) and apply it to all

loadnap_and_apply()

uniforminparts_all(TrueOrFalse: bool)

filter_inundation()

export_results_as(which='geotiff')

Export des résultats WOLF2D vers le format GeoTiff On attend que les matrices “.hbin” aient été chargées dans l’interface

TODO : Modifier la routine pour prendre les classe de résultats 2D

export_shape(outdir='', fn='', myarrays=[], descr=[], mask: wolfhece.wolf_array.WolfArray = None)

Export multiple arrays to shapefile

Parameters:

• outdir – output directory

• fn – filename – .shp will be added if not present

• myarrays – list of Wolfarrays to export

• descr – list of descriptions

• mask – mask array – export only where mask > 0

export_geotif(outdir='', fn='', myarrays=[], descr=[])

Export multiple arrays to geotiff

Parameters:

• outdir – output directory

• fn – filename – .tif will be added if not present

• myarrays – list of Wolfarrays to export

• descr – list of descriptions – Bands names

get_linked_arrays(linked: bool = True) → dict

Get all arrays in the viewer and linked viewers

save_linked_canvas(fn, mpl=True, ds=0.0)

Save canvas of all linked viewers

thread_update_blender()

add_object(which: Literal[array, array_lidar_first, array_lidar_second, array_xyz, array_tiles, bridges, weirs, wolfhece.PyVertexvectors.vector, tiles, tilescompcloud, triangulation, cross_sections, other, views, res2d, res2d_gpu, particlesystem, wmsback, wmsfore] = 'array', filename='', newobj=None, ToCheck=True, id='')

Add object to current Frame/Drawing area

get_obj_from_treeitem(treeitem)

Find the object associated with treeitem

getobj_from_id(id: str)

Find the object associated with id

get_obj_from_id(id: str, drawtype: draw_type)

Find the object associated with id in a specifid drawtype

If you want to search in all drawtypes, use getobj_from_id instead.

Parameters:

• id – str : id of the object

• drawtype – draw_type : type of object to search

_get_list(drawing_type: draw_type)

return the list of objects of type drawing_type

get_list_keys(drawing_type: draw_type, checked_state: bool = True)

Create a list of keys of type draw_type

get_list_objects(drawing_type: draw_type, checked_state: bool = True)

Create a list of objects of type draw_type

single_choice_key(draw_type: WolfMapViewer.single_choice_key.draw_type, checked_state: bool = True, message: str = _('Make a choice'), title: str = _('Choice'))

Create wx dialog to choose a key object of type draw_type

single_choice_object(draw_type: WolfMapViewer.single_choice_object.draw_type, checked_state: bool = True, message: str = _('Make a choice'), title: str = _('Choice'))

Create wx dialog to choose an object of type draw_type

multiple_choice_key(draw_type: WolfMapViewer.multiple_choice_key.draw_type, checked_state: bool = True, message: str = _('Make a choice'), title: str = _('Choice'))

Create wx dialog to choose multiple keys object of type draw_type

multiple_choice_object(draw_type: WolfMapViewer.multiple_choice_object.draw_type, checked_state: bool = True, message: str = _('Make a choice'), title: str = _('Choice'))

Create wx dialog to choose multiple objects of type draw_type

iterator_over_objects(drawing_type: draw_type, checked_state: bool = True)

Create iterator over objects of type draw_type

gettreeitem(obj)

Find the tree item associated with obj

removeobj()

Remove selected item from general tree

removeobj_from_id(id: str)

Remove object from id

upobj()

Up selected item into general tree

downobj()

Down selected item into general tree

OnShowPopup(event)

OnPopupItemSelected(event)

Action to do when an item is selected in the popup menu

OnClose(event)

Close the application

OnSelectItem(event)

Select the item in the tree list

OnCheckItem(event: TreeListEvent)

Check the item in the tree list

getXY(pospix)

OnZoomGesture(e)

OnLeave(e)

get_cross_sections()

Récupération du premier objet crosssections disponible

set_active_profile(active_profile: wolfhece.PyCrosssections.profile)

This method sets the active profile in Pydraw (useful for interfaces communication).

set_active_vector(active_vector: wolfhece.PyVertexvectors.vector)

This method sets the active vector in Pydraw (useful for interfaces communication).

get_active_profile()

This methods returns the active profile in pydraw (useful for interfaces communication).

plot_cross(x: float, y: float)

OnRightDown(e: wx.MouseEvent)

Event when the right button of the mouse is pressed.

We use this event to manage “action” set by others objects.

OnRightUp(e)

OnButton(e: wx.MouseEvent)

OnRDClick(e)

OnLDClick(e: wx.MouseEvent)

OnLDown(e)

_set_active_bc()

Search and activate BCManager according to active_array

set_statusbar_text(txt: str)

Set the status bar text

set_label_selecteditem(nameitem: str)

Set the label of the selected item in the tree list

get_label_selecteditem()

Get the label of the selected item in the tree list

OnActivateTreeElem(e)

Activate the selected item in the tree list

_update_mytooltip()

Update the tooltip with the values of the active arrays and results at position x,y

OnMotion(e: wx.MouseEvent)

Mouse move event

Autoscale(update_backfore=True)

Redimensionnement de la fenêtre pour afficher tous les objets

_endactions()

End of actions

Call when the user double click on the right button of the mouse or press return.

Depending on the action, the method will call differnt routines and refresh the figure.

Each action must call self.end_action() to nullify the action and print a message.

print_About()

Print the About window

check_for_updates()

Check for updates

print_shortcuts(inframe: bool = None)

Print the list of shortcuts into logging

msg_action(which: int = 0)

Message to end action

start_action(action: str, message: str = '')

Message to start action

end_action(message: str = '')

Message to end action

OnHotKey(e: wx.KeyEvent)

Gestion des touches clavier – see print_shortcuts for more details

paste_values(fromarray: wolfhece.wolf_array.WolfArray)

Paste selected values from a WolfArray to the active array

paste_selxy(fromarray: wolfhece.wolf_array.WolfArray)

Paste selected nodes from a WolfArray to the active array

OntreeRight(e: wx.MouseEvent)

Gestion du menu contextuel sur l’arbre des objets

update()

Update backgournd et foreground elements and arrays if local minmax is checked.

_plotting(drawing_type: draw_type, checked_state: bool = True)

Drawing objets on canvas

get_MVP_Viewport_matrix()

Get the modelview projection matrix

SetCurrentContext()

Set the current OGL context if exists otherwise return False

_set_gl_projection_matrix()

Paint()

Dessin des éléments ajoutés au viewer

OnPaint(e)

event handler for paint event

findminmax(force=False)

Find min/max of all objects

resizeFrame(w: int, h: int)

Resize the frame

Parameters:

• w – width in pixels

• h – height in pixels

mimicme()

Report des caractéristiques de la fenêtre sur les autres éléments liés

mimicme_copyfrom()

Active_vector(vect)

Active un vecteur et sa zone parent si existante

Active_zone(zone: WolfMapViewer.Active_zone.zone)

Active une zone et son parent si existant

list_background()

list_foreground()

check_id(id=str, gridsize=100.0)

Check an element from its id

uncheck_id(id=str, unload=True, forceresetOGL=True, askquestion=False)

Uncheck an element from its id

get_current_zoom()

Get the current zoom

Returns:

dict with keys ‘center’, ‘xmin’, ‘xmax’, ‘ymin’, ‘ymax’, ‘width’, ‘height’

save_current_zoom(filepath)

Save the current zoom in a json file

read_current_zoom(filepath)

Read the current zoom from a json file

class wolfhece.PyDraw.Comp_Type

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

ARRAYS = 1

ARRAYS_MB = 2

RES2D = 3

RES2D_GPU = 4

class wolfhece.PyDraw.Compare_Arrays_Results(parent: WolfMapViewer = None, share_cmap_array: bool = False, share_cmap_diff: bool = False)

_check_type(file: pathlib.Path)

Check the type of the file/directory

If it is a file and suffix is empty, it is considered as RES2D. If it is a directory and contains a simul_gpu_results, it is considered as RES2D_GPU. If it is a file and suffix is not empty, it is considered as ARRAYS. A check is done to see if it is a multi-block array.

add(file_or_dir: OpenGL.GLUT.Union[str, pathlib.Path] = None)

check()

Check the consystency of the elements to compare

update_comp(idx=list[int])

Update Arrays from 2D modellings

Parameters:

idx – indexes of the time step to update –> steps to read

update_type_result(newtype)

Update the result type for each element

set_elements()

Set the elements to compare with the right type

set_diff()

Set the differential between the elements and the first one, which is the reference

set_viewers(independent: bool = None)

Set viewers

set_shields_param(diamsize: float = 0.001, graindensity: float = 2.65)

Set the parameters for the shields diagram

update_viewers()

Update the viewers with the new elements

bake()