wradlib.vpr.norm_vpr_stats#
- wradlib.vpr.norm_vpr_stats(volume, reference_layer, stat=None, **kwargs)[source]#
Returns the average normalised vertical profile of a volume or any other desired statistics
Given a Cartesian 3-d
volume
and an arbitraryreference layer
index, the function normalises all vertical profiles represented by the volume and computes a static of all profiles (e.g. an average vertical profile using the defaultstat
).- Parameters:
volume (
numpy.ndarray
or) –numpy.ma.MaskedArray
Cartesian 3-d grid with shape (num vertical layers, num x intervals, num y intervals)reference_layer (
int
) – This index defines the vertical layers ofvolume
that is used to normalise all vertical profilesstat (
callable
) – typically a numpy statistics function (defaults to numpy.mean)kwargs (
dict
) – further keyword arguments taken bystat
- Returns:
output (
numpy.ndarray
ornumpy.ma.MaskedArray
) – Array of shape (num vertical layers,) which provides the statistic fromstat
applied over all normalised vertical profiles (e.g. the mean normalised vertical profile ifnumpy.mean
is used)