eelbrain.NDVar.rms

NDVar.rms(self, axis=(), **regions)

Compute the root mean square over given dimensions

Parameters:

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

**regions

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

name : str

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

Returns:

rms : NDVar | Var | float

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