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

Pulsar pulses, combines OdinPulse and SeqPulsNdim. More...

#include <seqpulsar.h>

Inheritance diagram for SeqPulsar:

Inheritance graph
[legend]
Collaboration diagram for SeqPulsar:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SeqPulsar (const STD_string &object_label, const STD_string &pulsarfile, bool rephased=false, const dvector &phaselist=0, const dvector &freqlist=0, float grad_shift_offset=0.0, bool interactive=true)
 SeqPulsar (const STD_string &object_label="unnamedSeqPulsar")
 SeqPulsar (const SeqPulsar &sp)
 ~SeqPulsar ()
SeqPulsarset_rephased (bool rephased)
bool get_rephased () const
fvector get_reph_gradintegral () const
SeqPulsaroperator= (const SeqPulsar &sp)
SeqPulsarrefresh ()
SeqPulsarset_interactive (bool flag)
int get_dims () const
SeqFreqChanInterfaceset_nucleus (const STD_string &nucleus)
float get_flipangle () const
SeqPulsInterfaceset_flipangle (float flipangle)
SeqPulsInterfaceset_pulsduration (float pulsduration)
SeqPulsInterfaceset_attenuation (float pulspower)
SeqPulsInterfaceset_pulse_type (pulseType type)
pulseType get_pulse_type () const
STD_string get_properties () const
bool operator== (const SeqPulsar &sp) const
bool operator< (const SeqPulsar &sp) const
bool operator!= (const SeqPulsar &sp) const

Friends

class SeqPulsarReph
class SeqMethod
class SeqMethodProxy

Detailed Description

Pulsar pulses, combines OdinPulse and SeqPulsNdim.

This class is an interface to the Pulsar program; It is possible to access most of the parameters of the underlying data structure 'OdinPulse' via get/set functions

Definition at line 46 of file seqpulsar.h.


Constructor & Destructor Documentation

SeqPulsar::SeqPulsar ( const STD_string &  object_label,
const STD_string &  pulsarfile,
bool  rephased = false,
const dvector phaselist = 0,
const dvector freqlist = 0,
float  grad_shift_offset = 0.0,
bool  interactive = true 
)

Constructs a pulse labeled 'object_label' that was generated with the Pulsar program and saved into 'pulsarfile'. In addition, the following properties can be specified:

SeqPulsar::SeqPulsar ( const STD_string &  object_label = "unnamedSeqPulsar"  ) 

Constructs an empty Pulsar pulse with the given label.

SeqPulsar::SeqPulsar ( const SeqPulsar sp  ) 

Constructs a Pulsar pulse which is a copy of 'sp'

SeqPulsar::~SeqPulsar (  ) 

Destructor


Member Function Documentation

SeqPulsar& SeqPulsar::set_rephased ( bool  rephased  ) 

Specifies whether an additional gradient rephasing lobe will be added to rephase the magnetisation in case of an excitation pulse.

bool SeqPulsar::get_rephased (  )  const [inline]

Returns whether an additional gradient rephasing lobe will be added to rephase the magnetisation in case of an excitation pulse.

Definition at line 94 of file seqpulsar.h.

fvector SeqPulsar::get_reph_gradintegral (  )  const

Returns the rephasers integral on all three channels

SeqPulsar& SeqPulsar::operator= ( const SeqPulsar sp  ) 

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

SeqPulsar& SeqPulsar::refresh (  ) 

Recalculates the pulse manually, this is only required if the pulse is not interactive

SeqPulsar& SeqPulsar::set_interactive ( bool  flag  ) 

If this flag is set to true, the pulse will be recalculated each time a parameter is changed, otherwise it must be done manually via the refresh() function

int SeqPulsar::get_dims (  )  const [virtual]

Dimensionality of the pulse

Reimplemented from SeqPulsNdim.

SeqFreqChanInterface& SeqPulsar::set_nucleus ( const STD_string &  nucleus  ) 

Sets the nucleus for the pulse

Reimplemented from OdinPulse.

float SeqPulsar::get_flipangle (  )  const [inline]

Returns the flip angle

Reimplemented from OdinPulse.

Definition at line 125 of file seqpulsar.h.

SeqPulsInterface& SeqPulsar::set_flipangle ( float  flipangle  )  [virtual]

Sets the flip angle of the pulse

Reimplemented from SeqPulsInterface.

SeqPulsInterface& SeqPulsar::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 SeqPulsNdim.

SeqPulsInterface& SeqPulsar::set_attenuation ( float  pulspower  )  [virtual]

Sets the pulse attenuation (Bruker)

Reimplemented from SeqPulsInterface.

SeqPulsInterface& SeqPulsar::set_pulse_type ( pulseType  type  ) 

Sets the type of the pulse, this is necessary for calculating the pulse gain of adiabatic pulses and optimization of pulses.

Reimplemented from OdinPulse.

pulseType SeqPulsar::get_pulse_type (  )  const [inline]

Returns the type of the pulse

Reimplemented from OdinPulse.

Definition at line 130 of file seqpulsar.h.

STD_string SeqPulsar::get_properties (  )  const [virtual]

Returns a string describing the object

Reimplemented from SeqParallel.


The documentation for this class was generated from the following file:
Generated on Sat Jun 14 12:32:38 2008 by  doxygen 1.5.1