SeqAcqRead Class Reference
[Classes for sequence design (odinseq library)]
Acquisition + readout gradient.
More...
#include <seqacqread.h>
Public Member Functions | |
| SeqAcqRead (const STD_string &object_label, double sweepwidth, unsigned int nAcqPoints, float fov, direction gradchannel, float os_factor=1.0, const STD_string &nucleus="", const dvector &phaselist=0, const dvector &freqlist=0, float timestep=0.0, rampType rampmode=linear) | |
| SeqAcqRead (const SeqAcqRead &sar) | |
| SeqAcqRead (const STD_string &object_label="unnamedSeqAcqRead") | |
| SeqAcqRead & | operator= (const SeqAcqRead &sar) |
| const SeqGradTrapez & | get_readgrad () const |
| double | get_acquisition_center () const |
| double | get_acquisition_start () const |
| SeqAcqInterface & | set_sweepwidth (double sw, float os_factor) |
Friends | |
| class | SeqGradEcho |
Detailed Description
Acquisition + readout gradient.This class represents an acquisition window with a read gradient.
Definition at line 37 of file seqacqread.h.
Constructor & Destructor Documentation
| SeqAcqRead::SeqAcqRead | ( | const STD_string & | object_label, | |
| double | sweepwidth, | |||
| unsigned int | nAcqPoints, | |||
| float | fov, | |||
| direction | gradchannel, | |||
| float | os_factor = 1.0, |
|||
| const STD_string & | nucleus = "", |
|||
| const dvector & | phaselist = 0, |
|||
| const dvector & | freqlist = 0, |
|||
| float | timestep = 0.0, |
|||
| rampType | rampmode = linear | |||
| ) |
Constructs an acquisition window with a simultaneous read gradient labeled 'object_label' and the following properties:
- sweepwidth: The sampling frequency
- nAcqPoints: The number of samples
- fov: The Field of View
- gradchannel: The channel where the read gradient will be placed
- os_factor: See class 'SeqAcq' for explanation
- nucleus: See class 'SeqAcq' for explanation
- phaselist: See class 'SeqAcq' for explanation
- freqlist: See class 'SeqAcq' for explanation
- timestep: The time resolution for the digitised ramps, the default is to take minimum time step the scanner is capable of.
- rampmode: This parameter determines the shape of the ramp waveform
| SeqAcqRead::SeqAcqRead | ( | const SeqAcqRead & | sar | ) |
Constructs an acquisition window with read gradient which is a copy of 'sar'
| SeqAcqRead::SeqAcqRead | ( | const STD_string & | object_label = "unnamedSeqAcqRead" |
) |
Constructs an empty acquisition window with read gradient with the given label.
Member Function Documentation
| SeqAcqRead& SeqAcqRead::operator= | ( | const SeqAcqRead & | sar | ) |
This assignment operator will make this object become an exact copy of 'sar'.
| const SeqGradTrapez& SeqAcqRead::get_readgrad | ( | ) | const [inline] |
Returns reference to read gradient.
Definition at line 81 of file seqacqread.h.
| double SeqAcqRead::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 SeqAcqRead::get_acquisition_start | ( | ) | const [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.
| SeqAcqInterface& SeqAcqRead::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.
The documentation for this class was generated from the following file:
