bartorch.tools.bin

Contents

bartorch.tools.bin#

bartorch.tools.bin(label, src, *, l=None, o=False, R=None, C=None, r=None, c=None, a=None, A=None, O=None, x=None, M=False, zero_fill=None, stream=False, **extra)#

Binning

Runs bart bin.

Parameters:

  • label (torch.Tensor) – Input array.

  • src (torch.Tensor) – Input array.

  • l (int | None) – Bin according to the labels, clustered along this axis. (-l)

  • o (bool) – Reorder according to labels (-o)

  • R (int | None) – Quadrature Binning: Number of respiratory labels (-R)

  • C (int | None) – Quadrature Binning: Number of cardiac labels (-C)

  • r (tuple[int, int] | None) – (Respiration: Eigenvector index) (-r)

  • c (tuple[int, int] | None) – (Cardiac motion: Eigenvector index) (-c)

  • a (int | None) – Quadrature Binning: Moving average (-a)

  • A (int | None) – (Quadrature Binning: Cardiac moving average window) (-A)

  • O (tuple[float, float] | None) – Quadrature Binning: Angle offset for resp and card. (-O)

  • x (str | None) – (Output filtered cardiac EOFs) (-x)

  • M (bool) – Amplitude binning (-M)

  • zero_fill (tuple[int, int] | None) – Specify dimension and number of zero filled frames. Zero-filling according to order in label_file. (--zero-fill)

  • stream (bool) – Stream input/output. (--stream)

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

Returns:

dst

Return type:

torch.Tensor

Contents