RadarDisplay.plot_ppi(field, sweep=0, mask_tuple=None, vmin=None, vmax=None, norm=None, cmap=None, mask_outside=False, title=None, title_flag=True, axislabels=(None, None), axislabels_flag=True, colorbar_flag=True, colorbar_label=None, colorbar_orient='vertical', edges=True, gatefilter=None, filter_transitions=True, ax=None, fig=None, ticks=None, ticklabs=None, raster=False, title_datetime_format=None, title_use_sweep_time=True, **kwargs)[source]#

Plot a PPI.

Additional arguments are passed to Matplotlib’s pcolormesh function.

  • field (str) – Field to plot.

  • sweep (int, optional) – Sweep number to plot.

Other Parameters
  • mask_tuple ((str, float)) – Tuple containing the field name and value below which to mask field prior to plotting, for example to mask all data where NCP < 0.5 set mask_tuple to [‘NCP’, 0.5]. None performs no masking.

  • vmin (float) – Luminance minimum value, None for default value. Parameter is ignored is norm is not None.

  • vmax (float) – Luminance maximum value, None for default value. Parameter is ignored is norm is not None.

  • norm (Normalize or None, optional) – matplotlib Normalize instance used to scale luminance data. If not None the vmax and vmin parameters are ignored. If None, vmin and vmax are used for luminance scaling.

  • 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.

  • mask_outside (bool) – True to mask data outside of vmin, vmax. False performs no masking.

  • 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_datetime_format (str) – Format of datetime in the title (using strftime format).

  • title_use_sweep_time (bool) – True for the current sweep’s beginning time to be used for the title. False for the radar’s beginning time.

  • title_flag (bool) – 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.

  • ticks (array) – Colorbar custom tick label locations.

  • ticklabs (array) – Colorbar custom tick labels.

  • edges (bool) – True will interpolate and extrapolate the gate edges from the range, azimuth and elevations in the radar, treating these as specifying the center of each gate. False treats these coordinates themselves as the gate edges, resulting in a plot in which the last gate in each ray and the entire last ray are not plotted.

  • gatefilter (GateFilter) – GateFilter instance. None will result in no gatefilter mask being applied to data.

  • filter_transitions (bool) – True to remove rays where the antenna was in transition between sweeps from the plot. False will include these rays in the plot. No rays are filtered when the antenna_transition attribute of the underlying radar is not present.

  • 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.

  • raster (bool) – False by default. Set to true to render the display as a raster rather than a vector in call to pcolormesh. Saves time in plotting high resolution data over large areas. Be sure to set the dpi of the plot for your application if you save it as a vector format (i.e., pdf, eps, svg).