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

Singleton with information about the simulation of the current spin. More...

#include <World.h>

+ Collaboration diagram for World:

Public Member Functions

virtual ~World ()
 Default destructor.
 
double ConcomitantField (double *G)
 Get concomitant field term for the current gradients. More...
 
void SetNoOfSpinProps (int n)
 Set number of spinproperties. More...
 
int GetNoOfSpinProps ()
 Get number of spin properties. More...
 
double * Helper ()
 Reference to helper array.
 
void InitHelper (long size)
 Initilize helper array. More...
 
int GetNoOfCompartments ()
 Number of compartments. More...
 
void SetNoOfCompartments (int n)
 Set number of compartments to. More...
 

Static Public Member Functions

static Worldinstance ()
 Get sole instance of the sequence tree.
 

Public Attributes

void(* saveEvolFunPtr )(long l, bool b)
 Pointer to the evolution saving function. More...
 
void * solverSettings
 Arbitrary solver settings.
 
bool solverSuccess
 true, if last calculation successful
 
void * auxiliary
 Auxiliary data any kind of container needed for static methods can go here.
 
long SpinNumber
 Number of the current spin.
 
long TotalSpinNumber
 Total number of spins.
 
long TotalADCNumber
 Total number of spins.
 
double * Values
 Values of the current spin (position and physical parameters)
 
double time
 Current time point (in atom)
 
double total_time
 Current time point (absolut time)
 
double phase
 Receiver phase taken from the TPOIs.
 
double PhaseLock
 Locked Phase (the phase set by the last RF pulse)
 
double deltaB
 Any off-resonance terms.
 
std::vector< double > solution
 Solution [M_r, phi, M_z] at the current time point.
 
double RandNoise
 percentage of random noise added to the signal
 
double GMAXoverB0
 Constant for the concomitant field term.
 
double NonLinGradField
 Non-linear contribution to B_z from gradients.
 
SequenceTreepSeqTree
 The main sequence tree.
 
AtomicSequencepAtom
 Atomic sequence responsible for the current time point.
 
AtomicSequencepStaticAtom
 Atomic sequence responsible for all time points.
 
int saveEvolStepSize
 Step-size (in numbers of ADC) at which the evolution is stored.
 
string saveEvolFileName
 Filename in which the evolution is stored.
 
ofstream * saveEvolOfstream
 Output stream for saving the evolutions.
 
int m_myRank
 MPI rank of this process. if m_myRank<0 process is serial jemris.
 
bool m_useLoadBalancing
 use load balancing (send sample in small packages top slaves)
 
int m_no_processes
 number of parallel processes; used by load balancing
 
long m_startSpin
 start calculation with this spin ( in case of restart)
 
int m_noofspinprops
 

of spin properties


 
int m_noofspincompartments
 
std::vector< double > helper
 
multimap< EddyPulse *, double > m_eddies
 map of remaining eddies still to be played out (duration,pointer)
 

Private Member Functions

 World ()
 Default constructor.
 

Static Private Attributes

static Worldm_instance = 0
 Pointer to the sole instance of this implementation.
 

Detailed Description

Singleton with information about the simulation of the current spin.

Member Function Documentation

double World::ConcomitantField ( double *  G)

Get concomitant field term for the current gradients.

Parameters
GCurrent gradients
Returns
Concomitant field term for the current gradients.
int World::GetNoOfCompartments ( )

Number of compartments.

Returns
Number of compartments

+ Here is the caller graph for this function:

int World::GetNoOfSpinProps ( )
inline

Get number of spin properties.

Returns
Number of spin properties

+ Here is the caller graph for this function:

void World::InitHelper ( long  size)

Initilize helper array.

Parameters
sizeSize of helper array

+ Here is the caller graph for this function:

void World::SetNoOfCompartments ( int  n)

Set number of compartments to.

Parameters
nNumber of compartments

+ Here is the caller graph for this function:

void World::SetNoOfSpinProps ( int  n)

Set number of spinproperties.

Parameters
nNumber of spin properties

+ Here is the caller graph for this function:

Member Data Documentation

std::vector<double> World::helper

Number of spin compartments (i.e. MT pools etc.)

void(* World::saveEvolFunPtr) (long l, bool b)

Pointer to the evolution saving function.

Parameters
lNEEDS documenting
bNEEDS documenting

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

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