stilt.flux.particle_enhancement#

stilt.flux.particle_enhancement(particles, flux)[source]#

Return each particle’s enhancement, foot times flux summed along its trajectory.

The mean over particles, after any weighting, is the modelled enhancement at the receptor. Unlike stilt.Footprint.enhancement(), the flux is taken at each particle position, with no gridding or smoothing.

Parameters:

  • particles (DataFrame) – Particle table with indx, long, lati, and foot columns, and datetime when the flux varies in time.

  • flux (DataArray) – Surface flux field. See sample_flux().

Returns:

Enhancement indexed by indx, in the flux’s units times the footprint’s. A particle that never crosses the flux field gets 0.

Return type:

Series

Raises:

ValueError – If the flux varies in time and the particles have no datetime column.