stilt.transforms.AveragingKernel#

class stilt.transforms.AveragingKernel(*, kind: Literal['averaging_kernel'] = 'averaging_kernel', levels: list[float] | None = None, values: list[float] | None = None, table: str | None = None, coordinate: str = 'xhgt') → None[source]#

Transform that weights each particle’s foot by an averaging kernel.

Give the kernel as levels and values, or name a table with one kernel per receptor (see averaging_kernel_table()). A relative table path is relative to the project root. A receptor missing from the table is an error.

levels are release heights above ground in meters by default. Set coordinate: pres for a kernel on pressure levels in hPa. Fold any instrument-specific factor, such as TCCON’s wet-air scaling, into the values. The kernel weight is added as an ak_weight column.

Methods#

apply(particles[, context])

Return the particles with foot weighted by the averaging kernel.

kernel([context])

Return (levels, values) of the kernel for the receptor in context.

Attributes#

kind

levels

values

table

coordinate