wolfhece._sim_panels

Simulation explorer, video-creation, drowning, animation and DEM/DTM dialog classes extracted from PyDraw.py.

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

class wolfhece._sim_panels.Sim_Explorer(parent, title, mapviewer: wolfhece.PyDraw.WolfMapViewer, sim: wolfhece.wolfresults_2D.Wolfresults_2D)

Bases: wx.Frame

_panel

mapviewer

active_res2d: wolfhece.wolfresults_2D.Wolfresults_2D

_all_times_steps

_slider_steps

_label_idx

_step_idx

_label_time

_starting_date

_texttime

_step_time

_label_steps

_step_num

_cmd_apply

_cmd_update

_cmd_plot

_cmd_next

_cmd_prev

_mode

_interval

MinSize = (450, 500)

OnPlot(event)

Create a scatter plot of all steps.

Major x_axis is time in seconds, Minor X-axis is time by date.

Plots:

• Computation time step (Dt)

• Computation steps (N)

• Clock time (s)

• Mostly dry mesh (N)

OnInterval(event)

Change the interval

_find_next(idx: int)

Find the next step based on the mode and interval

_find_prev(idx: int)

Find the previous step based on the mode and interval

OnNext(event)

Go to the next step

OnPrev(event)

Go to the previous step

OnTextTime(event)

OnClose(event)

Close the simulation explorer

OnUpdate(event)

OnApply(event)

_set_all(idx: int)

Refresh(idx: int)

OnSliderSteps(event)

OnSelectCurTime(event)

OnSelectNumStep(event)

OnSelectIdxStep(event)

_update()

class wolfhece._sim_panels.Sim_VideoCreation(parent, title, mapviewer: wolfhece.PyDraw.WolfMapViewer, sim: wolfhece.wolfresults_2D.Wolfresults_2D)

Bases: wx.Dialog

mapviewer

active_res2d: wolfhece.wolfresults_2D.Wolfresults_2D

_framerate = 25

_start_step = 1

_end_step

_interval = 1

_fn = ''

_tz_ref

_tz_plot

_date_ref

_fontsize = 16

_fontcolor = (255, 255, 255, 255)

_timeposition = 'top-left'

tc1

btn_browse

tc2

tc3

tc4

tc5

tc7

tc8

tc9

btn1

btn2

check_date

calendar

timezone_ref

timezone_plot

OnBrowse(event)

Browse a file name to save the video

get_values()

Return the values set in the dialog

OnValidate(event)

Validate the text controls to be sure that the values are correct

OnOk(event)

Create the video file

OnCancel(event)

Cancel the video creation

class wolfhece._sim_panels.Drowning_Explorer(parent, title, mapviewer: any, sim: wolfhece.drowning_victims.drowning_class.Drowning_victim_Viewer)

Bases: wx.Frame

_panel

mapviewer

active_drowning: wolfhece.drowning_victims.drowning_class.Drowning_victim_Viewer

_all_times_steps

_slider_steps

_time_drowning

_label_time

_starting_date

_texttime

_step_time

_step_idx

_cmd_apply

_cmd_next

_cmd_prev

MinSize = (450, 500)

_find_next(idx: int)

Find the next step based on the mode and interval

_find_prev(idx: int)

Find the previous step based on the mode and interval

OnNext(event)

Go to the next step

OnTextTime(event)

OnPrev(event)

Go to the previous step

OnClose(event)

Close the simulation explorer

OnUpdate(event)

OnApply(event)

_set_all(idx: int)

Refresh(idx: int)

OnSliderSteps(event)

OnSelectNumStep(event)

OnSelectIdxStep(event)

_update()

class wolfhece._sim_panels.Select_Begin_end_interval_step(parent, title, sim: wolfhece.wolfresults_2D.Wolfresults_2D, checkbox: bool = False)

Bases: wx.Dialog

wx.frame to select the begin and end of the interval to extract

_panel

begin = 1

end

step = 1

check_all = True

check_violin = False

_slider_begin

_slider_end

_label_range

_text_range

_slider_step

_label_step

_text_step

_cmd_apply

_cmd_ok

