mrsprint.system package

Submodules

mrsprint.system.gradient module

Module for gradient related classes and functions.

Authors:
Since:
2017/07/01

Todo

Change nameOfFunctions to name_of_functions.

class mrsprint.system.gradient.Gradient(**opts)[source]

Bases: pyqtgraph.parametertree.parameterTypes.GroupParameter

Class that represents the gradients parameters in the sistem.

mrsprint.system.gradient.gradient_delay(duration, dt, number_of_points=0)[source]

Generate a delay of gradient pulse.

Parameters:
  • duration (float [s]) – Delay time.
  • dt (float [s]) – Time resolution.
  • number_of_points (int) – Number of points.
Returns:

Gradient delay - a zero x, y and z gradient components

Return type:

np.array

mrsprint.system.gradient.gradient_duration(gradient_event, dt)[source]

Return the duration of the gradient event (array).

It is based on the size and dt.

Parameters:
  • gradient_event (np.array) – An array of event.
  • dt (float [s]) – Value of time resolution.
Returns:

Duration of the event.

Return type:

float [s]

Todo

Regard the dimensions of the array.

mrsprint.system.magnet module

Module for magnet related classes and functions.

Authors:
Since:
2017/07/01

Todo

Maybe put all config together in magnet classes.

class mrsprint.system.magnet.Magnet(magnet_config, **opts)[source]

Bases: pyqtgraph.parametertree.parameterTypes.GroupParameter

Class that represents the parameters in the magnet.

Parameters:magnet_config (MagnetConfig) – An object that represents the limits to this magnet.
class mrsprint.system.magnet.MagnetConfig(**opts)[source]

Bases: pyqtgraph.parametertree.parameterTypes.GroupParameter

Class that configure the limit parameters of the magnet.

mrsprint.system.rf module

Module for radiofrequency related classes and functions.

Authors:
Since:
2017/07/01
class mrsprint.system.rf.RF(**opts)[source]

Bases: pyqtgraph.parametertree.parameterTypes.GroupParameter

Class that represents the RF parameters in the system.

mrsprint.system.rf.rf_delay(duration, dt)[source]

Generate a delay of rf pulse.

Parameters:
  • duration (float [s]) – Delay time.
  • dt (float [s]) – Time resolution.
Returns:

Rf delay - a zero am, pm, fm components in complex format.

Return type:

np.array(complex)

mrsprint.system.rf.rf_duration(rf_event, dt)[source]

Return the duration of the rf event (array) based on the number of the points and dt.

Parameters:
  • rf_event (np.array) – An array of event.
  • dt (float [s]) – Value of time resolution.
Returns:

duration of the event.

Return type:

float [s]

Todo

Regard the dimensions of the array.

mrsprint.system.rf.square_rf_pulse(dt, gamma, b1_max, flip_angle=90, phase=0.0, degrees=True)[source]

Generate a hard rf pulse with a specific and constant flip angle and phase.

Parameters:
  • dt (float [s]) – Value of time resolution.
  • gamma (float [rad/(G*s)]) – Gyromagnetic ratio of the excited nuclei.
  • b1_max (float [G]) – Max RF amplitude.
  • flip_angle (float [degrees, radians]) – Array of flip angle for rf pulse in degrees (if degrees = True).
  • phase (float [degrees, radians]) – Array of phase angle for rf pulse in degrees (if degrees = True).
  • degrees (bool) – Inform if the input is in degrees or radians.
Returns:

A square rf pulse in imaginary form.

Return type:

np.array(complex)

Module contents

Package for system related classes and objects.

Authors:
Since:
2015/11/01