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

#include <seqgradchan.h>

Inheritance diagram for SeqGradChan:

[legend]Collaboration diagram for SeqGradChan:

[legend]List of all members.

Public Member Functions
	SeqGradChan (const STD_string &object_label, channelNo gradchannel, float gradstrength, double gradduration)
	SeqGradChan (const STD_string &object_label="unnamedSeqGradChan")
	SeqGradChan (const SeqGradChan &sgc)
virtual	~SeqGradChan ()
SeqGradChan &	operator= (const SeqGradChan &sgc)
virtual channelNo	get_channel () const
virtual int	get_wavesize () const
virtual void	resize (unsigned int newsize)
SeqGradInterface &	set_strength (float gradstrength)
SeqGradInterface &	invert_strength ()
float	get_strength () const
double	get_gradduration () const
SeqGradInterface &	set_gradrotmatrix (const RotMatrix &matrix)
fvector	get_gradintegral () const
STD_string	get_properties () const
unsigned int	event (eventContext &context) const
Protected Member Functions
float	get_grdfactor (channelNo chan) const
fvector	get_grdfactors_norot () const
Protected Attributes
SeqDriverInterface< SeqGradChanDriver >	graddriver
Friends
class	SeqGradChanList
class	SeqGradChanParallel

---

Detailed Description

This is the base class for all objects that represent a single gradient object

Definition at line 84 of file seqgradchan.h.

---

Constructor & Destructor Documentation

SeqGradChan::SeqGradChan	(	const STD_string &	object_label,
		channelNo	gradchannel,
		float	gradstrength,
		double	gradduration
	)

Constructs a gradient channel object labeled 'object_label' with the following properties:

• gradchannel: The channel this object should be played out
• gradstrength: The gradient strength for this object
• gradduration: The duration of this gradient object

SeqGradChan::SeqGradChan

(

const STD_string &

object_label = "unnamedSeqGradChan"

)

Construct an empty gradient channel object with the given label

SeqGradChan::SeqGradChan

(

const SeqGradChan &

sgc

)

Constructs a copy of 'sgc'

virtual SeqGradChan::~SeqGradChan

(

)

[inline, virtual]

Destructor

Definition at line 109 of file seqgradchan.h.

---

Member Function Documentation

SeqGradChan& SeqGradChan::operator=

(

const SeqGradChan &

sgc

)

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

virtual channelNo SeqGradChan::get_channel

(

)

const [virtual]

Returns the occupied channel

virtual int SeqGradChan::get_wavesize

(

)

const [inline, virtual]

Overload this function to return the size of the used waveform, if any

Definition at line 125 of file seqgradchan.h.

virtual void SeqGradChan::resize

(

unsigned int

newsize

)

[inline, virtual]

Overload this function to resize the current waveform, if any

Definition at line 130 of file seqgradchan.h.

SeqGradInterface& SeqGradChan::set_strength

(

float

gradstrength

)

[virtual]

Changes the strength of the gradient object

Implements SeqGradInterface.

Reimplemented in SeqGradRamp.

SeqGradInterface& SeqGradChan::invert_strength

(

)

[virtual]

Changes the polarity of the gradient, i.e. inverts the sign of the gradient strength

Implements SeqGradInterface.

float SeqGradChan::get_strength

(

)

const [virtual]

Returns the strength of the gradient object

Implements SeqGradInterface.

Reimplemented in SeqGradDelay.

double SeqGradChan::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.

Implements SeqGradInterface.

Definition at line 139 of file seqgradchan.h.

SeqGradInterface& SeqGradChan::set_gradrotmatrix

(

const RotMatrix &

matrix

)

[virtual]

This function can be used to specify a rotation of the gradient object in the spatial domain, the rotation will be applied to this object only rather than to the whole sequence.

Implements SeqGradInterface.

fvector SeqGradChan::get_gradintegral

(

)

const [virtual]

Returns the integral vector of the gradient course

Implements SeqGradInterface.

STD_string SeqGradChan::get_properties

(

)

const [virtual]

Returns a string describing the object

Reimplemented from SeqTreeObj.

unsigned int SeqGradChan::event

(

eventContext &

context

)

const [virtual]

Queries the sequence tree for events, returns the number of events executed

Reimplemented from SeqTreeObj.

float SeqGradChan::get_grdfactor

(

channelNo

chan

)

const [protected]

returns element [channel][chan] val. from the current rot. Matrix

fvector SeqGradChan::get_grdfactors_norot

(

)

const [protected]

returns element [channel][chan] val. from the current rot. Matrix without considering the rotation matrix of the current event block (for IDEA)

---

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

• seqgradchan.h

---