ODIN
Public Member Functions | Friends | List of all members
SeqFreqChanInterface Class Reference

#include <seqfreq.h>

Inheritance diagram for SeqFreqChanInterface:
Inheritance graph
[legend]

Public Member Functions

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 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)
 

Friends

class SeqAcqEPI
 

Additional Inherited Members

- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual void clear_container ()
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Abstract interfac class for all sequence objects that occupy a transmitter/receiver channel, e.g. pulse objects or acquisition objects

Definition at line 36 of file seqfreq.h.

Member Function Documentation

◆ get_freqlist_vector()

virtual const SeqVector& SeqFreqChanInterface::get_freqlist_vector ( ) const
inlinevirtual

Returns the frequency list vector (for loop insertion)

Reimplemented in SeqFreqChan, SeqDecoupling, and SeqAcqEPI.

Definition at line 58 of file seqfreq.h.

◆ get_phaselist_reorder_vector()

virtual const SeqVector& SeqFreqChanInterface::get_phaselist_reorder_vector ( ) const
inlinevirtual

Returns the reordering vector of the phase list (for loop insertion)

Definition at line 99 of file seqfreq.h.

◆ get_phaselist_vector()

virtual const SeqVector& SeqFreqChanInterface::get_phaselist_vector ( ) const
inlinevirtual

Returns the phaselist vector (for loop insertion)

Reimplemented in SeqFreqChan, and SeqAcqEPI.

Definition at line 64 of file seqfreq.h.

◆ get_reorder_vector()

virtual const SeqVector& SeqFreqChanInterface::get_reorder_vector ( ) const
inlinevirtual

Returns the reordering vector of the frequency list (for loop insertion)

Definition at line 84 of file seqfreq.h.

◆ operator const SeqVector &()

SeqFreqChanInterface::operator const SeqVector & ( ) const
inline

Returns the frequency list vector (for loop insertion)

Definition at line 69 of file seqfreq.h.

◆ set_encoding_scheme()

virtual SeqFreqChanInterface& SeqFreqChanInterface::set_encoding_scheme ( encodingScheme  scheme)
inlinevirtual

Sets the frequency encoding scheme

Definition at line 74 of file seqfreq.h.

◆ set_freqlist()

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

Sets the freqlist for the object

Reimplemented in SeqFreqChan, and SeqAcqEPI.

Definition at line 48 of file seqfreq.h.

◆ set_freqoffset()

SeqFreqChanInterface& SeqFreqChanInterface::set_freqoffset ( double  freqoffset)

Sets the frequency list to a single value 'freqoffset'

◆ set_nucleus()

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

Specify the nucleus for this frequency channel

Reimplemented in SeqPulsar, SeqFreqChan, and SeqAcqEPI.

Definition at line 42 of file seqfreq.h.

◆ set_phase()

SeqFreqChanInterface& SeqFreqChanInterface::set_phase ( double  phaseval)

Sets the phase list to a single value 'phaseval'

◆ set_phaselist()

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

Sets the phaselist for the object

Reimplemented in SeqFreqChan, and SeqAcqEPI.

Definition at line 53 of file seqfreq.h.

◆ set_phaselist_encoding_scheme()

virtual SeqFreqChanInterface& SeqFreqChanInterface::set_phaselist_encoding_scheme ( encodingScheme  scheme)
inlinevirtual

Sets the encoding scheme of the phase list

Definition at line 89 of file seqfreq.h.

◆ set_phaselist_reorder_scheme()

virtual SeqFreqChanInterface& SeqFreqChanInterface::set_phaselist_reorder_scheme ( reorderScheme  scheme,
unsigned int  nsegments = 1 
)
inlinevirtual

Sets the reordering scheme for the phase list

Definition at line 94 of file seqfreq.h.

◆ set_phasespoiling()

SeqFreqChanInterface& SeqFreqChanInterface::set_phasespoiling ( unsigned int  size = 80,
double  incr = 117.0,
double  offset = 0.0 
)

Sets a phase list for RF spoiling of length 'size', multiplicator 'incr' and uniform 'offset'. Defaults are recommended by the 'Handbook of MRI'

◆ set_reorder_scheme()

virtual SeqFreqChanInterface& SeqFreqChanInterface::set_reorder_scheme ( reorderScheme  scheme,
unsigned int  nsegments = 1 
)
inlinevirtual

Sets the reordering scheme for the frequency list

Definition at line 79 of file seqfreq.h.


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