Distribution Statement
# # # This source code is subject to the license referenced at

Interpolators in GeoIPS#

An interpolator is a class-based GeoIPS plugin that takes data in its native resolution and interpolates it to a grid with a different resolution. This interpolation can be done either before or after running an algorithm, or independently of running any algorithm.

Interpolators can be executed in two ways:

1. Inclusion in Product Specifications: Include the interpolator in a product or product default specification, which can be executed via the command line or a test script using a GeoIPS procflow.

For examples of including an interpolator in a product implementation, see the product defaults and products tutorials.

  1. Direct Invocation: Interpolators can also be called directly from within a program:

    from geoips.interfaces import interpolators
    interp_name = "interp_nearest"
    interpolator = interpolators.get_plugin(interp_name)
    

Plugin arguments#

The arguments accepted by a interpolator step (validated in Order-Based Processing workflows) are defined by the model below. These fields are generated directly from the code, so they always reflect the current validation rules.

pydantic model geoips.pydantic_models.v1.interpolators.InterpolatorArgumentsModel[source]

Validate common Interpolator arguments.

Fields:
Validators:

field area_def: str | None = None

Area definition identifier.

field varlist: List[str] | None = None

variables required for specific interpolation processing