PlotAC.py

# PlotAC.py -- Pamhyr
# Copyright (C) 2023-2024  INRAE
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

# -*- coding: utf-8 -*-

from tools import timer
from View.Tools.PamhyrPlot import PamhyrPlot
from matplotlib import pyplot as plt

from PyQt5.QtCore import (
    QCoreApplication
)

_translate = QCoreApplication.translate


class PlotAC(PamhyrPlot):
    def __init__(self, canvas=None, trad=None, toolbar=None,
                 results=None, reach_id=0, profile_id=0,
                 parent=None):
        super(PlotAC, self).__init__(
            canvas=canvas,
            trad=trad,
            data=results,
            toolbar=toolbar,
            parent=parent
        )

        self._current_timestamp = max(results.get("timestamps"))
        self._current_reach_id = reach_id
        self._current_profile_id = profile_id

        self.label_x = _translate("Results", "X (m)")
        self.label_y = _translate("MainWindow_reach", "Elevation (m)")

        self.label_bottom = _translate("Results", "River bottom")
        self.label_water = _translate("Results", "Water elevation")
        self.label_water_max = _translate("Results", "Max water elevation")

        self._isometric_axis = False

        self._auto_relim_update = True
        self._autoscale_update = True

    @property
    def results(self):
        return self.data

    @results.setter
    def results(self, results):
        self.data = results
        self._current_timestamp = max(results.get("timestamps"))

    @timer
    def draw(self, highlight=None):
        self.init_axes()

        if self.results is None:
            return

        reach = self.results.river.reach(self._current_reach_id)
        profile = reach.profile(self._current_profile_id)

        self.draw_profile(reach, profile)
        self.draw_water_elevation(reach, profile)
        self.draw_water_elevation_max(reach, profile)

        self.enable_legend()

        self.idle()
        self._init = True

    def draw_profile(self, reach, profile):
        x = profile.geometry.get_station()
        z = profile.geometry.z()

        self.line_kp, = self.canvas.axes.plot(
            x, z,
            linestyle="solid",
            lw=1.5,
            label=self.label_bottom,
            color=self.color_plot_river_bottom,
        )

    def draw_water_elevation(self, reach, profile):
        x = profile.geometry.get_station()
        z = profile.geometry.z()
        kp = reach.geometry.get_kp()
        water_z = profile.get_ts_key(self._current_timestamp, "Z")

        self.water, = self.canvas.axes.plot(
            [min(x),  max(x)], [water_z, water_z],
            label=self.label_water,
            lw=1., color=self.color_plot_river_water,
        )

        self.collection = self.canvas.axes.fill_between(
            x, z, water_z,
            where=z <= water_z,
            color=self.color_plot_river_water_zone,
            alpha=0.7, interpolate=True
        )
        self.liste_chemins = self.collection.get_paths()

    def draw_water_elevation_max(self, reach, profile):
        x = profile.geometry.get_station()
        z = profile.geometry.z()
        kp = reach.geometry.get_kp()
        water_z = max(profile.get_key("Z"))

        self.water_max, = self.canvas.axes.plot(
            [min(x),  max(x)], [water_z, water_z],
            label=self.label_water_max,
            linestyle='dotted',
            lw=1., color=self.color_plot_river_water,
        )

    def set_reach(self, reach_id):
        self._current_reach_id = reach_id
        self._current_profile_id = 0
        self.update()

    def set_profile(self, profile_id):
        self._current_profile_id = profile_id
        self.update()

    def set_timestamp(self, timestamp):
        self._current_timestamp = timestamp

        reach = self.results.river.reach(self._current_reach_id)
        profile = reach.profile(self._current_profile_id)
        x = profile.geometry.get_station()
        z = profile.geometry.z()

        self.update_water(reach, profile, x, z)
        self.update_idle()

    def update(self):
        if not self._init:
            self.draw()

        reach = self.results.river.reach(self._current_reach_id)
        profile = reach.profile(self._current_profile_id)
        x = profile.geometry.get_station()
        z = profile.geometry.z()

        self.update_river_bottom(reach, profile, x, z)
        self.update_water(reach, profile, x, z)
        self.update_water_max(reach, profile, x, z)

        self.update_idle()

    def update_river_bottom(self, reach, profile, x, z):
        self.line_kp.set_data(x, z)

    def update_water(self, reach, profile, x, z):
        water_z = profile.get_ts_key(self._current_timestamp, "Z")
        self.water.set_data(
            [min(x),  max(x)],
            [water_z, water_z]
        )

        self.collection.remove()
        self.collection = self.canvas.axes.fill_between(
            x, z, water_z,
            where=z <= water_z,
            color=self.color_plot_river_water_zone,
            alpha=0.7, interpolate=True
        )

    def update_water_max(self, reach, profile, x, z):
        water_z = max(profile.get_key("Z"))
        self.water_max.set_data(
            [min(x),  max(x)],
            [water_z, water_z]
        )