Public Member Functions | Protected Member Functions | Friends | List of all members

#include <seqfreq.h>

Inheritance diagram for SeqFreqChan:
Inheritance graph
[legend]

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
 
unsigned int get_vectorsize () const
 
bool prep_iteration () const
 
bool is_qualvector () const
 
svector get_vector_commands (const STD_string &iterator) const
 
- Public Member Functions inherited from SeqVector
 SeqVector (const STD_string &object_label="unnamedSeqVector")
 
 SeqVector (const STD_string &object_label, unsigned int nindices, int slope=1, int offset=0)
 
 SeqVector (const SeqVector &sv)
 
virtual ~SeqVector ()
 
SeqVectoroperator= (const SeqVector &sv)
 
virtual unsigned int get_numof_iterations () const
 
virtual bool needs_unrolling_check () const
 
virtual int get_current_index () const
 
int get_acq_index () const
 
virtual bool is_acq_vector () const
 
virtual bool is_obj_vector () const
 
virtual STD_string get_loopcommand () const
 
SeqVectorset_indexvec (const ivector &iv)
 
ivector get_indexvec () const
 
SeqVectorset_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)
 
SeqVectorset_encoding_scheme (encodingScheme scheme)
 
const SeqVectorget_reorder_vector () const
 
virtual nestingRelation get_nesting_relation () const
 
iarray get_index_matrix () const
 
int get_current_reord_index () const
 
STD_string get_reord_iterator (const STD_string &iterator) 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 SeqFreqChanInterface
 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)
 

Protected Member Functions

virtual double get_freqchan_duration () const
 
bool prep ()
 
- Protected Member Functions inherited from SeqVector
virtual svector get_reord_vector_commands (const STD_string &iterator) const
 
bool is_handled () const
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual void clear_container ()
 

Friends

class SeqPhaseListVector
 

Additional Inherited Members

- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

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

Definition at line 171 of file seqfreq.h.

Constructor & Destructor Documentation

§ SeqFreqChan() [1/3]

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

Constructs an empty frequency channel labeled 'object_label'

§ SeqFreqChan() [2/3]

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() [3/3]

SeqFreqChan::SeqFreqChan ( const SeqFreqChan sfc)

Constructs a copy of 'sfc'

§ ~SeqFreqChan()

virtual SeqFreqChan::~SeqFreqChan ( )
inlinevirtual

Destructor

Definition at line 202 of file seqfreq.h.

Member Function Documentation

§ get_channel()

int SeqFreqChan::get_channel ( ) const
inline

Return the assigned number of this frequency channel

Definition at line 214 of file seqfreq.h.

§ get_freqchan_duration()

virtual double SeqFreqChan::get_freqchan_duration ( ) const
inlineprotectedvirtual

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

Reimplemented in SeqDecoupling.

Definition at line 283 of file seqfreq.h.

§ get_freqlist()

dvector SeqFreqChan::get_freqlist ( ) const
inline

Returns the freqlist of the object

Definition at line 220 of file seqfreq.h.

§ get_freqlist_vector()

const SeqVector& SeqFreqChan::get_freqlist_vector ( ) const
inlinevirtual

Returns the frequency list vector (for loop insertion)

Reimplemented from SeqFreqChanInterface.

Definition at line 258 of file seqfreq.h.

§ get_freqlistindex()

virtual unsigned int SeqFreqChan::get_freqlistindex ( ) const
inlinevirtual

Return the index for the frequency list

Reimplemented in SeqDecoupling.

Definition at line 244 of file seqfreq.h.

§ get_frequency()

virtual double SeqFreqChan::get_frequency ( ) const
virtual

Returns the current frequency

§ get_iteratorcommand()

STD_string SeqFreqChan::get_iteratorcommand ( objCategory  cat) const

Returns the command to iterate through the frequency list

§ get_phase()

double SeqFreqChan::get_phase ( ) const
inline

Returns the current phase (in rad !)

Definition at line 226 of file seqfreq.h.

§ get_phaselist_vector()

const SeqVector& SeqFreqChan::get_phaselist_vector ( ) const
inlinevirtual

Returns the phaselist vector (for loop insertion)

Reimplemented from SeqFreqChanInterface.

Definition at line 259 of file seqfreq.h.

§ get_phaselistindex()

unsigned int SeqFreqChan::get_phaselistindex ( ) const
inline

Return the index for the phase list

Definition at line 238 of file seqfreq.h.

§ get_vector_commands()

svector SeqFreqChan::get_vector_commands ( const STD_string &  iterator) const
inlinevirtual

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 266 of file seqfreq.h.

§ get_vectorsize()

unsigned int SeqFreqChan::get_vectorsize ( ) const
inlinevirtual

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

Reimplemented from SeqVector.

Definition at line 263 of file seqfreq.h.

§ is_qualvector()

bool SeqFreqChan::is_qualvector ( ) const
inlinevirtual

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 265 of file seqfreq.h.

§ operator=()

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

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

§ prep()

bool SeqFreqChan::prep ( )
protectedvirtual

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.

§ prep_iteration()

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.

§ set_freqlist()

SeqFreqChanInterface& SeqFreqChan::set_freqlist ( const dvector freqlist)
inlinevirtual

Sets the freqlist for the object

Reimplemented from SeqFreqChanInterface.

Definition at line 256 of file seqfreq.h.

§ set_nucleus()

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

Specify the nucleus for this frequency channel

Reimplemented from SeqFreqChanInterface.

§ set_phaselist()

SeqFreqChanInterface& SeqFreqChan::set_phaselist ( const dvector phaselist)
inlinevirtual

Sets the phaselist for the object

Reimplemented from SeqFreqChanInterface.

Definition at line 257 of file seqfreq.h.


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