RFPulse Class Reference

Super class for all RF pulses. More...

#include <RFPulse.h>

Inheritance diagram for RFPulse:

Collaboration diagram for RFPulse:

List of all members.

Public Member Functions
	RFPulse ()
	Contructor.
virtual	~RFPulse ()
	Default destructor.
	RFPulse (const RFPulse &)
	Default copy constructor.
virtual void	GetValue (double *dAllVal, double const time)
	see Module::GetValue()
virtual bool	Prepare (PrepareMode mode)
	see Module::Prepare()
virtual double	GetIntegralNumeric (int steps)
	Get the B1 integral of this pulse.
double	GetFlipAngle ()
	Get the flip angle of this pulse.
void	SetFlipAngle (double fa)
	Set the flip angle of this RF pulse.
int	GetChannel ()
	Get the CoilArray channel of this pulse.
void	SetChannel (int ch)
	Set the CoilArray channel of this RF pulse.
virtual double	GetMagnitude (double time)
	Returns the Magnitidue of this pulse at a given time.
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.
Protected Member Functions
virtual string	GetInfo ()
	Get informations on this Pulse.
Protected Attributes
double	m_flip_angle
	Flipangle of this pulse.
double	m_bw
	Bandwidth of this pulse.
int	m_channel
	Transmit channel of this pulse.
CoilArray *	m_coil_array
	Transmit array in simulation.
vector< double(*)(Module *, double)>	m_GetPhaseFunPtrs
	GetPhase functions, adding additional Transmit phase terms.

---

Detailed Description

Super class for all RF pulses.

Definition at line 35 of file RFPulse.h.

---

Member Function Documentation

double RFPulse::GetBandWidth

(

)

[inline]

Get the band width of this pulse.

Returns:

Band width.

Definition at line 119 of file RFPulse.h.

References m_bw.

int RFPulse::GetChannel

(

)

[inline]

Get the CoilArray channel of this pulse.

Returns:

Flip angle.

Definition at line 91 of file RFPulse.h.

References m_channel.

CoilArray* RFPulse::GetCoilArray

(

)

[inline]

Get the CoilArray for this RF pulse.

Parameters:

pCA

Pointer to the CoilArray

Definition at line 146 of file RFPulse.h.

References m_coil_array.

double RFPulse::GetFlipAngle

(

)

[inline]

Get the flip angle of this pulse.

Returns:

Flip angle.

Definition at line 77 of file RFPulse.h.

References m_flip_angle.

Referenced by HardRFPulse::GetMagnitude(), SincRFPulse::Prepare(), SechRFPulse::Prepare(), and GaussianRFPulse::Prepare().

Here is the caller graph for this function:

string RFPulse::GetInfo

(

)

[protected, virtual]

Get informations on this Pulse.

Returns:

Infos.

Reimplemented in AnalyticRFPulse, and SincRFPulse.

Definition at line 130 of file RFPulse.cpp.

References TxRxPhase::GetInitialPhase(), m_bw, m_channel, and m_flip_angle.

Here is the call graph for this function:

double RFPulse::GetIntegralNumeric

(

int

steps

)

[virtual]

Get the B1 integral of this pulse.

Parameters:

steps

The number of sampling points of the integral.

Returns:

Numeric integra.

Definition at line 117 of file RFPulse.cpp.

References Pulse::GetDuration(), and GetMagnitude().

Referenced by SincRFPulse::Prepare(), SechRFPulse::Prepare(), GaussianRFPulse::Prepare(), and AnalyticRFPulse::Prepare().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual double RFPulse::GetMagnitude

(

double

time

)

[inline, virtual]

Returns the Magnitidue of this pulse at a given time.

This method needs to be implemented by every derived RF pulse. It is called from RFpulse::GetValue

The Magnitude might also be real-valued, in which case the 180 degree phase jumps for negative values are set automatically.

Parameters:

time

Time-point at which the magnitude is requested.

Returns:

Magnitude.

Reimplemented in AnalyticRFPulse, ExternalRFPulse, GaussianRFPulse, HardRFPulse, SechRFPulse, and SincRFPulse.

Definition at line 112 of file RFPulse.h.

Referenced by GetIntegralNumeric(), and GetValue().

Here is the caller graph for this function:

void RFPulse::insertGetPhaseFunction

(

double(*)(Module *, double)

FGetPhase

)

Add another phase function for this RF pulse.

Derived RF pulses should call this function in prepare if they define an additional phase term through a static function, similar to TxRxPhase::GetInitialPhase and TxRxPhase::getLinearPhase

Parameters:

FGetPhase

Function pointer to the static member function defining the additional phase term.

Definition at line 65 of file RFPulse.cpp.

References m_GetPhaseFunPtrs.

Referenced by SechRFPulse::Prepare(), Prepare(), and ExternalRFPulse::Prepare().

Here is the caller graph for this function:

void RFPulse::SetChannel

(

int

ch

)

[inline]

Set the CoilArray channel of this RF pulse.

Parameters:

fa

Flip angle.

Definition at line 98 of file RFPulse.h.

References m_channel.

void RFPulse::SetCoilArray

(

CoilArray *

pCA

)

[inline]

Set the CoilArray for this RF pulse.

Parameters:

pCA

Pointer to the CoilArray

Definition at line 139 of file RFPulse.h.

References m_coil_array.

void RFPulse::SetFlipAngle

(

double

fa

)

[inline]

Set the flip angle of this RF pulse.

Parameters:

fa

Flip angle.

Definition at line 84 of file RFPulse.h.

References m_flip_angle.

---

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

• RFPulse.h
• RFPulse.cpp