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

Vector of SeqRotMatrix's. More...

#include <seqrotmatrixvector.h>

Inheritance diagram for SeqRotMatrixVector:
Inheritance graph
[legend]

Public Member Functions

 SeqRotMatrixVector (const STD_string &object_label="unnamedSeqRotMatrixVector")
 
 SeqRotMatrixVector (const SeqRotMatrixVector &srmv)
 
 ~SeqRotMatrixVector ()
 
SeqRotMatrixVectoroperator= (const SeqRotMatrixVector &srmv)
 
const RotMatrixoperator[] (unsigned long index) const
 
const RotMatrixget_current_matrix () const
 
SeqRotMatrixVectorcreate_inplane_rotation (unsigned int nsegments)
 
SeqRotMatrixVectorclear ()
 
SeqRotMatrixVectorappend (const RotMatrix &srm)
 
RotMatrix get_maxMatrix () const
 
unsigned int get_vectorsize () const
 
bool needs_unrolling_check () const
 
bool is_qualvector () const
 
bool prep_iteration () const
 
svector get_vector_commands (const STD_string &iterator) 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 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
 
- 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)
 

Friends

class SeqGradChan
 

Additional Inherited Members

- Protected Member Functions inherited from SeqVector
virtual svector get_reord_vector_commands (const STD_string &iterator) const
 
bool is_handled () const
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual void clear_container ()
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Vector of SeqRotMatrix's.

This class keeps an arry of rotation matrices. It can be used consecutively by a gradient object within a loop via the function SeqObjList::set_gradrotmatrixvector().

Definition at line 34 of file seqrotmatrixvector.h.

Constructor & Destructor Documentation

§ SeqRotMatrixVector() [1/2]

SeqRotMatrixVector::SeqRotMatrixVector ( const STD_string &  object_label = "unnamedSeqRotMatrixVector")

default constructor

§ SeqRotMatrixVector() [2/2]

SeqRotMatrixVector::SeqRotMatrixVector ( const SeqRotMatrixVector srmv)

constructs a rot-matrix vector from an existing rot-matrix vector

§ ~SeqRotMatrixVector()

SeqRotMatrixVector::~SeqRotMatrixVector ( )

Destructor

Member Function Documentation

§ append()

SeqRotMatrixVector& SeqRotMatrixVector::append ( const RotMatrix srm)
inline

adds a new rotation matrix at the end of the vector

Definition at line 87 of file seqrotmatrixvector.h.

§ clear()

SeqRotMatrixVector& SeqRotMatrixVector::clear ( )
inline

clears the list of rotation matrices

Definition at line 78 of file seqrotmatrixvector.h.

§ create_inplane_rotation()

SeqRotMatrixVector& SeqRotMatrixVector::create_inplane_rotation ( unsigned int  nsegments)

Makes this a vector of 'nsegments' matrices that rotate the first and second dimension (read, phase) with a constant angle increment of 2*PI/nsegments.

§ get_current_matrix()

const RotMatrix& SeqRotMatrixVector::get_current_matrix ( ) const

returns the currently active matrix when used inside a loop

§ get_maxMatrix()

RotMatrix SeqRotMatrixVector::get_maxMatrix ( ) const

returns values with max. absolute values for each element of the matrix vector

§ get_vector_commands()

svector SeqRotMatrixVector::get_vector_commands ( const STD_string &  iterator) const
inlinevirtual

If the vector is used as a variable in the code-generated pulse program, overload this function to return a unique label/command for the vector which is either attached to the loop (Bruker), or executed at the beginning of the loop (EPIC).

Reimplemented from SeqVector.

Definition at line 106 of file seqrotmatrixvector.h.

§ get_vectorsize()

unsigned int SeqRotMatrixVector::get_vectorsize ( ) const
inlinevirtual

Overload this function to return the number of elements in the vector (regardless of reordering)

Reimplemented from SeqVector.

Definition at line 102 of file seqrotmatrixvector.h.

§ is_qualvector()

bool SeqRotMatrixVector::is_qualvector ( ) const
inlinevirtual

Overload this function to tell whether the vector qualitatively alters the sequence concerning timings and RF power deposition. This is useful for accelerating duration and SAR calculations (Siemens).

Reimplemented from SeqVector.

Definition at line 104 of file seqrotmatrixvector.h.

§ needs_unrolling_check()

bool SeqRotMatrixVector::needs_unrolling_check ( ) const
inlinevirtual

Overload this function to trigger a check whether the loop must possibly be unrolled in pulse or gradient program

Reimplemented from SeqVector.

Definition at line 103 of file seqrotmatrixvector.h.

§ operator=()

SeqRotMatrixVector& SeqRotMatrixVector::operator= ( const SeqRotMatrixVector srmv)

assignment operator

§ operator[]()

const RotMatrix& SeqRotMatrixVector::operator[] ( unsigned long  index) const

returns the index'th matrix

§ prep_iteration()

bool SeqRotMatrixVector::prep_iteration ( ) const
virtual

Overload this function to prepare objects at run-time before the execution of a loop repetition return 'false' when preparation fails

Reimplemented from SeqVector.


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