pysteps.utils.conversion.to_raindepth

pysteps.utils.conversion.to_raindepth(R, metadata, a=None, b=None)

Convert to rain depth [mm].

Parameters:

R : array-like

Array of any shape to be (back-)transformed.

metadata : dict

Metadata dictionary containing the accutime, transform, unit, threshold and zerovalue attributes as described in the documentation of pysteps.io.importers.

Additionally, in case of conversion to/from reflectivity units, the zr_a and zr_b attributes are also required, but only if a=b=None.

a,b : float, optional

The a and b coefficients of the Z-R relationship.

Returns:

R : array-like

Array of any shape containing the converted units.

metadata : dict

The metadata with updated attributes.