Public Member Functions | Friends | List of all members
SeqGradVectorPulse Class Reference

Vector of gradient pulses. More...

#include <seqgradpulse.h>

Inheritance diagram for SeqGradVectorPulse:
Inheritance graph
[legend]

Public Member Functions

 SeqGradVectorPulse (const STD_string &object_label, direction gradchannel, float maxgradstrength, const fvector &trimarray, float gradduration)
 
 SeqGradVectorPulse (const SeqGradVectorPulse &sgvp)
 
 SeqGradVectorPulse (const STD_string &object_label="unnamedSeqGradVectorPulse")
 
SeqGradVectorPulseoperator= (const SeqGradVectorPulse &sgvp)
 
SeqGradVectorPulseset_trims (const fvector &trims)
 
fvector get_trims () const
 
SeqGradVectorPulseset_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)
 
SeqGradVectorPulseset_encoding_scheme (encodingScheme scheme)
 
const SeqVectorget_reorder_vector () const
 
SeqGradVectorPulseset_constduration (float duration)
 
double get_constduration () const
 
 operator const SeqVector & () const
 
SeqGradInterfaceset_strength (float gradstrength)
 
- Public Member Functions inherited from SeqGradChanList
 SeqGradChanList (const STD_string &object_label="unnamedSeqGradChanList")
 
 SeqGradChanList (const SeqGradChanList &sgcl)
 
 ~SeqGradChanList ()
 
SeqGradChanListoperator= (const SeqGradChanList &sgcl)
 
double get_duration () const
 
STD_string get_properties () const
 
unsigned int event (eventContext &context) const
 
void query (queryContext &context) const
 
SeqGradInterfaceinvert_strength ()
 
float get_strength () const
 
fvector get_gradintegral () const
 
double get_gradduration () const
 
SeqGradInterfaceset_gradrotmatrix (const RotMatrix &matrix)
 
direction get_channel () const
 
SeqGradChanListoperator+= (SeqGradChanList &sgcl)
 
SeqGradChanListoperator+= (SeqGradChan &sgc)
 
- Public Member Functions inherited from List< SeqGradChan, SeqGradChan *, SeqGradChan &>
 List ()
 
 ~List ()
 
Listoperator= (const List &l)
 
Listclear ()
 
Listappend (SeqGradChan & item)
 
Listremove (SeqGradChan & item)
 
unsigned int size () const
 
iter get_begin ()
 
iter get_end ()
 
constiter get_const_begin () const
 
constiter get_const_end () const
 
- Public Member Functions inherited from SeqGradInterface
float get_gradintegral_norm () const
 
- Public Member Functions inherited from SeqClass
SeqClassset_temporary ()
 
- Public Member Functions inherited from Labeled
 Labeled (const STD_string &label="unnamed")
 
Labeledset_label (const STD_string &label)
 
const STD_string & get_label () const
 
Labeledoperator= (const Labeled &l)
 
- Public Member Functions inherited from SeqTreeObj
virtual STD_string get_program (programContext &context) const
 
virtual RecoValList get_recovallist (unsigned int reptimes, LDRkSpaceCoords &coords) const
 
bool contains (const SeqTreeObj *sto) const
 
void tree (SeqTreeCallbackAbstract *display) const
 
virtual SeqValList get_freqvallist (freqlistAction action) const
 
virtual SeqValList get_delayvallist () const
 
virtual double get_rf_energy () const
 

Friends

class SeqGradPhaseEnc
 
class SeqGradEcho
 

Additional Inherited Members

- Public Types inherited from List< SeqGradChan, SeqGradChan *, SeqGradChan &>
typedef STD_list< SeqGradChan * >::iterator iter
 
typedef STD_list< SeqGradChan * >::const_iterator constiter
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Vector of gradient pulses.

This class represents a gradient pulse with a constant gradient shape with the the strength taken from a vector. This object can be attached to a SeqLoop to iterate over the values in the vector.

Definition at line 103 of file seqgradpulse.h.

Constructor & Destructor Documentation

§ SeqGradVectorPulse() [1/3]

SeqGradVectorPulse::SeqGradVectorPulse ( const STD_string &  object_label,
direction  gradchannel,
float  maxgradstrength,
const fvector trimarray,
float  gradduration 
)

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

  • gradchannel: The channel this object should be played out
  • maxgradstrength: The maximum gradient strength for this object
  • trimarray: The vector of gradient strength values
  • gradduration: The duration of this gradient object

§ SeqGradVectorPulse() [2/3]

SeqGradVectorPulse::SeqGradVectorPulse ( const SeqGradVectorPulse sgvp)

Constructs a copy of 'sgvp'

§ SeqGradVectorPulse() [3/3]

SeqGradVectorPulse::SeqGradVectorPulse ( const STD_string &  object_label = "unnamedSeqGradVectorPulse")

Construct an empty gradient pulse with the given label

Member Function Documentation

§ get_constduration()

double SeqGradVectorPulse::get_constduration ( ) const
inline

getting duration of the gradient vector part

Definition at line 166 of file seqgradpulse.h.

§ get_reorder_vector()

const SeqVector& SeqGradVectorPulse::get_reorder_vector ( ) const
inline

Returns the reordering vector (for loop insertion)

Definition at line 156 of file seqgradpulse.h.

§ get_trims()

fvector SeqGradVectorPulse::get_trims ( ) const
inline

Returns the trim values that will be used

Definition at line 140 of file seqgradpulse.h.

§ operator const SeqVector &()

SeqGradVectorPulse::operator const SeqVector & ( ) const
inline

conversion operator for loop insertion

Definition at line 171 of file seqgradpulse.h.

§ operator=()

SeqGradVectorPulse& SeqGradVectorPulse::operator= ( const SeqGradVectorPulse sgvp)

Assignment operator that makes this constant gradient pulse object become a copy of 'sgvp'

§ set_constduration()

SeqGradVectorPulse& SeqGradVectorPulse::set_constduration ( float  duration)
inline

setting duration of the gradient vector part

Definition at line 161 of file seqgradpulse.h.

§ set_encoding_scheme()

SeqGradVectorPulse& SeqGradVectorPulse::set_encoding_scheme ( encodingScheme  scheme)
inline

Sets the phase encoding scheme and the number of phase encoding steps

Definition at line 151 of file seqgradpulse.h.

§ set_reorder_scheme()

SeqGradVectorPulse& SeqGradVectorPulse::set_reorder_scheme ( reorderScheme  scheme,
unsigned int  nsegments = 1 
)
inline

Sets the reordering scheme and the number of segments

Definition at line 145 of file seqgradpulse.h.

§ set_strength()

SeqGradInterface& SeqGradVectorPulse::set_strength ( float  gradstrength)
virtual

Changes the strength of the gradient object

Reimplemented from SeqGradChanList.

§ set_trims()

SeqGradVectorPulse& SeqGradVectorPulse::set_trims ( const fvector trims)
inline

Specifies the trim values that will be used

Definition at line 135 of file seqgradpulse.h.


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