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

RF pulse. More...

#include <seqpuls.h>

Inheritance diagram for SeqPuls:

[legend]Collaboration diagram for SeqPuls:

[legend]List of all members.

Public Member Functions
	SeqPuls (const STD_string &object_label, const cvector &waveform, float pulsduration, float pulspower, const STD_string &nucleus="", const dvector &phaselist=0, const dvector &freqlist=0, float rel_magnetic_center=0.5)
	SeqPuls (const STD_string &object_label="unnamedSeqPuls")
	SeqPuls (const SeqPuls &sp)
SeqPuls &	operator= (const SeqPuls &sp)
SeqPuls &	set_wave (const cvector &waveform)
cvector	get_wave () const
double	get_pulsstart () const
SeqPulsInterface &	set_pulsduration (float pulsduration)
double	get_pulsduration () const
float	get_flipangle () const
SeqPulsInterface &	set_flipangle (float flipangle)
float	get_attenuation () const
SeqPulsInterface &	set_attenuation (float pulspower)
float	get_power () const
SeqPulsInterface &	set_rel_magnetic_center (float center)
float	get_magnetic_center () const
SeqPulsInterface &	set_pulse_type (pulseType type)
pulseType	get_pulse_type () const
const SeqVector &	get_flipangle_vector () const
void	set_flipscales (const fvector &flipscales)
fvector	get_flipscales () const
SeqPulsInterface &	set_flipangle_reorder_scheme (reorderScheme scheme, unsigned int nsegments)
const SeqVector &	get_flipangle_reorder_vector () const
double	get_duration () const
STD_string	get_program (programContext &context) const
double	get_rf_energy () const
STD_string	get_properties () const
unsigned int	event (eventContext &context) const
float	get_B1max () const
Friends
class	SeqFlipAngVector

---

Detailed Description

RF pulse.

This class represents a shaped RF-pulse with a complex waveform

Definition at line 257 of file seqpuls.h.

---

Constructor & Destructor Documentation

SeqPuls::SeqPuls	(	const STD_string &	object_label,
		const cvector &	waveform,
		float	pulsduration,
		float	pulspower,
		const STD_string &	nucleus = "",
		const dvector &	phaselist = 0,
		const dvector &	freqlist = 0,
		float	rel_magnetic_center = 0.5
	)

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

• wave: The complex waveform that will be played out
• pulsduration: The duration of the pulse
• pulspower: The power of the pulse in dB
• nucleus: This parameter determines the frequency at which the pulse will be played out to be the resonance frequency of the specified nucleus
• phaselist: This is an array of phases at which the acquired pulse will be modulated. Use the get_phaselist_vector() function to attach it to a loop.
• freqlist: This is an array of frequency offsets at which the pulse waveform will be modulated.
• rel_magnetic_center: This parameter specifies the point in time that will be used as the center of the pulse for timing calculations, e.g. for a spin-echo

SeqPuls::SeqPuls

(

const STD_string &

object_label = "unnamedSeqPuls"

)

Constructs an empty pulse with the given label.

SeqPuls::SeqPuls

(

const SeqPuls &

sp

)

Constructs a pulse which is a copy of 'sp'

---

Member Function Documentation

SeqPuls& SeqPuls::operator=

(

const SeqPuls &

sp

)

This assignment operator will make this pulse become an exact copy of 'sp'.

SeqPuls& SeqPuls::set_wave

(

const cvector &

waveform

)

Sets the complex waveform of the pulse

cvector SeqPuls::get_wave

(

)

const [inline]

Returns the complex RF waveform

Definition at line 305 of file seqpuls.h.

double SeqPuls::get_pulsstart

(

)

const [inline]

Returns the time offset within this object where the RF starts

Definition at line 310 of file seqpuls.h.

SeqPulsInterface& SeqPuls::set_pulsduration

(

float

pulsduration

)

[virtual]

Sets the duration of the pulse. In case of a more complex pulse that needs some extra commands before and after the actual pulse will be played out, this function still sets the effective duration, i.e. when the RF-field is non-zero

Reimplemented from SeqPulsInterface.

double SeqPuls::get_pulsduration

(

)

const [virtual]

Returns the duration of the pulse. In case of a more complex pulse that needs some extra commands before and after the actual pulse will be played out, this function still returns the effective duration, i.e. when the RF-field is applied

Reimplemented from SeqPulsInterface.

float SeqPuls::get_flipangle

(

)

const [inline, virtual]

Returns the flip angle of the pulse

Reimplemented from SeqPulsInterface.

Definition at line 316 of file seqpuls.h.

SeqPulsInterface& SeqPuls::set_flipangle

(

float

flipangle

)

[inline, virtual]

Sets the flip angle of the pulse

Reimplemented from SeqPulsInterface.

Definition at line 317 of file seqpuls.h.

float SeqPuls::get_attenuation

(

)

const [virtual]

Returns the pulse attenuation (Bruker)

Reimplemented from SeqPulsInterface.

SeqPulsInterface& SeqPuls::set_attenuation

(

float

pulspower

)

[virtual]

Sets the pulse attenuation (Bruker)

Reimplemented from SeqPulsInterface.

float SeqPuls::get_power

(

)

const [virtual]

Returns the power deposition of the pulse

Reimplemented from SeqPulsInterface.

SeqPulsInterface& SeqPuls::set_rel_magnetic_center

(

float

center

)

[virtual]

Sets the relative magnetic_center

Reimplemented from SeqPulsInterface.

float SeqPuls::get_magnetic_center

(

)

const [virtual]

Returns the absolute magnetic_center

Reimplemented from SeqPulsInterface.

SeqPulsInterface& SeqPuls::set_pulse_type

(

pulseType

type

)

[virtual]

Sets the type of the pulse

Reimplemented from SeqPulsInterface.

pulseType SeqPuls::get_pulse_type

(

)

const [virtual]

Returns the type of the pulse

Reimplemented from SeqPulsInterface.

const SeqVector& SeqPuls::get_flipangle_vector

(

)

const [inline, virtual]

Returns a sequence vector to iterate over flipangles

Reimplemented from SeqPulsInterface.

Definition at line 325 of file seqpuls.h.

SeqPulsInterface& SeqPuls::set_flipangle_reorder_scheme	(	reorderScheme	scheme,
		unsigned int	nsegments
	)			[inline, virtual]

Sets the reordering scheme of the flipangle vector

Reimplemented from SeqPulsInterface.

Definition at line 328 of file seqpuls.h.

const SeqVector& SeqPuls::get_flipangle_reorder_vector

(

)

const [inline, virtual]

Returns the reorder vector for flipangles

Reimplemented from SeqPulsInterface.

Definition at line 329 of file seqpuls.h.

double SeqPuls::get_duration

(

)

const [virtual]

Returns the duration of the sequence object.

Reimplemented from SeqDur.

STD_string SeqPuls::get_program

(

programContext &

context

)

const [virtual]

Returns the part in the pulse/gradient program of this sequence object. 'context' holds data about how the program should be generated, e.g. type of program and formatting.

Reimplemented from SeqTreeObj.

double SeqPuls::get_rf_energy

(

)

const [virtual]

Returns the RF power deposition in the objects branch of the sequence tree. The physical unit is unspecified, it depends on the current platform.

Reimplemented from SeqTreeObj.

STD_string SeqPuls::get_properties

(

)

const [virtual]

Returns a string describing the object

Reimplemented from SeqTreeObj.

unsigned int SeqPuls::event

(

eventContext &

context

)

const [virtual]

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

Reimplemented from SeqTreeObj.

---

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

• seqpuls.h

---