Public Member Functions | List of all members
SeqGradInterface Class Referenceabstract

#include <seqgrad.h>

Inheritance diagram for SeqGradInterface:
Inheritance graph
[legend]

Public Member Functions

virtual SeqGradInterfaceset_strength (float gradstrength)=0
 
virtual SeqGradInterfaceinvert_strength ()=0
 
virtual float get_strength () const =0
 
virtual fvector get_gradintegral () const =0
 
float get_gradintegral_norm () const
 
virtual double get_gradduration () const =0
 
virtual SeqGradInterfaceset_gradrotmatrix (const RotMatrix &matrix)=0
 
- 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)
 

Additional Inherited Members

- 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

This is the abstract base class for all objects that represent gradient fields

Definition at line 35 of file seqgrad.h.

Member Function Documentation

§ get_gradduration()

virtual double SeqGradInterface::get_gradduration ( ) const
pure virtual

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.

Implemented in SeqGradTrapez, SeqAcqEPI, SeqGradEcho, SeqDiffWeight, SeqGradChan, SeqEpiDriverDefault, SeqParallel, SeqSat, SeqGradChanParallel, and SeqGradChanList.

§ get_gradintegral()

virtual fvector SeqGradInterface::get_gradintegral ( ) const
pure virtual

Returns the integral vector of the gradient course

Implemented in SeqAcqEPI, SeqGradEcho, SeqGradChan, SeqDiffWeight, SeqEpiDriverDefault, SeqParallel, SeqSat, SeqGradChanParallel, and SeqGradChanList.

§ get_gradintegral_norm()

float SeqGradInterface::get_gradintegral_norm ( ) const

Returns the norm of the integral vector of the gradient course

§ get_strength()

virtual float SeqGradInterface::get_strength ( ) const
pure virtual

§ invert_strength()

virtual SeqGradInterface& SeqGradInterface::invert_strength ( )
pure virtual

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

Implemented in SeqAcqEPI, SeqGradEcho, SeqDiffWeight, SeqGradChan, SeqEpiDriverDefault, SeqParallel, SeqSat, SeqGradChanParallel, and SeqGradChanList.

§ set_gradrotmatrix()

virtual SeqGradInterface& SeqGradInterface::set_gradrotmatrix ( const RotMatrix matrix)
pure 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.

Implemented in SeqAcqEPI, SeqGradEcho, SeqDiffWeight, SeqGradChan, SeqEpiDriverDefault, SeqParallel, SeqSat, SeqGradChanParallel, and SeqGradChanList.

§ set_strength()

virtual SeqGradInterface& SeqGradInterface::set_strength ( float  gradstrength)
pure virtual

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