pyart.correct.get_mask_fzl#

pyart.correct.get_mask_fzl(radar, fzl=None, doc=None, min_temp=0.0, max_h_iso0=0.0, thickness=None, beamwidth=None, temp_field=None, iso0_field=None, temp_ref='temperature')[source]#

Constructs a mask to mask data placed thickness m below data at min_temp and beyond.

Parameters:

radar (Radar) – The radar object.
fzl (float, optional) – Freezing layer, gates above this point are not included in the correction.
doc (float, optional) – Number of gates at the end of each ray to to remove from the calculation.
min_temp (float, optional) – Minimum temperature below which the data is mask in degrees.
max_h_iso0 (float, optional) – Maximum height relative to the iso0 below which the data is mask in meters.
thickness (float, optional) – Extent of the layer below the first gate where min_temp is reached that is going to be masked.
beamwidth (float, optional) – The radar antenna 3 dB beamwidth.
temp_field (str, optional) – The temperature field. A value of None will use the default field name as defined in the Py-ART configuration file. It is going to be used only if available.
iso0_field (str, optional) – The field containing the height over the 0C isotherm. A value of None will use the default field name as defined in the Py-ART configuration file. It is going to be used only if available.
temp_ref (str, optional) – The field use as reference for temperature. Can be either temperature, height_over_iso0 or fixed_fzl.

Returns:

mask_fzl (2D array) – The values that should be masked.
end_gate_arr (1D array) – The index of the last valid gate in the ray.