ODIN
Public Member Functions | List of all members
SeqSimAbstract Class Referenceabstract

#include <seqsim.h>

Inheritance diagram for SeqSimAbstract:
Inheritance graph
[legend]

Public Member Functions

virtual void prepare_simulation (const Sample &sample, CoilSensitivity *transmit_coil=0, CoilSensitivity *receive_coil=0, ProgressMeter *progmeter=0)=0
 
virtual cvector simulate (const SeqSimInterval &simvals, double gamma)=0
 
virtual void finalize_simulation ()=0
 
- Public Member Functions inherited from SeqClass
SeqClassset_temporary ()
 
- Public Member Functions inherited from Labeled
 Labeled (const STD_string &label="unnamed")
 
Labeledset_label (const STD_string &label)
 
const STD_string & get_label () const
 
Labeledoperator= (const Labeled &l)
 

Additional Inherited Members

- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual void clear_container ()
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Interface for Simulators

Definition at line 63 of file seqsim.h.

Member Function Documentation

◆ finalize_simulation()

virtual void SeqSimAbstract::finalize_simulation ( )
pure virtual

Call this function after a simulation (i.e. after successive calls to simulate() )

Implemented in SeqSimMagsi.

◆ prepare_simulation()

virtual void SeqSimAbstract::prepare_simulation ( const Sample sample,
CoilSensitivity transmit_coil = 0,
CoilSensitivity receive_coil = 0,
ProgressMeter progmeter = 0 
)
pure virtual

Prepare a simulation (i.e. before successive calls to simulate() ) with the parameters:

  • sample: The virtual sample
  • transmit_coil: Transmitter coil, 0 for none
  • receive_coil: Receiver coil, 0 for none
  • progmeter: Status indicator to trace progress, 0 for none

Implemented in SeqSimMagsi.

◆ simulate()

virtual cvector SeqSimAbstract::simulate ( const SeqSimInterval simvals,
double  gamma 
)
pure virtual

Simulation with

  • simvals: The magnetic fields during a time interval
  • gamma: Gyromagnetic ration of the nucleus observed Return value: Signal in each receiver channel

Implemented in SeqSimMagsi.


The documentation for this class was generated from the following file: