wradlib Documentation - Bitbucket

wradlib Documentation, Release 0.1.1
initial value for linear coefficient of the k-Z relation ( k = a ∗ Z b ). Per default set to
1.67e-4.
a_min : float
minimal allowed linear coefficient of the k-Z relation ( k = a ∗ Z b ) in the downwards
iteration of a in case of signal overflow (sum of signal and attenuation exceeds the
threshold thrs). Per default set to 2.33e-5.
b : float
exponent of the k-Z relation ( k = a ∗ Z b ). Per default set to 0.7.
n : integer
l : float
number of iterations from a_max to a_min. Per default set to 30.
length of a range gate [km]. Per default set to 1.0.
mode : string
Controls how the function reacts in case of signal overflow (sum of signal and attenuation
exceeds the threshold thrs). Possible values:
‘warn’ : emit a warning through the module’s logger but continue execution
‘zero’ : set offending gates to 0.0
‘nan’ : set offending gates to nan
Per default set to ‘zero’. Any other mode will raise an Exception.
thrs_dBZ : float
Threshold, for the attenuation corrected signal [dBZ], which is deemed unplausible. Per
default set to 59.0 dBZ.
Returns pia : array
Array with the same shape as gateset containing the calculated attenuation [dB] for
each range gate.
Raises AttenuationOverflowError :
Exception, if attenuation exceeds thrs even with smallest possible linear coefficient
(a_min) and no handling mode is set.
References
[Kraemer2008]
3.12.3 wradlib.atten.correctAttenuationHJ
wradlib.atten.correctAttenuationHJ(gateset, a_max=0.000167, a_min=2.33e-05, b=0.7, n=30,
l=1.0, mode=’zero’, thrs_dBZ=59.0, max_PIA=20.0)
Gate-by-Gate attenuation correction based on Stefan Kraemer [Kraemer2008], expanded by Stephan Jacobi,
Maik Heistermann and Thomas Pfaff [Jacobi2011].
Parameters gateset : array
60 Chapter 3. Library Reference