mpnrage_sim

Contents

mpnrage_sim#

torchsim.mpnrage_sim(nshots, flip, TR, T1, diff=None, B1=1.0, inv_efficiency=1.0, M0=1.0, TI=0.0, phases=0.0, device=None, **values)[source]#

MPnRAGE simulator wrapper.

Parameters:

  • nshots (int) – Number of SPGR shots per inversion block.

  • flip (float | npt.ArrayLike) – Flip angle train in degrees.

  • TR (float | npt.ArrayLike) – Repetition time in milliseconds.

  • T1 (float | npt.ArrayLike) – Longitudinal relaxation time in milliseconds.

  • diff (str | tuple[str], optional) – Arguments to get the signal derivative with respect to. The default is None (no differentation).

  • B1 (float | npt.ArrayLike, optional) – Flip angle scaling map, default is 1.0.

  • inv_efficiency (float | npt.ArrayLike, optional) – Inversion efficiency map, default is 1.0.

  • M0 (float or array-like, optional) – Proton density scaling factor, default is 1.0.

  • TI (float | npt.ArrayLike, optional) – Inversion time in milliseconds. The default is 0.0.

  • phases (float or array-like, optional) – Sequence phase schedule in degrees. The default is 0.0.

  • **values (optional) – Additional call-time tissue, protocol or run settings accepted by Simulator.simulate. Settings fixed only at simulator construction remain class-interface features.

  • device (str | torch.device, optional) – Computational device for simulation. The default is None (infer from input).

Returns:

  • sig (npt.ArrayLike) – Signal evolution of shape (..., len(flip)).

  • jac (npt.ArrayLike) – Derivatives of signal wrt diff parameters, of shape (..., len(diff), len(flip)). Not returned if diff is None.

Contents