JEMRIS  2.8.1
open-source MRI simulations
List of all members | Public Member Functions | Protected Member Functions | Private Attributes
EddyPulse Class Reference

Prototype of an Eddy pulse. More...

#include <EddyPulse.h>

+ Inheritance diagram for EddyPulse:
+ Collaboration diagram for EddyPulse:

Public Member Functions

 EddyPulse ()
 Default constructor.
 
 ~EddyPulse ()
 Default destructor.
 
 EddyPulse (const EddyPulse &)
 Default copy constructor.
 
void Init ()
 initialize .
 
EddyPulseClone () const
 
virtual bool Prepare (PrepareMode mode)
 Prepare the hard RF pulse. More...
 
bool Insert (PrepareMode mode)
 Insert EddyCurrent pulse in sequence tree.
 
bool ConvKernel ()
 compute the convolution kernel
 
double GetAreaNumeric (int steps)
 compute the area of the eddy currents
 
double GetLingerTime ()
 Get linger time of the eddy current (eddy current duration outside its parent atom) More...
 
double GetParentDuration ()
 Get duration of the parent atom of this eddy current. More...
 
virtual void GetValue (double *dAllVal, double const time)
 
virtual double GetGradient (double const time)
 
virtual void SetTPOIs ()
 Allows non-equdistant setting of ADCs via Shape attribute (GiNaC formula) More...
 
void SetGenPulse (GradPulse *pulse)
 Set the pulse which generates the eddy currents.
 
GradPulseGetGenPulse ()
 Get the pulse which generates the eddy currents.
 
AtomicSequenceGetParentAtom ()
 Get the AtomicSequence in which eddy currents were generated.
 
- Public Member Functions inherited from GradPulse
 GradPulse ()
 
virtual ~GradPulse ()
 
 GradPulse (const GradPulse &)
 
virtual bool PrepareNLGfield (PrepareMode mode)
 Preparation of Nonlinear Gradient fields. More...
 
virtual bool PrepareEddyCurrents (PrepareMode mode, int steps=5000)
 Calculate Eddy Currents of this Gradient.
 
double GetAreaNumeric (int steps)
 get the area of this gradient pulse by numerical integration. More...
 
void SetArea (double val)
 Set the area of this gradient pulse. More...
 
void SetNonLinGradField (double const time)
 Set the nonlinear gradient field term World::NonLinGradField. More...
 
bool HasNonLinGrad ()
 Check, whether this gradient is nonlinear. More...
 
virtual void GenerateEvents (std::vector< Event * > &events)
 
- Public Member Functions inherited from Pulse
 Pulse ()
 Construct and initialise some values.
 
virtual ~Pulse ()
 Default destructor.
 
 Pulse (const Pulse &)
 Copy constructor.
 
virtual void GetValue (double *dAllVal, double const time) const
 
void SetDuration (double val)
 Set the duration of this pulse. More...
 
double GetDuration ()
 
void SetAxis (const PulseAxis eAxis)
 Set the Axis of propagation of this pulse. More...
 
PulseAxis GetAxis () const
 Get the Axis of propagation of this pulse. More...
 
int GetNADC ()
 
void SetNADC (unsigned int nadc)
 Set number of ADCs. More...
 
double GetInitialDelay ()
 Get delay in respect of the AtomicSequence holding this pulse. More...
 
void SetPhaseLock (bool val)
 Set phase lock. More...
 
bool GetPhaseLock ()
 Get phase lock. More...
 
- Public Member Functions inherited from Module
 Module ()
 Constructor. More...
 
virtual ~Module ()
 Destructor. More...
 
 Module (const Module &)
 Copy constructor. More...
 
void Initialize (DOMNode *node)
 Initialize this module. More...
 
ModuleGetParent ()
 Get Parent. More...
 
virtual int GetNumOfTPOIs ()
 Get the Number of TPOIs of this module. More...
 
vector< Module * > GetChildren () const
 Get Children. More...
 
ModuleGetChild (unsigned int position) const
 Get Child. More...
 
