RadarMapDisplayBasemap.plot_ppi_map(field, sweep=0, mask_tuple=None, vmin=None, vmax=None, cmap=None, norm=None, mask_outside=False, title=None, title_flag=True, colorbar_flag=True, colorbar_label=None, colorbar_orient='vertical', ax=None, fig=None, lat_lines=None, lon_lines=None, projection='lcc', area_thresh=10000, min_lon=None, max_lon=None, min_lat=None, max_lat=None, width=None, height=None, lon_0=None, lat_0=None, resolution='h', shapefile=None, edges=True, gatefilter=None, basemap=None, filter_transitions=True, embellish=True, ticks=None, ticklabs=None, raster=False, alpha=None, edgecolors='face', **kwargs)[source]#

Plot a PPI volume sweep onto a geographic map.

Additional arguments are passed to Basemap.

  • 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 tilt parameters. Parameter is ignored if title_flag is False.

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

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

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

  • ticklabs (array) – Colorbar custom tick labels.

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

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

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

  • lat_lines, lon_lines (array or None) – Locations at which to draw latitude and longitude lines. None will use default values which are resonable for maps of North America.

  • projection (str) – Map projection supported by basemap. The use of cylindrical projections (mill, merc, etc) is not recommended as they exhibit large distortions at high latitudes. Equal area (aea, laea), conformal (lcc, tmerc, stere) or equidistant projection (aeqd, cass) work well even at high latitudes. The cylindrical equidistant projection (cyl) is not supported as coordinate transformations cannot be performed.

  • area_thresh (float) – Coastline or lake with an area smaller than area_thresh in km^2 will not be plotted.

  • min_lat, max_lat, min_lon, max_lon (float) – Latitude and longitude ranges for the map projection region in degrees.

  • width, height (float) – Width and height of map domain in meters. Only this set of parameters or the previous set of parameters (min_lat, max_lat, min_lon, max_lon) should be specified. If neither set is specified then the map domain will be determined from the extend of the radar gate locations.

  • lon_0, lat_0 (float) – Center of the map domain in degrees. If the default, None is used the latitude and longitude of the radar will be used.

  • shapefile (str) – Filename for a ESRI shapefile as background (untested).

  • resolution (‘c’, ‘l’, ‘i’, ‘h’, or ‘f’.) – Resolution of boundary database to use. See Basemap documentation for details.

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

  • 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 themselved as the gate edges, resulting in a plot in which the last gate in each ray and the entire last ray are not not plotted.

  • embellish (bool) – True by default. Set to false to supress drawing of coastlines etc.. Use for speedup when specifying shapefiles.

  • basemap (Basemap instance) – If None, create basemap instance using other keyword info. If not None, use the user-specifed basemap instance.

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

  • alpha (float or None) – Set the alpha tranparency of the radar plot. Useful for overplotting radar over other datasets.

  • edgecolor (str) – Set the behavior of the edges of the pixels, by default it will color them the same as the pixels (faces).

  • **kwargs (additional keyword arguments to pass to pcolormesh.)