cloudnetpy 1.56.8__py3-none-any.whl → 1.56.9__py3-none-any.whl

cloudnetpy/plotting/__init__.py

@@ -1,2 +1,2 @@
 from .plot_meta import PlotMeta
-from .plotting import PlotParameters, generate_figure, plot_2d
+from .plotting import Dimensions, PlotParameters, generate_figure, plot_2d

cloudnetpy/plotting/plot_meta.py

@@ -15,8 +15,8 @@ class PlotMeta(NamedTuple):
         plot_range: The range of values to be plotted. It can be a tuple
             containing the minimum and maximum values, or None if the range should
             be automatically determined.
-        log_scale: Whether to use a logarithmic scale for the plot.
-        moving_average: Whether to add a moving average to a 1d plot.
+        log_scale: Whether to plot data values in a logarithmic scale.
+        moving_average: Whether to plot a moving average in a 1d plot.
         contour: Whether to plot contours on top of a filled colormap.
     """
 

cloudnetpy/plotting/plotting.py

@@ -34,7 +34,8 @@ class PlotParameters:
         mark_data_gaps: Whether to mark data gaps in the plot.
         grid: Whether to display grid lines in the plot.
         edge_tick_labels: Whether to display tick labels on the edges of the plot.
-        show_sources: Whether to display the sources of plotted data.
+        show_sources: Whether to display the sources of plotted data (i.e.
+            instruments and model).
         footer_text: The text to display in the footer of the plot.
         plot_meta: Additional metadata for the plot.
     """
@@ -52,14 +53,20 @@ class PlotParameters:
 
 
 class Dimensions:
-    """Dimensions of a generated figure in pixels."""
+    """
+    Dimensions of a generated figure in pixels. Elements such as the figure
+    title, labels, colorbar and legend are exluded from the margins.
 
-    width: int
-    height: int
-    margin_top: int
-    margin_right: int
-    margin_bottom: int
-    margin_left: int
+    Attributes:
+        width (int): Figure width in pixels.
+        height (int): Figure height in pixels.
+        margin_top (int): Space between top edge of image and plotted data in pixels.
+        margin_right (int): Space between right edge of image and plotted data
+            in pixels.
+        margin_bottom (int): Space between bottom edge of image and plotted
+            data in pixels.
+        margin_left (int): Space between left edge of image and plotted data in pixels.
+    """
 
     def __init__(self, fig, axes, pad_inches: float | None = None):
         if pad_inches is None:
@@ -284,7 +291,7 @@ class Plot:
         self._is_log = sub_plot.plot_meta.log_scale
         self._ax = sub_plot.ax
 
