SeqPulsar Class Reference
[Classes for sequence design (odinseq library)]
Pulsar pulses, combines OdinPulse and SeqPulsNdim.
More...
#include <seqpulsar.h>
Public Member Functions | |
| SeqPulsar (const STD_string &object_label="unnamedSeqPulsar", bool rephased=false, bool interactive=true) | |
| SeqPulsar (const SeqPulsar &sp) | |
| ~SeqPulsar () | |
| SeqPulsar & | set_rephased (bool rephased, float strength=0.0) |
| fvector | get_reph_gradintegral () const |
| SeqPulsar & | operator= (const SeqPulsar &sp) |
| SeqPulsar & | refresh () |
| SeqPulsar & | set_interactive (bool flag) |
| float | get_strength () const |
| int | get_dims () const |
| SeqFreqChanInterface & | set_nucleus (const STD_string &nucleus) |
| float | get_flipangle () const |
| SeqPulsInterface & | set_flipangle (float flipangle) |
| SeqPulsInterface & | set_pulsduration (float pulsduration) |
| SeqPulsInterface & | set_power (float pulspower) |
| SeqPulsInterface & | set_pulse_type (pulseType type) |
| pulseType | get_pulse_type () const |
| STD_string | get_properties () const |
Friends | |
| class | SeqPulsarReph |
| class | SeqMethod |
| class | SeqMethodProxy |
Detailed Description
Pulsar pulses, combines OdinPulse and SeqPulsNdim.This class is an interface to the Pulsar program; It is possible to access most of the parameters of the underlying data structure 'OdinPulse' via get/set functions
Definition at line 41 of file seqpulsar.h.
Constructor & Destructor Documentation
| SeqPulsar::SeqPulsar | ( | const STD_string & | object_label = "unnamedSeqPulsar", |
|
| bool | rephased = false, |
|||
| bool | interactive = true | |||
| ) |
Constructs an empty Pulsar pulse with the given label. If 'rephased' is true, rephasing gradient lobes will be added to null the zero'th order gradient moment, i.e. the integral. If 'interactive' is true, the pulse will be updated each time a parameter was changed, otherwise update() has to be called manually.
| SeqPulsar::SeqPulsar | ( | const SeqPulsar & | sp | ) |
Constructs a Pulsar pulse which is a copy of 'sp'
| SeqPulsar::~SeqPulsar | ( | ) |
Destructor
Member Function Documentation
| SeqPulsar& SeqPulsar::set_rephased | ( | bool | rephased, | |
| float | strength = 0.0 | |||
| ) |
Specifies whether an additional gradient rephasing lobe will be added to rephase the magnetization in case of an excitation pulse. If strength is larger than zero, this maximum strength will be used for the rephaser gradient.
| fvector SeqPulsar::get_reph_gradintegral | ( | ) | const |
Returns the rephasers integral on all three channels
This assignment operator will make this object become an exact copy of 'sp'.
| SeqPulsar& SeqPulsar::refresh | ( | ) |
Recalculates the pulse manually, this is only required if the pulse is not interactive
| SeqPulsar& SeqPulsar::set_interactive | ( | bool | flag | ) |
If this flag is set to true, the pulse will be recalculated each time a parameter is changed, otherwise it must be done manually via the refresh() function
| float SeqPulsar::get_strength | ( | ) | const [inline, virtual] |
Returns the strength of the gradient object
Reimplemented from SeqParallel.
Definition at line 95 of file seqpulsar.h.
| int SeqPulsar::get_dims | ( | ) | const [virtual] |
Dimensionality of the pulse
Reimplemented from SeqPulsNdim.
| SeqFreqChanInterface& SeqPulsar::set_nucleus | ( | const STD_string & | nucleusname | ) |
Sets the nucleus for the pulse
Reimplemented from OdinPulse.
| float SeqPulsar::get_flipangle | ( | ) | const [inline] |
| SeqPulsInterface& SeqPulsar::set_flipangle | ( | float | flipangle | ) | [virtual] |
Sets the flip angle of the pulse
Reimplemented from SeqPulsInterface.
| SeqPulsInterface& SeqPulsar::set_pulsduration | ( | float | pulsduration | ) | [virtual] |
Sets the duration of the pulse. In case of a more complex pulse that needs some extra commands before and after the actual pulse will be played out, this function still sets the effective duration, i.e. when the RF-field is non-zero
Reimplemented from SeqPulsNdim.
| SeqPulsInterface& SeqPulsar::set_power | ( | float | pulspower | ) | [virtual] |
Sets the power deposition (or pulse attenuation on Bruker) of the pulse
Reimplemented from SeqPulsInterface.
| SeqPulsInterface& SeqPulsar::set_pulse_type | ( | pulseType | type | ) |
Sets the type of the pulse, this is necessary for calculating the pulse gain of adiabatic pulses and optimization of pulses.
Reimplemented from OdinPulse.
| pulseType SeqPulsar::get_pulse_type | ( | ) | const [inline] |
Returns the type of the pulse
Reimplemented from OdinPulse.
Definition at line 110 of file seqpulsar.h.
| STD_string SeqPulsar::get_properties | ( | ) | const [virtual] |
Returns a string describing the object
Reimplemented from SeqParallel.
The documentation for this class was generated from the following file:
