cngi.vis.time_average

time_average(mxds, vis, bin=1, width=None, span='state', maxuvwdistance=None)[source]

Average data across the time axis

Parameters

  • mxds (xarray.core.dataset.Dataset) – input multi-xarray Dataset with global data

  • vis (str) – visibility partition in the mxds to use

  • bin (int) – number of adjacent times to average, used when width is None. Default=1 (no change)

  • width (str) – resample to width freq (i.e. ’10s’) and produce uniform time steps over span. Ignores bin. Default None uses bin value. see https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html.

  • span (str) – span of the binning. Allowed values are ‘scan’, ‘state’ or ‘both’. Default is ‘state’ (meaning all states in a scan)

  • (future) (maxuvwdistance) – NOT IMPLEMENTED. maximum separation of start-to-end baselines that can be included in an average. (meters)

Returns

New output multi-xarray Dataset with global data

Return type

xarray.core.dataset.Dataset