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

#include <seqfreq.h>

Inheritance diagram for SeqFreqChan:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 SeqFreqChan (const STD_string &object_label="unnamedSeqFreqChan")
 SeqFreqChan (const STD_string &object_label, const STD_string &nucleus, const dvector &freqlist=0, const dvector &phaselist=0)
 SeqFreqChan (const SeqFreqChan &sfc)
virtual ~SeqFreqChan ()
SeqFreqChanoperator= (const SeqFreqChan &sfc)
int get_channel () const
dvector get_freqlist () const
double get_phase () const
virtual double get_frequency () const
unsigned int get_phaselistindex () const
virtual unsigned int get_freqlistindex () const
STD_string get_iteratorcommand (objCategory cat) const
SeqFreqChanInterfaceset_nucleus (const STD_string &nucleus)
SeqFreqChanInterfaceset_freqlist (const dvector &freqlist)
SeqFreqChanInterfaceset_phaselist (const dvector &phaselist)
const SeqVectorget_freqlist_vector () const
const SeqVectorget_phaselist_vector () const
SeqFreqChanInterfaceset_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)
SeqFreqChanInterfaceset_encoding_scheme (encodingScheme scheme)
const SeqVectorget_reorder_vector () const
unsigned int get_vectorsize () const
bool prep_iteration () const
bool is_qualvector () const
svector get_vector_commands (const STD_string &iterator) const

Protected Member Functions

virtual double get_freqchan_duration () const
bool prep ()

Friends

class SeqPhaseListVector


Detailed Description

This is the base class for all sequence objects that occupy a transmitter/receiver channel

Definition at line 149 of file seqfreq.h.


Constructor & Destructor Documentation

SeqFreqChan::SeqFreqChan ( const STD_string &  object_label = "unnamedSeqFreqChan"  ) 

Constructs an empty frequency channel labeled 'object_label'

SeqFreqChan::SeqFreqChan ( const STD_string &  object_label,
const STD_string &  nucleus,
const dvector freqlist = 0,
const dvector phaselist = 0 
)

Constructs a frequency channel labeled 'object_label' with the following properties:

  • nucleus: The nucleus for which the frequency channel should be reserved. The default is the protons resonance frequency.
  • freqlist: This is an array of frequencies at which the transmit/receive signal will be modulated/demodulated.
  • phaselist: This is an array of phases at which the transmit/receive signal will be modulated/demodulated.

SeqFreqChan::SeqFreqChan ( const SeqFreqChan sfc  ) 

Constructs a copy of 'sfc'

virtual SeqFreqChan::~SeqFreqChan (  )  [inline, virtual]

Destructor

Definition at line 180 of file seqfreq.h.


Member Function Documentation

SeqFreqChan& SeqFreqChan::operator= ( const SeqFreqChan sfc  ) 

Assignment operator that makes this frequency channel become a copy of 'sfc'

int SeqFreqChan::get_channel (  )  const [inline]

Return the assigned number of this frequency channel

Definition at line 192 of file seqfreq.h.

dvector SeqFreqChan::get_freqlist (  )  const [inline]

Returns the freqlist of the object

Definition at line 198 of file seqfreq.h.

double SeqFreqChan::get_phase (  )  const [inline]

Returns the current phase (in rad !)

Definition at line 204 of file seqfreq.h.

virtual double SeqFreqChan::get_frequency (  )  const [virtual]

Returns the current frequency

unsigned int SeqFreqChan::get_phaselistindex (  )  const [inline]

Return the index for the phase list

Definition at line 216 of file seqfreq.h.

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

Return the index for the frequency list

Reimplemented in SeqDecoupling.

Definition at line 222 of file seqfreq.h.

STD_string SeqFreqChan::get_iteratorcommand ( objCategory  cat  )  const

Returns the command to iterate through the frequency list

SeqFreqChanInterface& SeqFreqChan::set_nucleus ( const STD_string &  nucleus  )  [virtual]

Specify the nucleus for this frequency channel

Reimplemented from SeqFreqChanInterface.

SeqFreqChanInterface& SeqFreqChan::set_freqlist ( const dvector freqlist  )  [inline, virtual]

Sets the freqlist for the object

Reimplemented from SeqFreqChanInterface.

Definition at line 234 of file seqfreq.h.

SeqFreqChanInterface& SeqFreqChan::set_phaselist ( const dvector phaselist  )  [inline, virtual]

Sets the phaselist for the object

Reimplemented from SeqFreqChanInterface.

Definition at line 235 of file seqfreq.h.

const SeqVector& SeqFreqChan::get_freqlist_vector (  )  const [inline, virtual]

Returns the frequency list vector (for loop insertion)

Reimplemented from SeqFreqChanInterface.

Reimplemented in SeqDecoupling.

Definition at line 236 of file seqfreq.h.

const SeqVector& SeqFreqChan::get_phaselist_vector (  )  const [inline, virtual]

Returns the phaselist vector (for loop insertion)

Reimplemented from SeqFreqChanInterface.

Definition at line 237 of file seqfreq.h.

SeqFreqChanInterface& SeqFreqChan::set_reorder_scheme ( reorderScheme  scheme,
unsigned int  nsegments = 1 
) [inline, virtual]

Sets the reordering scheme for the frequency list

Reimplemented from SeqFreqChanInterface.

Definition at line 238 of file seqfreq.h.

SeqFreqChanInterface& SeqFreqChan::set_encoding_scheme ( encodingScheme  scheme  )  [inline, virtual]

Sets the encoding scheme

Reimplemented from SeqFreqChanInterface.

Definition at line 239 of file seqfreq.h.

const SeqVector& SeqFreqChan::get_reorder_vector (  )  const [inline, virtual]

Returns the reordering vector (for loop insertion)

Reimplemented from SeqFreqChanInterface.

Definition at line 240 of file seqfreq.h.

unsigned int SeqFreqChan::get_vectorsize (  )  const [inline, virtual]

Overload this function to return the number of elements in the vector (regardless of reordering)

Reimplemented from SeqVector.

Definition at line 244 of file seqfreq.h.

bool SeqFreqChan::prep_iteration (  )  const [virtual]

Overload this function to prepare objects at run-time before the execution of a loop repetition return 'false' when preparation fails

Reimplemented from SeqVector.

bool SeqFreqChan::is_qualvector (  )  const [inline, virtual]

Overload this function to tell whether the vector qualitatively alters the sequence concerning timings and RF power deposition. This is useful for accelerating duration and SAR calculations (Siemens).

Reimplemented from SeqVector.

Definition at line 246 of file seqfreq.h.

svector SeqFreqChan::get_vector_commands ( const STD_string &  iterator  )  const [inline, virtual]

If the vector is used as a variable in the code-generated pulse program, overload this function to return a unique label/command for the vector which is either attached to the loop (Bruker), or executed at the beginning of the loop (EPIC).

Reimplemented from SeqVector.

Definition at line 247 of file seqfreq.h.

virtual double SeqFreqChan::get_freqchan_duration (  )  const [inline, protected, virtual]

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

Reimplemented in SeqDecoupling.

Definition at line 264 of file seqfreq.h.

bool SeqFreqChan::prep (  )  [protected, virtual]

Overload this function to prepare objects before the measurement. This function will then be called automatically after editing the sequence parameters and before the measurement is started. This function should not alter the physical properties of the sequence object, e.g. its duration.

Reimplemented from SeqClass.


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

Generated on Wed Sep 30 15:33:17 2009 by  doxygen 1.5.6