API documentation
SpiralGradPulse Class Reference
Prototype of a spiral gradient as described by Pauly et al. More...
#include <SpiralGradPulse.h>
Inheritance diagram for SpiralGradPulse:
Collaboration diagram for SpiralGradPulse:Public Member Functions | |
| SpiralGradPulse () | |
| SpiralGradPulse (const SpiralGradPulse &) | |
| ~SpiralGradPulse () | |
| SpiralGradPulse * | Clone () const |
| virtual bool | Prepare (PrepareMode mode) |
| virtual double | GetGradient (double const time) |
Protected Member Functions | |
| virtual string | GetInfo () |
Protected Attributes | |
| double | m_arms |
| double | m_slewrate |
| double | m_max_grad |
| double | m_grad_samp_int |
| double | m_fov |
| double | m_bw |
| double | m_pitch |
| double | m_beta |
| int | m_inward |
| long | m_samples |
| double * | m_amps |
Detailed Description
Prototype of a spiral gradient as described by Pauly et al.
Definition at line 33 of file SpiralGradPulse.h.
Constructor & Destructor Documentation
| SpiralGradPulse::SpiralGradPulse | ( | ) | [inline] |
Constructor
Definition at line 40 of file SpiralGradPulse.h.
Referenced by Clone().
Here is the caller graph for this function:| SpiralGradPulse::SpiralGradPulse | ( | const SpiralGradPulse & | ) | [inline] |
Copy constructor.
Definition at line 45 of file SpiralGradPulse.h.
| SpiralGradPulse::~SpiralGradPulse | ( | ) |
Destructor.
Definition at line 198 of file SpiralGradPulse.cpp.
Member Function Documentation
| SpiralGradPulse* SpiralGradPulse::Clone | ( | ) | const [inline, virtual] |
See Module::clone
Implements Module.
Definition at line 55 of file SpiralGradPulse.h.
References SpiralGradPulse().
Here is the call graph for this function:| double SpiralGradPulse::GetGradient | ( | double const | time | ) | [virtual] |
See Module::GetValue
Reimplemented from GradPulse.
Definition at line 28 of file SpiralGradPulse.cpp.
References m_amps, m_grad_samp_int, and m_inward.
| string SpiralGradPulse::GetInfo | ( | ) | [protected, virtual] |
Get informations on this trapezoidal gradient
- Returns:
- GradPulse::GetInfo plus m_pitch and m_alpha
Reimplemented from GradPulse.
Definition at line 187 of file SpiralGradPulse.cpp.
| bool SpiralGradPulse::Prepare | ( | PrepareMode | mode | ) | [virtual] |
Prepare the spiral gradient pulse.
- Parameters:
-
mode Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.
Reimplemented from GradPulse.
Definition at line 37 of file SpiralGradPulse.cpp.
References Pulse::GetDuration(), Prototype::GetName(), Prototype::HasDOMattribute(), m_amps, m_arms, Pulse::m_axis, m_beta, m_bw, m_fov, m_grad_samp_int, m_inward, m_max_grad, m_pitch, m_samples, m_slewrate, XC, YC, and ZC.
Here is the call graph for this function:Member Data Documentation
double* SpiralGradPulse::m_amps [protected] |
Gradient amplitudes
Definition at line 87 of file SpiralGradPulse.h.
Referenced by GetGradient(), and Prepare().
double SpiralGradPulse::m_arms [protected] |
double SpiralGradPulse::m_beta [protected] |
double SpiralGradPulse::m_bw [protected] |
double SpiralGradPulse::m_fov [protected] |
double SpiralGradPulse::m_grad_samp_int [protected] |
Gradient samping interval
Definition at line 80 of file SpiralGradPulse.h.
Referenced by GetGradient(), and Prepare().
int SpiralGradPulse::m_inward [protected] |
Spiral in?
Definition at line 85 of file SpiralGradPulse.h.
Referenced by GetGradient(), and Prepare().
double SpiralGradPulse::m_max_grad [protected] |
Maximum gradient amplitude override
Definition at line 79 of file SpiralGradPulse.h.
Referenced by Prepare().
double SpiralGradPulse::m_pitch [protected] |
Spiral pitch
Definition at line 83 of file SpiralGradPulse.h.
long SpiralGradPulse::m_samples [protected] |
double SpiralGradPulse::m_slewrate [protected] |
Maximum slew rate override
Definition at line 78 of file SpiralGradPulse.h.
Referenced by Prepare().
The documentation for this class was generated from the following files:





