10.4. JOB Command Catalog. ORTEC A66-BW GammaVision

GammaVision

®

v7 (A66-BW) 783620H / 1013

10.4. JOB Command Catalog

ANALYZE [“spectrum filename”]

This analyzes the spectrum in the same manner as the menu commands. With no argument, the spectrum in the display (either the MCB or the buffer) is analyzed according to the settings in the Analyze/Settings/ Sample Type... dialog. With a spectrum filename as argument, the spectrum on disk is analyzed according to the settings in the spectrum file. The filename can include any of the variables shown in Section 10.2.

To change the settings used in an analysis, load the spectrum into the buffer using the

RECALL command, recall the new settings using the RECALL_SETTINGS command, then

ANALYZE the spectrum in memory (no filename).

The

.JOB

file does not wait until the analysis is complete before proceeding to the next command, however the results will be automatically output according to the settings (printed, file or program) when the analysis is complete. To force the JOB to wait until the analysis is complete, put a WAIT “

WAN32.EXE

” command after the ANALYZE command.

The JOB command might exit after the ANALYZE command, but the QUIT command should not be used because the results will not be printed if GammaVision is not running.

ASK_CALIBRATION

This asks for the name of a file containing the calibration to be used as the internal calibration. After entering the filename, the file is read and the calibration is loaded.

ASK_COLLECTION

This asks for the date and time for the decay correction. It is the same as the date and time entry in the Acquire/Acquisition Settings... dialog. If any Ask on Start options are marked, the START command in the

.JOB

file will also open this dialog.

ASK_CONFIRM <“text”>

This opens a dialog showing the text, and waits until you click OK.

394

783620H / 1013 10. JOB FILES

ASK_DESCRIPTION

This asks for the sample description to be put in the spectrum file and on the report. It is the same as the sample description entry in the Acquire/Acquisition Settings... dialog and the sample description entry in the File/Settings... menu. If the Ask on Start option is marked, the START command in the

.JOB

file will also open this dialog. If the Ask on Save option is marked, the SAVE command in the

.JOB

file will also open this dialog.

ASK_GAMMATOTAL

This command opens the Gamma Total/EDF Report dialog as shown in Fig. 301 (see also

Section 5.5.1.9).

Fig. 301. ASK_GAMMATOTAL Dialog.

NOTES

Individual parameters can be set in JOB files using the SET_SETTING or SET_OPTIONS commands. The following parameters are stored in the

.SDF

file and are loaded when an

.SDF

file is recalled:

GammaTotalReportingEnabled

GammaTotalGermaniumReportingEnabled

395

GammaVision

®

v7 (A66-BW) 783620H / 1013

GammaTotalCalculationEnabled

GammaTotalEDFTableOnlyEnabled

GammaTotalReportIsoMdaOnReportsEnabled

GammaTotalCountBackgroundEnabled

GammaTotalCountCesiumEnabled

GammaTotalWriteBackgroundReportEnabled

GammaTotalWriteMaintenanceReportEnabled

GammaTotalAnalysisStartChannel

GammaTotalAnalysisEndChannel

GammaTotalUseRangeForBackgroundQAEnabled

GammaTotalBackgroundSpectrumPath

GammaTotalCesiumSpectrumPath

GammaTotalGeometryFilePath

ASK_LIBRARY

This asks for the name of the library to be used as the internal library. After entering the filename, the library file is loaded.

ASK_ONLYEFFICIENCY

Displays a dialog (Fig. 302) that asks for a calibration file. Once a file is selected, the command loads the Efficiency calibration but does not load the Energy or FWHM calibration. If you click Cancel, the JOB terminates with JOB Error 15 (Problem with Ask).

ASK_ONLYENERGY

Displays a dialog (Fig. 303) that asks for a calibration file. Once a file is selected, the command loads the energy calibration but does not load the FWHM calibration. If you click

Cancel, the JOB terminates with JOB Error 15 (Problem with Ask).

Fig. 302. ASK_ONLYEFFICNCY Dialog.

Fig. 303. ASK_ONLYENERGY Dialog.

ASK_ONLYFWHM

Displays a dialog (Fig. 304) that asks for a calibration file. Once a file is selected, the command loads the FWHM calibration but does not load the Energy calibration. If you click

Cancel, the JOB terminates with JOB Error 15 (Problem with Ask).

396

783620H / 1013 10. JOB FILES

Fig. 304. ASK_ONLYFWHM Dialog.

ASK_OPERATOR

Asks for the operator’s name to be put in the spectrum file and on the report. It is also stored in the Registry.

ASK_OPTIONS

Asks for the

.SDF

(Sample Description File) filename of the analysis options. The

.SDF

file is created in the Analyze/Settings/Sample Type... dialog. It is the same as the sample type entry in the Acquire/Acquisition Settings... dialog. If Ask on Start is marked, the START command in the

.JOB

file will also open this dialog.

ASK_PASSWORD

Used to define the password to be used in the

.JOB

file. This command can be to lock an unlocked detector, unlock and use one that is locked, or lock one for the duration of the job and then unlock it. The actual lock/unlock is done with LOCK and UNLOCK, respectively.

This command is to set the internal password variable,

$(Password)

, to the user input so the password will be available for use in the JOB. The

$(Owner)

variable is only used when locking detectors. Following is an example:

.

.

.

.

ASK_PASSWORD

LOCK “Password”,”Owner”

ASK_PBC

Asks for the name of the peak background correction to be used. After entering the filename, the Peak Background Correction file is loaded.

ASK_PRESET

Asks for the presets to be set in the Detector. It is the same as the preset entry in the Acquire/

Acquisition Settings... dialog. If Ask on Start is marked, the START command in the

.JOB

file will also open this dialog.

397

GammaVision

®

v7 (A66-BW) 783620H / 1013

ASK_SPECTRUM

