Public Member Functions | List of all members
SeqPars Class Reference

Sequence Parameter proxy. More...

#include <seqpars.h>

Inheritance diagram for SeqPars:
Inheritance graph
[legend]

Public Member Functions

 SeqPars (const STD_string &label="unnamedSeqPars")
 
 SeqPars (const SeqPars &sp)
 
SeqParsset_MatrixSize (direction dir, unsigned int size, parameterMode parmode=edit)
 
unsigned int get_MatrixSize (direction dir) const
 
SeqParsset_RepetitionTime (double time, parameterMode parmode=edit)
 
double get_RepetitionTime () const
 
SeqParsset_NumOfRepetitions (unsigned int times, parameterMode parmode=edit)
 
unsigned int get_NumOfRepetitions () const
 
SeqParsset_EchoTime (double time, parameterMode parmode=edit)
 
double get_EchoTime () const
 
SeqParsset_AcqSweepWidth (double sw, parameterMode parmode=edit)
 
double get_AcqSweepWidth () const
 
SeqParsset_FlipAngle (double fa, parameterMode parmode=edit)
 
double get_FlipAngle () const
 
SeqParsset_ReductionFactor (unsigned int factor, parameterMode parmode=edit)
 
unsigned int get_ReductionFactor () const
 
SeqParsset_PartialFourier (float factor, parameterMode parmode=edit)
 
float get_PartialFourier () const
 
SeqParsset_RFSpoiling (bool flag, parameterMode parmode=edit)
 
bool get_RFSpoiling () const
 
SeqParsset_GradientIntro (bool flag, parameterMode parmode=edit)
 
bool get_GradientIntro () const
 
SeqParsset_PhysioTrigger (bool flag, parameterMode parmode=edit)
 
bool get_PhysioTrigger () const
 
SeqParsset_Sequence (const STD_string &seqid)
 
const STD_string & get_Sequence () const
 
SeqParsset_ExpDuration (double dur)
 
double get_ExpDuration () const
 
SeqParsset_AcquisitionStart (double time)
 
double get_AcquisitionStart () const
 
SeqParsoperator= (const SeqPars &pars2)
 
- Public Member Functions inherited from LDRblock
 LDRblock (const STD_string &title="Parameter List")
 
 LDRblock (const LDRblock &block)
 
 ~LDRblock ()
 
LDRblockoperator= (const LDRblock &block)
 
LDRblockmerge (LDRblock &block, bool onlyUserPars=true)
 
LDRblockunmerge (LDRblock &block)
 
STD_string printval (const STD_string &parameterName, bool append_unit=false) const
 
bool parseval (const STD_string &parameterName, const STD_string &value)
 
int parseblock (const STD_string &source, const LDRserBase &serializer=LDRserJDX())
 
unsigned int numof_pars () const
 
LDRbaseget_parameter (const STD_string &ldrlabel)
 
bool parameter_exists (const STD_string &ldrlabel) const
 
LDRblockset_prefix (const STD_string &prefix)
 
LDRblockset_embedded (bool embedded)
 
bool is_embedded () const
 
LDRbaseoperator[] (unsigned int i)
 
const LDRbaseoperator[] (unsigned int i) const
 
LDRbaseget_parameter_by_id (int id)
 
LDRblockcreate_copy (const LDRblock &src)
 
LDRblockappend_copy (const LDRbase &src)
 
LDRblockcopy_ldr_vals (const LDRblock &src)
 
bool operator== (const LDRblock &rhs) const
 
bool operator< (const LDRblock &rhs) const
 
bool compare (const LDRblock &rhs, const STD_list< STD_string > *exclude=0, double accuracy=0.0) const
 
STD_string print (const LDRserBase &serializer=LDRserJDX()) const
 
LDRbaseset_parmode (parameterMode parameter_mode)
 
LDRbaseset_filemode (fileMode file_mode)
 
STD_string get_parx_code (parxCodeType type) const
 
