Public Member Functions | List of all members
SeqGradConstPulse Class Reference

Constant gradient pulse. More...

#include <seqgradpulse.h>

Inheritance diagram for SeqGradConstPulse:
Inheritance graph
[legend]

Public Member Functions

 SeqGradConstPulse (const STD_string &object_label, direction gradchannel, float gradstrength, float gradduration)
 
 SeqGradConstPulse (const SeqGradConstPulse &sgcp)
 
 SeqGradConstPulse (const STD_string &object_label="unnamedSeqGradConstPulse")
 
SeqGradConstPulseoperator= (const SeqGradConstPulse &sgcp)
 
SeqGradConstPulseset_constduration (float duration)
 
double get_constduration () 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
 

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

Constant gradient pulse.

This class represents a gradient pulse with a constant gradient field

Definition at line 41 of file seqgradpulse.h.

Constructor & Destructor Documentation

§ SeqGradConstPulse() [1/3]

SeqGradConstPulse::SeqGradConstPulse ( const STD_string &  object_label,
direction  gradchannel,
float  gradstrength,
float  gradduration 
)

Constructs a constant gradient pulse 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

§ SeqGradConstPulse() [2/3]

SeqGradConstPulse::SeqGradConstPulse ( const SeqGradConstPulse sgcp)

Constructs a copy of 'sgcp'

§ SeqGradConstPulse() [3/3]

SeqGradConstPulse::SeqGradConstPulse ( const STD_string &  object_label = "unnamedSeqGradConstPulse")

Construct an empty constant gradient pulse with the given label

Member Function Documentation

§ get_constduration()

double SeqGradConstPulse::get_constduration ( ) const
inline

getting duration of the constant part

Definition at line 78 of file seqgradpulse.h.

§ operator=()

SeqGradConstPulse& SeqGradConstPulse::operator= ( const SeqGradConstPulse sgcp)

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

§ set_constduration()

SeqGradConstPulse& SeqGradConstPulse::set_constduration ( float  duration)
inline

setting duration of the constant part

Definition at line 72 of file seqgradpulse.h.

§ set_strength()

SeqGradInterface& SeqGradConstPulse::set_strength ( float  gradstrength)
virtual

Changes the strength of the gradient object

Reimplemented from SeqGradChanList.


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