Asks for the spectrum filename to be used in the next and subsequent SAVE and RECALL commands. See SAVE command below. This is stored in the variables

$(FullPath)

,

$(FullBase)

,

$(FileExt)

, and

$(FileDir)

.

ASK_VARIABLE “VarName”, “Label”, “Format”, “FileExtension”

This command displays a dialog box that asks for the JOB variable value. The arguments to this command are as follows:

VarName

The variable name can be up to 32 characters long. If the variable does not exist in the list of defined variables, a new one is created. This field is required.

Label

Format

This optional field is used to provide a text prompt for data entry.

If omitted, the label used is “Enter Value:”

This optional field describes the variable type. Valid Format values are: “Integer”, “Float”, “String”, “Date”, and “Path”.

Based on this value, the value is checked for the specified type.

If omitted, the Format used is “String”.

FileExtension

This value describes the default file extension used for the “Path” format. A browse button is enabled so the user can select an existing file. If this field is omitted, the FileExtension used is

“*.” (i.e., all file types).

Figures 305 through 309 illustrate the ASK_VARIABLE dialogs for the different Format options. If you click OK to close the dialog without entering a value, an error message is displayed and you are prompted to select a value before closing the dialog. If you click

Cancel, the JOB terminates with JOB Error 15 (Problem with Ask).

Fig. 305. ASK_VARIABLE Integer Format.

398

Fig. 306. ASK_VARIABLE Float Format.

783620H / 1013 10. JOB FILES

Fig. 307. ASK_VARIABLE String Format.

Fig. 308. ASK_VARIABLE Date Format.

Fig. 309. ASK_VARIABLE Path Format.

ASK_WEIGHT

ASK_WEIGHT prompts for the sample size or weight to be stored in the spectrum file and used in the analysis (the units are specified in the Sample Defaults File). In addition, it includes an optional 1-sigma sample size uncertainty (+/-) field, which accepts values from

0% to 1000%. This is the same as the sample size entry in the Acquire/Acquisition Set-

tings... and File/Settings... dialogs. If Ask on Start is marked, the START command in the

.JOB

file will also open this dialog. If Ask on Save is marked, the SAVE command in the

.JOB

file will also open this dialog.

BEEP <freq>,<duration>

In PCs without a sound card, this produces an audible tone at a pitch of <freq> hertz lasting for <duration> milliseconds. Overridden (disabled) if PC has a sound card.

BEEP ID

A numerical ID is given based on a desired system event. For example, BEEP 7 will generate the “Exit Windows” sound, if one has been designated.

ID Event

0 Beep Speaker

1 Default Beep

2 Start Windows

399

GammaVision

®

v7 (A66-BW) 783620H / 1013

3 Asterisk

4 Exclamation

5 Critical Stop

6 Question

7 Exit Windows

BEEP “String”

String can be a

.WAV

file or any event defined in the Registry.

CALIBRATE_AUTO

This executes the automatic energy calibration on the active spectrum with the working library.

CALIBRATE_EFFICIENCY “file.eft”

Performs an efficiency calibration using the active spectrum and the data in file.eft

. The filename can include any of the variables defined in Section 10.2.

CALIBRATE_ENERGY “file.ent”

Performs an energy calibration using the active spectrum and the data in file.ent

. The filename can include any of the variables defined in Section 10.2. This performs the same function as the Merge button on the Energy Calibration Sidebar (see Section 5.3.2.4).

CALL “file.job”

Executes another

.JOB

file as a subroutine. The filename can include any of the variables defined in Section 10.2.

CHANGE_SAMPLE

This is used to control the CHANGE SAMPLE output and SAMPLE READY input BNC signals on the rear panel of most MCBs, and is intended to initiate a hardware handshake sequence for advancing a sample changer. The SET_OUTPUT_HIGH command is sent to the currently selected Detector, then the sample-ready status is monitored (for at least

120 seconds) until the input is low, then finally the SET_OUTPUT_LOW command is sent and input is monitored until it returns to the high level again before proceeding.

Note that if the sample changer controls are not able to make the SAMPLE READY input go high very soon after the CHANGE SAMPLE signal is set (i.e., the normal state of the

SAMPLE READY is low; it is expected to go high immediately after the CHANGE

SAMPLE condition is set and remain high while the sample changer is moving, and returns to low when the sample changer is at its new position), then it might be necessary to use the

SEND_MESSAGE command to send a SET_OUTPUT_HIGH command, then pause (with

400

783620H / 1013 10. JOB FILES

WAIT or some other time-consuming command), and then send the CHANGE_SAMPLE command. The following example demonstrates this:

SET_DETECTOR 1

LOOP 5

CLEAR

START

WAIT

FILL_BUFFER

SEND_MESSAGE “SET_OUTPUT_HIGH”

SET_DETECTOR 0

SAVE “MONTE???.CHN”

SET_DETECTOR 1

CHANGE_SAMPLE

END_LOOP

CLEAR

This clears (erases) the data, the real time and the live time for the selected Detector. The presets are not changed. This command has the same function as the CLEAR function under the ACQUIRE menu. The command would logically be preceded by the SET_DETECTOR commands as follows:

.

.

.

.

SET_DETECTOR 1

CLEAR

CLOSEBUFFERS

Closes all buffer windows.

CLOSEMCBS

Closes all Open Detector windows.

CLOSEWINDOW

Closes the active window if multiple windows are open. This command has no effect if there is only one open window.

CREATEPBC “file.ufo” , “file.pbc”

Generates a

.PBC

file when given a

.UFO

file as input. This is the same as the Create PBC... command under the Analyze/Settings/Peak Background Correction submenu.

401

GammaVision

®

v7 (A66-BW) 783620H / 1013

DESCRIBE_SAMPLE “description”

Accepts a 63-character description of the sample being analyzed. This description is saved with the spectrum using the SAVE command function, and is included in the REPORT printout. Same function as the Sample Description function under the Services menu.

The loop count value can be included in any text by typing three question marks in the text where the loop count is to be inserted. The loop count replaces “???” with three characters wherever it appears.

END_LOOP — see LOOP

EXPORT “filename”

This executes the Export function with the filename specified. The remainder of the options are defined on the Export tab under File/Settings.... The filename can include any of the variables defined in Section 10.2.

FILL_BUFFER

This transfers the active Detector data to the buffer. This command has the same function as

Copy to Buffer under Acquire.

IMPORT “filename”

This executes the Import function with the filename specified. The remainder of the options are defined on the Import tab under File/Settings. The filename can include any of the variables defined in Section 10.2.

LOAD_LIBRARY “filename.extension”

This loads the nuclide library specified, and duplicates the function of Select File under the

Library menu. The filename can include any of the variables defined in Section 10.2.

LOAD_PBC “name.pbc”

This loads the Peak Background Correction specified, and duplicates the function of Select

PBC... under Analyze/Settings/Peak Background Correction. The filename can include any of the variables defined in Section 10.2.

LOCK “Pwd” [,”Name”]

This locks the current Detector using “Pwd” as the password. If the optional “Name” parameter is missing, the Locked name defaults to “Job”.

This password is retained in the

.JOB

file and used with any

.JOB

commands so that the user does not need to re-enter the password.

402

783620H / 1013 10. JOB FILES

LOOP <repetitions> ... END_LOOP

This pair executes multiple times all the commands between LOOP and END_LOOP. The number of execution times is specified by <repetitions>. Each command must be given on a separate line. A value of 0 executes once. A LOOP with no END_LOOP statement executes once.

The loop count value can be included in any text by typing three question marks in the text where the loop count is to be inserted. The loop count replaces “???” with three characters using leading zeros if necessary.

The loop variables,

$(Loop)

and

$(LOOP1)

, can be included in any text. The loop count will be inserted with leading zeros suppressed.

The following is an example:

SET_DETECTOR 1

SET_PRESET_LIVE 20

LOOP 3

SET_DETECTOR 1

CLEAR

START

WAIT

FILL_BUFFER

SET_DETECTOR 0

SAVE “TEST???.CHN”

END_LOOP

The above commands run three 20-second acquisitions and store the data on a disk in

TEST001.CHN

,

TEST002.CHN

, and

TEST003.CHN

.

If the SAVE command is replaced with SAVE “

TEST$(Loop).CHN

,” then the following files will be saved:

TEST0.CHN

,

TEST1.CHN

, and

TEST2.CHN

.

See also Section 10.1.1.1.

LOOP SPECTRA...END_LOOP

This executes the commands within the loop once for each spectrum stored in the Detector hardware. This command only works for hardware that supports Field Mode.

MARK_PEAKS

This command performs a Mariscotti-type peak search on the spectrum in the currently selected Detector or buffer window (see Analyze/Peak Search, Section 5.5.2, which performs the same function). The peak search sensitivity is chosen on the System tab under

403

GammaVision

®

v7 (A66-BW) 783620H / 1013

Analyze/Settings/ Sample Type... (page 152). Each peak found is marked with an ROI. If a calibration is loaded in the selected window, the width of the ROI is three times the calculated FWHM of the peak. If no calibration is loaded in the selected window, the width of the

ROI equals the width of the peak as determined by the peak search function. Overlapping or close peaks might have contiguous ROIs. Existing ROIs are not cleared, therefore, you might wish to clear them before issuing this command.

The following is an example of the MARK_PEAKS command used with REPORT:

.

.

.

MARK_PEAKS

REPORT “TESTDAT.RPT”

.

The above procedure performs a peak-search, then writes to disk an ROI Report for the peaks found.

QABACKGROUND

This executes the background QA test without displaying prompts or violations.

QASAMPLE

This executes the sample QA test without displaying prompts or violations.

QUIT

This unconditionally terminates the GammaVision program and returns control to Windows.

RECALL “file.chn” or “file.spc”

This reads a disk filename to the buffer. The disk file must be in the format created by SAVE.

Any DOS filename, including the drive and subdirectory, can be used. The resultant horizontal size of the buffer is the same as the file. If the spectrum file has calibration information, the calibration parameters in the spectrum file are used to set the calibration for the buffer.

This command has the same function as Recall... under the File menu.

The loop count value can be included in the above filename, as in any text, by typing three question marks in the text where the loop count is to be inserted. The loop count replaces

“???” wherever they appear. The filename can include any of the variables defined in

Section 10.2.

404

783620H / 1013 10. JOB FILES

RECALL_CALIB “file “

This loads both the energy and efficiency calibration data from the specified file to the calibration data for the selected Detector. If the file is a pure calibration file (

.CLB

), then all the information, including any energy or efficiency tables, are replaced in the selected spectrum data memory. If the file is a spectrum data type file

.CHN

, only the calibration parameters from the calibration data stored with a spectrum are loaded.

The filename can include any of the variables defined in Section 10.2.

This command can be used in generating reports that include library nuclide identification.

The following is an example:

.

.

RECALL_CALIB “CALIB001.clb”

MARK_PEAKS

.

.

REPORT “NEWDATA.RPT”

The report

NEWDATA.RPT

includes nuclide identification using the energy calibration contained in

CALIB001.clb.

RECALL_EFFICIENCY “file “

This loads the efficiency calibration data from the specified file to the calibration data for the selected Detector. If the file is a pure calibration file (

.CLB

), then all the information, including any efficiency tables, are replaced in the selected spectrum data memory. The filename can include any of the variables defined in Section 10.2.

RECALL_ENERGY “file “