-    def _convert_units(self) -> str | None:
+    def _convert_units(self) -> str:
         multiply, add = "multiply", "add"
         units_conversion = {
             "rainfall_rate": (multiply, 360000, "mm h$^{-1}$"),
@@ -303,6 +310,7 @@ class Plot:
             self._data += conversion
             self._data_orig += conversion
         if units is not None:
+            self._plot_meta = self._plot_meta._replace(clabel=units)
             return units
         units = getattr(self.sub_plot.variable, "units", "")
         return _reformat_units(units)
@@ -509,6 +517,28 @@ class Plot2D(Plot):
 
 
 class Plot1D(Plot):
+    def plot(self, figure_data: FigureData) -> None:
+        units = self._convert_units()
+        self._mark_gaps(figure_data)
+        self._ax.plot(
+            figure_data.time_including_gaps,
+            self._data,
+            label="_nolegend_",
+            **self._get_plot_options(),
+            zorder=_get_zorder("data"),
+        )
+        if self._plot_meta.moving_average:
+            self._plot_moving_average(figure_data)
+        self._fill_between_data_gaps(figure_data)
+        self.sub_plot.set_yax(ylabel=units, y_limits=self._get_y_limits())
+        pos = self._ax.get_position()
+        self._ax.set_position((pos.x0, pos.y0, pos.width * 0.965, pos.height))
+        if figure_data.is_mwrpy_product():
+            flags = self._read_flagged_data(figure_data)
+            if np.any(flags):
+                self._plot_flag_data(figure_data.time[flags], self._data_orig[flags])
+                self._add_legend()
+
     def plot_tb(self, figure_data: FigureData, freq_ind: int) -> None:
         self._data = self._data[:, freq_ind]
         self._data_orig = self._data_orig[:, freq_ind]
@@ -518,11 +548,28 @@ class Plot1D(Plot):
         flags = self._read_flagged_data(figure_data)[:, freq_ind]
         flags[is_bad_zenith] = False
         if np.any(flags):
-            self.plot_flag_data(figure_data.time[flags], self._data_orig[flags])
-            self.add_legend()
+            self._plot_flag_data(figure_data.time[flags], self._data_orig[flags])
+            self._add_legend()
         self.plot(figure_data)
+        self._show_frequency(figure_data, freq_ind)
+
+    def _show_frequency(self, figure_data: FigureData, freq_ind: int) -> None:
+        frequency = figure_data.file.variables["frequency"][freq_ind]
+        self._ax.text(
+            0.0,
+            -0.13,
+            f"Freq: {frequency:.2f} GHz",
+            transform=self._ax.transAxes,
+            fontsize=12,
+            color="dimgrey",
+            bbox={
+                "facecolor": "white",
+                "linewidth": 0,
+                "boxstyle": "round",
+            },
+        )
 
-    def plot_flag_data(self, time: ndarray, values: ndarray) -> None:
+    def _plot_flag_data(self, time: ndarray, values: ndarray) -> None:
         self._ax.plot(
             time,
             values,
@@ -533,7 +580,7 @@ class Plot1D(Plot):
             zorder=_get_zorder("flags"),
         )
 
-    def add_legend(self) -> None:
+    def _add_legend(self) -> None:
         self._ax.legend(
             ["Flagged data"],
             markerscale=3,
@@ -541,28 +588,6 @@ class Plot1D(Plot):
             frameon=False,
         )
 
-    def plot(self, figure_data: FigureData) -> None:
-        units = self._convert_units()
-        self._mark_gaps(figure_data)
-        self._ax.plot(
-            figure_data.time_including_gaps,
-            self._data,
-            label="_nolegend_",
-            **self._get_plot_options(),
-            zorder=_get_zorder("data"),
-        )
-        if self._plot_meta.moving_average:
-            self._plot_moving_average(figure_data)
-        self._fill_between_data_gaps(figure_data)
-        self.sub_plot.set_yax(ylabel=units, y_limits=self._get_y_limits())
-        pos = self._ax.get_position()
-        self._ax.set_position((pos.x0, pos.y0, pos.width * 0.965, pos.height))
-        if figure_data.is_mwrpy_product():
-            flags = self._read_flagged_data(figure_data)
-            if np.any(flags):
-                self.plot_flag_data(figure_data.time[flags], self._data_orig[flags])
-                self.add_legend()
-
     def _get_y_limits(self) -> tuple[float, float]:
         percent_gap = 0.05
         fallback = (-percent_gap, percent_gap)
@@ -597,11 +622,6 @@ class Plot1D(Plot):
 
         return default_options
 
-    @staticmethod
-    def _get_line_width(time: ndarray) -> float:
-        line_width = np.median(np.diff(time)) * 1000
-        return min(max(line_width, 0.25), 0.9)
-
     def _plot_moving_average(self, figure_data: FigureData) -> None:
         time = figure_data.time.copy()
         data = self._data_orig.copy()
@@ -620,6 +640,11 @@ class Plot1D(Plot):
                 zorder=_get_zorder("mean_curve"),
             )
 
