hydromodpy.display.visualization_results#
Copyright (C) 2023-2025 Alexandre Gauvain, Ronan Abhervé, Jean-Raynald de Dreuzy
This program and the accompanying materials are made available under the
terms of the Eclipse Public License 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
which is available at https://www.apache.org/licenses/LICENSE-2.0.
SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
- class hydromodpy.display.visualization_results.Visualization(watershed, modelname)[source]#
Bases:
objectClass to plot results by default.
Parameters#
- watershedobject
Variable object of the model domain (watershed). Created by geographic.
- modelnamestr
Name of the model simulation.
- visual2D(object_list: list = ['map', 'grid', 'watertable', 'watertable_depth', 'drain_flow', 'surface_flow', 'pathlines', 'residence_times'], color_scale=None, time_step=0, lines=100, structure='v')[source]#
Parameters#
- object_listlist
Select the simulation results you wish to plot.
- color_scalelist, optional
Boundary limits for color scale. The default is None.
- time_stepint, optional
Choice the stress period to plot. The default is 0.
- linesint, optional
Number of randomly selected pathlines to be traced. The default is 100.
- structurestr, optional
Structure of the frame figures ‘h’:horizontal or ‘v’: vertical. The default is ‘v’.
- visual3D(object_list=['grid', 'watertable'], view='south-west', bg='lb', interactive=False, lines=100, z_scale=20, render=1, cscale='default', cmin=-1, cmax=1, cloc=(0.65, 0.75), size=(1500, 1080))[source]#
3Dvisual shows the vtk objects from an interactive windows or a screenshot.
Parameters#
- object_listlist of str, optional
list of visualisation. possible options: grid, watertable, watertable_depth, pathlines, flux, acc_flux The default is [‘grid’, ‘watertable’].
- viewstr, optional
position of view to see the 3D visual. possible options: north, north-east, east, south-east, south, south-west, west, north-west The default is ‘south-west’.
- interactivebool, optional
activate the interactive window, if True the figure doesn’t save. The default is False.
- linesint, optional
the number of random pathlines displayed
- cloctuple, optional
Scalar bar location either as legacy (x, y) anchor or as ((x0, y0), (x1, y1)) bounding box.