This loads the energy calibration data from the specified file to the calibration data for the selected Detector. If the file is a pure calibration file (

.CLB

), then all the information, including any energy tables, are replaced in the selected spectrum data memory. If the file is a spectrum data type file

.CHN

, only the calibration parameters from the calibration data stored with a spectrum are loaded. The filename can include any of the variables defined in

Section 10.2.

RECALL_ONLYEFFICIENCY “File”

Recall efficiency calibration only, where “File” can be any GammaVision file that contains a valid efficiency calibration. This command is identical to the RECALL_ EFFICIENCY command and is provided for consistent naming.

405

GammaVision

®

v7 (A66-BW) 783620H / 1013

RECALL_ONLYENERGY “File”

Recall energy calibration only, where “File” can be any GammaVision file that contains a valid energy calibration. This command does not recall the FWHM calibration from the file.

RECALL_ONLYFWHM “File”

Recall FWHM calibration only, where “File” can be any GammaVision file that contains a valid energy calibration. This command does not recall the energy calibration from the file.

RECALL_OPTIONS “file.sdf”

This loads the acquisition and analysis parameters into the working set for the selected

Detector or buffer. This is the same as recalling a

.SDF

file in the Analyze/Settings/Sample

Type... type menu. The filename can include any of the variables defined in Section 10.2.

RECALL_ROI “file.roi”

This marks the ROI channels in the selected data memory or Detector to conform to the table in the disk file, which can be an

.ROI

,

.UFO

,

.SPC

, or

.LIB

file. The data contents of the Detector or buffer are not altered by this operation. The previous ROIs are cleared. The filename can include any of the variables defined in Section 10.2.

This command has the same function as Recall File... under ROI.

This command can be used in generating reports that look for specific nuclides (librarydirected as opposed to peak-search-directed). For example, a calibration spectrum is run containing

57

Co and

137

Cs, and ROIs marked on the 122 keV and 662 keV peaks.

The calibration is saved as spectrum file

COBCS.CHN

and as

.ROI

file

COBCS.ROI

. The command sequence is:

.

.

RECALL_CALIB “COBCS.CHN”

RECALL_ROI “COBCS.ROI”

.

.

REPORT “COBCS.RPT”

These commands report the values only for the 122 keV and 662 keV peaks. Compare with the example for MARK_PEAKS.

As usual, the loop count value can be included in any text by typing three question marks in the text where the loop count is to be inserted.

406

783620H / 1013 10. JOB FILES

REM [Text]

This line is a comment (remark) and is ignored during command processing. The REM command allows entering descriptive comments into script files or disabling commands during testing of scripts.

REPORT “filename”

This command will produce a list of areas, activities, and peak shapes for all the ROIs marked in the spectrum. See Analyze/ROI Report (Section 5.5.3) for more information on the report format and contents. The ROI data will be presented in either columns or paragraphs, according to the format most recently selected in the ROI Report dialog (therefore, you can choose a format before executing the JOB file). If you do not specify a filename, the report will be sent to the default Windows printer for this PC. If you specify a filename, the report will be sent to an ASCII text file that can be used by other programs or printed later. The loop count value can be included in the filename by typing three question marks in the text where the loop count is to be inserted. The loop count replaces “???” in the filename. The filename can include any of the variables defined in Section 10.2.

RUN “program”

This executes an application named “program.” This is typically an

.EXE

filename. Note that the program will not run to completion before returning to GammaVision, unless it is run at higher priority or the WAIT command is used. The filename can include any of the variables defined in Section 10.2. Any arguments to the program can be included in the quotation marks.

RUN_MINIMIZED “program”

Same as the RUN command above, except that the application is run initially as an icon

(minimized), rather than as a normal window.

SAVE “[d:][\path\]file[.spc]” [,n]

This saves the active Detector or the selected data memory in a disk file. It has the same function as Save As... under the File menu. The file type is determined in the File/Settings... dialog. The disk filename (in quotation marks) can be any valid DOS filename; the drive [d:], path [\path\] and extension [.spc] are optional. If an extension is not supplied, the default extension is automatically determined by the file settings selection. Also, the current drive and directory are used by default when the optional path specification is not supplied. The loop count value can be included in the filename by typing three question marks in the text where the loop count is to be inserted. The loop count replaces “???” wherever it appears.

The filename can include any of the variables defined in Section 10.2.

The optional argument n specifies the spectrum number to save for a

.CHN

or

.SPE

file. For the DSPEC Plus in ZDT mode zero, a value of zero will switch the display to the normal

407

GammaVision

®

v7 (A66-BW) 783620H / 1013

spectrum before the data is saved and a value of 1 will switch the spectrum to the ZDT spectrum before the save. For the DSPEC Plus in ZDT mode one, a value of 1 will switch the display to the ZDT spectrum before the data is saved and a value of zero will switch the spectrum to the Error spectrum before the save. This parameter is ignored if the DSPEC Plus is not in ZDT mode. This parameter is not used when saving data to an

.SPC

file since both spectra are automatically saved.

The Ask on Save questions as defined in File/Settings... will be asked each time a SAVE command is executed. This will stop execution of the

.JOB

file until the question is answered.

Note that if you Cancel an ask-on-save prompt, the JOB will terminate. As with the File/Save

As function, the real time, live time, start of acquisition, and, if available, calibration data, detector description, and sample description are stored with the spectrum.

If the ASK_SPECTRUM command has been executed in this

.JOB

file prior to this SAVE command, the filename is stored in

$(FullPath)

.

SAVE_CALIBRATION “[d:][\path\]file[.clb]”

Saves the current working energy and efficiency calibrations to a

.CLB

file. It has the same function as Save Calibration... under the Calibrate menu. The contents of the spectrum are not altered by this operation. The disk filename (in quotation marks) can be any valid filename, with optional elements as described for the SAVE command, above. The default extension is

.CLB