+    @staticmethod
+    def _get_line_width(time: ndarray) -> float:
+        line_width = np.median(np.diff(time)) * 1000
+        return min(max(line_width, 0.25), 0.9)
+
     @staticmethod
     def _get_unmasked_values(
         data: ma.MaskedArray,

cloudnetpy/version.py

@@ -1,4 +1,4 @@
 MAJOR = 1
 MINOR = 56
-PATCH = 8
+PATCH = 9
 __version__ = f"{MAJOR}.{MINOR}.{PATCH}"

{cloudnetpy-1.56.8.dist-info → cloudnetpy-1.56.9.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cloudnetpy
-Version: 1.56.8
+Version: 1.56.9
 Summary: Python package for Cloudnet processing
 Author: Simo Tukiainen
 License: MIT License

{cloudnetpy-1.56.8.dist-info → cloudnetpy-1.56.9.dist-info}/RECORD

@@ -8,7 +8,7 @@ cloudnetpy/metadata.py,sha256=Bcu1a9UyUq61jomuZ0_6hYIOzf61e5qCXeiwLm46ikw,5040
 cloudnetpy/output.py,sha256=jD1pfBb4OQhVOrlhPEk-8FAi4bUW7zjAL468r6BPkJg,14586
 cloudnetpy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 cloudnetpy/utils.py,sha256=yY5a5HLuAks2uzA4XbbqsGFEmXoyqECn_TjD3sMa0lI,27193
-cloudnetpy/version.py,sha256=_SXj81dofY9NERxtayhy3t3CvF1V5RuifRBTXoDj-qI,72
+cloudnetpy/version.py,sha256=L5yTOc1IUQ52ak-q9sb2zqco0z_mepJx_hFuzl6k6JY,72
 cloudnetpy/categorize/__init__.py,sha256=gP5q3Vis1y9u9OWgA_idlbjfWXYN_S0IBSWdwBhL_uU,69
 cloudnetpy/categorize/atmos.py,sha256=cax3iRmvr7S-VkUZqz0JCfAN3WEsUVbGfH4zSHy1APo,12384
 cloudnetpy/categorize/atmos_utils.py,sha256=wndpwJxc2-QnNTkV8tc8I11Vs_WkNz9sVMX1fuGgUC4,3777
@@ -90,9 +90,9 @@ cloudnetpy/model_evaluation/tests/unit/test_plot_tools.py,sha256=YeeJdS2JO5F645z
 cloudnetpy/model_evaluation/tests/unit/test_plotting.py,sha256=h9V8JKmrO4v9bOvv-UjRa06sZJQPhDNVHGBSImDdtkI,3277
 cloudnetpy/model_evaluation/tests/unit/test_statistical_methods.py,sha256=Ra3r4V0qbqkpDuaTYvEIbaasl0nZ5gmTLR4eGC0glBQ,9724
 cloudnetpy/model_evaluation/tests/unit/test_tools.py,sha256=Ia_VrLdV2NstX5gbx_3AZTOAlrgLAy_xFZ8fHYVX0xI,3817
-cloudnetpy/plotting/__init__.py,sha256=2-8x8d1AfAhfU15RwWhusD0Wot_g6Ob_jJoywbrTC7A,95
-cloudnetpy/plotting/plot_meta.py,sha256=Tc5RuDe3-NeYM1a0xu9ZG3ePyC-5NMabp6teXjlOJ3w,14627
-cloudnetpy/plotting/plotting.py,sha256=56nFTBePQIj48_VGYcGap3PwR227WTIeVx8RafvBVN0,29546
+cloudnetpy/plotting/__init__.py,sha256=lg9Smn4BI0dVBgnDLC3JVJ4GmwoSnO-qoSd4ApvwV6Y,107
+cloudnetpy/plotting/plot_meta.py,sha256=NWI8ECKMypN5YyM9XKCAp1WEthbFlKMvilxqXmYSEK4,14631
+cloudnetpy/plotting/plotting.py,sha256=AU7WWEfemlXXQ17IgybagQMx8JRJBF4y9DSv5DF_2Ho,30683
 cloudnetpy/products/__init__.py,sha256=2hRb5HG9hNrxH1if5laJkLeFeaZCd5W1q3hh4ewsX0E,273
 cloudnetpy/products/classification.py,sha256=J_FOMUSyxvFaT-hvdKVVcKPtuQ0u3V9PsV5xaIKzMjg,7843
 cloudnetpy/products/der.py,sha256=HAdPvbJySEqkIwDrdZDPnli_wnN2qwm72_D1a82ZWIs,12398
@@ -106,8 +106,8 @@ cloudnetpy/products/mie_lu_tables.nc,sha256=It4fYpqJXlqOgL8jeZ-PxGzP08PMrELIDVe5
 cloudnetpy/products/mwr_tools.py,sha256=PRm5aCULccUehU-Byk55wYhhEHseMjoAjGBu5TSyHao,4621
 cloudnetpy/products/product_tools.py,sha256=E8CSijBY8cr70BH2JFa0lGQ-RzI9EcHQ0Fzt8CQ8rY4,10442
 docs/source/conf.py,sha256=IKiFWw6xhUd8NrCg0q7l596Ck1d61XWeVjIFHVSG9Og,1490
-cloudnetpy-1.56.8.dist-info/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
-cloudnetpy-1.56.8.dist-info/METADATA,sha256=AJkrIWze21HybWis8YfMvvAyP1W_qGhN0XQRteEBBPY,5733
-cloudnetpy-1.56.8.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-cloudnetpy-1.56.8.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
-cloudnetpy-1.56.8.dist-info/RECORD,,
+cloudnetpy-1.56.9.dist-info/LICENSE,sha256=wcZF72bdaoG9XugpyE95Juo7lBQOwLuTKBOhhtANZMM,1094
+cloudnetpy-1.56.9.dist-info/METADATA,sha256=HgNqhO700XNh1uBoHccsDiA73n4R48XgLctfsB8Qczs,5733
+cloudnetpy-1.56.9.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+cloudnetpy-1.56.9.dist-info/top_level.txt,sha256=ibSPWRr6ojS1i11rtBFz2_gkIe68mggj7aeswYfaOo0,16
+cloudnetpy-1.56.9.dist-info/RECORD,,