6.1.2.7. thyrsis.plugin module¶
- class thyrsis.plugin.MinMaxUpdater(layer, result_control, time_control, scaleAutoUpdateCheckBox, parent=None)¶
Bases:
PyQt5.QtCore.QObject
Scale Updater
- autoUpdate(scratch=None)¶
Activate auto scale
- update(scratch=None)¶
Update min max value of the scale
- class thyrsis.plugin.Plugin(iface)¶
Bases:
PyQt5.QtWidgets.QWidget
Major class of Thyrsis plugin
- add_plots(point)¶
Add plots to the plot dock
- Parameters
point (QgsPoint) – click point
- checkProj()¶
Check if the project has the same projection as the data in the database
- composition()¶
Build a layout to create animation
- Returns
layout parameter
- Return type
dict
- createInjectionZones()¶
Create automatic injection zone from zones
- createIsovalues(pixels_per_meter=0)¶
Create isovalue from result layer
- Parameters
pixel_per_meter (int) – used for image output
- createLatinHypercube()¶
Open LatinHypercube dialog
- createMeshProjectDependantWidgets()¶
Create widgets that are dependant to a mesh project
- createProjectDependantWidgets()¶
Create widgets that are dependant to a project
- displayBoreHole(point)¶
Display borehole lithology
- Parameters
point (QgsPoint) – click point
- displayValue(point)¶
Display mesh value
- Parameters
point (QgsPoint) – click point
- exportAnimation(fil=None, composition=None, test=False)¶
Export project animation as a image file (if results layer exists)
- Parameters
fil (string) – file path
- exportRaster(fil=None)¶
Export the active layer as a image file
- exportTemplate(flag=None)¶
Export simulation template
- Parameters
flag (bool) – unused
- exportVideo(fil=None, composition=None, test=False)¶
Export project visualization as a video file (if results layer exists)
- importSite(flag)¶
Open dialog to create a new computational project
- Parameters
flag (bool) – unused
- initGui()¶
initGui function, do not rename it
- inverse(test=False)¶
Launch creation model with inversion
- Parameters
test (bool) – flag to use when no GUI
- inverse_plot()¶
Open hynverse result plot
- last_layout()¶
- layerWillBeRemoved(layerId)¶
Triggered when a layer will be removed
- Parameters
layerId (string) – layer id
- layersAdded(layers)¶
Triggered when layers are added
- Parameters
layers (list) – layers
- layout_watch(name)¶
- make_model()¶
Model creation dialog (from pilot point, permeability field or constant value
- maskUnits¶
- mesh()¶
Open mesh dialog, and then launch mesh process
- model_no_inverse(param, const=True, test=False)¶
Launch creation model without inversion
- Parameters
param (string or float) – perm parameter (raster or constant values)
const (bool) – flag for constant value use
test (bool) – flag to use when no GUI
- newMesh()¶
Open dialog to create a new mesh project and create mesh database
- openHelp()¶
Open the Help dialog
- openPreferences()¶
Open the Preference dialog
- openProject(flag=None)¶
Open QFileDialog to seek project
- Parameters
flag (bool) – unused
- pickBoreHoleToggled(checked)¶
Activate borehole maptool to display borehole lithology
- Parameters
checked (bool) – flag
- pickButtonToggled(flag)¶
Activate maptool to display mesh value
- Parameters
flag (bool) – flag
- plot(flag)¶
Display plot dock and activate maptool to display plot
- Parameters
flag (bool) – flag
- plot_bilan()¶
Display mass balance plot
- probability(seuil=None)¶
Create probability map, according to result layer and a threshold (several simulation are needed)
- qgisProjectLoaded(doc=None)¶
Triggered when a qgis project is loaded
- radionuclide()¶
- removeMeshProjectDependantWidgets()¶
Remove widgets that are dependant to a mesh project
- removeProjectDependantWidgets()¶
Delete widgets that are dependant to a mesh project
- runSimulation(init=True, run=True)¶
Launch simultation
- Parameters
init (bool) – init flag
run (bool) – run flag
- second_milieu(flag=None)¶
Use the current project to create a new computational database with a dual-porisity simulation
- unload()¶
Triggered when Thyrsis closes
- updateSitesMenu()¶
Populate site menu
- zoomFull(dummy=None)¶
Unused
- class thyrsis.plugin.TitleSetter(legend, parent=None)¶
Bases:
PyQt5.QtCore.QObject
Put title into legend
- update(title)¶
Set title
- Parameters
title (string) – title
- class thyrsis.plugin.WaitCursor¶
Bases:
object
Lock cursor
- thyrsis.plugin.get_layer(name)¶
Return a layer if existing, according to the name requested
- Parameters
name (string) – layer name
- thyrsis.plugin.tr(message)¶
Get the translation for a string using Qt translation API.
- thyrsis.plugin.wait_cursor()¶
Return wait cursor
- Returns
wait cursor
- Return type