. The loop count value can be included in the filename by typing three question marks in the text where the loop count is to be inserted. The loop count replaces “???” wherever it appears. The filename can include any of the variables defined in Section 10.2.

SAVE_ROI “[d:][\path\]file[.roi]”

Saves a table of channel numbers that have the ROI set for the active Detector or selected data memory in a disk file. It has the same function as Save File... under the ROI menu. The contents of the spectrum are not altered by this operation. The disk filename (in quotation marks) can be any valid filename, with optional elements as described for the SAVE command, above. The default extension is

.ROI

. The loop count value can be included in the filename by typing three question marks in the text where the loop count is to be inserted. The loop count replaces “???” wherever it appears. The filename can include any of the variables defined in Section 10.2.

SAVE_SPCIMAGE “ImageFile”, “Type”, “SettingsFile”

Saves the currently displayed histogram to the specified “ImageFile” in either

.BMP

or

.JPG

format. The optional argument “Type” may be either “Jpg” or “Bmp”. If this argument is missing, the image format defaults to “Bmp” format. Additionally, a GVPlot settings file

(created in GVPlot with the File/Save Settings As... command) can also be passed in as an argument.

408

783620H / 1013 10. JOB FILES

SEND_MESSAGE “command”

This is used to send MCB hardware commands to the active Detector. This can be used to perform any operations of the Detector that are desired. The text must be in the syntax expected by the Detector. If the response from the Detector does not end with a commandaccepted message, then this command will exit with error.

Specific Detector commands and syntax are described in the technical manual associated with each specific Detector.

The following is an example of using this command to set the fine and coarse gain to a total value of 50 (the product of the fine [= 0.5] and coarse [= 100] gains):

.

.

SET_DETECTOR 1

STOP

CLEAR

SEND_MESSAGE “SET_GAIN_FINE 2048"

.

SEND_MESSAGE “SET_GAIN_COARSE 100"

.

SET_BUFFER

This selects the buffer. It is the same as SET_DETECTOR 0.

SET_DETECTOR <number>

This selects the active Detector or the buffer. The Detector number can be 1 to 999 according to the Detector configuration, or 0 for the buffer. Also, SET_DETECTOR without an argument is used to switch to the previously selected Detector. If a Detector is selected that does not exist, no change is made. The Detector number is the number shown on the toolbar and the Detector pick list.

