stilt.FootprintConfig#

class stilt.FootprintConfig(*, grid: stilt.spatial.Grid | None = None, geometry: Annotated[stilt.footprint.config.FileGeometrySpec | stilt.footprint.config.H3GeometrySpec | stilt.footprint.config.WindowsGeometrySpec, FieldInfo(annotation=NoneType, required=True, discriminator='kind')] | None = None, cells_per_target: Annotated[float, Gt(gt=0)] = 4.0, smooth_factor: float = 1.0, time_integrate: bool = False, transforms: list[Any] = <factory>) → None[source]#

Footprint settings: the grid, smoothing, and particle transforms.

The config and each variant hold these as their defaults and overrides, and every footprint keeps the settings it was calculated with.

grid is the raster the footprint is computed on. Leave both grid and geometry unset for a variant that only produces particles. Give geometry to name the polygons the footprint will be aggregated to, and the grid is derived from them (stilt.Mesh.to_grid()) when the project first reads its variants (project.variants), not when the config loads. When both are given, grid is used as is and geometry is recorded with the footprints.

Parameters#

Parameter	Description	Default
`grid`	Domain and resolution of the footprint. Unset with `geometry` derives it from the geometry; unset without it gives a run that produces particles only.	`None`
`geometry`	Polygons the footprint will be aggregated to (`kind` of `file`, `h3`, or `windows`). Used to derive `grid` when it is unset, and stored with the footprint.	`None`
`cells_per_target`	Grid cells across the smallest `geometry` cell when `grid` is derived.	`4.0`
`smooth_factor`	Factor on the width of the Gaussian smoothing kernel. 0 turns smoothing off.	`1.0`
`time_integrate`	Sum the footprint over time into a single layer instead of hourly layers.	`False`
`transforms`	Particle transforms applied in order before the footprint is computed. Each entry’s `kind` is a built-in name (`averaging_kernel`, `pressure_weighting`, `first_order_lifetime`) or the import path of your own class.	`[]`