RainDataset.plot_rain

RainDataset.plot_rain(storm, ms=7.5, mec=None, mew=0.5, minimum_threshold=1.0, levels=None, cmap=None, domain='dynamic', plot_all_dots=False, ax=None, cartopy_proj=None, save_path=None, **kwargs)[source]

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

Parameters

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

  • ms (float or int) – Marker size for individual rainfall observations. Default is 7.5.

  • mec (str or rgb tuple) – Marker edge color for dots. If none (default), none will be colored.

  • mew (float or int) – Marker edge width for dots. If mec is specified, the default is 0.5.

  • minimum_threshold (float or int) – Minimum threshold (in inches) to plot dots. Default is 1.00 inch.

  • levels (list or numpy.ndarray) – List of levels, in inches, corresponding to the colormap used to color fill the observation dots. If none, this is automatically generated.

  • cmap (colormap) – Colormap to use for color filling the observation dots. 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.