int GetNumberOfChildren () const
 Get number of Children. More...
 
bool InsertChild (const string &name)
 Insert Child. More...
 
virtual ModuleGetPrototypeByAttributeValue (string name, string attrib)
 Get a Prototype by value of an attribute. More...
 
bool AddDOMattribute (const string attribute, const string value)
 Add attribute and value to the DOM node of this module. More...
 
void AddAllDOMattributes (bool show_hidden=true)
 
virtual TPOIGetTPOIs ()
 get the TPOIs of this module More...
 
void DumpTree (const string &file="", Module *mod=NULL, int ichild=0, int level=0)
 Dump the sequence tree. More...
 
int GetDepth (int depth=0)
 Return tree depth from this module (including depth of Containers) More...
 
int GetHardwareMode ()
 Return the hardware mode of this module. More...
 
bool WriteStaticXML (const string &xml_file)
 Rewrite XML-tree where all expressions are evaluated (for IDEA) More...
 
bool StaticDOM (DOMDocument *doc, DOMNode *node, bool append=true)
 Create a DOM tree where all expressions are evaluated (for IDEA) More...
 
void SetSeqTree (SequenceTree *pST)
 
SequenceTreeGetSeqTree ()
 
- Public Member Functions inherited from Prototype
 Prototype ()
 Constructor. More...
 
virtual ~Prototype ()
 Default destructor. More...
 
 Prototype (const Prototype &)
 Default copy constructor. More...
 
bool IsPrepared ()
 Check if the Prototype is prepared. More...
 
void SetName (string name)
 Set the name of this module. More...
 
DOMNode * GetNode ()
 Get the DOMNode of this module. More...
 
void SetNode (DOMNode *node)
 Set the DOMNode of this module. More...
 
string GetClassType ()
 Get the class type of this prototype. More...
 
Type GetType ()
 Get the module type of this module. More...
 
string GetDOMattribute (const string attribute)
 Get attribute value from the DOMNode. More...
 
bool HasDOMattribute (const string attribute)
 Check, if attribute exists in DOM node of this module. More...
 
AttributeGetAttribute (string name)
 Get an Attribute. More...
 
void CopyObservers (Attribute *a1, Attribute *a2)
 Copy observers from one attribute to another. More...
 
bool HasAttribute (string name)
 Check if an attribute exist. More...
 
void HideAttribute (string attrib, bool observable=true)
 Hide an attribute. More...
 
string GetName ()
 Get the name of this module. More...
 
bool Observe (Attribute *attrib, string prot_name, string attrib_name, bool verbose)
 Set up the list of observations. More...
 
bool Observe (Attribute *attrib, string prot_name, string attrib_name, string attrib_keyword, bool verbose)
 
template<typename T >
bool Notify (const T &val)
 Notify all observers of an attribute. More...
 
template<typename T >
bool NewState (const T &val)
 Check the state of an attribute. More...
 
vector< double > * GetVector ()
 Each Prototype has a double vector as a private member, which values can be filled through XML and accessed from attributes within the same Prototype. More...
 

Protected Member Functions

virtual string GetInfo ()
 

Private Attributes

double m_dt
 
double m_linger_time
 
int m_length
 
vector< double > m_kernel
 Convolution kernel for EC calculation.
 
bool m_prepared
 status whether eddy currents were succesfully prepared
 
GradPulsem_gen_pulse
 The pulse which generates the eddy currents.
 
AtomicSequencem_parent
 The parent atom.
 

Additional Inherited Members

- Static Public Member Functions inherited from Prototype
static bool ReplaceString (string &str, const string &s1, const string &s2)
 A global sub-string replacer. More...
 
static bool ReplaceSymbolString (string &str, const string &s1, const string &s2)
 A global sub-string replacer which replaces only complete symbol strings.
 
static vector< string > Tokenize (const string &str, const string &delimiters=",")
 A global string tokenizer. More...
 
- Protected Attributes inherited from GradPulse
double m_slew_rate
 The slewrate of this gradient pulse.
 
double m_max_ampl
 The maximum amplitude of this gradient pulse.
 
