bartorch.apodize#

bartorch.apodize()#

Multiply centred k-space by an apodization window over axes.

The window is built over axes and broadcast along the other axes, so every coil, frame or slice is weighted identically.

Parameters:

kspace (torch.Tensor) – Centred k-space: the zero frequency at index n // 2 along axes.
kind ({"fermi", "hann"}, default='fermi') – fermi_window() or hann_window().
axes (tuple of int, default=(-2, -1)) – Axes spanning the k-space grid.
**kwargs – Passed to the window: radius, width and geometry for "fermi", radius and geometry for "hann".

Returns:

The apodized k-space, on the device of kspace.

Return type:

torch.Tensor

Raises:

ValueError – If kind is neither value.

Examples using `apodize`#