SetSystemParams

Declaration: SetSystemParams(MakePermanent: boolean; Parameters: string): integer;
Sets various system parameters. You can make the new settings of the specified parameters permanent by setting the parameter MakePermanent to TRUE. If MakePermanent is FALSE, the changes will be effective only until the next restart of .

The parameters are specified by means of the parameter string Parameters. More than one parameter can be set at once. The parameters are to be specfied according to the following syntax:

PName = PValue,

where PName is the name of the parameter and PValue is the associated value. If more than one parameter is to be set, the individual parameter assignments have to be separated by semicolons:

PName1=PValue1; PName2=PValue2; PName3=PValue3;....

The following parameters are currently supported:

Name of parameter Type of value Explanation
ActionLogLevel integer Controls the level of action log: 0 = turn off action log; 1 = log commands only; 2 = log everything
ActionLogMaxSize integer Determines the maximum length of the action log file in kB. The valid range is between 100 and 20000.
AllowLdIvSpdcs boolean This option is for debug purposes only and should be turned off. If the option is activated the user may load invalid sets of spectral descriptors after confirming a warning message.
AlwaysUse32Bit boolean This option allows you to start in 32-bit mode regardless of the actual capabilities of . Please note that switching to the 32-bit mode requires a restart of . This option is always made permanent regardless of the parameter MakePermanent.
AutoReloadData boolean If this option is set automatically reloads the dataset used at last (which may take considerable time if you load big datasets). So for large datasets you could consider to switch off this option.
AutoDDWndList boolean If this option is turned on, the Open Windows Selector is opened when you move the mouse over the control (otherwise you have to click the control in order to open it).
BaseLineIv double This option defines the distances of the cursor lines in the Spectral Descriptor Editor. The valid range is between -100.0 and +100.0. Positive values are interpreted as percent of the length of the visible spectrum, negative values are interpreted as layer index values (using the absolute value of BaseLineIv).
CheckDataInt boolean This option allows to switch on/off check of the data integrity in order to speed up reading of large datasets.
CloseOnEscape boolean If this option is set TRUE you can close the form which has the focus by pressing the <ESC> key.
ColorGamma double Controls the magnitude of the logarithmic color scale transform. The vald range of this value is between 0.0 (no effect) and 1.0 (max. effect). See also Gamma of Log Color Scale in the preferences.
ColorLimitPerc double Defines the default color scale range in percentiles. The valid range is between 0.1 and 10.0. See the parameter Color Scale Range in the preferences for more.
ColorPartSel hex color Defines the color used to display selected regions in the particle detector. The color has to be specified as 24 bit hexadecimal number (blue, green, red)
ConfBandColor hex color Controls the color used to display confidence bands in mean spectra. The color has to be specified as 24 bit hexadecimal number (blue, green, red)
CSVSeparator integer Determines which separator is used or expected in CSV files:
1 ... blank
2 ... semicolon
3 ... comma
4 ... colon
5 ... tab
DBDir string Sets the database directory
DefaultCMap integer Controls the default color map according to the following key:
0 ... rainbow
1 ... black & white
2 ... cyclic rainbow
3 ... geographic map
4 ... high contrast
5 ... bipolar (red/blue)
6 ... fringes
7 ... black & yellow with threshold
8 ... class colors
9 ... user defined (see parameter UDefCMap)
10 ... morgenstemning (for impaired color vision)
In the case of a user defined color map (DefaultCMap = 9), you have to specify the parameter UDefCMap as well.
DefStkBlendMode integer The default blending mode used by the image stack. The valid range is between 0 and 11 and designates the following modes (see the section on the image stack for a detailed explanation):
0 ... opaque
1 ... mix
2 ... add
3 ... subtract
4 ... multiply
5 ... min
6 ... max
7 ... difference
8 ... exclusion
9 ... white mix
10 ... HSI fusion
11 ... Brovey transform
DefStkBlendWgt integer The default blending weight used by the image stack. The valid range is between 0 and 100.
DefMaskColor hex color Specifies the default color used to display masked areas in an image. The color has to be specified as 24 bit hexadecimal number (blue, green, red)
ExtCtrlFeedback boolean This option controls whether a status message is displayed in the case an external program tries to control by a faulty control script.
FilterMode integer Controls whether the search filter in certain windows performs either a simple substring search (FilterMode = 0) or a logical combination of several substring searches (FilterMode = 1). This option is always made permanent regardless of the parameter MakePermanent. See Filter Mode for Text Filters for details.
ImportMenu list of integer Specifies the list of available import menu commands. The individual commands in the list have to be separated by commas and are encoded as follows (invalid specifications are ignored):
1 ... Agilent Mass Hunter
2 ... Analyze 7.5
3 ... Applied Spectra LIBS
4 ... BIF 6 Format IONTOF
5 ... Bruker Aurora Elite LA-ICP/MS
6 ... Bruker Hyperion JCAMP/DX
7 ... CSV Flat File
8 ... CytoSpec CYT Format
9 ... Edax Genesis
10 ... Edax Team
11 ... ENVI Data File
12 ... FITS Data
13 ... Horiba LabSpec 6
14 ... IGTIF Format
15 ... ION-TOF TOF.SIMS
16 ... JASCO Text Files
17 ... JPG Photo
18 ... Laser Ablation ICP/MS Thermo iCAP q
19 ... Laser Ablation ICP/OES iCAP 6000
20 ... Lightigo LIBS Data
21 ... Matlab ImageLab File
22 ... Menlo Systems THz Image
23 ... Opus Data Point Table
24 ... Oxford Instruments EDS
25 ... Perkin Elmer XL Data
26 ... Recendt THz
27 ... Renishaw
28 ... siMPle Data
29 ... Specim IQ Raw Data
30 ... TIFF Image
31 ... Tokyo Intruments Nanofinder
32 ... TUW Stand-off Raman
33 ... Witec Alpha 300R+ Spectral Data
34 ... Witec Alpha 300R+ AFM Data
IndefiniteValue double Defines the value which is used to indicate an indefinite value.
MaxListRecOFiles integer Controls the maximum number of files listed in the Recently Used Files list. The valid range is between 5 and 100. Please note that any change comes into effect only after picking a file from this list.
MaxPCAEigVals integer Determines the upper limit of the number of PCA eigenvalues to which a PCA protocol is generated. The valid range is between 10 and 5000.
MaxPCAScores integer Determines the upper limit of the number of PCA scores to which a PCA protocol is generated. The valid range is between 50 and 100000.
MaxPkDynRange integer This setting limits the dynamic range of peak ratios of spectral descriptors. The valid range is between 10 and 10000.
MaxThreads integer Sets the number of CPU cores to be used in parallel. MaxThreads can assume one of the following values:
0 ... no multiprocessing
1 ... 2 cores
2 ... all but one core
3 ... all cores
MeanSpecRadius integer Controls the radius of the circular region for which an mean spectrum is displayed in the 2D Imager.
MinDistDupMark integer This parameter specifies the minimum distance (in pixels) required for two marks to be drawn as separate items (see Suppression of Duplicate Marks for details). The valid range is between 0 and 3 and is automatically limited to this range.
NoDataMaskColor hex color Controls the color of regions where no data is available. The color has to be specified as 24 bit hexadecimal number (blue, green, red)
PartEdAutoFocus boolean This option controls whether a selected particle in the Particle Editor is always kept visible during zooming by automatically shifting the displayed image.
PartEdClNameEdit boolean Controls whether the user can change the class names in the Particle Editor.
PercSampleSize integer The color scales of various plots are calibrated to the percentiles specified by the parameter Color Scale Range in the preferences. The calculation of percentiles can be time-consuming for large datasets. In order to avoid unnecessarily high computation times you can restrict the calculation of the percentiles to a random sample whose size is determined by this parameter. Hint: the lower the samling limit the faster is the calculation but the more the estimation of the percentiles will vary. A good compromise is about 50000 samples. ColorSampleSize is limited to a range between 1000 and 1000000.
PixelAspectRatio double Defines the aspect ratio the pixels of an image should have when displayed in any window. The valid range is from 0.01 to 100.0, setting this parameter to zero switches off the enforced aspect ratio (i.e. the pixels may assume any aspect ratio depending on the zoom state of the image)
PixMaskSampleThresh integer Limit at which sampling of masked pixels sets in to display masked pixels in the mask editor. The threshold above which resampling occurs can be set between 10000 and 5000000 pixels.
SampleLimit3D integer Controls the whether the data of a 3D surface plot is resampled before creating the plot. The threshold above which resampling occurs can be set between 2000 and 50000 pixels.
ScratchDir string Sets the scratch directory.
ScriptDir string Sets the script directory.
ScriptTemplate string Defines the script template. This template file has to be stored in the script directory. Note that this option is always made permanent, independent of MakePermanent
UDefCMap string Defines the name of the user-defined color map used as default color map. The specified color map file must be stored in the directory $WorkDir$\colormaps.
VidTimerLayers integer This controls the playback speed of the layer video in the 2D Imager. The value is in msec. Values less than 50 are automatically limited to 50.
VidTimerTSlots integer This controls the playback speed of the time slot video in the 2D Imager. The value is in msec. Values less than 50 are automatically limited to 50.
WorkDir string Sets the working directory.

The function returns the following error codes:

 0 ... OK, done
-1 ... unknown parameter
-2 ... invalid parameter value
-3 ... parameter string is too long
-4 ... missing assignment
-5 ... file/path does not exist
-6 ... one or more of the import parameters is invalid (warning only)

 

Example: The following statement sets the "close on <ESC> option" and switches off the checking of data integrity, the changes are not made permanent:
SetSystemParams (false, 'CloseOnEscape=true; CheckDataInt=false');