PulseB input documentation
==========================


Initialize relaxation time approximation for scattering.


Used to initialize class :class:`qimpy.transport.material.ab_initio.PulseB`.

YAML template:
--------------

.. parsed-literal::

   :yamlparam:`qimpy.transport.material.ab_initio.PulseB:B0`: (0.0, 0.0, 0.0)           :yamlcomment:`# Magnetic field amplitude vector.`
   :yamlparam:`qimpy.transport.material.ab_initio.PulseB:g`: 0.0                        :yamlcomment:`# Gyromagnetic ratio magnitude to calculate mean Larmor frequency.`
   :yamlparam:`qimpy.transport.material.ab_initio.PulseB:g-flip`: 0.0                   :yamlcomment:`# Gyromagnetic ratio magnitude to calculate flip time.`
   :yamlparam:`qimpy.transport.material.ab_initio.PulseB:t-starts`: (0.0,)              :yamlcomment:`# Start times of oscillating magnetic field pulse.`
   :yamlparam:`qimpy.transport.material.ab_initio.PulseB:angles`: (3.141592653589793,)  :yamlcomment:`# Corresponding target spin rotation angles (in radians).`

Parameters:
-----------

B0
++

*Type:* <class 'torch.Tensor'> or <class 'numpy.ndarray'> or :yamltype:`float` or :yamltype:`list` of :yamltype:`float`, *Default:*  (0.0, 0.0, 0.0)

Magnetic field amplitude vector.

g
+

*Type:* :yamltype:`float`, *Default:*  0.0

Gyromagnetic ratio magnitude to calculate mean Larmor frequency.

g-flip
++++++

*Type:* :yamltype:`float`, *Default:*  0.0

Gyromagnetic ratio magnitude to calculate flip time.
May be different from g for anisotropic system.
If unspecified or set to zero, assumed to be same as `g`.

t-starts
++++++++

*Type:* <class 'torch.Tensor'> or <class 'numpy.ndarray'> or :yamltype:`float` or :yamltype:`list` of :yamltype:`float`, *Default:*  (0.0,)

Start times of oscillating magnetic field pulse.

angles
++++++

*Type:* <class 'torch.Tensor'> or <class 'numpy.ndarray'> or :yamltype:`float` or :yamltype:`list` of :yamltype:`float`, *Default:*  (3.141592653589793,)

Corresponding target spin rotation angles (in radians).