double m_rise_time
 The constant rise time of this gradient pulse.
 
double m_area
 The area of the gradient pulse.
 
bool m_non_lin_grad
 A flag for nonlinear gradients.
 
double m_nlg_field
 Nonlinear gradient field (NLG)
 
double m_nlg_px
 x-position to compute the NLG field
 
double m_nlg_py
 y-position to compute the NLG field
 
double m_nlg_pz
 z-position to compute the NLG field
 
double m_nlg_val
 gradient value to compute the NLG field
 
bool m_eddy_currents
 A flag for nonlinear gradients.
 
double m_eddy_time
 time of eddy current
 
double m_eddy_val
 value of eddy current
 
double m_ec_area
 area of eddy current
 
int m_ec_length
 convolution length of eddy current
 
EddyPulsem_eddy_pulse
 pulse for eddy currents
 
bool m_hide
 Hide this gradient (not played out, but its ECs!)
 
- Protected Attributes inherited from Pulse
PulseAxis m_axis
 
unsigned int m_adc
 
double m_initial_delay
 
bool m_phase_lock
 
- Protected Attributes inherited from Module
SequenceTreem_seq_tree
 Reference to the sequence tree.
 
Parametersm_parameters
 Pointer to the sole instance of the Parameters.
 
TPOI m_tpoi
 Time points of interest are stored the referred repository.
 
string m_info
 Information string for this module.
 
double m_duration
 The duration of this module.
 
int m_calls
 Number of calls of this module.
 
int m_hardware_mode
 Hardware mode (-1: simulation only; 0: both; 1: hardware only)
 
- Protected Attributes inherited from Prototype
bool m_aux
 auxiliary helper variable for debugging purposes
 
bool m_prepared
 True, after the first call to Prepare.
 
string m_name
 Name of this Prototype.
 
DOMNode * m_node
 The node configuring this Module.
 
Type m_type
 The type of the module: one of MOD_PULSE, MOD_ATOM, MOD_CONCAT.
 
vector< double > m_vector
 A vector which elements are accessible through loop counters.
 
map< string, Attribute * > m_attributes
 Map to connect a keyword with an Attribute.
 
vector< Attribute * > m_obs_attribs
 Vector of observed Attributes.
 
vector< string > m_obs_attrib_keyword
 Vector of user-defined Attribute names.
 

Detailed Description

Prototype of an Eddy pulse.

Member Function Documentation

EddyPulse* EddyPulse::Clone ( ) const
inlinevirtual

See Prototype::Clone.

Implements Module.

+ Here is the call graph for this function:

double EddyPulse::GetGradient ( double const  time)
virtual

See GradPulse::GetGradient

Implements GradPulse.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

string EddyPulse::GetInfo ( )
protectedvirtual

Get informations

Returns
Infos for display.

Reimplemented from GradPulse.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

double EddyPulse::GetLingerTime ( )
inline

Get linger time of the eddy current (eddy current duration outside its parent atom)

Returns
linger time
double EddyPulse::GetParentDuration ( )
inline

Get duration of the parent atom of this eddy current.

Returns
duration

+ Here is the call graph for this function:

void EddyPulse::GetValue ( double *  dAllVal,
double const  time 
)
virtual

See GradPulse::GetValue

Reimplemented from GradPulse.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool EddyPulse::Prepare ( PrepareMode  mode)
virtual

Prepare the hard RF pulse.

Parameters
modeSets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.
Returns
Success.

Reimplemented from GradPulse.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void EddyPulse::SetTPOIs ( )
inlinevirtual

Allows non-equdistant setting of ADCs via Shape attribute (GiNaC formula)

See also
Pulse::SetTPOIs()

Reimplemented from Pulse.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Member Data Documentation

double EddyPulse::m_dt
private

convolution smapling interval

int EddyPulse::m_length
private

length of the convolution kernel

double EddyPulse::m_linger_time
private

time of the EC outside the parent atom


The documentation for this class was generated from the following files:

-- last change 17.06.2016 | Tony Stoecker | Imprint --