eelbrain.NDVar.max

NDVar.max(self, dims=(), **regions)

Compute the maximum over given dimensions

Parameters:

dims : str | tuple of str | boolean 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 maximum in specific elements (if the data has a case dimension, the maximum is computed for each case).

**regions

Regions over which to aggregate. For example, to get the maximum between time=0.1 and time=0.2, use ndvar.max(time=(0.1, 0.2)).

name : str

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

Returns:

max : NDVar | Var | float

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