hdobs.gridded_stats

hdobs.gridded_stats(request, thresh={}, binsize=1, domain='dynamic', ax=None, return_array=False, cartopy_proj=None, prop={}, map_prop={})[source]

Creates a plot of gridded statistics.

Parameters

  • request (str) –

    This string is a descriptor for what you want to plot. It will be used to define the variable (e.g. ‘wind’ –> ‘vmax’) and the function (e.g. ‘maximum’ –> np.max()). This string is also used as the plot title.

    Variable words to use in request:

    • wind - (kt). Flight level wind.

    • 30s wind - (kt). 30-second flight level wind.

    • 10s wind - (kt). 10-second flight level wind.

    • sfmr - (kt). SFMR wind.

    • pressure - (hPa). Minimum pressure.

    Units of all wind variables are knots and pressure variables are hPa. These are added into the title.

    Function words to use in request:

    • maximum

    • minimum

    Example usage: “maximum wind”, “minimum pressure”

  • thresh (dict, optional) –

    Keywords in self.keys

    Units of all wind variables = kt, and pressure variables = hPa. These are added to the subtitle.

  • binsize (float, optional) – Grid resolution in degrees. Default is 1 degree.

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

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

  • return_array (bool, optional) – If True, returns the gridded 2D array used to generate the plot. Default is False.

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

Other Parameters

  • prop (dict, optional) – Customization properties of plot. Please refer to gridded_stats for available options.

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

Returns

By default, the plot axes is returned. If “return_array” are set to True, a dictionary is returned containing both the axes and data array.