radtraq.proc.calc_avg_profile

radtraq.proc.calc_avg_profile(_obj, variable=None, mask_variable='cloud_mask_2', mask_value=None, mask_meaning='cloud', first_height=500.0, last_height=15000.0, step_height=50, height_variable=None, ygrid=None)[source]

Function for calculating average profiles from data after applying the cloud mask

Parameters:

  • _obj (Xarray.Dataset) – xarray object with all the data

  • variable (str or list) – List of variables to average

  • mask_variable (string) – Name of mask variable to apply to data

  • mask_value (int) – Value of mask to filter

  • mask_meaning (string) – Mask meaning listed in mask variable flag_meanings. Ignored if mask_value set.

  • first_height (float) – First height to start the analysis. Start at 500 to throw out non-meteorological echo

  • last_height (float) – Last height to end the analysis.

  • step_height (float) – Height step value to use between first_height and last_height to make ygrid.

  • height_variable (string) – Name of the height variable to use. If set to None, will attempt to determine by using coordinate varible name.

  • ygrid (numpy array or list) – Numpy array of ygrid values to interpolate. first_height, last_height, step_height ignored if set.

Returns:

obj – xarray dataset with new variables added

Return type:

Xarray.Dataset

References

Kollias, P., I. Jo, P. Borque, A. Tatarevic, K. Lamer, N. Bharadwaj, K. Widener, K. Johnson, and E.E. Clothiaux, 2014: Scanning ARM Cloud Radars. Part II: Data Quality Control and Processing. J. Atmos. Oceanic Technol., 31, 583–598, https://doi.org/10.1175/JTECH-D-13-00045.1