pwtools.num.rms3d

pwtools.num.rms3d(arr, axis=0, nitems='all')[source]

RMS of 3d array along axis. Sum all elements of all axes != axis.

Parameters:

  • arr (3d array)

  • axis (int) – The axis along which the RMS of all sub-arrays is to be computed (usually time axis in MD).

  • nitems ({'all', float}) – normalization constant, the sum of squares is divided by this number, set to unity for no normalization, if ‘all’ then use nitems = number of elements in each sub-array along axis

Returns:

rms

Return type:

1d array, (arr.shape[axis],)