Base class of all EPG Models#

class sycomore.epg.Base#

Base class for all EPG models

M0(self: sycomore._sycomore.epg.Base, pool: int = 0) → float#

Return the equilibrium magnetization of one of the pools

__init__(*args, **kwargs)#
__len__(self: sycomore._sycomore.epg.Base) → int#

Number of states of the model

apply_pulse(*args, **kwargs)#

Overloaded function.

  1. apply_pulse(self: sycomore._sycomore.epg.Base, angle: sycomore._sycomore.Quantity, phase: sycomore._sycomore.Quantity = 0 [ ]) -> None

Apply an RF hard pulse to a single-pool model

  1. apply_pulse(self: sycomore._sycomore.epg.Base, angle_a: sycomore._sycomore.Quantity, phase_a: sycomore._sycomore.Quantity, angle_B: sycomore._sycomore.Quantity, phase_b: sycomore._sycomore.Quantity) -> None

Apply an RF hard pulse to an two-pools exchange model

  1. apply_pulse(self: sycomore._sycomore.epg.Base, angle_a: sycomore._sycomore.Quantity, phase_a: sycomore._sycomore.Quantity, saturation: float) -> None

Apply an RF pulse to an two-pools magnetization transfer model

property delta_b#

Frequency offset of the second pool

property delta_omega#

Frequency offset of the simulator

property echo#

Echo signal, i.e. \(F_0\)

property elapsed#

Return the elapsed time

k(self: sycomore._sycomore.epg.Base, pool: int) → sycomore._sycomore.Quantity#

Return the exchange constant of one of the pools

property kind#

Return the kind of the model, set at creation

off_resonance(self: sycomore._sycomore.epg.Base, duration: sycomore._sycomore.Quantity) → None#

Simulate field- and species-related off-resonance effects during given duration with given frequency offset

property pools#

Return the number of pools of the model, set at creation

relaxation(self: sycomore._sycomore.epg.Base, duration: sycomore._sycomore.Quantity) → None#

Simulate the relaxation during given duration

set_M0(*args, **kwargs)#

Overloaded function.

  1. set_M0(self: sycomore._sycomore.epg.Base, pool: int, M0: float) -> None

Set the equilibrium magnetization of one of the pools

  1. set_M0(self: sycomore._sycomore.epg.Base, M0: float) -> None

Set the equilibrium magnetization of one of the pools

set_k(self: sycomore._sycomore.epg.Base, pool: int, M0: sycomore._sycomore.Quantity) → None#

Set the exchange constant of one of the pools

property species#
property states#

Return all states in the model, as \(\tilde{F}\), \(\tilde{F}^*\), and \(\tilde{Z}\) for each order and each pool.

property threshold#

Threshold used to cull states with low population