Georeferenced data containing descriptors of the azimuth, gates
and beam height, amongst others.
rad_paramsdict
Radar technical details.
attvarsdict
Polarimetric variables used for the attenuation correction.
mov_avrgf_len2-element tuple or list, optional
Window size used to smooth \(\Phi_{DP}\) by applying a
moving average window. The default is (1, 3). It is
recommended to average \(\Phi_{DP}\) along the range,
i.e. keep the window size in a (1, n) size.
t_spdp: int or float, optional
Discard bins with standard deviations of \(\Phi_{DP}\)
greater than the selected value. The default is 10 deg.
minthr_pdp0: int or float, optional
Tolerance for the true value of \(\Phi_{DP}(r0)\).
Values below this threshold are removed.
The default is -5 deg.
rhohv_min: float, optional
Threshold in \(\rho_{HV}\) used to discard bins
related to nonmeteorological
signals. The default is 0.90
phidp0_correctionBool, optional
If True, adjust \(\Phi_{DP}(r0)\) for each individual
ray.
mlyrMeltingLayer Class, optional
Filter and interpolate PhiDP within the melting layer.
The ml_top (float, int, list or np.array) and ml_bottom
(float, int, list or np.array) must be explicitly defined.
The default is None.
Melting layer class containing the top of the melting layer, (i.e.,
the melting level) and its thickness, in km. Only gates below the
melting layer bottom (i.e. the rain region below the melting layer)
are included in the computation; ml_top and ml_thickness can be
either a single value (float, int), or an array (or list) of values
corresponding to each azimuth angle of the scan. If None, the
function is applied assuming ml_top=5km and ml_thickness=0.5 km.
attc_methodstr
Attenuation correction algorithm to be used. The default is ‘ABRI’:
[ABRI] = Bringi (optimised).
[AFV] = Final value (optimised).
[AHB] = Hitschfeld and Bordan (optimised).
[ZPHI] = Testud (constant parameters).
[BRI] = Bringi (constant parameters).
[FV] = Final value (constant parameters).
[HB] = Hitschfeld and Bordan (constant parameters).
pdp_pxavr_rngint
Pixels to average in \(\Phi_{DP}\) along range: Odd number
equivalent to about 4km, i.e. 4km/range_resolution. The default
is 7.
pdp_pxavr_azmint
Pixels to average in \(\Phi_{DP}\) along azimuth. Must be an
odd number. The default is 1.
pdp_dminfloat
Minimum total \(\Delta\Phi_{DP}\) expected in a ray to perform
attenuation correction (at least 10-20 degrees). The default is 20.
coeff_alpha3-element tuple or list, optional
[Min, max, fixed value] of coeff \(\alpha\). These bounds are
used to find the optimum value of \(\alpha\) from
\(A_H = \alpha K_{DP}\). Default values are
[0.020, 0.1, 0.073], derived for C-band.
coeff_a3-element tuple or list, optional
[Min, max, fixed value] of coeff \(a\). These bounds are
used to find the optimum value of \(a\) from
\(A_H = a Z_{H}^b\). Default values are [1e-5, 9e-5, 3e-5],
derived for C-band.
coeff_b3-element tuple or list, optional
[Min, max, fixed value] of coeff \(b\). These bounds are used
to find the optimum value of \(b\) from
\(A_H = a Z_{H}^b\). Default values are [0.65, 0.85, 0.78],
derived for C-band.
niterint
Number of iterations to find the optimised values of
the coeffs \(a, b, \alpha\). The default is 500.
phidp0int , float or None
Adjusts the value (in deg) of \(\Phi_{DP}(r0)\) for the whole
scan. If None, the function computes the value of the offset by
averaging the value of \(\Phi_{DP}\) in the first ten
consecutive bins classified as rain, according to the cclass. The
default is 0.
plot_methodBool, optional
Plot the ZH attenuation correction method. The default is False.
1. The attenuation is computed up to a user-defined melting level
height.
2. This function uses the shared object ‘lnxlibattenuationcorrection’
or the dynamic link library ‘w64libattenuationcorrection’ depending on
the operating system (OS).
Melting layer class containing the top of the melting layer, (i.e.,
the melting level) and its thickness, in km. Only gates below the
melting layer bottom (i.e. the rain region below the melting layer)
are included in the computation; ml_top and ml_thickness can be
either a single value (float, int), or an array (or list) of values
corresponding to each azimuth angle of the scan. If None, the
function is applied assuming ml_top=5km and ml_thickness=0.5 km.
attc_methodstr
Attenuation correction algorithm to be used. The default is ‘BRI’:
[ABRI] = Bringi (optimised beta parameter).
[BRI] = Bringi (constant beta/alpha ratio).
coeff_beta3-element tuple or list, optional
[Min, max, fixed value] of coeff \(\beta\). These bounds are
used to find the optimum value of \(\beta\).
Default values are [0.002, 0.04, 0.02], derived for C-band.
beta_alpha_ratiofloat, opt
Quotient between \(\alpha\) and \(\beta\) parameters from
\(A_{DP} = ( \beta / \alpha )A_{H}\). The default is 0.265 for
C-band.
rhv_thldfloat
Minimum value of \(\rho_{HV}\) expected in the rain medium.
The default is 0.98.
mov_avrgf_lenint
Odd number used to apply a moving average filter to each beam and
smooth the signal. The default is 5.
minbinsint
Minimum number of bins related to the length of each rain cell
along the beam. The default is 10.
p2avrfint
Number of bins to average on the far side of the rain cell.
The default is 3.
zh_zdr_modelstr
Method used to compute the ZH-ZDR relationship. The “linear” model
uses the relation provided in [2] and [4], whereas the “exp”
model uses the relation proposed by [3].
rparams: dict
Additional parameters describing the ZH-ZDR relationship:
For the linear model: ZH_lower_lim: 20 dBZ, ZH_upper_lim:
45 dBZ, coeff_a: 0.048, coeff_b: 0.774, zdr_max: 1.4