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

Gradient Ramp. More...

#include <seqgradramp.h>

Inheritance diagram for SeqGradRamp:

[legend]

List of all members.

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")
SeqGradRamp &	set_ramp (float initgradstrength, float finalgradstrength, double timestep, rampType type=linear, float steepnessfactor=1.0, bool reverse=false)
SeqGradRamp &	set_ramp (double gradduration, float initgradstrength, float finalgradstrength, double timestep, rampType type=linear, bool reverse=false)
rampType	get_ramptype () const
SeqGradRamp &	operator= (const SeqGradRamp &sgr)
SeqGradInterface &	set_strength (float gradstrength)

---

Detailed Description

Gradient Ramp.

This class represents a digitized gradient ramp.

Definition at line 52 of file seqgradramp.h.

---

Constructor & Destructor Documentation

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::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::SeqGradRamp

(

const SeqGradRamp &

sgr

)

Constructs a copy of 'sgr'

SeqGradRamp::SeqGradRamp

(

const STD_string &

object_label = "unnamedSeqGradRamp"

)

Construct an empty gradient object with the given label

---

Member Function Documentation

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)

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)

rampType SeqGradRamp::get_ramptype

(

)

const [inline]

Returns the shape for the ramp

Definition at line 127 of file seqgradramp.h.

SeqGradRamp& SeqGradRamp::operator=

(

const SeqGradRamp &

sgr

)

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

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:

• seqgradramp.h