eddy_footprint.calc_footprint#

eddy_footprint.calc_footprint(*, air_pressure: numpy.ndarray, air_temperature: numpy.ndarray, friction_velocity: numpy.ndarray, wind_speed: numpy.ndarray, cross_wind_variance: numpy.ndarray, wind_direction: numpy.ndarray, monin_obukhov_length: numpy.ndarray, time: numpy.ndarray, instrument_height: float, roughness_length: float, domain_length: Optional[int] = 1000, resolution: Optional[int] = 5, workers: Optional[int] = 1, method: Optional[Literal['Hsieh', 'Kormann & Meixner']] = 'Hsieh') xarray.core.dataarray.DataArray[source]#

Create a dataset with footprint influences from eddy covariance measurements.

Warning

This function is experimental and its signature may change.

Parameters
air_pressurenp.ndarray

Array with measurement of air pressure in units Pa.

air_temperaturenp.ndarray

Array with measurments of air temperature in degrees K.

friction_velocitynp.ndarray

Array with measurements of friction veloicty (u*) in meters per second.

wind_speednp.ndarray

Array with horizontal (u) wind velocity in meters per second.

cross_wind_variancenp.ndarray

Array with cross wind (v) variance in meters^2 per second^2.

wind_directionnp.ndarray

Array with down wind direction in degrees, where N/S is at 0/360 degrees.

monin_obukhov_lengthnp.ndarray

Array with Monin-Obukhov length in meters.

timenp.ndarray

Array with time, a datetime object, filename, or other unique identifier. time will serve as the third dimension. time need not be continuous or regular, but cannot have duplicates.

instrument_heightfloat

Constant for the instrument (sonic anemometer) height in meters above ground.

roughness_lengthfloat

Constant for the site roughness length (z_not) in meters.

domain_lengthint, optional

Integer for the domain length in meters. The extent in downwind and crosswind directions used in footprint calculations. The x and y dimensions of the output xarray are twice the domain length, with the eddy covaiance tower located at (0,0). Default: 1000.

resolutionint, optional

Integer for the resolution in meters used in the footprint calculations and x and y dimensions. Default: 5.

workersint, optional

Number of workers to use for parallel processing during interpolation step. If -1 is given all CPU threads are used. Default: 1.

methodHsieh or Kormann & Meixner, optional

The footprint model method to use, either Hsieh or Kormann & Meixner. Default: Hsieh.

Returns
da: xarray.DataArray

DataArray with footprints of influence.