eelbrain.NDVar.extrema

NDVar.extrema(axis=None, **regions)

Extrema (value farthest away from 0) over given dimensions

For each data point, extremum = max(x) if max(x) >= abs(min(x)) else min(x).

Parameters

• axis (Union[None, str, Sequence[str], NDVar]) – Dimensions over which to operate. A str is used to specify a single dimension, a tuple of str to specify several dimensions, None to compute the maximum over all dimensions. An boolean NDVar with the same dimensions as the data can be used to compute the extrema in specific elements (if the data has a case dimension, the extrema are computed for each case).

• **regions – Regions over which to aggregate. For example, to get the extrema between 0.1 and 0.2 s, use ndvar.extrema(time=(0.1, 0.2)).

• name (str) – Name of the output NDVar (default is the current name).

Returns

Extrema over specified dimensions. Return a Var if only the case dimension remains, and a float if the function collapses over all data.

Return type

extrema

See also

max, min