API documentation
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
| AnalyticCoil | Prototype of a Biot-Savart loop |
| AnalyticGradPulse | Gradient with analytic shape |
| AnalyticPulseShape | Prepare and GiNaC evaluation of analytic pulse shapes |
| AnalyticRFPulse | Analytic RF pulse |
| AtomicSequence | Atomic sequence prototype |
| Attribute | Attribute class. Attributes are private member variables of a Prototype which are accessible through XML and, thus, they are subject to observation mechanism |
| BiotSavartLoop | Prototype of a Biot-Savart loop |
| Bloch_CV_Model | Numerical solving of Bloch equations As an application of the CVODE solver by Lawrence Livermore National Laboratory - Livermore, CA http://www.llnl.gov/CASC/sundials |
| Coil | Base class of coil objects |
| CoilArray | Coil configuration and sensitivities |
| CoilPrototypeFactory | This interface knows about coil prototypes |
| ConcatSequence | Concat sequence prototype |
| ConstantGradPulse | Gradient with constant amplitude |
| DelayAtomicSequence | Prototype of a delay |
| DOMTreeErrorReporter | XML exception handling |
| DynamicVariables | Instance class holding dynamic sample properties |
| EmptyPulse | Prototype of an empty pulse |
| excompiler | |
| ExternalCoil | Prototype of an ideal coil |
| ExternalGradPulse | External gradient prototype |
| ExternalPulseData | Read and retrieve data of external pulse shapes |
| ExternalRFPulse | RF pulse with external pulse shape |
| GaussianRFPulse | Gaussian shaped radio frequency pulses |
| GradPulse | Base class and prototype for all gradient pulses |
| HardRFPulse | Prototype for hard radio frequency pulses |
| IdealCoil | Prototype of an ideal coil |
| Model | Base class for MR model solver |
| Module | Module super class! ABC for all Objects in the sequence framework |
| ModulePrototypeFactory | Module factory |
| Mpi2Evolution | Pure virtual class; provides methods to write evolution file using parallel I/O |
| nvec | Structure keeping the vectors for cvode |
| Parameters | World parameters provide the parametric data of the sequence |
| Prototype | Prototype super class |
| PrototypeFactory | Base class for prototype factories |
| Pulse | Pulse Super Class. ABC for all RF and gradient pulses |
| RepIter | A super-simple iterator for counting the repetitions of a concat sequence |
| Repository | Signal repository structure |
| RFPulse | Super class for all RF pulses |
| Sample | The Sample is the object to simulate. It contains the spins |
| SampleReorderShuffle | Shuffles the order in which spins are simulated |
| SampleReorderStrategyInterface | Base class for different sample reorder strategies |
| SechRFPulse | Sech shaped radio frequency pulses |
| Sequence | Super class for all sequence (non-pulse) modules |
| SequenceTree | Singelton implementation of the lfo-tree representation of the whole sequence |
| TPOI::set | The set of data of each time point of interest |
| Signal | The signal store and IO |
| Simulator | The simulator |
| SincRFPulse | The prototype for Sinc RF Pulse |
| Spin_data | Brief Spin structure |
| SpiralGradPulse | Prototype of a spiral gradient as described by Pauly et al |
| StrX | Simple class for transcoding sax errors to the machines locale |
| TPOI | Time points of interest of all modules |
| Trajectory | Context class for trajectories (design pattern: Strategy) |
| Trajectory1D | One-dimensional Trajectory |
| TrajectoryEmpty | The "do nothing"-strategy |
| TrajectoryInterface | Pure virtual base class for all Trajectories |
| TrajectoryMotion | Motion Trajectory |
| TrajectoryT2s | Strategy for T2s; needs some extra handling for GetValueDerived |
| TrapGradPulse | Prototype of a trapezoidal gradient pulse (e.g. for cartesian k-space imaging) |
| TriangleGradPulse | Gradient with constant amplitude |
| TxRxPhase | Phase physics super class |
| World | The simulated reality |
| XMLIO | XML file-IO class |
