Public Member Functions

SeqDecoupling Class Reference
[Classes for sequence design (odinseq library)]

Decoupling period. More...

#include <seqdec.h>

Inheritance diagram for SeqDecoupling:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 SeqDecoupling (const STD_string &object_label, const STD_string &nucleus, float decpower, const dvector &freqlist=0, const STD_string decprog="", float decpulsduration=0.0)
 SeqDecoupling (const SeqDecoupling &sd)
 SeqDecoupling (const STD_string &object_label="unnamedSeqDecoupling")
SeqDecouplingoperator() (const SeqObjBase &so)
float get_decpower () const
void set_decpower (float p)
STD_string get_program () const
void set_program (const STD_string &p)
double get_pulsduration () const
void set_pulsduration (float d)
SeqDecouplingoperator= (const SeqDecoupling &sd)
double get_freqchan_duration () const
unsigned int get_freqlistindex () const
const SeqVectorget_freqlist_vector () const
void clear_container ()

Detailed Description

Decoupling period.

This class represents a decoupling container which can hold a part of the sequence where decoupling is switched on.

Definition at line 70 of file seqdec.h.


Constructor & Destructor Documentation

SeqDecoupling::SeqDecoupling ( const STD_string &  object_label,
const STD_string &  nucleus,
float  decpower,
const dvector freqlist = 0,
const STD_string  decprog = "",
float  decpulsduration = 0.0 
)

Constructs a container for a sequence part at which decoupling will be switched on with the following properties:

  • nucleus: The nucleus for which the decoupling should be performed.
  • decpower: The maximum power for the decoupling program.
  • freqlist: Frequency list for the decoupler.
  • decprog: The file name of the decoupling program which will be used. If none is specified, continuous wave decouling will be used.
  • decpulsduration: If a decoupling program is given, this parameter determines the pulse duration of each single pulse in a composite pulse decoupling scheme.
SeqDecoupling::SeqDecoupling ( const SeqDecoupling sd  ) 

Constructs a decoupling container which is a copy of 'sd'

SeqDecoupling::SeqDecoupling ( const STD_string &  object_label = "unnamedSeqDecoupling"  ) 

Constructs an empty decoupling container with the given label.


Member Function Documentation

void SeqDecoupling::clear_container (  )  [virtual]

Overload this function in case the class is a container object, i.e. it contains other sequence objects. The function should clear all references to other sequence objects, i.e. to thos it contains.

Reimplemented from SeqClass.

float SeqDecoupling::get_decpower (  )  const [inline]

Returns the decoupling power

Definition at line 112 of file seqdec.h.

double SeqDecoupling::get_freqchan_duration (  )  const [inline, virtual]

Overload this function to return the duration of the object while it effectively occupies the RF channel

Reimplemented from SeqFreqChan.

Definition at line 153 of file seqdec.h.

const SeqVector& SeqDecoupling::get_freqlist_vector (  )  const [virtual]

Returns the frequency list vector (for loop insertion)

Reimplemented from SeqFreqChan.

unsigned int SeqDecoupling::get_freqlistindex (  )  const [inline, virtual]

Return the index for the frequency list

Reimplemented from SeqFreqChan.

Definition at line 154 of file seqdec.h.

STD_string SeqDecoupling::get_program (  )  const

Returns the decoupling program

double SeqDecoupling::get_pulsduration (  )  const

Returns the decoupling pulse duration for Composite Pulse Decoupling

SeqDecoupling& SeqDecoupling::operator() ( const SeqObjBase so  ) 

This function specifies that during the sequence part 'so' decoupling will be switched on.

SeqDecoupling& SeqDecoupling::operator= ( const SeqDecoupling sd  ) 

This assignment operator will make this object become an exact copy of 'sd'.

void SeqDecoupling::set_decpower ( float  p  )  [inline]

Sets the decoupling power

Definition at line 117 of file seqdec.h.

void SeqDecoupling::set_program ( const STD_string &  p  ) 

Sets the decoupling program

void SeqDecoupling::set_pulsduration ( float  d  ) 

Sets the decoupling pulse duration for Composite Pulse Decoupling


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