Source code for improver.cli.threshold_interpolation

#!/usr/bin/env python
# (C) Crown Copyright, Met Office. All rights reserved.
#
# This file is part of 'IMPROVER' and is released under the BSD 3-Clause license.
# See LICENSE in the root of the repository for full licensing details.
"""Script to run the threshold interpolation plugin."""

from improver import cli




@cli.clizefy
@cli.with_output
def process(
    forecast_at_thresholds: cli.inputcube,
    *,
    thresholds: cli.comma_separated_list,
):
    """
    Use this CLI to modify the probability thresholds in an existing probability
    forecast cube by linearly interpolating between the existing thresholds.

    Args:
        forecast_at_thresholds:
            Cube expected to contain a threshold coordinate.
        thresholds:
            List of the desired output thresholds.

    Returns:
        Cube with forecast values at the desired set of thresholds.
        The threshold coordinate is always the zeroth dimension.
    """
    from improver.utilities.threshold_interpolation import ThresholdInterpolation

    result = ThresholdInterpolation(thresholds)(forecast_at_thresholds)

    return result