bartorch.tools.sim

Contents

bartorch.tools.sim#

bartorch.tools.sim(*, T1=None, T2=None, BLOCH=False, BMC=False, ROT=False, ODE=False, STM=False, split_dim=False, seq=None, other=None, pool=None, CEST=None, **extra)#

simulation tool

Runs bart sim.

Parameters:

  • T1 (tuple[float, float, float] | None) – range of T1 values (-1)

  • T2 (tuple[float, float, float] | None) – range of T2 values (-2)

  • BLOCH (bool) – Bloch Equations (default) (--BLOCH)

  • BMC (bool) – Bloch-McConnell Equations (--BMC)

  • ROT (bool) – discretized simulation based on rotational matrices (--ROT)

  • ODE (bool) – ordinary differential equation solver (default) (--ODE)

  • STM (bool) – solver based on state-transition matrices (--STM)

  • split_dim (bool) – split magnetization into x, y, and z component (--split-dim)

  • seq (str | None) – configure sequence parameter (--seq)

  • other (str | None) – configure other parameters (--other)

  • pool (str | None) – configure parameters for 2nd->5th pool (--pool)

  • CEST (str | None) – configure parameters for CEST (--CEST)

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

Returns:

signal: Mxy, Partial derivatives: dR1, dM0, dR2, dB1

Return type:

tuple of torch.Tensor

Contents