Public Member Functions | List of all members

Gradient Ramp. More...

#include <seqgradramp.h>

Inheritance diagram for SeqGradRamp:
Inheritance graph
[legend]

Public Member Functions

 SeqGradRamp (const STD_string &object_label, direction gradchannel, float initgradstrength, float finalgradstrength, double timestep, rampType type=linear, float steepnessfactor=1.0, bool reverse=false)
 
 SeqGradRamp (const STD_string &object_label, direction gradchannel, double gradduration, float initgradstrength, float finalgradstrength, double timestep, rampType type=linear, bool reverse=false)
 
 SeqGradRamp (const SeqGradRamp &sgr)
 
 SeqGradRamp (const STD_string &object_label="unnamedSeqGradRamp")
 
SeqGradRampset_ramp (float initgradstrength, float finalgradstrength, double timestep, rampType type=linear, float steepnessfactor=1.0, bool reverse=false)
 
SeqGradRampset_ramp (double gradduration, float initgradstrength, float finalgradstrength, double timestep, rampType type=linear, bool reverse=false)
 
rampType get_ramptype () const
 
SeqGradRampoperator= (const SeqGradRamp &sgr)
 
SeqGradInterfaceset_strength (float gradstrength)
 
- Public Member Functions inherited from SeqGradWave
 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
 
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 Ramp.

This class represents a digitized gradient ramp.

Definition at line 52 of file seqgradramp.h.

Constructor & Destructor Documentation

§ SeqGradRamp() [1/4]

SeqGradRamp::SeqGradRamp ( const STD_string &  object_label,
direction  gradchannel,
float  initgradstrength,
float  finalgradstrength,
double  timestep,
rampType  type = linear,
float  steepnessfactor = 1.0,
bool  reverse = false 
)

Constructs a gradient ramp labeled 'object_label' with the following properties:

  • gradchannel: The channel this object should be played out
  • initgradstrength: The initial gradient strength, i.e. the strength at the beginning of the ramp
  • finalgradstrength: The final gradient strength, i.e. the strength at the end of the ramp
  • timestep: The time between adjecent points of the ramp
  • type: The shape for the ramp
  • steepnessfactor: This parameter in the range of ]0,1] determines the relative rising speed of the gradient strength, i.e. with 1 the gradients are switched as fast as possible
  • reverse: Reverse ramp calculation (only relevant for asymmetric ramps)

§ SeqGradRamp() [2/4]

SeqGradRamp::SeqGradRamp ( const STD_string &  object_label,
direction  gradchannel,
double  gradduration,
float  initgradstrength,
float  finalgradstrength,
double  timestep,
rampType  type = linear,
bool  reverse = false 
)

Constructs a gradient ramp labeled 'object_label' with the following properties:

  • gradchannel: The channel this object should be played out
  • gradduration: The duration of this gradient object
  • initgradstrength: The initial gradient strength, i.e. the strength at the beginning of the ramp
  • finalgradstrength: The final gradient strength, i.e. the strength at the end of the ramp
  • timestep: The time between adjecent points of the ramp
  • type: The shape for the ramp
  • reverse: Reverse ramp calculation (only relevant for asymmetric ramps)

§ SeqGradRamp() [3/4]

SeqGradRamp::SeqGradRamp ( const SeqGradRamp sgr)

Constructs a copy of 'sgr'

§ SeqGradRamp() [4/4]

SeqGradRamp::SeqGradRamp ( const STD_string &  object_label = "unnamedSeqGradRamp")

Construct an empty gradient object with the given label

Member Function Documentation

§ get_ramptype()

rampType SeqGradRamp::get_ramptype ( ) const
inline

Returns the shape for the ramp

Definition at line 127 of file seqgradramp.h.

§ operator=()

SeqGradRamp& SeqGradRamp::operator= ( const SeqGradRamp sgr)

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

§ set_ramp() [1/2]

SeqGradRamp& SeqGradRamp::set_ramp ( float  initgradstrength,
float  finalgradstrength,
double  timestep,
rampType  type = linear,
float  steepnessfactor = 1.0,
bool  reverse = false 
)

Sets the ramp according to the following parameters:

  • initgradstrength: The initial gradient strength, i.e. the strength at the beginning of the ramp
  • finalgradstrength: The final gradient strength, i.e. the strength at the end of the ramp
  • timestep: The time between adjecent points of the ramp
  • type: The shape for the ramp
  • steepnessfactor: This parameter in the range of ]0,1] determines the relative rising speed of the gradient strength, i.e. with 1 the gradients are switched as fast as possible
  • reverse: Reverse ramp calculation (only relevant for asymmetric ramps)

§ set_ramp() [2/2]

SeqGradRamp& SeqGradRamp::set_ramp ( double  gradduration,
float  initgradstrength,
float  finalgradstrength,
double  timestep,
rampType  type = linear,
bool  reverse = false 
)

Sets the ramp according to the following parameters:

  • gradduration: The duration of this gradient object
  • initgradstrength: The initial gradient strength, i.e. the strength at the beginning of the ramp
  • finalgradstrength: The final gradient strength, i.e. the strength at the end of the ramp
  • timestep: The time between adjecent points of the ramp
  • type: The shape for the ramp
  • reverse: Reverse ramp calculation (only relevant for asymmetric ramps)

§ set_strength()

SeqGradInterface& SeqGradRamp::set_strength ( float  gradstrength)
virtual

Changes the strength of the gradient object

Reimplemented from SeqGradChan.


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