STD_ostream & print2stream (STD_ostream &os, const LDRserBase &serializer) const
 
bool parsevalstring (const STD_string &, const LDRserBase *ser=0)
 
bool parse (STD_string &parstring, const LDRserBase &serializer)
 
STD_string printvalstring (const LDRserBase *ser=0) const
 
LDRbasecreate_copy () const
 
STD_string get_typeInfo (bool parx_equivtype=false) const
 
int load (const STD_string &filename, const LDRserBase &serializer=LDRserJDX())
 
int write (const STD_string &filename, const LDRserBase &serializer=LDRserJDX()) const
 
- Public Member Functions inherited from LDRbase
virtual double get_minval () const
 
virtual double get_maxval () const
 
bool has_minmax () const
 
const STD_string & get_description () const
 
LDRbaseset_description (const STD_string &descr)
 
virtual svector get_alternatives () const
 
const STD_string & get_unit () const
 
LDRbaseset_unit (const STD_string &un)
 
virtual parameterMode get_parmode () const
 
virtual fileMode get_filemode () const
 
virtual GuiProps get_gui_props () const
 
virtual LDRbaseset_gui_props (const GuiProps &)
 
JcampDxProps get_jdx_props () const
 
LDRbaseset_jdx_props (const JcampDxProps &jp)
 
- 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 List< I, P, R >
 List ()
 
 ~List ()
 
Listoperator= (const List &l)
 
Listclear ()
 
Listappend (R item)
 
Listremove (R item)
 
unsigned int size () const
 
iter get_begin ()
 
iter get_end ()
 
constiter get_const_begin () const
 
constiter get_const_end () const
 

Additional Inherited Members

- Public Types inherited from List< I, P, R >
typedef STD_list< P >::iterator iter
 
typedef STD_list< P >::const_iterator constiter
 
- Protected Member Functions inherited from LDRblock
LDRblockappend_member (LDRbase &ldr, const STD_string ldrlabel="")
 

Detailed Description

Sequence Parameter proxy.

This class is used to hold all common sequence parameters

Definition at line 35 of file seqpars.h.

Constructor & Destructor Documentation

§ SeqPars() [1/2]

SeqPars::SeqPars ( const STD_string &  label = "unnamedSeqPars")

Constructs a SeqPars with the given label

§ SeqPars() [2/2]

SeqPars::SeqPars ( const SeqPars sp)
inline

Constructs a copy of 'sp'

Definition at line 47 of file seqpars.h.

Member Function Documentation

§ get_AcqSweepWidth()

double SeqPars::get_AcqSweepWidth ( ) const
inline

Returns the sweep width of the acquisition window

Definition at line 101 of file seqpars.h.

§ get_AcquisitionStart()

double SeqPars::get_AcquisitionStart ( ) const
inline

Returns the starting time point of the sequence

Definition at line 192 of file seqpars.h.

§ get_EchoTime()

double SeqPars::get_EchoTime ( ) const
inline

Returns the echo time of the sequence

Definition at line 89 of file seqpars.h.

§ get_ExpDuration()

double SeqPars::get_ExpDuration ( ) const
inline

Returns the total duration of the sequence in minutes

Definition at line 182 of file seqpars.h.

§ get_FlipAngle()

double SeqPars::get_FlipAngle ( ) const
inline

Returns the flip angle of the excitation pulse

Definition at line 111 of file seqpars.h.

§ get_GradientIntro()

bool SeqPars::get_GradientIntro ( ) const
inline

Returns whether gradient intro will be played out prior to sequence

Definition at line 151 of file seqpars.h.

§ get_MatrixSize()

unsigned int SeqPars::get_MatrixSize ( direction  dir) const

Returns the size of the image in the given direction

§ get_NumOfRepetitions()

unsigned int SeqPars::get_NumOfRepetitions ( ) const
inline

Returns the number of times the sequence will be repeated

Definition at line 78 of file seqpars.h.

§ get_PartialFourier()

