Sech shaped radio frequency pulses. More...

#include <SechRFPulse.h>

Inheritance diagram for SechRFPulse:

Collaboration diagram for SechRFPulse:

Public Member Functions
	SechRFPulse ()
	Default constructor.

	SechRFPulse (const SechRFPulse &)
	Default copy constructor.

	~SechRFPulse ()
	Default destructor.

SechRFPulse *	Clone () const

virtual bool	Prepare (PrepareMode mode)
	Prepare the hard RF pulse.

virtual double	GetMagnitude (double time)
	Returns the Sech Magnitidue for all times.

virtual void	SetTPOIs ()

virtual double	GetPhase ()

Public Member Functions inherited from RFPulse
	RFPulse ()
	Contructor.

virtual	~RFPulse ()
	Default destructor.

	RFPulse (const RFPulse &rfp)
	Default copy constructor.

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

virtual double	GetIntegralNumeric (int steps)
	Get the B1 integral of this pulse.

double	GetFlipAngle () const
	Get the flip angle of this pulse.

void	SetFlipAngle (const double fa)
	Set the flip angle of this RF pulse.

int	GetChannel () const
	Get the CoilArray channel of this pulse.

void	SetChannel (int ch)
	Set the CoilArray channel of this RF pulse.

double	GetBandWidth ()
	Get the band width of this pulse.

void	insertGetPhaseFunction (double(FGetPhase)(Module , double))
	Add another phase function for this RF pulse.

void	SetCoilArray (CoilArray *pCA)
	Set the CoilArray for this RF pulse.

CoilArray *	GetCoilArray ()
	Get the CoilArray for this RF pulse.

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.

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.

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.

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.

Static Public Member Functions
static double	GetSechPhase (Module *mod, double time)

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.

Protected Attributes
double	m_max_amplitude
	Maximum amplitude.

double	m_sech_phase

Protected Attributes inherited from RFPulse
double	m_flip_angle
	Flipangle of this pulse

double	m_bw
	Bandwidth of this pulse

int	m_channel
	Transmit channel of this pulse.

bool	m_refocusing
	Refocussing pulse?

double	m_symmetry
	KSpace symmetry.

CoilArray *	m_coil_array
	Transmit array in simulation

vector< double()(Module , double)>	m_GetPhaseFunPtrs
	GetPhase functions, adding additional Transmit phase terms.

Protected Attributes inherited from Pulse
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.

Additional Inherited Members
Protected Member Functions inherited from RFPulse
virtual string	GetInfo ()
	Get informations on this Pulse.

Detailed Description

Sech shaped radio frequency pulses.

Member Function Documentation

◆ Clone()

SechRFPulse * SechRFPulse::Clone ( ) const

inlinevirtual

See also: Prototype::Clone()

Implements Module.

Here is the call graph for this function:

◆ GetMagnitude()

double SechRFPulse::GetMagnitude ( double time )

virtual

Returns the Sech Magnitidue for all times.

Parameters

time	The flip angle as double.

Returns: the Magntidue.

Reimplemented from RFPulse.

Here is the call graph for this function:

◆ Prepare()

bool SechRFPulse::Prepare ( PrepareMode mode )

virtual

Prepare the hard RF pulse.

Parameters

mode	Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.

Reimplemented from RFPulse.

Here is the call graph for this function:

◆ SetTPOIs()

void SechRFPulse::SetTPOIs ( )

inlinevirtual

See also: Pulse::SetTPOIs()

Reimplemented from RFPulse.

Here is the call graph for this function:

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

/Users/stoeckert/DZNE/workspace/jemris/src/SechRFPulse.h
/Users/stoeckert/DZNE/workspace/jemris/src/SechRFPulse.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Clone()

◆ GetMagnitude()

◆ Prepare()

◆ SetTPOIs()