improver.pollen.pollen_maximum_index_for_period module

Calculations to produce overall Pollen Index values for a period, Hourly or Daily.

class PollenMaximumIndexForPeriod

Bases: PostProcessingPlugin

Plugin to calculate the overall Pollen Index for either a Daily or Hourly period.

The input cubelist has Pollen Index Values for all pollen taxa for the period as specified in the cubes. The maximum value across all taxa at a location is saved as the Index for that location.

_abc_impl = <_abc._abc_data object>

_calculate(cubes)

Calculate the overall Pollen Index for the period.

The period, either Hourly or Daily, can be determined by the value in the cube attribute “forecast_period” which has the period in seconds. i.e. 3600 for Hourly and 86400 for Daily.

For each grid point, determine the maximum pollen value across all taxa, and use this as the pollen index for that grid point.

Parameters:

cubes (tuple[Cube, ...] | CubeList) – Input cubes for all pollen types

_metadata()

Change the cube name and other metadata.

Some attributes are removed because they are not relevant to this aggregated cube data which is no longer specific to one pollen taxon.

_output_cube = None

process(*cubes)

Calculate the Pollen Hourly Index.

Parameters:

cubes (iris.cube.CubeList or list of iris.cube.Cube) – Input cubes for all pollen types for Pollen Value for 1 hour.

Return type:

Cube

Returns:

The calculated output cube.

Warns:

UserWarning – If output values fall outside typical expected ranges