API documentation
ConstantGradPulse Class Reference
Gradient with constant amplitude. More...
#include <ConstantGradPulse.h>
Inheritance diagram for ConstantGradPulse:
Collaboration diagram for ConstantGradPulse:
Public Member Functions | |
| ConstantGradPulse () | |
| Default constructor. | |
| ConstantGradPulse (const ConstantGradPulse &) | |
| Default copy constructor. | |
| ~ConstantGradPulse () | |
| Default destructor. | |
| ConstantGradPulse * | Clone () const |
| virtual bool | Prepare (PrepareMode mode) |
| virtual double | GetGradient (double const time) |
Protected Member Functions | |
| virtual string | GetInfo () |
| Get informations on this analytic gradient. | |
Protected Attributes | |
| double | m_amplitude |
Detailed Description
Gradient with constant amplitude.
Definition at line 32 of file ConstantGradPulse.h.
Member Function Documentation
| ConstantGradPulse* ConstantGradPulse::Clone | ( | ) | const [inline, virtual] |
See Module::clone
Implements Module.
Definition at line 55 of file ConstantGradPulse.h.
References ConstantGradPulse().
Here is the call graph for this function:
| double ConstantGradPulse::GetGradient | ( | double const | time | ) | [inline, virtual] |
Reimplemented from GradPulse.
Definition at line 57 of file ConstantGradPulse.cpp.
References m_amplitude.
| string ConstantGradPulse::GetInfo | ( | ) | [protected, virtual] |
Get informations on this analytic gradient.
- Returns:
- GradPulse::GetInfo plus info of the Shape
Reimplemented from GradPulse.
Definition at line 64 of file ConstantGradPulse.cpp.
References m_amplitude.
| bool ConstantGradPulse::Prepare | ( | PrepareMode | mode | ) | [virtual] |
See Module::Prepare
Reimplemented from GradPulse.
Definition at line 33 of file ConstantGradPulse.cpp.
References Pulse::GetDuration(), Prototype::GetName(), Prototype::HideAttribute(), m_amplitude, and GradPulse::SetArea().
Here is the call graph for this function:
Member Data Documentation
double ConstantGradPulse::m_amplitude [protected] |
My amplitude
Definition at line 76 of file ConstantGradPulse.h.
Referenced by ConstantGradPulse(), GetGradient(), GetInfo(), and Prepare().
The documentation for this class was generated from the following files:
