improver.cli.apply_dz_rescaling module
CLI to apply a scaling factor to account for a correction linked to the difference in altitude between the grid point and the site location.
- process(forecast, scaling_factor, *, site_id_coord='wmo_id')[source]
Apply a scaling factor to account for a correction linked to the difference in altitude between the grid point and the site location.
- Parameters:
forecast (iris.cube.Cube) – Percentile forecasts.
rescaling_cube (iris.cube.Cube) – Multiplicative scaling factor to adjust the percentile forecasts. This cube is expected to contain multiple values for the forecast_period and forecast_reference_time_hour coordinates. The most appropriate forecast period and forecast reference_time_hour pair within the rescaling cube are chosen using the forecast reference time hour from the forecast and the nearest forecast period that is greater than or equal to the forecast period of the forecast. However, if the forecast period of the forecast exceeds all forecast periods within the rescaling cube, the scaling factor from the maximum forecast period is used. This cube is generated using the estimate_dz_rescaling CLI.
site_id_coord (str) – The name of the site ID coordinate. This defaults to ‘wmo_id’.
- Returns:
Percentile forecasts that have been rescaled to account for a difference in altitude between the grid point and the site location.
- Return type: