tools.phasepole

Contents

tools.phasepole#

bartorch.tools.phasepole()#

Detect and sample phase poles.

Runs bart phasepole.

Parameters:

  • input__coils_singularity_positions_ (torch.Tensor | None, default=None) – Input array. Optional.

  • estimate (bool, default=False) – Estimate phase poles (input is sensitivity maps / output is singularity positions) (-e)

  • sample (bool, default=False) – Sample phase poles (input is position / phase) (-s)

  • espirit (bool, default=False) – Use ESPIRiT mode (diameter=1, no closing) (--espirit)

  • dims (tuple[int, int, int] | None, default=None) – Explicitly specify image dimensions (-x)

  • c (str | None, default=None) – output curl map (-c)

  • w (str | None, default=None) – (output weighting map) (-w)

  • a (str | None, default=None) – (output averaged curl map) (-a)

  • t (float | None, default=None) – threshold for pole detection (-t)

  • d (float | None, default=None) – diameter of curve integral to detect poles (in FoV) (-d)

  • closing (float | None, default=None) – (radius of closing ball (in FoV)) (--closing)

  • center (tuple[float, float, float] | None, default=None) – specify position of phase pole to sample (--center)

  • n (int | None, default=None) – normal direction for 2D pole detection (0,1,2) (-n)

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

Returns:

output (sampled phase/singularity positions)

Return type:

torch.Tensor

Contents