TrapGradPulse Class Reference

Prototype of a trapezoidal gradient pulse (e.g. for cartesian k-space imaging). More...

#include <TrapGradPulse.h>

Inheritance diagram for TrapGradPulse:

Collaboration diagram for TrapGradPulse:

List of all members.

Public Member Functions
	TrapGradPulse ()
	TrapGradPulse (const TrapGradPulse &)
	~TrapGradPulse ()
TrapGradPulse *	Clone () const
virtual bool	Prepare (PrepareMode mode)
virtual double	GetGradient (double const time)
bool	SetShape (bool verbose=false)
	Set the shape of the trapezoidal gradient.
void	SetTrapezoid ()
	Set the shape of the trapezoid in minimal possible time.
virtual void	SetTPOIs ()
Protected Member Functions
virtual string	GetInfo ()
Protected Attributes
double	m_flat_top_area
double	m_flat_top_time
double	m_asym_sr
bool	m_has_flat_top_time
bool	m_has_flat_top_area
bool	m_has_duration
double	m_amplitude
double	m_ramp_up_time
double	m_ramp_dn_time
double	m_slope_up
double	m_slope_dn
double	m_time_to_ramp_dn

---

Detailed Description

Prototype of a trapezoidal gradient pulse (e.g. for cartesian k-space imaging).

Definition at line 33 of file TrapGradPulse.h.

---

Constructor & Destructor Documentation

TrapGradPulse::TrapGradPulse

(

)

Constructor

Definition at line 42 of file TrapGradPulse.cpp.

Referenced by Clone().

Here is the caller graph for this function:

TrapGradPulse::TrapGradPulse

(

const TrapGradPulse &

hrfp

)

Copy constructor.

Definition at line 27 of file TrapGradPulse.cpp.

References m_amplitude, m_asym_sr, m_flat_top_area, m_flat_top_time, m_has_duration, m_has_flat_top_area, m_has_flat_top_time, m_ramp_dn_time, m_ramp_up_time, m_slope_dn, m_slope_up, and m_time_to_ramp_dn.

TrapGradPulse::~TrapGradPulse

(

)

Destructor.

Definition at line 44 of file TrapGradPulse.cpp.

---

Member Function Documentation

TrapGradPulse * TrapGradPulse::Clone

(

)

const [virtual]

See Module::clone

Implements Module.

Definition at line 46 of file TrapGradPulse.cpp.

References TrapGradPulse().

Here is the call graph for this function:

double TrapGradPulse::GetGradient

(

double const

time

)

[inline, virtual]

See GradPulse::GetGradient

Reimplemented from GradPulse.

Definition at line 190 of file TrapGradPulse.cpp.

References m_amplitude, m_flat_top_time, m_ramp_up_time, m_slope_dn, and m_slope_up.

string TrapGradPulse::GetInfo

(

)

[protected, virtual]

Get informations on this trapezoidal gradient

Returns:

GradPulse::GetInfo plus info on the flat top (if set)

Reimplemented from GradPulse.

Definition at line 236 of file TrapGradPulse.cpp.

References m_flat_top_area, m_flat_top_time, and m_has_flat_top_time.

bool TrapGradPulse::Prepare

(

PrepareMode

mode

)

[virtual]

Prepare the trapezoidal gradient pulse.

See Module::Prepare

Reimplemented from GradPulse.

Definition at line 50 of file TrapGradPulse.cpp.

References Prototype::GetName(), Prototype::HasDOMattribute(), m_amplitude, m_asym_sr, m_flat_top_area, m_flat_top_time, m_has_duration, m_has_flat_top_area, m_has_flat_top_time, m_ramp_dn_time, m_ramp_up_time, m_time_to_ramp_dn, and SetShape().

Here is the call graph for this function:

bool TrapGradPulse::SetShape

(

bool

verbose = false

)

[inline]

Set the shape of the trapezoidal gradient.

The method checks for various inputs from XML and prepares the trapezoidal shape arcodingly by calling TrapGradPulse::SetTrapezoid

Parameters:

verbose

Shout error in preparation, if true.

