stilt.Simulation.calc_footprint#

Simulation.calc_footprint(*, grid=None, smooth_factor=None, time_integrate=None, transforms=None)[source]#

Calculate a footprint from the stored particles, without writing it.

This is stilt.calc_footprint() with this simulation’s particles, receptor, and settings filled in. Each setting given replaces the variant’s own. Use it to try other settings; the workers write the variant’s own footprint. A relative file name in a transform’s settings starts from the project directory.

Returns:

The footprint, or None when no particle reaches the grid.

Return type:

DataArray | None

Raises:

TypeError – If the variant has no grid and none is given.
FileNotFoundError – If the particles have not been written yet.

Parameters:

grid (Grid | None)
smooth_factor (float | None)
time_integrate (bool | None)
transforms (Sequence[Any] | None)

Examples

>>> smoother = sim.calc_footprint(smooth_factor=2.0)
>>> fine = sim.calc_footprint(
...     grid=hexes.to_grid(cells_per_target=4)
... )