RainDataset.plot_rain_grid

RainDataset.plot_rain_grid(storm, grid, levels=None, cmap=None, domain='dynamic', plot_all_dots=False, ax=None, cartopy_proj=None, save_path=None, prop={}, map_prop={})[source]

Creates a plot of a storm track and its associated rainfall (gridded).

Parameters

  • storm (tropycal.tracks.Storm) – Storm object to be plotted.

  • grid (dict or xarray.DataArray) – Output from interpolate_to_grid() to be plotted. Can also be any dict with “lat”, “lon” and “grid” entries, or an xarray DataArray with “lat” and “lon” dimensions.

  • levels (list or numpy.ndarray) – List of contour fill levels to plot the grid values, in inches. If none, this is automatically generated.

  • cmap (colormap) – Colormap to use for contour filling rainfall. If none, this is automatically generated.

  • domain (str) – Domain for the plot. Default is “dynamic”. Please refer to Map Domain Options for available domain options.

  • plot_all_dots (bool) – Whether to plot dots for all observations along the track. If false, dots will be plotted every 6 hours. Default is false.

  • ax (axes) – Instance of axes to plot on. If none, one will be generated. Default is none.

  • cartopy_proj (ccrs) – Instance of a cartopy projection to use. If none, one will be generated. Default is none.

  • save_path (str) – Relative or full path of directory to save the image in. If none, image will not be saved.

Other Parameters

  • prop (dict) – Customization properties of storm track lines. Please refer to Tracks Properties for available options.

  • map_prop (dict) – Customization properties of Cartopy map. Please refer to Map prop for available options.

Returns

ax – Instance of axes containing the plot is returned.