eelbrain.NDVar.min

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

Compute the minimum over given dimensions

Parameters:

• axis (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 minimum over all dimensions. A boolean NDVar with the same dimensions as the data can be used to compute the minimum in specific elements (if the data has a case dimension, the minimum is computed for each case).

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

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

Returns:

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

Return type:

min

See also

argmin, extrema