API documentation
AnalyticCoil Class Reference
Prototype of a Biot-Savart loop. More...
#include <AnalyticCoil.h>
Inheritance diagram for AnalyticCoil:
Collaboration diagram for AnalyticCoil:Public Member Functions | |
| AnalyticCoil () | |
| constructor | |
| ~AnalyticCoil () | |
| Default destructor. | |
| virtual double | GetSensitivity (double *position) |
| Request sensitivity at given position. | |
| virtual double | GetPhase (double *position) |
| Get the B1+ phase at point (x,y,z). | |
| virtual AnalyticCoil * | Clone () const |
| Clone. | |
| virtual bool | Prepare (PrepareMode mode) |
| Prepare. | |
Detailed Description
Prototype of a Biot-Savart loop.
Definition at line 37 of file AnalyticCoil.h.
Member Function Documentation
| virtual AnalyticCoil* AnalyticCoil::Clone | ( | ) | const [inline, virtual] |
Clone.
- Returns:
- A clone.
Implements Coil.
Definition at line 75 of file AnalyticCoil.h.
References AnalyticCoil().
Here is the call graph for this function:| virtual double AnalyticCoil::GetPhase | ( | double * | position | ) | [inline, virtual] |
Get the B1+ phase at point (x,y,z).
This method may be implemented by every derived coil. Otherwise phase is zero.
Important: the phase of Coils needs to be implemented with unit radians! (In contrast to the phase of RF pulses which has units degrees.)
- Parameters:
-
position At position.
- Returns:
- B1+ phase with respect to spin in World.
Reimplemented from Coil.
Definition at line 68 of file AnalyticCoil.h.
| double AnalyticCoil::GetSensitivity | ( | double * | position | ) | [virtual] |
Request sensitivity at given position.
- Parameters:
-
position Position.
- Returns:
- Sensitivity at requested position.
Implements Coil.
Definition at line 85 of file AnalyticCoil.cpp.
References Attribute::EvalExpression(), Prototype::GetAttribute(), Attribute::GetImaginary(), Coil::m_azimuth, Coil::m_polar, and Coil::m_position.
Here is the call graph for this function:| bool AnalyticCoil::Prepare | ( | PrepareMode | mode | ) | [virtual] |
Prepare.
- Parameters:
-
mode Sets the preparation mode, one of enum PrepareMode {PREP_INIT,PREP_VERBOSE,PREP_UPDATE}.
- Returns:
- Success
Reimplemented from Coil.
Definition at line 34 of file AnalyticCoil.cpp.
References Coil::DumpSensMap(), Prototype::GetAttribute(), Prototype::GetDOMattribute(), Prototype::GetName(), Prototype::m_obs_attribs, Prototype::Observe(), Prototype::ReplaceString(), Attribute::SetMember(), and Attribute::SetObservable().
Here is the call graph for this function:The documentation for this class was generated from the following files:





