Public Member Functions | List of all members

Trapezoidal gradient. More...

#include <seqgradtrapez.h>

Inheritance diagram for SeqGradTrapez:
Inheritance graph
[legend]

Public Member Functions

 SeqGradTrapez (const STD_string &object_label, direction gradchannel, float gradstrength, double constgradduration, double timestep=0.01, rampType type=linear, double minrampduration=0.0, float steepness=1.0)
 
 SeqGradTrapez (const STD_string &object_label, float gradintegral, direction gradchannel, double constgradduration, double timestep=0.01, rampType type=linear, double minrampduration=0.0, float steepness=1.0)
 
 SeqGradTrapez (const STD_string &object_label, float gradintegral, float gradstrength, direction gradchannel, double timestep=0.01, rampType type=linear, double minrampduration=0.0, float steepness=1.0)
 
 SeqGradTrapez (const SeqGradTrapez &sgt)
 
 SeqGradTrapez (const STD_string &object_label="unnamedSeqGradTrapez")
 
SeqGradTrapezoperator= (const SeqGradTrapez &sgt)
 
SeqGradTrapezset_constgrad_duration (double duration)
 
double get_onramp_duration () const
 
double get_constgrad_duration () const
 
double get_offramp_duration () const
 
float get_onramp_integral (double tmin, double tmax) const
 
float get_onramp_integral () const
 
float get_constgrad_integral () const
 
float get_offramp_integral (double tmin, double tmax) const
 
float get_offramp_integral () const
 
SeqGradTrapezset_integral (float gradintegral)
 
float get_integral () const
 
unsigned int get_onramp_npts () const
 
unsigned int get_const_npts () const
 
unsigned int get_offramp_npts () const
 
unsigned int get_npts () const
 
fvector get_onramp () const
 
fvector get_offramp () const
 
fvector get_trapezshape () const
 
double get_timestep () const
 
rampType get_ramptype () const
 
SeqGradTrapezexclude_offramp_from_timing (bool flag)
 
float get_strength () const
 
double get_gradduration () const
 
- Public Member Functions inherited from SeqGradChanList
 SeqGradChanList (const STD_string &object_label="unnamedSeqGradChanList")
 
 SeqGradChanList (const SeqGradChanList &sgcl)
 
 ~SeqGradChanList ()
 
SeqGradChanListoperator= (const SeqGradChanList &sgcl)
 
double get_duration () const
 
STD_string get_properties () const
 
unsigned int event (eventContext &context) const
 
void query (queryContext &context) const
 
SeqGradInterfaceset_strength (float gradstrength)
 
SeqGradInterfaceinvert_strength ()
 
fvector get_gradintegral () const
 
SeqGradInterfaceset_gradrotmatrix (const RotMatrix &matrix)
 
direction get_channel () const
 
SeqGradChanListoperator+= (SeqGradChanList &sgcl)
 
SeqGradChanListoperator+= (SeqGradChan &sgc)
 
- Public Member Functions inherited from List< SeqGradChan, SeqGradChan *, SeqGradChan &>
 List ()
 
 ~List ()
 
Listoperator= (const List &l)
 
Listclear ()
 
Listappend (SeqGradChan & item)
 
Listremove (SeqGradChan & item)
 
unsigned int size () const
 
iter get_begin ()
 
iter get_end ()
 
constiter get_const_begin () const
 
constiter get_const_end () 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 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

- Public Types inherited from List< SeqGradChan, SeqGradChan *, SeqGradChan &>
typedef STD_list< SeqGradChan * >::iterator iter
 
typedef STD_list< SeqGradChan * >::const_iterator constiter
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Trapezoidal gradient.

This class represents a gradient pulse with a trapezoidal shape, i.e. a piecewise constant gradient with ramps

Definition at line 141 of file seqgradtrapez.h.

Constructor & Destructor Documentation

§ SeqGradTrapez() [1/5]

SeqGradTrapez::SeqGradTrapez ( const STD_string &  object_label,
direction  gradchannel,
float  gradstrength,
double  constgradduration,
double  timestep = 0.01,
rampType  type = linear,
double  minrampduration = 0.0,
float  steepness = 1.0 
)

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

  • gradchannel: The channel this object should be played out
  • gradstrength: The maximum gradient strength for this object
  • constgradduration: The duration of the constant part of the gradient pulse
  • timestep: The time resolution for the ramps
  • type: The shape for the ramps
  • minrampduration: The minimum duration for the ramps
  • steepness: 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

§ SeqGradTrapez() [2/5]

SeqGradTrapez::SeqGradTrapez ( const STD_string &  object_label,
float  gradintegral,
direction  gradchannel,
double  constgradduration,
double  timestep = 0.01,
rampType  type = linear,
double  minrampduration = 0.0,
float  steepness = 1.0 
)

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

  • gradintegral: The overall integral for the gradient pulse
  • gradchannel: The channel this object should be played out
  • constgradduration: The duration of the constant part of the gradient pulse
  • timestep: The time resolution for the ramps
  • rampType: The shape for the ramps
  • minrampduration: The minimum duration for the ramps
  • steepness: 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

§ SeqGradTrapez() [3/5]

SeqGradTrapez::SeqGradTrapez ( const STD_string &  object_label,
float  gradintegral,
float  gradstrength,
direction  gradchannel,
double  timestep = 0.01,
rampType  type = linear,
double  minrampduration = 0.0,
float  steepness = 1.0 
)

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

  • gradintegral: The overall integral for the gradient pulse
  • gradstrength: The strength of the constant part of the gradient pulse
  • gradchannel: The channel this object should be played out
  • timestep: The time resolution for the ramps
  • rampType: The shape for the ramps
  • minrampduration: The minimum duration for the ramps
  • steepness: 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

§ SeqGradTrapez() [4/5]

SeqGradTrapez::SeqGradTrapez ( const SeqGradTrapez sgt)

Constructs a copy of 'sgt'

§ SeqGradTrapez() [5/5]

SeqGradTrapez::SeqGradTrapez ( const STD_string &  object_label = "unnamedSeqGradTrapez")

Construct an empty gradient pulse with the given label

Member Function Documentation

§ exclude_offramp_from_timing()

SeqGradTrapez& SeqGradTrapez::exclude_offramp_from_timing ( bool  flag)

Spefifies whether to exclude the off-ramp from timing calculations

§ get_const_npts()

unsigned int SeqGradTrapez::get_const_npts ( ) const

Returns the number of digitised points during the constant part

§ get_constgrad_duration()

double SeqGradTrapez::get_constgrad_duration ( ) const
inline

Returns the duration of the constant part of the gradient pulse

Definition at line 225 of file seqgradtrapez.h.

§ get_constgrad_integral()

float SeqGradTrapez::get_constgrad_integral ( ) const
inline

Returns the integral of the constant part

Definition at line 247 of file seqgradtrapez.h.

§ get_gradduration()

double SeqGradTrapez::get_gradduration ( ) const
inlinevirtual

Returns the duration of the gradient object. This function returns only the effective duration during whichthe gradient is active, any delays before and after the gradient are omitted.

Reimplemented from SeqGradChanList.

Definition at line 323 of file seqgradtrapez.h.

§ get_integral()

float SeqGradTrapez::get_integral ( ) const

Returns the overall integral of the gradient pulse

§ get_npts()

unsigned int SeqGradTrapez::get_npts ( ) const

Returns the total number of digitised points

§ get_offramp()

fvector SeqGradTrapez::get_offramp ( ) const
inline

Returns the waveform of the ramp that switches the gradient pulse on

Definition at line 298 of file seqgradtrapez.h.

§ get_offramp_duration()

double SeqGradTrapez::get_offramp_duration ( ) const
inline

Returns the duration of the ramp that switches the gradient pulse off

Definition at line 231 of file seqgradtrapez.h.

§ get_offramp_integral() [1/2]

float SeqGradTrapez::get_offramp_integral ( double  tmin,
double  tmax 
) const
inline

Returns the integral of the ramp that switches the gradient pulse off from tmin to tmax

Definition at line 252 of file seqgradtrapez.h.

§ get_offramp_integral() [2/2]

float SeqGradTrapez::get_offramp_integral ( ) const
inline

Returns the integral of the ramp that switches the gradient pulse off

Definition at line 257 of file seqgradtrapez.h.

§ get_offramp_npts()

unsigned int SeqGradTrapez::get_offramp_npts ( ) const

Returns the number of digitised points of the ramp that switches the gradient pulse off

§ get_onramp()

fvector SeqGradTrapez::get_onramp ( ) const
inline

Returns the waveform of the ramp that switches the gradient pulse on

Definition at line 293 of file seqgradtrapez.h.

§ get_onramp_duration()

double SeqGradTrapez::get_onramp_duration ( ) const
inline

Returns the duration of the ramp that switches the gradient pulse on

Definition at line 219 of file seqgradtrapez.h.

§ get_onramp_integral() [1/2]

float SeqGradTrapez::get_onramp_integral ( double  tmin,
double  tmax 
) const
inline

Returns the integral of the ramp that switches the gradient pulse on from tmin to tmax

Definition at line 237 of file seqgradtrapez.h.

§ get_onramp_integral() [2/2]

float SeqGradTrapez::get_onramp_integral ( ) const
inline

Returns the integral of the ramp that switches the gradient pulse on

Definition at line 242 of file seqgradtrapez.h.

§ get_onramp_npts()

unsigned int SeqGradTrapez::get_onramp_npts ( ) const

Returns the number of digitised points of the ramp that switches the gradient pulse on

§ get_ramptype()

rampType SeqGradTrapez::get_ramptype ( ) const
inline

Returns the shape type of the ramps

Definition at line 313 of file seqgradtrapez.h.

§ get_strength()

float SeqGradTrapez::get_strength ( ) const
inlinevirtual

Returns the strength of the gradient object

Reimplemented from SeqGradChanList.

Definition at line 322 of file seqgradtrapez.h.

§ get_timestep()

double SeqGradTrapez::get_timestep ( ) const
inline

Returns the time resolution for the ramps

Definition at line 308 of file seqgradtrapez.h.

§ get_trapezshape()

fvector SeqGradTrapez::get_trapezshape ( ) const

Returns a waveform which is a digitised version of the whole trapezoid

§ operator=()

SeqGradTrapez& SeqGradTrapez::operator= ( const SeqGradTrapez sgt)

Assignment operator that makes this gradient pulse become a copy of 'sgt'

§ set_constgrad_duration()

SeqGradTrapez& SeqGradTrapez::set_constgrad_duration ( double  duration)

Sets the duration of the constant part of the gradient pulse

§ set_integral()

SeqGradTrapez& SeqGradTrapez::set_integral ( float  gradintegral)

Sets the overall integral of the gradient pulse


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