_cmd_cancel

OnCheckAll(event)

OnCheckViolin(event)

OnSliderBegin(event)

OnSliderEnd(event)

OnSliderStep(event)

OnApply(event)

OnOK(event)

OnCancel(event)

class wolfhece._sim_panels.PrecomputedDEM_DTM(*args, **kwds)

Bases: enum.Enum

Enum for Precomputed DEM/DTM array

DEMDTM_50cm = 'AllData.vrt'

DEMDTM_1m_average = 'Combine_1m_average.vrt'

DEMDTM_1m_min = 'Combine_1m_minimum.vrt'

DEMDTM_1m_max = 'Combine_1m_maximum.vrt'

DEMDTM_2m_average = 'Combine_2m_average.vrt'

DEMDTM_2m_min = 'Combine_2m_minimum.vrt'

DEMDTM_2m_max = 'Combine_2m_maximum.vrt'

DEMDTM_5m_average = 'Combine_5m_average.vrt'

DEMDTM_5m_min = 'Combine_5m_minimum.vrt'

DEMDTM_5m_max = 'Combine_5m_maximum.vrt'

DEMDTM_10m_average = 'Combine_10m_average.vrt'

DEMDTM_10m_min = 'Combine_10m_minimum.vrt'

DEMDTM_10m_max = 'Combine_10m_maximum.vrt'

class wolfhece._sim_panels.Precomputed_DEM_DTM_Dialog(parent, title, directory: pathlib.Path | str, mapviewer: wolfhece.PyDraw.WolfMapViewer)

Bases: wx.Dialog

wx.Dialog to select Precomputed DEM/DTM array

Resolutions are 50cm, 1m, 2m, 5m, 10m Operators are average, min, max

_dir

_header = None

_vrt = None

_mapviewer

_panel

_res = ['50cm', '1m', '2m', '5m', '10m']

_ops = ['average', 'minimum', 'maximum']

_resolution

_operations

_cmd_sameactive

_cmd_sameas

_cmd_zoom

OnSameAs(event)

Set the Precomputed DEM/DTM array to the same bounds as an existing array

OnSameActive(event)

Set the Precomputed DEM/DTM array to the same bounds as the active array

OnZoom(event)

Set the Precomputed DEM/DTM array to the current zoom

property selected_vrt

add_array()

Add a new array to the viewer

OnSelectResolution(event)

Select the resolution

available_vrt()

List all available vrt files in the directory

class wolfhece._sim_panels.GlobalAnimationClock(mapviewer: wolfhece.PyDraw.WolfMapViewer)

Global animation clock manager for all zones with animations.

Replaces per-zone wx.Timer instances with a single centralized timer. This avoids flooding the wxPython event queue with redundant refresh events when dozens of zones are animated simultaneously.

Features: - Single ~30 fps timer for the entire WolfMapViewer - Zones register/unregister their animation needs - Adaptive throttling based on total animation load - On each tick, updates a shared time base and requests one redraw - Automatically stops the timer when no animations are active

_FPS_STEPS

mapviewer

timer: wx.Timer | None = None

subscribed_zones: dict[int, int]

current_time: float = 0.0

_timer_start_time: float | None = None

_interval_ms: int | None = None

property total_load: int

Return the total declared animation load across all zones.

subscribe(zone, load: int = 1)

Register a zone as animated with its estimated rendering load.

Automatically starts the timer if this is the first subscription.

unsubscribe(zone)

Unregister a zone from animation.

Automatically stops the timer if this was the last subscription.

_get_target_interval_ms() → int

Return the timer interval based on the current animation load.

_ensure_timer_state()

Start, stop, or retune the timer according to current load.

_start_timer(interval_ms: int)

Start the global animation timer.

_stop_timer()

Stop the global animation timer.

_on_timer_tick(event)

Handle timer tick: update time and request canvas refresh.

get_phase(anim_speed: float = 1.0) → float

Compute animation phase for a given speed.

Parameters:

anim_speed – Animation speed multiplier (default 1.0).

Returns:

Phase in range [0, 1), cycling at rate = anim_speed.

destroy()

Clean up the timer and disconnect.