SeqGradWave Class Reference
[Classes for sequence design (odinseq library)]
Gradient Waveform.
More...
#include <seqgradwave.h>
Public Member Functions | |
| SeqGradWave (const STD_string &object_label, direction gradchannel, double gradduration, float maxgradstrength, const fvector &waveform) | |
| SeqGradWave (const SeqGradWave &sgw) | |
| SeqGradWave (const STD_string &object_label="unnamedSeqGradWave") | |
| SeqGradWave & | set_wave (const fvector &waveform) |
| const fvector & | get_wave () const |
| float | get_integral (double tmin, double tmax) const |
| unsigned int | get_npts () const |
| unsigned int | size () const |
| double | get_timestep () const |
| float | operator[] (unsigned int i) const |
| SeqGradWave & | operator= (const SeqGradWave &sgw) |
Detailed Description
Gradient Waveform.This class represents a gradient object with an arbitrarily shaped gradient field The physical gradient strengths of one data point is the product of the value of the waveform at that point and the gradient strength of this object
Definition at line 36 of file seqgradwave.h.
Constructor & Destructor Documentation
| SeqGradWave::SeqGradWave | ( | const STD_string & | object_label, | |
| direction | gradchannel, | |||
| double | gradduration, | |||
| float | maxgradstrength, | |||
| const fvector & | waveform | |||
| ) |
Constructs a gradient waveform labeled 'object_label' with the following properties:
- gradchannel: The channel this object should be played out
- gradduration: The duration of this gradient object
- maxgradstrength: The maximum gradient strength for this object
- waveform: The waveform that will be played out
| SeqGradWave::SeqGradWave | ( | const SeqGradWave & | sgw | ) |
Constructs a copy of 'sgw'
| SeqGradWave::SeqGradWave | ( | const STD_string & | object_label = "unnamedSeqGradWave" |
) |
Construct an empty gradient object with the given label
Member Function Documentation
| SeqGradWave& SeqGradWave::set_wave | ( | const fvector & | waveform | ) |
Specifies the waveform that will be used
| const fvector& SeqGradWave::get_wave | ( | ) | const [inline] |
Returns the waveform that will be used
Definition at line 69 of file seqgradwave.h.
| float SeqGradWave::get_integral | ( | double | tmin, | |
| double | tmax | |||
| ) | const |
Returns the integral of the waveform time tmin to time tmax (relative to the starting point of the ramp)
| unsigned int SeqGradWave::get_npts | ( | ) | const |
Returns the number of digitised points for the waveform
| unsigned int SeqGradWave::size | ( | ) | const [inline] |
Returns the number of digitised points for the waveform
Definition at line 86 of file seqgradwave.h.
| double SeqGradWave::get_timestep | ( | ) | const [inline] |
Returns the sampling rate of the waveform
Definition at line 91 of file seqgradwave.h.
| float SeqGradWave::operator[] | ( | unsigned int | i | ) | const [inline] |
Returns the i'th element of the waveform
Definition at line 96 of file seqgradwave.h.
| SeqGradWave& SeqGradWave::operator= | ( | const SeqGradWave & | sgw | ) |
Assignment operator that makes this gradient channel object become a copy of 'sgw'
The documentation for this class was generated from the following file:
