ODIN
Public Member Functions | List of all members
SeqGradPhaseEnc Class Reference

Phase Encoding. More...

#include <seqgradphase.h>

Inheritance diagram for SeqGradPhaseEnc:
Inheritance graph
[legend]

Public Member Functions

 SeqGradPhaseEnc (const STD_string &object_label, unsigned int nsteps, float fov, direction gradchannel, float gradstrength, encodingScheme scheme=linearEncoding, reorderScheme reorder=noReorder, unsigned int nsegments=1, unsigned int reduction=1, unsigned int acl_bands=DEFAULT_ACL_BANDS, float partial_fourier=0.0, const STD_string &nucleus="")
 
 SeqGradPhaseEnc (const STD_string &object_label, unsigned int nsteps, float fov, float gradduration, direction gradchannel, encodingScheme scheme=linearEncoding, reorderScheme reorder=noReorder, unsigned int nsegments=1, unsigned int reduction=1, unsigned int acl_bands=DEFAULT_ACL_BANDS, float partial_fourier=0.0, const STD_string &nucleus="")
 
 SeqGradPhaseEnc (const STD_string &object_label="unnamedSeqGradPhaseEnc")
 
 SeqGradPhaseEnc (const SeqGradPhaseEnc &sgpe)
 
SeqGradPhaseEncoperator= (const SeqGradPhaseEnc &sgpe)
 
- Public Member Functions inherited from SeqGradVectorPulse
 SeqGradVectorPulse (const STD_string &object_label, direction gradchannel, float maxgradstrength, const fvector &trimarray, float gradduration)
 
 SeqGradVectorPulse (const SeqGradVectorPulse &sgvp)
 
 SeqGradVectorPulse (const STD_string &object_label="unnamedSeqGradVectorPulse")
 
SeqGradVectorPulseoperator= (const SeqGradVectorPulse &sgvp)
 
SeqGradVectorPulseset_trims (const fvector &trims)
 
fvector get_trims () const
 
SeqGradVectorPulseset_reorder_scheme (reorderScheme scheme, unsigned int nsegments=1)
 
SeqGradVectorPulseset_encoding_scheme (encodingScheme scheme)
 
const SeqVectorget_reorder_vector () const
 
SeqGradVectorPulseset_constduration (float duration)
 
double get_constduration () const
 
 operator const SeqVector & () const
 
SeqGradInterfaceset_strength (float gradstrength)
 
- Public Member Functions inherited from SeqGradChanList
 SeqGradChanList (const STD_string &object_label="unnamedSeqGradChanList")
 
 SeqGradChanList (const SeqGradChanList &sgcl)
 
 ~SeqGradChanList ()
 
SeqGradChanListoperator= (const SeqGradChanList &sgcl)
 
double get_duration () const
 
STD_string get_properties () const
 
unsigned int event (eventContext &context) const
 
void query (queryContext &context) const
 
SeqGradInterfaceinvert_strength ()
 
float get_strength () const
 
fvector get_gradintegral () const
 
double get_gradduration () const
 
SeqGradInterfaceset_gradrotmatrix (const RotMatrix &matrix)
 
direction get_channel () const
 
SeqGradChanListoperator+= (SeqGradChanList &sgcl)
 
SeqGradChanListoperator+= (SeqGradChan &sgc)
 
- Public Member Functions inherited from List< SeqGradChan, SeqGradChan *, SeqGradChan & >
 List ()
 
 ~List ()
 
Listoperator= (const List &l)
 
Listclear ()
 
Listappend (SeqGradChan & item)
 
Listremove (SeqGradChan & item)
 
unsigned int size () const
 
iter get_begin ()
 
iter get_end ()
 
constiter get_const_begin () const
 
constiter get_const_end () 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 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
 

Additional Inherited Members

- Public Types inherited from List< SeqGradChan, SeqGradChan *, SeqGradChan & >
typedef STD_list< SeqGradChan * >::iterator iter
 
