ODIN
Public Member Functions | Friends | List of all members

#include <seqacq.h>

Inheritance diagram for SeqAcqInterface:
Inheritance graph
[legend]

Public Member Functions

virtual double get_acquisition_duration () const
 
virtual double get_acquisition_center () const
 
virtual double get_acquisition_start () const
 
virtual unsigned int get_npts () const
 
virtual SeqAcqInterfaceset_sweepwidth (double sw, float os_factor)
 
virtual double get_sweepwidth () const
 
virtual float get_oversampling () const
 
virtual SeqAcqInterfaceset_readout_shape (const fvector &shape, unsigned int dstsize)
 
virtual SeqAcqInterfaceset_reco_vector (recoDim dim, const SeqVector &vec, const dvector &valvec=dvector())
 
virtual SeqAcqInterfaceset_default_reco_index (recoDim dim, unsigned int index)
 
virtual SeqAcqInterfaceset_template_type (templateType type)
 
virtual SeqAcqInterfaceset_reflect_flag (bool flag)
 
- 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 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 SeqAcqDeph
 

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

This is the abstract base class for all objects that have the property of acquiring a signal

Definition at line 39 of file seqacq.h.

Member Function Documentation

◆ get_acquisition_center()

virtual double SeqAcqInterface::get_acquisition_center ( ) const
inlinevirtual

Returns the the duration from the the beginnig of the acquisition object to the middle of the acquisition window.

Reimplemented in SeqGradEcho, SeqAcqSpiral, SeqAcqRead, SeqAcqEPI, SeqEpiDriverDefault, and SeqAcq.

Definition at line 52 of file seqacq.h.

◆ get_acquisition_duration()

virtual double SeqAcqInterface::get_acquisition_duration ( ) const
inlinevirtual

Returns the duration of the acquisition window without padding delays.

Reimplemented in SeqAcq.

Definition at line 46 of file seqacq.h.

◆ get_acquisition_start()

virtual double SeqAcqInterface::get_acquisition_start ( ) const
inlinevirtual

Returns the the duration from the the beginnig of the acquisition object to the beginnig of the acquisition window (the point of time where data starts to be acquired).

Reimplemented in SeqGradEcho, SeqAcqSpiral, SeqAcqRead, SeqAcqEPI, SeqEpiDriverDefault, and SeqAcq.

Definition at line 59 of file seqacq.h.

◆ get_npts()

virtual unsigned int SeqAcqInterface::get_npts ( ) const
inlinevirtual

Returns the total number of sampling points, without oversampling

Reimplemented in SeqAcqEPI, SeqEpiDriver, and SeqAcq.

Definition at line 65 of file seqacq.h.

◆ get_oversampling()

virtual float SeqAcqInterface::get_oversampling ( ) const
inlinevirtual

Returns the oversampling factor

Reimplemented in SeqAcqEPI, and SeqAcq.

Definition at line 84 of file seqacq.h.

◆ get_sweepwidth()

virtual double SeqAcqInterface::get_sweepwidth ( ) const
inlinevirtual

Returns the sweepwidth factor

Reimplemented in SeqAcqEPI, and SeqAcq.

Definition at line 79 of file seqacq.h.

◆ set_default_reco_index()

virtual SeqAcqInterface& SeqAcqInterface::set_default_reco_index ( recoDim  dim,
unsigned int  index 
)
inlinevirtual

Sets the default value 'index' for the reco index in dimension 'dim'. This is relevant for automatic reconstruction.

Reimplemented in SeqAcqEPI, and SeqAcq.

Definition at line 110 of file seqacq.h.

◆ set_readout_shape()

virtual SeqAcqInterface& SeqAcqInterface::set_readout_shape ( const fvector shape,
unsigned int  dstsize 
)
inlinevirtual

Specifies a regridding matrix for this ADC (for automatic reconstruction)

Reimplemented in SeqAcq.

Definition at line 91 of file seqacq.h.

◆ set_reco_vector()

virtual SeqAcqInterface& SeqAcqInterface::set_reco_vector ( recoDim  dim,
const SeqVector vec,
const dvector valvec = dvector() 
)
inlinevirtual

Specifies a vector 'vec' which indexes the data dimension 'dim'. The current index for each acquisition is retrieved from the vector. This is relevant for automatic reconstruction. An additional vector 'valvec' of double values can be given, which is attached to this dimension, e.g. different TEs in the echo dimension.

Reimplemented in SeqAcqEPI, and SeqAcq.

Definition at line 102 of file seqacq.h.

◆ set_reflect_flag()

virtual SeqAcqInterface& SeqAcqInterface::set_reflect_flag ( bool  flag)
inlinevirtual

Specifies whether the data points should be reversed, only relevant for automatic reconstruction

Reimplemented in SeqAcq.

Definition at line 124 of file seqacq.h.

◆ set_sweepwidth()

virtual SeqAcqInterface& SeqAcqInterface::set_sweepwidth ( double  sw,
float  os_factor 
)
inlinevirtual

Sets the sweepwidth 'sw' without oversampling and oversampling factor 'os_factor' for this acquisition object, os_factor=1 means no oversampling.

Reimplemented in SeqAcqSpiral, SeqAcqRead, SeqAcqEPI, and SeqAcq.

Definition at line 73 of file seqacq.h.

◆ set_template_type()

virtual SeqAcqInterface& SeqAcqInterface::set_template_type ( templateType  type)
inlinevirtual

Sets the template mode of this acquisition object. This is also relevant for automatic reconstruction.

Reimplemented in SeqGradEcho, SeqAcqEPI, and SeqEpiDriverDefault.

Definition at line 117 of file seqacq.h.


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