Pulse Class Reference

Pulse Super Class. ABC for all RF and gradient pulses. More...

#include <Pulse.h>

Inheritance diagram for Pulse:

Collaboration diagram for Pulse:

Public Member Functions
	Pulse ()
	Construct and initialise some values.
virtual	~Pulse ()
	Default destructor.
	Pulse (const Pulse &)
	Copy constructor.
virtual void	GetValue (double *dAllVal, double const time) const
virtual bool	Prepare (const PrepareMode mode)
	see Module::Prepare()
void	SetDuration (double val)
	Set the duration of this pulse.
double	GetDuration ()
void	SetAxis (const PulseAxis eAxis)
	Set the Axis of propagation of this pulse.
PulseAxis	GetAxis () const
	Get the Axis of propagation of this pulse.
virtual void	SetTPOIs ()
	Set time points of interest.
virtual void	GenerateEvents (std::vector< Event * > &events)
	Generate an event to run on scanner hardware.
int	GetNADC ()
void	SetNADC (int nadc)
	Set number of ADCs.
int	GetADCFlag ()
void	SetADCFlag (int adcflag)
	Set ADC flag.
double	GetInitialDelay ()
	Get delay in respect of the AtomicSequence holding this pulse.
Public Member Functions inherited from Module
	Module ()
	Constructor.
virtual	~Module ()
	Destructor.
	Module (const Module &)
	Copy constructor.
virtual Module *	Clone () const =0
	Clone a module.
virtual void	GetValue (double *dAllVal, double const time)
	Get the value of this element.
void	Initialize (DOMNode *node)
	Initialize this module.
Module *	GetParent ()
	Get Parent.
virtual int	GetNumOfTPOIs ()
	Get the Number of TPOIs of this module.
vector< Module * >	GetChildren () const
	Get Children.
vector< Module * >	GetChildrenDynamic () const
	Get Children dynamic (old non-cached version for dynamic events such as eddy currents)
Module *	GetChild (unsigned int position) const
	Get Child.
int	GetNumberOfChildren () const
	Get number of Children.
bool	InsertChild (const string &name)
	Insert Child.
virtual Module *	GetPrototypeByAttributeValue (string name, string attrib)
	Get a Prototype by value of an attribute.
bool	AddDOMattribute (const string attribute, const string value)
	Add attribute and value to the DOM node of this module.
void	AddAllDOMattributes (bool show_hidden=true)
virtual TPOI *	GetTPOIs ()
	get the TPOIs of this module
void	DumpTree (const string &file="", Module *mod=NULL, int ichild=0, int level=0)
	Dump the sequence tree.
int	GetDepth (int depth=0)
	Return tree depth from this module (including depth of Containers)
int	GetHardwareMode ()
	Return the hardware mode of this module.
bool	WriteStaticXML (const string &xml_file)
	Rewrite XML-tree where all expressions are evaluated (for IDEA)
bool	StaticDOM (DOMDocument *doc, DOMNode *node, bool append=true)
	Create a DOM tree where all expressions are evaluated (for IDEA)
void	SetSeqTree (SequenceTree *pST)
SequenceTree *	GetSeqTree ()
Public Member Functions inherited from Prototype
	Prototype ()
	Constructor.
virtual	~Prototype ()
	Default destructor.
	Prototype (const Prototype &)
	Default copy constructor.
bool	IsPrepared ()
	Check if the Prototype is prepared.
void	SetName (string name)
	Set the name of this module.
DOMNode *	GetNode ()
	Get the DOMNode of this module.
void	SetNode (DOMNode *node)
	Set the DOMNode of this module.
string	GetClassType ()
	Get the class type of this prototype.
Type	GetType ()
	Get the module type of this module.
string	GetDOMattribute (const string attribute)
	Get attribute value from the DOMNode.
bool	HasDOMattribute (const string attribute)
	Check, if attribute exists in DOM node of this module.
Attribute *	GetAttribute (string name)
	Get an Attribute.
void	CopyObservers (Attribute *a1, Attribute *a2)
	Copy observers from one attribute to another.
bool	HasAttribute (string name)
	Check if an attribute exist.
void	HideAttribute (string attrib, bool observable=true)
	Hide an attribute.
string	GetName ()
	Get the name of this module.
bool	Observe (Attribute *attrib, string prot_name, string attrib_name, bool verbose)
	Set up the list of observations.
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.
template<typename T >
bool	NewState (const T &val)
	Check the state of an attribute.
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.
Public Member Functions inherited from TxRxPhase
	TxRxPhase ()
	Constructor.
virtual	~TxRxPhase ()
	Default destructor.
void	SetInitialPhase (double val)
	Get phase of this pulse.
bool	GetPhaseLock ()
	Get phase lock of this pulse.
void	SetPhaseLock (bool bval)
	Set phase lock of this pulse.
double	GetInitialPhase ()
	Get initial phase of this pulse.
double	GetFrequency ()
	Get constant frequency for linear phase terms.
void	SetFrequency (double val)
	Set constant frequency for linear phase terms.

