Public Member Functions | Protected Member Functions | Friends | List of all members

#include <seqgradchan.h>

Inheritance diagram for SeqGradChan:
Inheritance graph
[legend]

Public Member Functions

 SeqGradChan (const STD_string &object_label, direction gradchannel, float gradstrength, double gradduration)
 
 SeqGradChan (const STD_string &object_label="unnamedSeqGradChan")
 
 SeqGradChan (const SeqGradChan &sgc)
 
virtual ~SeqGradChan ()
 
SeqGradChanoperator= (const SeqGradChan &sgc)
 
virtual direction get_channel () const
 
virtual int get_wavesize () const
 
virtual void resize (unsigned int newsize)
 
SeqGradInterfaceset_strength (float gradstrength)
 
SeqGradInterfaceinvert_strength ()
 
float get_strength () const
 
double get_gradduration () const
 
SeqGradInterfaceset_gradrotmatrix (const RotMatrix &matrix)
 
fvector get_gradintegral () const
 
STD_string get_properties () const
 
unsigned int event (eventContext &context) 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 SeqDur
 SeqDur (const STD_string &object_label, float duration)
 
 SeqDur (const STD_string &object_label="unnamedSeqDur")
 
 SeqDur (const SeqDur &sd)
 
SeqDurset_duration (float duration)
 
double get_duration () const
 
SeqDuroperator= (const SeqDur &sd)
 
- 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
 

Protected Member Functions

float get_grdfactor (direction chan) const
 
fvector get_grdfactors_norot () const
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual void clear_container ()
 
virtual bool prep ()
 
- Protected Member Functions inherited from SeqTreeObj
virtual void query (queryContext &context) const
 

Friends

class SeqGradChanList
 
class SeqGradChanParallel
 

Additional Inherited Members

- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

This is the base class for all objects that represent a single gradient object

Definition at line 84 of file seqgradchan.h.

Constructor & Destructor Documentation

§ SeqGradChan() [1/3]

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

Constructs a gradient channel object 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

§ SeqGradChan() [2/3]

SeqGradChan::SeqGradChan ( const STD_string &  object_label = "unnamedSeqGradChan")

Construct an empty gradient channel object with the given label

§ SeqGradChan() [3/3]

SeqGradChan::SeqGradChan ( const SeqGradChan sgc)

Constructs a copy of 'sgc'

§ ~SeqGradChan()

virtual SeqGradChan::~SeqGradChan ( )
inlinevirtual

Destructor

Definition at line 109 of file seqgradchan.h.

Member Function Documentation

§ event()

unsigned int SeqGradChan::event ( eventContext context) const
virtual

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

Reimplemented from SeqTreeObj.

§ get_channel()

virtual direction SeqGradChan::get_channel ( ) const
virtual

Returns the occupied channel

§ get_gradduration()

double SeqGradChan::get_gradduration ( ) const
inlinevirtual

Returns the duration of the gradient object. This function returns only the effective duration during whichthe gradient is active, any delays before and after the gradient are omitted.

Implements SeqGradInterface.

Definition at line 139 of file seqgradchan.h.

§ get_gradintegral()

fvector SeqGradChan::get_gradintegral ( ) const
virtual

Returns the integral vector of the gradient course

Implements SeqGradInterface.

§ get_grdfactor()

float SeqGradChan::get_grdfactor ( direction  chan) const
protected

returns element [channel][chan] val. from the current rot. Matrix

§ get_grdfactors_norot()

fvector SeqGradChan::get_grdfactors_norot ( ) const
protected

returns element [channel][chan] val. from the current rot. Matrix without considering the rotation matrix of the current event block (for IDEA)

§ get_properties()

STD_string SeqGradChan::get_properties ( ) const
virtual

Returns a string describing the object

Reimplemented from SeqTreeObj.

§ get_strength()

float SeqGradChan::get_strength ( ) const
virtual

Returns the strength of the gradient object

Implements SeqGradInterface.

Reimplemented in SeqGradDelay.

§ get_wavesize()

virtual int SeqGradChan::get_wavesize ( ) const
inlinevirtual

Overload this function to return the size of the used waveform, if any

Definition at line 125 of file seqgradchan.h.

§ invert_strength()

SeqGradInterface& SeqGradChan::invert_strength ( )
virtual

Changes the polarity of the gradient, i.e. inverts the sign of the gradient strength

Implements SeqGradInterface.

§ operator=()

SeqGradChan& SeqGradChan::operator= ( const SeqGradChan sgc)

Assignment operator that makes this gradient channel object become a copy of 'sgc'

§ resize()

virtual void SeqGradChan::resize ( unsigned int  newsize)
inlinevirtual

Overload this function to resize the current waveform, if any

Definition at line 130 of file seqgradchan.h.

§ set_gradrotmatrix()

SeqGradInterface& SeqGradChan::set_gradrotmatrix ( const RotMatrix matrix)
virtual

This function can be used to specify a rotation of the gradient object in the spatial domain, the rotation will be applied to this object only rather than to the whole sequence.

Implements SeqGradInterface.

§ set_strength()

SeqGradInterface& SeqGradChan::set_strength ( float  gradstrength)
virtual

Changes the strength of the gradient object

Implements SeqGradInterface.

Reimplemented in SeqGradRamp.


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