pyrad.graph._plot_time_range#

pyrad.graph._plot_time_range(rad_time, rad_range, rad_data, field_name, fname_list, titl='Time-Range plot', xlabel='time (s from start time)', ylabel='range (Km)', clabel=None, vmin=None, vmax=None, figsize=(10, 8), save_fig=True, dpi=72, plot_max=False)[source]#

Plot a time-range plot.

Parameters:

  • rad_time (1D array) – Array containing the x dimension, typically time.

  • rad_range (1D array) – Array containing the y dimension, typically range.

  • rad_data (2D array) – Array containing the data to plot. Expected shape is (ntime, nrange).

  • field_name (str or None) – Field name. Used to define plot characteristics.

  • fname_list (list of str) – Names of the files where the plot will be stored.

  • titl (str, optional) – Plot title.

  • xlabel, ylabel (str, optional) – X- and y-axis labels.

  • clabel (str or None, optional) – Colorbar label.

  • vmin, vmax (float or None, optional) – Minimum and maximum values of the colorbar.

  • figsize (tuple, optional) – Figure size as (xsize, ysize).

  • save_fig (bool, optional) – If True, save the figure to each file in fname_list. Otherwise, return the figure and axes.

  • dpi (int, optional) – Figure resolution in dots per inch.

  • plot_max (bool, optional) – If True, mark the maximum finite, unmasked value with a red dot and annotate its time, range, and value.

Returns:

  • fname_list (list of str) – Names of the created plots when save_fig is True.

  • fig, ax (matplotlib objects) – Figure and axes handles when save_fig is False.