Public Member Functions

SeqGradTrapezDriver Class Reference
[Internal Classes for sequence design (odinseq library)]

#include <seqgradtrapez.h>

Inheritance diagram for SeqGradTrapezDriver:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual bool update_driver (direction channel, double onrampdur, double constdur, double offrampdur, float strength, double timestep, rampType type, bool exclude_offramp_from_timing)=0

Detailed Description

The base class for platform specific drivers of trapezoidal gradient pulses

Definition at line 34 of file seqgradtrapez.h.


Member Function Documentation

virtual bool SeqGradTrapezDriver::update_driver ( direction  channel,
double  onrampdur,
double  constdur,
double  offrampdur,
float  strength,
double  timestep,
rampType  type,
bool  exclude_offramp_from_timing 
) [pure virtual]

Update the driver with the following properties:

  • channel: The channel (direction) of the trapez
  • onrampdur: Duration of the on-ramp
  • constdur: Duration of the flat top
  • offrampdur: Duration of the off-ramp
  • strength: Max gradient strength
  • timestep: Dwell time (gradient raster) of the ramps
  • type: The shape for the ramps
  • exclude_offramp_from_timing: Exclude the off-ramp from timing calculations

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