Public Member Functions | List of all members

Gradient Waveform. More...

#include <seqgradwave.h>

Inheritance diagram for SeqGradWave:
Inheritance graph
[legend]

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")
 
SeqGradWaveset_wave (const fvector &waveform)
 
const fvectorget_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
 
SeqGradWaveoperator= (const SeqGradWave &sgw)
 
- Public Member Functions inherited from SeqGradChan
 SeqGradChan (const STD_string &object_label, direction gradchannel, float gradstrength, double gradduration)
 
 SeqGradChan (const STD_string &object_label="unnamedSeqGradChan")
 
 SeqGradChan (const SeqGradChan &sgc)
 
virtual ~SeqGradChan ()
 
SeqGradChanoperator= (const SeqGradChan &sgc)
 
virtual direction get_channel () const
 
SeqGradInterfaceset_strength (float gradstrength)
 
SeqGradInterfaceinvert_strength ()
 
float get_strength () const
 
double get_gradduration () const
 
SeqGradInterfaceset_gradrotmatrix (const RotMatrix &matrix)
 
fvector get_gradintegral () const
 
STD_string get_properties () const
 
unsigned int event (eventContext &context) const
 
- Public Member Functions inherited from SeqGradInterface
float get_gradintegral_norm () const
 
- 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)
 
- Public Member Functions inherited from SeqDur
 SeqDur (const STD_string &object_label, float duration)
 
 SeqDur (const STD_string &object_label="unnamedSeqDur")
 
 SeqDur (const SeqDur &sd)
 
SeqDurset_duration (float duration)
 
double get_duration () const
 
SeqDuroperator= (const SeqDur &sd)
 
- Public Member Functions inherited from SeqTreeObj
virtual STD_string get_program (programContext &context) const
 
virtual RecoValList get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const
 
bool contains (const SeqTreeObj *sto) const
 
void tree (SeqTreeCallbackAbstract *display) const
 
virtual SeqValList get_freqvallist (freqlistAction action) const
 
virtual SeqValList get_delayvallist () const
 
virtual double get_rf_energy () const
 

Additional Inherited Members

- Protected Member Functions inherited from SeqGradChan
float get_grdfactor (direction chan) const
 
fvector get_grdfactors_norot () const
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual void clear_container ()
 
- Protected Member Functions inherited from SeqTreeObj
virtual void query (queryContext &context) const
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

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() [1/3]

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() [2/3]

SeqGradWave::SeqGradWave ( const SeqGradWave sgw)

Constructs a copy of 'sgw'

§ SeqGradWave() [3/3]

SeqGradWave::SeqGradWave ( const STD_string &  object_label = "unnamedSeqGradWave")

Construct an empty gradient object with the given label

Member Function Documentation

§ get_integral()

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)

§ get_npts()

unsigned int SeqGradWave::get_npts ( ) const

Returns the number of digitised points for the waveform

§ get_timestep()

double SeqGradWave::get_timestep ( ) const
inline

Returns the sampling rate of the waveform

Definition at line 91 of file seqgradwave.h.

§ get_wave()

const fvector& SeqGradWave::get_wave ( ) const
inline

Returns the waveform that will be used

Definition at line 69 of file seqgradwave.h.

§ operator=()

SeqGradWave& SeqGradWave::operator= ( const SeqGradWave sgw)

Assignment operator that makes this gradient channel object become a copy of 'sgw'

§ operator[]()

float SeqGradWave::operator[] ( unsigned int  i) const
inline

Returns the i'th element of the waveform

Definition at line 96 of file seqgradwave.h.

§ set_wave()

SeqGradWave& SeqGradWave::set_wave ( const fvector waveform)

Specifies the waveform that will be used

§ size()

unsigned int SeqGradWave::size ( ) const
inline

Returns the number of digitised points for the waveform

Definition at line 86 of file seqgradwave.h.


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