geoips.plugins.modules.algorithms.sfc_winds package#

Submodules#

geoips.plugins.modules.algorithms.sfc_winds.windbarbs module#

Surface Winds plotted as Barbs in Knots.

Data manipulation steps for surface winds products. This algorithm expects surface wind speeds in units of kts

geoips.plugins.modules.algorithms.sfc_winds.windbarbs.call(arrays, output_data_range=None, input_units=None, output_units=None, min_outbounds='crop', max_outbounds='crop', norm=False, inverse=False)[source]#

Windbarbs product algorithm data manipulation steps.

This algorithm expects input windspeed with units “kts” and returns in “kts”

Parameters:

  • arrays (list of numpy.ndarray) –

    • list of numpy.ndarray or numpy.MaskedArray of channel data,

      in order of sensor “channels” list

    • kts

  • output_data_range (list of float, default=None) –

    • list of min and max value for wind speeds (kts)

    • defaults to None, which results in using data.min and data.max.

  • input_units (str, default=None) –

    • Units of input data, for applying necessary conversions

    • defaults to None, resulting in no unit conversions.

  • output_units (str, default=None) –

    • Units of output data, for applying necessary conversions

    • defaults to None, resulting in no unit conversions.

  • min_outbounds (str, default='crop') –

    • Method to use when applying bounds. Valid values are:

      • retain: keep all pixels as is

      • mask: mask all pixels that are out of range

      • crop: set all out of range values to either min_val or max_val as appropriate

  • max_outbounds (str, default='crop') –

    • Method to use when applying bounds. Valid values are:

      • retain: keep all pixels as is

      • mask: mask all pixels that are out of range

      • crop: set all out of range values to either min_val or max_val as appropriate

  • norm (bool, default=False) –

    • Boolean flag indicating whether to normalize (True) or not (False)

      • If True, returned data will be in the range from 0 to 1

      • If False, returned data will be in the range from min_val to max_val

  • inverse (bool, default=False) –

    • Boolean flag indicating whether to inverse (True) or not (False)

      • If True, returned data will be inverted

      • If False, returned data will not be inverted

Returns:

numpy.ndarray or numpy.MaskedArray of appropriately scaled channel data, dstacked as follows:

  • (spd, direction, rain_flag)

  • spd in kts

  • direction in degrees

  • rain_flag 0 or 1

Return type:

numpy.ndarray

Module contents#

geoips sfc_winds algorithm init.