JEMRIS 2.9.1
open-source MRI simulations
No Matches
List of all members | Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes
Parameters Class Reference

World parameters provide the parametric data of the sequence. More...

#include <Parameters.h>

+ Inheritance diagram for Parameters:
+ Collaboration diagram for Parameters:

Public Member Functions

 ~Parameters ()
 Default destructor.
ParametersClone () const
 Clone. More...
double GetDuration ()
bool Prepare (const PrepareMode mode=PREP_INIT)
void SetDefaults ()
 Set default parameters. More...
- Public Member Functions inherited from Module
 Module ()
 Constructor. More...
virtual ~Module ()
 Destructor. More...
 Module (const Module &)
 Copy constructor. More...
virtual ModuleClone () const =0
 Clone a module. More...
virtual void GetValue (double *dAllVal, double const time)
 Get the value of this element. More...
virtual bool Prepare (const PrepareMode mode)
 Prepare this pulse. More...
void Initialize (DOMNode *node)
 Initialize this module. More...
ModuleGetParent ()
 Get Parent. More...
virtual double GetDuration ()=0
virtual int GetNumOfTPOIs ()
 Get the Number of TPOIs of this module. More...
vector< Module * > GetChildren () const
 Get Children. More...
vector< Module * > GetChildrenDynamic () const
 Get Children dynamic (old non-cached version for dynamic events such as eddy currents) 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...
virtual PrototypeGetParent ()
 Get Parent. More...
virtual PrototypeClone () const =0
 Clone a prototype. More...
virtual bool Prepare (PrepareMode mode)=0
 Prepare this pulse. More...
bool IsPrepared ()
 Check if the Prototype is prepared. More...
virtual void Initialize (DOMNode *conf)=0
 Initialise this prototype. 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...
virtual PrototypeGetPrototypeByAttributeValue (string name, string attrib)
 Get a Prototype by value of 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...

Static Public Member Functions

static Parametersinstance ()
 Get the single instance of the World parameters.
- 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...

Public Attributes

double m_te
 Sequence TE.
double m_tr
 Sequence TR.
double m_ti
 Sequence TI.
double m_td
 Sequence TD.
double m_fov_x
 Sequence FOV in x direction.
double m_fov_y
 Sequence FOV in y direction.
double m_fov_z
 Sequence FOV in z direction.
unsigned int m_iNx
 Sequence image size in x direction.
unsigned int m_iNy
 Sequence image size in y direction.
unsigned int m_iNz
 Sequence image size in z direction.
double m_delta_x
 Sequence image resolution in x direction.
double m_delta_y
 Sequence image resolution in y direction.
double m_delta_z
 Sequence image resolution in z direction.
double m_kmax_x
 Sequence maximum k-value in x direction.
double m_kmax_y
 Sequence maximum k-value in y direction.
double m_kmax_z
 Sequence maximum k-value in z direction.
double m_delta_kx
 Sequence k-space resolution in x direction.
double m_delta_ky
 Sequence k-space resolution in y direction.
double m_delta_kz
 Sequence k-space resolution in z direction.
double m_grad_slew_rate
 Overall maximum gradient slewrate.
double m_grad_max_ampl
 Overall maximum gradient amplitude.
double m_grad_rise_time
 Constant rise time for all trapezoids.

Static Public Attributes

static Parametersm_instance = 0

Additional Inherited Members

- Protected Member Functions inherited from Module
virtual string GetInfo ()
 Get informations on this module. More...
- Protected Attributes inherited from Module
 Reference to the sequence tree.
 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

World parameters provide the parametric data of the sequence.

Member Function Documentation

◆ Clone()

Parameters * Parameters::Clone ( ) const


Clone the Parameters returns a pointer to the single instance.

Implements Module.

+ Here is the call graph for this function:

◆ GetDuration()

double Parameters::GetDuration ( )

See Module::GetDuration

Implements Module.

◆ Prepare()

bool Parameters::Prepare ( const PrepareMode  mode = PREP_INIT)
See also
modePrepare mode (Here only PREP_INIT)

Reimplemented from Module.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetDefaults()

void Parameters::SetDefaults ( )

Set default parameters.

the method is called once during creation of the single instance.

+ Here is the caller graph for this function:

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

-- last change 03.10.2023 | Tony Stoecker | Imprint | Data Protection --