bartorch.tools.whiten

Contents

bartorch.tools.whiten#

bartorch.tools.whiten(input, ndata, *, o=None, c=None, n=False, **extra)#

Apply multi-channel noise pre-whitening on <input> using noise data <ndata>. Optionally output whitening matrix and noise covariance matrix

Runs bart whiten.

Parameters:

  • input (torch.Tensor) – Input array.

  • ndata (torch.Tensor) – Input array.

  • o (torch.Tensor | None) – use external whitening matrix <optmat_in> (-o)

  • c (torch.Tensor | None) – use external noise covariance matrix <covar_in> (-c)

  • n (bool) – normalize variance to 1 using noise data <ndata> (-n)

  • **extra (Any) – Further BART flags, passed through by name.

Returns:

output, optmat_out, covar_out

Return type:

tuple of torch.Tensor

Contents