ppcpy.cloudmask.cloudscreen#

Functions

cloudScreen_MSG

CLOUDSCREEN_MSG cloud screen with maximum signal gradient.

cloudScreen_Zhao

cloudscreen

smooth_signal

Uniformly smooth the input signal
ppcpy.cloudmask.cloudscreen.smooth_signal(signal: ndarray, window_len: int) → ndarray[source]#

Uniformly smooth the input signal

Parameters:

  • singal (ndarray) – Signal to be smooth

  • window_len (int) – Width of the applied uniform filter

Returns:

  • ndarray – Smoothed signal

  • History

  • ——-

  • - 2026-02-04 Changed from scipy.ndimage.uniform_filter1d to ppcpy.misc.helper.uniform_filter

ppcpy.cloudmask.cloudscreen.cloudscreen(data_cube)[source]#
ppcpy.cloudmask.cloudscreen.cloudScreen_MSG(height, RCS, slope_thres, search_region)[source]#

CLOUDSCREEN_MSG cloud screen with maximum signal gradient.

INPUTS:
height: array

Height in meters.

signal: array (time, height) !! this is transposed compared to the original implementation

Photon count rate in MHz.

slope_thres: float

Threshold of the slope to determine whether there is strong backscatter signal. [MHz*m]

search_region: list or array (2 elements)

[baseHeight, topHeight] in meters.

OUTPUTS:
flagCloudFree: boolean array

Indicates whether the profile is cloud free.

layerStatus: matrix (height x time)

Layer status for each bin (0: unknown, 1: cloud, 2: aerosol).

HISTORY:

  • 2021-05-18: First edition by Zhenping

  • 2025-03-20: Translated into python

ppcpy.cloudmask.cloudscreen.cloudScreen_Zhao(height, RCS, slope_thres, search_region)[source]#