World Class Reference

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

#include <World.h>

Collaboration diagram for World:

Public Member Functions
void	setTrajLoading (int firstSpin, int paketSize)
	Set trajectory parameters for MPI current sample paket.
long	getTrajBegin ()
	Get trajectory parameters for MPI current sample paket.
long	getTrajNumber ()
virtual	~World ()
	Default destructor.
double	ConcomitantField (double *G)
	Get concomitant field term for the current gradients.
void	SetNoOfSpinProps (int n)
	Set number of spinproperties.
int	GetNoOfSpinProps ()
	Get number of spin properties.
double *	Helper ()
	Reference to helper array.
void	InitHelper (long size)
	Initilize helper array.
int	GetNoOfCompartments ()
	Number of compartments.
void	SetNoOfCompartments (int n)
	Set number of compartments to.

Static Public Member Functions
static World *	instance ()
	Get sole instance of the sequence tree.

Public Attributes
bool	logFile
	Write or not a log file.
bool	logTrajectories
	Write or not a log file for trajectories.
void(*	saveEvolFunPtr )(long l, bool b)
	Pointer to the evolution saving function.
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	LargestM0
	largest equilibrium magnetization for noise scaling
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.
SequenceTree *	pSeqTree
	The main sequence tree.
AtomicSequence *	pAtom
	Atomic sequence responsible for the current time point.
AtomicSequence *	pStaticAtom
	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_trajBegin
	First trajectory to load for current MPI sample paket.
long	m_trajSize
	Number of trajectories to load for current MPI sample paket.
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)
int	m_slice
	slice number
int	m_set
	set number
int	m_contrast
	contrast number
int	m_average
	average number
int	m_shot
	shot number
int	m_shotmax
	total number of shots
int	m_partition
	partition number
int	m_partitionmax
	total number of partitions
string	m_seqSignature
	Sequence signature (md5 sum of Pulseq sequence file)

Private Member Functions
	World ()
	Default constructor.

Static Private Attributes
static World *	m_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

ConcomitantField()

double World::ConcomitantField

(

double *

G

)

Get concomitant field term for the current gradients.

Parameters

G	Current gradients

Returns

Concomitant field term for the current gradients.

GetNoOfCompartments()

int World::GetNoOfCompartments

(

)

Number of compartments.

Returns

Number of compartments

Here is the caller graph for this function:

GetNoOfSpinProps()

int World::GetNoOfSpinProps ( )

inline

Get number of spin properties.

Returns

Number of spin properties

Here is the caller graph for this function:

InitHelper()

void World::InitHelper

(

long

size

)

Initilize helper array.

Parameters

size	Size of helper array

Here is the caller graph for this function:

SetNoOfCompartments()

void World::SetNoOfCompartments

(

int

n

)

Set number of compartments to.

Parameters

n	Number of compartments

Here is the caller graph for this function:

SetNoOfSpinProps()

void World::SetNoOfSpinProps

(

int

n

)

Set number of spinproperties.

Parameters

n	Number of spin properties

Here is the caller graph for this function:

Member Data Documentation

helper

std::vector<double> World::helper

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

saveEvolFunPtr

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

Pointer to the evolution saving function.

Parameters

l	NEEDS documenting
b	NEEDS documenting

---

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

• /Users/stoeckert/DZNE/workspace/jemris/src/World.h
• /Users/stoeckert/DZNE/workspace/jemris/src/World.cpp