radtraq.proc.calc_cloud_mask

radtraq.proc.calc_cloud_mask(obj, variable, height_variable=None, noise_threshold=-45.0, threshold_offset=5.0, counts_threshold=12)[source]

Main function for calculating the cloud mask

Parameters:

  • obj (Xarray.dataset) – ACT object with data

  • variable (string) – Variable name to calculate. Should be a reflectivity.

  • height_variable (string) – Height variable name to use for calculations. If not provided will attempt to use coordinates of data variable.

  • noise_threshold (float) – Threshold value used for noise detection. Greater than this value.

  • threshold_offset (float) – Threshold offset value used for noise detection

  • counts_threshold (int) – Threshold of counts used to determine mask. Greater than or equal to this value.

Returns:

result – Returns the updated dataset with noise floor masks added for each time samplea

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