prepare_environmental_parameters

prepare_environmental_parameters#

torchsim.base.prepare_environmental_parameters(T2, T2_star=None, B0=None)[source]#

Prepare environmental parameters for simulations.

Parameters:

  • T2 (torch.Tensor) – Transverse relaxation time (ms).

  • T2_star (torch.Tensor, optional) – Effective transverse relaxation time including dephasing effects (ms). If not provided, R2’ is set to 0.

  • B0 (torch.Tensor, optional) – Off-resonance frequency (Hz). If not provided, it is set to 0.

Returns:

  • R2 (torch.Tensor) – Transverse relaxation rate (1/s).

  • R2_prime (torch.Tensor) – Rate of additional dephasing due to field inhomogeneities (1/s).

  • B0_rad (torch.Tensor) – Off-resonance frequency (rad/s).

Raises:

ValueError – If T2_star is provided and T2_star >= T2.

Return type:

tuple[Tensor, Tensor, Tensor]