improver.cli.integrate_time_bounds module

Contents

improver.cli.integrate_time_bounds module#

Script to multiply period average values by the period.

process(cube, *, new_name=None)[source]#

Multiply a frequency or rate cube by the time period given by the time bounds over which it is defined to return a count or accumulation. The frequency or rate must be defined with time bounds, e.g. an average frequency across the period. This function will handle a cube with a non-scalar time coordinate, multiplying each time in the coordinate by the related bounds.

The returned cube has units equivalent to the input cube multiplied by seconds. Any time related cell methods are removed from the output cube and a new “sum” over time cell method is added.

Parameters:
  • cube (iris.cube.Cube) – Cube to multiply

  • new_name (str) – New name for the output diagnostic.

Returns:

A cube containing the time multiplied data.

Return type:

iris.cube.Cube