anaflow.tools.mean.annular_fmean
- annular_fmean(func, val_arr, f_def, f_inv, ann_dim=2, arg_dict=None, **kwargs)[source]
Calculating the annular generalized f-mean.
Calculating the annular generalized f-mean of a radial symmetric function for given consecutive radii defining annuli by the following formula
\[\varphi_i=f^{-1}\left(\frac{d}{r_{i+1}^d-r_i^d} \intop^{r_{i+1}}_{r_i} r^{d-1}\cdot f(\varphi(r))\, dr \right)\]- Parameters
func (
callable
) – Function that should be used (\(\varphi\) in the formula). The first argument needs to be the radial variable:func(r, **kwargs)
val_arr (
numpy.ndarray
) – Radii defining the annuli.ann_dim (
float
, optional) – The dimension of the annuli. Default:2.0
f_def (
callable
) – Function defining the f-mean.f_inv (
callable
) – Inverse of the function defining the f-mean.arg_dict (
dict
orNone
, optional) – Keyword-arguments given as a dictionary that are forwarded to the function given infunc
. Will be merged with**kwargs
. This is designed for overlapping keywords inannular_fmean
andfunc
. Default:None
**kwargs – Keyword-arguments that are forwarded to the function given in
func
. Will be merged witharg_dict
- Returns
Array with all calculated arithmetic means
- Return type
- Raises
ValueError – If func is not callable.
ValueError – If f_def is not callable.
ValueError – If f_inv is not callable.
ValueError – If
val_arr
has less than 2 values.ValueError – If
val_arr
is not sorted in incresing order.
Notes
If the last value in val_arr is “inf”, the given function should provide a value for “inf” as input:
func(float("inf"))