API documentation
SechRFPulse Class Reference
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 () |
Protected Attributes | |
| double | m_max_amplitude |
| Maximum amplitude. | |
Detailed Description
Sech shaped radio frequency pulses.
Definition at line 33 of file SechRFPulse.h.
Member Function Documentation
| SechRFPulse* SechRFPulse::Clone | ( | ) | const [inline] |
- See also:
- Prototype::Clone()
Definition at line 55 of file SechRFPulse.h.
References SechRFPulse().
Here is the call graph for this function:
| 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.
Definition at line 51 of file SechRFPulse.cpp.
References Pulse::GetDuration(), and m_max_amplitude.
Here is the call graph for this function:
| 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.
Definition at line 32 of file SechRFPulse.cpp.
References RFPulse::GetFlipAngle(), RFPulse::GetIntegralNumeric(), Prototype::HideAttribute(), RFPulse::insertGetPhaseFunction(), and m_max_amplitude.
Here is the call graph for this function:
| void SechRFPulse::SetTPOIs | ( | ) | [inline, virtual] |
- See also:
- Pulse::SetTPOIs()
Definition at line 62 of file SechRFPulse.cpp.
References Pulse::GetDuration(), and Module::m_tpoi.
Here is the call graph for this function:
The documentation for this class was generated from the following files:
