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

Acquisition. More...

#include <seqacq.h>

Inheritance diagram for SeqAcq:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 SeqAcq (const STD_string &object_label, unsigned int nAcqPoints, double sweepwidth, float os_factor=1.0, const STD_string &nucleus="", const dvector &phaselist=0, const dvector &freqlist=0)
 SeqAcq (const SeqAcq &sa)
 SeqAcq (const STD_string &object_label="unnamedSeqAcq")
 ~SeqAcq ()
SeqAcqset_npts (unsigned int nAcqPoints)
double get_sweep_width () const
SeqAcqoperator= (const SeqAcq &sa)
SeqAcqset_reflect_flag (bool flag)
void set_kspace_traj (const farray &kspaceTraj)
void set_weight_vec (const cvector &weightVec)
SeqAcqset_rel_center (double relative_kspace_center)
const kSpaceCoordget_kcoord () const
double get_acquisition_duration () const
double get_acquisition_center () const
double get_acquisition_start () const
unsigned int get_npts () const
SeqAcqInterfaceset_sweepwidth (double sw, float os_factor)
double get_sweepwidth () const
float get_oversampling () const
SeqAcqInterfaceset_readout_shape (const fvector &shape, unsigned int dstsize)
SeqAcqInterfaceset_reco_vector (recoDim dim, const SeqVector &vec, const dvector &valvec=dvector())
SeqAcqInterfaceset_default_reco_index (recoDim dim, unsigned int index)
STD_string get_program (programContext &context) const
double get_duration () const
void query (queryContext &context) const
RecoValList get_recovallist (unsigned int reptimes, JDXkSpaceCoords &coords) const
unsigned int event (eventContext &context) const
STD_string get_properties () const

Friends

class SeqMethod


Detailed Description

Acquisition.

This class represents an acquisition window

Definition at line 198 of file seqacq.h.


Constructor & Destructor Documentation

SeqAcq::SeqAcq ( const STD_string &  object_label,
unsigned int  nAcqPoints,
double  sweepwidth,
float  os_factor = 1.0,
const STD_string &  nucleus = "",
const dvector phaselist = 0,
const dvector freqlist = 0 
)

Constructs an acquisition window labeled 'object_label' with the following properties:

  • nAcqPoints: The number of sampling points that will be acquired during the acquisition
  • sweepwidth: The sampling frequency without oversampling
  • os_factor: The oversampling factor, os_factor=1 means no oversampling
  • nucleus: The nucleus for which the acquisition should be performed. The default is to acquire on the protons resonance freuency.
  • phaselist: This is an array of phases at which the acquired signal will be demodulated. The actual phase for each acquisition is determined by cycling through this array of phases which are represented in degree.
  • freqlist: This is an array of frequency offsets at which the acquired signal will be demodulated.

SeqAcq::SeqAcq ( const SeqAcq sa  ) 

Constructs an acquisition window which is a copy of 'sa'

SeqAcq::SeqAcq ( const STD_string &  object_label = "unnamedSeqAcq"  ) 

Constructs an empty acquisition window with the given label.

SeqAcq::~SeqAcq (  ) 

Destructor


Member Function Documentation

SeqAcq& SeqAcq::set_npts ( unsigned int  nAcqPoints  ) 

Sets the number of sampling points that will be acquired during the acquisition

double SeqAcq::get_sweep_width (  )  const [inline]

Returns the sweep width

Definition at line 247 of file seqacq.h.

SeqAcq& SeqAcq::operator= ( const SeqAcq sa  ) 

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

SeqAcq& SeqAcq::set_reflect_flag ( bool  flag  )  [inline]

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

Definition at line 261 of file seqacq.h.

void SeqAcq::set_kspace_traj ( const farray kspaceTraj  ) 

Specifies a an explicit k-space Trajectory for this ADC (for automatic reconstruction)

void SeqAcq::set_weight_vec ( const cvector weightVec  ) 

Specifies a complex vector which is is used to weight each point in this ADC (for automatic reconstruction)

SeqAcq& SeqAcq::set_rel_center ( double  relative_kspace_center  )  [inline]

Sets the relative point in time (between 0 and 1) when k-space center is passed, the default is 0.5. Will be used in get_acquisition_center().

Definition at line 279 of file seqacq.h.

const kSpaceCoord& SeqAcq::get_kcoord (  )  const

Returns the k-space index of this ADCs

double SeqAcq::get_acquisition_duration (  )  const [inline, virtual]

Returns the duration of the acquisition window without padding delays.

Reimplemented from SeqAcqInterface.

Definition at line 289 of file seqacq.h.

double SeqAcq::get_acquisition_center (  )  const [virtual]

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

Reimplemented from SeqAcqInterface.

double SeqAcq::get_acquisition_start (  )  const [inline, virtual]

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 from SeqAcqInterface.

Definition at line 291 of file seqacq.h.

unsigned int SeqAcq::get_npts (  )  const [inline, virtual]

Returns the total number of sampling points, without oversampling

Reimplemented from SeqAcqInterface.

Definition at line 292 of file seqacq.h.

SeqAcqInterface& SeqAcq::set_sweepwidth ( double  sw,
float  os_factor 
) [virtual]

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

Reimplemented from SeqAcqInterface.

double SeqAcq::get_sweepwidth (  )  const [inline, virtual]

Returns the sweepwidth factor

Reimplemented from SeqAcqInterface.

Definition at line 294 of file seqacq.h.

float SeqAcq::get_oversampling (  )  const [inline, virtual]

Returns the oversampling factor

Reimplemented from SeqAcqInterface.

Definition at line 295 of file seqacq.h.

SeqAcqInterface& SeqAcq::set_readout_shape ( const fvector shape,
unsigned int  dstsize 
) [virtual]

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

Reimplemented from SeqAcqInterface.

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

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 from SeqAcqInterface.

SeqAcqInterface& SeqAcq::set_default_reco_index ( recoDim  dim,
unsigned int  index 
) [virtual]

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

Reimplemented from SeqAcqInterface.

STD_string SeqAcq::get_program ( programContext context  )  const [virtual]

Returns the part in the pulse/gradient program of this sequence object. 'context' holds data about how the program should be generated, e.g. type of program and formatting.

Reimplemented from SeqTreeObj.

double SeqAcq::get_duration (  )  const [virtual]

Returns the duration of the sequence object.

Implements SeqTreeObj.

void SeqAcq::query ( queryContext context  )  const [inline, virtual]

Query the sequence tree recursively

Reimplemented from SeqTreeObj.

Definition at line 305 of file seqacq.h.

RecoValList SeqAcq::get_recovallist ( unsigned int  reptimes,
JDXkSpaceCoords coords 
) const [virtual]

Appends the k-space coordinates in this branch of the sequence tree to 'coords' and returns their ordering

Reimplemented from SeqTreeObj.

unsigned int SeqAcq::event ( eventContext context  )  const [virtual]

Queries the sequence tree for events, returns the number of events executed

Reimplemented from SeqTreeObj.

STD_string SeqAcq::get_properties (  )  const [virtual]

Returns a string describing the object

Reimplemented from SeqTreeObj.


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

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