System proxy.
More...
#include <system.h>
List of all members.
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::System |
( |
const STD_string & |
object_label = "unnamedSystem" |
) |
|
Constructs a System with the given label
| System::System |
( |
const System & |
s |
) |
[inline] |
Copy constructor
Definition at line 103 of file system.h.
Member Function Documentation
Returns the platform identifier for the scanner, works only in the context of sequence programming
| STD_string System::get_platform_str |
( |
|
) |
const [inline] |
Returns a string identifying the platform
Definition at line 118 of file system.h.
| STD_string System::get_transmit_coil_name |
( |
|
) |
const [inline] |
Returns a string identifying the transmit coil
Definition at line 123 of file system.h.
| System& System::set_transmit_coil_name |
( |
const STD_string & |
tcname |
) |
|
Sets the transmit coil name
| 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 133 of file system.h.
| 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
| float System::get_max_grad |
( |
|
) |
const [inline] |
Returns the maximum gradient strength of the scanner
Definition at line 143 of file system.h.
| float System::get_max_slew_rate |
( |
|
) |
const [inline] |
Returns the maximum slew rate
Definition at line 148 of file system.h.
| float System::get_grad_switch_time |
( |
float |
graddiff |
) |
const |
Returns the time required to change the gradient strength by the specified amount
| float System::get_inter_grad_delay |
( |
|
) |
const [inline] |
Returns the minimum time gap between two gradient commands
Definition at line 158 of file system.h.
| System& System::set_scandir |
( |
const STD_string & |
dir |
) |
|
Sets the directory where the experimental data files of the current scans are stored
| STD_string System::get_scandir |
( |
|
) |
const |
Returns the directory where the experimental data files of the current scans are stored
| float System::get_grad_shift_delay |
( |
|
) |
const [inline] |
Returns the time shift between RF and gradient channel
Definition at line 174 of file system.h.
| double System::get_B0 |
( |
|
) |
const [inline] |
Returns the field strength of the static magnetic field
Definition at line 179 of file system.h.
| 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
| double System::get_gamma |
( |
const STD_string & |
nucName = "" |
) |
const |
Returns the gyromagnetic ratio of the given nucleus, default returns the ratio of protons
| System& System::set_reference_gain |
( |
float |
refgain |
) |
|
Sets the reference gain in dB
| float System::get_reference_gain |
( |
|
) |
const [inline] |
Returns the reference gain in dB
Definition at line 200 of file system.h.
| double System::get_nuc_freq |
( |
const STD_string & |
nucName = "" |
) |
const |
Returns the resonance for the given nucleus
| JDXenum System::get_nuc_enum |
( |
|
) |
const |
Returns an enum with all registered nuclei as entries
| double System::get_min_duration |
( |
objCategory |
c |
) |
const [inline] |
Returns the minimum duration for the given object category
Definition at line 216 of file system.h.
| double System::get_min_grad_rastertime |
( |
|
) |
const [inline] |
Returns the minimum gradient raster time
Definition at line 221 of file system.h.
| double System::get_rastertime |
( |
objCategory |
cat |
) |
const |
Returns the raster time for the given object category, if no such time exists, it returns 0
| double System::get_rasteredtime |
( |
objCategory |
cat, |
|
|
double |
time | |
|
) |
| | const |
Returns the rastered time for the given object type and non-rastered time point/period
| int System::get_max_rf_samples |
( |
|
) |
const [inline] |
Returns the maximum number of samples per RF pulse
Definition at line 236 of file system.h.
| int System::get_max_grad_samples |
( |
|
) |
const [inline] |
Returns the maximum number of samples per gradient waveform
Definition at line 241 of file system.h.
| System& System::set_data_type |
( |
const STD_string & |
type |
) |
[inline] |
Sets the data represention type of the image data
Definition at line 246 of file system.h.
| STD_string System::get_data_type |
( |
|
) |
const [inline] |
Returns the data represention type of the image data
Definition at line 251 of file system.h.
| 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.
The documentation for this class was generated from the following file:
