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

Pinwheel pulse. More...

#include <seqpulsar.h>

Inheritance diagram for SeqPulsarPinWheel:

[legend]Collaboration diagram for SeqPulsarPinWheel:

[legend]List of all members.

Public Member Functions
	SeqPulsarPinWheel (const STD_string &object_label, const STD_string &pulsarfile="", const STD_string &exppulsarfile="", float grad_shift_offset=0.0, const STD_string &shape="Disk(20.0)", const STD_string &trajectory="ConstSpiral(2)", float duration=2.0, unsigned int npoints=256, float resolution=0.0, float flipangle=60.0, float freq_offset=0.0)
	SeqPulsarPinWheel (const STD_string &object_label="unnamedSeqPulsarPinWheel")
	SeqPulsarPinWheel (const SeqPulsarPinWheel &sppw)
SeqPulsarPinWheel &	operator= (const SeqPulsarPinWheel &sppw)
SeqPulsar &	get_segment_pulse (unsigned int index)
unsigned int	get_nsegments () const
SeqPulsarPinWheel &	simulate_segment (SeqSimMagsi &magn, const Sample &sample, unsigned int index)
SeqPulsarPinWheel &	simulate_sum (SeqSimMagsi &magn, SeqSimMagsi &magn_sum, const Sample &sample)
SeqPulsarPinWheel &	set_nucleus (const STD_string &nucleus)
double	get_pulsduration () const
SeqPulsarPinWheel &	set_pulsduration (float pulsduration)
SeqPulsarPinWheel &	set_freqoffset (float freqoffset)
SeqPulsarPinWheel &	set_freqlist (const dvector &freqlist)
const SeqVector &	get_freqlist_vector () const
SeqPulsarPinWheel &	set_grad_shift_offset (float grad_shift_offset)
float	get_magnetic_center () const
STD_string	get_trajectory_parameter (const STD_string &parameter_label) const
SeqPulsarPinWheel &	set_trajectory_parameter (const STD_string &parameter_label, const STD_string &value)
double	get_spatial_offset (channelNo direction) const
SeqPulsarPinWheel &	set_spatial_offset (channelNo direction, double offset)
SeqPulsarPinWheel &	use_min_spat_resolution (bool flag)
bool	get_consider_system_cond () const
SeqPulsarPinWheel &	set_consider_Nyquist_cond (bool flag)
double	get_spat_resolution () const
SeqPulsarPinWheel &	set_spat_resolution (double sigma)
STD_string	get_shape () const
STD_string	get_shape_parameter (const STD_string &parameter_label)
double	get_flipangle () const
int	load (const STD_string &filename)
int	write (const STD_string &filename) const
SeqPulsarPinWheel &	refresh ()

---

Detailed Description

Pinwheel pulse.

A 2D pinwheel shaped pulse with additional capability to simulate the profile of the pulse

Definition at line 360 of file seqpulsar.h.

---

Constructor & Destructor Documentation

SeqPulsarPinWheel::SeqPulsarPinWheel	(	const STD_string &	object_label,
		const STD_string &	pulsarfile = "",
		const STD_string &	exppulsarfile = "",
		float	grad_shift_offset = 0.0,
		const STD_string &	shape = "Disk(20.0)",
		const STD_string &	trajectory = "ConstSpiral(2)",
		float	duration = 2.0,
		unsigned int	npoints = 256,
		float	resolution = 0.0,
		float	flipangle = 60.0,
		float	freq_offset = 0.0
	)

Constructs a 2D pinwheel pulse labeled 'object_label' that was generated with the Pulsar program and saved into 'pulsarfile'. can be load from pulsarfile and saved into 'exppulsarfile' with the following properties:

• shape: The twodimensional shape to excite (Disk,square-Box..) and the shape 's size (disk:diameter, box: edg e lengths)
• trajectory: The k-space trajectory of the pulse [Type(NumberOfCycles, numberOfSegments, currentSegment..)]
• duration: The pulse duration
• npoints: The number of digitised points for the pulse
• resolution: The spatial resolution, i.e. the scale on which the excitation profile is smoothed
• flipangle: The flip angle
• freq_offset: The (transmitter) frequency offset of the pulse

SeqPulsarPinWheel::SeqPulsarPinWheel

(

const STD_string &

object_label = "unnamedSeqPulsarPinWheel"

)

Constructs a standard 2D pinwheel pulse

SeqPulsarPinWheel::SeqPulsarPinWheel

(

const SeqPulsarPinWheel &

sppw

)

Constructs a copy of 'sppw'

---

Member Function Documentation

SeqPulsarPinWheel& SeqPulsarPinWheel::operator=

(

const SeqPulsarPinWheel &

sppw

)

Assignment operator that makes this object become a copy of 'sppw'

SeqPulsar& SeqPulsarPinWheel::get_segment_pulse

(

unsigned int

index

)

Returns the i.te segment of the pulse when constructing the sequence

unsigned int SeqPulsarPinWheel::get_nsegments

(

)

const

Returns the number of Segments (excitation k-space segmentation)

SeqPulsarPinWheel& SeqPulsarPinWheel::simulate_segment	(	SeqSimMagsi &	magn,
		const Sample &	sample,
		unsigned int	index
	)

