braindecode.functional.masked_mean

braindecode.functional.masked_mean(x, mask, dim)

Mean over dim of the entries a mask flags.

Parameters:

• x (Tensor) – Tensor to average.

• mask (Optional[Tensor]) – Boolean mask over the leading axes of x (e.g. a ch_mask of shape (batch, n_chans)), True for the entries that count; it is broadcast over the remaining axes. None is a plain mean.

• dim (List[int]) – Axes to average over.

Returns:

x averaged over dim. Masked entries do not count, whatever they hold (even NaN).

Return type:

Tensor