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

Trapezoidal gradient. More...

#include <seqgradtrapez.h>

Inheritance diagram for SeqGradTrapez:

[legend]Collaboration diagram for SeqGradTrapez:

[legend]List of all members.

Public Member Functions
	SeqGradTrapez (const STD_string &object_label, channelNo 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, channelNo 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, channelNo 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")
SeqGradTrapez &	operator= (const SeqGradTrapez &sgt)
double	get_gradpulse_center () const
SeqGradTrapez &	set_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
SeqGradTrapez &	set_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
SeqGradTrapez &	exclude_offramp_from_timing (bool flag)
float	get_strength () const
double	get_gradduration () const

---

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 127 of file seqgradtrapez.h.

---

Constructor & Destructor Documentation

SeqGradTrapez::SeqGradTrapez	(	const STD_string &	object_label,
		channelNo	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::SeqGradTrapez	(	const STD_string &	object_label,
		float	gradintegral,
		channelNo	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::SeqGradTrapez	(	const STD_string &	object_label,
		float	gradintegral,
		float	gradstrength,
		channelNo	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::SeqGradTrapez

(

const SeqGradTrapez &

sgt

)

Constructs a copy of 'sgt'

SeqGradTrapez::SeqGradTrapez

(

const STD_string &

object_label = "unnamedSeqGradTrapez"

)

Construct an empty gradient pulse with the given label

---

Member Function Documentation

SeqGradTrapez& SeqGradTrapez::operator=

(

const SeqGradTrapez &

sgt

)

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

double SeqGradTrapez::get_gradpulse_center

(

)

const

Returns the time interval from the beginning of the gradient pulse to the center of the constant gradient part

SeqGradTrapez& SeqGradTrapez::set_constgrad_duration

(

double

duration

)

Sets the duration of the constant part of the gradient pulse

double SeqGradTrapez::get_onramp_duration

(

)

const [inline]

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

Definition at line 211 of file seqgradtrapez.h.

double SeqGradTrapez::get_constgrad_duration

(

)

const [inline]

Returns the duration of the constant part of the gradient pulse

Definition at line 217 of file seqgradtrapez.h.

double SeqGradTrapez::get_offramp_duration

(

)

const [inline]

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

Definition at line 223 of file seqgradtrapez.h.

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 229 of file seqgradtrapez.h.

float SeqGradTrapez::get_onramp_integral

(

)

const [inline]

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

Definition at line 234 of file seqgradtrapez.h.

float SeqGradTrapez::get_constgrad_integral

(

)

const [inline]

Returns the integral of the constant part

Definition at line 239 of file seqgradtrapez.h.

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 244 of file seqgradtrapez.h.

float SeqGradTrapez::get_offramp_integral

(

)

const [inline]

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

Definition at line 249 of file seqgradtrapez.h.

SeqGradTrapez& SeqGradTrapez::set_integral

(

float

gradintegral

)

Sets the overall integral of the gradient pulse

float SeqGradTrapez::get_integral

(

)

const

Returns the overall integral of the gradient pulse

unsigned int SeqGradTrapez::get_onramp_npts

(

)

const

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

unsigned int SeqGradTrapez::get_const_npts

(

)

const

Returns the number of digitised points during the constant part

unsigned int SeqGradTrapez::get_offramp_npts

(

)

const

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

unsigned int SeqGradTrapez::get_npts

(

)

const

Returns the total number of digitised points

fvector SeqGradTrapez::get_onramp

(

)

const [inline]

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

Definition at line 285 of file seqgradtrapez.h.

fvector SeqGradTrapez::get_offramp

(

)

const [inline]

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

Definition at line 290 of file seqgradtrapez.h.

fvector SeqGradTrapez::get_trapezshape

(

)

const

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

double SeqGradTrapez::get_timestep

(

)

const [inline]

Returns the time resolution for the ramps

Definition at line 300 of file seqgradtrapez.h.

rampType SeqGradTrapez::get_ramptype

(

)

const [inline]

Returns the shape type of the ramps

Definition at line 305 of file seqgradtrapez.h.

SeqGradTrapez& SeqGradTrapez::exclude_offramp_from_timing

(

bool

flag

)

Spefifies whether to exclude the off-ramp from timing calculations

float SeqGradTrapez::get_strength

(

)

const [inline, virtual]

Returns the strength of the gradient object

Reimplemented from SeqGradChanList.

Definition at line 314 of file seqgradtrapez.h.

double SeqGradTrapez::get_gradduration

(

)

const [inline, virtual]

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 315 of file seqgradtrapez.h.

---

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

• seqgradtrapez.h

---