ODIN
Public Member Functions | List of all members

Saturation pulse + spoilers. More...

#include <seqsat.h>

Inheritance diagram for SeqSat:
Inheritance graph
[legend]

Public Member Functions

 SeqSat (const STD_string &object_label="unnamedSeqSat", satNucleus nuc=fat, float bandwidth=0.3, unsigned int npulses=1)
 
 SeqSat (const SeqSat &spg)
 
SeqSatoperator= (const SeqSat &spg)
 
SeqGradInterfaceset_strength (float gradstrength)
 
SeqGradInterfaceinvert_strength ()
 
float get_strength () const
 
fvector get_gradintegral () const
 
double get_gradduration () const
 
SeqGradInterfaceset_gradrotmatrix (const RotMatrix &matrix)
 
- Public Member Functions inherited from SeqObjList
 SeqObjList (const STD_string &object_label="unnamedSeqObjList")
 
 SeqObjList (const SeqObjList &so)
 
SeqObjListoperator= (const SeqObjList &so)
 
SeqObjListoperator= (const SeqObjLoop &sl)
 
SeqObjListoperator= (const SeqDecoupling &sd)
 
SeqObjListoperator= (const SeqObjBase &soa)
 
SeqObjListoperator= (SeqGradObjInterface &sgoa)
 
SeqObjListoperator= (SeqGradChan &sgc)
 
SeqObjListoperator= (SeqGradChanList &sgcl)
 
SeqObjListoperator+= (const SeqObjBase &soa)
 
SeqObjListoperator+= (SeqGradObjInterface &sgoa)
 
SeqObjListoperator+= (SeqGradChan &sgc)
 
SeqObjListoperator+= (SeqGradChanList &sgcl)
 
SeqObjListset_gradrotmatrixvector (const SeqRotMatrixVector &matrixVec)
 
STD_string get_program (programContext &context) const
 
unsigned int event (eventContext &context) const
 
double get_duration () const
 
STD_string get_properties () const
 
void query (queryContext &context) const
 
RecoValList get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const
 
SeqValList get_freqvallist (freqlistAction action) const
 
SeqValList get_delayvallist () const
 
double get_rf_energy () const
 
- Public Member Functions inherited from SeqTreeObj
bool contains (const SeqTreeObj *sto) const
 
void tree (SeqTreeCallbackAbstract *display) const
 
- 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)
 
- Public Member Functions inherited from List< SeqObjBase, const SeqObjBase *, const SeqObjBase & >
 List ()
 
 ~List ()
 
Listoperator= (const List &l)
 
Listclear ()
 
Listappend (const SeqObjBase & item)
 
Listremove (const SeqObjBase & item)
 
unsigned int size () const
 
iter get_begin ()
 
iter get_end ()
 
constiter get_const_begin () const
 
constiter get_const_end () const
 
- Public Member Functions inherited from SeqPulsInterface
virtual SeqPulsInterfaceset_pulsduration (float pulsduration)
 
virtual double get_pulsduration () const
 
virtual float get_flipangle () const
 
virtual SeqPulsInterfaceset_flipangle (float flipangle)
 
SeqPulsInterfaceset_flipangles (const fvector &flipangles)
 
fvector get_flipangles () const
 
virtual SeqPulsInterfaceset_power (float pulspower)
 
virtual float get_power () const
 
virtual SeqPulsInterfaceset_rel_magnetic_center (float center)
 
virtual float get_rel_magnetic_center () const
 
virtual float get_magnetic_center () const
 
virtual SeqPulsInterfaceset_pulse_type (pulseType type)
 
virtual pulseType get_pulse_type () const
 
virtual SeqPulsInterfaceset_flipangle_reorder_scheme (reorderScheme scheme, unsigned int nsegments)
 
virtual const SeqVectorget_flipangle_vector () const
 
virtual const SeqVectorget_flipangle_reorder_vector () const
 
- Public Member Functions inherited from SeqFreqChanInterface
virtual SeqFreqChanInterfaceset_nucleus (const STD_string &nucleus)
 
virtual SeqFreqChanInterfaceset_freqlist (const dvector &freqlist)
 
virtual SeqFreqChanInterfaceset_phaselist (const dvector &phaselist)
 
virtual const SeqVectorget_freqlist_vector () const
 
virtual const SeqVectorget_phaselist_vector () const
 
 operator const SeqVector & () const
 
virtual SeqFreqChanInterfaceset_encoding_scheme (encodingScheme scheme)
 
virtual SeqFreqChanInterfaceset_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)
 
virtual const SeqVectorget_reorder_vector () const
 
virtual SeqFreqChanInterfaceset_phaselist_encoding_scheme (encodingScheme scheme)
 
virtual SeqFreqChanInterfaceset_phaselist_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)
 
virtual const SeqVectorget_phaselist_reorder_vector () const
 
SeqFreqChanInterfaceset_freqoffset (double freqoffset)
 
SeqFreqChanInterfaceset_phase (double phaseval)
 
SeqFreqChanInterfaceset_phasespoiling (unsigned int size=80, double incr=117.0, double offset=0.0)
 
- Public Member Functions inherited from SeqGradInterface
float get_gradintegral_norm () const
 

Additional Inherited Members

- Public Types inherited from List< SeqObjBase, const SeqObjBase *, const SeqObjBase & >
typedef STD_list< const SeqObjBase * >::iterator iter
 
typedef STD_list< const SeqObjBase * >::const_iterator constiter
 
- Protected Member Functions inherited from SeqObjList
void clear_container ()
 
bool prep ()
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Saturation pulse + spoilers.

A saturation pulse + spoiler gradient pulse

Definition at line 95 of file seqsat.h.

Constructor & Destructor Documentation

◆ SeqSat() [1/2]

SeqSat::SeqSat ( const STD_string &  object_label = "unnamedSeqSat",
satNucleus  nuc = fat,
float  bandwidth = 0.3,
unsigned int  npulses = 1 
)

Constructs saturation pulse labeled 'object_label' with the following properties:

  • nuc: the nucleus to saturate
  • bandwidth: The bandwidth in kHz
  • npulses: The number of consecutive pulses

◆ SeqSat() [2/2]

SeqSat::SeqSat ( const SeqSat spg)

Constructs a copy of 'spg'

Member Function Documentation

◆ get_gradduration()

double SeqSat::get_gradduration ( ) const
virtual

Returns the duration of the gradient object. This function returns only the effective duration during whichthe gradient is active, any delays before and after the gradient are omitted.

Implements SeqGradInterface.

◆ get_gradintegral()

fvector SeqSat::get_gradintegral ( ) const
virtual

Returns the integral vector of the gradient course

Implements SeqGradInterface.

◆ get_strength()

float SeqSat::get_strength ( ) const
virtual

Returns the strength of the gradient object

Implements SeqGradInterface.

◆ invert_strength()

SeqGradInterface& SeqSat::invert_strength ( )
virtual

Changes the polarity of the gradient, i.e. inverts the sign of the gradient strength

Implements SeqGradInterface.

◆ operator=()

SeqSat& SeqSat::operator= ( const SeqSat spg)

Assignment operator that makes this object become a copy of 'spg'

◆ set_gradrotmatrix()

SeqGradInterface& SeqSat::set_gradrotmatrix ( const RotMatrix matrix)
virtual

This function can be used to specify a rotation of the gradient object in the spatial domain, the rotation will be applied to this object only rather than to the whole sequence.

Implements SeqGradInterface.

◆ set_strength()

SeqGradInterface& SeqSat::set_strength ( float  gradstrength)
virtual

Changes the strength of the gradient object

Implements SeqGradInterface.


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