Simulates the magnetization profile of segment index

SeqPulsarPinWheel& SeqPulsarPinWheel::simulate_sum	(	SeqSimMagsi &	magn,
		SeqSimMagsi &	magn_sum,
		const Sample &	sample
	)

Simulates the magnetization profile of the sum of the segments

SeqPulsarPinWheel& SeqPulsarPinWheel::set_nucleus

(

const STD_string &

nucleus

)

[inline]

Sets the frequency at which the pulse will be played out to the resonance frequency of the specified nucleus reimplemented, virtual function from SeqFreqChanInterface

Definition at line 424 of file seqpulsar.h.

double SeqPulsarPinWheel::get_pulsduration

(

)

const [inline]

Returns the pulse duration of the pulse

Definition at line 433 of file seqpulsar.h.

SeqPulsarPinWheel& SeqPulsarPinWheel::set_pulsduration

(

float

pulsduration

)

[inline]

Sets the pulse duration of the pulse

Definition at line 440 of file seqpulsar.h.

SeqPulsarPinWheel& SeqPulsarPinWheel::set_freqoffset

(

float

freqoffset

)

[inline]

Sets the frequency offset of the pulse

Definition at line 450 of file seqpulsar.h.

const SeqVector& SeqPulsarPinWheel::get_freqlist_vector

(

)

const [inline]

Returns the frequency offsets of the pulses

Definition at line 465 of file seqpulsar.h.

SeqPulsarPinWheel& SeqPulsarPinWheel::set_grad_shift_offset

(

float

grad_shift_offset

)

[inline]

Sets an additional delay between the beginning of the pulse and the gradients See base class SeqPulsNdim

Definition at line 473 of file seqpulsar.h.

float SeqPulsarPinWheel::get_magnetic_center

(

)

const [inline]

Returns the absolute magnetic_center of the pulse See class OdinPulse

Definition at line 483 of file seqpulsar.h.

STD_string SeqPulsarPinWheel::get_trajectory_parameter

(

const STD_string &

parameter_label

)

const [inline]

Returns the value of the pulse trajectory parameter which has the given label See class OdinPulse

Definition at line 489 of file seqpulsar.h.

SeqPulsarPinWheel& SeqPulsarPinWheel::set_trajectory_parameter	(	const STD_string &	parameter_label,
		const STD_string &	value
	)			[inline]

Sets the value of the pulse trajectory parameter which has the label 'parameter_label' to 'value' See class OdinPulse

Definition at line 497 of file seqpulsar.h.

double SeqPulsarPinWheel::get_spatial_offset

(

channelNo

direction

)

const [inline]

Returns the spatial offset in the given direction

Definition at line 506 of file seqpulsar.h.

SeqPulsarPinWheel& SeqPulsarPinWheel::set_spatial_offset	(	channelNo	direction,
		double	offset
	)			[inline]

Sets the spatial offset in the given direction

Definition at line 513 of file seqpulsar.h.

SeqPulsarPinWheel& SeqPulsarPinWheel::use_min_spat_resolution

(

bool

flag

)

[inline]

Sets whether minimum spatial resolution is used.

Definition at line 522 of file seqpulsar.h.

bool SeqPulsarPinWheel::get_consider_system_cond

(

)

const [inline]

Returns whether to consider maximum gradient strength and slew-rate while calculating the trajectory.

Definition at line 531 of file seqpulsar.h.

SeqPulsarPinWheel& SeqPulsarPinWheel::set_consider_Nyquist_cond

(

bool

flag

)

[inline]

Specifies whether to consider maximum gradient strength and slew-rate while calculating the trajectory.

Definition at line 538 of file seqpulsar.h.

double SeqPulsarPinWheel::get_spat_resolution

(

)

const [inline]

Returns the spatial resolution

Definition at line 548 of file seqpulsar.h.

SeqPulsarPinWheel& SeqPulsarPinWheel::set_spat_resolution

(

double

sigma

)

[inline]

Sets the spatial resolution

Definition at line 555 of file seqpulsar.h.

STD_string SeqPulsarPinWheel::get_shape

(

)

const [inline]

Returns the label of the current pulse shape See class OdinPulse

Definition at line 565 of file seqpulsar.h.

STD_string SeqPulsarPinWheel::get_shape_parameter

(

const STD_string &

parameter_label

)

[inline]

Returns the value of the pulse shape parameter which has the given label See class OdinPulse

Definition at line 573 of file seqpulsar.h.

double SeqPulsarPinWheel::get_flipangle

(

)

const [inline]

Returns the flip angle

Definition at line 580 of file seqpulsar.h.

int SeqPulsarPinWheel::load

(

const STD_string &

filename

)

[inline]

Loads the pulse parameter(s) from a JCAMP-DX file

Definition at line 587 of file seqpulsar.h.

int SeqPulsarPinWheel::write

(

const STD_string &

filename

)

const [inline]

Writes the pulse parameter(s) to a JCAMP-DX file

Definition at line 596 of file seqpulsar.h.

SeqPulsarPinWheel& SeqPulsarPinWheel::refresh

(

)

Recalculates the pulse See class SeqPulsar

---

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

• seqpulsar.h

---