ODIN
Public Member Functions | Friends | List of all members

Vector of constant gradients. More...

#include <seqgradvec.h>

Inheritance diagram for SeqGradVector:
Inheritance graph
[legend]

Public Member Functions

 SeqGradVector (const STD_string &object_label, direction gradchannel, float maxgradstrength, const fvector &trimarray, double gradduration)
 
 SeqGradVector (const SeqGradVector &sgv)
 
 SeqGradVector (const STD_string &object_label="unnamedSeqGradVector")
 
SeqGradVectorset_trims (const fvector &trims)
 
fvector get_trims () const
 
SeqGradVectoroperator= (const SeqGradVector &sgv)
 
- Public Member Functions inherited from SeqGradChan
 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
 
- Public Member Functions inherited from SeqVector
 SeqVector (const STD_string &object_label="unnamedSeqVector")
 
 SeqVector (const STD_string &object_label, unsigned int nindices, int slope=1, int offset=0)
 
 SeqVector (const SeqVector &sv)
 
virtual ~SeqVector ()
 
SeqVectoroperator= (const SeqVector &sv)
 
virtual unsigned int get_numof_iterations () const
 
virtual bool needs_unrolling_check () const
 
virtual int get_current_index () const
 
int get_acq_index () const
 
virtual bool is_acq_vector () const
 
virtual bool is_obj_vector () const
 
virtual STD_string get_loopcommand () const
 
SeqVectorset_indexvec (const ivector &iv)
 
ivector get_indexvec () const
 
SeqVectorset_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)
 
SeqVectorset_encoding_scheme (encodingScheme scheme)
 
const SeqVectorget_reorder_vector () const
 
virtual nestingRelation get_nesting_relation () const
 
iarray get_index_matrix () const
 
int get_current_reord_index () const
 
STD_string get_reord_iterator (const STD_string &iterator) const
 

Friends

class SeqGradVectorPulse
 

Additional Inherited Members

- Protected Member Functions inherited from SeqGradChan
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 ()
 
- Protected Member Functions inherited from SeqTreeObj
virtual void query (queryContext &context) const
 
- Protected Member Functions inherited from SeqVector
bool is_handled () const
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Vector of constant gradients.

This class represents a gradient object 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 38 of file seqgradvec.h.

Constructor & Destructor Documentation

◆ SeqGradVector() [1/3]

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

Constructs a gradient vector 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

◆ SeqGradVector() [2/3]

SeqGradVector::SeqGradVector ( const SeqGradVector sgv)

Constructs a copy of 'sgv'

◆ SeqGradVector() [3/3]

SeqGradVector::SeqGradVector ( const STD_string &  object_label = "unnamedSeqGradVector")

Construct an empty gradient object with the given label

Member Function Documentation

◆ get_trims()

fvector SeqGradVector::get_trims ( ) const
inline

Returns the trim values that will be used

Definition at line 69 of file seqgradvec.h.

◆ operator=()

SeqGradVector& SeqGradVector::operator= ( const SeqGradVector sgv)

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

◆ set_trims()

SeqGradVector& SeqGradVector::set_trims ( const fvector trims)

Specifies the trim values that will be used


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