API documentation
SincRFPulse Class Reference
The prototype for Sinc RF Pulse. More...
#include <SincRFPulse.h>
Inheritance diagram for SincRFPulse:
Collaboration diagram for SincRFPulse:
Public Member Functions | |
| SincRFPulse () | |
| Default constructor. | |
| SincRFPulse (const SincRFPulse &) | |
| Copy constructor. | |
| ~SincRFPulse () | |
| Default destructor. | |
| SincRFPulse * | Clone () const |
| virtual bool | Prepare (PrepareMode mode) |
| Prepare the sinc RF pulse. | |
| virtual double | GetMagnitude (double time) |
| Returns the sinc shape of this SincRFpulse. | |
| virtual void | SetTPOIs () |
Protected Member Functions | |
| virtual string | GetInfo () |
Protected Attributes | |
| double | m_zeros |
| Half the number of zero crossings of the sinc. | |
| double | m_max_amplitude |
| Maximum amplitude of the sinc; derived from flipangle and duration in Prepare(). | |
| double | m_alpha |
| Apodization factor (default 0.5 = Hamming window). | |
Detailed Description
The prototype for Sinc RF Pulse.
Definition at line 31 of file SincRFPulse.h.
Member Function Documentation
| SincRFPulse* SincRFPulse::Clone | ( | ) | const [inline] |
See Module::clone
Definition at line 53 of file SincRFPulse.h.
References SincRFPulse().
Here is the call graph for this function:
| string SincRFPulse::GetInfo | ( | ) | [protected, virtual] |
| double SincRFPulse::GetMagnitude | ( | double | time | ) | [virtual] |
Returns the sinc shape of this SincRFpulse.
See also RFPulse::GetMagnitude
- Parameters:
-
time Time-point at which the magnitude is requested.
- Returns:
- Magntidue.
Reimplemented from RFPulse.
Definition at line 61 of file SincRFPulse.cpp.
References m_alpha, RFPulse::m_bw, m_max_amplitude, and m_zeros.
| bool SincRFPulse::Prepare | ( | PrepareMode | mode | ) | [virtual] |
Prepare the sinc RF pulse.
- Parameters:
-
mode Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.
- Returns:
- Success.
Reimplemented from RFPulse.
Definition at line 38 of file SincRFPulse.cpp.
References RFPulse::GetFlipAngle(), RFPulse::GetIntegralNumeric(), Prototype::HideAttribute(), m_alpha, RFPulse::m_bw, m_max_amplitude, m_zeros, and Pulse::SetDuration().
Here is the call graph for this function:
| void SincRFPulse::SetTPOIs | ( | ) | [inline, virtual] |
Definition at line 72 of file SincRFPulse.cpp.
References Pulse::GetDuration(), Module::m_tpoi, and m_zeros.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
