Skip to content

SspaConfig

SspaConfig

Configuration for the SSP&A (kriging-based) velocity-field fitting method.

Parameters:

Name Type Description Default
search_radius float

Neighbourhood search radius used when selecting conditioning data for each kriging estimate (model units). This only needs to span a few raster cells — typically 2–3× the cell size of the input raster. Best practice: read the cell size from each input raster (e.g. via rasterio) and set search_radius = 2 * cell_size (or 3 * cell_size for safety). A radius that is too large wastes time and over-smooths; a radius that is too small under-determines the kriging system and produces noisy velocities.

required
krig_offset float

Finite-difference offset used when estimating the kriged head gradient near the particle. Smaller values sample the gradient more locally; larger values smooth it over a wider distance. Default is 0.1.

0.1

search_radius property

search_radius: float

Neighbourhood search radius for kriging (model units).

Should be 2–3× the raster cell size. Read the cell size from each input raster and set dynamically rather than hard-coding.

krig_offset property

krig_offset: float

Finite-difference offset for kriged gradient estimation.

__init__

__init__(search_radius: float, krig_offset: float = 0.1) -> None