stilt.observations.plume_background#
- stilt.observations.plume_background(longitudes, latitudes, values, plume, *, uncertainties=None, side=None, width=0.5, pad=0.1, trim=0.9)[source]#
Background from the soundings next to, but outside, the plume.
The soundings inside
plumeare the enhanced ones. Around them a box is drawn, the bounding box of the in-plume soundings padded bypadtimes its size, and the out-of-plume soundings withinwidthdegrees of that box on each side are the background candidates.sidepicks one side (choose the upwind one; the forward particles’ drift tells you which);Nonepools all four.trimfirst drops the out-of-plume soundings above that quantile of their values, X-STILT’s guard against enhanced air the plume outline missed;Nonekeeps them all. The background is the median of what remains.Pass only good-quality soundings. Raises when no sounding falls inside the plume, because then the overpass did not see it.
- Return type:
PlumeBackground- Parameters:
longitudes (_Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes])
latitudes (_Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes])
values (_Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes])
plume (Plume | Polygon)
uncertainties (_Buffer | _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes] | None)
side (Literal['north', 'south', 'east', 'west'] | None)
width (float)
pad (float)
trim (float | None)