radtraq.plotting.plot_cr_raster

radtraq.plotting.plot_cr_raster(obj, field='reflectivity', target_range=None, ax=None, fig=None, delta_x=None, delta_y=None, target_limits=None, az_limits=None, el_limits=None, vmin=None, vmax=None, cmap=None, title=None, title_flag=True, axislabels=['Azimuth (degree)', 'Elevation (degree)'], axislabels_flag=True, colorbar_flag=True, colorbar_label=None, colorbar_orient='vertical', noplot=False, az_field='azimuth', el_field='elevation', range_field='range')[source]

Plot a corner reflector raster scan

Parameters:

  • obj (Xarray.Dataset) – Xarray Dataset containing data

  • field (String) – Field to plot if other than reflectivity

  • target_range (Float) – Estimated range of the corner reflector

  • ax (Axis) – Axis to plot on. None will use the current axis.

  • fig (Figure) – Figure to add the colorbar to. None will use the current figure.

  • delta_x (Float) – Azimuth grid spacing for griddata

  • delta_y (Float) – Elevation grid spacing for griddata

  • target_limits (list) – Distance limits in form [min, max] used to subset the data when determining what range to analyze. This is ignored if target_range is set.

  • az_limits (list) – Azimuth limits in form [min, max]

  • el_limits (list) – Elevation limits in form [min, max]

  • vmin (float) – Luminance minimum value used in plotting, None for default value.

  • vmax (float) – Luminance maximum value used in plotting, None for default value.

  • cmap (str or None) – Matplotlib colormap name. None will use the default colormap for the field being plotted as specified by the Py-ART configuration.

  • title (str) – Title to label plot with, None to use default title generated from the field and sweep parameters. Parameter is ignored if title_flag is False.

  • title_flag (bool) – Set to True to add a title to the plot, False does not add a title.

  • axislabels ((str, str)) – 2-tuple of x-axis, y-axis labels. None for either label will use the default axis label. Parameter is ignored if axislabels_flag is False.

  • axislabels_flag (bool) – True to add label the axes, False does not label the axes.

  • colorbar_flag (bool) – True to add a colorbar with label to the axis. False leaves off the colorbar.

  • colorbar_label (str) – Colorbar label, None will use a default label generated from the field information.

  • colorbar_orient (‘vertical’ or ‘horizontal’) – Colorbar orientation.

  • noplot (boolean) – Switch to indicate if a plot should be created or just return the values.

Returns:

dict – A dictionary with values for max = Maximum data value min = Maximum data value az_max = Azimuth value for maximum data value, hopefully in center of corner reflector el_max = Elevation value for maximum data value, hopefully in center of corner reflector el_top = Elevation value for top of corner reflector range = Distance to target

Return type:

dictionary