bartorch.tools.ssa

Contents

bartorch.tools.ssa#

bartorch.tools.ssa(src, *, w=None, z=False, m=None, n=None, r=None, g=None, **extra)#

Perform SSA-FARY or Singular Spectrum Analysis. <src>: [samples, coordinates]

Runs bart ssa.

Parameters:
  • src (torch.Tensor) – Input array.

  • w (int | None) – Window length (-w)

  • z (bool) – Zeropadding [Default: True] (-z)

  • m (int | None) – Remove mean [Default: True] (-m)

  • n (int | None) – Normalize [Default: False] (-n)

  • r (int | None) – Rank for backprojection. r < 0: Throw away first r components. r > 0: Use only first r components. (-r)

  • g (int | tuple[int, ...] | None) – Grouping, as a set of indices. (-g)

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

Returns:

EOF, S, backprojection

Return type:

tuple of torch.Tensor