wradlib Documentation - Bitbucket

wradlib Documentation, Release 0.1.1
constr_args : list
list of lists, which are to be passed to the individual constraint functions using the *args
mechanism (len(constr_args) == len(constraints))
diagnostics : dictionary
dictionary of variables, which are usually not returned by the function but may be of
interest for research or during testing. Defaults to {}, in which case no diagnostics are
generated. If a dictionary with certain keys is passed to the function, the respective
diagnostics are generated. Currently implemented diagnostics:
• ‘a’ - returns the values of the a coefficient of the k-Z relation, which was used to
calculate the attenuation for the respective beam as a np.array. The shape of the
returned array will be gateset.shape[:-1].
Returns k : array
Array with the same shape as gateset containing the calculated attenuation [dB] for
each range gate.
Raises AttenuationOverflowError :
Exception, if not all constraints are satisfied even with the smallest possible linear coefficient
(a_min) and no handling mode is set.
Examples
>>> # Implementing the original Hitschfeld & Bordan (1954) algorithm with
>>> # otherwise default parameters
>>> k = correctAttenuationConstrained(gateset, n=1, mode=’nan’)
>>> # Implementing the basic Kraemer algorithm
>>> k = correctAttenuationConstrained(gateset,
... mode=’nan’,
... constraints=[constraint_dBZ],
... constr_args=[[59.0]])
>>> # Implementing the PIA algorithm by Jacobi et al.
>>> k = correctAttenuationConstrained(gateset,
... mode=’nan’,
... constraints=[constraint_dBZ,
... constraint_PIA],
... constr_args=[[59.0],
... [20.0]])
3.12.5 wradlib.atten.constraint_dBZ
wradlib.atten.constraint_dBZ(gateset, k, thrs_dBZ)
Constraint callback function for correctAttenuationConstrained. Selects beams, in which at least one pixel
exceeds thrs_dBZ [dBZ].
3.12.6 wradlib.atten.constraint_PIA
wradlib.atten.constraint_PIA(gateset, k, thrs_PIA)
Constraint callback function for correctAttenuationConstrained. Selects beams, in which the path integrated
attenuation exceeds thrs_PIA.
3.12. Attenuation Correction 63