Public Member Functions

SeqGradInterface Class Reference
[Internal Classes for sequence design (odinseq library)]

#include <seqgrad.h>

Inheritance diagram for SeqGradInterface:
Inheritance graph
[legend]

List of all members.

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

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

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 SeqEpiDriverDefault, SeqAcqEPI, SeqDiffWeight, SeqParallel, and SeqSat.

virtual fvector SeqGradInterface::get_gradintegral (  )  const [pure virtual]

Returns the integral vector of the gradient course

Implemented in SeqEpiDriverDefault, SeqAcqEPI, SeqDiffWeight, SeqParallel, and SeqSat.

float SeqGradInterface::get_gradintegral_norm (  )  const

Returns the norm of the integral vector of the gradient course

virtual float SeqGradInterface::get_strength (  )  const [pure virtual]

Returns the strength of the gradient object

Implemented in SeqEpiDriverDefault, SeqAcqEPI, SeqDiffWeight, SeqParallel, and SeqSat.

virtual SeqGradInterface& SeqGradInterface::invert_strength (  )  [pure virtual]

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

Implemented in SeqEpiDriverDefault, SeqAcqEPI, SeqDiffWeight, SeqParallel, and SeqSat.

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 SeqEpiDriverDefault, SeqAcqEPI, SeqDiffWeight, SeqParallel, and SeqSat.

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

Changes the strength of the gradient object

Implemented in SeqEpiDriverDefault, SeqAcqEPI, SeqDiffWeight, SeqParallel, and SeqSat.


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