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

System proxy. More...

#include <system.h>

Inheritance diagram for System:
Inheritance graph
[legend]

Public Member Functions

 System (const STD_string &object_label="unnamedSystem")
 
 System (const System &s)
 
Systemoperator= (const System &s)
 
odinPlatform get_platform () const
 
STD_string get_platform_str () const
 
STD_string get_transmit_coil_name () const
 
Systemset_transmit_coil_name (const STD_string &tcname)
 
STD_string get_receive_coil_name () const
 
Systemset_receive_coil_name (const STD_string &rcname)
 
STD_string get_main_nucleus () const
 
Systemset_main_nucleus (const STD_string &nucname)
 
float get_max_grad () const
 
float get_max_slew_rate () const
 
float get_grad_switch_time (float graddiff) const
 
float get_inter_grad_delay () const
 
Systemset_scandir (const STD_string &dir)
 
STD_string get_scandir () const
 
float get_grad_shift_delay () const
 
double get_B0 () const
 
Systemset_B0 (double b0)
 
Systemset_B0_from_freq (double freq, const STD_string &nucName="")
 
double get_gamma (const STD_string &nucName="") const
 
Systemset_reference_gain (float refgain)
 
float get_reference_gain () const
 
double get_nuc_freq (const STD_string &nucName="") const
 
LDRenum get_nuc_enum () const
 
double get_min_duration (objCategory c) const
 
double get_min_grad_rastertime () const
 
double get_rastertime (objCategory cat) const
 
double get_rasteredtime (objCategory cat, double time) const
 
int get_max_rf_samples () const
 
int get_max_grad_samples () const
 
Systemset_data_type (const STD_string &type)
 
STD_string get_data_type () const
 
bool allowed_grad_freq (double freq, double &low, double &upp) const
 
- 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 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
 

Friends

class SeqMethod
 

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

System proxy.

This class is used to hold all information/configuration of the spectrometer

Definition at line 91 of file system.h.

Constructor & Destructor Documentation

§ System() [1/2]

System::System ( const STD_string &  object_label = "unnamedSystem")

Constructs a System with the given label

§ System() [2/2]

System::System ( const System s)
inline

Copy constructor

Definition at line 103 of file system.h.

Member Function Documentation

§ allowed_grad_freq()

bool System::allowed_grad_freq ( double  freq,
double &  low,
double &  upp 
) const

Returns 'true' if gradient switching frequency 'freq' does not cause acoustic resonance, otherwise, 'low' and 'upp' will contain the next possible lower and upper frequencies, respectively.

§ get_B0()

double System::get_B0 ( ) const
inline

Returns the field strength of the static magnetic field

Definition at line 189 of file system.h.

§ get_data_type()

STD_string System::get_data_type ( ) const
inline

Returns the data represention type of the image data

Definition at line 266 of file system.h.

§ get_gamma()

double System::get_gamma ( const STD_string &  nucName = "") const

Returns the gyromagnetic ratio of the given nucleus, default returns the ratio of protons

§ get_grad_shift_delay()

float System::get_grad_shift_delay ( ) const
inline

Returns the time shift between RF and gradient channel

Definition at line 184 of file system.h.

§ get_grad_switch_time()

float System::get_grad_switch_time ( float  graddiff) const

Returns the time required to change the gradient strength by the specified amount

§ get_inter_grad_delay()

float System::get_inter_grad_delay ( ) const
inline

Returns the minimum time gap between two gradient commands

Definition at line 168 of file system.h.

§ get_main_nucleus()

STD_string System::get_main_nucleus ( ) const
inline

Returns the current main nucleus of the sequence, i.e. the nucleus for which both, excitation and acquisition, will be performed

Definition at line 143 of file system.h.

§ get_max_grad()

float System::get_max_grad ( ) const
inline

Returns the maximum gradient strength of the scanner

Definition at line 153 of file system.h.

§ get_max_grad_samples()

int System::get_max_grad_samples ( ) const
inline

Returns the maximum number of samples per gradient waveform

Definition at line 256 of file system.h.

§ get_max_rf_samples()

int System::get_max_rf_samples ( ) const
inline

Returns the maximum number of samples per RF pulse

Definition at line 251 of file system.h.

§ get_max_slew_rate()

float System::get_max_slew_rate ( ) const
inline

Returns the maximum slew rate

Definition at line 158 of file system.h.

§ get_min_duration()

double System::get_min_duration ( objCategory  c) const
inline

Returns the minimum duration for the given object category

Definition at line 231 of file system.h.

§ get_min_grad_rastertime()

double System::get_min_grad_rastertime ( ) const
inline

Returns the minimum gradient raster time

Definition at line 236 of file system.h.

§ get_nuc_enum()

LDRenum System::get_nuc_enum ( ) const

Returns an enum with all registered nuclei as entries

§ get_nuc_freq()

double System::get_nuc_freq ( const STD_string &  nucName = "") const

Returns the resonance for the given nucleus

§ get_platform()

odinPlatform System::get_platform ( ) const

Returns the platform identifier for the scanner, works only in the context of sequence programming

§ get_platform_str()

STD_string System::get_platform_str ( ) const
inline

Returns a string identifying the platform

Definition at line 118 of file system.h.

§ get_rasteredtime()

double System::get_rasteredtime ( objCategory  cat,
double  time 
) const

Returns the rastered time for the given object type and non-rastered time point/period

§ get_rastertime()

double System::get_rastertime ( objCategory  cat) const

Returns the raster time for the given object category, if no such time exists, it returns 0

§ get_receive_coil_name()

STD_string System::get_receive_coil_name ( ) const
inline

Returns a string identifying the receive coil

Definition at line 133 of file system.h.

§ get_reference_gain()

float System::get_reference_gain ( ) const
inline

Returns the reference gain in dB

Definition at line 215 of file system.h.

§ get_scandir()

STD_string System::get_scandir ( ) const

Returns the directory where the experimental data files of the current scans are stored

§ get_transmit_coil_name()

STD_string System::get_transmit_coil_name ( ) const
inline

Returns a string identifying the transmit coil

Definition at line 123 of file system.h.

§ operator=()

System& System::operator= ( const System s)

Assignment operator

§ set_B0()

System& System::set_B0 ( double  b0)
inline

Returns the field strength of the static magnetic field

Definition at line 194 of file system.h.

§ set_B0_from_freq()

System& System::set_B0_from_freq ( double  freq,
const STD_string &  nucName = "" 
)

Specifies the field strength of the static magnetic field by giving the resonance frequency for the specified nucleus

§ set_data_type()

System& System::set_data_type ( const STD_string &  type)
inline

Sets the data represention type of the image data

Definition at line 261 of file system.h.

§ set_main_nucleus()

System& System::set_main_nucleus ( const STD_string &  nucname)

Specifies the current main nucleus of the scanner, i.e. the nucleus for which both, excitation and acquisition, will be performed

§ set_receive_coil_name()

System& System::set_receive_coil_name ( const STD_string &  rcname)

Sets the receive coil name

§ set_reference_gain()

System& System::set_reference_gain ( float  refgain)

Sets the reference gain in dB

§ set_scandir()

System& System::set_scandir ( const STD_string &  dir)

Sets the directory where the experimental data files of the current scans are stored

§ set_transmit_coil_name()

System& System::set_transmit_coil_name ( const STD_string &  tcname)

Sets the transmit coil name


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