Protected Member Functions
virtual string	GetInfo ()

Protected Attributes
PulseAxis	m_axis
int	m_adc
int	m_adc_flag
double	m_initial_delay
Protected Attributes inherited from Module
SequenceTree *	m_seq_tree
	Reference to the sequence tree.
Parameters *	m_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.
Protected Attributes inherited from TxRxPhase
double	m_initial_phase
	Initial Phase of this phase event.
bool	m_phase_lock
	Phase lock of this phase event.
double	m_frequency
	A constant frequency to set linear phase terms.

Friends
class	AnalyticPulseShape
class	ExternalPulseData

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.
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.
Static Public Member Functions inherited from TxRxPhase
static double	getLinearPhase (Module *mod, double time)
	A general purpose linear additive phase term.

Detailed Description

Pulse Super Class. ABC for all RF and gradient pulses.

Member Function Documentation

GenerateEvents()

virtual void Pulse::GenerateEvents ( std::vector< Event * > & events )

inlinevirtual

Generate an event to run on scanner hardware.

Must be overloaded by pulse shapes. New events are allocated on the heap and pointers are stored in the events vector.

Parameters

events

vector to store new events

Reimplemented in EmptyPulse, GradPulse, RFPulse, and TrapGradPulse.

Here is the caller graph for this function:

GetADCFlag()

int Pulse::GetADCFlag ( )

inline

Returns

Get ADC flag

ADC flag

GetAxis()

PulseAxis Pulse::GetAxis ( ) const

inline

Get the Axis of propagation of this pulse.

Get the Axis of propagation of this pulse to the given PulseAxis.

Returns

Axis of propagation.

Here is the caller graph for this function:

GetDuration()

double Pulse::GetDuration ( )

inlinevirtual

See Module::GetDuration

Implements Module.

Here is the call graph for this function:

Here is the caller graph for this function:

GetInfo()

string Pulse::GetInfo ( )

protectedvirtual

Get informations on this Pulse

Returns

Infos

Reimplemented from Module.

Reimplemented in AnalyticGradPulse, AnalyticRFPulse, ConstantGradPulse, EddyPulse, EmptyPulse, ExternalGradPulse, ExternalRFPulse, GradPulse, RFPulse, SincRFPulse, SpiralGradPulse, TrapGradPulse, and TriangleGradPulse.

Here is the caller graph for this function:

GetInitialDelay()

double Pulse::GetInitialDelay ( )

inline

Get delay in respect of the AtomicSequence holding this pulse.

Returns

Delay in respect to start of the AtomicSequence.

Here is the caller graph for this function:

GetNADC()

int Pulse::GetNADC ( )

inline

Returns

Get number of ADCs

Number of ADCs

Here is the caller graph for this function:

GetValue()

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

inlinevirtual

See Module::GetValue

Prepare()

bool Pulse::Prepare ( const PrepareMode mode )

virtual

see Module::Prepare()

Reimplemented from Module.

Reimplemented in AnalyticGradPulse, ConstantGradPulse, ExternalGradPulse, ExternalRFPulse, HardRFPulse, RFPulse, SpiralGradPulse, TriangleGradPulse, AnalyticRFPulse, EddyPulse, EmptyPulse, GaussianRFPulse, GradPulse, SechRFPulse, SincRFPulse, and TrapGradPulse.

Here is the call graph for this function:

Here is the caller graph for this function:

SetADCFlag()

void Pulse::SetADCFlag ( int adcflag )

inline

Set ADC flag.

Parameters

nadc

Here is the call graph for this function:

Here is the caller graph for this function:

SetAxis()

void Pulse::SetAxis ( const PulseAxis eAxis )

inline

Set the Axis of propagation of this pulse.

Set the Axis of propagation of this pulse to the given PulseAxis.

Parameters

eAxis

the axis as stated above.

Here is the caller graph for this function:

SetDuration()

void Pulse::SetDuration

(

double

val

)

Set the duration of this pulse.

Set the duration of this pulse to the given double value.

Parameters

val	double as stated above.

Here is the caller graph for this function:

SetNADC()

void Pulse::SetNADC ( int nadc )

inline

Set number of ADCs.

Parameters

nadc

Here is the call graph for this function:

Here is the caller graph for this function:

SetTPOIs()

void Pulse::SetTPOIs ( )

inlinevirtual

Set time points of interest.

Must be overloaded by non-constant pulse shapes! Further, the function needs to be called every time the PulseShape changes its timing!!!

Reimplemented in EddyPulse, EmptyPulse, ExternalGradPulse, ExternalRFPulse, GaussianRFPulse, RFPulse, SechRFPulse, SincRFPulse, and TrapGradPulse.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_adc

int Pulse::m_adc

protected

Number of ADCs

m_adc_flag

int Pulse::m_adc_flag

protected

Property of ADCs (see TPOI)

m_axis

PulseAxis Pulse::m_axis

protected

The axis of this pulse

m_initial_delay

double Pulse::m_initial_delay

protected

Time shift at the beginning inside the atom

---

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

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