Definition at line 100 of file TrapGradPulse.cpp.

References Prototype::GetName(), GradPulse::m_area, Module::m_duration, m_flat_top_area, m_flat_top_time, m_has_duration, m_has_flat_top_area, m_has_flat_top_time, GradPulse::m_max_ampl, GradPulse::m_slew_rate, m_slope_dn, m_slope_up, GradPulse::SetArea(), and SetTrapezoid().

Referenced by Prepare().

Here is the call graph for this function:

Here is the caller graph for this function:

void TrapGradPulse::SetTPOIs

(

)

[inline, virtual]

See Pulse::SetTPOIs

Reimplemented from Pulse.

Definition at line 214 of file TrapGradPulse.cpp.

References Pulse::GetDuration(), Pulse::GetNADC(), World::instance(), m_flat_top_time, m_has_flat_top_time, Pulse::m_phase_lock, m_ramp_up_time, Module::m_tpoi, World::PhaseLock, and TPOI::Reset().

Here is the call graph for this function:

---

Member Data Documentation

double TrapGradPulse::m_amplitude [protected]

My amplitude

Definition at line 107 of file TrapGradPulse.h.

Referenced by GetGradient(), Prepare(), SetTrapezoid(), and TrapGradPulse().

double TrapGradPulse::m_asym_sr [protected]

Factor for asymetric slew rate set from XML. Should be in [-1,1]

Definition at line 101 of file TrapGradPulse.h.

Referenced by Prepare(), SetTrapezoid(), and TrapGradPulse().

double TrapGradPulse::m_flat_top_area [protected]

Area beyond the Flat Top set from XML

Definition at line 99 of file TrapGradPulse.h.

Referenced by GetInfo(), Prepare(), SetShape(), and TrapGradPulse().

double TrapGradPulse::m_flat_top_time [protected]

Duration of the Flat Top set from XML

Definition at line 100 of file TrapGradPulse.h.

Referenced by GetGradient(), GetInfo(), Prepare(), SetShape(), SetTPOIs(), SetTrapezoid(), and TrapGradPulse().

bool TrapGradPulse::m_has_duration [protected]

true, if corresponding doulbe attribute was set in XML

Definition at line 105 of file TrapGradPulse.h.

Referenced by Prepare(), SetShape(), and TrapGradPulse().

bool TrapGradPulse::m_has_flat_top_area [protected]

true, if corresponding doulbe attribute was set in XML

Definition at line 104 of file TrapGradPulse.h.

Referenced by Prepare(), SetShape(), and TrapGradPulse().

bool TrapGradPulse::m_has_flat_top_time [protected]

true, if corresponding doulbe attribute was set in XML

Definition at line 103 of file TrapGradPulse.h.

Referenced by GetInfo(), Prepare(), SetShape(), SetTPOIs(), and TrapGradPulse().

double TrapGradPulse::m_ramp_dn_time [protected]

My ramp down time

Definition at line 109 of file TrapGradPulse.h.

Referenced by Prepare(), SetTrapezoid(), and TrapGradPulse().

double TrapGradPulse::m_ramp_up_time [protected]

My ramp up time

Definition at line 108 of file TrapGradPulse.h.

Referenced by GetGradient(), Prepare(), SetTPOIs(), SetTrapezoid(), and TrapGradPulse().

double TrapGradPulse::m_slope_dn [protected]

My slope down

Definition at line 111 of file TrapGradPulse.h.

Referenced by GetGradient(), SetShape(), SetTrapezoid(), and TrapGradPulse().

double TrapGradPulse::m_slope_up [protected]

My slope up

Definition at line 110 of file TrapGradPulse.h.

Referenced by GetGradient(), SetShape(), SetTrapezoid(), and TrapGradPulse().

double TrapGradPulse::m_time_to_ramp_dn [protected]

My time to the end of the flat top

Definition at line 112 of file TrapGradPulse.h.

Referenced by Prepare(), SetTrapezoid(), and TrapGradPulse().

---

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

• TrapGradPulse.h
• TrapGradPulse.cpp