stilt.Footprint#

class stilt.Footprint(receptor: stilt.receptors.Receptor, config: stilt.config.footprint.FootprintConfig, data: xarray.core.dataarray.DataArray, name: str = '')[source]#

Gridded footprint of one receptor.

A footprint is the sensitivity of the concentration at the receptor to the surface flux in each grid cell, in ppm per (µmol m⁻² s⁻¹). Multiply it by a flux and sum over the grid to get the enhancement at the receptor (enhancement()).

Footprints normally come from a simulation (sim.footprint) or a file (from_netcdf()).

Parameters

receptorReceptor

Receptor the footprint belongs to.

configFootprintConfig

Grid and smoothing settings it was calculated with. grid must be set.

dataxarray.DataArray

Values with dimensions (time, lat, lon), or (time, y, x) on a projected grid. Coordinates are cell centres, and time is the start of each hour. A time-integrated footprint has one time, the receptor time.

namestr, optional

Name of the footprint, usually the variant name.

Methods#

aggregate(target, time_bins)

Sum the footprint onto the cells of another grid or set of polygons, per time bin.

calculate(particles, receptor, config[, ...])

Calculate a footprint from particles.

enhancement(flux)

Return the modelled enhancement at the receptor, footprint times flux summed over the grid.

from_netcdf(path, *[, chunks])

Read a footprint from a NetCDF file written by to_netcdf().

integrate_over_time([start, end])

Sum the footprint over time.

to_netcdf(path)

Write the footprint to a CF-1.8 NetCDF file.

Attributes#

plot

Plotting methods, such as foot.plot.map().

time_range

Start and end of the period the footprint covers.

grid

Grid the footprint is on (config.grid).