float SeqPars::get_PartialFourier ( ) const
inline

Returns the partial Fourier factor (0.0 = full k-space, 1.0 = half k-space)

Definition at line 131 of file seqpars.h.

§ get_PhysioTrigger()

bool SeqPars::get_PhysioTrigger ( ) const
inline

Returns whether a physiological trigger is used

Definition at line 161 of file seqpars.h.

§ get_ReductionFactor()

unsigned int SeqPars::get_ReductionFactor ( ) const
inline

Returns the reduction factor for parallel imaging

Definition at line 121 of file seqpars.h.

§ get_RepetitionTime()

double SeqPars::get_RepetitionTime ( ) const
inline

Returns the repetition time of the sequence

Definition at line 68 of file seqpars.h.

§ get_RFSpoiling()

bool SeqPars::get_RFSpoiling ( ) const
inline

Returns whether RF spoiling is used

Definition at line 141 of file seqpars.h.

§ get_Sequence()

const STD_string& SeqPars::get_Sequence ( ) const
inline

Returns the label of the sequence used

Definition at line 171 of file seqpars.h.

§ operator=()

SeqPars& SeqPars::operator= ( const SeqPars pars2)

Assignment operator

§ set_AcqSweepWidth()

SeqPars& SeqPars::set_AcqSweepWidth ( double  sw,
parameterMode  parmode = edit 
)

Specifies the sweep width of the acquisition window

§ set_AcquisitionStart()

SeqPars& SeqPars::set_AcquisitionStart ( double  time)
inline

Sets the starting time point of the sequence

Definition at line 187 of file seqpars.h.

§ set_EchoTime()

SeqPars& SeqPars::set_EchoTime ( double  time,
parameterMode  parmode = edit 
)

Specifies the echo time of the sequence

§ set_ExpDuration()

SeqPars& SeqPars::set_ExpDuration ( double  dur)
inline

Sets the total duration of the sequence in minutes

Definition at line 177 of file seqpars.h.

§ set_FlipAngle()

SeqPars& SeqPars::set_FlipAngle ( double  fa,
parameterMode  parmode = edit 
)

Specifies the flip angle of the excitation pulse

§ set_GradientIntro()

SeqPars& SeqPars::set_GradientIntro ( bool  flag,
parameterMode  parmode = edit 
)

Specifies whether gradient intro will be played out prior to sequence

§ set_MatrixSize()

SeqPars& SeqPars::set_MatrixSize ( direction  dir,
unsigned int  size,
parameterMode  parmode = edit 
)

Specifies the size of the image in the given direction 'dir' to 'size'

§ set_NumOfRepetitions()

SeqPars& SeqPars::set_NumOfRepetitions ( unsigned int  times,
parameterMode  parmode = edit 
)

Specifies the number of times the sequence will be repeated

§ set_PartialFourier()

SeqPars& SeqPars::set_PartialFourier ( float  factor,
parameterMode  parmode = edit 
)

Specifies the partial Fourier factor (0.0 = full k-space, 1.0 = half k-space)

§ set_PhysioTrigger()

SeqPars& SeqPars::set_PhysioTrigger ( bool  flag,
parameterMode  parmode = edit 
)

Specifies whether a physiological trigger is used

§ set_ReductionFactor()

SeqPars& SeqPars::set_ReductionFactor ( unsigned int  factor,
parameterMode  parmode = edit 
)

Specifies the reduction factor for parallel imaging

§ set_RepetitionTime()

SeqPars& SeqPars::set_RepetitionTime ( double  time,
parameterMode  parmode = edit 
)

Specifies the repetition time of the sequence

§ set_RFSpoiling()

SeqPars& SeqPars::set_RFSpoiling ( bool  flag,
parameterMode  parmode = edit 
)

Specifies whether RF spoiling is used

§ set_Sequence()

SeqPars& SeqPars::set_Sequence ( const STD_string &  seqid)
inline

Sets the label of the sequence used

Definition at line 166 of file seqpars.h.


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