The JOB processor expects one or more numerals as the argument to this command, entered with or without quotation marks (e.g., you can enter the numerals 1000 or the string “1000").

The JOB processor will also accept the loop counter as an argument to the function as long as

it is set in quotation marks. For example, you could use “$(loop1)” to sequence through the detector list, provided the detector list is in numerical sequence.

This command (for values 1 to 12) has the same function as <Ctrl+ F1> through

<Ctrl+ F12>. For value 0 or no argument at all, it duplicates the Detector/Buffer toggle under the Display menu, <F4>, and <Alt+ 6>.

See also the notes on SET_DETECTOR and the new GammaVision multi-detector interface in Section 10.1.1.4.

409

GammaVision

®

v7 (A66-BW) 783620H / 1013

SET_LIST

Switches the currently selected Detector from PHA mode to LIST mode.

SET_NAME_STRIP “file.chn”

This can be used before STRIP to select a disk filename to be used subsequently by the

STRIP command. (It is not necessary to use this command, because the filename can be supplied as part of the STRIP command itself; however, the command is included for backward compatibility.) No other action is taken by this command. The filename can include any of the variables defined in Section 10.2.

SET_OPTIONS “OptionsFile”, “SdfFile”

This command creates “SdfFile” based on the options specified in “OptionsFile”. The

OptionsFile is a text file composed of single settings as defined in the SET_SETTINGS JOB command. An example file is shown in Fig. 310.

Fig. 310. SET_OPTIONS Options file.

NOTES

! An invalid parameter name, data type, or file structure will generate an error and terminate the job.

410

783620H / 1013 10. JOB FILES

! A single quote character at the start of a line indicates that the line is a comment, and the line is not parsed for Parameter/Data pairs.

! A blank line will terminate the parsing process, so the single quote character should be used if white space is desired to improve readability of the file content.

! The

.SDF

file does not store the following SET_SETTINGS parameters, so they cannot be included in the Options File.

Keyword

Operator

Laboratory

GammaTotalGammaTotalSequence

GammaTotalGermaniumSequence

GammaTotalReportDirectory

GammaTotalGermaniumReportDirectory

Storage Location

Stored in the Registry

Stored in the Registry

Stored in the Context File

Stored in the Context File

Stored in the Registry

Stored in the Registry

The following additional parameters can be used to set the Presets in the

.SDF

file, and they will be applied to the hardware when the

.SDF

file is loaded into GammaVision.

RealTimePreset Float in seconds

LiveTimePreset

ROIPeakPreset

ROIIntegralPreset

Float in seconds

Integer

Integer

UncertaintyPresetPercent

UncertaintyPresetStartChannel

UncertaintyPresetWidth

Float in percent

Integer

Integer

Note that presets can also be modified when the Job is running by using the following

GammaVision Job commands in lieu of saving presets to an

.SDF

file.

SET_PRESET_CLEAR

SET_PRESET_REAL

SET_PRESET_LIVE

SET_PRESET_COUNT

SET_PRESET_INTEGRAL

SET_PRESET_UNCERTAINTY

SET_PHA

Switches the currently selected Detector from LIST mode to PHA mode.

411

GammaVision

®

v7 (A66-BW) 783620H / 1013

SET_PRESET_CLEAR

This clears the presets for the active Detector. The clearing should be done to ensure that unwanted presets are not used by the Detector when the Detector is started.

NOTE

For the Models 916/17/18 Detectors, the new presets (including CLEAR) can be loaded at any time, but are not put into effect until the Detector goes from STOP to

START. For most other MCBs, the presets can only be changed when the unit is not counting.

The Detector should be selected by the SET_DETECTOR commands before the

SET_PRESET_CLEAR command is given, as in the following:

.

.

SET_DETECTOR 1

STOP

.

.

SET_PRESET_CLEAR

START

SET_PRESET_COUNT <counts>

This sets the ROI peak count preset for the active Detector. The preset is set to the entered value. With this preset condition, the Detector stops counting when any ROI channel’s content reaches this value. If no ROIs are marked in the Detector, then that Detector never meets this condition. This command has the same function as the ROI Peak Count field on the Presets tab under Acquire/MCB Properties... (Section 5.2.11); refer to the discussion describing that dialog for additional information.

The JOB processor expects one or more numerals as the argument to this command, entered with or without quotation marks (e.g., you can enter the numerals 1000 or the string “1000").

The JOB processor will also accept the loop counter as an argument to the function as long as

it is set in quotation marks. For example, you could use the loop counter to collect a series of spectra with increasing ROI peak counts by appending zeroes to the loop counter to obtain

1000 counts, then 2000, and so on.

SET_PRESET_INTEGRAL <counts>

This sets the ROI Integral Count preset value for the active Detector. The preset is set to the entered value. With this preset condition, the Detector stops counting when the sum of all counts in all channels marked with an ROI reaches this limit. If no ROIs are marked in the

Detector, then that Detector never meets this condition. This command has the same function as the ROI Integral field on the Presets tab under Acquire/MCB Properties...

(Section 5.2.11); refer to the discussion describing that dialog for additional information.

412

783620H / 1013 10. JOB FILES

The JOB processor expects one or more numerals as the argument to this command, entered with or without quotation marks (e.g., you can enter the numerals 1000 or the string “1000").

The JOB processor will also accept the loop counter as an argument to the function as long as

it is set in quotation marks. For example, you could use the loop counter to collect a series of spectra with increasing ROI integral counts by appending zeroes to the loop counter to obtain

1000 counts, then 2000, and so on.

SET_PRESET_LIVE <seconds>

This sets the live-time preset for the active Detector. The preset is set to the entered value.

With this condition, the Detector stops counting when the live time reaches this limit. The live time is the real time minus the dead time. This command has the same function as the

Live Time field on the Presets tab under Acquire/MCB Properties... (Section 5.2.11); refer to the discussion describing that dialog for additional information.

The JOB processor expects one or more numerals as the argument to this command, entered with or without quotation marks (e.g., you can enter the numerals 1000 or the string “1000").

The JOB processor will also accept the loop counter as an argument to the function as long as

it is set in quotation marks. For example, you could use the loop counter to collect a series of spectra with increasing live times by appending zeroes to the loop counter to obtain 1000 seconds, then 2000, and so on.

SET_PRESET_REAL <seconds>

This sets the real-time preset for the active Detector. The preset is set to the entered value.

With this preset condition, the Detector stops counting when the real time reaches this limit.

This command has the same function as the Real Time field on the Presets tab under

Acquire/MCB Properties... (Section 5.2.11); refer to the discussion describing that dialog for additional information.

The JOB processor expects one or more numerals as the argument to this command, entered with or without quotation marks (e.g., you can enter the numerals 1000 or the string “1000").

The JOB processor will also accept the loop counter as an argument to the function as long as

it is set in quotation marks. For example, you could use the loop counter to collect a series of spectra with increasing real times by appending zeroes to the loop counter to obtain 1000 seconds, then 2000, and so on.

SET_PRESET_UNCERTAINTY <limit>,<low chan>,<high chan>

This sets the statistical preset to the uncertainty based on the counts in the region between the low and high channels. Not supported by all MCBs. See Section 4.2.1.1 for details on the calculation. The low channel must be greater than 1 and the high channel must be greater than the low channel plus 7.

413

GammaVision

®

v7 (A66-BW) 783620H / 1013

SET_RANGE “M/dd/yyyy”, “hh:mm:ss”, <t>

SET_RANGE “r”, “t”

Displays a time slice of data from a

.LIS

file that has been recalled into a buffer.

SET_SETTING “Setting”, “Value”

This command updates the analysis setting described by “Setting” to the value specified by

“Value”. Formatting for the Setting / Value combinations are shown below:

Setting

AnalysisStartChannel

AnalysisEndChannel

RandomSummingFactor

BackgroundTypeOption

InternalLibraryEnabled

LibraryFilePath

InternalCalibrationEnabled

CalibrationFilePath

Laboratory

Operator

MDAMethod

PeakSearchSensitivityOption

MatchWidth

Description

Starting channel number

Ending channel number

Floating point value allowed

0 = Auto, 1 = 1Pt, 3 = 3Pt, 5 = 5pt

1 = Yes, Anything else = No

Library pathname

1 = Yes, Anything else = No

Calibration override pathname

Laboratory name

Operator name

1 = Traditional ORTEC

2 = Critical Level ORTEC

3 = Suppress Output

4 = KTA Rule

5 = Japan 2-Sigma Limit

6 = Japan 3-Sigma Limit

7 = Currie Limit

8 = RISO MDA

9 = LLD ORTEC

10 = Peak Area

11 = Air Monitor – GIMRAD

12 = Reg. Guide 4.16 Method

13 = Counting Lab USA

14 = DIN 25 482.5

Erkennungsgrenze

15 = DIN 25 482.5 Nachweisgrenze

16 = EDF – France

17 = Nureg 0472

18 = ISO Decision Threshold (CL)

19 = ISO Detection Limit (MDA)

1, 2, 3, 4, or 5

Floating point (0.4 to 1.0)

414

783620H / 1013

FractionLimit

ActivityuCi

ActivityUnits

ActivityMultiplier

ActivityDivisor

SampleQuantity

SampleQuantityUnits

SampleQuantityUncertainty

DecayToCollectionEnabled

DecayDDuringAcquisitionEnabled

DecayDuringCollectionEnabled

DecayToDate

CollectionStartDate

CollectionEndDate

ReportUnknownPeaksEnabled

ReportLibraryPeakListEnabled

ReportLibraryPeakMatrixEnabled

ReportNuclideAbundanceEnabled

ReportIsoNormEnabled

UncertaintyPercentOption

UncertaintyCountingOption

UncertaintyConfidenceLevelOption

DisplayAnalysisResultsEnabled

ReportOutputOption

ReportFilePath

ReportProgramPath

10. JOB FILES

Floating point in percent library

1 = uCi, Anything else = Bq

Sample Activity Units descriptor

Sample amount multiplier

Sample amount divisor

Sample amount

Sample amount units

Sample amount uncertainty in percent

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

Date Time “YYYY-MM-DD

HH:MM:SS”

Date Time “YYYY-MM-DD

HH:MM:SS”

Date Time “YYYY-MM-DD

HH:MM:SS”

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Percent, Anything else =

Activity

1 = Counting, Anything else =

Total

1 = 1-Sigma, 2 = 2-Sigma, 3 = 3-

Sigma

1 = Yes, Anything else = No

1 = Printer, 2 = File, 3 = Program,

4 = Report Writer

File pathname

Program pathname

415

GammaVision

®

v7 (A66-BW) 783620H / 1013

ReportWriterTemplatePath Template pathname

AnalysisEngine ‘WAN32', ‘GAM32', ‘NPP32',

‘ENV32' or ‘ROI32', or userdefined name

NOTES

For GAM32 and ROI32, Directed Fit, Library Based peak stripping, and Manual Based peak stripping are disabled.

For NPP32 and ENV32, Library Based peak stripping is enabled and Manual Based peak stripping is disabled.

AdditionalRandomError

AdditionalSystemicError

LibraryPeakStrippingEnabled

ManualPeakStrippingEnabled

SecondLibraryPath

ThirdLibraryPath

PeakCutoff

TCCEnabled

DirectedFitEnabled

PBCEnabled

PBCInternalEnabled

PBCByEnergyEnabled

PBCFilePath

PBCMatchWidth

GEOEnabled

GEOInternalEnabled

GEOFilePath

ATTEnabled

ATTInternalEnabled

ATTFromFilePath

ATTFromDatabaseEnabled

ATTMaterial

ATTConfigurationOption

ATTLength

Random error in percent

Systemic error in percent

1 = Yes, Anything else = No

1 = Yes, Anything else = No

Pathname to second library

Pathname to third library

Peak cutoff in percent

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

Full pathname to the PBC file

Positive floating point number

1 = Yes, Anything else = No

1 = Yes, Anything else = No

Full pathname to the Geometry file

1 = Yes, Anything else = No

1 = Yes, Anything else = No

Full pathname to ATT file

1 = Yes, Anything else = No

Material name

1 = Linear, Anything else = Mass

Length or Mass

416

783620H / 1013 10. JOB FILES

ATTTypeOption

AvgEnergyEnabled

AvgEnergyInternalEnabled

AvgEnergyFilePath

IEQEnabled

IEQInternalEnabled

IEQFilePath

1 = Internal, Anything else =

External

1 = Yes, Anything else = No

1 = Yes, Anything else = No

Full pathname to the .EBR file

1 = Yes, Anything else = No

1 = Yes, Anything else = No

Full pathname to the .IEQ file

DACEnabled

DACInternalEnabled

DACFilePath

1 = Yes, Anything else = No

1 = Yes, Anything else = No

Full pathname to the .DAC file

GammaTotalReportingEnabled

GammaTotalGermaniumReportingEnabled

GammaTotalCalculationEnabled

GammaTotalEDFTableOnlyEnabled

GammaTotalReportIsoMdaOnReportsEnabled

GammaTotalCountBackgroundEnabled

GammaTotalCountCesiumEnabled

GammaTotalWriteBackgroundReportEnabled

GammaTotalWriteMaintenanceReportEnabled

GammaTotalSequence

GammaTotalGermaniumSequence

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

1 = Yes, Anything else = No

Integer number

Integer number

GammaTotalReportDirectory

GammaTotalGermaniumReportDirectory

GammaTotalAnalysisStartChannel

Directory path

Directory path

Starting channel number

GammaTotalAnalysisEndChannel Ending channel number

GammaTotalUseRangeForBackgroundQAEnabled 1 = Yes, Anything else = No

GammaTotalBackgroundSpectrumPath Full pathname

GammaTotalCesiumSpectrumPath

GammaTotalGeometryFilePath

Full pathname

Full pathname

AdditionalUncertainty1Name

AdditionalUncertainty2Name

AdditionalUncertainty3Name

AdditionalUncertainty4Name

AdditionalUncertainty5Name

AdditionalUncertainty6Name

String description 37 chars max

String description 37 chars max

String description 37 chars max

String description 37 chars max

String description 37 chars max

String description 37 chars max

417

GammaVision

®

v7 (A66-BW) 783620H / 1013

AdditionalUncertainty7Name

AdditionalUncertainty8Name

AdditionalUncertainty9Name

AdditionalUncertainty1Value

AdditionalUncertainty2Value

AdditionalUncertainty3Value

AdditionalUncertainty4Value

AdditionalUncertainty5Value

AdditionalUncertainty6Value

AdditionalUncertainty7Value

AdditionalUncertainty8Value

AdditionalUncertainty9Value

String description 37 chars max

String description 37 chars max

String description 37 chars max

Float between 0 and 1000%

Float between 0 and 1000%

Float between 0 and 1000%

Float between 0 and 1000%

Float between 0 and 1000%

Float between 0 and 1000%

Float between 0 and 1000%

Float between 0 and 1000%

Float between 0 and 1000%

SET_VARIABLE “VarName”, “VarValue”

This command sets the user defined JOB variable “VarName” to “VarValue”. Variable name are limited in length by 32 characters and variable values are limited to 256 characters. Up to

100 variables can be accessed in a JOB and variable 101 overwrites the first variable assigned.

To access any one of the user-defined variables, the macro expansion ‘$(VarName)’ can be used in any JOB command. For example, the following JOB commands load the sample type file stored in the variable ‘SDFPath’:

SET_VARIABLE “SDFPath, “C:\User\Sample Types\SetOptions.Sdf”

RECALL_OPTIONS $(SDFPath)

User-defined variables are shared across multiple jobs when they are nested using the CALL

JOB command. The nested JOBs inherit all previously defined variables and their values at run time, and changes made to those variables or values added in nested JOBs are available when control returns to the calling JOB. The maximum limit of 100 user-defined variables is the total across all nested JOBs that are called from a main JOB.

SMOOTH

This command smooths the data in the active buffer window. Its function is the same as

Smooth under the Calculate menu. A five-point, area-preserving, binomial smoothing algorithm is used. The original contents of the buffer are lost.

START

This initiates data collection in the selected Detector. This function is the same as Start under the Acquire menu.

418

783620H / 1013 10. JOB FILES

The Ask on Start questions as defined in Acquire/Acquisition Settings... will be asked each time a START command is executed. This stops execution of the

.JOB

file until the question is answered. If you choose Cancel for an ask-on-start prompt, the JOB terminates.

START_OPTIMIZE

For MCBs that support this feature, this starts the optimize function for the Detector. See

Section 4.2.3.5 for functional details.

START_PZ

This starts the PZ function for the detector. It is automatically included in the optimize function. This command is only available for MCBs with internal amplifiers.

STOP

This stops data collection in the active Detector. If the Detector has already been stopped, no operation occurs. This command has the same function as Stop under the Acquire menu.

STOP_PZ

This stops the PZ function for the detector. Note that the PZ function is not complete when this is used. The PZ function should be allowed to complete automatically. This command is only available for MCBs with internal amplifiers.

STRIP <factor>,[“file.chn”]

This strips the disk spectrum specified in the SET_NAME_STRIP command or in the command itself (either way is acceptable; the filename is optional in this command) from the spectrum in the buffer and stores the results in the buffer. The disk and selected data memory spectra must be the same size. The disk spectrum can be scaled up or down by <factor> (a constant) or, if <factor> is zero, by the ratio of the live times of the two spectra. The filename can include any of the variables defined in Section 10.2.

UNLOCK “Pwd”

This unlocks the current Detector using “Pwd” as the password.

VIEW “i”

This moves the “i”th stored spectrum to position 0. This command is only valid in MCBs with Field Mode.

WAIT [<seconds>]

This suspends execution of the JOB to wait until either the active Detector stops counting (in the case where the <seconds> argument is not included), or for a fixed number of seconds.

419

GammaVision

®

v7 (A66-BW) 783620H / 1013

WAIT “program”

This suspends execution of the JOB to wait until the named program stops execution. If the program does not stop, this JOB will not continue. It is good practice to put a WAIT 2 command between the RUN “program” and WAIT “program” commands to give Windows time to start the program before the status is checked. The “program” name must agree with the name used in Windows, and must include the

.EXE

extension.

WAIT_AUTO

For DSPEC only; this waits until the optimize function is complete.

WAIT_CHANGER

This waits until the sample ready signal on the rear panel is present. It is used in conjunction with the SEND_COMMAND function for more control over the sample changer than is provided by the CHANGE_SAMPLE command.

WAIT_PZ

This waits until the PZ function is complete.

WAIT_QA

This waits until QA is complete.

WAIT_SERIAL “Command”, timeout[,”Response”]

This is used to send and receive commands on the serial port of MCBs. It is designed to be used to control sample changers with RS-232 controls. “Command” are the characters sent to the changer to make it operate. Timeout is the maximum time to wait for a response before error. “Response” is the reply from the changer when it has finished the “Command.”

The first operation is to send “Command” out the serial port for the selected Detector. It then waits for a response or timeout according to these entries:

1. If a response string is provided, the length of the response string determines the exact number of characters to wait for.

2. If a response string is not provided, any character input will generate a success.

3. If a response string is provided, and the characters do not match, an Invalid Response message is generated and the JOB terminates.

4. If a timeout occurs, a Timeout Message is generated and the JOB terminates.

Example:

SET_DETECTOR 1

LOOP 3

WAIT_SERIAL “$(Loop1)L$(CR)”, 300, “$(BEL)”

420

783620H / 1013 10. JOB FILES

BEEP 5

END_LOOP

This code does the following:

1. Sends 1L

5 and waits 5 minutes for an ASCII Bell Character. Beeps 5 after ASCII bell is received.

2. Sends 2L

5 and waits 5 minutes for an ASCII Bell Character. Beeps 5 on success.

3. Sends 3L

5 and waits 5 minutes for an ASCII Bell Character. Beeps 5 on success.

The

5 is the

$(CR)

(carriage return) character.

ZOOM <i>

Changes the size of the GammaVision window. Selects one of icon, normal, or maximum according to the argument. The arguments are:

!1 = minimize (icon on Taskbar)

0 = normal (size determined by last use)

+1 = maximize (full screen)

ZOOM: <x,y,w,h>

Changes the position and size of the GammaVision window. The arguments are: x = x position of upper-left corner of window (0 is left) y = y position of upper-left corner of window (0 is top) w = width of window in pixels, starting at x and going right h = height in pixels, starting at y and going down

Since these arguments are in pixels, experimentation is the best way to determine the desired size.

421

GammaVision

®

v7 (A66-BW) 783620H / 1013

[Intentionally blank]

422