typedef STD_list< SeqGradChan * >::const_iterator constiter
 
- Protected Member Functions inherited from SeqClass
void marshall_error () const
 
virtual bool prep ()
 
- Static Protected Member Functions inherited from SeqClass
static void clear_temporary ()
 
static void clear_containers ()
 

Detailed Description

Phase Encoding.

A phase encoding gradient

Definition at line 37 of file seqgradphase.h.

Constructor & Destructor Documentation

◆ SeqGradPhaseEnc() [1/4]

SeqGradPhaseEnc::SeqGradPhaseEnc ( const STD_string &  object_label,
unsigned int  nsteps,
float  fov,
direction  gradchannel,
float  gradstrength,
encodingScheme  scheme = linearEncoding,
reorderScheme  reorder = noReorder,
unsigned int  nsegments = 1,
unsigned int  reduction = 1,
unsigned int  acl_bands = DEFAULT_ACL_BANDS,
float  partial_fourier = 0.0,
const STD_string &  nucleus = "" 
)

Constructs a phase encoding gradient labeled 'object_label' with the following properties:

  • nsteps: The number of phase encoding steps
  • fov: The Field of View
  • gradchannel: The channel this object should be played out
  • gradstrength: The maximum gradient strength
  • scheme: The phase encoding scheme
  • reorder: The reordering scheme
  • nsegments: The number of segments for segmented reordering
  • reduction: Reduction factor for parallel imaging (sparsely sampled k-space)
  • acl_bands: Number of autocalibration bands (bunch of adjacent lines between actual k-space lines) for GRAPPA
  • partial_fourier: The amount of partial Fourier undersampling (0=no undersampling, 1=half fourier)
  • nucleus: The nucleus this object should be calculated for

◆ SeqGradPhaseEnc() [2/4]

SeqGradPhaseEnc::SeqGradPhaseEnc ( const STD_string &  object_label,
unsigned int  nsteps,
float  fov,
float  gradduration,
direction  gradchannel,
encodingScheme  scheme = linearEncoding,
reorderScheme  reorder = noReorder,
unsigned int  nsegments = 1,
unsigned int  reduction = 1,
unsigned int  acl_bands = DEFAULT_ACL_BANDS,
float  partial_fourier = 0.0,
const STD_string &  nucleus = "" 
)

Constructs a phase encoding gradient labeled 'object_label' with the following properties:

  • nsteps: The number of phase encoding steps
  • fov: The Field of View
  • gradduration: The duration of the gradient
  • gradchannel: The channel this object should be played out
  • scheme: The phase encoding scheme
  • reorder: The reordering scheme
  • nsegments: The number of segments for segmented reordering
  • reduction: Reduction factor for parallel imaging (sparsely sampled k-space)
  • acl_bands: Number of autocalibration bands (bunch of adjacent lines between actual k-space lines) for GRAPPA
  • partial_fourier: The amount of partial Fourier undersampling (0=no undersampling, 1=half fourier)
  • nucleus: The nucleus this object should be calculated for

◆ SeqGradPhaseEnc() [3/4]

SeqGradPhaseEnc::SeqGradPhaseEnc ( const STD_string &  object_label = "unnamedSeqGradPhaseEnc")
inline

Constructs an empty phase encoding gradient labeled 'object_label'

Definition at line 85 of file seqgradphase.h.

◆ SeqGradPhaseEnc() [4/4]

SeqGradPhaseEnc::SeqGradPhaseEnc ( const SeqGradPhaseEnc sgpe)
inline

Constructs a copy of 'sgpe'

Definition at line 90 of file seqgradphase.h.

Member Function Documentation

◆ operator=()

SeqGradPhaseEnc& SeqGradPhaseEnc::operator= ( const SeqGradPhaseEnc sgpe)
inline

Assignment operator that makes this object become a copy of 'sgpe'

Definition at line 95 of file seqgradphase.h.


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