Plots module

            GNU GENERAL PUBLIC LICENSE
              Version 3, 29 June 2007

KOSWAT, from the dutch combination of words Kosts-Wat (what are the costs) Copyright (C) 2025 Stichting Deltares

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 http://www.gnu.org/licenses/.

KoswatFigureContextHandler

PyPlot fig context handler that opens the figure stream and closes it saving it to the appointed path. Usage example: with KoswatFigureContext(Path("C://my_plot.png"), 42) as _figure: _subplot = _figure.add_subplot() ...

__enter__() -> Figure

Access to the context and invokation of pyplot.figure(dpi).

Returns:
  • Figure( Figure ) –

    Initialized instance from pyplot.figure(dpi=dpi).

__exit__(*args, **kwargs) -> None

Exit the current context and save the previously initialized Figure.

__init__(output_path: Path, dpi: int) -> None

Initializes the context by invoking pyplot.figure(dpi=dpi) and saving its output to an internal field.

Parameters:
  • output_path (Path) –

    Export location for the generated plot.

  • dpi (int) –

    Canvas resolution in dots-per-inch.

 
            GNU GENERAL PUBLIC LICENSE
              Version 3, 29 June 2007

KOSWAT, from the dutch combination of words Kosts-Wat (what are the costs) Copyright (C) 2025 Stichting Deltares

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 http://www.gnu.org/licenses/.

KoswatPlotProtocol

Bases: Protocol

plot(*args, **kwargs) -> pyplot.axes

Plots a koswat_object into the provided plot ax with the requested *args and **kwargs.

Returns:
  • axes –

    pyplot.axes: Canvas with plotted koswat_object.

 
            GNU GENERAL PUBLIC LICENSE
              Version 3, 29 June 2007

KOSWAT, from the dutch combination of words Kosts-Wat (what are the costs) Copyright (C) 2025 Stichting Deltares

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 http://www.gnu.org/licenses/.

PlotExporterProtocol

Bases: KoswatExporterProtocol, Protocol

export() -> None

Exports a given object into a plot.