Model S560

Genie™ 2000
Programming Library
9233656F V3.1 User’s Manual
 Body: 9230877J

Copyright 2006, Canberra Industries, Inc. All rights reserved.

The material in this document, including all information, pictures,

graphics and text, is the property of Canberra Industries, Inc. and is
protected by U.S. copyright laws and international copyright
conventions.

Canberra expressly grants the purchaser of this product the right to

copy any material in this document for the purchaser’s own use,
including as part of a submission to regulatory or legal authorities
pursuant to the purchaser’s legitimate business needs.

No material in this document may be copied by any third party, or

used for any commercial purpose, or for any use other than that
granted to the purchaser, without the written permission of Canberra
Industries, Inc.

Canberra Industries, 800 Research Parkway, Meriden, CT 06450

Tel: 203-238-2351 FAX: 203-235-1347 http://www.canberra.com

The information in this document describes the product as accurately

as possible, but is subject to change without notice.

Printed in the United States of America.

Genie is a trademark of Canberra Industries, Inc.

Microsoft, Windows, NT, Visual Basic and Visual C++ are registered trademarks of Microsoft Corporation in the
United States and/or other countries.
Pentium is a registered trademark of Intel Corporation in the United States and/or other countries.
Table of Contents

1. Installation and Setup . . . . . . . . . . . . . . . . . . . . . . . . . 1

Installing the Genie 2000 Programming Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Installing TCP/IP Network Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Windows NT/2000/XP TCP/IP Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Additional TCP/IP Installation Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Non-Network VDM Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Windows-2000 Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Windows-XP Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Installing AIM Device Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Windows NT AIM Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Windows 2000/XP Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

2. Programming Library Reference . . . . . . . . . . . . . . . . . . 20

Genie 2000 Software Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Configuration Access Method (CAM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
CAM Data and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Programming Library Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Programming Library Routines Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Naming Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Create a Special VDM Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Create a Standard VDM Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Delete a VDM Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Get Detailed Error Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Enumerate a List of VDMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Open a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Save a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Close a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Create a File Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Retrieve Information from a DSC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Retrieve Information from the CAM Schema File . . . . . . . . . . . . . . . . . . . . . . . . 39
 Read Spectral Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Write Spectral Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Read a CAM Parameter Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Write a CAM Parameter Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Read an Array of CAM Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Write an Array of CAM Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Read a List of CAM Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Write a List of CAM Parameter Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Read a Related Set of CAM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Write a Related Set of CAM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Setting Acquisition Preset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Retrieve ROI Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Return Number of Records in a CAM Class . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Return Number of Entries in a CAM Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Insert a Record/Entry into a CAM Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Delete a Record/Entry from a CAM Datasource . . . . . . . . . . . . . . . . . . . . . . . . . 55
Select a Member of a Multi-Memory Group Input . . . . . . . . . . . . . . . . . . . . . . . . 56
Issue Control Commands to Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Copy Classes of CAM Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Search for CAM Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Copy CAM Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Retrieve Information about a Datasource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
ICB Direct Access Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Create a Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Read a Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Write a Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Utility Library Routines Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Create a Local VDM Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Convert System Date/Time into CAM Time Format . . . . . . . . . . . . . . . . . . . . . . . 68
Convert C Date/Time to/from CAM Time Format . . . . . . . . . . . . . . . . . . . . . . . . 69
Convert ASCII Date/Time to/from CAM Time Format . . . . . . . . . . . . . . . . . . . . . 70
Defining Genie 2000 Environment Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Analysis Engine Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Analysis Engine Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

ii
 Setup Screen Dialog Function Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Example Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

3. Component Programming Library Reference . . . . . . . . . . . 82

DataAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
DataAccess Data Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
DataAccess Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Open a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Close a Data Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Flushing Changes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Creating a Parameter Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Deleting a Parameter Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Copying a Parameter Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Inserting a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Inserting a Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Deleting a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Deleting an Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Finding a Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Saving Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Evaluating Spectroscopic Calibrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Converting from Energy To Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Computing ROIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Determining if a File Exists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Moving or Copying a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
DataAccess Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
Parameter Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Parameter Array Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
Single Parameter Array. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Spectral Data Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Determining the File Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Determining the Number of Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
Determining the Number of Tabular Entries . . . . . . . . . . . . . . . . . . . . . . . . 101
Access Handle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Determining if Opened . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

iii
 Determining if Modified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Status Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Retrieving Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Data Access Calibrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Low Tail Calibrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
Energy Calibrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
FWHM Calibrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
Efficiency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Dual Efficiency Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Linear Efficiency Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Empirical Efficiency Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Efficiency Calibration Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Dual Efficiency Cross Over Energy . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112
Alpha Efficiency Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Matrix Correction Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Neutron Mass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Multiplication Corrected Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Reals Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Doubles Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
Non-Multiplication Corrected Properties . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Non-Multiplication Corrected Reals Properties. . . . . . . . . . . . . . . . . . . . . . . 118
Power Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Rational Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Exponential Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Polynomial Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Non-Multiplication Corrected Totals Calibration. . . . . . . . . . . . . . . . . . . . . . 122
Add-a-Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Reals Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
Totals Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
DeviceAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
DeviceAccess Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
DeviceAccess Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

iv
 Connecting to a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Disconnecting from a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Clearing the Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Setting up a Spectroscopy Detector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Setting up a Neutron Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Starting an Acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
Stopping an Acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Pausing an Acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Copying a Parameter Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Saving Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Retrieving Spectral Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Retrieving Neutron Measurements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Verify Input Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Defining the Memory Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
Sending Commands to a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Sending Commands to a List of Detectors . . . . . . . . . . . . . . . . . . . . . . . . . 141
Evaluating Spectroscopic Calibrations . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Converting from Energy To Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Computing ROIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Setting or Getting Boot Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Moving or Copying a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
DeviceAccess Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Parameter Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Parameter Array Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Single Parameter Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Spectral Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
Name of the Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Determining Analyzer Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Determining the Analyzer Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
Determining if Connected. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Determining MID Defined Spectroscopy Detectors . . . . . . . . . . . . . . . . . . . . 153
Access Handle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
Determining if Modified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154
Status Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155

v
 Retrieving Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
High Voltage Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Amplifier Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
ADC Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
DeviceAccess Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Processing Asynchronous Message Events . . . . . . . . . . . . . . . . . . . . . . . . . 159
Processing Device Message Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
CAM Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
CAM Datasource Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Array Of Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Evaluation Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Delete Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Open Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Close Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Datasource Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Device Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Search Record Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Datasource Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Preset Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Information Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
Datasource Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Device Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Clone Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
VDM Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Structure Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
Parameter Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Class Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Conversion Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Analysis Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Input Device Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Input Device Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
CAM Datasource Component Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

vi
CAM Datasource Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Opening a Datasource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Closing a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Compressed Spectral Data or Scaled Data . . . . . . . . . . . . . . . . . . . . . . . . . 178
Creating a Parameter Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Copying a Parameter Block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
Copying a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Finding a Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Inserting Records or Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Deleting Records, Entries or Parameter Blocks. . . . . . . . . . . . . . . . . . . . . . . 182
Counting Records or Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Save As . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Creating a Connection to the Local VDM . . . . . . . . . . . . . . . . . . . . . . . . . 183
Determining Datasource Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Cloning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Accessing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Accessing Arrays of Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
ICamDatasource Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Determining Modified State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Device Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Preset Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Evaluate Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Error Handling using the Message List Interface . . . . . . . . . . . . . . . . . . . . . . 190
Acquisition Completion Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Setting or Getting Spectrum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
CAM Datasource Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Datasource Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Property Change Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Device Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Executing Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
Clearing Open Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Verifying Hardware Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Memory Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

vii
 Preset Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Input Device Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
Input Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Verification of Input Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Programmable Device. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Supported Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Input Device Collection Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Find . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Status of All Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
Verification of All Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Evaluate Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Calling a Genie-2k Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Evaluations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Abort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Evaluate Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Analysis Complete Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Preset Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Start Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Stop Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Count Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

viii
 Sweeps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Parameter Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Convert . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Message List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Parameter Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Parameter Collection Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Count . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Collection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Data Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Data Display Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Data Display Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Opening a Datasource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Closing a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Closing All Datasources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Saving Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
Displaying a Specific Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Next Datasource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Previous Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228
Determining if a Source is Already Loaded . . . . . . . . . . . . . . . . . . . . . . . . 228
Setting up a Spectroscopy Detector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
Setting up a Neutron Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

ix
 Starting an Acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Aborting an Acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Pausing an Acquisition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Clearing a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Verifying Input Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234
Adding an ROI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Deleting an ROI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Deleting all ROIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Next ROI/Next Data Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Previous ROI/Previous Data Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Saving ROIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Loading ROIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Moving Through NID Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Manually Moving the Spectral Plot Cursors . . . . . . . . . . . . . . . . . . . . . . . . 239
Zoom Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Changing Axis Limit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Copy Data into Windows Application . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Printing Graphics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Exporting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Plotting Coincidence Rates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Plotting Coincidence Rate Histograms . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Displaying Histograms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Displaying Scalar Bank Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Changing Spectral Plot Axis Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Data Display Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Current Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Determining a Datasource Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
Determining a Datasource Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Determining the Number of Datasources . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Getting a List of Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Determining if Modified . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Parameter Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Parameter Array Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
Single Parameter Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253

x
Drag and Drop Opens . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
Plot Background Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
ROI Type Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
NID Annotation Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Spectrum Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Activating Expand Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
Expand Plot Real Time Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Activating Zoom Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Getting the Number of ROIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Display Refresh Rate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Auto-Scale During Acquisitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Displaying Grid Lines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
Displaying Spectral Plot Borders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Changing the Number of Y-Axis Tick Marks . . . . . . . . . . . . . . . . . . . . . . . 262
Activating Energy X-Axis Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Hiding or Showing the Status Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Hiding or Showing the Information Spreadsheet . . . . . . . . . . . . . . . . . . . . . . 264
Displaying Input Device Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Displaying Computational Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
Displaying Spectral Data Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Displaying Peak Area, Calibration, and NID Results . . . . . . . . . . . . . . . . . . . . 266
Displaying Nuclide Lines on the Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Activating Linear Y-Axis Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
Displaying Data Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Filling Spectral ROIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 269
Displaying Compressed or Uncompressed Spectral Data. . . . . . . . . . . . . . . . . . 269
Determining if a Datasource Has Both Neutron and Spectroscopic Data . . . . . . . . . 270
Changing the Type of Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Changing the Plot Point Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Determining if Coincidence Rates are Being Displayed . . . . . . . . . . . . . . . . . . 272
Determining if Coincidence Histograms are Being Displayed . . . . . . . . . . . . . . . 272
Determining if Multiplicity Data is Being Displayed . . . . . . . . . . . . . . . . . . . . 273
Determining if Scalar Data is Being Displayed . . . . . . . . . . . . . . . . . . . . . . . 273
Number of Standard Deviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

xi
 Number of Coincidence Bins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
Displaying Coincidence Rates in a Spreadsheet . . . . . . . . . . . . . . . . . . . . . . 275
Peak Labeling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
Data Display Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Processing Peak Cursor Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Processing R OI Cursor Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Processing Time Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Processing Neutron Rate Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Processing Device Status Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Processing Mouse Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 279
Processing Asynchronous Message Events . . . . . . . . . . . . . . . . . . . . . . . . . 280
Drag and Drop Open Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Interactive Data Fit Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Interactive Data Fit Control Data Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Interactive Data Fit Control Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Plotting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Extended Plotting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Over Plots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Over Plot Legend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Plotting in Three Dimensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Highlight a Plane on the 3d Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
Adding Models To Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
Deleting a Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Undeleting A Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Undeleting All Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Starting a Computation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Aborting a Computation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Zoom Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Changing Axis Limits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Copying Data Into Windows Applications . . . . . . . . . . . . . . . . . . . . . . . . . 299
Exporting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Moving the Plot Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Getting the Plot Cursor Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

xii
 Getting the Current Plot Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Selecting the Current Model to Display . . . . . . . . . . . . . . . . . . . . . . . . . . 304
Holding Coefficients Constant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Changing a Polynomial Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
Computing Fit Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
Evaluating a Point. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Status Window Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Fitting Without a Plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Evaluation of a Point on the Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310
Get Dual Low Energy Model Information . . . . . . . . . . . . . . . . . . . . . . . . . 311
Status Bar Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
Scaling Axes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Maximize to Full Screen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Interactive Data Fit Control Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Data Point Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Model Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Low Dual Curve Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Background Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Plot Axes And Label Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Fit Envelope Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
Cursor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Cross Over Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Data Point Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Log/Linear Axis Scales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Cursor Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Activating Zoom Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 321
Display a Plot or Spreadsheet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Displaying the Covariance Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322
Changing the Number of Y-Axis Tick Marks . . . . . . . . . . . . . . . . . . . . . . . 323
Displaying Grid Lines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323
Hiding or Showing the Status Window . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
Hiding or Showing the Information Window . . . . . . . . . . . . . . . . . . . . . . . . 324
Number of Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Number of Deleted Points. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325

xiii
 Number of Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
Status Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Retrieving Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326
Activating/Deactivating Spreadsheet Edits . . . . . . . . . . . . . . . . . . . . . . . . . 327
Displaying the Number Of Deleted Points . . . . . . . . . . . . . . . . . . . . . . . . . 327
Displaying the Fit Uncertainty . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
The Number of Standard Deviations in the Fit . . . . . . . . . . . . . . . . . . . . . . . 328
Dual Model Crossover Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Enabling The Crossover Cursor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Sets the Current Data Set for the Plot Cursor . . . . . . . . . . . . . . . . . . . . . . . . 330
Determining Computation Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Changing Dual Efficiency Model Into a Single Efficiency Model . . . . . . . . . . . . . 331
Changing Linear Estimation Technique . . . . . . . . . . . . . . . . . . . . . . . . . . 331
Interactive Data Fit Control Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Processing Mouse Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Processing Plot Cursor Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Processing Asynchronous Message Events . . . . . . . . . . . . . . . . . . . . . . . . . 333
Processing OverPlot Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Processing Model Selection Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 333
Processing Dual Cross Over Change Events . . . . . . . . . . . . . . . . . . . . . . . . 333
Processing Computations Completed Event . . . . . . . . . . . . . . . . . . . . . . . . 334
Processing Point Delete/Undelete Event . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Exported C Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Fitting Data to a Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Evaluating a Fit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Library of Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Spectroscopy Energy And Shape Models. . . . . . . . . . . . . . . . . . . . . . . . . . 337
Spectroscopy Efficiency Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Spectroscopy Efficiency versus Density Models . . . . . . . . . . . . . . . . . . . . . . 340
General Non-Linear Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 341
General Linear Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Model Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Efficiency Calibration Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Using the Efficiency Calibration Phase I Component. . . . . . . . . . . . . . . . . . . . . . 344

xiv
Efficiency Calibration Control Phase I Methods . . . . . . . . . . . . . . . . . . . . . . . . 345
Opening a Datasource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Closing a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Deleting A Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 347
Adding A Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Automatic Efficiency Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Adding An Efficiency Calibration Record . . . . . . . . . . . . . . . . . . . . . . . . . 349
Merging Efficiency Calibration Records . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Displaying Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 351
Changing the Energy Display Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
Saving Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 352
Listing the Efficiency Point Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Removing Points Associated with a Datasource Identifier . . . . . . . . . . . . . . . . . 353
Efficiency Calibration Control Phase I Properties . . . . . . . . . . . . . . . . . . . . . . . 354
Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354
Cross Over Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Status Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Retrieving Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Number of Calibration Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Modify State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Activating/Deactivating Edits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Efficiency Calibration Control Phase I Events . . . . . . . . . . . . . . . . . . . . . . . . . 358
Processing Asynchronous Message Event . . . . . . . . . . . . . . . . . . . . . . . . . 358
Processing Enable Change Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Processing Cell Selection Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Modified CAM Parameters for Phase I . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359
Exported Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Adding Efficiency Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Merging Efficiency Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
List of Calibration Identifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Removing Point By Identifier. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 361
Using the Efficiency Calibration Phase II Component . . . . . . . . . . . . . . . . . . . . . 362
Efficiency Calibration Control Phase II Data Types . . . . . . . . . . . . . . . . . . . . . . 362

xv
 Efficiency Calibration Control Phase II Methods . . . . . . . . . . . . . . . . . . . . . . . . 363
Opening a Datasource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Closing a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Deleting A Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 365
Undeleting A Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Undeleting All Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Aborting a Computation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Changing Axis Limits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Changing the Energy Display Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Changing the Density Display Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Displaying Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 369
Saving Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Efficiency Calibration Control Phase II Properties . . . . . . . . . . . . . . . . . . . . . . . 370
Data Point Colors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Model Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371
Low Dual Curve Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Background Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Plot Axes And Label Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Cursor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Cross Over Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373
Status Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Retrieving Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Activating/Deactivating Edits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Determining Computation Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
Determining the Displayed Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Number of Calibration Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Modify State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Efficiency Calibration Control Phase II Events . . . . . . . . . . . . . . . . . . . . . . . . . 378
Processing Asynchronous Message Event . . . . . . . . . . . . . . . . . . . . . . . . . 378
Processing Equation Change Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Processing Plot Change Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Processing Cursor Change Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379

xvi
 Exported C Routines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Multi-Curve Efficiency Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Modified CAM Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
Multi-Curve Efficiency Engine UI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Energy Calibration Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Using the Energy Calibration Phase I Component . . . . . . . . . . . . . . . . . . . . . . . 383
Energy Calibration Control Phase I Methods . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Opening a Datasource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Closing a Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Adding A Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Deleting A Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Cursor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Markers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Automatic Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Detector Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Move ROI Cursors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Saving Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Displaying Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Changing the Energy Display Units . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Energy Calibration Phase I Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Reference Peak . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Status Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Retrieving Status Message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Activating/Deactivating Edits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Editing Spreadsheet Calibration Points . . . . . . . . . . . . . . . . . . . . . . . . . . . 394
Number of Calibration Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Modify State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
Linear/Log Scale . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Expand On/Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Display Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Recalibration Mode On/Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398

xvii
 Auto Scale On/Off . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Energy Calibration Phase I Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Processing Asynchronous Message Event . . . . . . . . . . . . . . . . . . . . . . . . . 399
Processing Enable Change Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Processing Mvc Cursor Moves . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Processing Cell Selection Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Processing Computation Completed Event . . . . . . . . . . . . . . . . . . . . . . . . . 401
Modified CAM Parameters for Energy Calibration Phase I . . . . . . . . . . . . . . . . . . 401
Algorithms for Energy Calibration Phase I . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Using the Energy Calibration Phase II Component . . . . . . . . . . . . . . . . . . . . . . . 402
Energy Calibration Control Phase II Data Types . . . . . . . . . . . . . . . . . . . . . . . . 403
Energy Calibration Control Phase II Methods . . . . . . . . . . . . . . . . . . . . . . . . . 403
Opening a Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Closing a Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Deleting A Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Undeleting A Point . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Undeleting All Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Changing Axis Limits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Saving Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Displaying Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Energy Calibration Control Phase II Properties . . . . . . . . . . . . . . . . . . . . . . . . . 408
Calibration Colors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Background Color. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Plot Axes And Label Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Cursor Color . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Status Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Retrieving Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Activating/Deactivating Edits. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
Determining Computation Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Privilege. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Number of Calibration Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
Modify State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413

xviii
 Energy Calibration Control Phase II Events . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Processing Asynchronous Message Event . . . . . . . . . . . . . . . . . . . . . . . . . 414
Processing Computation Completed Event . . . . . . . . . . . . . . . . . . . . . . . . . 415
Modified CAM Parameters for Phase II . . . . . . . . . . . . . . . . . . . . . . . . . . 415
CAM Dialog Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
CAM Dialog Control Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
CAM Dialog Control Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Open Datasource Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Open ROI File Dialog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Calibration File Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Certificate Open Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Nuclide Library Open Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423
Save As Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424
Adjust Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Adjust Control Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Setting a Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426
Closing the Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Checking for Busy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Changes in the Adjust Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428
Adjust Control Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Status Severity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Retrieving Status Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Sequence Analyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
SequenceAnalyzer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Analysis Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436
Reporter Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Clearing the View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Copy the selected text to the clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Copy all the text to the clipboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
Viewing a text file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439

xix
 Viewing an RTF file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Saving the Report Contents as a Text File . . . . . . . . . . . . . . . . . . . . . . . . . 439
Saving the Report Contents as an RTF File. . . . . . . . . . . . . . . . . . . . . . . . . 440
Executing a Genie 2000 Report Template . . . . . . . . . . . . . . . . . . . . . . . . . 440
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441
Reporter Viewer Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Reporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Error Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449

4. MCA Input Definition . . . . . . . . . . . . . . . . . . . . . . . . 451

The InSpector 2000 Simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
The MID Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Using the Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
The MCA Input Definition Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Basic Concepts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
Starting the MCA Input Definition (MID) Editor . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Building an MCA Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
Adding an MCA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
Interpreting the Definition Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Deleting an MCA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Defining an MCA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
MCA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 460
Sample Changer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Stabilizer, High Voltage, DSP Gain and DSP Filter . . . . . . . . . . . . . . . . . . . . 461
The Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
MCA Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Stabilizer Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
High Voltage Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
DSP Gain Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
DSP Filter Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465

xx
 MCS Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Input Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Saving the Input Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
Changing the Summary View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Editing an MCA Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Viewing the File Details. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Editing the Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
The New Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
The Input Definition Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Using MCA Definition Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Viewing the Current Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Loading and Unloading Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Loading the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Unloading the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472

5. CAM Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474

Configuration Data and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
Creating a Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
Initial Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Values Common to All Detector Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Values Dependent on the Detector Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Configuration Parameter Descriptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
Flag Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Individual Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Acquisition Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Sample Changer Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485
Neutron Shift Register (JSR-12) Parameters . . . . . . . . . . . . . . . . . . . . . . . . 485
Power Management Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486
Segmented Gamma Scanner Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 487
Neutron Generator Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Dose Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
Vendor Spare Common Acquisition Parameters . . . . . . . . . . . . . . . . . . . . . . 490
User Spare Common Acquisition Parameters. . . . . . . . . . . . . . . . . . . . . . . . 490

xxi
 Common Tabular Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
High Voltage Power Supply Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 490
Amplifier Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 492
Gain Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494
Filter Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Digital Spectrum Stabilizer Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 495
Loss-Free-Counting Module Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 496
MCS/MSS Module Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496
Multiplexer Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
ADC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497
Multichannel Analyzer Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
Energy Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Peak Shape Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500
Special Purpose Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Pulse Pileup Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
Reference Peak Correction Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . 501
User Spare Acquisition Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
Alternate Linear Energy Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . 502
Vacuum Device Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502
MGAU Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Miscellaneous Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Record Tabular Entry Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
Sample Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Plant/Site Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
Air Sampling Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
WBC-Related Sample Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
Waste Assay Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
User Spare Sample Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
Alpha Analyst Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Sample Flags Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Geometry Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510

xxii
 WBC and Lung Counter Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Empirical Efficiency Model Calibration Parameters . . . . . . . . . . . . . . . . . . . . 511
Alpha Spectroscopy Efficiency Calibration Parameters . . . . . . . . . . . . . . . . . . 512
Dual Polynomial Efficiency Model Calibration Parameters . . . . . . . . . . . . . . . . 512
Linear Efficiency Model Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . 513
User Spare Geometry Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
Record Tabular Entry Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
Peak Search Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Hypermet Peak Search Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 521
Singlet Peak Search Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Alpha Peak Search Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
ROI Peak Search Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 522
Gamma-M Peak Search Processing Parameters. . . . . . . . . . . . . . . . . . . . . . . . . 522
Calibration Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Alpha-M Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
MGA Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 523
Nuclide ID Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
WBC-Specific Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 526
Interactive Peak Search Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 526
User Spare Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Reference Peak Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Neutron Analysis Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Coincidence Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Multiplicity Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Automated Waste Analysis Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Waste Assay Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Miscellaneous Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Action Level Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Shift/Sum Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Non-Uniformity Detection Analysis Parameters . . . . . . . . . . . . . . . . . . . . . . . . 531
K-Edge Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Self-Absorption Correction Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
TMU Analysis Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532

xxiii
 General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Gamma TMU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 533
Passive Neutron TMU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
DDA TMU Analysis Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
DDA Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
TGS Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Collimator and Geometry Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Analysis Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Library Correlation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Display Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538
User Spare Display Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
MPA Display Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Record Tabular Entry Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 540
Peak Search Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 544
User Spare Peak Search Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
More Peak Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
Record Tabular Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
Certificate Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 548
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Energy/FWHM Calibration Results Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 549
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Shape Calibration Results Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 550
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Nuclide Library and Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 551
Nuclide Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 552
Record parameter (per nuclide) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555

xxiv
 NAA-Specific Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 555
WBC Counting Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
Record Parameters (All Applications) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
User Spare Nuclide Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
NAA-Specific Nuclide Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
WBC Nuclide Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Record Tabular Entry Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Energy Line Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
User Spare Energy Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
NAA Specific Energy Line Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Interfering Nuclide List Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Interference Specific Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 569
Interfering Nuclide Results Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
NAA Run Descriptor Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 570
NaI (Alpha-M) Standard File Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 571
Scanning WBC Setup Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Security Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Analysis Control Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 582
QA Parameter Definition Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 583
QA Results Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
Tabular Entry Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
MGA Results Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587

xxv
 Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 591
Neutron Acquisition and Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
Filter Engine Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594
Measurement Correction Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 595
Standard Coincidence Analysis Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 597
Multiplicity Analysis Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Waste Analysis Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Ones Rate Analysis Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Cosmic Ray Rejection Analysis Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Cm/Cf Analysis Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Coincidence Collar Analysis Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 601
Active Multiplicity Analysis Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 602
Neutron Declaration Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 603
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 605
Neutron Detector Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 606
Neutron Sample-Dependent Detector Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 607
General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 608
Multiplication-Corrected Reals 240Pu Calibration. . . . . . . . . . . . . . . . . . . . . . . . 610
Non-Multiplication-Corrected Reals 240Pu Calibration . . . . . . . . . . . . . . . . . . . . . 610
240
Pu Calibration (Power Function) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Non-Multiplication-Corrected Reals 240Pu Calibration (Exponential Function) . . . . . . . . 612
Non-Multiplication-Corrected Reals 240Pu Calibration (Rational Function) . . . . . . . . . . 612
Non-Multiplication-Corrected Totals 240Pu Calibration . . . . . . . . . . . . . . . . . . . . 612
Multiplication-Corrected Doubles 240Pu Calibration . . . . . . . . . . . . . . . . . . . . . . 613
Multiplicity Ones Rate 240Pu Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Non-Truncated Multiplicity 240Pu Calibration . . . . . . . . . . . . . . . . . . . . . . . . . 613
Truncated Multiplicity 240Pu Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Truncated Multiplicity Spallation Calibration . . . . . . . . . . . . . . . . . . . . . . . . . 614
Non-Truncated Multiplicity Cm/Cf Calibration. . . . . . . . . . . . . . . . . . . . . . . . . 615

xxvi
 DDA Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Neutron Sample Processing Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 616
DDA Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Shuffler Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Attenuation Correction Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Absorption Measurement Calibration/Result Parameters . . . . . . . . . . . . . . . . . . . . . . 623
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 623
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Differential Peak Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Transmission Correction Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
Differential Peak Absorption Correction Calibration / Results . . . . . . . . . . . . . . . . . . . 626
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Safeguards Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
DAS Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
HDC Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
AMP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
EMP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
UIP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Neutron Analysis Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
DAS Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
EMP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
ASDEM Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
Neutron Detector Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Neutron Analysis Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Generic Flags Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 633
Special Uses Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634

xxvii
 Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
MCS Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 636
K-Edge Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
K-Edge Analysis Results Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
Neutron Multiplicity Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
Record Tabular Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
Add-a-Source Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 640
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 643
ASTM Mass Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 644
Record Tabular Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
Peak-to-Total Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Coincidence Summing Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Record parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Coincidence Summing Chain Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
Record parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Passive Neutron TMU Analysis Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 648
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Gamma TMU Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 650
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
Multi-Modality Results Combination Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 653
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 654
Differential Dieaway Analysis Results Parameters . . . . . . . . . . . . . . . . . . . . . . . . . 655

xxviii
 Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Record Tabular Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 657
Differential Dieaway TMU Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 658
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 659
TGS ROI Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
TGS ROI Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 661
Voxel Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
Record Tabular Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
NIT Calibration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 663
Record Tabular Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Shuffler Assay Results. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 664
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Record Tabular Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665
Datasource Name List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Record Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666
Hydrogen Correction Calibration/Results Parameters . . . . . . . . . . . . . . . . . . . . . . . . 666
Common Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 666

6. Development Tools Environment . . . . . . . . . . . . . . . . . 667

7. Genie 2000 Error Codes . . . . . . . . . . . . . . . . . . . . . . 668

CAM Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
IPC Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
VDM Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Analysis Module Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671

xxix
 Common 61 ‘xxxx’ codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
Common E8 ‘xxxx’ codes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 674
Geometry Composer Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Report Module Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
QA Routine Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
MID Editor Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Input Datasource Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Open/Verify Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Operational Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 690

8. LabSOCS/ISOCS Error Codes . . . . . . . . . . . . . . . . . . . 693

General Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Geometry Composer Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723
ISOCS Multi-Efficiency Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 731
ISOCS Template-Dependent Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 732
LabSOCS Template-Dependent Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 751

xxx
1. Installation and Setup
Note: The format and contents of the screens shown in this chapter are operating sys-
tem dependent. You should use these screens as references only.

Installing the Genie 2000 Programming Library

To install the Genie 2000 Programming Library software:

1. If you are installing this software as an upgrade from a previous version, make
sure that no Genie 2000 software programs, such as the VDM, are running.

2. Put the CD-ROM labeled “Genie 2000 Programming Library Software - Disk 1
of n” into your CD-ROM drive.

3. Select Start | Run and, in the Open text box, type:

x:\setup

where x: is the drive designator.

4. First, you will be presented with an introductory screen describing the

installation of the Genie 2000 Programming Library software. Press Next to
continue.

5. After pressing Next, you will be given a choice between installing “Genie 2000
Runtime Files Only” or “Programming Library and Genie-2000 Runtime Files”
(this is the default). If the installation is being performed simply to allow
execution of a program developed with this package, then you should select the
first option.

6. After pressing Next, you will be asked to choose between “Standard

Installation” or “Custom Installation”. Choosing Custom allows you to override
default structures during the installation.

7. If the S560 installation was used to set up a Genie 2000 runtime environment,
there are a few additional items that may require further installation/setup:
• Installing TCP/IP Network Components; please refer to page 2.
• Installing AIM Device Drivers; please refer to page 17.
Installation and Setup

Note Files are installed only if the target system contains either an installation of
Genie 2000 V1.4 or later, or no Genie 2000 software at all. Genie 2000 V1.3
and earlier do not fully support the S560 package. If one of these earlier ver-
sions is present, the S560 runtime files will not be installed.

Documentation
The Programming Library User’s Manual is located on the CD-ROM Distribution. This
manual will automatically be installed if other Genie 2000 documents are resident on the
target system.

Installing TCP/IP Network Components

The TCP/IP network protocol is a standard component of the Windows operating system
environments. The Genie 2000 software is a client/server architecture; communications
between the client and server components is through Windows sockets using the TCP/IP
protocol.

Note: Genie-2000 assumes that a network interface is installed in the local PC. If you
do not have a network interface in a Windows 2000 or Windows XP PC, refer
to the procedures in “Non-Network VDM Configuration” on page .

Windows NT/2000/XP TCP/IP Setup

The following steps should be performed to ensure proper setup of TCP/IP for use by Ge-
nie 2000 under Windows NT/2000/XP. If remote VDM access is required, either by this
computer or by another remote computer to this computer’s VDM, some additional steps
may be required; these are described in “Additional Setup Steps for Remote VDM Ac-
cess” on page 5.

1. To determine if TCP/IP is already installed on your computer, right click on the

Network Neighborhood icon, select Properties, then select the Configuration tab.

If you see TCP/IP in the Configuration list (Figure 1), it is installed and no
further action is required. Click on Cancel to exit the Network window without
making any changes.

2
 Installing TCP/IP Network Components

Figure 1 Network Protocol Screen

2. Only two network components require installation for Genie 2000. First, a
network adapter must be added. If your computer does not contain a network
adapter card, then an MS Loopback Adapter must be added. Click on the
Adapters notebook tab (this brings up the Network Adapters selection page);
click on the Add button to bring up the dialog in Figure 2.

Figure 2 Select Network Adapter

3
Installation and Setup

Select the appropriate vendor and network adapter card to match the one in your
machine. If none is present, then select the MS Loopback Adapter entry in the
Network Adapters list. Choose OK to add the selected adapter. You will be
prompted for your Windows NT/2000/XP installation disks (CD-ROM) in order
to copy the required files for the selected network adapter (note that on some
pre-loaded systems, the Windows NT/2000/XP distribution is installed on the
hard disk partition containing Windows NT/2000/XP).

3. It is now time to add the TCP/IP protocol. Select the Protocols notebook tab on
the Network Settings screen and press the Add button to bring up the Select
Network Component Protocol dialog (Figure 3).

Figure 3 Select Network Protocol

Highlight the TCP/IP Protocol from the Network Protocol list and press OK to
add. You will be prompted for your Windows NT/2000/XP installation disks
(CD-ROM) in order to copy the required files for the selected network adapter
(note that on some pre-loaded systems, the Windows NT/2000/XP distribution is
installed on the hard disk partition containing Windows NT/2000/XP).

4. If remote VDM access is required, then proceed to ”Additional Setup Steps for
Remote VDM Access” on page 5.

5. Press the Close pushbutton to exit the Network setting dialog. At this time you
will be prompted (via a dialog shown in Figure 4) for setup of TCP/IP
properties.

On this dialog, an IP address and subnet mask must be specified. Since the
loopback adapter has been selected (i.e. restricting TCP/IP communications to
local only), then any legal IP address and subnet mask may be specified (e.g.
200.200.200.1 for IP address and a subnet mask of 255.255.255.0). Note that
with this type of setup, Genie 2000 will use the standard loopback IP address,

4
 Installing TCP/IP Network Components

127.0.0.1, and not the one specified in this dialog. Press OK to complete the
setup.

Figure 4 Microsoft TCP/IP Properties

6. When all required files have been copied and the installation is complete, you
will be reminded to reboot your system to complete the installation process and
will be given the option of restarting your computer immediately.

Additional Steps for Remote VDM Access

If access to this computer’s VDM is required from another remote computer, then this
computer must identify itself via a unique computer name. If, after setting up your re-
mote VDM access, you have persistent problems in establishing client connections to the
VDM, refer to “Additional TCP/IP Installation Tips” on page 9.

To set up remote VDM access, perform the following steps:

1. The name of this computer must be defined via the Network Settings applet. To
do this, click on the Identification notebook tab which brings up a dialog box.

Click the Change button to enter the Computer Name (Figure 5), which must be
unique and is limited to 8 characters, maximum. It can include letters, numbers,
hyphens and underlines (spaces are not allowed).

5
Installation and Setup

The Workgroup field is not used by Genie 2000. It is typically used in a larger
network to help partition it and its users into logical domains.

Figure 5 Computer Name Identification

6
 Installing TCP/IP Network Components

2. Click the Close button to exit the Network setting dialog. You’ll be prompted
(via the dialog in Figure 6) to set up the TCP/IP properties.

Figure 6 TCP/IP Properties Screen

An IP address must be defined for this computer so it can be associated with the
previously entered computer name (this is how computers and applications
communicate with each other using TCP/IP; the computer name is translated
into an IP address). Either select the “Specify an IP address” radio button and
enter in a valid IP address and subnet mask (e.g. IP address of 200.200.200.1
and a subnet mask of 255.255.255.0) or select the “Obtain an IP address
automatically” radio button if this computer resides on a network that uses
TCP/IP and employs dynamic IP addressing.

It is recommended that you contact your network administrator for guidance in

setting up this portion of TCP/IP since IP addresses must be unique on a
network. Select OK when setup of TCP/IP properties is complete.

3. When all required files have been copied and the installation is complete, you
will be reminded to reboot your system to complete the installation process and
will be given the option of restarting your computer immediately. Select No to
the restart computer question since some additional setup steps are still required.

7
Installation and Setup

4. The Genie 2000 Network Configuration File (as pointed to by the environment
variable CINETCFG; typically named G2K_VDM.NCF) must be edited as
follows:

Edit the first line of this file to remove the text LOCAL as shown below (this
indicates that the computer name/IP address information is defined via the
network settings information and not defaulted to Local / 127.0.0.1):

Original:
1 -\local
1B-\pipe\datasrce
1C-\pipe\configur
Edited:
1 -\
1B-\pipe\datasrce
1C-\pipe\configur

If access to another computers VDM is required from this computer, perform the
following steps:

1. The Genie 2000 Network Configuration File (as pointed to by the environment
variable CINETCFG) must be edited as follows:

Edit additional lines (after the first three lines) into the file as follows (this
example assumes a remote computer name of NODE1):

Original:
1 -\local
1B-\pipe\datasrce
1C-\pipe\configur
Edited:
1 -\
1B-\pipe\datasrce
1C-\pipe\configur
1M-\\node1\pipe\datasrce
1C-\\node1\pipe\configur

Add additional lines as required to define subsequent remote computers.

8
 Installing TCP/IP Network Components

2. Assuming your network does not use DNS, WINS or dynamic IP addressing,
then one additional Windows NT/2000/XP TCP/IP file requires editing in order
for this computer to resolve the remote computer name to an IP address. This
file is named HOSTS and must be located in the
WINNT\SYSTEM32\DRIVERS\ETC directory. A sample file named HOSTS,
located in the aforementioned directory, can be used as the template for creating
this file. Computer name and IP address entries must be made to this file so this
computer can access the remote computer running the VDM. An example file is
shown below with edits for the remote computer name NODE1.

# Copyright (c) 1993-1995 Microsoft

# Corp.
#
# This is a sample HOSTS file used by
# Microsoft TCP/IP for Windows/NT
#
# This file contains the mappings of
# IP addresses to host names. Each
# entry should be kept on an individual
# line. The IP address should
# be placed in first column followed
# by the corresponding host name.
# The IP address and the host name
# should be separated by at least one
# space.
#
# Additionally, comments (such as
# these) may be inserted on individual
# lines or following the machine name
# denoted by a # symbol.
#
# For example:
#
# 102.54.94.97 rhino.acme.com # source server
# 38.25.63.10 x.acme.com # x client host

127.0.0.1 localhost
200.200.200.5 node1 # Node 1 IP address

Additional TCP/IP Installation Tips

Genie 2000 uses (by default) the port numbers 1200, 1300, and 2000 when creating
socket connections for client/server communications. These are in the range of “user de-
fined” services as specified by the TCP/IP standard. It is possible that these may be de-
fined by another application on your computer, causing conflicts with Genie 2000. If
problems persist in establishing client connections to the VDM, this may be a possible
cause of the problems. To verify, examine the file
WINNT\SYSTEM32\DRIVERS\ETC\SERVICES, as shown below.

9
Installation and Setup

# Copyright (c) 1993-1995 Microsoft Corp.

#
# This file contains port numbers for
# well-known services as defined by
# RFC 1060 (Assigned Numbers).
#
# Format:
#
# <service name> <port number>/
# <protocol> [aliases...] [#comment>]
echo 7/tcp
echo 7/udp
discard 9/tcp sink null
discard 9/udp sink null
systat 11/tcp
systat 11/tcp users
daytime 13/tcp
daytime 13/udp
netstat 15/tcp
.
.
.
kpop 1109/tcp # Pop with Kerberos
phone 1167/udp
ingreslock 1524/tcp
maze 1666/udp
nfs 2049/udp # sun nfs.
.
.
.
Check to see if any one of the default Genie 2000 port numbers is defined. If so, then ed-
its must be made to this file as follows:

Datasrce nnnn/tcp # VDM datasource connection

Advise nnnn/tcp # VDM advise connection
Configur nnnn/tcp # VDM configuration connec-
tion

where nnnn is an undefined port number.

If a Dialup Adapter is used for binding the TCP/IP protocol stack, it is possible that your
Windows system is set up to “Connect to the Internet as needed”. This feature will

10
 Non-Network VDM Configuration

instruct the system to prompt you for an Internet connection whenever a Genie 2000
client application connects to the VDM.

To disable this behavior, bring up the Internet settings applet from within the Control
Panel. Use the Connections notebook tab (as shown in Figure 7) and uncheck the
checkbox labeled “Connect to the Internet as needed”; click on OK to save this settings
change.

Figure 7 Connect to Internet

Non-Network VDM Configuration

This section provides procedures for VDM configuration of a non-network Windows
2000 or Windows XP system.

Windows-2000 Setup
This procedure supercedes the TCPIP configuration procedure for Windows-2000 instal-
lations that do not contain a network adapter.

Communication to the Virtual Data Manager (VDM) is performed using the TCPIP net-
work protocol stack. With Windows-2000 installations, the configuration of this protocol
differs somewhat from the Windows-NT installations when network adapter is not resi-
dent in the computer. Follow the steps outlined below to configure the TCPIP protocol
stack.

11
Installation and Setup

1. Connect the Genie hardware key to the local parallel port.

2. Log in to a local Administrator account.

3. Click Start | Setting. Click on the Network and Dialup Connections.

4. Double click on “Make New Connection”. This will launch the Network
Connection Wizard. Click on Next to continue

5. Select Connect to a Private Network through the Internet as shown in Figure 8.

Click on Next.

Figure 8 Selecting the Network Conection Type

12
 Non-Network VDM Configuration

6. Select Do Not Dial the Initial Connection as shown in Figure 9. Click on Next.

Figure 9 Connecting to the Public Network

7. Enter a Host IP of 100.0.0.1 as shown in Figure 10. Click on Next.

Figure 10 Entering the IP Adress

13
Installation and Setup

8. Select “All Users”.

9. When prompted to Connect, select Cancel.

Windows-XP Setup
This procedure supercedes the TCPIP configuration procedure for Windows-XP installa-
tions that do not contain a network adapter.

Communication to the Virtual Data Manager (VDM) is performed using the TCPIP net-
work protocol stack. With Windows-2000 installations, the configuration of this protocol
differs somewhat from the Windows-NT installations when network adapter is not resi-
dent in the computer. Follow the steps outlined below to configure the TCPIP protocol
stack.

1. Connect the Genie hardware key to the local parallel port.

2. Log in to a local Administrator account.

3. Click on Start | Settings then Network and right click on “Network”.

4. This will launch the New Network Connection Wizard. Click Next to continue.

5. Select “Setup and Advanced Network Connection” as shown in Figure 11. Click
on Next.

Figure 11 Selecting the Network Connection

Type

14
 Non-Network VDM Configuration

6. Do not configure any connection devices if this is a stand-alone system. See

Figure 12. Click on Next.

Figure 12 Selecting Devices for Incoming Con-

nection

7. Select “Allow Virtual Private Connections” as shown in Figure 13. Click on

Next.

Figure 13 Selecting the VPN Connection

15
Installation and Setup

8. Select all users you wish to have access rights to the network. At a minimum,
the Local Administrator must have network rights assigned. Click on Next.

9. Add the network protocols to the network. TCPIP must be added at this time if
not already in the protocol list. See Figure 14. Click on Next.

Figure 14 Selecting the Network Software

11. Configure a range of IP addresses allowed to access the system. A minimum

range must be assigned as shown in Figure 15. Click OK.

16
 Installing AIM Device Drivers

Figure 15 Configuring the IP Address

12. Click Next and restart your system. When the system is restarted, verify the
VDM starts correctly by simply opening a hardware or software datasource

Installing AIM Device Drivers

In order to communicate with an AIM acquisition device under Genie 2000, a special
protocol stack must be installed.

• The Windows NT AIM setup is described on page 18.

• The Windows 2000/XP AIM setup is described on page 18.

For CD-ROM distributions, the following table shows the CD-ROM location of the AIM
drivers for each operating system.

CD-ROM Operating
Directory System

NT Windows-NT

2000 Windows 2000

17
Installation and Setup

Windows NT AIM Setup

The following steps should be followed to ensure proper setup of the AIM protocol stack
under Windows NT:

1. Launch the Network applet (via the Control Panel).

2. Click on the Protocols notebook tab and then press the Add button.

3. Click on the Have Disk button.

4. Make sure the CD is still loaded in the CD-ROM drive. Select the directory
(?:\NT) having the required Windows NT AIM driver, where ? is your
CD-ROM drive.

5. A dialog box will appear having the following entry: Canberra 802.3 SNAP
Protocol Driver V1.0; click OK to accept this protocol.

6. Make sure that the Canberra 802.3 SNAP Protocol is bound to the correct
Ethernet adapter (this is not an issue if you have only one Ethernet adapter in
your computer). If multiple adapters are present, the adapter binding can be
determined from the Bindings dialog. The name of the protocol can be clicked
on which brings up a list of adapters it is bound to. Highlight the adapter(s)
which do not require the Canberra 802.3 protocol driver and click on Disable.
Click on Close to save these new bindings.

7. Exit the Network settings dialog by clicking on OK (follow the prompts for
your Windows distribution and reboot your system.)

Windows 2000/XP Setup

The following steps should be followed to ensure proper setup of the AIM protocol stack
under Windows 2000/XP:

1. Launch the Network and Dial-up Connections applet for Windows 2000 or the
Network Connections applet for Windows XP (via the Control Panel).

2. Right click on the Local Area Connection icon and click Properties.

3. Click the Install pushbutton on the Local Area Connection Properties window.

4. Highlight Protocol and then click the Add pushbutton.

5. Click on the Have Disk pushbutton.

18
 Installing AIM Device Drivers

6. Make sure the CD is still loaded in the CD-ROM drive. Click the Browse
pushbutton to select the directory (?:\2000) having the required Windows
2000/XP AIM drivers, where ? is your CD-ROM drive.

7. Click OK.

8. A dialog box will appear having the following entry: Canberra NDIS 5.0 SNAP
Protocol Driver; click OK to accept this protocol.

9. (Insert step 6 of NT Setup here, changing only Canberra 802.3 SNAP Protocol
with Canberra NDIS 5.0 SNAP Protocol in both places)

10. Exit the Local Area Connection Properties dialog by clicking Close (follow the
prompts for your Windows distribution and reboot your system).

19
Programming Library Reference

2. Programming Library Reference

Index of Routines
Routine Description Page

fUtlCAMToStr Changes CAM time format to an ASCII string. 70

fUtlCAMToCTime Changes CAM time format to C time format. 69

fUtlCTimeToCAM Changes C time format to CAM time format. 69

fUtlStrToCAM Changes an ASCII string to CAM time format. 70

fUtlTimeNow Fetches the current system date/time. 68

iUtlCreateFileDSC Establishes a connection to the local VDM. 68

SadCalculate Returns calculated data for an ROI. 51

SadClassCopy Copies a class of CAM data from the input 57

datasource.

SadClassCount Returns the number of records in a CAM class. 52

SadCloseDataSource Closes a datasource. 36

SadControlDSC Issues control commands to the hardware 56

devices.

SadCopyRecord Copies a CAM record from one datasource to 60

another.

SadCreateBlock Creates a block of a given class in a CAM file. 65

SadCreateDSC Establishes a standard connection to the VDM 29

SadCreateDSC2 Establishes a special connection to the VDM. 29

SadCreateFile Creates a CAM file and opens it for exclusive 37

read/write.

SadDeleteDSC Deletes a connection to the VDM. 30

SadDeleteOne Deletes a record or entry from a datasource. 55

SadEntryCount Returns the number of entries in a CAM class. 53

SadEnumNodes List local and remote VDMs. 32

SadFindRecord Searches for a specific CAM record of data. 58

20
SadFlush Saves datasource changes to the original 35
datasource.

SadGetArray Reads an array of values for a CAM parameter. 43

SadGetICB Reads from the specified ICB register. 65

SadGetListCAM Reads a set of values for a list of CAM 46

parameters.

SadGetParam Reads a CAM parameter value from a 41

datasource.

SadGetSpectrum Reads spectral data from a datasource. 40

SadGetStatus Returns a 32-bit error code. 31

SadInfoICB Fetches model and serial numbers from the 64

specified ICB device.

SadInsertOne Inserts a record or entry into a datasource. 54

SadOpenDataSource Opens a datasource. 33

SadOpenICB Opens the MCA, specifies the ICB device and 62

verifies communication.

SadPutArray Writes an array of values for a CAM parameter. 44

SadPutICB Writes to the specified ICB register. 64

SadPutListCAM Writes a set of values for a list of CAM 47

parameters.

SadPutParam Writes a CAM parameter value to a datasource. 42

SadReadUFBlock Reads data written to a CAM file by a call to 66

SadWriteUFBlock.

SadPutSpectrum Writes spectral data to a datasource. 40

SadQueryCAM Retrieves information about a CAM parameter 39

name.

SadQueryDataSource Returns information about a datasource. 61

SadQueryDSC Returns information stored in a DSC structure. 38

SadSaveAs Saves datasource changes to another datasource. 35

SadSetCurrent Selects a member of a multi-memory group. 56

SadWriteUFBlock Writes data to a CAM file block created by 67

SadCreateBlock.

21
Programming Library Reference

vG2KEnv() Reads a Genie 2000 environmental setting from 71

the registry.

Organization of This Chapter

This chapter, which is a programmer’s reference guide for the programming library rou-
tines, assumes a basic knowledge of C programming and an understanding of the basic
operation of Windows.

The chapter is organized to present the significant concepts, tools and routines in separate
sections.

• Genie 2000 Software Architecture is a brief overview of the Genie 2000

software architecture.
• Configuration Access Method (CAM) describes the data storage model of
Genie 2000 datasources (including spectral data and associated parameters).
• Programming Library Files describes the key INCLUDE and library files
provided with the programming library and their use.
• Programming Library Routines Reference describes the programming library
routines.
• Utility Library Routines Reference describes various utility library routines that
provide additional support for developing Genie 2000 application programs.
• Analysis Engine Requirements describes the design requirements for
constructing an “analysis engine”.
• Example Programs lists and describes example programs that use the
programming library routines.

22
 Genie 2000 Software Architecture

Genie 2000 Software Architecture

The Genie 2000 software architecture is based on the client/server paradigm. This archi-
tecture model allows an application to be partitioned into client and server components
which can execute together in one computer or be distributed across computers over a
network. An InterProcess Communication (IPC) subsystem provides the connective layer
between the components. Figure 16 illustrates the Genie 2000 software architecture by
providing an overview of its system software components.

Figure 16 Genie 2000 Software Architecture

The server component, known as the Virtual Data Manager (VDM) provides essential
spectroscopy-related services to its clients. The interface to these services, which include
spectral data file, MCA, and front-end electronics hardware control/access services, ap-
pears to the client as a generic consistent set of APIs (Application Programming Inter-
faces). These APIs define the calling conventions for the programming library routines.

Configuration Access Method (CAM)

Configuration datasources store spectral and related parameter data. Since the types of
data that need to go into a configuration are quite varied, Canberra has designed a flexi-
ble, general-purpose system for defining the format of and the access to the data. This
system is called the Configuration Access Method (CAM). The CAM subsystem consists
of two major components:

1. A database schema file which defines the format of the CAM datasources.

23
Programming Library Reference

2. A set of programming library routines which access the data in the CAM
datasources, according to the schema file.

Once a CAM datasource is open for access, all read/writes to the datasource are directed
to a memory cache (for performance reasons) which contains the current state of the
datasource. The user of the CAM subsystem must explicitly flush this cache to disk be-
fore closing the datasource in order to preserve all changes made to the datasource during
access.

CAM Data and Parameters

Among the types of data to be stored when a sample is counted are the spectral data it-
self, elapsed time information, sample information, calibration information, and so forth.
In addition, if the data is analyzed, the analysis results must be stored.

CAM knows about two kinds of data: parameters and spectral channel data. A parameter
is a single number or text string, such as preset real time or sample title. Each parameter
is assigned a unique symbolic code, by which it can be accessed using the programming
library routines. Using the appropriate routine, a user can read the value of a parameter or
write a new value.

Spectral data is an array of 32-bit integers. Again, using the appropriate routines, a user
can read or write the spectral channels by specifying a start channel and the number of
channels to access.

The different kinds of data which make up a CAM datasource are separated into classes
of information. The data composing each class of information is considered to be rela-
tively independent of the data in other classes. CAM defines four types of parameters that
may exist in any given class. Figure 17 shows a typical CAM data class structure.

24
 Configuration Access Method (CAM)

Figure 17 Typical CAM Data Class Structure

1. Common: Each common parameter occurs only once in a class.

2. Common Tabular: Each common tabular parameter may occur a fixed number
of times per class. To access a common tabular parameter, an entry number must
be specified.

3. Record: Each record parameter can occur an indefinite number of times. To

access a record parameter, a record number must be specified.

4. Record Tabular: A record tabular parameter can occur a variable number of

times per record. To access a record tabular parameter, both a record and entry
number must be specified.

Refer to Appendix A, “CAM File Structure”, for a complete listing of all CAM parame-
ters by class, including each parameter’s symbolic code and a brief description of the pa-
rameter.

25
Programming Library Reference

Programming Library Files

The following development-related files are distributed as part of the Genie 2000 Pro-
gramming Library:

Include Files
CITYPES.H: Contains definitions for the various data storage declarations
used by the programming library routines.

CAMDEF.H: Contains definitions for the CAM class values (i.e.

CAM_CLS_xxxx).

CAMPDEF.H: Contains definitions for the CAM parameter identifiers.

CAM_N.H: Contains definitions that specify the maximum length of all

CAM string-type parameters (i.e. CAM_T_xxxx parameters).

CAMMSGS.H: Contains definitions for the various detailed CAM-specific error

codes that may be returned via SadGetStatus.

SAD.H: Contains the function prototype definitions for the programming

library (SAD) routines.

SAD_NEST.H: Contains various definitions for structures and constants required

to call the programming library routines. Note that this file is au-
tomatically included as part of SAD.H.

SAD_RC.H: Contains definitions for the various programming library error

return codes. Note that this file is automatically included as part
of SAD.H.

IPC.H: Contains the definition for the network configuration record

structure used by SadEnumNodes.

SPASST.H: Contains definitions for HMEM (handle to a datasource context)

and open mode bits used by SadOpenDataSource.

UTILITY.H: Contains the function prototype definitions for the utility library
routines.

CAMINFO.H: Contains the structure definition for the information returned by

SadQueryCAM.

CI_FILES.H: Contains the definitions for the datasource types (i.e. file, hard-
ware) used by SadOpenDataSource.

DRIVER.H: Contains definitions for the control opcodes used by

SadControlDSC.

COM_VDM.H: Contains the structure definition for the information returned by

SadQueryMidFile. Note that this file is automatically included as
part of SAD_NEST.H.

26
 Programming Library Routines Reference

CRACKERS.H: Contains definitions for various system semaphores.

GET_PUT.H Contains WST_codes and structures definitions to support the

SadPutStruct and SadGetStruct functions

ANADEFS.H: Contains definitions for various analysis related error codes.

Library Files
OS2WIN32.LIB: The DLL link library that contains support functions used by the
fUtlStrToCAM and fUtlCAMToStr Utility Library routines.

SAD.LIB: The DLL link library that contains the programming library
(SAD) routines. Note that the library file must be placed in a
path that is defined in the system environment variable LIB.

UTILITY.LIB: The object library that contains the utility library routines.

Example Files
EXAMPLE.C: An example C program (described in “Example Program” on
page 74) that demonstrates the proper usage of the programming
library routines.

EXAMPLE.MAK: An example MAKE file that shows the proper compile and link
options that need to be used when developing application pro-
grams that use the programming library routines.

EXAMPLE.DSP A Microsoft Developer Studio project file for EXAMPLE.C.

EXAMPLE2.C An example C program that demonstrates how acquisition of

data is performed.

Programming Library Routines Reference

The programming library routines provide access to VDM functions and are prefixed
with “SAD” (System Access to Data).

These routines will always return a SHORT value as follows:

• CSI_Okay: Success. Unless this value is returned, the output parameters for
the routines described below are not defined.
• CSI_Error: Error encountered, use the SadGetStatus routine to return more
detailed information as to what error was generated within the system.
• CSI_NoDSC: An invalid DSC value (see SadCreateDSC) was specified (or in
the case of SadCreateDSC, a DSC could not be created due to memory
allocation problems).

27
Programming Library Reference

• CSI_WrongState: A routine was called out of sequence (for example, an

attempt was made to close a datasource which was not open).

Other possible miscellaneous return values are listed with the description of the
programming library routines.

Naming Conventions
The following variable naming conventions (i.e. prefixes) are used throughout the pro-
gramming routines reference sections:

sz: null-terminated string (i.e. 0 terminated array of character)

f: boolean (i.e. flag value)

r: float (i.e. single precision floating point value)

d: double (i.e. double precision floating point value)

l: long

i: integer

s: short

fs: short used as a “bit-mapped” value

fl: long used as a “bit-mapped” value

st: structure

u: union

a: In front of the above indicates “array of”

p: In front of the above indicates “pointer to”

Every description for the programming routine parameters defines the data storage
definition (in bold type) that should be used when declaring the parameter variables.

Create a Special VDM Connection

This routine establishes a special connection to the VDM (in other words, a connection
that will work with both the standard Genie 2000 and S560 Genie 2000 runtime environ-
ment). This routine returns a Data Source Context (DSC) which is used by all subsequent
SAD routines.

28
 Programming Library Routines Reference

Calling Convention
sReturn = SadCreateDSC2 ( &stConfig, &hDSC, 0, 0 )

Parameters
stConfig: This input parameter (structure ipcCfg_T as specified in IPC.H)
contains node and pipe name information which defines which
VDM the connection is being requested for. This parameter will
typically be filled in through a call to the SadEnumNodes routine
(see “Enumerate a List of VDMs” on page 31).

If this parameter is NULL, then a temporary DSC is established.

This is used when attempting to invoke the SadEnumNodes rou-
tine.

hDSC: This output parameter will contain a handle (HMEM as defined

in SPASST.H) to a DSC as created by this routine.

Parameters 3 and 4 must be specified as 0; they are reserved for use by the Genie 2000
software.

Operational Notes
If an error status of CSI_Error is returned, the DSC structure has been allocated but an at-
tempt to connect to the specified VDM has failed. Use the SadDeleteDSC routine to
de-allocate the DSC structure after gathering detailed error code information via a call to
SadGetStatus.

Example
ipcCfg_T stConfig;
HMEM hDSC;
SHORT sRC;
•
•
•
sRC = SadCreateDSC2(&stConfig, &hDSC, 0, 0)

Create a Standard VDM Connection

This routine establishes a standard connection to the VDM (that is, a connection that will
work only with the standard Genie 2000 runtime environment). This routine returns a
Data Source Context (DSC) which is used by all subsequent SAD routines.

Calling Convention
sReturn = SadCreateDSC ( &stConfig, &hDSC, 0, 0 )

29
Programming Library Reference

Parameters
stConfig: This input parameter (structure ipcCfg_T as specified in IPC.H)
contains node and pipe name information which defines which
VDM the connection is being requested for. This parameter will
typically be filled in through a call to the SadEnumNodes routine
(see “Enumerate a List of VDMs” on page 31).

If this parameter is NULL, then a temporary DSC is established.

This is used when attempting to invoke the SadEnumNodes rou-
tine.

hDSC: This output parameter will contain a handle (HMEM as defined

in SPASST.H) to a DSC as created by this routine.

Parameters 3 and 4 must be specified as 0; they are reserved for use by the Genie 2000
software.

Operational Notes
If an error status of CSI_Error is returned, the DSC structure has been allocated but an at-
tempt to connect to the specified VDM has failed. Use the SadDeleteDSC routine to
de-allocate the DSC structure after gathering detailed error code information via a call to
SadGetStatus.

Example
ipcCfg_T stConfig;
HMEM hDSC;
SHORT sRC;
•
•
•
sRC = SadCreateDSC(&stConfig, &hDSC, 0, 0)

Delete a VDM Connection

This routine deletes a connection to the VDM (by disconnecting from the VDM and
cleaning up the DSC structure).

Calling Convention
sReturn = SadDeleteDSC ( hDSC )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

Operational Notes
If an error status of CSI_Error is returned, the DSC structure was not deleted. Use
SadGetStatus to gather detailed error information as to why.

30
 Programming Library Routines Reference

Example
HMEM hDSC;
SHORT sRC;
•
•
•
sRC = SadDeleteDSC(hDSC);

Get Detailed Error Information

This routine returns a detailed 32-bit error code; this code provides the actual error that
caused a CSI_Error return. Refer to Appendix C, Error Codes and Messages for an ex-
planation of the 32-bit error code.

Calling Convention
sReturn = SadGetStatus ( hDSC, &ulError, &sDummy1, &usDummy2 )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

ulError: This output parameter will contain the ULONG (32-bit) error
code as returned by this routine.

sDummy1: This output parameter is reserved for use by the Genie 2000 soft-
ware; a valid address of an SHORT must be passed to the rou-
tine for a successful invocation.

usDummy2: This output parameter is reserved for use by the Genie 2000 soft-
ware; a valid address of an USHORT must be passed to the rou-
tine for a successful invocation.

Example
HMEM hDSC;
SHORT sRC, sDum1;
USHORT usDum2;
ULONG ulError;
•
•
•
sRC = SadGetStatus(hDSC),&ulError,&sDum1,&usDum2);

Enumerate a List of VDMs

This routine is used to list the VDMs (both local and remote) as defined in the Network
Configuration File. For more details, refer to “Genie 2000 Network Configuration File”
in the Network Considerations manual (in your Genie 2000 Application Options binder).

31
Programming Library Reference

Calling Convention
sReturn = SadEnumNodes ( hDSC, &stConfig, &usNo, chType )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).
For this routine, the DSC will be created by calling
SadCreateDSC with a NULL pointer for the &stConfig parame-
ter.

stConfig: This output parameter (structure ipcCfg_T as specified in

IPC.H) contains node and pipe name information for a VDM as
defined in the Network Configuration File.

usNo: This input/output parameter contains an USHORT value that is

used to define which record of the Network Configuration File is
used as the starting point for searching for the specified type of
VDM.

chType: This input parameter contains a CHAR value which is used to

specify the type of VDM that should be searched for. Legal val-
ues are:

M: VDMs that support hardware only

F: VDMs that support files only

B: VDMs that support both files and

hardware

Operational Notes
The usNo parameter is ordinarily set to 1 before invoking the SadEnumNodes routine for
the first time and is simply passed to each successive call of the routine (i.e. it is automat-
ically incremented and returned by the routine). Note that specifying usNo=0 will return
the name of the local node as defined in the first line of the Network Configuration File.

If successful, the stConfig structure parameter has been filled in. The local VDM defini-
tion is located by checking for an empty stConfig.szNode string.

Additional error returns:

CSI_End: No more matching VDM entries are found.

Example
ipcCfg_T stConfig;
HMEM hDSC;
SHORT sRC;
USHORT usNo = 1;

32
 Programming Library Routines Reference

•
•
•
sRC = SadCreateDSC(NULL, &hDSC, 0, 0);

/* Look for a hardware-only type VDM */

sRC = SadEnumNodes(hDSC, &stConfig, &usNo, ‘M’);
if (sRC == CSI_End) {
/* No VDM of ‘M’ type found */
}
if (sRC) {
/* Fatal error occurred during SadEnumNodes */
}
sRC = SadDeleteDSC(hDSC);

/* Connect to ‘M’ type VDM */

sRC = SadCreateDSC(&stConfig, &hDSC, 0, 0);

Open a Datasource
This routine is used to open a CAM datasource (i.e. detector input or file). Once a
datasource is open, subsequent datasource-related SAD routine operations may be per-
formed (i.e. read/write parameters).

Calling Convention
sReturn = SadOpenDataSource ( hDSC, szName, usType, fsAccess, fVerify, szShellID )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

szName: This input parameter contains a null-terminated character string

(i.e. PSZ) which defines the name of the datasource. If usType
represents a file (see below), then szName must be a fully-speci-
fied pathname of the file; if usType represents hardware, then
szName must contain the name of a detector input that is cur-
rently loaded in the VDM’s runtime database.

usType: This input parameter contains an USHORT value which repre-

sents the type of datasource to be opened. Legal values (as de-
fined in CI$FILES.H) include:

CIF_NativeSpect: File type

CIF_Detector: Hardware type

33
Programming Library Reference

fsAccess: This input parameter contains a FLAGS value which defines a

set of bits that represent the access mode for opening the speci-
fied datasource. Legal bit values (as defined in SPASST.H) in-
clude:

ACC_ReadOnly: Read-Only access

ACC_ReadWrite: Read/write access

ACC_Exclusive: Exclusive open access

ACC_SysWrite: System write access

ACC_AppWrite: Application write access

ACC_Direct: Open direct; bypass the VDM

The ACC_Exclusive bit implies exclusive ownership by the ap-

plication performing the open (i.e. no other applications will be
allowed to open this datasource). The ACC_SysWrite and
ACC_AppWrite bits define which type of read/write access is
being provided. In general, all user applications should use the
ACC_AppWrite bit when opening datasources – this allows for
proper operation with the MCA View/Control window which
uses the ACC_SysWrite bit.

fVerify: This input parameter contains a FLAG value which enables

(when defined TRUE or 1) or disables (when FALSE or 0) the
hardware verification process. This parameter is only used when
attempting to open hardware datasources.

szShellID: This input parameter contains a null-terminated character string

(i.e. PSZ) which defines an application shell identifier. This pa-
rameter is used to allow two applications to share read/write ac-
cess to a datasource (i.e. one using ACC_SysWrite and the other
using ACC_AppWrite). In order for sharing to be allowed, the
two applications must call the SadOpenDataSource routine and
specify the same unique application shell identifier.

Operational Notes
In order to open a datasource for ACC_AppWrite such that it can be shared with the
MCA View/Control window, the application shell identifier must be defined as the name
of the local node with the process ID of the application’s parent appended to the end (i.e.
LOCAL12 where LOCAL is the local node name and 12 is the process ID of the applica-
tion’s parent).

Additional error returns:

CSI_Verify: Hardware verification failure occurred during open.

34
 Programming Library Routines Reference

Example
HMEM hDSC;
SHORT sRC;
•
•
•
sRC = SadOpenDataSource(hDSC, "C:\\GENIEPC\\CAMFILES\\NBSSTD.CNF",
CIF_NativeSpect,
ACC_ReadOnly, FALSE, "");

Save a Datasource
These two routines save all data and parameter changes to a datasource. The SadFlush
routine saves to the original datasource while the SadSaveAs routine allows saving to an-
other datasource.

Calling Convention
sReturn = SadFlush ( hDSC )

sReturn = SadSaveAs ( hInpDSC, hOutDSC )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC). It
is assumed that a datasource has already been opened via
SadOpenDataSource.

hInpDSC: This input parameter contains a handle (HMEM as defined in

SPASST.H) to a DSC (as created by a call to SadCreateDSC)
and is considered the input datasource (i.e. this is where the
saved data is read from). It is assumed that a datasource has been
previously opened via SadOpenDataSource.

hOutDSC: This input parameter contains a handle (HMEM as defined in

SPASST.H) to a DSC (as created by a call to SadCreateDSC)
and is considered the output datasource (i.e. this is where the
saved data is written to). This hDSC must refer to a file
datasource that has been previously opened via
SadOpenDataSource or created via SadCreateFile.

Operational Notes
These routines save to, but do not close, the specified datasource(s). Note that the
SadSaveAs routine replaces all data in hOutDSC.

Additional error returns:

CSI_Source: An error has occurred involving the input datasource.

35
Programming Library Reference

CSI_Target: An error has occurred involving the output datasource.

If either of the above errors is returned, use the corresponding DSC to query for
additional detailed information via SadGetStatus.

Example
HMEM hDSC, hOutDSC;
SHORT sRC;
•
•
•
sRC = SadFlush(hDSC);
sRC = SadSaveAs(hDSC, hOutDSC);

Close a Datasource
This routine closes the specified datasource.

Calling Convention
sReturn = SadCloseDataSource ( hDSC )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC). It
is assumed that the datasource has been previously opened via
SadOpenDataSource.

Operational Notes
Note that this routine does not save any data that has been cached for the specified
datasource. To save any changes to disk, the application program must issue a SadFlush
call before closing the datasource.

Example
HMEM hDSC;
SHORT sRC;
•
•
•
sRC = SadCloseDataSource(hDSC);

Create a File Datasource

This routine will create a skeleton CAM file and open it for exclusive read/write (i.e.
ACC_Exclusive and ACC_ReadWrite). This file can now be used to write or save data
to.

36
 Programming Library Routines Reference

Calling Convention
sReturn = SadCreateFile (hDSC, szFile, fOverride, usFType, usAType, usNoChans )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC). If
the hDSC argument is a temporary one (i.e. created using a
NULL first argument to SadCreateDSC), then the file that is cre-
ated will be an “open direct” version.

szFile: This input parameter contains a null-terminated character string

(i.e. PSZ) which defines the fully-specified pathname of the file
datasource to be created.

If this parameter is specified as a null string, then a temporary

file is created (this type of file is automatically deleted upon is-
suing a SadCloseDataSource call).

fOverride: This input parameter contains a FLAG value that determines

what happens if the specified file datasource already exists. If
TRUE (or 1), then an existing file will be automatically over-
written. If FALSE (or 0), then an error will occur if the specified
file datasource exists.

usFType: This input parameter contains a USHORT value that specifies

the type of CAM file to be created. This parameter is typically
defined as CAM_CTYP_ACQD (defined in CAMDEF.H).

usAType: This input parameter contains a USHORT value that specifies

the application code type stored in the CAM file. This parameter
is typically defined as CAM_CAP_GSPEC (defined in
CAMDEF.H).

usNoChans: This input parameter contains a USHORT value that specifies

the no. of spectral data channels that will require storage in the
CAM file. This number should correspond to the value of
CAM_L_CHANNELS as stored within the file.

Operational Notes
Note that this routine does not perform any initialization of CAM parameters (other than
the CAM_L_CHANNELS parameter) within the file. This is the responsibility of the ap-
plication program.

Example
HMEM hDSC;
SHORT sRC;
•
•
•
sRC = SadCreateFile(

37
Programming Library Reference

hDSC, "C:\\GENIEPC\\CAMFILES\\NEWFILE.CNF",
TRUE, CAM_CTYP_ACQD, CAM_CAP_GSPEC, 4096);

Retrieve Information from a DSC

This routine returns specific information that is stored within the DSC structure (e.g.
VDM type, datasource name, etc.).

Calling Convention
sReturn = SadQueryDSC ( hDSC, usOpcode, &unValue )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usOpcode: This input parameter contains a USHORT value that specifies

the type of information that is to be returned. Legal values (as
defined in Sad_NEST.H) include:

DSC_ServerType: Type of VDM (M, F, or B)

DSC_CurrentMem: Current member no. of a

multi-memory group input

DSC_CountMem: Total no. of memory groups

DSC_NameOfDS: Name of datasource. In the case of a

multi- memory group detector input,
this will be returned in the format
DETNAME(n:m).

DSC_WeighVDM: Type of VDM where:

0: S400 (Standard)
1: S402 (Standalone)
2: S404 (InSpector)

unValue: This output parameter (union FetchFrom_T as defined in

Sad_NEST.H) will contain the value for the specific item of in-
formation requested via the usOpcode parameter.

Example
HMEM hDSC;
SHORT sRC;
FetchFrom_T stData;
•
•
•
sRC = SadQueryDSC(hDSC, DSC_CurrentMem, &stData);

38
 Programming Library Routines Reference

Retrieve Information from the CAM Schema File

This routine is used to retrieve information about a CAM parameter name (the portion af-
ter the CAM_x_ prefix) from the CAM schema file (i.e. its ULONG identifier, its stor-
age type, description, etc.).

Calling Convention
sReturn = SadQueryCAM ( hDSC, &stQuery, &stResult )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

stQuery: This input parameter (structure QueryCAM_T as defined in

Sad_NEST.H) specifies the CAM parameter name (via structure
member szParamName; the remaining members of the structure
are reserved for use by the Genie 2000 software).

stResult: This output parameter (structure InfoCAM_T as defined in

CAMINFO.H) will contain schema file information about the
specified CAM parameter. This includes:

– ULONG identifier (structure member ulParam)

– Return type (structure member usRType); values defined in

CAMINFO.H.

– Size in bytes (structure member usSize)

– Description (structure member acDesc)

Example
HMEM hDSC;
SHORT sRC;
QueryCAM_T stQuery;
InfoCAM_T stInfo;
•
•
•
strcpy (stQuery.szParamName, "SQUANT");
sRC = SadQueryCAM(hDSC, &stQuery, &stInfo);

Read Spectral Data

This routine will read spectral data from a datasource for the specified range of channels.

39
Programming Library Reference

Calling Convention
sReturn = SadGetSpectrum ( hDSC, usStart, usCount, fFloat, aulData )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usStart: This input parameter contains a USHORT value which specifies

the starting channel number.

usCount: This input parameter contains a USHORT value which specifies

the number of channels to read.

fFloat: This input parameter contains a FLAG value. A value of TRUE

(or 1) returns the spectral data as REAL values; a value of
FALSE (or 0) returns the data as ULONG values.

aulData: This output parameter will contain the set of spectral data as an
array of REAL or ULONG values based on the parameter
fFloat.

Operational Notes
A limit of 4000 channels can be read at one time.

Example
HMEM hDSC;
SHORT sRC;
ULONG aulChanData[1024];
•
•
•
sRC = SadGetSpectrum(hDSC, 1, 1024, FALSE,
aulChanData);

Write Spectral Data

This routine will write spectral data to a datasource for the specified range of channels.

Calling Convention
sReturn = SadPutSpectrum ( hDSC, usStart, usCount, aulData )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

40
 Programming Library Routines Reference

usStart: This input parameter contains a USHORT value which specifies

the starting channel number.

usCount: This input parameter contains a USHORT value which specifies

the number of channels to be written.

aulData: This input parameter contains the set of spectral data to be writ-
ten as an array of ULONG values.

Operational Notes
A limit of 4000 channels can be written at one time.

Example
HMEM hDSC;
SHORT sRC;
ULONG aulChanData[3];
•
•
•
aulChanData[0] = 1000;
aulChanData[1] = 2000;
aulChanData[2] = 3000;
sRC = SadPutSpectrum(hDSC, 100, 3, aulChanData);

Read a CAM Parameter Value

This routine reads a CAM parameter value from the specified datasource.

Calling Convention
sReturn = SadGetParam ( hDSC, ulParam, usRecord, usEntry, pValue, usSize )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

ulParam: This input parameter contains a ULONG value that specifies the
identifier of the CAM parameter value to be read; these identifier
codes are defined in the include file CAMPDEF.H.

usRecord: This input parameter contains a USHORT value that specifies

the record number of the CAM parameter value to be read. The
first record is defined as record number 1.

usEntry: This input parameter contains a USHORT value that specifies

the entry number of the CAM parameter value to be read. The
first entry is defined as entry number 1.

41
Programming Library Reference

pValue: This input/output parameter contains a pointer to the proper size

storage location for the value being read (e.g. REAL * for
CAM_F parameters, LONG * for CAM_L parameters, etc.).
This storage location must be large enough to hold the value of
the CAM parameter being read.

usSize: This input parameter contains a USHORT value that specifies

the size, in bytes, of the storage location pointed to by the pa-
rameter pValue.

Example
HMEM hDSC;
SHORT sRC;
REAL rQuant;
•
•
•
sRC = SadGetParam(hDSC, CAM_F_SQUANT, 0, 0, &rQuant, sizeof(REAL));

Write a CAM Parameter Value

This routine writes a CAM parameter value to the specified datasource.

Calling Convention
sReturn = SadPutParam ( hDSC, ulParam, usRecord, usEntry, pValue, usSize )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

ulParam: This input parameter contains a ULONG value that specifies the
identifier of the CAM parameter value to be written; these iden-
tifier codes are defined in the include file CAMPDEF.H.

usRecord: This input parameter contains a USHORT value that specifies

the record number of the CAM parameter value to be written.
The first record is defined as record number 1.

usEntry: This input parameter contains a USHORT value that specifies

the entry number of the CAM parameter value to be written. The
first entry is defined as entry number 1.

pValue: This input parameter contains a pointer to the value being writ-
ten (e.g. REAL * for CAM_F parameters, LONG * for CAM_L
parameters, etc.).

usSize: This input parameter contains a USHORT value that specifies

the size, in bytes, of the value being written.

42
 Programming Library Routines Reference

Operational Notes
A write to a record number (or entry number) that is 1 greater than last record (or entry)
is considered an append operation. Note that some tables are fixed-length and cannot be
expanded; the number of possible entries can be obtained via a call to SadEntryCount.

Example
HMEM hDSC;
SHORT sRC;
REAL rQuant;
•
•
•
rQuant = 11.11;
sRC = SadPutParam(hDSC, CAM_F_SQUANT, 0, 0, &rQuant, sizeof(REAL));

Read an Array of CAM Parameter Values

This routine is used to read an array of values for a particular CAM parameter (the set of
values is read either from multiple records or from multiple entries in a table).

Calling Convention
sReturn = SadGetArray ( hDSC, &stParam, usRecord, usEntry, pValue,
usCount, fsFlags )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

stParam: This input parameter (structure ListOfCAM_T as defined in

SAD_NEST.H) specifies the identifier (member ulParam) and
size (usSize) of the CAM parameter value to be read. The struc-
ture member usPCV is not used and is reserved for use by the
Genie 2000 software and must be zero.

usRecord: This input parameter contains a USHORT value that specifies

the starting record number of the CAM parameter value to be
read.

usEntry: This input parameter contains a USHORT value that specifies

the starting entry number of the CAM parameter value to be
read.

pValue: This input/output parameter contains either an array of pointers

to the location where the data is to be stored or a pointer to an
array to store the data (see parameter fsFlags).

usCount: This input parameter contains a USHORT value that specifies

the number of values being read.

43
Programming Library Reference

fsFlags: This input parameter contains a FLAGS value which defines a

set of bits that define the operation of the routine. Legal bit val-
ues (as defined in SAD_NEST.H) include:

GPA_Entry: If this bit is set, then the routine

fetches a set of tabular values by in-
crementing the entry number. If this
bit is not set, then the routine
fetches a set of values from multiple
records by incrementing the record
number.

GPA_Point: If this bit is set, then the pValue pa-

rameter is assumed to be an array of
pointers; if this bit is not set, then
the pValue parameter is assumed to
be a pointer to an array.

Example
HMEM hDSC;
SHORT sRC;
ListOfCAM_T stROIStart;
ULONG aulStart[16];
•
•
•
stROIStart.ulParam = CAM_L_RGNSTART;
stROIStart.usSize = sizeof(ULONG);
stROIStart.usPCV = 0;
sRC = SadGetArray(hDSC, &stROIStart, 1, 1, aulStart, 16, 0);

Write an Array of CAM Parameter Values

This routine is used to write an array of values for a particular CAM parameter (the set of
values is written either to multiple records or to multiple entries in a table).

Calling Convention
sReturn = SadPutArray ( hDSC, &stParam, usRecord, usEntry, pValue, usCount, fsFlags )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

stParam: This input parameter (structure ListOfCAM_T as defined in

SAD_NEST.H) specifies the identifier (member ulParam) and
size (usSize) of the CAM parameter value to be written. The
structure member usPCV is not used and is reserved for use by
the Genie 2000 software and must be zero.

44
 Programming Library Routines Reference

usRecord: This input parameter contains a USHORT value that specifies

the starting record number of the CAM parameter value to be
written.

usEntry: This input parameter contains a USHORT value that specifies

the starting entry number of the CAM parameter value to be
written.

pValue: This input/output parameter contains either an array of pointers

to the location where the data to be written is stored or a pointer
to an array containing the data to be written (see parameter
fsFlags).

usCount: This input parameter contains a USHORT value that specifies

the number of values being written.

fsFlags: This input parameter contains a FLAGS value which defines a

set of bits that define the operation of the routine. Legal bit val-
ues (as defined in SAD_NEST.H) include:

GPA_Entry: If this bit is set, then the routine

writes a set of tabular values by in-
crementing the entry number. If
this bit is not set, then the routine
writes a set of values to multiple
records by incrementing the record
number.

GPA_Point: If this bit is set, then the pValue

parameter is assumed to be an ar-
ray of pointers; if this bit is not set,
then the pValue parameter is as-
sumed to be a pointer to an array.

Example
HMEM hDSC;
SHORT sRC;
ListOfCAM_T stROIType;
ULONG aulType[16];
•
•
•
stROIStart.ulParam = CAM_L_RGNSTART;
stROIStart.usSize = sizeof(ULONG);
stROIStart.usPCV = 0;
aulType[0] = 1;
•
•
•
aulType[15] = 1;
sRC = SadPutArray(hDSC, &stROIType, 1, 0, aulType, 16, 0);

45
Programming Library Reference

Read a List of CAM Parameter Values

This routine is used to read a set of values for a list of specified CAM parameters.

Calling Convention
sReturn = SadGetListCAM ( hDSC, usRecord, usEntry, usCount,
usBytesPer, astParam, pvData )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usRecord: This input parameter contains a USHORT value that specifies

the record number from which the list of CAM parameter values
will be read.

usEntry: This input parameter contains a USHORT value that specifies

the entry number from which the list of CAM parameter values
will be read.

usCount: This input parameter contains a USHORT value that specifies

the number of CAM parameters being read.

usBytesPer: This input parameter contains a USHORT value that is used as

follows:

– If the value is non-zero, it must be 4 or 8. In that case, the

pValue parameter (see below) is assumed to be a pointer to an
array of storage locations of that size.

– If the value is zero, then the pValue parameter (see below) is

assumed to be an array of pointers, each of which point to a
storage location whose size is defined by the structure member
usSize for the corresponding astParam item (see below).

astParam: This input parameter is an array of structures (ListOfCAM_T as

defined in SAD_NEST.H) which specify the list of CAM param-
eter values to be read. Structure member ulParam defines the
CAM parameter identifier; structure member usSize defines the
size of the value (if the usBytesPer parameter is zero). The struc-
ture member usPCV is not used (reserved for use by the Genie
2000 software) and must be zero.

pValue: This input/output parameter contains either an array of pointers

to the location where the data is to be stored or a pointer to an
array to store the data (see parameter usBytesPer).

Example
HMEM hDSC;

46
 Programming Library Routines Reference

SHORT sRC;
static ListOfCAM_T astParams[2] = {
{ CAM_X_EREAL, 0, 0 },
{ CAM_X_ELIVE, 0, 0 }
};
DOUBLE adTimes[2];
•
•
•
sRC = SadGetListCAM(hDSC, 1, 0, 2, sizeof(DOUBLE), astParams, adTimes);

Write a List of CAM Parameter Values

This routine is used to write a set of values for a list of specified CAM parameters.

Calling Convention
sReturn = SadPutListCAM ( hDSC, usRecord, usEntry, usCount, usBytesPer, astParam,
pvData )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usRecord: This input parameter contains a USHORT value that specifies

the record number to which the list of CAM parameter values
will be written.

usEntry: This input parameter contains a USHORT value that specifies

the entry number to which the list of CAM parameter values will
be written.

usCount: This input parameter contains a USHORT value that specifies

the number of CAM parameters being written.

usBytesPer: This input parameter contains a USHORT value that is used as

follows:

– If the value is non-zero, it must be 4 or 8. In that case, the

pValue parameter (see below) is assumed to be a pointer to an
array of value locations of that size.

– If the value is zero, then the pValue parameter (see below) is

assumed to be an array of pointers, each of which point to a
value location whose size is defined by the structure member
usSize for the corresponding astParam item (see below).

47
Programming Library Reference

astParam: This input parameter is an array of structures (ListOfCAM_T as

defined in SAD_NEST.H) which specify the list of CAM param-
eter values to be written. Structure member ulParam defines the
CAM parameter identifier; structure member usSize defines the
size of the value (if the usBytesPer parameter is zero). The struc-
ture member usPCV is not used (is reserved for use by the Genie
2000 software) and must be zero.

pValue: This input/output parameter contains either an array of pointers

to the location where the data values are stored or a pointer to an
array of data values (see parameter usBytesPer).

Example
HMEM hDSC;
SHORT sRC;
static ListOfCAM_T astParams[2] = {
{ CAM_X_EREAL, 0, 0 },
{ CAM_X_ELIVE, 0, 0 }
};
DOUBLE adTimes[2];
•
•
•
adTimes[0] = 4000.0;
adTimes[1] = 4020.0;
sRC = SadPutListCAM(hDSC, 1, 0, 2, sizeof(DOUBLE),
astParams, adTimes);

Read a Related Set of CAM Parameters

This routine is used to read a related set of CAM parameter values.

Calling Convention
sReturn = SadGetStruct( hDSC, usSet, usRecord, usEntry, pvData, usSize )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC2).

usSet: This input parameter contains a USHORT value that specifies

the WST_ structure code to be read. Both WST_ codes and
structures are defined in GET_PUT.H.

usRecord: This input parameter contains a USHORT value that specifies

the record number from which the set of CAM parameter values
will be read.

48
 Programming Library Routines Reference

usEntry: This input parameter contains a USHORT value that specifies

the entry number from which the set of CAM parameter values
will be read.

pvData: This output parameter contains a pointer to the structure to re-

ceive the CAM parameter values.

usSize: This input parameter contains a USHORT value that specifies

the size, in bytes, of the storage location pointed to by the pa-
rameter pvData.

Example
HMEM hDSC;
SHORT sRC;
Preset_T stPSet;
•
•
•
sRC = SadGetStruct(hDSC, WST_SetPreset, 1, 1, &stPSet, sizeof(Preset_T));

Write a Related Set of CAM Parameters

This routine is used to write a related set of CAM parameter values. It is also the only
way to set acquisition presets.

Calling Convention
sReturn = SadPutStruct ( hDSC, usSet, usRecord, usEntry, pvData, usSize )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC2).

usSet: This input parameter contains a USHORT value that specifies

the WST_ structure code to be written. Both WST_ codes and
structures are defined in GET_PUT.H.
usRecord: This input parameter contains a USHORT value that specifies
the record number from which the set of CAM parameter values
will be written.

usEntry: This input parameter contains a USHORT value that specifies

the entry number from which the set of CAM parameter values
will be written.

pvData: This output parameter contains a pointer to the structure that

contains the CAM parameter values to be written.

usSize: This input parameter contains a USHORT value that specifies

the size, in bytes, of the storage location pointed to by the pa-
rameter pvData.

Example
HMEM hDSC;

49
Programming Library Reference

SHORT sRC;
Preset_T stPSet;
•
•
•
FillMemory(&stPSet, sizeof(Preset_T), ‘\0’ );
/* 30 second livetime preset */
stPSet.flPsetMode = CAM_M_PMOD_LIVE;
stPSet.unTime.dPsetTime = 30.0;
sRC = SadPutStruct(hDSC, WST_SetPreset, 1, 1, &stPSet, sizeof(Preset_T));

Setting Acquisition Preset

Acquisition preset can only be set with the SadPutStruct routine. The structure show be-
low is defined in the GET_PUT.H file.

#define WST_SetPreset 28/* Structure ID */

union pset_U {
double dPsetTime; /* seconds */

ULONG ulSweeps;

};

typedef struct {
long flPsetMode;
union pset_U unTime;

double dPsetComp;

ULONG ulStartCh; /* Define the range of - */

ULONGulStopCh; /* - the comp preset. */

} Preset_T;

The preset can be set as a time preset or a computational preset or a combination of the
two. It can also be set as a number of MCS sweeps; in this case both time and
computational presets are not allowed. The preset mode is determined by the
combination of bits set in the flPsetMode member of the Preset_T structure. The
following are valid bit definitions and their meanings:

CAM_M_PMOD_LIVE preset live time

CAM_M_PMOD_REAL preset real time

CAM_M_PMOD_SWEEPS preset sweeps

50
 Programming Library Routines Reference

CAM_M_PMOD_TOTALS preset integral

CAM_M_PMOD_LEVEL preset counts

CAM_M_PMOD_AREA preset area

For an example of setting presets, see the file EXAMPLE2.C in the S560 directory.

Retrieve ROI Information

This routine returns calculated data for a specified ROI (region of interest). Information
returned includes integral, area, area uncertainty, centroid, FWHM, FWTM, and Gaussi-
an ratio. These values correspond to those calculated and shown on the MCA View/Con-
trol Marker status page.

Calling Convention
sReturn = SadCalculate ( hDSC, &stROI, &stValue )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

stROI: This input parameter (structure CalcParam_T as defined in

SAD_NEST.H) describes the ROI for which the data will be re-
turned. Structure members usStart and usStop define the ROI
start/stop channels, member usBkgndChns defines the number of
background channels to be used, and member rSigma defines the
sigma at which area uncertainty is reported.

stValue: This output parameter (structure CalcValue_T as defined in

SAD_NEST.H) will contain the calculated values that are re-
turned for the ROI.

Operational Notes
The usBkgndChns and rSigma values will not be used; these values are read from the
datasource. The calculated values centroid, area, area uncertainty, FWHM, FWTM and
Gaussian ratio are computed only when the size of the ROI meets the following criteria:

51
Programming Library Reference

Number of Spectral ROI Size

Data Channels
256 ≤256
512-2048 ≤512
>2048 ≤1024

Example
HMEM hDSC;
SHORT sRC;
CalcParam_T stCalc;
CalcValue_T stValues;
•
•
•
stCalc.usStart = 100;
stCalc.usStop = 200;
stCalc.usBkgndChns = 4;
stCalc.rSigma = 1.0;
sRC = SadCalculate(hDSC, &stCalc, &stValues);

Return Number of Records in a CAM Class

This routine will return the number of records in a CAM class for the specified
datasource.

Calling Convention
sReturn = SadClassCount ( hDSC, usClass, &usCount )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usClass: This input parameter contains a USHORT value that specifies

the CAM class of interest. This parameter can either be defined
via the CAM_CLS_xxxx definitions in CAMDEF.H or by spec-
ifying HIUSHORT(CAM parameter name) if that parameter
is known to be part of the class record of interest.

usCount: This output parameter will contain a USHORT value that is the
count of records for the specified class.

52
 Programming Library Routines Reference

Example
HMEM hDSC;
SHORT sRC;
USHORT usCount;
•
•
•
sRC = SadClassCount(hDSC, HIUSHORT(CAM_L_RGNEND), &usCount);

Return Number of Entries in a CAM Class

This routine will return the number of entries in the table for the specified CAM parame-
ter.

Calling Convention
sReturn = SadEntryCount ( hDSC, ulParam, usRecord, &usCount )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

ulParam: This input parameter contains a ULONG value that specifies the
CAM parameter identifier; these identifier codes are defined in
the include file CAMPDEF.H.

usRecord: This input parameter contains a USHORT value that specifies

the record number containing the table of interest. This parame-
ter is required only for record tabular CAM parameters.

usCount: This output parameter will contain a USHORT value that is the
count of entries for the specified record.

Example
HMEM hDSC;
SHORT sRC;
USHORT usCount;
•
•
•
sRC = SadEntryCount(hDSC, CAM_L_NCLLINE, 1, &usCount);

Insert a Record/Entry into a CAM Datasource

This routine will insert a record or entry into the specified location of a CAM datasource.

53
Programming Library Reference

Calling Convention
sReturn = SadInsertOne ( hDSC, usClass, usRecord, usEntry )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usClass: This input parameter contains a USHORT value that specifies

the CAM class of interest. This parameter can either be defined
via the CAM_CLS_xxxx definitions in CAMDEF.H or by spec-
ifying HIUSHORT(CAM parameter name) if that parameter
is known to be part of the class record of interest.

usRecord: This input parameter contains a USHORT value that specifies

the record number to be used as follows:

– If record number is zero, then the insert is for a common tabu-

lar entry (see usEntry parameter).

– If record number is non-zero and the usEntry parameter is

zero, then the insert creates an empty record in front of the re-
cord number specified. If the usEntry parameter is non-zero,
then the insert is for a record tabular entry (see usEntry param-
eter).

usEntry: This input parameter contains a USHORT value that specifies

the entry number to be used as follows:

– If entry number is zero, then the insert is to create a new re-

cord (see usRecord parameter).

– If entry number is non-zero and the usRecord parameter is

zero, then the insert creates an empty common tabular entry in
front of the entry number specified. If the usRecord parameter
is non-zero, then the insert creates a record tabular entry in
front of the entry number specified on the record specified.

Example
HMEM hDSC;
SHORT sRC;
•
•
•
sRC = SadInsertOne(HDSC,HIUSHORT(CAM_T_NCLNAME),1, 0);

54
 Programming Library Routines Reference

Delete a Record/Entry from a CAM Datasource

This routine will delete a record or entry from the specified location of a CAM
datasource.

Calling Convention
sReturn = SadDeleteOne ( hDSC, usClass, usRecord, usEntry )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usClass: This input parameter contains a USHORT value that specifies

the CAM class of interest. This parameter can either be defined
via the CAM_CLS_xxxx definitions in CAMDEF.H or by spec-
ifying HIUSHORT(CAM parameter name) if that parameter
is known to be part of the class record of interest.

usRecord: This input parameter contains a USHORT value that specifies

the record number to be used as follows:

– If record number is zero, then the delete is for a common tabu-

lar entry (see usEntry parameter).

– If record number is non-zero and the usEntry parameter is

zero, then the specified record is deleted and all subsequent re-
cords are moved up (i.e. if record number 4 is deleted, then re-
cord no. 5 becomes number 4, etc.). If the usEntry parameter
is non-zero, then the delete is for a record tabular entry (see
usEntry parameter).

usEntry: This input parameter contains a USHORT value that specifies

the entry number to be used as follows:

– If entry number is zero, then the delete is for a record (see

usRecord parameter).

– If entry number is non-zero and the usRecord parameter is

zero, then the specified common tabular entry is deleted and
all subsequent entries are moved up (i.e. if entry number 4 is
deleted, then entry number 5 becomes number 4, etc.). If the
usRecord parameter is non-zero, then the specified record tab-
ular entry is deleted and all subsequent entries are moved up.

Example
HMEM hDSC;
SHORT sRC;

55
Programming Library Reference

•
•
•
sRC = SadDeleteOne(hDSC,
HIUSHORT(CAM_T_NCLNAME),
1, 0);

Select a Member of a Multi-Memory Group Input

This routine provides the ability to select a member of a multi-memory group detector in-
put. This member now becomes the current member for subsequent Sad calls (e.g.
SadGetParam, SadGetSpectrum, etc.).

Calling Convention
sReturn = SadSetCurrent ( hDSC, usMember, usCase )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usCase: This input parameter contains a USHORT value; this parameter

should always be specified as 0; other values are reserved for use
by the Genie 2000 software.

usMember: This input parameter contains a USHORT value that specifies

the member number to be selected.

Example
HMEM hDSC;
SHORT sRC;
•
•
•
sRC = SadSetCurrent(hDSC, 1, 0);

Issue Control Commands to Hardware

This routine issues control commands to the various hardware front-end devices that
comprise the specified detector input.

Calling Convention
sReturn = SadControlDSC ( hDSC, usDevice, usOpCode )

56
 Programming Library Routines Reference

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usDevice: This input parameter contains a USHORT value that specifies

the device to which the control command will be issued. Legal
values (as defined in DRIVER.H) include:

MCA: MCA device

SmpChngr: Sample changer device

Other device codes are defined in DRIVER.H and are reserved

for use by the Genie 2000 software.

usOpCode: This input parameter contains a USHORT value that specifies

the control command to be issued. Legal values (as defined in
SAD_NEST.H) include:

CTL_StartAcq: Start acquisition at MCA

CTL_AbortAcq: Stop acquisition at MCA

CTL_BumpChanger: Advance sample changer

CTL_ClearData: Clear data at MCA

Other control command codes are defined in SAD_NEST.H and

are reserved for use by the Genie 2000 software.

Example
HMEM hDSC;
SHORT sRC;
•
•
•
sRC = SadControlDSC(hDSC, MCA, CTL_StartAcq);

Copy Classes of CAM Data

This routine copies the specified class of CAM data from the input datasource to the target
destination datasource. This routine can not be used to copy ‘user-formated’ data. Instead,
use a combination of SadReadUFBlock (page 66) and SadWriteUFBlock (page 67).

Calling Convention
sReturn = SadClassCopy ( hInpDSC, hOutDSC, usClass )

57
Programming Library Reference

Parameters
hInpDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC)
and is considered the input datasource (i.e. this is where the class
of data is read from). It is assumed that a datasource has been
previously opened via SadOpenDataSource.

hOutDSC: This input parameter contains a handle (HMEM as defined in

SPASST.H) to a DSC (as created by a call to SadCreateDSC)
and is considered the output datasource (i.e. this is where the
class of data is written to). It is assumed that a datasource has
been previously opened via SadOpenDataSource or created via
SadCreateFile.

usClass: This input parameter contains a USHORT value that specifies

the CAM class of interest. This parameter can either be defined
via the CAM_CLS_xxxx definitions in CAMDEF.H or by spec-
ifying HIUSHORT(CAM parameter name) if that parameter
is known to be part of the class of interest.

Operational Notes
Additional error returns:

CSI_Source: Error occurred while accessing the input datasource.

CSI_Target: Error occurred while accessing the output datasource.

If the above error is returned, use the corresponding DSC to query for additional detailed
information via SadGetStatus.

Example
HMEM hDSC, hOutDSC;
SHORT sRC;
•
•
•
sRC = SadClassCopy(hDSC, hOutDSC, HIUSHORT(CAM_T_NCLNAME));

Search for CAM Records

This routine searches for a specified CAM record of data based on a specified match cri-
teria. The types of CAM records that can be searched are restricted to specific sorted
classes of CAM data as described below.

Calling Convention
sReturn = SadFindRecord ( hDSC, usSearch, pMatchObject,
usStart, pusRecord, pfFound )

58
 Programming Library Routines Reference

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usSearch: This input parameter contains a USHORT value that defines the
type of CAM record to be searched. Legal values (as defined in
Sad_NEST.H) include:

SEEK_History: A record in the QA Results class

will be searched for based on a
date/time stamp match criteria.

SEEK_Peak: A record in the Peak Search Re-

sults class will be searched for
based on an energy/tolerance crite-
ria.

SEEK_NucLine: A record in the Nuclide Library –

Energy Lines class will be
searched for based on an en-
ergy/tolerance criteria.

SEEK_Nuclide: A record in the Nuclide Library –

Nuclides class will be searched for
based on a nuclide name criteria.

pMatchObject: This input parameter contains a pointer to a storage location that

contains the required match criteria as follows:

SEEK_History: Pointer to a DOUBLE containing

a CAM date/time stamp absolute
value.

SEEK_Peak: Pointer to a structure (defined as

OjEnergy_T in Sad_NEST.H)
containing the energy (member
rEnergy) and tolerance value
(member rToler).

SEEK_NucLine: Pointer to a structure (defined as

OjEnergy_T in Sad_NEST.H)
containing the energy (member
rEnergy) and tolerance value
(member rToler).

SEEK_Nuclide: Pointer to a null-terminated char-

acter string (i.e. PSZ. up to nine
characters including the null) con-
taining the nuclide name.

usStart: This input parameter contains a USHORT value specifying the

starting record number to begin the search.

59
Programming Library Reference

pusRecord: This output parameter will contain a USHORT value that repre-
sents the record number containing the matching data. Note that
if an exact match is not found (see pfFound parameter below),
the record number returned will be the one containing the data
which is the closest greater value as compared to the specified
match criteria. If the object being searched for is greater than any
contained in any records, an error return is generated.

pfFound: This output parameter will contain a FLAG value that indicates
whether or not a match was found. A value of TRUE (or 1) indi-
cates that an exact match was found; a value of FALSE (or 0) in-
dicates that no exact match was found.

Example
HMEM hDSC;
SHORT sRC;
USHORT usRecord;
OjEnergy_T stPeak;
FLAG fFound;
•
•
•
stPeak.rEnergy = 661.0;
stPeak.rToler = 1.0;
sRC = SadFindRecord(hDSC, SEEK_Peak, &stPeak, 1, &usRecord, &fFound);

Copy CAM Records

This routine copies a record within the specified CAM class from the input datasource to
the target datasource.

Calling Convention
sReturn = SadCopyRecord ( hInpDSC, usClass, usIRecord, hOutDSC, usORecord,
fDelete )

Parameters
hInpDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC)
and is considered the input datasource (i.e. this is where data re-
cord is read from). It is assumed that a datasource has been pre-
viously opened via SadOpenDataSource.

usClass: This input parameter contains a USHORT value that specifies

the CAM class of interest. This parameter can either be defined
via the CAM_CLS_xxxx definitions in CAMDEF.H or by spec-
ifying HIUSHORT(CAM parameter name) if that parameter
is known to be part of the class of interest.

60
 Programming Library Routines Reference

usIRecord: This input parameter contains a USHORT value that specifies

the number of the record that will be copied from the input
datasource.

hOutDSC: This input parameter contains a handle to a DSC and is consid-

ered the output datasource (i.e. this is where the data record is
written to). It is assumed that a datasource has been previously
opened via SadOpenDataSource or created via SadCreateFile.

usORecord: This input parameter contains a USHORT value that specifies

the number of the record into which the copied record will be
written. Note that this performs an insert; all records in this out-
put datasource with this record number or greater will first be
moved to the next higher record.

fDelete: This input parameter contains a FLAG value that specifies

whether or not the specified input record will be deleted after the
copy. A value of TRUE (or 1) will delete the record; a value of
FALSE (or 0) will leave the input record intact.

Operational Notes
If the hOutDSC parameter is specified as zero, then the copy will be performed to the
specified record on the input datasource (as specified by the hInpDSC parameter).

Example
HMEM hDSC, hOutDSC;
SHORT sRC;
•
•
•
sRC = SadCopyRecord(hDSC, HIUSHORT(CAM_T_NCLNAME),
1, hOutDSC, 1, FALSE);

Retrieve Information about a Datasource

This routine will return information about a specified datasource.

Calling Convention
sReturn = SadQueryDataSource ( hDSC, usOpCode, &unValue )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC). It
is assumed that a datasource has been previously opened via
SadOpenDataSource.

61
Programming Library Reference

usOpCode: This input parameter contains a USHORT value that specifies

the type of information to return. Legal values (as defined in
SAD_NEST.H) include:

DSQ_Status: Status information (see unValue pa-

rameter below).

Other opcodes are defined in SAD_NEST.H and are reserved for

use by the Genie 2000 software.

unValue: This output parameter will contain status information (union

DSQuery_T as defined in Sad_NEST.H). Member stDS.fsStatus
contains status bits as follows:

DSS_Idle: Not acquiring; data was saved, con-

sequently the detector input is con-
sidered available.

DSS_Busy: Actively acquiring.

DSS_Done: Not acquiring; data not yet saved.

DSS_Update: Some data parameter has changed at

the datasource since the last
SadFlush call.

Example
HMEM hDSC;
SHORT sRC;
DSQuery_T stInfo;
•
•
•
sRC = SadQueryDataSource(hDSC, DSQ_Status, &stInfo);

ICB Direct Access Support

These routines directly access ICB devices: opening the device, fetching the device’s
model number and serial number, and reading data from and writing data to a specific
ICB register.

Specifying the ICB Device

The SadOpenICB routine opens the MCA, specifies the ICB device and verifies commu-
nication to the specified Ethernet and ICB addresses. When the program needs no further
access to any of the ICB devices connected to this MCA, it should call
SadCloseDataSource with this hDSC.

62
 Programming Library Routines Reference

Calling Convention
sReturn = SadOpenICB( HMEM hDSC, char *szDSName, USHORT usICBAddr,
SHORT fsAccess, char *szShellID )

Parameters
hDSC This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

szDSName This input parameter is a null-terminated character string repre-

senting the name of a detector that has been configured as an
AIM MCA in the MID Editor (that configuration determines the
Ethernet address).

usICBAddr This input parameter is a USHORT value which represents the

instrument’s address setting. Use the same value that you would
select for this device when configuring it in the MID Editor. The
applicable NIM unit’s manual contains information on setting
the ICB address for that unit.

fsAccess This input parameter contains a FLAGS value which defines a

set of bits that represent the access mode for opening the speci-
fied datasource. Legal bit values (as defined in SPASST.H) in-
clude:

ACC_ReadOnly: Read-Only access

ACC_ReadWrite: Read/write access

ACC_Exclusive: Exclusive open access

ACC_SysWrite: System write access

ACC_AppWrite: Application write access

The ACC_Exclusive bit implies exclusive ownership by the ap-

plication performing the open (i.e. no other applications will be
allowed to open this datasource). The ACC_SysWrite and
ACC_AppWrite bits define which type of read/write access is
being provided. In general, all user applications should use the
ACC_AppWrite bit when opening datasources – this allows for
proper operation with the MCA View/Control window which
uses the ACC_SysWrite bit.

szShellID This input parameter contains a null-terminated character string

(i.e. PSZ) which defines an application shell identifier. This pa-
rameter is used to allow two applications to share read/write ac-
cess to a datasource (i.e. one using ACC_SysWrite and the other
using ACC_AppWrite). In order for sharing to be allowed, the
two applications must call the SadOpenDataSource routine and
specify the same unique application shell identifier.

63
Programming Library Reference

Example
SadOpenICB( hDSC, "DET:DET03", ACC_ReadOnly, "" );

Fetch the Device’s Model Number

The SadInfoICB routine fetches the model number and serial number from the specified
ICB device.

Calling Convention
SadInfoICB( HMEM, hDSC, InfoICB_T *pstData )

Parameters
hDSC This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC). It
is assumed that the datasource has been previously opened via
SadOpenICB.

pstData This parameter is a pointer to a structure (of the InfoICB_T form

that is described in SAD_NEST.H). The requested information
will be returned into that structure.

ote that the value of the 'bModel' member of that structure

equates to the ICB device’s model number as follows:

Value Model

1 554

3 9641

4 9645

5 9633

6 9635

7 9615

Example
HMEM hDSC;
InfoICB-T stInfo
sRC = SadInfoICB( hDSC, &stInfo );

Writing to the ICB Register

The SadPutICB routine writes byte values to the specified ICB register.

Calling Convention
SadPutICB( HMEM hDSC, BYTE bRegister, BYTE bData )

64
 Programming Library Routines Reference

Parameters
hDSC This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC). It
is assumed that the datasource has been previously opened via
SadOpenICB.

bRegister This input parameter is a BYTE value which represents the num-
ber of the ICB register that is to be written to. For most devices
its value must be 1 through 16.

bData This parameter contains the 8-bit value that is to be written to

that register.

Example
SadPutICB ( hDSC, 7, 128 )

Reading from the ICB Register

The SadGetICB routine reads byte values from the specified ICB register.

Calling Convention
SadGetICB( HMEM hDSC, BYTE bRegister, BYTE *pbData )

Parameters
hDSC This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC). It
is assumed that the datasource has been previously opened via
SadOpenICB.

bRegister This input parameter is a BYTE value which represents the num-
ber of the ICB register that is to be read from. For most devices
its value must be 1 through 16.

pbData This parameter is a pointer to the place where the value that was
read from the register is to be stored.

Example
SadGetICB( hDSC, 9, &bRegNine )

Create a Block
This routine creates a ‘block’ of a given class on the file which is currently open for
read-write on that hDSC. It has two likely uses: To remove an existing user-format block
and to override the default size of the first block of a ‘standard’ class.

Actual user-format blocks cannot be created with this function, they will be created auto-
matically when writing to the datasource with SadWriteUFBlock (Page 67).

65
Programming Library Reference

SadCreateBlock can be used to remove an existing user-format block by passing a

ulBytes = 0 and flFlags = –1.

Calling Convention
sReturn = SadCreateBlock( hDSC, usClass, ulBytes, flFlags )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

ulBytes This input parameter contains the number of actual bytes to be

allocated on the file for the (first) block of the class.

flFlags can be CAM_M_CRB_NEW or CAM_M_CRB_APPND.

Example
sRC = SadCreateBlock( hDSC, 16401, 8000, 0 );

Read a Block
This routine reads back any data that was written to a CAM file by a call to
SadWriteUFBlock (page 67). Note that usBytes and ulOffset have to be multiples of 512.
At most, 15872 bytes can be read with one call.

Calling Convention
sReturn = SadReadUFBlock( hDSC, usClass, ulOffset, pvData, usBytes,
flFlags, pusAct )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usClass This parameter is a class-number to which user-formatted data

has been written.

ulOffset This parameter is a ULONG denoting how far into the block that
the read is to start.

pvData This parameter is a pointer to the place where the data which is
read from that class will be stored.

usBytes This parameter is the count of bytes to be read. Note that pvData
must point to memory of at least that many bytes.

flFlags Not currently used; must be 0 for future compatibility.

66
 Programming Library Routines Reference

pusAct This parameter is the address of a USHORT that will receive the
count of bytes actually read, in case that block with that offset
has fewer bytes available than requested.

Example
sRC = SadReadUFBlock( hDSC, 16401, 0, &abData[0], 8000, 0, &usActual);

Write a Block
This routine writes arbitrary data of (nearly) arbitrary size to any block of the CAM file.
Note that the write must be done in multiples of 512 bytes. It is currently limited to
3E00H (1587210) bytes in any one call.

When writing a user-format block to a datasource that already contains a block, the sizes
must match. A problem will occur when writing chunks of data to a user-format block.
It’s not likely that the chunk size will be the same as the user-format block size. Should
this case arise, you should clear the user-format block first using the SadCreateBlock
command (Page 65).

Calling Convention
sReturn = SadWriteUFBlock( hDSC, usClass, pvData, usBytes, flFlags )

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC).

usClass This parameter is the class-number specified in the call to

CreateBlock.

pvData This parameter is a pointer to the data that is to be written to that

class.

usBytes This parameter is the count of bytes to be fetched using that

pointer and written to the file in that class.

flFlags The flag CAM_M_DRW_APPEND is used to append data to the

user-format block. If the block does not exist to begin with, it
will be created as part of the write. Set the flag to zero when
writing a new block to the datasource for the first time.

Example
sRC = SadWriteUFBlock( hDSC, 16401, abData, 8000, 0 );

67
Programming Library Reference

Utility Library Routines Reference

The utility library routines provide miscellaneous support functions that are useful in the
construction of application programs that utilize the Genie 2000 programming library
routines. They are described in the following sections.

Create a Local VDM Connection

This routine establishes a connection to the local VDM. All operations that are legally
defined for the local VDM (depending on its type, i.e. F or M) may be performed via
subsequent SAD routines.

Calling Convention
iReturn = iUtlCreateFileDSC ( &hDSC, 0, 0 )

Parameters
hDSC: This output parameter will contain a handle (HMEM as defined
in SPASST.H) to a DSC as created by this routine.

Parameters 2 and 3 must be specified as 0; they are reserved for use by the Genie 2000
software.

Operational Notes
The hDSC parameter is defined only if a value of 0 is returned. All other returns are con-
sidered fatal errors.

Example
HMEM hDSC;
INT iReturn;
•
•
•
iReturn = iUtlCreateFileDSC( &hDSC, 0, 0 );

Convert System Date/Time into CAM Time Format

This routine fetches the current system date/time and returns it in CAM time format
(DOUBLE value representing number of seconds since system reference time).

Calling Convention
fReturn = fUtlTimeNow ( &dCAMTime )

68
 Utility Library Routines Reference

Parameters
dCAMTime: This output parameter contains a DOUBLE value that represents
the CAM time value for the current system date/time.

Return Values
A value of FALSE (or 0) indicates success; a value of TRUE (or 1) indicates that an error
occurred in converting the current system date/time.

Example
DOUBLE dCAMTime;
FLAG fReturn;
•
•
•
fReturn = fUtlTimeNow( &dCAMTime );

Convert C Date/Time to/from CAM Time Format

These routines perform conversion between the C time structure and CAM time format.

Calling Convention
fReturn = fUtlCTimeToCAM ( pstCTime, &dCAMTime )

fReturn = fUtlCAMToCTime ( dCAMTime, pstCTime )

Parameters
pstCTime: This parameter contains a pointer to the C time structure tm (de-
fined in TIME.H).

dCAMTime: This parameter contains a DOUBLE value that represents the

CAM time value to be converted (fUtlCAMToCTime) or that
has been converted (fUtlCTimeToCAM) to/from the specified C
time structure.

Return Values
A value of FALSE (or 0) indicates success; a value of TRUE (or 1) indicates that an error
occurred in converting the date/time value.

Exampl
DOUBLE dCAMTime;
struct tm stCTime;
FLAG fReturn;

69
Programming Library Reference

•
•
•
fReturn = fUtlCTimeToCAM(&stCTime, &dCAMTime);

Convert ASCII Date/Time to/from CAM Time Format

These routines perform conversion between CAM time formatted values and ASCII
strings. The format of the ASCII strings is defined by the format and separator specifica-
tions defined in the Control Panel’s Regional Settings.

Calling Convention
fReturn = fUtlStrToCAM ( szDate, szTime, &dCAMTime, szFmt )

fReturn = fUtlCAMToStr ( dCAMTime, szDate, szTime )

fReturn = fUtlCAMToString2 ( dCAMTime, szDate, szTime, flOption)

Parameters
szDate: This parameter contains a null-terminated string (i.e. PSZ)
which represents the ASCII date string (9 chars. including
NULL). Note that this must conform to the format defined in the
Control Panel’s Regional Settings.

szTime: This parameter contains a null-terminated string (i.e. PSZ)

which represents the ASCII time string (up to 12 chars. includ-
ing NULL). Note that this must conform to the format defined in
the Control Panel’s Regional Settings.

dCAMTime: This parameter contains a DOUBLE value that represents the

CAM time value to be converted (fUtlCAMToCTime) or that
has been converted (fUtlCTimeToCAM) to/from the specified
date/time strings.

szFmt: This output parameter contains a null-terminated string (i.e.

PSZ) which will contain the correct date/time format as defined
by OS2.INI (e.g. dd/mm/yy hh:mm:ss). If the pointer (address)
passed is NULL, then no format string is returned.

flOption: This parameter can be DTY_Two to force a two-digit year or

DTY_Four to force a four-digit year. If neither are supplied,
szDate will use short format from the control panels Regional
Settings.

Return Values
A value of FALSE (or 0) indicates success; a value of TRUE (or 1) indicates that an error
occurred in converting the date/time value.

70
 Analysis Engine Requirements

Example
DOUBLE dCAMTime;
CHAR szDate[9], szTime[12], szFmt[24];
FLAG fReturn;
•
•
•
fReturn = fUtlStrToCAM(szDate, szTime, &dCAMTime, szFmt);

Defining Genie 2000 Environment Settings

This routine performs the function of reading Genie 2000 environment settings from the
registry to initialize a program’s environment space within its process environment. All
programs must issue a call to this routine before using any Genie 2000 programming li-
brary routine.

Calling Convention
vG2KEnv()

Parameters
None

Return Values
None

Example
/* Set Environment from the registry */

vG2KEnv();

Analysis Engine Requirements

An analysis engine in the Genie 2000 context is a computational module which can be in-
tegrated into analysis sequences. The engine can also be accessed manually via the vari-
ous analysis window applications in the Acquisition and Analysis application or by
Genie 2000 batch commands.

An analysis engine is composed of two parts:

1. The analysis engine itself, which performs a particular step of analysis or

computation.

71
Programming Library Reference

2. The engine setup screen, which allows the user to enter/modify the setup
parameters the analysis engine requires. The engine setup screen requires
WIN32 programming in order to construct the dialog function and resource file
which defines the setup screen format.

The analysis engines are built as Windows Dynamically Linked Libraries (DLLs), which
are loaded by the applications only when needed. All communication with the engine or
its setup screen is via calling arguments and/or CAM parameters. One of the arguments is
an hDSC (see “Programming Library Routines Reference” on page 27). The hDSC refers
to the datasource where the setup parameters and input data reside and where the results
get written to (one exception to this are the report engines, which produce output to an
ASCII file).

Refer to the section on Analysis Engine Files in the “Genie 2000 Configuration” chapter
of the Genie 2000 Operations Manual for a detailed description of how to make an anal-
ysis engine file known to the Genie 2000 software environment.

Analysis Engine Interface

The engine must contain no I/O (either via printf or WIN32 code) to the console. Since
an engine is called from multiple places (i.e. both WIN32 and character cell applica-
tions), it is typically created in a separate DLL from where the setup screen dialog func-
tion and resource file are.

Calling Convention
long lEngine (hDSC, usStep, *pv1, *pv2);

Parameters
hDSC: This input parameter contains a handle (HMEM as defined in
SPASST.H) to a DSC (as created by a call to SadCreateDSC). It
is assumed that a datasource has been previously opened via
SadOpenDataSource.

usStep: This input parameter contains a USHORT value that contains

the step number within analysis sequence file (this parameter
will be zero if the engine is being invoked manually). The step
number may be used as a record index into the Analysis Control
Parameters class by the engine to fetch input parameters.

pv1: This output parameter will contain a ULONG error return which
provides detailed information whenever an engine encounters
ANA_BadSetupData, ANA_BadExpData, or
ANA_BadSmpData errors. Refer to ANADEFS.H for legal val-
ues for this error return. If this pointer is defined as NULL, then
the analysis engine must NOT store any values here.

pv2: Reserved for use by the Genie 2000 software.

72
 Analysis Engine Requirements

Return Values
Refer to the include file ANADEFS.H for a list of currently supported return codes; 0 in-
dicates successful completion.

Setup Screen Dialog Function Interface

The setup screen consists of a DLL with the dialog resource file and the dialog function
WIN32 code to manage the screen.

Calling Convention
long lEngineSetup ( hMod, hWndFrom, hWndFrame, hDSC, usStep, *pfExecute)

Parameters
hMod: This input parameter contains a HMOD value which specifies
the module handle of the dialog resource file.

hWndFrom: This input parameter contains a HWND value which specifies

the handle of the parent dialog window.

hWndFrame: This input parameter contains a HWND value which specifies

the handle of the Acquisition and Analysis application window.

hDSC: This input parameter contains a handle (HMEM as defined in

SPASST.H) to a DSC (as created by a call to SadCreateDSC). It
is assumed that a datasource has been previously opened via
SadOpenDataSource.

usStep: This input parameter contains a USHORT value that contains

the step number within analysis sequence file (this parameter
will be zero if the engine is being invoked manually). The step
number may be used as a record index into the Analysis Control
Parameters class by the setup screen dialog function to fetch in-
put parameters.

pfExecute: This input/output parameter contains a pointer to a FLAG value

which is used as follows: as an input parameter, this value indi-
cates whether or not the setup screen should enable (value of
TRUE or 1) or disable (value of FALSE or 0) the EXECUTE
button. As an output parameter, the value reflects whether or not
the EXECUTE button was pressed (TRUE or 1) or not pressed
(FALSE or 0).

Return Values
The return value from the setup screen should be TRUE (or 1) if via the OK or
EXECUTE buttons, and FALSE (or 0) if via CANCEL.

73
Programming Library Reference

Example Programs
This section lists and explains the example source code files (EXAMPLE.C AND
EXAMPLE2.C) included on the S560 distribution disk. The numbers to the left of the
listing refer to the notes at the end of the chapter.

EXAMPLE.C Source Code

The EXAMPLE.C file is an example of a program that read/writes parameters from/to a
CAM file.

/* Source Code Example - Genie 2000 Programming Library */

1. /* Windows includes */

#include <windows.h>
#include <crackers.h>

/* C run time library includes */

#include <stdio.h>

/* Genie 2000 User Library includes */

#include <citypes.h>
#include <spasst.h>
#include <sad.h>
#include <ci_files.h>
#include <campdef.h>
#include <cam_n.h>

/* Genie 2000 Utility Library includes */

#include <utility.h>

/* User’s includes */

/* Application source code */

main(int argc, char *argv[], char *envp[])

{
HMEM hDSC;
INT iRC;
SHORT sRc, sRet, sDum1;
ULONG ulRC;
USHORT usDum2;
CHAR szIdent[CAM_N_SIDENT];
REAL rQuant;

74
 Example Programs

/* Set environment from the registry */

2. vG2KEnv();

/* Establish a connection to the local VDM */

3. iRC = iUtlCreateFileDSC(&hDSC, 0, 0);

if (iRC) { printf("Error creating a VDM connection: %u", iRC);
return(1);
}

/* Open a CAM file datasource */

4. sRC = SadOpenDataSource(hDSC, "C:\\GENIE2K\\CAMFILES\\NBSSTD.CNF",

CIF_NativeSpect,
ACC_Exclusive|ACC_SysWrite|ACC_ReadWrite,
FALSE, "");

if (sRC) {

5. sRet = SadGetStatus(hDSC, &ulRC, &sDum1, &usDum2);

printf("Error opening NBSSTD.CNF: %lx", ulRC); return(1);

/* Read/write parameters to/from NBSSTD.CNF */

6. sRC = SadGetParam(hDSC, CAM_T_SIDENT, 0, 0, szIdent, CAM_N_SIDENT);

if (sRC) {
sRet = SadGetStatus(hDSC, &ulRC, &sDum1, &usDum2);
printf("Error reading sample ID: %lx", ulRC);
return(1);
}
rQuant = 10.0;

7. sRC = SadPutParam(hDSC, CAM_F_SQUANT, 0, 0, &rQuant, sizeof(REAL));

if (sRC) {
sRet = SadGetStatus(hDSC, &ulRC, &sDum1, &usDum2);
printf("Error writing sample quantity: %lx", ulRC);
return(1);
}

/* Save changes to NBSSTD.CNF, cleanup and exit */

8. sRC = SadFlush(hDSC);
if (sRC) {
sRet = SadGetStatus(hDSC, &ulRC, &sDum1, &usDum2);
printf("Error saving changes to NBSSTD.CNF: %lx", ulRC);

75
Programming Library Reference

return(1);
}

9. sRC = SadCloseDataSource(hDSC);

10. sRC = SadDeleteDSC(hDSC);

return(0);
}

/**** End Of File ****/

Notes
1. The set of #include lines specify the include files required for compiling C
programs using the Genie 2000 Programming Library. The order of these
include files is very important, specifically:

a. The Windows and C run time library include files must be specified
ahead of the Genie 2000 specific files.

b. The first Genie 2000 include file must always be CITYPES.H.

c. Any other required Genie 2000 and/or user include files may follow at
this point.

2. This statement invokes a routine (from UTILITY.LIB) which initializes the

program’s environment space with environment variable definitions that
correspond to Genie 2000 registry settings. All programs developed using the
S560 package need to call this routine at the beginning of the program.

3. This code section is establishing a connection to the local VDM by using the
utility routine iUtlCreateFileDSC. Note that a non-zero return value (iRC) is
being checked for which indicates a failure to create the connection.

4. This statement is opening a CAM file datasource (specified as CIF_NativeSpect)

named C:\GENIE2K\CAMFILES\NBSSTD.CNF. The file is being opened for
exclusive system write (this means that no other applications can open the file).
The application shell identifier is specified as a null string since the open is for
exclusive access.

5. This statement shows the use of SadGetStatus in retrieving a system 32-bit error
code (ulRC) which provides detailed error information about any
SadOpenDataSource error condition.

6. The SadGetParam routine is being called to retrieve the value of the

CAM_T_SIDENT (sample ID) parameter from NBSSTD.CNF. Note that the
length parameter is using a definition from the CAM_N.H include file which
defines maximum string length values for all CAM string parameters. The

76
 Example Programs

record and entry numbers are specified as 0 since the sample ID parameter is a
common parameter.

7. The SadPutParam routine is being called to write a value of 10.0 into the
CAM_F_SQUANT (sample quantity) parameter in NBSSTD.CNF. The record
and entry numbers are specified as 0 since the sample ID parameter is a
common parameter.

8. All changes to NBSSTD.CNF are being saved by calling SadFlush. Note that
this save of data will NOT happen automatically when closing the datasource –
an explicit save operation must be performed.

9. The file NBSSTD.CNF is being closed. No error checking is performed since

there is no course of action that could be taken in the event of an error.

10. The connection to the local VDM is deleted. No error checking is performed
since there is no course of action that could be taken in the event of an error.

The EXAMPLE.MAK file can be opened as a Workspace in the Microsoft Developer

Studio. You can also use the NMAKE command to build EXAMPLE.EXE within an
MS-DOS command window. The command line session must be initialized with the
VCVARS32.BAT file created when Visual C++® was installed. To execute the NMAKE
file, type:

set include=%include%;.\

nmake -f example.mak

EXAMPLE2.C Source Code

The EXAMPLE2.C file is an example of a program that starts acquisition on a detector
input and waits for its completion.

/* Source Code Example2 - Genie-PC Programming Library */

1. /* Windows includes */

#include <windows.h>
#include <crackers.h>

/* C run time library includes */

#include <tchar.h>
#include <stdio.h>

/* Genie-PC User Library includes */

#include <citypes.h>

77
Programming Library Reference

#include <spasst.h>
#include <sad.h>
#include <get_put.h>
#include <driver.h>
#include <ci_files.h>
#include <campdef.h>
#include <cam_n.h>

/* Genie-PC Utility Library includes */

#include <utility.h>

/* User’s includes */

/* Application source code */

main(int argc, char *argv[], char *envp[])

{
HMEM hDSC;
INT iRC;
SHORT sRc, sRet, sDum1;
ULONG ulRC;
USHORT usDum2;

/* Set environment from the registry */

2. vG2KEnv();

/* Establish a connection to the local VDM */

3. iRC = iUtlCreateFileDSC2(&hDSC, 0, 0);

if (iRC) {
printf("Error creating a VDM connection: %u", iRC);
return(1);
}

/* Open the DET01 datasource */

4. sRC = SadOpenDataSource(hDSC, "DET01", CIF_Detector

ACC_Exclusive|ACC_SysWrite|ACC_ReadWrite,
TRUE,"");

5. if(sRC == CSI_Verify){
printf("Error failed to verify DET01 parameter setttings.");
return(1);
}
else if (sRC){

6. sRet = SadGetStatus(

78
 Example Programs

hDSC, &ulRC, &sDum1, &usDum2);

printf("Error opening DET01: %lx", ulRC);
return(1);
}

/* Set acquisition preset to 30 seconds livetime. */

7. Preset_T stPSet;
FillMemory (&stPSet, sizeof(Preset_T), ‘\0’);
stPSet.flPsetMode = CAM_M_PMOD_LIVE;
stPSet.unTime.dPsetTime = 30.0;
SRC = SadPutStruct(hDSC,WST_SetPreset, 1, 1, &stPSet, sizeof(Preset_T));
if (sRC){
printf("Error failed to set livetime preset.");
return(1);
}
}

/* Clear the acquisition memory. */

8. sRC = SadControlDSC(hDSC, MCA, CTL_ClearData);

if (sRC) {
printf("Error failed to clear acquisition memory.");
return(1);
}

/* Start the acquisition. */

9. sRC = SadControlDSC(hDSC, MCA, CTL_Start_Acq);

if (sRC) {
printf("Error failed to start acquisition.");
return(1);
}

/* Wait for acquisition to complete .*/

10. DSQuery_T stQData;

double dLive;
sRC = SadQueryDataSource(hDSC, DSQ_Status, &stQData);
if (sRC) {
printf("Error hardwrae query failed.");
return(1);
}
while (stQData.stDSfsStatus & DSS_Busy) // while acquiring
{

79
Programming Library Reference

Sleep(1000); // Sleep for 1 second

sRC = SadGetParam(hDSC, CAM_X_ELIVE,0, 0, &dLive, sizeof(double));
if (!sRC) {
printf("\rLivetime seconds: %f", dLive);
}
sRC = SadQueryDataSource(hDSC, DSQ_Status, &stQData);
if (sRC) {
printf("Error hardware query failed.");
return(!);
}
}
}

/* Cleanup and exit */

11. sRC = SadCloseDataSource(hDSC);

12. sRC = SadDeleteDSC(hDSC);

return(0);
}

/**** End Of File ****/

Notes
1. The set of #include lines specify the include files required for compiling C
programs using the Genie 2000 Programming Library. The order of these
include files is very important, specifically:

a. The Windows and C run time library include files must be specified
ahead of the Genie 2000 specific files.

b. The first Genie 2000 include file must always be CITYPES.H.

c. Any other required Genie 2000 and/or user include files may follow at
this point.

2. This statement invokes a routine (from UTILITY.LIB) which initializes the

program’s environment space with environment variable definitions which
correspond to Genie 2000 registry settings. All programs developed using the
S560 package need to call this routine at the beginning of the program.

3. This code section is establishing a connection to the local VDM by using the
utility routine iUtlCreateFileDSC. Note that a non-zero return value (iRC) is
being checked for which indicates a failure to create the connection.

4. This statement is opening a detector input datasource (specified as

CIF_Detector) named DET01. The detector is being opened for exclusive
system write (this means that no other applications can open this detector input).

80
 Example Programs

The application shell identifier is specified as a null string since the open is for
exclusive access. The verification flag is set to TRUE, this indicates that a
hardware verification (read and write of all programmable settings) will be
performed.

5. This statement is checking the variable sRC for a specific error return of
CSI_VERIFY, indicating that a verification error of some kind was encountered
(wrong module ID, different serial number, and so forth).

6. This statement shows the use of SadGetStatus in retrieving a system 32-bit error
code (ulRC) which provides detailed error information about any
SadOpenDataSource error condition.

7. This code section is setting up the acquisition preset value to be used during
acquire. Note that a predefined structure (Preset_T as defined in GET_PUT.H)
is used to define the proper preset values to be written; this predefined structure
is then used in the SadPutStruct call to program the detector input.

8. The SadControlDSC routine is being called to clear the acquisition memory

(using the command code CTL_ClearData as defined in SAD_NEST.H).

9. The SadControlDSC routine is being called to start the acquisition memory

(using the command code CTL_StartAcq as defined in SAD_NEST.H).

10. The SadQueryDataSource routine is being called with the DSQ_Status argument
(as defined in SAD_NEST.H). One of the status bits (DSS_Busy) returned is the
acquisition busy bit. This code section loops until acquisition is complete; each
loop iteration fetches (via SadGetParam) and displays the elapsed live time.

11. The detector input, DET01, is being closed. No error checking is performed
since there is no course of action that could be taken in the event of an error.

12. The connection to the local VDM is deleted. No error checking is performed
since there is no course of action that could be taken in the event of an error.

81
Component Programming Library Reference

3. Component Programming Library

Reference
This chapter, which is a programmer’s reference guide for the components programming
library routines, assumes a basic knowledge of Visual Basic ®,Visual C++ and an under-
standing of the basic operation of Windows.

This chapter is organized to present the significant methods, properties and events in sep-
arate sections.

• DataAccess describes the properties and methods for the DataAccess

component.
• DeviceAccess describes the properties, events, and methods for the Device
Access component.
• CAM Datasource describes properties and methods for the CAM Datasource
component.
• Data Display describes the properties, events, and methods for the Mvc
component.
• Interactive Data Fit Control describes the properties, events, and methods for
the Interactive Data Fit component.
• Efficiency Calibration Control describes the properties, events, and methods for
the Efficiency Calibration component for both phase I and phase II.
• Energy Calibration Control describes the properties, events, and methods for
the Energy Calibration component for both phase I and phase II.
• CAM Dialog Control describes methods for CAM Dialog component.
• Adjust Control describes the properties, events, and methods for the Adjust
Control component.
• Sequence Analyzer describes the properties, events, and methods for the
Sequence Analyzer and the Analysis Editor.
• Reporter describes the properties and methods for the Report Viewer and the
Reporter.
• Error Handling describes common error handling methods for all components.

Note All calling formats and examples given in this chapter use Visual Basic nota-
tion. Examples of Visual C++ are located in Genie2k/S560/VC directory.

82
 DataAccess

DataAccess
The DataAccess component allows CAM access in Visual Basic. This component defines
all of the properties and methods related to storage and retrieval of data from a CAM file.
This component is accessible to Visual Basic by importing the “Canberra Nuclear Data
Access Library” into VB.

This object defines all of the operations and properties related to storage and retrieval of
spectral data in Visual Basic (VB). This object is accessible to Visual Basic by importing
the Data Access COM server into VB.

This component may be added to a VB project by selecting Project | References. The

References dialog box is displayed; select “Canberra Nuclear Data Access Library”. No
icon will appear on your form. You may access this library by dimensioning a new vari-
able as a DataAccess.

DataAccess Data Types

DataAccess defines the following enumeration types:

MessageCodes Component Warning and Error Codes

ParamCodes CAM parameter codes

ClassCodes CAM parameter class codes

MasksAndVals CAM parameter bit mask codes

In Visual Basic, IDE enumeration is useful because the enumeration values are displayed.

DataAccess Methods
This DataAccess is defined by the following methods:

Operation Description
Open Opens or Creates a connection to the CAM file
Close Closes a connection to the CAM file
Flush Flushes changes to the CAM file
CreateBlock Creates a class of information
DeleteBlock Deletes a class of information

83
Component Programming Library Reference

Operation Description
CopyBlock Copies a class from one CAM file to another
InsertRecord Inserts a record into a class
InsertEntry Inserts an entry into a class
DeleteRecord Deletes a record from a class
DeleteEntry Deletes an entry from a class
Find Finds a parameter entry
Save Saves data to the current datasource or
another datasource
EvaluateSpectroscopyCalibration Evaluates the current energy, efficiency,
FWHM, or low energy tail calibration
ConvertEnergyToChannel Converts an energy value to a channel value
ComputeROIs Quantifies an ROI
FileExists Determine if a file exists
CopyRecord Copies a record into a class

Open a Datasource
This method will open a CAM file.

Note The CAM File may be opened read-write by multiple components in the same
process. However, all openers share the same handle. Therefore any save to the
file will result in all changes being saved.

Calling Convention
Open(String Name, OpenMode Mode, Long NumChans)

Parameters
String Name The name of the CAM file

OpenMode Mode (Optional) The open or create options:

dReadOnly: Read Only

dReadWrite: Read Write

dCreate: Create a new file.

84
 DataAccess

dLargeHeader: Create with a large directory

block. Used only while creating a
CAM file. This is a special option
that is used to create neutron data
storage files.

dDirectAccess: This options performs all data-

base actions without using the
Genie-2K VDM. This option in-
creases the speed database trans-
actions significantly.

dNoVerifyLicense This option allows you to run the

VDM without having a license.

dOverwrite When combined with dCreate op-

tion, overwrites the file if it ex-
ists.

Long NumChans (Optional) The number of spectral channels. Used only

while creating a CAM file.

Optional
OpenMode Mode Value of dReadOnly

Long NumChans Value of 0

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite

Close a Data Resource

This method will close a CAM file.

Calling Convention
Close(CloseMode Mode)

Parameters
CloseMode Mode The close options:

dUpdate: Save changes

dDelete: Delete a CAM file

dNoUpdate: Do not save changes

Optional
CloseMode Mode Value of dNoUpdate

85
Component Programming Library Reference

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File1.Close

Flushing Changes
This method will flush changes to a CAM file.

Calling Convention
Flush()

Parameters
None

Optional
None

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File1.Param(CAM_L_CHANNELS) = 512
File1.Flush

Creating a Parameter Block

This method will create a new parameter block.

Calling Convention
CreateBlock(ClassCodes Class, Long Size, ParamCodes Param)

Parameters
ClassCodes Class The class to create. Set to 0 if you want to use a parameter
code.

Long Size (Optional) The size. Must be multiples of 512.

ParamCodes Param (Optional) The parameter which is defined in the class.

This should be used to define the class if the class of the
parameter is not known.

Optional
Long Size A value of 0. This indicates that the value specified in the
data storage schema should be used.

ParamCodes Param A value of 0

86
 DataAccess

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File1.CreateBlock(CAM_CLS_GEOM)

Deleting a Parameter Block

This method will delete a parameter block.

Calling Convention
DeleteBlock(ClassCodes Class, ParamCodes Param)

Parameters
ClassCodes Class The class to create. Set to 0 if you want to use a parameter
code.

ParamCodes Param (Optional) The parameter which is defined in the class.

This should be used to define the class if the class of the
parameter is not known.

Optional
ParamCodes Param A value of 0

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File1.CreateBlock(CAM_CLS_GEOM)
File1.DeleteBlock(CAM_CLS_GEOM)

Copying a Parameter Block

This method will copy a parameter block from one CAM source into another. This
method will copy at a DataAccess or DeviceAccess object or to a file defined by a String
name.

Calling Convention
CopyBlock(Variant Dest, ClassCodes Class, ParamCodes Param)

Parameters
Variant Dest The destination object. This can be a DataAccess or
DeviceAccess object of File name (String).

ClassCodes Class The class to copy information from. Set to 0 if you want to
use a parameter code.

87
Component Programming Library Reference

ParamCodes Param (Optional) The parameter which is defined in the class.

This should be used to define the class if the class of the
parameter is not known.

Optional
ParamCodes Param A value of 0

Example
Dim File1 as New DataAccess
Dim File2 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File2.Open “test.cnf”, dReadOnly
File1.CopyBlock(File2, CAM_CLS_PROC)

Inserting a Record
This method will insert a record into a parameter class.

Calling Convention
InsertRecord(ClassCodes Class, Long Rec, ParamCodes Param)

Parameters
ClassCodes Class The class to insert a record into. Set to 0 if you want to use
a parameter code.

Long lRec The record to insert.

ParamCodes Param (Optional) The parameter which is defined in the class.

This should be used to define the class if the class of the
parameter is not known.

Optional
ParamCodes Param A value of 0

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File1.InsertRecord(CAM_CLS_NEUTACQ, 20)

Inserting a Entry
This method will insert an entry into a parameter class.

Calling Convention
InsertEntry(ClassCodes Class, Long Rec, Long lEntry, ParamCodes Param)

88
 DataAccess

Parameters
ClassCodes Class The class to insert an entry into. Set to 0 if you want to use
a parameter code.

Long lRec The record number.

Long lEntry The entry to insert.

ParamCodes Param (Optional) The parameter which is defined in the class.

This should be used to define the class if the class of the
parameter is not known.

Optional
ParamCodes Param A value of 0

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File1.InsertEntry(0, 1, 5, CAM_F_NLENERGY)

Deleting a Record
This method will delete a record from a parameter class.

Calling Convention
DeleteRecord(ClassCodes Class, Long Rec, ParamCodes Param)

Parameters
ClassCodes Class The class to delete a record from. Set to 0 if you want to
use a parameter code.

Long lRec The record to delete.

ParamCodes Param (Optional) The parameter which is defined in the class.

This should be used to define the class if the class of the
parameter is not known.

Optional
ParamCodes Param A value of 0

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File1.DeleteRecord(0, 2, CAM_F_NACQSTOTALS)

89
Component Programming Library Reference

Deleting an Entry
This method will delete an entry from a parameter class.

Calling Convention
DeleteEntry(ClassCodes Class, Long Rec, Long lEntry, ParamCodes Param)

Parameters
ClassCodes Class The class to delete an entry from. Set to 0 if you want to
use a parameter code.

Long lRec The record number.

Long lEntry The entry to delete.

ParamCodes Param (Optional) The parameter which is defined in the class.

This should be used to define the class if the class of the
parameter is not known.

Optional
ParamCodes Param A value of 0

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File1.DeleteEntry(CAM_CLS_NEUTMULTI, 1, 2)

Finding a Parameter
This method will find a particular record that matches the search information.

Calling Convention
Find(FindMode Mode, Variant vSearch, Long StartRec)

Parameters
FindMode Mode The search mode:

dByNuclideLine: By nuclide line energy (keV)

dByPeak: By peak centroid (keV)

dByHistory: By data/time stamp

dByNuclideName: By nuclide name

Variant Search This type is determined by the search options:

90
 DataAccess

dByNuclideLine, Requires this argument to be a 2

dByPeak: dim array of single precision val-
ues. Dim 0 is the energy to search
for (keV). Dim 1 defines the en-
ergy tolerance.

dByHistory: Requires this parameter to be a

Date, a CAM double precision
date time stamp, or a CAM string
formatted date time stamp.

dByNuclideName: Requires this argument to be a

String.

Long StartRec (Optional) The record to start the search at.

Return
Long lFind The record found.

Optional
Long StartRec A value of 1

Example
Dim File1 as New DataAccess
Dim lRec as Long
Dim arVals(0 to 1) as Single
File1.Open “naidemo.cnf”, dReadWrite
arVals[0] = 88.7
arVals[1] = 1.2
lRec = File1.FindRecord(dByNuclideLine, arVals);

Saving Changes
This method will save a CAM file into another.

Calling Convention
Save(String Name, Boolean Overwrite)

Parameters
String Name (Optional) The name of the file. If “”, the current file is
flushed.

Boolean Overwrite (Optional) If true and the file exists, the file is overwritten.

Optional
String Name A value of “”

Boolean Overwrite A value of false

91
Component Programming Library Reference

Example
Dim File1 as New DataAccess
File1.Save “bobo.cnf”, dReadWrite
File1.Param(CAM_L_CHANNELS) = 512
File.Save

Evaluating Spectroscopic Calibrations

This method will allow you to evaluate a point in the current spectroscopy calibration,
where “current” means that for evaluating efficiency, the calibration type defined by the
CAM parameter CAM_T_EFFTYPE is used.

Calling Convention
EvaluateSpectroscopyCalibration(Single Point, Spectroscopy Calibrations Type, Single
Value, Single Uncertainty, Boolean PtIsEnergy)

Parameters
Single Point The point to evaluate the calibration at.

SpectroscopyCalibrationType The type of calibration to evaluate:

dEfficiency: Using the default efficiency de-

fined by CAM_T_EFFTYPE.

dFwhm: Using the default FWHM defined

by CAM_T_FWCALTYPE. Cur-
rently, only the square foot model
is supported.

dEnergy: Energy Calibration

dLowEnergyTail: Low energy tail calibration.

Single Value The evaluated calibration.

Single Uncertainty The uncertainty in the evaluated calibration.

Boolean PtIsEnergy (Optional) If true evaluation point is assumed to be in units

of energy (keV).

Optional
Boolean PtIsEnergy A value of false

Example
Dim File1 as New DataAccess
Dim Val as Single
Dim Unc as Single
File1.Save “bobo.cnf”, dReadWrite
File1.EvaluateSpectroscopyCalibration 128, dFwhm, Val, Unc

92
 DataAccess

Converting from Energy To Channel

This method will allow you to convert an energy value to a channel.

Calling Convention
ConvertEnergyToChannel(Single Energy)

Parameters
Single Energy The energy to convert (keV).

Optional
None

Return
Single Chan The channel

Example
Dim File1 as New DataAccess
Dim Chan as Single
File1.Save "bobo.cnf", dReadWrite
Chan = File1.ConvertEnergyToChannel(128.2)

Computing ROIs
This method will allow you to quantify an ROI.

Calling Convention
ComputeROIs(Single Left, Single Right, Long BackgroundChans, Single Sigma,
Boolean ValuesAreEnergy)

Parameters
Single Left The left ROI

Single Right The right ROI

Long BackgroundChans The number of background channels (currently unused, set

CAM_L_BACKGNDCHNS instead)

Single Sigma The number of standard deviations (currently unused, set

CAM_F_SIGMA instead)

Boolean ValuesAreEnergy If true, the ROIs are in energy units (keV)

Optional
None

93
Component Programming Library Reference

Return
Variant Vals This is an array of doubles where dimensions are

[0]: Integral

[1]: Area

[2]: Area Uncertainty

[3]: Gaussian Ratio

[4]: Centroid

[5]: FWHM

[6]: FWTM

Example
Dim File1 as New DataAccess
Dim Vals as Variant
File1.Save “bobo.cnf”, dReadWrite
Vals = File1.ComputeROIs(512, 520, 5, 3.0)

Determining if a File Exists

This method will allow you to determine if a file already exists.

Calling Convention
FileExists(String Name)

Parameters
String Name The name of the file

Optional
None

Return
Boolean FileExists True if the file exists

Example
Dim File1 as New DataAccess
If (File1.FileExists(“bobo.cnf”) < > True) Then _File1.Save “bobo.cnf”, dReadWrite

Moving or Copying a Record

This method will allow you to copy or move a record.

94
 DataAccess

Calling Convention
CopyRecord(ClassCodes lClass, long SourceRec, long DestRec, Boolean Delete,
Variant Dest)

Parameters
ClassCodes Class The class to copy from.

Long SourceRec The source record.

Long DestRec The destination record.

Boolean Delete If true, the source record is deleted after the copy. This
changes the method to a move operation.

Variant Dest The destination interface. This can be a DeviceAccess or

DataAccess interface. Also if the Variant is empty the
source object is used as the destination object.

Optional
None

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, ReadWrite
File1.CopyRecord CAM_CLS_PEAK, 1, 2, True, “test.cnf”

DataAccess Properties
Some properties are read-only; a value can not be assigned to these types of properties.
Therefore, a topic called Privilege has been added to describe whether the property is
read-only or read-write. An example is provided by each property description. The prop-
erties are given in the table below.

Name Description
Param Reads and Writes a parameter
ParamArray Reads and Writes an array of parameters
ParamArrayEx Reads and Writes an array for values for a single
parameter
Spectrum Reads and Writes a spectrum
Name Returns the name of the CAM file
AccessHandle Returns the storage handle
NumberOfRecords Returns the number of records

95
Component Programming Library Reference

Name Description
NumberOfEntries Returns the number of entries
Calibrations The calibration information (See “Calibrations” on
page 105)
IsOpen Returns true if the interface has an open file
IsModified Returns true if the file was modified
IsWarning Displays a warning message
IsError Displays an error message
Message Returns the status message text by the staus code

Parameter Access
Parameters may be read from or written to a CAM file.

Note Date/Time parameters written to the datasource must be Visual Basic data type.
When a date/time parameter is read from the datasource, it is returned as a Vi-
sual Basic string.

Calling Convention
Param(ParamCodes Param, Long Record, Long Entry)

Parameters
ParamCodes Param The parameter code defining the parameter to read or write.

Long Record (Optional) The record number.

Long Entry (Optional) The entry number.

Return
Variant Param The parameter value

Privilege
Read-Write

Optional
Long Record A value of 1

Long Entry A value of 1

96
 DataAccess

Example
Dim File1 as New DataAccess
Dim File2 as New DataAccess
File1.Open “bobo.cnf”, dReadWrite
File2.Open “test.cnf”, dCreate
File2.Param(CAM_L_CHANNELS) = File1.Param(CAM_L_CHANNELS)
File2.Param(CAM_F_ECALTOL) = 1.2

Parameter Array Access

A group of parameters may be read from or written to a CAM file.

Note Date/Time parameters written to the datasource must be Visual Basic data type.
When a Date/Time parameter is read from the datasource, it is returned as a Vi-
sual basic string.

Calling Convention
ParamArray(ParamCodes Param(*), Long Record, Long Entry)

Parameters
ParamCodes Param(*) The parameter codes defining the parameter to read or
write.

Long Record (Optional) The record number.

Long Entry (Optional) The entry number.

Return
Variant Params(*) The parameter values. The parameter array is allocated by
the server. Therefore, you do not need to allocate the mem-
ory before using this property.

Privilege
Read-Write

Optional
Long Record A value of 1

Long Entry A value of 1

97
Component Programming Library Reference

Example
Dim File1 as New DataAccess
Dim arCodes(0 to 2) as ParamCodes
Dim Vals as Variant
File1.Open “bobo.cnf”, dReadWrite
arCodes(0) = CAM_L_CHANNELS
arCodes(1) = CAM_T_STITLE
arCodes(2) = CAM_F_ECALTOL
Vals = File1.ParamArray(arCodes)

Single Parameter Array

An array of values for a specific parameter may be read from or written to a CAM file.
All arrays must start at index 0 (i.e., Option Base 0).

Note Date/Time parameters written to the datasource must be Visual Basic data type.
When a Date/Time parameter is read from the datasource, it is returned as a Vi-
sual basic string.

Calling Convention
ParamArrayEx(ParamCodes Param, Long Num, Long Options, Long Record, Long
Entry)

Parameters
ParamCodes Param The parameter code defining the parameter to read or write.

Long Num The number of values to retrieve

ArrayOptions Option (Optional) The options:

dAutoIncrementRecord: Increments the record number

dAutoIncrementEntry: Increments the entry number

Long Record (Optional) The start record number.

Long Entry (Optional) The start entry number.

Return
Variant Params(*) The parameter values. The parameter array is allocated by
the server. Therefore, you do not need to allocate the mem-
ory before using this property.

Privilege
Read-Write

Optional
Long Record A value of 1

98
 DataAccess

Long Entry A value of 1

ArrayOptions Option A value of dAutoIncrementRecord

Example
Dim File1 as New DataAccess
Dim Vals as Variant
File1.Open “bobo.cnf”, dReadWrite
Vals = File1.ParamArrayEx(CAM_L_RGNSTART, 2, dAutoIncrementRecord)

Spectral Data Access

All or a portion of a spectrum may be read from or written to a CAM file.

Calling Convention
Spectrum(Long lStart, Long lStop, Long Row, Long Group)

Parameters
Long lStart (Optional) The start channel.

Long lStop (Optional) The stop channel. A negative value indicates

that the number of channels should be read from the detec-
tor.

Long Row (Optional) The row number.

Long Group (Optional) The group number.

Return
Variant Spectrum(*) The spectrum. The spectral array is allocated by the server,
so you don’t need to allocate memory before using this
property. This is an array of singles that starts at index 0.

Privilege
Read-Write

Optional
Long lStart A value of 1

Long lStop A value of -1

Long Row A value of 1

Long Group A value of 1

99
Component Programming Library Reference

Example
Dim File1 as New DataAccess
Dim File2 as New DataAccess
Dim Spec as Variant
File1.Open “bobo.cnf”, dReadOnly
File2.Open “test.cnf”, dReadWrite
File2.Spectrum = File1.Spectrum

Determining the File Name

This property allows a programmer to retrieve the file name of the open file.

Calling Convention
Name

Parameters
None

Return
String The File Name

Privilege
Read-Only

Example
Dim File1 as New DataAccess
File1.Open "bobo.cnf", dReadWrite
Text1.text = File1.name

Determining the Number of Records

This property determines number of records in a particular parameter class.

Calling Convention
NumberOfRecords(ClassCodes Class, ParamCodes Param)

Parameters
ClassCodes Class The class code.

ParamCodes Param (Optional) The parameter code. Use this argument if you
do not know the class code. If this argument is non-zero, it
will be used instead of the Class argument.

Return
Long NumberOfRecords The number of records

100
 DataAccess

Optional
ParamCodes Param Value of 0

Privilege
Read-Only

Example
Dim File1 as New DataAccess
Dim lCnt as Long
File1.Open “bobo.cnf”, dReadOnly
lCnt = File1.NumberOfRecords(CAM_CLS_GEOM)

Determining the Number of Tabular Entries

This property determines number of entries in a particular parameter class.

Calling Convention
NumberOfEntries(ClassCodes Class, Long Record, ParamCodes Param)

Parameters
ClassCodes Class The class code.

Long Record The record number.

ParamCodes Param (Optional) The parameter code. Use this argument if you
do not know the class code. If this argument is non-zero, it
will be used instead of the Class argument.

Return
Long NumberOfEntries The number of entries

Optional
ParamCodes Param Value of 0

Privilege
Read-Only

Example
Dim File1 as New DataAccess
Dim lCnt as Long
File1.Open “bobo.cnf”, dReadOnly
lCnt = File1.NumberOfEntries(CAM_CLS_GEOM, 2)

101
Component Programming Library Reference

Access Handle
This property returns the access handle which may be used for the SAD API.

Calling Convention
AccessHandle

Parameters
None

Return
Variant AccessHandle The handle which may be passed to Genie-2K API.

Optional
None

Privilege
Read-Only

Example
Dim File1 as New DataAccess
Dim Val as Single
Dim iSize as Integer
Dim Rc as Integer
File1.Open “bobo.cnf”, dReadOnly
iSize = 4
Rc = SadGetParam(File1.AccessHandle, CAM_F_ECALTOL, 1, 1, Val, iSize)

Determining if Opened
This property allows the programmer to determine if the component has an opened file.

Calling Convention
IsOpened

Parameters
None

Return
Boolean IsOpen If true, the interface is has an opened file.

Optional
None

102
 DataAccess

Privilege
Read-Only

Example
Dim File1 as New DataAccess
File1.Open “bobo.cnf”, dReadOnly
If (File1.IsOpen = False) Then

Determining if Modified
This property allows the programmer to determine if the datasource has been modified.

Calling Convention
IsModified

Parameters
None

Return
Boolean IsModified If true, the interface is has been modified.

Optional
None

Privilege
Read-Only

Example
Dim File1 as New DataAccess
File1.Open "bobo.cnf", dReadWrite
File1.Param(CAM_F_ECALTOL) = 1.2
If (File1.IsModified) Then File1.Save

Status Severity
All status messages have a severity associated with them. This severity defines whether a
message is a warning message or an error message. There are two properties that may be
used to determine the severity of a message.

Calling Convention
IsWarning(MessageCodes Code)
IsError(MessageCodes Code)

103
Component Programming Library Reference

Parameters
MessageCodes Status The status code to examine for severity level.

Return
Boolean bVal A value of true indicates that the message is of that speci-
fied severity level.

Optional
None

Example
Dim File As New DataAccess
On Error Resume Next
File.Open “bobo.cnf”
If (File.IsError(Err.Number)) Then …

Retrieving Status Message

This property returns the status message text defined by the status code.

Calling Convention
String Message(MessageCode Code)

Parameters
MessageCodes Code The message code to retrieve the status string.

Return
String Message String for the status

Optional
None

Privilege
Read-Only

Example
Dim File As New DataAccess
On Error Resume Next
File.Open “bobo.cnf”
If (File.IsError(Err.Number)) Then …
MsgBox File.Message Err.Number, vbOkOnly

104
 DataAccess

Properties
This property allows the programmer to set a number of properties that are not defined in
the interface.

Calling Convention
Properties

Parameters
VARIANT Name The name of the property.

Return
VARIANT Val The value of the property

Optional
None

These properties are used to get or set the properties tabulated below.

Name Description Type Rights

AppName The component identifier or BSTR Read-Only
shell identifier that is used to
filter the processes that can
access the datasource.

Data Access Calibrations

This property groups all of the calibration properties under one component. The calibra-
tion properties are tabulated below.

Name Description
Energy Energy information
Fwhm FWHM information
LowTail Low energy tail calibration information
Efficiency Efficiency information (See “Efficiency” on
page 109)
MatrixCorrection Matrix correction calibration information
Mass Neutron mass calibration information
AddASource Neutron add-a-source calibration information

105
Component Programming Library Reference

Name Description
DifferentialPeak Reserved for internal use
Transmission Reserved for internal use

All of the calibration types listed above have the following properties: Points and Curve.
The points property will read and/or write calibration points to and/or from a datasource.
The curve property will read and write the calibration coefficients to and from a
datasource. Some calibration types support reading and writing covariance matrices
through a property called Covariance.

Low Tail Calibrations

This property retrieves the low energy tail calibration information.

Calling Convention
LowTail

Parameters
None

Return
Variant LowTail.Curve(*) The low energy tail calibration. The calibration array is al-
located by the server. Therefore, you do not need to allo-
cate the memory before using this property. The order is:

LowTail.Curve(0): Offset

LowTail.Curve(1): Slope

Variant LowTail.Points(3)(*) The energy, low energy tail, and uncertainty triplets. The
data array is allocated by the server. Therefore, you do not
need to allocate the memory before using this property.
The order is:

LowTail.Points (0)(*): Energies

LowTail.Points (1)(*): Low energy tails

LowTail.Points (2)(*): Uncertainties

Optional
None

Privilege
Curve: Read-Only

106
 DataAccess

Points: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Samples as Variant
File1.Open “bobo.cnf”, dReadOnly
Cal = File1.Calibrations.LowTail.Curve
Samples = File1.Calibrations.LowTail.Points

Energy Calibrations
This property retrieves the energy calibration information.

Calling Convention
Energy

Parameters
None

Return
Variant Energy.Curve(*) The energy calibration. The calibration array is allocated
by the server. Therefore, you do not need to allocate the
memory before using this property. The order is:

Energy.Curve(0): Offset

Energy.Curve(1): Slope

Energy.Curve(2): Quadratic

Energy.Curve(3): Cubic

Energy.Curve(4): Quardic

Energy.Curve(5): Quintic

Variant EnergyPoints(3)(*) The channel, energy, and uncertainty triplets. The data ar-
ray is allocated by the server. Therefore, you do not need to
allocate the memory before using this property. The order
is:

Energy.Points (0)(*): Channels

Energy.Points (1)(*): Energies

Energy.Points (2)(*): Uncertainties

107
Component Programming Library Reference

Optional
None

Privilege
Curve: Read-Only

Points: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Samples as Variant
File1.Open “bobo.cnf”, dReadOnly
Cal = File1.Calibrations.Energy.Curve
Samples = File1.Calibrations.Energy.Points

FWHM Calibrations
This property retrieves the FWHM calibration information.

Calling Convention
Fwhm

Parameters
None

Return
Variant Fwhm.Curve(*) The FWHM calibration. The calibration array is allocated
by the server. Therefore, you do not need to allocate the
memory before using this property.

If there are only 2 coefficients, the calibration model is

square root of energy. For this model the order is:

Fwhm.Curve(0): Offset

Fwhm.Curve(1): Slope

If there are 3 coefficients, the calibration model is polyno-

mial in energy. For this model the order is

Fwhm.Curve(0): Offset

Fwhm.Curve(1): Slope

Fwhm.Curve(2): Quadratic

108
 DataAccess

Variant Fwhm.Points(3)(*) The energy, fwhm, and uncertainty triplets. The data array
is allocated by the server. Therefore, you do not need to al-
locate the memory before using this property. The order is:

Fwhm.Points (0)(*): Energies

Fwhm.Points (1)(*): Fwhms

Fwhm.Points (2)(*): Uncertainties

Optional
None

Privilege
Curve: Read-Only

Points: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Samples as Variant
File1.Open “bobo.cnf”, dReadOnly
Cal = File1.Calibrations.Fwhm.Curve
Samples = File1.Calibrations.Fwhm.Points

Efficiency
This property groups all of the efficiency calibration properties under one component.
The efficiency properties are tabulated below.

Name Description
Dual Curve Reads the dual efficiency calibration
Empirical Curve Read the empirical efficiency calibration
Linear Curve Reads the linear efficiency calibration
CrossOver Reads the cross over energy for dual efficiency
EfficiencyPoints Reads the efficiency calibration points
Alpha Curve Reads the alpha spectroscopy efficiency calibration

Dual Efficiency Calibration

This property retrieves dual efficiency calibration coefficients.

109
Component Programming Library Reference

Calling Convention
Dual Curve(Long Record)

Parameters
Long Record (Optional) The record number.

Return
Variant Dual Curve (2) (10) The Dual efficiency calibration. The calibration array is al-
located by the server. Therefore, you do not need to allo-
cate the memory before using this property. The order is:

Dual Curve (0): Low energy calibration coeffi-

cients (offset thru quardic).

Dual Curve (1): High energy calibration coeffi-

cients (offset thru quintic)

Optional
Long Record Default value is 1

Privilege
Read-Only

Example
Dim File1 as New DataAccess
Dim Cal() as Variant
File1.Open “bobo.cnf”, dReadOnly
Cal = File1.Calibrations.Efficiency.Dual Curve

Linear Efficiency Calibration

This property retrieves linear efficiency calibration coefficients.

Calling Convention
Linear Curve (Long Record)

Parameters
Long Record (Optional) The record number.

Return
Variant Linear Curve (*) The Linear efficiency calibration. The calibration array is
allocated by the server. Therefore, you do not need to allo-
cate the memory before using this property. The order is:

110
 DataAccess

Linear Curve (0-9): offset thru 9’th order. The array

values (c0 - c9) represent the
coefficients of the following
equation:
log(Eff) = (c0*Energy) – (c1) +
(c2/Energy) – (c3/Energy^2) +
(c4/Energy^3)...

Optional
Long Record Default value is 1

Privilege
Read-Only

Example
Dim File1 as New DataAccess
Dim Cal() as Variant
File1.Open “bobo.cnf”, dReadOnly
Cal = File1.Calibrations.Efficiency.Linear Curve

Empirical Efficiency Calibration

This property retrieves empirical efficiency calibration coefficients.

Calling Convention
Empirical Curve (Long Record)

Parameters
Long Record (Optional) The record number.

Return
Variant Empirical Curve (*) The Empirical efficiency calibration. The calibration array
is allocated by the server. Therefore, you do not need to al-
locate the memory before using this property. The order is:

Empirical (0-6): The array values (c0 – c6) repre-

sent coefficients of the following
equation: ln(Eff) = c1 + (c2*x) +
(c3*x^2) + … where x = ln(c0).

Optional
Long Record Default value is 1

Privilege
Read-Only

111
Component Programming Library Reference

Example
Dim File1 as New DataAccess
Dim Cal() as Variant
File1.Open “bobo.cnf”, dReadOnly
Cal = File1.Calibrations.Efficiency.Empirical Curve

Efficiency Calibration Points

This property retrieves the efficiency calibration points used to determine the calibration
coefficients.

Calling Convention
EfficiencyPoints(lRecord)

Parameters
Long Record The record number.

Return
Variant EfficiencyPoints(4)(*) The energy, efficiency, uncertainty, and density points.
The data array is allocated by the server. Therefore, you
do not need to allocate the memory before using this
property. The order is:

EfficiencyPoints (0)(*): Energies

EfficiencyPoints (1)(*): Efficiencies

EfficiencyPoints (2)(*): Uncertainties

EfficiencyPoints (3)(*): Density

Optional
None

Privilege
Read-Only

Example
Dim File1 as New DataAccess
Dim Triplets()() as Variant
File1.Open “bobo.cnf”, dReadOnly
Triplets = File1.Calibrations.Efficiency.EfficiencyPoints

Dual Efficiency Cross Over Energy

This property retrieves cross over energy associated with the dual efficiency calibration.

112
 DataAccess

Calling Convention
CrossOver(lRecord)

Parameters
Long Record The record number.

Return
Variant CrossOver The cross over energy of the dual efficiency calibration.

Optional
None

Privilege
Read-Only

Example
Dim File1 as New DataAccess
Dim Cross as Variant
File1.Open “bobo.cnf”, dReadOnly
Cross = File1.Calibrations.Efficiency.CrossOver

Alpha Efficiency Calibration

This property retrieves alpha or average efficiency calibration coefficients.

Calling Convention
Alpha Curve (Long Record)

Parameters
Long Record (Optional) The record number.

Return
Variant Alpha Curve The alpha efficiency calibration. This calibration is a single
coefficient.

Optional
Long Record Default value is 1

Privilege
Read-Only

113
Component Programming Library Reference

Example
Dim File1 as New DataAccess
Dim Cal as Variant
File1.Open “bobo.cnf”, dReadOnly
Cal = File1.Calibrations.Efficiency.Alpha Curve

Matrix Correction Calibration

This property retrieves the matrix correction calibration information. All arrays must start
at index 0 (i.e., Option Base 0).

Calling Convention
MatrixCorrection

Parameters
None

Return
Variant MatrixCorrection.Curve(*) The matrix correction calibration. The calibration
array is allocated by the server. Therefore, you do
not need to allocate the memory before using this
property. For this model the order is
MatrixCorrection.Curve(0): Offset
MatrixCorrection.Curve(1): Slope
MatrixCorrection.Curve(2): Quadratic
MatrixCorrection.Curve(3): Cubic
MatrixCorrection.Curve(*): Higher

Variant MatrixCorrection.Points(3)(*)The energy, attenuation, and uncertainty triplets.

The data array is allocated by the server. Therefore,
you do not need to allocate the memory before us-
ing this property. The order is:
MatrixCorrection.Points (0)(*): Energy
MatrixCorrection.Points (1)(*): Attenuation
MatrixCorrection.Points (2)(*): Uncertainties

Optional
None

Privilege
Curve: Read-Only
Points: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant”
Dim Samples as Variant

114
 DataAccess

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.MatrixCorrection.Curve
Samples = File1.Calibrations.MatrixCorrection.Points

Neutron Mass
This property groups all of the neutron mass calibration properties under one interface.
The mass properties are tabulated below.

Multiplication Corrected All Multiplication Corrected

Calibration Information
NonMultCorrectedRates All non-multiplication corrected
calibration information

Multiplication Corrected Properties

This section outlines the multiplication corrected calibration properties.

Reals All Reals Calibration Information

Doubles All doubles calibration
information

All of the calibration types listed above have the following properties: Points, Curve, and
Covariance. The Points property will read and write calibration points to and from a
datasource. The Curve property will read and write the calibration coefficients to and
from a datasource. The Covariance property will read and write the calibration coeffi-
cient covariance to and from the datasource.

Reals Calibration
This property retrieves the reals calibration information. All arrays must start at index 0
(i.e., Option Base 0).

Calling Convention
Reals

Parameters
None

115
Component Programming Library Reference

Return
Variant Reals.Curve(*) The reals calibration. The calibration array is allocated by
the server. Therefore, you do not need to allocate the mem-
ory before using this property. The order is:
Reals.Curve(0): Offset
Reals.Curve(1): Slope

Variant Reals.Points(3)(*) The mass, reals, and uncertainty triplets. The data array is
allocated by the server. Therefore, you do not need to allo-
cate the memory before using this property. The order is:
Reals.Points (0)(*): Mass
Reals.Points (1)(*): Reals rate
Reals.Points (2)(*): Uncertainties

Variant Reals.Covariance(*)(*) The covariance matrix. The data array is allocated by

the server. Therefore, you do not need to allocate the
memory before using this property.

Optional
None

Privilege
Curve: Read-Write
Points: Read-Write
Covariance: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Samples as Variant

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.Mass.MultiplicationCorrected.Reals.Curve
Samples = File1.Calibrations.Mass.MultiplicationCorrected.Reals.Points

Doubles Calibration
This property retrieves the doubles calibration information. All arrays must start at index
0 (i.e., Option Base 0).

Calling Convention
Reals

Parameters
None

116
 DataAccess

Return
Variant Doubles.Curve(*) The double calibration. The calibration array is allocated
by the server. Therefore, you do not need to allocate the
memory before using this property. The order is:
Doubles.Curve(0): Offset
Doubles.Curve(1): Slope

Variant Doubles.Points(3)(*) The mass, doubles, and uncertainty triplets. The data ar-
ray is allocated by the server. Therefore, you do not need
to allocate the memory before using this property. The
order is:
Doubles.Points (0)(*): Mass
Doubles.Points (1)(*): Doubles rate
Doubles.Points (2)(*): Uncertainties

Variant Doubles.Covariance(*)(*) The covariance matrix. The data array is allocated by

the server. Therefore, you do not need to allocate the
memory before using this property.

Optional
None

Privilege
Curve: Read-Write
Points: Read-Write
Covariance: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Samples as Variant

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.Mass.MultiplicationCorrected.Doubles.Curve
Samples = File1.Calibrations.Mass.MultiplicationCorrected.Doubles.Points

Non-Multiplication Corrected Properties

This section outlines the multiplication corrected calibration properties.

NonMultReals All reals calibration information

NonMultTotals All totals calibration information

All of the calibration types listed above have the following properties: Points, Curve, and
Covariance. The Points property will read and write calibration points to and from a
datasource. The Curve property will read and write the calibration coefficients to and

117
Component Programming Library Reference

from a datasource. The Covariance property will read and write the calibration coeffi-
cient covariance to and from the datasource.

Non-Multiplication Corrected Reals Properties

This section outlines the multiplication corrected calibration properties.

Power All power function calibration information

Exponential All exponential function calibration information
Rational All rational function calibration information
Polynomial All polynomial function calibration information
Points Calibration points

All of the calibration functions have the following properties: Curve and Covariance. The
Curve property will read and write the calibration coefficients to and from a datasource.
The Covariance property will read and write the calibration coefficient covariance to and
from the datasource.

Power Function
This property retrieves the power function calibration information. All arrays must start
at index 0 (i.e., Option Base 0).

Calling Convention
Reals

Parameters
None

Return
Variant Power.Curve(*) The power function calibration. The calibration array is al-
located by the server. Therefore, you do not need to allo-
cate the memory before using this property. The order is:
Power.Curve(0): Exponent
Power.Curve(1): Mantissa

Variant Power.Covariance(*)(*) The covariance matrix. The data array is allocated by

the server. Therefore, you do not need to allocate the
memory before using this property.

Optional
None

118
 DataAccess

Privilege
Curve: Read-Write
Covariance: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Covar as Variant

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.Mass.NonMultCorrected.NonMultReals.Power.Curve
Covar = File1.Calibrations.Mass.NonMultCorrected.NonMultReals.Power.Covariance

Rational Function
This property retrieves the rational function calibration information. All arrays must start
at index 0 (i.e., Option Base 0).

Calling Convention
Reals

Parameters
None

Return
Variant Rational.Curve(*) The rational function calibration. The calibration array is
allocated by the server. Therefore, you do not need to allo-
cate the memory before using this property. The order is:
Rational.Curve(0): Denominator
Rational.Curve(1): Numerator

Variant Rational.Covariance(*)(*) The covariance matrix. The data array is allocated

by the server. Therefore, you do not need to allocate
the memory before using this property.

Optional
None

Privilege
Curve: Read-Write
Covariance: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Covar as Variant

119
Component Programming Library Reference

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.Mass.NonMultCorrected.NonMultReals.Rational.Curve
Covar = File1.Calibrations.Mass.NonMultCorrected.NonMultReals.Rational.Covariance

Exponential Function
This property retrieves the exponential function calibration information. All arrays must
start at index 0 (i.e., Option Base 0).

Calling Convention
Reals

Parameters
None

Return
Variant Exponential.Curve(*) The exponential function calibration. The calibration ar-
ray is allocated by the server. Therefore, you do not need
to allocate the memory before using this property. The
order is:
Exponential.Curve(0): Exponent
Exponential.Curve(1): Mantissa

Variant Exponential.Covariance(*)(*)The covariance matrix. The data array is allocated

by the server. Therefore, you do not need to allo-
cate the memory before using this property.

Optional
None

Privilege
Curve: Read-Write
Covariance: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Covar as Variant

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.Mass.NonMultCorrected.NonMultReals.Exponential.Curve
Covar = File1.Calibrations.Mass.NonMultCorrected.NonMultReals.
Exponential.Covariance

120
 DataAccess

Polynomial Function
This property retrieves the polynomial function calibration information. All arrays must
start at index 0 (i.e., Option Base 0).

Calling Convention
Reals

Parameters
None

Return
Variant Exponential.Curve(*) The polynomial function calibration. The calibration
array is allocated by the server. Therefore, you do not
need to allocate the memory before using this property.
The order is:
Polynomial.Curve(0): Offset
Polynomial.Curve(1): Slope
Polynomial.Curve(2): Quadratic
Polynomial.Curve(3): Cubic

Variant Exponential.Covariance(*)(*) The covariance matrix. The data array is allo-

cated by the server. Therefore, you do not need
to allocate the memory before using this prop-
erty.

Optional
None

Privilege
Curve: Read-Write
Covariance: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Covar as Variant

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.Mass.NonMultCorrected.NonMultReals.Polynomial.Curve
Covar = File1.Calibrations.Mass.NonMultCorrected.NonMultReals.
Polynomial.Covariance

Points
This property retrieves the calibration data. All arrays must start at index 0 (i.e., Option
Base 0).

121
Component Programming Library Reference

Calling Convention
Reals

Parameter
None

Return
Variant Points(*) The calibration data. The calibration array is allocated by
the server. Therefore, you do not need to allocate the mem-
ory before using this property.

Optional
None

Privilege
Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Data as Variant

File1.Open “bobo.cnf”, dReadOnly

Data = File1.Calibrations.Mass.NonMultCorrected.NonMultReals.Points

Non-Multiplication Corrected Totals Calibration

This property retrieves the totals calibration information. All arrays must start at index 0
(i.e., Option Base 0).

Calling Convention
Reals

Parameters
None

Return
Variant NonMultTotals.Curve(*) The totals calibration. The calibration array is allo-
cated by the server. Therefore, you do not need to al-
locate the memory before using this property. The
order is:
Totals.Curve(0): Offset
Totals.Curve(1): Slope

122
 DataAccess

Variant NonMultTotals.Points(3)(*) The mass, totals, and uncertainty triplets. The data
array is allocated by the server. Therefore, you do
not need to allocate the memory before using this
property. The order is:
Totals.Points (0)(*): Mass
Totals.Points (1)(*): Doubles rate
Totals.Points (2)(*): Uncertainties

Variant NonMultTotals.Covariance(*)(*) The covariance matrix. The data array is allo-

cated by the server. Therefore, you do not
need to allocate the memory before using this
property.

Optional
None

Privilege
Curve: Read-Write
Points: Read-Write
Covariance: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Samples as Variant

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.Mass.NonMultiplicationCorrected.NonMultTotals.Curve
Samples = File1.Calibrations.Mass.NonMultiplicationCorrected.NonMultTotals.Points

Add-a-Source
This property groups all of the neutron add-a-source calibration properties under one
interface.

Reals All reals calibration information

Totals All totals calibration information

All of the calibration types listed above have the following properties: Points, Curve, and
Covariance. The points property will read and write calibration points to and from a
datasource. The curve property will read and write the calibration coefficients to and
from a datasource. The covariance property will read and write the calibration coefficient
covariance to and from the datasource.

123
Component Programming Library Reference

Reals Calibration
This property retrieves the reals calibration information. All arrays must start at index 0
(i.e., Option Base 0).

Calling Convention
Reals

Parameters
None

Return
Variant Reals.Curve(*) The reals calibration. The calibration array is allo-
cated by the server. Therefore, you do not need to al-
locate the memory before using this property. The
order is:
Reals.Curve(0): Offset
Reals.Curve(1): Slope

Variant Reals.Points(3)(*) The mass, reals, and uncertainty triplets. The data ar-
ray is allocated by the server. Therefore, you do not
need to allocate the memory before using this prop-
erty. The order is:
Reals.Points (0)(*): Mass
Reals.Points (1)(*): Reals rate
Reals.Points (2)(*): Uncertainties

Variant Reals.Covariance(*)(*) The covariance matrix. The data array is allocated by

the server. Therefore, you do not need to allocate the
memory before using this property.

Optional
None

Privilege
Curve: Read-Write
Points: Read-Write
Covariance: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Samples as Variant

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.AddASource.Reals.Curve
Samples = File1.Calibrations.AddASource.Reals.Points

124
 DataAccess

Totals Calibration
This property retrieves the totals calibration information. All arrays must start at index 0
(i.e., Option Base 0).

Calling Convention
Reals

Parameters
None

Return
Variant Totals.Curve(*) The totals calibration. The calibration array is allocated by
the server. Therefore, you do not need to allocate the mem-
ory before using this property. The order is:
Totals.Curve(0): Offset
Totals.Curve(1): Slope

Variant Totals.Points(3)(*) The mass, totals, and uncertainty triplets. The data array is
allocated by the server. Therefore, you do not need to allo-
cate the memory before using this property. The order is:
Totals.Points (0)(*): Mass
Totals.Points (1)(*): Doubles rate
Totals.Points (2)(*): Uncertainties

Variant Totals.Covariance(*)(*) The covariance matrix. The data array is allocated by

the server. Therefore, you do not need to allocate the
memory before using this property.

Optional
None

Privilege
Curve: Read-Write
Points: Read-Write
Covariance: Read-Write

Example
Dim File1 as New DataAccess
Dim Cal as Variant
Dim Samples as Variant

File1.Open “bobo.cnf”, dReadOnly

Cal = File1.Calibrations.AddASource.Totals.Curve
Samples = File1.Calibrations.AddASource.Totals.Points

125
Component Programming Library Reference

DeviceAccess
The DeviceAccess component is use to control both neutron devices and spectroscopy
devices. The DeviceAccess component allows you to connect to and acquire with the fol-
lowing devices: JSR-12, JSR-14, 2150, and all Genie 2000 supported devices.

This component may be added to a VB project by selecting Project | Components, then in

the Components dialog, select “Canberra Nuclear Device Control Library”. An icon simi-
lar to the one in Figure 18 will appear in the VB toolbar.

Figure 18 Control
Library Icon

Double click on this icon and it will appear on your VB form. This icon will appear only
during design time. There are no properties visible in the property toolbar list; all proper-
ties and methods become visible during coding.

DeviceAccess Data Types

DeviceAccess defines the following new data types:

DeviceCommands Commands to send to devices

StopOptions Options when stopping an acquisition
ParamCodes CAM parameter codes
ClassCodes CAM parameter class codes
MasksAndVals CAM parameter bit mask codes
CoincidenceModes ADC Coincidence modes
PeakDetectModes ADC PeakDetect Modes
Interfaces ADC Interface

126
 DeviceAccess

DeviceCommands Commands to send to devices

Signals ADC Signal
TransferModes ADC Trasfer modes
DeviceMessages Messages sent from the device in an Event
AdviseMessageMasks Messages sent from the device in an Event
MessageCodes Component warning and error codes

DeviceAccess Methods
This DeviceAccess is defined by the following methods:

Operation Description
Connect Connects to a device
Disconnect Disconnects from a device
Clear Clears a devices memory
SpectroscopyAcquireSetup Sets up a spectroscopy detector for
acquisition
NeutronAcquireSetup Sets up a neutron device for acquisition
AcquireStart Starts an acquisition (multi-threaded)
AcquireStop Stops an acquisition
AcquirePause Pauses an acquisition
ClassCopy Copies a CAM class
Save Save the device data to a file
SpectroscopyMeasurements Returns the spectroscopy measurements
NeutronMeasurements Returns the neutron measurements
VerifyDeviceSettingsEx Verifies the device settings
SetMemoryGroup Changes the current spectroscopy memory
group
SendCommand Sends a device command to the current
device
SendCommand2ListOfDetectors Sends a device command to a list of
spectroscopy detectors
EvaluteSpectroscopyCalibration Evaluates the current energy, efficiency,
FWHM, or low energy tail calibration

127
Component Programming Library Reference

Operation Description
ConvertEnergyToChannel Converts an energy value to a channel
value
ComputeROIs Quantifies an ROI
GetBootParameters Get JSR-14 bootstrap parameters
PutBootParameters Set JSR-14 bootstrap parameters
CopyRecord Copies a record into a class

Connecting to a Device
Communications with a device begins when a connection to the device has been success-
fully established. This method allows the programmer to make that connection.

Note The device may be opened read-write by multiple components in the same pro-
cess. However, all openers share the same device/handle. Therefore any save to
the device will result in all changes being saved.

Calling Convention
Connect(String Name, ConnectOptions Mode, AnalyzerType Type, String Port,
BaudRate Rate)

Parameters
String Name The name of the detector

ConnectOptions Mode (Optional) The open or create options:

aReadOnly: Read Only access

aReadWrite: Read Write access

aContinue: Take control of spectroscopy de-

tector without aborting acquisi-
tion

aTakeControl: Take control of spectroscopy de-

tector

aTakeOver: Take over spectroscopy detector

aNoVerifyLicense This option allows you to run the

VDM without having a license.

AnalyzerType Type (Optional) The type of device to connected to:

aSpectroscopyDetector: A detector

128
 DeviceAccess

aShiftRegisterJsr12: JSR-12

aShiftRegisterJsr14: JSR-14 (Shift Register mode)

aMultiplicityJsr14: JSR-14 (Multiplicity mode)

aMultiplicity2150: 2150

ANeutronAutoDetect: Detect JSR-14 Device mode

BaudRate Rate (Optional) The baud rate for serial communications. This is
required for neutron device control. Note that this value
does affect the baud rate settings for spectroscopy devices.

aUseSystemSettings The Windows System COM port

settings

a19200 19.2K baud

a9600 9600 baud

a4800 4800 baud

a2400 2400 baud

a1200 1200 baud

String Port (Optional) The name of the serial port. This is required for
neutron device control. Note that this value does affect the
port settings for spectroscopy devices.

Optional
ConnectOptions Mode Value of aReadWrite

AnalyzerType Type Value of aSpectroscopyDetector

BaudRate Rate Value of aUseSystemSettings

String Port Value of “COM1”

Example
On Error Resume Next
Det1.Connect “Jsr”, aReadWrite, aMultiplicity2150 , “COM1”
If (Det1.IsError(Err.Number)) Then Goto Exit

Error Handling
This method may generate an error or warning when connecting to spectroscopy devices.
Here is a guide to handling some specific errors and warnings:

129
Component Programming Library Reference

Fatal Errors
This class of error indicates that the open of the device had failed. Some common fatal
errors are:

Error &H8CE99EA2 : Busy input but never open. This condition arises when then
VDM, in responding to a request for opening an input, detects that the input is busy
but is not being monitored. This may be recoverable by reconnecting to the device
using one of the aContinue or aTakeControl options. aTakeControl will stop the
current acquisition and reverify the device settings. aContinue will allow the
acquisition to continue.

Error &H80120008 : Hardware Unavailable. The device driver cannot connect to the
device. Check all physical connections and all MID settings.

Error &H80130019 : Owner Mismatch : The device is owned by another user. In the
case of an AIM, this situation may be corrected by using the aTakeOver option. Do
this only if no other user is currently using the AIM.

Major Errors
Error &H8CE99EA3 : Verify Error. This is often caused by a configuration setup.
Verify the model number settings for all devices in your MID file match the actual
devices. As with fatal errors, the device is not connected after this error.

Minor Errors
Error &H8CE99D36 : Verify Warning. This warning is generated when there are
minor verification errors. When these types of errors occur, you have connected to the
device. However, some settings in the device do not match the stored settings of the
device. The exact cause of a minor verification errors may be determined by calling
VerifyDeviceEx().

Disconnecting from a Device

Once a device has been connected to an analyzer it must be disconnected to control an-
other device. This function describes the disconnection operation.

Calling Convention
Disconnect()

Parameters
None

Optional
None

130
 DeviceAccess

Example
Dim Det1 as New DeviceAccess
Det1.Connect “DET1”, aReadWrite Or aTakeOver
Det1.Disconnect

Clearing the Device

This will clear the analyzer spectrum and elapsed time for spectroscopy devices. Neutron
device data memory and elapsed time are both cleared.

Calling Convention
Clear()

Parameters
None

Optional
None

Example
Dim Det1 as New DeviceAccess
Det1.Connect “DET1”, aReadWrite Or aTakeOver
Det1.Clear
Det1.Disconnect

Setting up a Spectroscopy Detector

This routine sets up the spectroscopy detector before acquisition.

Calling Convention
SpectroscopyAcquireSetup(AcquisitionModes Mode, Double Lim, Long Start, Long
End, Double ElapsedTime, Single HighVoltage)

Parameters
AcquisitionModes Mode (Optional) The preset modes are:

aCountToLiveTime: Count to preset live time

aCountToRealTime: Count to preset real time

aCountToTotal: Count to preset totals

aCountToArea: Count to preset peak area

aCountToLevel: Count to level

aCountToSweep: Count to preset sweep

131
Component Programming Library Reference

aCountNormal: Count to current preset settings

Double Lim (Optional) The preset limit.

Long Start (Optional) The preset start channel

Long End (Optional) The preset end channel

Double ElapsedTime (Optional) The preset time limit. This argument should be
set only during: aCountToTotal, aCountToArea, or
aCountToLevel.

Single HighVoltage (Optional) The high voltage value. If specified as 0.0 the
value is ignored and the value stored in the device is used.

Optional
AcquisitionModesMode A value of aCountNormal.

Boolean SignalWhenDone A value of True

Double Lim A value of 0.0

Long Start A value of 0

Long End A value of 0

Double ElapsedTime A value of 0.0

Single HighVoltage A value of 0

Example
Det1.Connect “DET1”, aReadWrite Or aTakeOver
‘Stop and Clear
Det1.AcquireStop
‘Set count to live time and set high voltage to 3000 volts
Det1.SpectroscopyAcquireSetup aCountToLiveTime, 1000, 0, 0, 3000

Note 1 This method will turn on the high voltage for the devicN.

ote 2

To specify a computational preset (aCountToTotal, aCountToArea,

aCountToLevel) the flag must be combined with either aCountToLiveTime or
aCountToRealTime. In these cases the value specified for ElapsedTime will be
set to the real or live time preset limit.

Setting up a Neutron Device

This routine sets up a neutron device before acquisition.

132
 DeviceAccess

Calling Convention
NeutronAcquireSetup(Single Gatewidth, Single Predelay, Double CountTime, Long
Cycles, Long Voltage, Single DeadTime)

Parameters
Single Gatewidth (Optional) The gate width (µs)

Single Predelay (Optional) The pre-delay (µs)

Double CountTime (Optional) The count time (s)

Long Voltage (Optional) The voltage. This parameter is not used for 2150
devices.

Long Cycles (Optional) The number of cycles

Single DeadTime (Optional) The dead time in microseconds. This is required

only to correctly compute the multiplicity rates.

Optional
Long Voltage A value of 1500

Long Cycles A value of 1

Double CountTime A value of 60.0

Single Gate A value of 60.0

Single Predelay A value of 4.5

Single DeadTime A value of 0.0

Starting an Acquisition
This routine starts an acquisition using the currently connected device.

Calling Convention
AcquireStart()

Parameters
None

Optional
None

133
Component Programming Library Reference

Example
Dim Det1 as New DeviceAccess
Dim Jsr as New DeviceAccess
Det1.Connect “DET1”
Det1.Clear
Det1.SpectroscopySetup aCountToLiveTime, 100.0
Jsr.Connect “Jsr”, aReadWrite, aShiftRegisterJsr14
Jsr.Clear
Jsr.NeutronSetup 60
Det1.AcquireStart
Jsr.AcquireStart

Stopping an Acquisition
This routine aborts an acquisition. All data is cleared after the device is stopped.

Calling Convention
AcquireStop(StopOptions Options)

Parameters
StopOptions Options The stop options are:

aNormalStop: Performs a normal device stop

aStopSweep: Performs a sweep stop

Return
None

Optional
StopOptions Options A value of aNormalStop

Example
Det1.Connect “DET1”
Det1.Clear
Det1.SpectroscopyAcquireSetup aCountToLiveTime, 100.0
Jsr.Connect “Jsr”, aReadWrite, aShiftRegisterJsr14
Jsr.Clear
Jsr.NeutronAcquireSetup 60
Det1.AcquireStart
Jsr.AcquireStart
Jsr.AcquireStop

Pausing an Acquisition
This routine stops an acquisition without clearing the data.

134
 DeviceAccess

Calling Convention
AcquirePause(StopOptions Options)

Parameters
StopOptions Options The stop options are:

aNormalStop: Performs a normal device stop

aStopSweep: Performs a sweep stop

Return
None

Optional
StopOptions Options A value of aNormalStop

Example
Det1.SpectroscopyAcquireSetup aCountToLiveTime, 100.0
Det1.AcquireStart
Det1.AcquirePause
.
.
.
Det1.AcquireStart

Copying a Parameter Block

This method will copy a parameter block from one storage device to another.

Calling Convention
CopyBlock(Variant Destination, ClassCodes Class, ParamCodes Param)

Parameters
Variant Destination

The name of the file, DataAccess object, or DeviceAccess object to copy the information
into.

ClassCodes Class The class to create. Set to 0 if you want to use a parameter
code.

Optional
ParamCodes Param (Optional) The parameter which is defined in the class.
This should be used to define the class if the class of the
parameter is not known.

135
Component Programming Library Reference

Boolean Overwrite (Optional) If true and the file exists, the block is overwrit-
ten.

Optional
ParamCodes Param A value of 0

Example
Det1.Connect “DET1”
Det1.Clear
Det1.CopyBlock “ecal.cnf”, CAM_CLS_SHAPE

Saving Data
This function will save data into a file or to the device.

Calling Convention
Save(String Name, Boolean Overwrite)

Parameters
String Name (Optional) The name of the output file. If , the device
settings are updated back to the device.

Boolean Overwrite (Optional) If true and the output file exists, the file is over-
written.

Return
None

Optional
String Name A value of “”

Boolean Overwrite A value of false

Example
Det1.Connect “DET1”
Det1.Clear
Det1.AcquireStart aCountToLiveTime, false, 10.0
•
•
•
Det1.Save “bobo.cnf”, True

Retrieving Spectral Measurements

This function will retrieve spectral measurements during or after an acquisition.

136
 DeviceAccess

Calling Convention
SpectroscopyMeasurements(String StartTime, double ElapsedTime, Variant Spectrum)

Parameters
String StartTime The acquisition start time

Variant Spectrum(*) The spectral data; this is an array of singles that starts at in-
dex 0

Double ElapsedTime The elapsed live time

Optional
None

Example
Dim Det1 as New DeviceAccess
Dim Time as String
Dim prSpec as Variant
Det1.Connect “DET1”
Det1.Clear
Det1.AcquireStart aCountToLiveTime, false, 10.0
Det1.SpectroscopyMeasurements Time, prSpec

Retrieving Neutron Measurements

This function will retrieve neutron measurements during or after an acquisition.

Calling Convention
NeutronMeasurements(String StartTime, double ElapsedTime, Variant Rates, Long Cy-
cle)

Parameters
String StartTime The acquisition start time

Double ElapsedTime The elapsed time (sec)

Variant Rates (*) The neutron coincidence rates. This array is dimension
based on the type of acquisition. If multiplicity acquisitions
are performed, the rates are:

Rates(0): Totals

Rates(1): Reals

Rates(2): Accidentals

Rates(3): Doubles

137
Component Programming Library Reference

Rates(4): Triples

If shift register acquisitions are performed the array is

dimensioned to 0-3.

Long Cycle The cycle to retrieve the rates from. If the cycle has not
been acquired at the time of the call, the most current cycle
is returned

Return
None

Optional
None

Example
Dim Det1 as New DeviceAccess
Dim Time as String
Dim ElapsedTime as Double
Dim Cycle as Long
Dim Rates as Variant
Cycle = 1
Det1.Connect “DET1”
Det1.Clear
Det1.AcquireStart aCountToLiveTime, false, 10.0
Det1.NeutronMeasurements Time, ElapsedTime, Rates, Cycle

Verify Input Devices

This function will execute a verification of the device settings. Spectroscopic devices will
reverify devices and query the devices to find any discrepancies. Neutron devices query
the hardware for device settings and compare the settings to those defined at setup.

Calling Convention
VerifyInputDevicesEx()

Parameters
None

Returns
Long Status If the device is o.k. then Status is PAS__OK. The return
values may be:

For Spectroscopic Devices

PAS__HWDFAULT: Hardware query error

PAS__COMFAIL: Software communications error

138
 DeviceAccess

PAS__POWERFAIL: Power failure

PAS__BADMODEL: Model mismatch

PAS__BADSERIALNO: Serial number mismatch

PAS__HWDCHANGE: Hardware settings have changed

For Neutron Devices

PAS__PREDELAYMISMATCH: The pre-delay value is not valid

PAS__GATEWIDTHMISMATCH: The gate-width is not valid

PAS__CNTTIMEMISMATCH: The count time is not valid

PAS__BAUDRATEMISMATCH: The baud rate is invalid

PAS__NUMTRIALSMISMATCH: The number of trials is invalid

PAS__HVMISMATCH: The high voltage is invalid

Optional
None

Example
Dim State as Long
Det1.Connect “DET1”
Det1.Clear
State = Det1.VerifyInputDevicesEx
If (State < > PAS__OK) Then
MsgBox Det.Message State, vbOkOnly

Defining the Memory Group

This function will set the current spectroscopic memory group.

Calling Convention
SetMemoryGroup(Long lGroup, Long Case)

Parameters
Long Group The memory group

Long Case Do not use

Return
None

139
Component Programming Library Reference

Optional
Case A value of 0.

Example
Det1.Connect “DET1”
Det1.Clear
Det1.SetMemoryGroup 1

Sending Commands to a Device

Sends commands to the acquisition device.

Calling Convention
SendCommand(DeviceCommands Command)

Parameters
DeviceCommands Command The command to send. Commands are:

aStart: Start acquisition,

aAbort: Stop acquisition

aStop: Stop at end of sweep

aMove: Move the sample changer (spec-

troscopy devices only)

aClear: Clear the device memory

aReset: Power reset (spectroscopy de-

vices only)

aReverify: Reverify device settings

aHome: Send sample change to home po-

sition (spectroscopy devices
only)

aLoad: Load sample changer (spectros-

copy devices only)

aUnload: Unload sample changer (spec-

troscopy devices only)

Optional
None

140
 DeviceAccess

Example
Det.Open "Det1"
Det.SendCommand aStart

Sending Commands to a List of Detectors

Sends commands to a list of spectroscopy devices. If an error or warning is detected
while connecting to the detectors in the list, the warnings a passed back to the client via
the AsynchronousMessages event and the command is executed. Errors are passed back
to the client via the return code of the method and connection to the detectors in the list
are broken. The string array must start at index 0 (i.e., Option Base 0).

Calling Convention
SendCommand2ListOfDetectors(String List(*), DeviceCommands command)

Parameters
String List(*) An array of detector names to send the commands to.

DeviceCommands Command The command to send. Commands are:

aStart: Start acquisition,

aAbort: Stop acquisition

aStop: Stop at end of sweep

aMove: Move the sample changer

aClear: Clear the device memory

aReset: Power reset

aReverify: Reverify device settings

aHome: Send sample change to home po-

sition

aLoad: Load sample changer

aUnload: Unload sample changer

Optional
None

Example
Dim List(0 to 1) as String
List(0) = "Det1"
List(1) = "Det2"
Device.SendCommand2ListOfDetectors List, aStart

141
Component Programming Library Reference

Evaluating Spectroscopic Calibrations

This method will allow you to evaluate a point in the current spectroscopy calibration,
where “current” means that for evaluating efficiency, the calibration type defined by the
CAM parameter CAM_T_EFFTYPE is used.

Calling Convention
EvaluateSpectroscopyCalibration(Single Point, SpectroscopyCalibrations Type, Single
Value, Single Uncertianty, Boolean PtIsEnergy)

Parameters
Single Point The point used to evaluate the calibration.

SpectroscopyCalibration Type The type of calibration to evaluate.

dEfficiency: Using the default efficiency de-

fined by CAM_T_EFFTYPE

dFwhm: Using the default FWHM defined

by CAM_T_FWCALTYPE. Cur-
rently, only the square root model
is supported.

dEnergy: Energy Calibration

dLowEnergyTail: Low energy tail calibration

Single Value The evaluated calibration

Single Uncertainty The uncertainty in the evaluated calibration.

Boolean PtIsEnergy (Optional) If true evaluation point is assumed to be in units

of energy (keV).

Optional
Boolean PtIsEnergy A value of false

Example
Dim Vals as Variant
Det1.Connect "DET1"
Det1.EvaluateSpectroscopyCalibration 128, dFwhm, Val, Unc

Converting from Energy To Channel

This method will allow you to convert an energy value to a channel

Calling Convention
ConvertEnergyToChannel(Single Energy)

142
 DeviceAccess

Parameters
Single Energy The energy to convert (keV).

Optional
None

Return
Single Chan The channel

Example
Det1.Connect “DET1”
Chan = Det1.ConvertEnergyToChannel(128.2)

Computing ROIs
This method will allow you to quantify an ROI.

Calling Convention
ComputeROIs(Single Left, Single Right, Long BackgroundChans, Single Sigma,
Boolean ValuesAreEnergy)

Parameters
Single Left The left ROI

Single Right The right ROI

Long BackgroundChans The number of background channels (currently unsed)

Single Sigma The number of standard deviations (currently unused)

Boolean ValuesAreEnergy If true, the ROIs are in energy units (keV)

Optional
None

Return
Variant Vals This is an array of doubles where dimensions are

[0]: Integral

[1]: Area

[2]: Area Uncertainty

[3]: Gaussian Ratio

[4]: Centroid

143
Component Programming Library Reference

[5]: FWHM

[6]: FWTM

Example
Dim Vals as Variant
Det1.Connect "DET1"
Vals = Det1. ComputeROIs(512, 520, 5, 3.0)

Setting or Getting Boot Parameters

This method is applicable only for neutron devices. The method reads or writes the
JSR-14 boot parameters. If the device is not a JSR-14, nothing is done.

Note When you put the boot parameters you cannot send any command to the hard-
ware until you receive the aNeutronDevTimer message. The hardware takes a
while to get out of the bootstrap mode. Getting boot parameters does not go
into boot strap mode (i.e., there is need to wait for a aNeutronDevTimer mes-
sage).

Calling Convention
PutBootParameters(ProgrammableAnalyzerType DevMode, HighVoltageMode
HvMode, PowerSource PMode, BaudRate
Baud)GetBootParameters(ProgrammableAnalyzerType DevMode, HighVoltageMode
HvMode, PowerSource PMode, BaudRate Baud, Boolean BootCmd)

Parameters
None

Return
ProgrammableAnalyzerType Type The mode of the device.

AShiftRegisterJsr14: Shift register mode

AMultiplicityJsr14: Multiplicity mode
HighVoltageMode HvMode The high voltage mode.

AManual: Manual mode

AInstalled: Installed mode
APortable: Portable mode
PowerSource Pmode The power source mode

AAC: AC powered
ABattery: Battery powered
BaudRate Baud The baud rate

144
 DeviceAccess

Boolean BootCmd If true, a boot command is sent to get the param-

eters. You must wait for the aNeutronDevTimer
message before writing to the device.

Optional
Boolean BootCmd A value of false.

Example
Dev.Connect “jsr14”, aReadWrite, aNeutronAutoDetect, “COM1”
If (Dev.AnalyserType < > aShiftRegisterJsr14) Then _
Dev.PutBootParameters(aShiftRegisterJsr14, aManual, aAC, a9600)

Moving or Copying a Record

This method will allow you to copy or move a record.

Calling Convention
CopyRecord(ClassCodes lClass, long SourceRec, long DestRec, Boolean Delete,
Varaint Dest)

Parameters
ClassCodes Class The class to copy from.

Long SourceRec The source record.

Long DestRec The destination record.

Boolean Delete If true, the source record is deleted after the copy. This
changes the method to a move operation.

Variant Dest The destination interface. This can be a DeviceAccess or

DataAccess interface. Also if the Variant is empty the
source object is used as the destination object.

Optional
None

Example
Dim Det1 as New DeviceAccess
Det1.Connect "DET1", aReadWrite Or aTakeOver
Det1.CopyRecord CAM_CLS_PEAK, 1, 2, True, "test.cnf"

DeviceAccess Properties
Some properties are read-only; a value can not be assigned to these types of properties.
Therefore, a topic called Privilege has been added to describe whether the property is

145
Component Programming Library Reference

read-only or read-write. An example is provided by each property description. The prop-

erties are given in the table below.

Name Description
Param Reads and Writes a parameter
ParamArray Reads and Writes an array of parameters
ParamArrayEx Reads and Writes an array for a single parameter
Spectrum Reads a spectrum
Name Returns the name of the CAM file
HighVoltage Reserved for internal use
ADC Reserved for internal use
Amplifier Reserved for internal use
AnalyzerType Returns the type of device being used
AnalyzerStatus Returns the status of the device
IsModified Returns true if the device was modified
ListSpectroscopyDevices Returns a string array of MID detectors
AccessHandle Returns the device access handle
IsWarning Displays a warning message
IsError Displays an error message
Message Returns the status message text by the staus code

Parameter Access
Detector settings may be read from or written to a device.

Note Date/Time parameters written to the datasource must be Visual Basic data type.
When a Date/Time parameter is read from the datasource, it is returned as a Vi-
sual basic string.

Calling Convention
Param(ParamCodes Param, Long Record, Long Entry)

Parameters
ParamCodes Param The parameter code defining the parameter to read or write.

Long Record (Optional) The record number.

146
 DeviceAccess

Long Entry (Optional) The entry number.

Return
Variant Param The parameter value

Privilege
Read-Write

Optional
Long Record A value of 1

Long Entry A value of 1

Example
Dim Det1 as New DeviceAccess
Dim Det2 as New DeviceAccess
Det1.Connect “DET1”
Det2.Connect “DET2”
Det2.Param(CAM_L_CHANNELS) = Det1.Param(CAM_L_CHANNELS)
Det2.Param(CAM_F_ECALTOL) = 1.2

Parameter Array Access

Detector groups of settings may be read from or written to a device. All arrays must start
at index 0.

Note Date/Time parameters written to the datasource must be Visual Basic data type.
When a Date/Time parameter is read from the datasource, it is returned as a Vi-
sual basic string.

Calling Convention
ParamArray(ParamCodes Param(*), Long Record, Long Entry)

Parameters
ParamCodes Param(*) The parameter codes defining the parameter to read or
write.

Long Record (Optional) The record number.

Long Entry (Optional) The entry number.

Return
Variant Params(*) The parameter values. The parameter array is allocated by
the server. Therefore, you do not need to allocate the mem-
ory before using this property.

147
Component Programming Library Reference

Privilege
Read-Write

Optional
Long Record A value of 1

Long Entry A value of 1

Example
Dim Det1 as New DeviceAccess
Det1.Connect “DET1”
arCodes(0) = CAM_L_CHANNELS
arCodes(1) = CAM_T_STITLE
arCodes(2) = CAM_F_ECALTOL
Vals = Det1.ParamArray(arCodes)

Single Parameter Array

An array of values for a specific parameter may be read from or written to a CAM file.
All arrays must start at index 0 (i.e., Option Base 0).

Note Date/Time parameters written to the datasource must be Visual Basic data type.
When a Date/Time parameter is read from the datasource, it is returned as a Vi-
sual basic string.

Calling Convention
ParamArrayEx(ParamCodes Param, Long Num, Long Options, Long Record,
Long Entry)

Parameters
ParamCodes Param The parameter code defining the parameter to read or write.

Long Num The number of values to retrieve.

ArrayOptions Option (Optional) The options:

dAutoIncrementRecord: Increments the record number.

dAutoIncrementEntry: Increments the entry number.

Long Record (Optional) The start record number.

Long Entry (Optional) The start entry number.

Return
Variant Params(*) The parameter values. The parameter array is allocated by
the server. Therefore, you do not need to allocate the mem-
ory before using this property.

148
 DeviceAccess

Privilege
Read-Write

Optional
Long Record A value of 1

Long Entry A value of 1

ArrayOptions Option A value of dAutoIncrementRecord

Example
Dim Vals as Variant
Det.Open “det1”, dReadWrite
Vals = Det.ParamArrayEx(CAM_L_RGNSTART, 2, dAutoIncrementRecord)

Spectral Access
This property will write or retrieve all or a portion of the spectral data from the detector.
All arrays must start at index 0.

Calling Convention
Spectrum(Long lStart, Long lStop)

Parameters
Long lStart (Optional) The start channel.

Long lStop (Optional) The stop channel. A negative value indicates

that the number of channels should be read from the de-
vice.

Return
Variant Spectrum(*) The spectrum. The spectral array is allocated by the server.
Therefore, you do not need to allocate the memory before
using this property. This is an array of Single which starts
at array index 0.

Privilege
Read-Write

Optional
Long lStart A value of 1

Long lStop A value of -1

149
Component Programming Library Reference

Example
Dim Det1 as DeviceAccess
Dim File1 as DataAccess
File1.Open “bobo.cnf”, dReadOnly
Det1.Connect “DET1”
File1.Spectrum = Det1.Spectrum

Name of the Device

This property will retrieve the name of the device.

Calling Convention
Name

Parameters
None

Return
String Name The name of the detector which is connected to the ana-
lyzer.

Optional
None

Privilege
Read-Only

Example
Dim Det1 as New DeviceAccess
Dim szName as String
Det1.Connect “DET1”
szName = Det1.Name

Determining Analyzer Status

Reads the acquisition status.

Calling Convention
AnalyzerStatus

Parameters
None

150
 DeviceAccess

Return
long AnalyzerStatus The status of the analyzer. There is a enumeration in VB
which defines all possible status bits. This enumeration is
defined as DeviceStatus.

aIdle: Device is not-acquiring

(DDS_Idle)

aAcquiring: Device is acquiring (DSS_Busy)

aAcquireDone: Acquisition is done (DSS_Done)

aTransferData: Transfering data from device to

PC (DSS_Update)

aPaused: Acquisition has paused

(DSS_Stopped)

aPresetReached: Preset reached (DSS_Reached)

aComputing: Performing data computations

(DSS_SoftBusy)

aError: Error during acquisition

(DSS_Error)

aHardwareCheck: Verifying hardware settings (no

DSS flag)

Privilege
Read-Only

Optional
None

Example
Dim Det1 as New DeviceAccess
Dim szName as String
Det1.Connect “DET1”
Det1.Clear
Det1.AcquireStart
lStat = aAcquireDone
If (Det1.AnalyzerStatus or 1Stat) = 1Stat Then …

Determining the Analyzer Type

Returns the type of analyzer which has been connected to.

151
Component Programming Library Reference

Calling Convention
AnalyzerType

Argument
None

Return
AnalyzerType The type of analyzer. These types are:

aSpectroscopyDetector: A detector

aShiftRegisterJsr12: JSR-12

aShiftRegisterJsr14: JSR-14 (Shift Register mode)

aMultiplicityJsr14: JSR-14 (Multiplicity mode)

aMultiplicity2150: 2150

Privilege
Read-Only

Optional
None

Determining if Connected
This property allows the programmer to determine if the component is connected to a de-
vice.

Calling Convention
IsConnected

Parameters
None

Return
Boolean IsConnected If true, the interface is connected to a device.

Optional
None

Privilege
Read-Only

152
 DeviceAccess

Example
Dim Det as New DeviceAccess
Dim Cross as Variant
Dim ErrorStr as String
Det.Connect “Det1”, aReadWrite
If (Det.IsConnected = False) Then

•
•
•

Determining MID Defined Spectroscopy Detectors

This property allows the programmer to get a list of the spectroscopy detectors defined
by the MID wizard. The returned array starts at index 0 (i.e., Option Base 0).

Calling Convention
ListSpectroscopyDevices

Parameter
None

Return
Variant ListSpectroscopyDevices An array of strings defining each detector name.

Optional
None

Privilege
Read-Only

Example
Dim arDets as• Variant
arDets = Det.ListSpectroscopyDevices
if (UBound(arDets) > 0) Then Det.Connect arDets(0)

•
•
•

Access Handle
This property returns the access handle which may be used for the SAD API.

Calling Convention
AccessHandle

153
Component Programming Library Reference

Parameters
None

Return
Variant AccessHandle The handle which may be passed to Genie-2K API.

Optional
None

Privilege
Read-Only

Example
Dim Val as Single
Dim iSize as Integer
Dim Rc as Integer
Det.Open “Det1”
iSize = 4
Rc = SadGetParam(Det.AccessHandle, CAM_F_ECALTOL, 1, 1, Val, iSize)

Determining if Modified
This property allows the programmer to determine if the datasource has been modified.

Calling Convention
IsModified

Parameters
None

Return
Boolean IsModified If true, the interface is has been modified.

Optional
None

Privilege
Read-Only

Example
Det.Open "Det1"
Det.Param(CAM_F_ECALTOL) = 1.2
If (Det.IsModified) Then Det.Save(”Det1.cnf”)

154
 DeviceAccess

Status Severity
All status messages have a severity associated with them. This severity defines whether a
message is a warning message or an error message. There are two properties that may be
used to determine the severity of a message.

Calling Convention
IsWarning(MessageCodes Code)
IsError(MessageCodes Code)

Parameters
MessageCodes Status The status code to examine for severity level.

Return
Boolean bVal A value of true indicates that the message is of that speci-
fied severity level.

Optional
None

Example
On Error Resume Next
Det.Connect “Det1”
If (Det.IsError(Err.Number)) Then …

Retrieving Status Messages

This property returns the status message text defined by the status code.

Calling Convention
Message text

Parameters
MessageCodes Code The message code to retrieve the status string.

Return
String Message String for the status

Optional
None

Privilege
Read-Only

155
Component Programming Library Reference

Example
On Error Resume Next
Det.Connect “Det1”
If (Det.IsError(Err.Number)) Then _
MsgBox Det.Message Err.Number, vbOkOnly

Properties
This property allows the programmer to set a number of properties that are not defined in
the interface.

Calling Convention
Properties

Parameters
VARIANT Name The name of the property.

Return
VARIANT Val The value of the property.

Optional
None

These properties are used to get or set the properties tabulated below.

Name Description Type Rights

AppName The component identifier or shell BSTR Read-Write
identifier that is used to filter the
processes that can access the
datasource.
NodeName The name of the computer that hosts BSTR Read-Write
the remote VDM.

High Voltage Control

This property groups all of the high voltage properties under one interface. These proper-
ties are tabulated below.

156
 DeviceAccess

Name Type Description

Address String Defines the NIM address of the HVPS
Serial Number String Defines the HVPS serial number
Type String Defines the type of HVPS
Voltage Single Defines the voltage
Range Variant Defines the maximum voltage level
On Boolean Turns on/off the HVPS
Attention Boolean Indicates HVPS needs attention
Online Boolean Indicates the device is online
Fault Boolean Indicates there is a hardware fault
Inhibit Boolean Indicates inhibit is active
InhibitLatchOn Boolean Indicates the inhibit latch is on
OverlatchOn Boolean Indicates over latch is on
Overload Boolean Indicates device is overloaded
VerificationFlag Long The verification flag for the device
IsBusy Boolean (Neutron only) True if the device is ramping HV

For detailed information, see the High Voltage Power Supply CAM Parameters on page
490.

Any parameters that can be written to spectroscopic devices may generate an error mes-
sage. The error message is used to inform you that the device is busy changing the hard-
ware settings to match the parameter value. Not all devices generate an error message; for
example manual control devices do not generate error messages. The error code that is
returned is PAS__DEVBUSY. This error code is actually a warning message.

Amplifier Control
This property groups all of the amplifier properties under one interface. These properties
are tabulated below.

Name Type Description

Address String Defines the NIM address of the amplifier
Serial Number String Defines the amplifier serial number
BaselineType String Defines the type of baseline restoration
Preamp String Defines the type of preamp
ShapingMode String Defines the shaping mode
Type String Define the type of amplifier

157
Component Programming Library Reference

DeadtimeType String Defines the type of deadtime

Gain Single Defines the gain
Gain1 Single Defines the hardware gain 1.
Gain2 Single Defines the hardware gain 2
Gain 3 Single Defines the hardware gain 3
TimeConstant Single Define the shaping time constant
AutoPoleZero Boolean Activates auto pole zero
ComplementInhibit Boolean Activates inhibit
DifferentialInput Boolean Indicates input is differentiated
MotorBusy Boolean Indicates that the fine gain motor is busy
PoleZeroBusy Boolean Indicates that device is busy doing pole zero
NegativePolarity Boolean Indicates polarity is negative
PileupReject Boolean Indicates to do pileup rejection
Online Boolean Indicates device is online
VerificationFlag Long The verification flag for the device

Any parameters that can be written to spectroscopic devices may generate an error mes-
sage. The error message is used to inform you that the device is busy changing the hard-
ware settings to match the parameter value. Not all devices generate an error message; for
example manual control devices do not generate error messages. The error code that is
returned is PAS__DEVBUSY. This error code is actually a warning message.

ADC Control
This property groups all of the ADC properties under one interface. These properties are
tabulated below.

Name Type Description

Address String Defines the NIM address of the ADC
Serial Number String Defines the ADC serial number
AcquisitionMode String Define the mode of acquisition
Type String Define the type of ADC
ConversionGain Long Defines the conversion gain
Offset Long Defines the offset
Interface Interfaces Defines the type of hardware interface
CoincidentMode CoincidentModes Defines the coincident mode
PeakDetectMode PeakDetectModes Define the type of peak detection

158
 DeviceAccess

Name Type Description

Signal Signals Defines the type of signal
TransferMode TransferModes Defines the type of transfer modes
LLD Single Defines the lower level discriminator
ULD Single Defines the upper level discriminator
StrobingTime Single Defines the strobe time
Threshold Single Defines the threshold
Zero Single Defines the zero value
AntiCoincidenceMode Boolean Indicates anti-coincidence is active
Online Boolean Indicates device is online
Range Variant Defines the range
VerificationFlag Long The verification flag for the device

Any parameters that can be written to spectroscopic devices may generate an error mes-
sage. The error message is used to inform you that the device is busy changing the hard-
ware settings to match the parameter value. Not all devices generate an error message; for
example manual control devices do not generate error messages. The error code that is
returned is PAS__DEVBUSY. This error code is actually a warning message.

DeviceAccess Events

Processing Asynchronous Message Events

Since this object is multi-threaded, errors/warnings need to be reported in an asynchron-
ous manner. Therefore, error events have been created to solve this problem. This event
may be caught by setting up a handling facility.

Calling Convention
AsynchronousMessages(ByVal Long Code, ByVal String Message)

Parameters
Long Code The error code which can be passed to the status handler
object (StatHdlr.dll)

String Message The error string

Processing Device Message Events

The device status needs to be reported in an asynchronous manner. This event may be
caught by setting up a handling callback.

159
Component Programming Library Reference

Calling Convention
DeviceMessages(ByVal Long Message, ByVal Long wParam, ByVal Long lParam)

Parameters
Long Message The message code. The message codes have been mapped
to the VB type known as DeviceMessages.

Long wParam The first parameter of information associated with the mes-
sage.

Long lParam The second parameter of information associated with the

message.

Neutron Messages
This section tabulates all of the advise messages which a neutron analyzer sends.

Message Description
aNeutronAcqStart Acquisition has been started
aNeutronAcqDone Acquisition is complete
aNeutronAcqClear Analyzer has been cleared
aNeutronAcqPause Acquisition has been paused
aNeutronAcqError Error has occurred
aNeutronAcqUpdate New acquisition data has been read from the
device
aNeutronAcqXfer Data is being transferred from analyzer to
computer
aNeutronAcqSave Data have been save to disk
aNeuntronAcqStop Analyzer has been stopped
aNeutronAcqStat Analyzer status has changed
aNeutonDevParam A setting has changed
aCamParamChange A CAM Parameter has changed
aNeutronDevTimer The neutron device timer has elapsed

All messages are defined in by the VB data type DeviceMessages. The message
NeutronAcqStat returns the status information through the lParam value. This status in-
formation meets the format described in “Determining Analyzer Status” on page 150.

160
 DeviceAccess

The error message NeutronAcqError contains the error code in the lParam value. The
stop message NeutronAcqStop contains a Boolean value in the wParam member. This
parameter indicates whether the device is in an error state; true indicates it is in an error
state. The reason for this design is because the analyzer automatically stops when an er-
ror occurs. The message NeutonDevParam is sent when a device parameter is changed.
The lParam associated with this parameter is the CAM parameter code of the parameter
that has changed. aCamParamChange is sent whenever any CAM parameter has been
modified; the wParam contains the CAM Class Code and the lParam defines the CAM
parameter code.

Spectroscopic Messages
Spectroscopic devices send two messages aAdvise and aCamParamChange. This mes-
sage contains the advise bit mask that defines the reason for the message. This bit mask is
sent in the lParam argument. The bit masks are defined by the VB type
AdviseMessageMasks. aCamParamChange is sent whenever any CAM parameter has
been modified; the wParam contains the CAM Class Code and the lParam defines the
CAM parameter code. The advise message masks are defined below.

Advise Mask Description

amDisplaySetting Display settings have changed
amExternalStart Acquisition has been started externally
amCalibrationChange A calibration parameter has changed
amAcquireStart Acquisition has been started
amAcquireDone Acquisition has been stopped
amDataChange Data has been changes (occurs after
AcquireClear)
amHardwareError Hardware error
amHardwareChange Hardware setting has changed
amHardwareAttention Hardware is requesting attention
amDeviceUpdate Device settings have been updated
amSampleChangerSet Sample changer set
amSampleChangeAdvance Sample changer advanced

Examples
In this example the software is triggering on the acquire stop event for a spectroscopic
device. When the acquire stop event occurs the Start button is enabled

161
Component Programming Library Reference

Private Sub DeviceAccess2_DeviceMessages(ByVal Message As Long, ByVal

wParam As Long, ByVal lParam As Long)
Dim Msg As DeviceMessages
Dim Mask As AdviseMessageMasks
‘Handle data updates
Mask = amAcquireDone
If (Message = aAdvise) and ((lParam And Mask) = Mask) Then
‘Enable the start button
StartButton.Enable = True
End If
End Sub

CAM Datasource
The CAM DataSource component is designed provide and interface that makes data ac-
cess to CAM devices and files easy.

This library is responsible for performing the following services:

• Access CAM information stored in a file or device

• Device control
• Perform simple computations and evaluations using the data source.

This component may be added to a VB project by selecting “Project”-“References” then

in the References dialog select “Canberra CAM Datasource Library”. No icon will
appear on your form. You may access this library by dimensioning a new variable as one
of the following interfaces defined in the component library.

CAM Datasource Data Types

CAM Datasource defines the following enumeration types:

Array Of Parameters
There will be an enumeration, defined by the name ArrayOptions, which will be used to
define options that are used for the ArrayOfParameters property. The enumeration de-
scription is given below.

162
 CAM Datasource

Name Description
camAutoIncrementRecord Automatically increments the
record number
camAutoIncrementEntry Automatically increments the
entry number

Evaluation Options
There will be an enumeration, defined by the name EvaluateOptions, which will be used
to define evaluation options. The enumeration description is given below.

Name Description
camEnergy2Channel Energy to channel conversion
camChannel2Energy Channel to energy conversion
camChannel2Efficiency Channel to efficiency conversion using the
default efficiency curve
camChannel2FWHM Channel to FWHM conversion
camChannel2LowTail Channel to low energy tail conversion
camChannel2Resolution Channel to detector resolution
camRoiInformation ROI quantification information (FWHM, Area,
ect.)
camMDAPreset Count to MDA preset value
camAreaPreset Count to Certificate defined peak areas
CamEnergy2FWHM Computes FWHM based on energy

Delete Options
There will be an enumeration, defined by the name DeleteOptions, which will be used to
define delete options. The enumeration description is given below.

Name Description
camDeleteRecord Delete a record
camDeleteEntry Delete an entry
camDeleteBlock Delete a parameter class or block

163
Component Programming Library Reference

Open Options
There will be an enumeration, defined by the name OpenOptions, which will be used to
define open options. The enumeration description is given below.

Name Description
camReadOnly Open read-only
camReadWrite Open read-write
camDirectAccess Open by passing the VDM
camDeviceContinue Open a device that is acquiring and continue. Must be
OR’d with camReadOnly or camReadWrite
camDeviceTakeControl Take over control of a device in use. Must be OR’d with
camReadOnly or camReadWrite. (For internal Use only)
camDeviceTakeOver Take over control of a device that was started on this
client but VDM no longer is controlling. Must be OR’d
with camReadOnly or camReadWrite. (For internal Use
only)
camNoVerifyLicense Do not verify the license. Must be OR’d with
camReadOnly or camReadWrite.
camCreate Create the datasource (File only)
camOverWrite Overwrite the datasource on create. Must be OR’d with
camCreate.
camLargeHeader Create a large directory block on create. Must be OR’d
with camCreate

Close Options
There will be an enumeration, defined by the name CloseOptions, which will be used to
define close options. The enumeration description is given below.

Name Description
camUpdate Flush all changes to the datasource before
close
camNoUpdate Close but do not save changes
camDelete Close and delete the datasource (File only)

164
 CAM Datasource

Datasource Types
There will be an enumeration, defined by the name SourceTypes, which will be used to
define the types of datasources. The enumeration description is given below.

Name Description
camSpectroscopyDetector Spectroscopy detector
camFile File

Device Commands
There will be an enumeration, defined by the name DeviceCommands, which will be
used to define the types of device commands. The enumeration description is given be-
low.

Name Description
camStart Start acquisition
camAbort Abort acquisition
camStop Stop acquisition
camMove Move sample changer
camClear Clear data
camReset Power reset
camReverify Reverify settings
camHome Sample changer home position
camLoad Sample changer load
camUnload Sample changer unload
camPassThru ??
camSpecials ??
camFileFlush Call SadFlush
camAcknowledge Call SadAckRequest.
camClearDone Call SadClearDone.
camAcceptErr Call SadAcceptOpenError.
camPassToCAM Passes data calls to file I/O routines
(i.e.PCAM.DLL)

165
Component Programming Library Reference

Search Record Options

There will be an enumeration, defined by the name FindOptions, which will be used to
define the search options. The enumeration description is given below.

Name Description
camByNuclideLine Search for a nuclide line
camByPeak Search for a peak
camByHistory Search for a date
camByNuclideName Search for a nuclide name

Datasource Messages
There will be an enumeration, defined by the name SourceMessageMasks, which will be
used to define the datasource message bit masks. The enumeration description is given
below.

Name Description
camDisplaySetting Display setting has changed
camExternalStart Certain detectors can be started with an ‘arm’
flag, to ask it to wait for an external (hardware)
event. The PCA-3 is one; the ‘new AIM’ is
another. In the ‘armed’ state, when the
preset-checker thread sees ‘started’ at the
detector, it does a ‘set dirty’ using this bit.
(_ExtStart would be a better name, as
implemented.)
camExternalStartParam MCS external advance parameter,
camExternalStartParam,
CAM_L_MCSCEXTADV, changed.
camCalibrationParamChange Calibration parameters changed
camAcquireStart Acquisition started
camAcquisitionParam Acquisition parameter changed
camSampleParamChange Sample information changed
camAnalysisParamChange Analysis parameter changed
camDataChange Spectrum changed

166
 CAM Datasource

Name Description
camAcquireDone Acquisition done
camHardwareError Hardware error
camHardwareChange Hardware settings changed
camHardwareAttention Attention light on hardware active
camDeviceUpdate Device updated
camSampleChangerSet Sample changer set
camSampleChangerAdvance Sample changer advanced
camAnotherUserOpened Another users has opened this device for control
camSuspectEnergyCal Energy calibration suspect (not used)

Preset Options
There will be an enumeration, defined by the name PresetOptions, which will be used to
define the preset options. The enumeration description is given below.

Name Description
camCountNormal Norrmal count
camCountToLiveTime Count till live time met
camCountToRealTime Count till real time met
camCountToTotal Count total counts met
camCountToLevel Count to a level
camCountToSweep Count to sweep
camCountToArea Count till area met

Information Types
There will be an enumeration, defined by the name InformationTypes, which will be used
to define type of information to get from the datasource. The enumeration description is
given below.

167
Component Programming Library Reference

Name Description
camServerType Type of VDM
camProperties Datasource properties
camCurrentMemoryGroup Current memory group
camCountMemory Row count
camName Name of the datasource
camFullName Fullname of the datasource
camWeighVDM The weight VDM
camDSType The datasource type
camIsOpen Whether datasource is open
camHandle The access handle
camOpenOptions The open options
camNodeName Computer name for the remote VDM in use

Datasource Properties
There will be an enumeration, defined by the name DatasourceProperty, which will be
used to define type of property information to get from the datasource. The enumeration
description is given below.

Name Description
camPropertyCounter Datasource is a counter
camPropertyNotVerified The Open was performed without the Verify bit
set.
camPropertyReadAccess Opened with read-only access
camPropertyWriteAccess Opened with read-write access
camPropertyControl Opened with control access
camPropertyNativeFile Datasource is a file
camPropertyFraction This (hardware) datasource is defined with
memory groups.
camPropertyVfyFatal This is used internally by SadOpen to do an
immediate Close.

168
 CAM Datasource

Name Description
camPropertyVfyMajor This (detector) saw a ‘major verify’ at Open - the
only functions allowed are Close and (whatever it
takes to do) the MVC-status screen.
camPropertyVfyMinor This (detector) saw a ‘minor verify’ at Open - the
status box will turn ‘red’ but all functions will be
permitted.
camPropertyNoSpectrum Datasource does not have a spectrum. This file
has no PHA class (2005) - CAM_L_CHANNELS
is 0.
camPropertyInputOfMXR This detector is defined as one input of a
Mixer/Router.
camPropertyNewAIM The AIM which was opened is a ‘new’ one -
some new features are available. The DSA-2000
is a ‘new AIM’.
camPropertyNewAIM_2 The open detector is using the second ADC of a
‘new’ AIM.
camPropertyDesktopDSP The open detector is a DSA-2000 - it has some
‘special properties’ including: If we’re looking at
0xC000 then we’re looking at an MCS (a
multi-channel scaler device). That is: If the
DSA-2000 def’n has a ‘second half’ then it can
only be used to do MCS operations.

Device Status
There will be an enumeration, defined by the name DeviceStatus, which will be used to
define results from the status property in the device interface. The enumeration descrip-
tion is given below.

Name Description
camStatusExternalWait A start-external has been issued to the detector; the
preset-checker thread is waiting for the external
event. Or the datasource has been Opened by a
client. This has no meaning to the client - so that bit
position was re-used for the ExternalWait state.
camStatusIdle Set by a call to SadClearDone(); cleared by Start.
ClearDone() also clears _Done, _Stop, _Stopped
and _Reached. (The intent is/was to mean:
Start-time is not well-defined.)

169
Component Programming Library Reference

Name Description
camStatusBusy A Start has been issued or the detector is acquiring.
camStatusDone The preset-checker recognized “no longer busy”.
camStatusUpdate A write- or a control-command has been issued to
the datasource since Open or Save. This is also set
by an open-with-verify or if another opener has
been updated since Save. This is the only
documented bit that has meaning for files.
camStatusStop A ‘stop acquire’ command was issued.
camStatusStopped The preset-checker saw ‘done’ when _Stop was
set.
camStatusPreReached The preset-checker saw ‘done’ when _Stop was
NOT set.
camStatusLocked While the get/put-block sequences for ClassCopy
and SaveAs are underway PCAM needs to have
both files locked. This flag is used by the VDM to
make sure the files get properly unlocked at the end
of the sequence.
camStatusTemp This is set by the create of a file with name=”“. The
file will be deleted at close.
camStatusBumped A sample-changer advance was issued to the
detector and the status-checker has not yet seen
‘ready’.
camStatusSoftTime Certain MXR configurations (589-AMX?) have no
on-board timers. All preset-reached code needs to
be done at the VDM level; this flags that condition
to the preset-checker.
camStatusLockHardware While the get/put-block sequences for ClassCopy
and SaveAs are underway, PCAM needs to have
both files locked. This flag is used by the VDM to
make sure the files get properly unlocked at the end
of the sequence.
camStatusSoftBusy The only occurrence of this flag is commented out.
It was my intent to do the _SoftTime code in a
higher-priority thread, and I expected to use this
flag there.
camStatusError Error

170
 CAM Datasource

Clone Options
There will be an enumeration, defined by the name CloneOptions, which will be used to
define the clone options. The enumeration description is given below.

Name Description
camCloneOpen An interface is created and the datasource is
reopened
camCloneNoOpen An interface is created but no datasource is
opened.

VDM Types
There will be an enumeration, defined by the name VDMTypes, which will be used to
define the type of VDM. The enumeration description is given below.

Name Description
camDeviceOnly Supports devices only
camFileOnly Supports files only
camBoth Supports both files and devices

Error Codes
There will be an enumeration, defined by the name CamSrcErrorCodes, which will be
used to define the error codes that are generated by this component library.

Structure Types
There will be an enumeration, defined by the name StructureTypes, which will be used to
define the different types of C structures that may be accessed via the Structure property.
The enumeration description is given below.

Structure Description
camStructEnergyCalEq Structure type definition G_EcalEq_S
camStructFwhmEq Structure type definition G_FwhmEq_T

171
Component Programming Library Reference

Structure Description
camStructHiTail Structure type definition G_TailEq_T
camStructLoTail Structure type definition G_TailEq_T
camStructSearch Structure type definition G_CommonPS_T
camStructPeakPS Structure type definition G_PeakPS_T
camStructPAResults Structure type definition PAResults_T
camStructARResults Structure type definition ARResults_T
camStructPlusROI Structure definition struct G_ExDispROI_S
camStructDispROI Structure definition struct G_DispROI_S
camStructCommonPA Structure type definition G_CommonPA_T
camStructSample Structure definition struct G_Elapse_S
camStructEnergyCal Structure type definition G_Cal_T
camStructShapeCal Structure type definition G_SC_T
camStructEFEntry Structure type definition stEFEntry_T
camStructCtfRec Structure type definition stCtfRec_T
camStructEfDual Structure type definition stEfDual_T
camStructEfLinear Structure type definition stEfLinear_T
camStructEfEmp Structure type definition stEfEmp_T
camStructECalSetup Structure type definition EcalSetup_T
camStructAcqPage Structure type definition AcqPage_T
camStructAcqPageX Structure type definition AcqPageX_T
camStructSamplePage Structure type definition SamplePage_T
camStructEcalAll Structure type definition EcalAll_T
camStructSpecialPks Structure type definition SpecialPeak_T
camStructSampleDesc Structure type definition SampleDesc_T
camStructSetPreset Structure type definition Preset_T
camStructNCLNuclide Structure type definition Nuclide_T
camStructNCLLine Structure type definition NucLine_T
camStructNCLMpc Structure type definition NCLMpc_T
camStructNCLMore Structure type definition NucMore_T
camStructNCLEngU Structure type definition NCLEngU_T

172
 CAM Datasource

Structure Description
camStructNCLUnits Structure type definition NCLUnits_T
camStructNCLMpcCF Structure type definition NCLMpcCF_T
camStructPSNid Structure type definition G_PSNid_T
camStructPSMda Structure type definition G_PSMda_T
camStructProcNid Structure type definition G_ProcNid_T
camStructNLNid Structure type definition G_NLNid_T
camStructUtlEnergyCalEq Structure type definition stEncalEq_T
(Read-Only)
CamStructUtlFwhmCalEq Structure type definition stEncalEq_T
(Read-Only)
camStructUtlLowTailCalEq Structure type definition stEncalEq_T
(Read-Only)

Parameter Codes
There will be an enumeration, defined by the name ParamCodes, which will be used to
define parameter codes which are used to identify the parameter to retrieve.

Class Codes
There will be an enumeration, defined by the name ClassCodes, which will be used to de-
fine parameter blocks/classes which parameters belong to.

Conversion Options
There will be an enumeration, defined by the name ConversionOptions, which will be
used to define the type of conversion to perform using the IParameter.Convert method.

Name Description
camConvert2CAM Converts the value into a CAM parameter value
camConvert2Variant Converts the CAM parameter value into a Variant type

Analysis Options
There will be an enumeration, defined by the name AnalyzeOptions, which will be used
to define the analysis options using the IEvaluate.Analyze method.

173
Component Programming Library Reference

Name Description
camSyncAnalysis Analysis is performed synchronously (method is
blocking)
camAsyncAnalysis Analysis is performed asynchronously (method is
non-blocking)
camAlphaAnalysis Alpha analysis is performed
camReportOnlyAnalysis Report sections are executed only
camNoReportAnalysis No report sections are executed

Input Device Types

There will be an enumeration, defined by the name InputDeviceTypes, which will be
used to define the possible input device types that are supported by spectroscopic
datasources.

Name Description
camInpMCA Multi-Channel Analyzer
camInpADC ADC
camInpMultiplexer Multiplexer
camInpStabilizer Stabilizer
camInpSampleChanger Sample Changer
camInpAmplifier Amplifier
camInpHVPS High voltage power supply
camInpPreamp Preamp
camInpLFC Loss Free Counting
camInpMCS MCS
camInpProtocol Protocol
camInpPowerMgmnt Power Management
camInpVacuum Vacuum
camInpGain Gain
camInpFilter Filter
camInpPulser Pulser

174
 CAM Datasource

Input Device Status

There will be an enumeration, defined by the name InputDeviceStatus, which will be
used to define the possible input device status.

Name Description
camInpCtlPowerReset The device driver told the status-checker that it
detected a reset condition. Parameter settings
probably changed. A call to ControlDSC(
CTL_PowerReset ) for that device is in order.
That device will get (pretty much the equivalent
of) a ReVerify.
camInpCtlHardwareFail The device driver responded with this bit to the
‘read control status’ command.
camInpCtlRequest The device told the status-checker ‘attention
required’. The Gamma Analyst (at least) uses
this.
camInpVfyHardwareFail This is the logical OR of a) a specific error
returned from a parameter read issued to the
driver at verify time, and b) a
camInpCtlHardwareFail from a ControlStatus
read.
camInpVfySoftwareFail Pretty much any error from any Read or Write
call to the driver sets this bit.
camInpVfyModel The device-open code saw a _BadDevType error
return from the driver.
camInpVfySerial The serial number read from the device does not
match the one on file.
camInpVfyRead Comparing hardware to file, read-verify found a
difference. This can include parameters which
are read-only which are being looked at during
the write-verify operation.
camInpVfyWrite Writing to the hardware, at write-verify time, the
driver returned (specifically) a write-no-verify
error.

CAM Datasource Component Library

The CAM Datasource component library consists of several interfaces: ICamDatasource,
IDevice, IInputDevice, IInput, IEvaluate, IPreset, IParameter, and IParameters.

175
Component Programming Library Reference

CAM Datasource Interface

This section will discuss the ICamDatasource. This interface contains all of the methods
and properties that are common to hardware datasource.

This interface contains all of the properties and methods that are common to both hard-
ware datasource and files.

Opening a Datasource
The datasource is opened such that it may be opened multiple times in the same process.
To open the datasource within multiple processes, you must set the “SharedRW” prop-
erty in the .Properties method to true.

If you want to partition your process such that sections of the process can access the
datasource and others cannot then use the “AppName” property in the .Properties
method. This property will allow you to create a name that is associated with the
datasource. All processes that use this name can access the datasource.

Note You must specify the full path to files due to the S560 API.

Calling Convention)
long Open(BSTR Name, OpenOptions lOptions, SourceTypes Src)

long OpenEx(BSTR Name, OpenOptions lOptions, SourceTypes Src, VARIANT Args)

Parameters
BSTR bstrName The name of the datasource.

long lOptions (Optional) The open options.

SourceTypes Type (Optional) The type of datasource.

VARIANT Args (Optional) If opening a CAM File using the Create option
the Options will accept the following array:

array[0] = # number of channels to create (No. of elements

= 1)

If opening a detector it will accept following types of ar-

rays:

array[0] = Remote Computer Name (No of elements = 1)

Note: For remote VDM access the NCF file must be up-
dated to exclude the “local” keyword from the first entry.

176
 CAM Datasource

Optional
OpenOptions lOptions Value of camReadOnly.

SourceTypes Type Value of camFile.

VARIANT Args Value of 0

Return
LONG Any warning generated during the open.

Example
Dim objDS As New CamDatasource
Dim objML As MessageList
Set objML = objDS.MessageList
lRC = objDS.Open(“c:\genie2k\camfiles\nbsstd.cnf”)
if (lRC 0) Then MsgBox objML.MessageString(lRC)
objDS.Close

‘Open with remote VDM on \\2350ENG

lRC = objDS.OpenEx(“DET01”, camReadWrite, camSpectroscopyDetector,
“2350ENG”)
if (lRC 0) Then MsgBox objML.MessageString(lRC)
objDS.Close

‘Open with remote VDM using NCF file

lRC = objDS.OpenEx(“DET01”, camReadWrite, camSpectroscopyDetector,
Array(“M”, 2))
if (lRC 0) Then MsgBox objML.MessageString(lRC)

Closing a Datasource
This method will close the datasource.

Calling Convention
Close(CloseOptions lOptions)

Parameters
CloseOptions The close options.

Optional
None

Example
Dim objDS As New CamDatasource
Dim objML As MessageList

177
Component Programming Library Reference

Set objML = objDS

lRC = objDS.Open(“c:\genie2k\camfiles\nbsstd.cnf”)
if (lRC 0) Then MsgBox objML.MessageString(lRC)
objDS.Close

Compressed Spectral Data or Scaled Data

This method will allow you to get compressed or scaled data.

Calling Convention
VARIANT ScaledSpectrum (long Start, long Stop, long VFS)

Parameters
long Start The start channel.

long End The end channel.

long VFS The vertical full scale range.

Valid Valus/Ranges are:

127: VFS_AutoLog

122: VFS_AutoLin

32: Log 256 K

31: Log 16 M

30: Log 4096 M

5: Linear 64

4: Linear 128

3: Linear 256

•
•
•

-20: Linear 2048 M

-21: Linear 4096 M

Optional
None

178
 CAM Datasource

Return
VARIANT The spectrum value.

Creating a Parameter Block

This method will allow you to create a parameter block (i.e., parameter class) in the
datasource.

Calling Convention
CreateBlock(LONG Class, long Size)

Parameters
LONG Class The parameter class/block to create

long Size The size of the parameter block. A value of –1 indicates that the
default size specified by the CAM schema will be used.

Optional
None

Example
objDS.CreateBlock spDS.ClassCode(CAM_L_CHANNELS)

Copying a Parameter Block

This method will allow you to copy a parameter block (i.e., parameter class) in the
datasource.

Calling Convention
CopyBlock(VARIANT Val, LONG lClass)

Parameters
VARIANT Val This can be a string name of a file, a data access object, a
device access object, or a CAM datasource object.

ClassCodes Class The parameter class/block to create

Optional
None

Example
objDS.CopyBlock
“c:\genie2k\camfiles\nbsstd.cnf2”,objDS.ClassCode[CAM_L_STITLE]

179
Component Programming Library Reference

Copying a Record
This method will allow you to copy a record to another record.

Calling Convention
CopyRecord(LONG lClass, long SourceRec, long DestRec, VARIANT_BOOL Delete,
VARIANT Dest)

Parameters
LONG lClass The parameter class/block to create

long SourceRec The source record

long DestRec The destination record

VARIANT_BOOL Delete If true, the source record is deleted after the copy is per-
formed.

VARIANT Dest This can be a string name of a file, a data access object, a
device access object, or a CAM datasource object.

Note CopyRecord actually inserts the record in the destination. Also, its not per-
forming any validation for similar existing record in the destination.

Optional
None

Example
objDS.CopyRecord CAM_CLS_PEAK, 1, 2, True, “c:\genie2k\camfiles\nbsstd.cnf2”

Finding a Record
This method will allow you to find a specific record.

Calling Convention
Find(FindOptions lOptions, VARIANT vSearchObject, long lStartRecord, long *plRec)

Parameters
FindOptions lOptions The find options

VARIANT vSearchObject The search parameters

long lStartRecord (Optional) Start record.

Optional
long lStartRecord Value of 1

180
 CAM Datasource

Return
LONG The found record

Note Number of arguments to SearchObject varies according to the FindOptions

Value.

FindOptions Expected SearchObject Arguments/ Parameters

CamByNuclideLine Energy (KeV), Tolerance (KeV)
CamByPeak Energy (KeV), Tolerance (KeV)
CamByHistory Energy (KeV), Tolerance (KeV)
CamByNuclideName Null terminated Nuclide name (max length = 9 char)

Example
Dim vArgs As Variant
Dim Rec As Long

vArgs(0) = 88.7
vArgs(1) = 1.2
Rec = objDS.Find(camByNuclideLine, vArgs)

Inserting Records or Entries

This method will allow you to insert a record or entry into a parameter block.

Calling Convention
Insert(LONG lClass, long lRec, long lEntry)

Parameters
LONG lClass The code identifying the class into which the record or entry is
inserted into.

long lRec The record number to use for the insert.

long lEntry (Optional) The entry number to use for the insert. A value of -1
indicates a record is performed.

Optional
long lEntry Value of -1

181
Component Programming Library Reference

Example
objDS.Insert(CAM_CLS_PEAK, 2)

Deleting Records, Entries or Parameter Blocks

This method will allow you to delete a record, entry or a parameter block.

Calling Convention
Delete(LONG lClass, long lRec, long lEntry, DeleteOptions Option)

Parameters
LONG lClass The code identifying the class into which the record, entry or
block is deleted.

long lRec The record number to use for the delete.

long lEntry (Optional) The entry number to use for the delete.

DeleteOptions Option (Optional) The delete options

Optional
long lEntry Value of 0

DeleteOptions Option Value of camDeleteRecord

Example
objDS.Delete(CAM_CLS_PEAK, 2)

Counting Records or Entries

This method will allow you to count records or entries in a parameter block.

Calling Convention
long Count(LONG lClass, long lRecord)

Parameters
LONG lClass The code identifying the class into which the record or entry is to
be counted or the CAM parameter to count the number of en-
tries.

long lRecord The record number to use for the entry count. A value of –1 indi-
cates a record count is performed. Cannot be –1 if counting num-
ber of entries.

Optional
None

182
 CAM Datasource

Return
Record Count Value of -1

Note User must have to provide a valid class code for which tabular entries are exist-
ing. If there are no tabular entries for given class code, it will endup with VDM
timeout.

Example
objDS.Count(CAM_CLS_PEAK)

Save As
This method will allow you to save the changes to a new file.

Note You must specify the full path to the file dues to the S560 API.

Calling Convention
Save(BSTR Name, VARIANT_BOOL vbOverWrite)

Parameters
BSTR Name The name of the new file.

VARIANT_BOOL OverWrite (Optional) If true and the file exists, it is overwritten.

Optional
VARIANT_BOOL OverWrite Value of 0

Example
objDS.Save(“c:\genie2k\camfiles\test.cnf”, True)

Creating a Connection to the Local VDM

This method will insure that the local VDM has been started. If a VDM is not already
running, this call will attempt to start one up. If a VDM is already running, this routine
does nothing.

Calling Convention
CreateLocalVdmConnection()

Parameters
None

Optional
None

183
Component Programming Library Reference

Note If the cam datasource has been marshaled across network boundaries (via
DCOM) then the VDM will be started where the cam datasource was originally
instantiated.

Most clients will not need to use this call since all lower level routines that require VDM
access already start the VDM when required.

Determining Datasource Information

This method will allow you to determine get information about the datasource: is open,
datasource type, type of vdm, datasource name, ect.

Calling Convention
VARIANT Information (InformationType Type)

Parameters
InformationType Type The type of information to get.

Optional
None

Return
VARIANT The information

Example
objDS.Open “DET1”, camReadOnly, camSpectroscopyDetector
if (objDS.Information(camDSType) = camSpectroscopyDetector) Then …

Cloning
This method will allow you to create a new instance of the datasource interface or create
a new instance with a new connection to the datasource.

Calling Convention
LPDISPATCH* Clone(CloneOptions Options)

STDMETHOD(Clone)([in] CloneOptions, [out, retval] LPDISPATCH *Return)

Parameters
CloneOptions Options What to clone.

Optional
None

184
 CAM Datasource

Return
LPDISPATCH * Return A pointer to the interface Example

Example
Set objDS2 = objDS.Clone

Accessing Parameters
This property will allow you to get or set a parameter or an array of parameters.

Calling Conventions
VARIANT Parameter (VARIANT Codes, LONG Record, LONG Entry)

Parameters
VARIANT Code This is an array of parameter codes or a single parameter code.
Parameter codes are defined by the ParamCode enumeration.

LONG Record (Optional) The record number.

LONG Entry (Optional) The entry number.

Optional
LONG Record Value of 1

LONG Entry Value of 1

Return
VARIANT The parameter or array of parameter values

Privilege
Read-Write

Example
Dim lChans As Long
Dim Params As Variant
lChans = objDS.Parameter(CAM_L_CHANNELS)
Params = objDS.Parameter(Array(CAM_L_CHANNELS, CAM_T_STITLE))

Parameters
CloneOptions Options What to clone.

Return
LPDISPATCH A pointer to the interface

185
Component Programming Library Reference

Example
Set objDS2 = objDS.Clone

Accessing Arrays of Parameters

These properties will allow you to get or set a parameter or array of parameters.

Calling Conventions
VARIANT ArrayOfParameters(LONG Code, long Num, ArrayOptions Options,
LONG Record, LONG Entry)

Parameters
LONG Code This single parameter code. Parameter codes are defined by the
ParamCode enumeration.

long lNum (Optional) The number of parameters to retrieve

ArrayOptions Options (Optional) Refer to CAM Datasource Data Types on page 162).

LONG Record (Optional) The record number.

LONG Entry (Optional) The entry number.

Optional
LONG Number Value of 1

ArrayOptions Option Value of camAutoIncrementRecord.

LONG Record Value of 1

LONG Entry Value of 1

Return
VARIANT The parameter or array of parameter values.

Privilege
Read-Write

Example
Dim Params As Variant
Params = objDS.ArrayOfParameters(CAM_L_RGNSTART, 2)

186
 CAM Datasource

ICamDatasource Properties
These properties are used to get or set the following properties:

Name Description Type Rights

StoreMessages Saves all datasource VARIANT_BOOL Read-Write
Windows messages in a list
to be polled at a later time
Message Gets a Windows message VARIANT. An array Read-Only
from the list of datasource of LONGs where
messages [0]: Message code
[1]: WPARAM
[2]: LPARAM
SpectrumAsSingle If TRUE, retrieval of spectra VARIANT_BOOL Read-Write
is as single precision.
Otherwise, it is as a
unsigned long.
SharedRW If TRUE, all opens will be VARIANT_BOOL Read-Write
such that the datasource
may be opened within other
processes.
AppName The component identifier or BSTR Read-Write
shell identifier that is used
to filter the processes that
can access the datasource.
By default this will be
“CamDatasource”.
GetErrorCode Get most recent error from LONG Read-Only
message list (index 0)

These properties return a Genie 2000 environment variable of the same. See the section
“Genie 2000 Environment Settings” of the Genie 2000 Operations Manual for details.

ADVISE_HOLD ASEQFILES CALFILES

CAMDB CAMFILES CIJOBHELP

CINETCFG DS_LOGON EXEFILES

GAMMAAEF GENIE2K GENIE2K_VERSION

187
Component Programming Library Reference

HDW_STATUS MCA$DEFINES MCA$DRIVERS

MVCPREFS OS2FCTSFILE PSET_DELAY

REPFILES RTPLFILES SAD_TIMEOUT

VDM$TEMPS

Calling Conventions
VARIANT Properties(VARIANT PropertyName)

Parameters
VARIANT PropertyName The property name.

Optional
None

Return
VARIANT The property value

Determining Modified State

These properties will allow you get or set the modified state of the datasource.

Calling Conventions
VARIANT_BOOL HasChanged ()

Parameters
None

Optional
None

Privilege
Read-Write

Example
if (objDS.HasChanged) Then objDS.Save camUpdate

Device Interface
This property will return an interface to access the hardware specific properties and
methods. If the datasource has not hardware then no interface is returned.

188
 CAM Datasource

Calling Convention
IDevice * Device()

Parameters
None

Optional
None

Return
IDevice * Device interface pointer

Privilege
Read-Only

Example
objDS.Device.Execute camClear

Preset Interface
This property will return an interface to access the preset. This interface can be used to
get or set the preset information. The preset is setup by Preset Interface.

Calling Conventions
IPreset* Preset()

Presets. This puts or gets defines the device presets

Parameters
None

Optional
None

Return
IPreset The preset interface

Privilege
Read-Write

Example
Dim objPreset As Preset
Set objPreset = objDS.Device.Preset

189
Component Programming Library Reference

objPreset.Time = 56
objPreset.Options = camCountToRealTime
Set objDS.Device.Preset = objPreset

Evaluate Interface
This property will return an interface to IEvaluate interface. This interface can be used to
evaluated calibrations, ROI information, etc.

Calling Convention
IEvaluate* Evaluate ()

Parameters
None

Optional
None

Return
IEvaluate * The Evaluate Interface Pointer.

Privilege
Read-Only

Example
Energy = objDS.Evaluate.Evaluate(camEnergy2Channel, 56)

Error Handling using the Message List Interface

This property will allow you to get or set the message list to which will be used to store
error messages. These properties will allow you to shared message lists between compo-
nents in an application.

Calling Conventions
LPUNKNOWN MessageList ()

Parameters
None

Optional
None

190
 CAM Datasource

Return
IMessageList * The interface.

Privilege
Read-Write

Example
OnError Resume Next
Energy = objDS.Evaluate.Evaluate(camEnergy2Channel, 56)

If (Err.Error 0) Then
Dim objInfo As MessageInfo

For Each objInfo In objDS.MessageList

MsgBox objInfo.Description
Next
EndIf

Acquisition Completion Time

This property will return the time at which the acquisition is expected to complete based
on the current time and the current elapsed live and real times.

Calling Convention
VARIANT CompletionTime ()

Parameters
None

Optional
None

Return
VARIANT Expected completion date as VT_DATE

Privilege
Read-Only

Setting or Getting Spectrum

This properity will allow you to get or set the spectral data.

Calling Conventions
VARIANT Spectrum(long lStart, long lStop)

191
Component Programming Library Reference

GetSpectrum. This returns the spectrum

PutSpectrum. This sets the spectrum

Parameters
long lStart The start channel.

long lStop The end channel. A value of –1 indicates that the last channel
will be used.

Optional
long lStart Value of 1

long lStop Value of -1

Return
VARIANT The spectrum

Privilege
Read-Write

Example
Dim Data As Variant
Data = objDS.Spectrum

CAM Datasource Events

Any datasource that uses the VDM will automatically receive information about
datasource state changes through the _ICamDatasourceEvents or
_ICamDataasourceEventVt interface.

The _ICamDatasourceEvents will be a dispinterface that should be used by scripting lan-

guages such as VBScript or JavaScript. Scripting languages are late binding. Therefore,
in order to communicate with the event interface a late binding interface will need to be
created.

The _ICamDatasourceEventsVt will be a custom COM interface that should be used by

any environment that supports this type of interface. Since the interface is custom it in-
herits from IUnknown. This interface should be used over the previous interface because
there is less overhead in using it.

The properties and methods for both interfaces are the same and are discussed below.

192
 CAM Datasource

Datasource Messages
This event will be fired for any asynchronous data retrieval call.

Calling Convention
HRESULT DataSourceMessages(long Message, long wParam, long lParam)

Parameters
LONG Message The device message.

LONG wParam The WPARAM associated with the message

LONG lParam The LPARAM associated with the message.

Spectroscopic devices return the SourceMessageMasks bit mask
enumeration through this parameter.

Property Change Event

This is reserved for future used.

Calling Convention
HRESULT PropertChange(VARIANT Name, VARIANT Val)

Parameters
VARIANT Name The property name

VARIANT Val The property value

Device Interface
This section will discuss the IDevice. This interface contains all of the methods and prop-
erties that are common to hardware datasource.

Executing Commands
This method executes a device command.

Calling Convention
ExecuteCommand(DeviceCommands Command)

Parameters
DeviceCommands The command to send.

Optional
None

193
Component Programming Library Reference

Returns
HRESULT The return status.

Clearing Open Errors

This method will clear any warnings that were returned from the .Open or .OpenEx
methods. These are verification warnings that are returned on datasource open. This will
change the LED on a NIM from yellow to green.

Calling Convention
ClearError()

Parameters
None

Optional
None

Example
Dim objDS As New CamDatasource
Dim objML As MessageList

Set objML = objDS

lRC = objDS.Open(“c:\genie2k\camfiles\nbsstd.cnf”)
if (lRC < > 0) Then objDS.Device.ClearErrors

Verifying Hardware Settings

This method will allow you to verify that the hardware setting match you input definition
file settings. This will write the MID file settings to the hardware and verify that the de-
vice and files values match.

Calling Convention
Long Verify()

Parameters
None

Optional
None

Return
long Verification results

194
 CAM Datasource

Status
This property will allow you to get the status of the hardware.

Calling Convention
VARIANT Status(VARIANT_BOOL StatusOnly)

Parameters
VARIANT_BOOL StatusOnly (Optional) Indicates whether status is the only return
value.

Optional
VARIANT_BOOL StatusOnly Value of -1

Return
VARIANT If StatusOnly is true, the DeviceStatus enumeration
value is returned. Otherwise, the DeviceStatus enu-
meration is returned in array index 0 and the currently
acquiring memory group number is returned in array
index 1.

Privilege
Read-Only

Example
If (camStatusBusy And objDS.Device.Status) Then …

Memory Groups
These properties allow you to get or set the current memory group to use.

Calling Conventions
MemoryGroup()

Parameters
None

Optional
None

Return
long The menory group

195
Component Programming Library Reference

Privilege
Read-Write

Example
Mem = objDS.Device.MemoryGroup

Preset Interface
This property will return an interface to access the preset. This interface can be used to
get or set the preset information. The preset is setup by the preset interface.

Calling Conventions
Preset()

Parameters
None

Optional
None

Return
IPreset The preset interface.

Privilege
Read-Write

Example
Dim objPreset As Preset
Set objPreset = objDS.Device.Preset
objPreset.Time = 56
objPreset.Options = camCountToRealTime
Set objDS.Device.Preset = objPreset

Input Device Collection

This property will return an interface to access the collection of supported input devices.
See “Input Device Collection Interface” on page 201 for details.

Calling Convention
IInputs *Inputs()

196
 CAM Datasource

Parameters
None

Optional
None

Return
IInputs* Input interface pointer

Privilege
Read-Only

Example
Dim obInputs As Inputs
Set objInputs = objDS.Device.Inputs
MsgBox “Number of supported input devices: “ & objInputs.Count

Datasource
This property will allow you to set or get a pointer to the CamDatasource interface.

Calling Convention
Datasource ()

Parameters
None

Optional
None

Return
IUnknown CamDatasource Interface pointer

Privilege
Read-Write

Properties
This property allows for future expansion of the property list.

Calling Convention
VARIANT Properties(VARIANT PropertyName)

197
Component Programming Library Reference

Parameters
VARIANT PropertyName The property name.

Optional
None

Return
VARIANT The property value.

Privelege
Read-Write

Input Interface
This section will discuss the IInputDevice. This interface defines all of the properties as-
sociate with an input device.

Name
This property will return the name of the input device.

Calling Convention
BSTR Name()

Parameters
None

Optional
None

Return
BSTR The device name.

Privilege
Read-Only

Status
This property will return the status of the input device, see “Input Device Status” on page
175.

Calling Convention
InputDeviceStatus Status ()

198
 CAM Datasource

Parameters
None

Optional
None

Return
InputDeviceStatus Input device status

Privilege
Read-Only

Verification of Input Device

This property will return the verification status of the input device.

Calling Conventions
long Verification ()

Parameters
None

Optional
None

Return
PVal- (long, output) The longword of verification status bits as returned from
SadQueryDevice. Note the definition of the bits depends on the
device type and how the driver is returning the bits. Typically
the caller will only be interested in seeing if any bit is set (indi-
cating there was a verification failure of some type). Since some
devices have parameters that may fail verification but are not
specifically written (such as HVPS inhibit) the client would call
this routine to see if there was an error.

Privilege
Read-Only

Programmable Device
This property will return TRUE if this input device is programmable.

Calling Convention
VARIANT_BOOL Programmable ()

199
Component Programming Library Reference

Parameters
None

Optional
None

Return
VARIANT_BOOL TRUE or FALSE.

Privilege
Read-Only

Type
This propert will return an input device type.

Calling Convention
InputDeviceTypes Type ()

Parameters
None

Optional
None

Return
InputDeviceTypes The input device type.

Privilege
Read-Write

Source
This propert will return an interface to the associated datasource, ICamDatasource.

Calling Convention
LPUNKNOWN Source ()

Parameters
None

Optional
None

200
 CAM Datasource

Return
LPUNKNOWN The datasource interface.

Privilege
Read-Only

Supported Parameter
This property will return an interface to the parameters that are supported by this inter-
face. This is a collection of parameters, see “Parameters Interface” on page 213.

Calling Convention
IParameters* Parameters()

Parameters
None

Return
IParameters* The parameters interface

Privelege
Read-Only

Properties
This property allows for future expansion of the property list.

Calling Convention
VARIANT Properties(VARIANT PropertyName)

Parameters
VARIANT PropertyName The property name

Return
VARIANT The property value.

Privelege
Read-Write

Input Device Collection Interface

This section will discuss the IInput. This interface is a collection of all of the input de-
vices that are supported by this interface.

201
Component Programming Library Reference

Count
This property will return the number of input devices this datasource supports.

Calling Convention
LONG Count()

Parameters
None

Return
LONG The number of input collection devices.

Privilege
Read-Only

Item
This property will return the input device interface associate with this index value. See
“Input Device Interface” on page 198 for details about the IInputDevice interface.

Calling Conventions
IInputDevice* Item(LONG Index)

Parameters
LONG The index number. Starts at 0 and ends at Count-1.

Return
IInputDevice The associate input device interface.

Privilege
Read-Only

Find
This method will return a specific input device interface that may not be supported by
this device. If it is not supported by this datasource, the return value is NULL.

Calling Convention
IInputDevice* Find (InputDeviceTypes Type)

Parameters
InputDeviceTypes The device type

202
 CAM Datasource

Return
IInputDevice * The associate input device interface

Privilege
Read-Only

Source
This method will return an interface to the associated datasource, ICamDatasource.

Calling Convention
LPUNKNOWN Source()

Parameters
None

Return
LPUNKNOWN *Val The datasource interface.

Privilege
Read-Write

Status of All Devices

This method will return an enumeration of all of the supported input devices.

Calling Convention
VARIANT_BOOL CheckStatus(InputDeviceTypes *peType)

Parameters
InputDeviceTypes *peType The first device with a status bit set.

Return
VARIANT_BOOL True if one device has a non-zero status.

Privilege
Read-Only

Example
This section will provide examples of how to use this interface based on the discussions
in the previous sections

Dim objInput As InputDevice

203
Component Programming Library Reference

For Each objInput In objDS.Device.Inputs

MsgBox objInput.Name

Next

Verification of All Devices

Checks the verification status of all input devices. If it sees any bits set return value is set
to TRUE. This routine is typically used with the CheckStatus routine above.

Calling Convention
VARIANT_BOOL CheckVerification (InputDeviceTypes *peType)

Parameters
InputDeviceTypes *peType The first device with a status bit set

Return
VARIANT_BOOL *pvbRet The status of the call

Privilege
Read-Only

Properties
This property allows for future expansion of the property list.

Calling Convention
VARIANT Properties(VARIANT PropertyName)

Parameters
VARIANT PropertyName The property name.

Optional
None

Return
VARIANT *Val The property value.

Privilege
Read-Write

204
 CAM Datasource

Evaluate Interface
This section will discuss the IEvaluate. This interface contains all of the properties and
methods that are common to evaluating the datasource.

Calling a Genie-2k Engine

These methods allow a client to call a Genie-2k engine directly.

Calls a Genie-2k analysis engine. Does not return the arguments from the function call
but always adds status information to the message list if they are non-zero.

Calling Convention
CallEngine (BSTR EngineName, VARIANT_BOOL vbAlphaAEF)

Parameters
EngineName BSTR the generic (language independent) name of the engine
for a particular phase (input).

vbAlphaAEF VARIANT_BOOL if true use Alpha AEF file

Optional
None

Extension of CallEngine to allow the client to receive the contents of the lVal pointers
from the engine. The client can then add them to the message list or process them di-
rectly.

Calling Convention
CallEngineEx (BSTR EngineName, VARIANT_BOOL vbAlphaAEF, long *lVal1, long
*lVal2, VARIANT_BOOL vbLogWarnings)

Parameters
EngineName BSTR the generic (language independent) name of the engine
for a particular phase (input).

VbAlphaAEF VARIANT_BOOL if true use Alpha AEF file (input).

lVal1 - long * The first output from the engine.

lVal2 - long * The second output from the engine.

vbLogWarnings VARIANT_BOOL if true, log non-zero lRet warnings from the

engine

Optional
None

205
Component Programming Library Reference

Evaluations
This method will allow you to evaluate a calibration point or compute ROI information.

Calling Convention
VARIANT Evaluate(EvaluationOptions,VARIANT Parameters)

Parameters
EvaluationOptions What to evaluate.

VARIANT Parameters Parameters need for evalution. See the table below

The table below outlines the various returns data types, input arguments, and documents
associated with each computation.

Name Parameter
CamEnergy2Channel Energy
Arg [0] : Channel Efficiency Value
CamChannel2Energy Channel
Arg [0] : Energy Value
CamChannel2Efficiency Channel
Arg [0] : Efficiency Value
Arg [1] : Efficiency Error
CamEnergy2FWHM Energy
Arg [0] : FWHM Value
camChannel2FWHM Channel
Arg [0] : Channel Value
camChannel2LowTail Channel
Arg [0] : LowTail Value
camChannel2Resolution Arg[0]: Peak width in channels
Arg[1]: Peak centroid in channels

206
 CAM Datasource

Name Parameter
camRoiInformation Arg[0]: Left ROI
Arg[1]: Right ROI
Arg[2]: Number of background Channels
Arg[3]: Number of Standard Deviations
Arg[4]: Boolean indicating values are in energy
Return Value is an Array of
Val[0]: Integral
Val[1]: Area
Val[2]: Area Unc
Val[3]: Gaussian Ratio
Val[4]: Centroid
Val[5]: FWHM
Val[6]: FWTM
camMDAPreset Arg[0]: Required MDA (Optional)
Arg[1,,,N]: Nuclide Names (Optional)
Return Val may be an Array of
Val[0]: Preset Time
Val[1,…N]: Nuclides not found
camAreaPreset Arg: Required area
Return Val may be an Array of
Val[0]: Preset Time
Val[1,…N]: Nuclides not found

Optional
None

Return
VARIANT

Example
Energy = objDS.Evaluate.Evaluate(camEnergy2Channel, 56)

Analysis
This method will allow you to execute an analysis sequence on this datasource. Refer to
“Analysis Options” on page 173 for details of analysis.

Calling Convention
long Analyze (AnalyzeOptions Options, VARIANT Skip2Steps, BSTR SequenceFile,
BSTR ReportFile)

207
Component Programming Library Reference

Parameters
AnalyzeOptions The analysis options

VARIANT Skip2Steps An array of longs indicating which steps to skip. Step num-
bers start at index value of 1 (option base 1).

SequenceFile The analysis sequence file name.

ReportFile The name of the output file for template reports.

Optional
None

Return
long The last step that was executed

Example
LastStep = objDS.Evaluate.Analyze(camSyncAnalysis, , “peakloc.asf”)

Abort
This method will allow you to abort an analysis that has been executed asynchronously.

Calling Convention
Abort()

Parameters
None

Optional
None

Example
Dim objEval As Evaluate

Set objEval = objDS.Evaluate

LastStep = objEval.Analyze(camAsyncAnalysis, , “peakloc.asf”)
objEval.Abort

Datasource
This property will allow you to set or get a pointer to the CamDatasource interface.

208
 CAM Datasource

Calling Convention
IUknown* Datasource ()

Parameters
None

Optional
None

Return
IUnknown* CamDatasource Interface pointer

Privilege
Read-Write

Properties
This property allows for future expansion of the property list.

Calling Convention
VARIANT Properties(VARIANT PropertyName)

Parameters
VARIANT PropertyName The property name

Optional
None

Return
VARIANT The property value.

Privilege
Read-Write

Evaluate Events
Any evaluation interface supports the following event interfaces: _IEvaluateEvents or
_IEvaluateEventVt interface.

The _ IEvaluateEvents will be a dispinterface that should be used by scripting languages

such as VBScript or JavaScript. Scripting languages are late binding. Therefore, in order
to communicate with the event interface a late binding interface will need to be created.

209
Component Programming Library Reference

The _ IEvaluateEventsVt will be a custom COM interface that should be used by any en-
vironment that supports this type of interface. Since the interface is custom it inherits
from IUnknown. This interface should be used over the previous interface because there
is less overhead in using it.

The properties and methods for both interfaces are the same and are discussed in the sec-
tions below.

Analysis Complete Messages

This event will be fired for any asynchronous data retrieval call.

Calling Convention
HRESULTS AnalysisComplete(LONG Status, LONG LastStepExecuted)

Parameters
LONG Status The execution status.

LONG LastStepExecuted The last step execute

Preset Interface
This section will discuss the IPreset. This interface contains all of the properties that are
common to setting up the counting presets.

Start Channel
This property will allow you to set or get the preset start channel.

Calling Conventions
long StartChannel()

Parameters
None

Optional
None

Return
LONG The start channel.

Privilege
Read-Write

210
 CAM Datasource

Stop Channel
This property will allow you to set or get the preset stop channel.

Calling Conventions
long StopChannel()

Parameters
None

Optional
None

Return
LONG The stop channel.

Privilege
Read-Write

Count Limit
This property will allow you to set or get the preset limit.

Calling Conventions
DOUBLE Limit()

Parameters
None

Optional
None

Return
DOUBLE The preset limit value.

Privilege
Read-Write

Sweeps
This property will allow you to set or get the number of sweeps.

211
Component Programming Library Reference

Calling Conventions
LONG Sweeps( )

Parameters
None

Optional
None

Return
LONG The number of sweeps.

Privilege
Read-Write

Time
This property will allow you to set or get the preset time.

Calling Conventions
DOUBLE Time()

Parameters
None

Optional
None

Return
DOUBLE The preset time.

Privilege
Read-Write

Options
This method will allow you to set or get the preset options.

Calling Conventions
PresetOptions Options()

Parameters
None

212
 CAM Datasource

Optional
None

Return
PresetOptions The preset options value.

Privilege
Read-Write

Example
Dim objPreset As Preset
Set objPreset = objDS.Device.Preset
objPreset.Time = 56
objPreset.Options = camCountToRealTime
Set objDS.Device.Preset = objPreset

Properties
This property allows for future expansion of the property list.

Calling Convention
VARIANT Properties(VARIANT PropertyName)

Parameters
VARIANT PropertyName The property name

Optional
None

Return
VARIANT The property value.

Privilege
Read-Write

Parameter Interface
This section will discuss the IParameter. This interface contains all of the methods and
properties hat are common to getting information about the parameter.

Convert
This method will allow you to convert a value to a CAM value or to a Variant value.

213
Component Programming Library Reference

Calling Convention
VARIANT Convert(ConversionOptions Op)

Parameters
ConversionOptions Op The conversion option.

Optional
None

Return
VARIANT The output value.

Example
Dim objParam As New Parameter
Dim varCamDate As Variant

objParam.Code = CAM_X_ASTIME
objParam.Value = Today
varCamDate = objParam.Convert(camConvert2CAM)

Code
This property will allow you to set or get the parameter code to use.

Calling Conventions
LONG Code()

Parameters
None

Optional
None

Return
LONG The parameter code

Privilege
Read-Write

Class
This property will allow you to get the class the parameter belongs to.

214
 CAM Datasource

Calling Convention
LONG Class()

Parameters
None

Optional
None

Return
LONG The class code

Privilege
Read-Only

Name
This property will allow you to get the parameter name.

Calling Convention
BSTR Name()

Parameters
None

Optional
None

Return
BSTR The parameter name.

Privilege
Read-Only

Example
Dim objParam As New Parameter

objParam.Code = CAM_L_CHANNELS
MsgBox objParam.Name

Description
This property will allow you to get the parameter description.

215
Component Programming Library Reference

Calling Convention
BSTR Description()

Parameters
None

Optional
None

Return
BSTR The parameter description.

Privilege
Read-Only

Example
Dim objParam As New Parameter

objParam.Code = CAM_L_CHANNELS
MsgBox objParam.Description

Type
This method will allow you to get the parameter type. This type information matches the
Variant enumeration types.

Calling Conventions
LONG Type()

Parameters
None

Optional

Return
LONG The parameter type.

Value
This property will allow you to get or put the parameter value to use in the Convert
method.

216
 CAM Datasource

Calling Conventions
VARIANT Value()

Parameters
None

Optional
None

Return
VARIANT The parameter value.

Privilege
Read-Write

Message List
This property will get or set the current message list for this component to use.

Calling Convention
LPUNKNOWN MessageList ()

Parameters
None

Optional
None

Return
LPUNKNOWN The message list pointer

Privilege
Read-Write

Parameter Size
This property returns the size of the parameter

LONG Size ()

Parameters
None

217
Component Programming Library Reference

Privilege
Read-Only

Optional
None

Return
LONG Parameter size

Properties
This property allows for future expansion of the property list.

Calling Convention
VARIANT Properties(VARIANT PropertyName)

Parameters
VARIANT PropertyName The property name

Optional
None

Return
VARIANT The property value.

Privilege
Read-Write

Parameter Collection Interface

This section will discuss the IParameters. This interface is a collection of all of the pa-
rameters that are supported by this input devices.

Count
This property will return the number of parameters supported by the input device.

Calling Convention
long Count()

Parameters
None

218
 CAM Datasource

Optional
None

Return
LONG Count The number of parameters this interface supports.

Privilege
Read-Only

Item
This property will return the input device interface associate with this index value. See
“Parameter Interface” on page 213 for details about the IParameter interface.

Calling Convention
IParameter* Item (LONG Index)

Parameters
LONG The index number. Starts at 0 and ends at Count-1.

Optional
None

Return
IParameter ** The associate parameter interface.

Privilege
Read-Only

Collection
This property will return an enumeration of all of the supported parameters.

Calling Convention
LPUNKNOWN _NewEnum ()

Parameters
None

Optional
None

219
Component Programming Library Reference

Parameters
LPUNKNOWN *pVal A collection of all of the supported parameter interfaces.

Privilege
Read-Only

Source
This property will return an interface to the associated input device IInputDevice.

Calling Convention
LPUNKNOWN Source ()

Parameters
None

Optional
None

Return
LPUNKNOWN *Val The input device

Privilege
Read-Write

Example
This section will provide examples of how to use this interface based on the discussions
in the previous sections

Dim objInput As InputDevice

Dim objParam As Parameter

For Each objInput In objDS.Device.Inputs

For Each objParam in objDS.Device.Inputs.Parameters
MsgBox objInput.Name & “ “ & objParam.Name
Next
Next

Properties
This property allows for future expansion of the property list.

Calling Convention
VARIANT Properties(VARIANT PropertyName)

220
 Data Display

Parameters
VARIANT PropertyName The property name.

Optional
None

Return
VARIANT The property value.

Privilege
Read-Write

Data Display
The Mvc Active-X component was designed to control and display data acquired from
spectroscopy detectors, neutron shift register devices, neutron multiplicity devices, and
neutron scaler devices. This component can also display data stored in a file that has a
CAM format. This component displays information based on the type of data, spectro-
scopic or neutronic. Spectroscopy data is displayed via a two dimensional spectral plot.
Neutron data is displayed in an Excel-like spreadsheet and in various types of plots.

Note: For the MVC component to run on Windows NT requires the installation of
Windows NT Service Pack 3 or greater.

This component may be added to a VB project by selecting “Project”-“Components”.

The Components dialog box is displayed; select “Canberra Nuclear Data Display Li-
brary”. An icon similar to the one in Figure 19 will appear in the VB toolbar.

Figure 19 Nuclear
Library Icon

221
Component Programming Library Reference

Double click on this icon and it will appear on your VB form. This icon will appear only
during design time. There are no properties visible in the property toolbar list; all proper-
ties and methods become visible during coding.

Data Display Data Types

Peak Labeling Options

There will be an enumeration, defined by the name PeakLabelOptions, which will be
used to define Peak Labeling options. The enumeration description is given below.

spShowPeakLabels Show/Hide Peak Labels

spShowInfoBubble Show/Hide Peak Information Bubble
spSelectLibraryLines Select Library lines or NID analysis results to
identify peak
spShowPeakActivity Show/Hide Peak Activity inside Information
Bubble
spUseAscendingLabels Show Peak Labels in Ascending or
Descending Form

Data Display Methods

The methods are summarized below.

Datasource Management

Open Opens a file or connects to an analyzer

Close Closes a file or disconnects from an analyzer
CloseAll Closes all datasources loaded into the display
object
Save Save datasource changes to a file
DisplaySource Displays a specified datasource which is in the
source list
NextSource Displays the next datasource in the source list
PreviousSource Displays the previous datasource in the source
list
DataSourceIsLoaded Is datasource currently open

222
 Data Display

Hardware Control

SpectroscopyAcquireSetup Sets up for a spectroscopy acquisition

NeutronAcquireSetup Sets up for a neutron acquisition
AcquireStart Starts an acquisition
AcquireStop Aborts an acquisition clearing the detector
AcquirePause Pauses acquisition
Clear Clears an analyzer
VerifyInputDevices Verifies the input device settings

Cursors, Markers, and ROIs

AddRoi Adds an ROI to the ROI list

DeleteRoi Deletes an ROI from the ROI list
DeleteAllRois Deletes all ROIs from the ROI list
NextRoi Moves the ROI cursors to the next ROI pair.
For neutron data the next histogram record or
scalar bank is displayed.
PreviousRoi Moves the ROI cursors to the previous ROI
pair. For neutron data the previous histogram
record or scalar bank is displayed.
SaveRoi Saves the display ROIs to a file
LoadRoi Loads display ROIs from a file
NextNuclide, Moves the peak cursor to the next or previous
PreviousNuclide NID nuclide results
NextLine, Moves the peak cursor and displays
PreviousLine information for the next or previous nuclide line
MoveSpectralPlotCursor Moves the peak or ROI cursors to a user
specified location.

223
Component Programming Library Reference

Display Limits

ZoomOut Zooms out one aperture

SetPlotLimits Changes the plot limits
GetPlotLimits Gets the current plot limits

Exporting Data

CopyToClipBoard Copies graphics or highlighted

data to the Clipboard
PrintPlotDialog Displays a print dialog
ExportData Exports data to a text file

Neutron Data Display

PlotCoincidenceRate Plots the coincidence rates

PlotCoincidenceDistribution Plot the coincidence histograms
PlotHistogram Plots the multiplicity histograms
PlotScalarBank Plots the scalar bank data

Opening a Datasource
Either opens a file or connects to a device and displays the data. Once a datasource has
been opened this datasource becomes the current datasource. Please refer to “Connecting
to a Device” on page 128 for a dicussion on handling errors from spectroscopy devices.

Note The datasource may be opened read-write by multiple components in the same
process. However, all openers share the same handle. Therefore any save will
result in all changes being saved.

Calling Convention
Open(String Name, OpenOptions Options, SourceType Type, String Port, BaudRate
Baud)

Parameters
String Name The name of the datasource to open

224
 Data Display

OpenOptions Options (Optional) The open or create options:

ReadOnly: Read Only

ReadWrite: Read Write

DirectAccess: This options performs all data-

base actions without using the
Genie-2K VDM. This option in-
creases the speed significantly.
This option is available only for
non-device access.

SourceType Type (Optional) The datasource type. Types are:

NeutronShiftRegisterJsr12: Jsr-12

NeutronShiftRegisterJsr14: Jsr-14 in Shift Register mode

NeutronMultiplicityJsr14: Jsr-14 in Shift Register mode

NeutronMultiplicity2150: 2150

NeutronFile: Neutron File

SpectroscopyDetector: Detector

SpectroscopyFile: Spectroscopy File

AutoDetect: The display type is determined by

the data present in the file

BaudRate Baud (Optional) The serial port baud rate. This is used for neu-
tron analyzers only.

String szPort (Optional) The serial port name. This is used for neutron
analyzers only.

Optional
BooleanIsDetector A value of false

SourceType Type A value of SpectroscopyFile

BaudRate Baud A value of aUseSystemSettings

String Port A value of “COM1”.

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly

225
Component Programming Library Reference

Closing a Datasource
Closes either a file or disconnects from a device and removes the display information
from the display.

Calling Convention
Close(CloseMode Options)

Argument
CloseMode Mode (Optional) The close options:

Update: Save changes

NoUpdate: Do not save changes

Optional
CloseMode Mode Value of NoUpdate

Example
Dim Display as New Mvc
Display.Open “bobo.cnf”, ReadWrite
Display.Close

Closing All Datasources

Closes all files and/or devices that have been opened by the display.

Calling Convention
CloseAll()

Optional
None

Example
Dim Display as New Mvc
Display.Open “bobo.cnf”, ReadWrite
Display.Open “det1”, ReadWrite, true
Display.CloseAll

Saving Data
The ROI information and acquisition measurements may be stored into the current
datasource or a new datasource via this method.

Note: Data can not be saved while a neutron device is in data acquisition.

226
 Data Display

Calling Convention
Save(String File, Boolean Overwrite)

Parameters
String File The name of the file. If , changes are saved to the cur-
rent datasource.

Boolean Overwrite (Optional) If the file exists and this is true, the file is over-
written

Optional
Boolean Overwrite A value of false.

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.Save(“MySpectralResults.cnf”)

Displaying a Specific Source

A specified source may be displayed by passing the name of the source or the source’s
index in the source list.

Calling Convention
DisplaySource(Variant WhichSrc)

Parameters
Variant WhichSrc This may be an integer defining the source index in the
source list (Option Base 0). This may be a string defining
the name of the source.

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.Open “naidemo.cnf”, ReadWrite
Display.Open “nbsstd.cnf”, ReadWrite
Display.DisplaySource(“Det1”)
Display.DisplaySource(2)

Next Datasource
The next datasource in the source list may be displayed via this method. If current
datasource is last in the list, this method will display the first datasource in the list

227
Component Programming Library Reference

Calling Convention
NextSource

Parameters
None

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.Open “Det2”, ReadWrite, SpectroscopyDetector
Display.NextSource

Previous Datasource
The previous datasource in the source list may be displayed via this method. If current
datasource is first in the list, this method will display the last datasource in the list.

Calling Convention
PreviousSource

Parameters
None

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.Open “Det2”, ReadWrite, SpectroscopyDetector
Display.PreviousSource

Determining if a Source is Already Loaded

This method will to determine if a specific datasource is already loaded into the display
component.

Calling Convention
DataSourceIsLoaded(String Name)

228
 Data Display

Parameters
String Name The name of the datasource.

Optional
None

Return
Boolean DataSourceIsLoaded If true, the datasource is loaded in the display component

Setting up a Spectroscopy Detector

This routine sets up the spectroscopy detector before acquisition.

Calling Convention
SpectroscopyAcquireSetup(AcquisitionModes Mode, Double Lim, Long Start, Long
End, Double ElapsedTime, Single HighVoltage)

Parameters
AcquisitionModes Mode (Optional) The preset modes:

aCountToLiveTime: Count to preset live time

aCountToRealTime: Count to preset real time

aCountToTotal: Count to preset totals

aCountToArea: Count to preset peak area

aCountToLevel Count to level

aCountToSweep: Count to preset sweep

aCountNormal: Count to current preset settings

Double Lim (Optional) The preset limit.

Long Start (Optional) The preset start channel

Long End (Optional) The preset end channel

Double ElapsedTime (Optional) The preset time limit. This argument should be
set only during: aCountToTotal, aCountToArea, or
aCountToLevel.

Single HighVoltage (Optional) The high voltage value. If specified as 0.0 the
value is ignored and the value stored in the device is used.

229
Component Programming Library Reference

Optional
AcquisitionModes Mode A value of aCountNormal.

Double Lim A value of 0.0

Long Start A value of 0

Long End A value of 0

Double ElapsedTime A value 0.0

Single HighVoltage A value of 0

Example
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.SpectroscopyAcquireSetup aCountToLiveTime, 10.0

Note This method will turn on the high voltage for the device. To specify a compu-
tational preset (aCountToTotal, aCountToArea, aCountToLevel) the flag must
be combined with either aCountToLiveTime or aCountToRealTime. In these
cases the value specified for ElapsedTime will be set to the real or live time
preset limit.

Setting up a Neutron Device

This routine sets up a neutron device before acquisition.

Calling Convention
NeutronAcquireSetup(Single Gatewidth, Single Predelay, Double CountTime, Long
Cycles, Long Voltage, Single DeadTime, Boolean Verify)

Parameters
Single Gatewidth (Optional) The gate width (micro-sec)

Single Predelay (Optional) The pre-delay (micro-sec)

Double CountTime (Optional) The count time (sec)

Long Voltage (Optional) The voltage

Long Cycles (Optional) The number of cycles

Single DeadTime (Optional) The dead-time in micro-sec. This is required

only to correctly compute the multiplicity rates.

Boolean Verify (Optional) If true, the parameters are written to the hard-
ware and read back to verify that the hardware accepted the
values. If false, the software verifies that the values are
within the valid range for the hardware.

230
 Data Display

Optional
Long Voltage A value of 1500

Long Cycles A value of 1

Double CountTime A value of 60.0

Single Gate A value of 60.0

Single Predelay A value of 4.5

Single DeadTime A value of 0.0

Boolean Verify A value of true

Example
Dim Display as New Mvc
Display.Open “Jsr”, ReadWrite, NeutronShiftRegisterJsr12
Display.NeutronAcquireSetup 60.0, 4.5, 40, 2

Starting an Acquisition
An acquisition may be started using this method provided that the current datasource is
an analyzer. Once acquisition is started the device measurements will be automatically
updated.

Calling Convention
AcquireStart (StartOptions Options)

Parameters
StartOptions Options The start options are:

Norma Start: Start datasources currently in

view

StartAllDevices: Starts all devices loaded into the

display

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, dReadWrite, SpectroscopyDetector
Display.AcquireStart

An acquisition may be started by breaking the DeviceAccess interface out from the Mvc
interface. What is meant is that the Mvc interface can create a DeviceAccess interface for

231
Component Programming Library Reference

you to control the device. This interface may be used instead of using the method
AcquireStart. For example:

Dim Display as New Mvc

Dim Det as DeviceAccess
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Set Det = Display.CurrentDataSource
Det.AcquireStart

See “Current Datasource” on page 248 for details about the CurrentDataSource property.

Aborting an Acquisition
This routine aborts an acquisition. All data is cleared after the device is stopped.

Calling Convention
AcquireStop(StopOptions Options)

Parameters
StopOptions Options The stop options:

NormalStop: Performs a normal device stop

StopSweep: Performs a sweep stop

StopAllDevices Stops all devices loaded into the

display

Optional
StopOptions Options A value of aNormalStop

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.AcquireStart
Display.AcquireStop

An acquisition may be aborted by breaking the DeviceAccess interface out from the Mvc
interface. What is meant is that the Mvc interface can create a DeviceAccess interface for
you to control the analyzer. This interface may be used instead of using the method
AcquireStop. For example:

Dim Display as New Mvc

Dim Det as DeviceAccess
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Set Det = Display.CurrentDataSource
Det.AcquireStart
Det.AcquireStop

232
 Data Display

See “Current Datasource” on page 248 for details about the CurrentDataSource property.

Pausing an Acquisition
The routine stops an acquisition without clearing the data.

Calling Convention
AcquirePause(StopOptions Options)

Parameters
StopOptions Options The stop options

NormalStop: Performs a normal device stop

StopSweep: Performs a sweep stop

StopAllDevices Stops all devices loaded into the

displayStop

AllDevices Stops all devices loaded into the

display

Optional
StopOptions Options A value of aNormalStop

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.AcquireStart
Display.AcquirePause

An acquisition may be paused by breaking the DeviceAccess interface out from the Mvc
interface. What is meant is that the Mvc interface can create a DeviceAccess interface for
you to control the analyzer. This interface may be used instead of using the method
AcquirePause. For example:

Dim Display as New Mvc

Dim Det as DeviceAccess
Display.Open “Det1”, ReadWrite, True
Set Det = Display.CurrentDataSource
Det.AcquireStart
Det.AcquirePause

See “Current Datasource” on page 248 for details about the CurrentDataSource property.

233
Component Programming Library Reference

Clearing a Device
All device memory may be cleared using this method provided that the current
datasource is an analyzer. If there are multiple devices that are loaded into the compo-
nent, all may be cleared at the same time by specifying the ClearAllDevices argument.

Calling Convention
Clear(ClearOptions Option)

Parameters
ClearOptions Option The clear options

NormalClear: The device that is currently dis-

played is cleared.

ClearAllDevices: All devices loaded into the dis-

play are cleared.

Optional
ClearOptions Option A value of NormalClear

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.AcquireStart
Display.AcquirePause
Display.Clear

An acquisition may be cleared by breaking the DeviceAccess interface out from the Mvc
interface. What is meant is that the Mvc interface can create a DeviceAccess interface for
you to control the analyzer. This interface may be used instead of using the method
Clear. For example:

Dim Display as New Mvc

Dim Det as DeviceAccess
Display.Open “Det1”, ReadWrite, True
Set Det = Display.CurrentDataSource
Det.AcquireStart
Det.AcquirePause
Det.Clear

See “Current Datasource” on page 248 for details about the CurrentDataSource property.

Verifying Input Devices

All of the input devices for a detector may be compared to the MID description.

234
 Data Display

Calling Convention
VerifyInputDevices()

Parameters
None

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.VerifyInputDevices

Adding an ROI
Spectral ROIs may be added to the spectral ROI list and displayed via this method. The
location of the ROI cursors defines the new ROI that is to be added.

Calling Convention
AddRoi
AddRoi Ex(Long Start, Long Stop, Long Type)

Parameters
Long Start The ROI Start Channel

Long Stop The ROI Stop Channel

Long Type The type of ROI

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.AddRoi

Deleting an ROI
A spectral ROI may be remove from the ROI list and displayed via this method. The lo-
cation of the ROI cursors defines the ROI that is to be removed.

235
Component Programming Library Reference

Calling Convention
DeleteRoi
DeleteRoi Ex(Long Start, Long Stop, Long Type)

Parameters
Long Start The ROI Start Channel

Long Stop The ROI Stop Channel

Long Type The type of ROI

Optional
Long Type A value of −1 means delete the first ROI that matches the
one specified, regardless of the ROI type

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.DeleteRoi

Deleting all ROIs

All spectral ROIs may be removed from the ROI list and the plot via this property.

Calling Convention
DeleteAllRois

Parameters
None

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.DeleteAllRois

Next ROI/Next Data Group

The spectral ROI cursors may be move to the next ROI in the ROI list via this property.
If neutron histogram data or scalar data is displayed, the next histogram or scalar bank in
the datasource is displayed.

236
 Data Display

Calling Convention
NextROI

Parameters
None

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.NextRoi

Previous ROI/Previous Data Group

The spectral ROI cursors may be move to the previous ROI in the ROI list via this prop-
erty. If neutron histogram data or scalar data is displayed, the previous histogram or sca-
lar bank in the datasource is displayed.

Calling Convention
PreviousROI

Parameters
None

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.PreviousROI

Saving ROIs
The spectral ROI list may be saved in the datasource or an ROI file by using this method.

Calling Convention
SaveRoi(String RoiFile, Boolean Overwrite)

237
Component Programming Library Reference

Parameters
String RoiFile (Optional) The name of the file. If the string is NULL (i.e.,
a value of “”) the current datasource is used as the storage
medium.

Boolean Overwrite (Optional) If the file exists and this is true, the file is over-
written.

Optional
String RoiFile A value of “”.

Boolean Overwrite A value of false.

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.AddRoi
Display.SaveRois(“MyRois.Roi”)

Loading ROIs
A spectral ROI file may be loaded into the display via this method.

Calling Convention
LoadRoi(String RoiFile, Boolean ByEnergy)

Parameters
String RoiFile The name of the file.

Boolean ByEnergy (Optional) If true, the ROIs are stored in energy units.

Optional
Boolean ByEnergy A value of false.

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.LoadRois(“MyRois.Roi”)

Moving Through NID Results

These methods will allow you to view the nuclide identification and energy line informa-
tion. These methods work only if the property ShowSpectralPeakInformation (refer to
“Determining If the Datasource Has Both Neutron and Spectroscopic Data” on page 270)
is set to true.

238
 Data Display

Calling Conventions
NextNuclideLine()

PreviousNuclideLine()

NextNuclide()

PreviousNuclide()

Parameters
None

Optional
None

Manually Moving the Spectral Plot Cursors

This method will move the spectral plot cursors to a specified channel or energy location
without mouse input.

Note: The cursors may also be move by assigning the CAM parameters
CAM_L_CURSORCH, CAM_L_RMARKCH, or CAM_L_LMARKCH using
the Param property.

Calling Convention
MoveSpectralPlotCursor(SpectralPlotCusors Cursor, Single Value, Boolean IsEnergy)

Parameters
Spectral PlotCusors Cursor The cursor to move. The cursor types are Peak, LeftRoi, or
RighRoi.

Single Value The location to move the cursor to. If is energy, must have
units of keV.

Boolean IsEnergy (Optional) If true, the value passed as an argument is in

units of energy.

Optional:
Boolean IsEnergy A value of false.

Zoom Out
While in zoom mode there is the ability to zoom out to a previous zoom aperture setting.
See Section “Activating Zoom Mode” on page 258 for enabling zoom mode.

239
Component Programming Library Reference

Calling Convention
ZoomOut()

Parameters
None

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.ZoomOut

Changing Axis Limit

These methods will allow you to change or get the plotting limits.

Call Convention
SetPlotLimits(Double MinX, Double MaxX, Double MinY, Double MaxY)

GetPlotLimits(Double MinX, Double MaxX, Double MinY, Double MaxY)

Parameters
Double MinX Min x value

Double MaxX Max x value

Double MinY Min y value

Double MaxY Max y value

Optional
None

Return
None

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\nbsstd.cnf”
Disp.SetPlotLimits(0, 1024, 0, 4096)

240
 Data Display

Copy Data into Windows Application

The spectral plot or highlighted information in the spreadsheet may be copied to a Win-
dows clipboard via this method.

Calling Convention
CopyToClipBoard()

Parameters
None

Optional
None

Printing Graphics
A print dialog is displayed when this method is called. The 2-d plot or the spreadsheet in-
formation that is printed is the information displayed in the data window (i.e., the win-
dow displaying the measurement data).

Note The default plot title all spectral plots will be defined by the CAM parameter
CAM_T_STITLE. If this parameter is NULL, there is no main title. The sub-
title for all spectral plots will be the name of the CAM data. The plot title for
neutron plots may be defined by CAM_T_STITLE. If this parameter is NULL,
the name of the datasource is used. The subtitle for all neutron plots is deter-
mined by the data displayed. Histogram data has the histogram cycle number
as the subtitle. Scaler data has the scaler bank number as the subtitle. The co-
incidence rate summary plot has “Rate Summary” as the subtitle. All other
neutron plots do not have subtitles.

Calling Convention
PrintPlotDialog()

Parameters
None

Optional
None

Example
Mvc.Open “c:\genie2k\camfiles\naidemo.cnf”
Mvc.PrintDialog()

241
Component Programming Library Reference

Exporting Data
Spectral and neutron data can be exported to an ASCII text file by using this method. For
spectral data, the channel, energy, efficiency and count are exported. Neutron sources
have count rate, histogram and scalar data exported.

Calling Conventions
ExportData(String FileName)

Parameters
String FileName The name of the text file to export the data to. If the file ex-
ists, it is overwritten.

Optional
None

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.ExportData “Det1.Txt”

Plotting Coincidence Rates

The coincidence rates may be displayed in a spreadsheet (See property
ShowCoincidenceSpreadsheet on page 275) or in a plot. This method allows you to view
the coincidence rates in a time series plot. You can view a specific type of coincidence
rate as a function of cycle time or you can view all rates in a summary plot. The rate sta-
tistics are displayed on the specific rate plots. All plots except for the summary plot are
updated during acquisition.

The coincidence rate plots have various information displayed. The N times the standard
deviation is displayed as a dashed horizontal line. The factor N may be defined by the
NumberOFStandardDeviations property. The coincident rate mean is displayed as a solid
horizontal line. All filtered rates are displayed in yellow. The cause for the rate to be fil-
tered may be determined by placing the cursor on the point and comparinging the infor-
mation spreadsheet to the filter reason information. All non-filtered points are displayed
in red. During an acquisition the plot is update with the current coincident rate every 0.5
second.

Calling Convention
PlotCoincidenceRate

Parameters
NeutronRatePlot Rate The rate to plot.

TotalsRate: Totals rate

242
 Data Display

AccidentalsRate: Accidentals rate

RealsRate: Reals rate

DoublesRate: Doubles rate

TriplesRate: Triples rate

AllRates: All rates.

Optional
None

Example
Display.Open “c:\pu240.cnf”, ReadWrite
Disp.NumberOfStandardDeviations = 4.0
Display.PlotCoincidenceRate TriplesRate

Plotting Coincidence Rate Histograms

The probability distribution of a specific coincidence rate quantity can be viewed via this
method. This method displays the relative frequency histogram of a coincidence rate. The
CoincidenceRateDistributionBinSize property allows you to specify the histogram bin
size.

Two distributions that are displayed when this method is called: the filtered rate and
non-filtered rate. The change in the statistical mean is displayed as vertical annotation
lines, one line for each mean (filtered and non-filtered). The histogram bin size may be
changed by setting the CoincidenceRateDistributionBinSize property.

Calling Convention
PlotCoincidenceDistribution

Parameters
NeutronRatePlot Rate The rate to plot.

TotalsRate: Totals rate

AccidentalsRate: Accidentals rate

RealsRate: Reals rate

DoublesRate: Doubles rate

TriplesRate: Triples rate

Optional
None

243
Component Programming Library Reference

Example
Display.Open “c:\pu240.cnf”, ReadWrite
Display.CoincidenceRateDistributionBinSize = 30.0
Display.PlotCoincidenceDistribution TriplesRate

Displaying Histograms
This method plots the neutron multiplicity histograms at a specific database record num-
ber. This method will work only if the datasource has neutron multiplicity data. Histo-
gram bin values are displayed in the information spreadsheet along with the plots that are
displayed in the data region

Calling Convention
PlotHistogram(Long Rec)

Parameters
Long Rec The datasource record number.

Optional
None

Example
Disp.Open “c:\genie2k\camfiles\active_mult_assay.cnf”, ReadOnly
Disp.PlotHistogram 1

Displaying Scalar Bank Data

This method plots data for a specific neutron scalar bank. This method will work only if
the datasource has scalar data.

The scalar plot consists of the filtered and non-filtered data and the statistics. The filtered
data is displayed in yellow and the non-filtered data is red. The reason for a point to be
filtered may be determined by placin the cursor on top of the point and viewing the infor-
mation spreadsheet for the reason for filtered. The statistics are computed using the
non-filtered data. The n-standard deviation is displayed as a dashed horizontal line. The
number of standard deviations may be defined by the NumberOfStandardDeviation prop-
erty. The mean is displayed as a solid horizontal line.

Calling Convention
PlotScalarBank(Long BankNo)

Parameters
Long BankNo The scalar bank number.

244
 Data Display

Optional
None

Example
Disp.Open “c:\genie2k\camfiles\active_mult_assay.cnf”, ReadOnly
Disp.NumberOfStandardDeviations = 3.0
Disp.PlotScalarBank 1

Changing Spectral Plot Axis Labels

This method will allow you to change the axis labels on the spectral plot.

Calling Convention
SpectralPlotAxisLabels(String Chan, String Energy, String Y)

Parameters
String Chan The x-axis label when channels are displayed.

String Energy The x-axis label when energies are displayed.

String Y The y-axis label.

Optional
None

Example
Disp.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly
Disp.SpectralPlotAxisLabels “Channel”, “Energy”, “Counts”

Data Display Properties

The properties for this component are defined below.

Datasource manipulation

CurrentDataSource Gets or puts a datasource into the list to plot

CurrentDataSourceName Returns the name of the datasource
CurrentDataSourceType Returns the type of the datasource
NumberOfSources Defines the number of sources currently
loaded
SourceList Retrieves a list of the datasources
IsModified Determines if current datasource is modified

245
Component Programming Library Reference

CurrentDataSource Gets or puts a datasource into the list to plot

Param CAM parameter access to current
datasource
ParamArray CAM parameter array access to current
datasource
ParamArrayEx Single CAM parameter array access to
current datasource
EnableDragAndDrop Enable or Disable file drag and drop open

Display Options

BackColor Define the background color of the plot

RoiTypeColor Defines the ROI type colors
KeylineColor Defines the nuclide key line annotation
color
NuclineColor Defines the nuclide energy line annotation
color
SpectrumColor Defines the color of the spectrum
ExpandMode Activates expand plot
ActivateZoom Activates zoom mode
NumberOfSpectralRois Returns the number of spectral ROIs
displayed in the plot
DisplayUpdateRate Defines the update rate for acquisitions
AutoScale Data plots are auto-scaled during
acquisitions
RealTimeUpdateExpandBox Activates updates of Expand Plot during
resize or movement of the Expand Box

246
 Data Display

Gridlines

ShowXAxisGridLines Plot x-axis grid lines are displayed with

axis labels
ShowYAxisGridLines Plot y-axis grid lines are displayed with
axis labels
ShowPlotBorders Spectral plot borders, x-axis, and y-axis
ticks are displayed
NumberOfTicks Change the number of y-axis ticks
XaxisAsEnergy Display x-axis gridlines in terms of
energy

Information Display

ShowStatus Displays or hides the status information

window at the top of the plot
ShowInfo Displays or hides the information
window at the base of the plot
ShowInputDevSpreadSheet Input device settings and status are
displayed
ShowCalculationSpreadSheet The ROI computations are displayed in
the information spreadsheet. The
neutron coincidence statistics are
displayed.
ShowSpectralDataSpreadSheet The spectral values are displayed in
the information spreadsheet
ShowSpectralPeakInformation Displays identified nuclides and peak
area results
ShowSpectralNuclideAnnotationLine Displays identified nuclides as
annotation lines

247
Component Programming Library Reference

Plot Method

LinearScale Activates linear scaling

DisplayPoints Displays the data points as points or a
continuous line
FillSpectralRois Display spectral ROIs as color filled
regions
ShowCompressData View compressed or uncompressed
spectral data
HasNeutronAndSpectroscopy Returns true if the datasource has both
neutron and spectroscopic data
DisplayType Changes the display user interface type
between neutron and spectroscopy
PlotPointSize Defines the point size for the plot points

Neutron Plot Method

ShowRatePlot Display time series coincidence rates

ShowingRateDistribution Indicates rate relative frequency plots
are displayed
ShowingMulitiplicity Indicates that the multiplicity histogram
is being displayed
ShowingScalars Indicates scalar plots are being
displayed
NumberOfStandardDeviations The number of standard deviations for
the coincidence rate
CoincidenceRateDistributionBinSize The number of bins used in the
coincidence histogram
ShowCoincidenceSpreadsheet Coincidence Rates are displayed in a
spreadsheet

Current Datasource
This property will retrieve the interface used to control the current datasource or add an
interface to the source list.

248
 Data Display

Calling Convention
CurrentDataSource

Parameters
None

Optional
None

Return
Variant CurrentDataSource The datasource to add or retrieve. Must be a DataAccess
or a DeviceAccess

Privilege
Read-Write

Example
Dim Disp as New Mvc
Dim File1 as New DataAccess
Dim Det as DeviceAccess
File1.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly
Disp.CurrentDataSource = File1
Disp.Open “Det1”, aReadOnly, SpectroscopyDetector
Set Det = Disp.CurrentDataSource

Determining a Datasource Name

The name of the datasource may be accessed via this property

Calling Convention
CurrentDataSourceName

Parameters
None

Optional
None

Privilege
Read-Only

249
Component Programming Library Reference

Example
Dim Display as New Mvc
Dim Name as String
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Name = Display.CurrentDataSourceName

Determining a Datasource Type

The type of the datasource may be accessed via this property. Datasource types are listed
in “Opening a Datasource” on page 224 under the open method.

Calling Convention
CurrentDataSourceType

Parameters
None

Optional
None

Privilege
Read-Only

Example
Dim Display as New Mvc
Dim Type as SourceType
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Type = Display.CurrentDataSourceType

Determining the Number of Datasources

This property will allow you to determine the number of datasources that are loaded into
the display.

Calling Conventions
NumberOfSources

Parameters
None

Optional
None

250
 Data Display

Privilege
Read-Only

Example
Dim Display as New Mvc
Display.Close
If (Display.NumberOfSources = 0) Then
PrintWidget.Enable = false
Endif

Getting a List of Sources

This property retrieves a list of sources loaded into the display.

Calling Convention
SourceList

Parameters
None

Optional
None

Return
String SourceList(*) The names of all of the datasources

Privilege
Read-Only

Example
Dim Disp as New Mvc
List as Variant
Disp.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly
List = Disp.SourceList

Determining if Modified
This property allows the programmer to determine if the datasource has been modified.

Calling Convention
IsModified

Parameters
None

251
Component Programming Library Reference

Return
Boolean IsModified If true, the interface is has been modified.

Optional
None

Privilege
Read-Only

Example
Display.Open "bobo.cnf", ReadWrite, SpectroscopyFile
Display.Param(CAM_F_ECALTOL) = 1.2
If (Diplay.IsModified) Then Display.Save

Parameter Access
A CAM parameter may be written to or read from the current datasource via this prop-
erty.

Note Date/Time parameters when written to the datasource must be VB date type.
When a date/time parameter is read from a datasource, it is returned as a VB
string.

Calling Convention
Param(ParamCodes Param, Long lRec, Long lEntry)

Parameters
ParamCodes Param The name of the CAM parameter to write

Long lRec (Optional) The record number

Long lEntry (Optional) The entry number

Optional
Long lRec A value of 1

Long lEntry A value of 1.

Privilege
Read-Write

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.Param(CAM_T_STITLE) = “Troy’s Pu-238 Sample”

252
 Data Display

Parameter Array Access

An array of CAM parameters may be written to or read from the current datasource via
this property.

Calling Convention
ParamArray(ParamCodes Param(*), Long lRec, Long lEntry)

Note Date/Time parameters when written to the datasource must be VB date type.
When a date/time parameter is read from a datasource, it is returned as a VB
string.

Parameters
ParamCodes Param(*) An array or CAM parameters to write

Long lRec (Optional) The record number

Long lEntry (Optional) The entry number

Optional
Long lRec A value of 1

Long lEntry A value of 1.

Privilege
Read-Write

Example
Dim Display as New Mvc
Dim List(0 to 1) as Variant
Dim Codes(0 to 1) as ParamCodes
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.Param(CAM_T_STITLE) = “Troy’s Pu-238 Sample”
Display.Open “Det1”, dReadWrite, True
List(0) = “My Sample”
List(1) = 1.2
Codes(0) = CAM_T_STITILE
Codes(1) = CAM_F_ECALTOL
Display.ParamArray(Codes) = List

Single Parameter Array

An array of values for a specific parameter may be read from or written to a datasource.
All arrays must start at index 0 (i.e., Option Base 0).

253
Component Programming Library Reference

Calling Convention
ParamArrayEx(ParamCodes Param, Long Num, Long Options, Long Record,
Long Entry)

Note Date/Time parameters when written to the datasource must be VB date type.
When a date/time parameter is read from a datasource, it is returned as a VB
string.

Parameters
ParamCodes Param The parameter code defining the parameter to read or write.

Long Num The number of values to retrieve.

ArrayOptions Option (Optional) The options:

dAutoIncrementRecord: Increments the record number

dAutoIncrementEntry: Increments the entry number

Long Record (Optional) The start record number.

Long Entry (Optional) The start entry number.

Return
Variant Params(*) The parameter values. The parameter array is allocated by
the server. Therefore, you do not need to allocate the mem-
ory before using this property.

Privilege
Read-Write

Optional
Long Record A value of 1

Long Entry A value of 1

Boolean SignalsErrors True

ArrayOptions Option A value of dAutoIncrementRecord

Example
Dim List(0 to 1)
Dim Codes (0 to 1) as ParamCodes
Display.Open “Det1”, ReadWrite, True
Vals = Display.ParamArrayEx(CAM_L_RGNSTART, 2, dAutoIncrementRecord)

254
 Data Display

Drag and Drop Opens

This property enables or disables the ability to drag and drop CAM files to display. If this
property is set true, a file or group of files may be dragged from Windows explorer onto
the display window and the component will open and display them.

Note All datasources are opened with Read/Write access during drag and drop oper-
ations.

Calling Convention
EnableDragAndDrop

Parameters
None

Return
Boolean EnableDragAndDrop If true, drag and drop is enabled

Optional
None

Privilege
Read-Write

Example
‘Open a detector to display
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
‘Enable drag and drop for files
Display.EnableDragAndDrop = True

Plot Background Color

This property defines the background color of the spectral plot.

Calling Convention
BackColor

Parameters
None

Optional
None

255
Component Programming Library Reference

Return
OLE_COLOR BackColor The plot background color

Privilege
Read-Write

ROI Type Colors

These properties define the ROI type colors.

Calling Conventions
RoiType1Color

RoiType2Color

RoiType3Color

RoiType4Color

Parameters
None

Optional
None

Return
OLE_COLOR Color The ROI type color

Privilege
Read-Write

NID Annotation Colors

These properties allow you to define the color of the nuclide key line and energy line an-
notation lines. These lines are used to display the NID results on the spectral plot. The
property KeylineColor defines the color of the annotation line that represents the nuclide
key line. The property NuclineColor defines the color of the other nuclide energy lines.

Calling Conventions
KeylineColor

NuclineColor

256
 Data Display

Parameters
None

Optional
None

Return
OLE_COLOR Color The nuclide annotation line color.

Privilege
Read-Write

Spectrum Color
These properties define the color of the spectrum.

Calling Convention
SpectrumColor

Parameters
None

Optional
None

Return
OLE_COLOR Color The color

Privilege
Read-Write

Activating Expand Mode

This property activates the expand plot. If true, the expand plot is displayed. Otherwise
the full spectrum plot is displayed.

Calling Convention
ExpandMode

Parameters
None

257
Component Programming Library Reference

Optional
None

Return
Boolean ExpandMode The state of expand mode

Privilege
Read-Write

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly

Expand Plot Real Time Updates

This property will allow you to enable/disable the expand plot to update while you are
resizing the expand box or moving the expand box.

Calling Convention
RealTimeUpdateExpandBox

Parameters
None

Optional
None

Return
Boolean RealTimeUpdateExpandBox If false, the expand plot is not updated until the
left mouse button is released after moving or
resizing the expand box.

Privilege
Read-Write

Example
Disp.Open “c:\genie2k\camfiles\nbsstd.cnf”
Disp. RealTimeUpdateExpandBox = False

Activating Zoom Mode

This property activates the zoom mode. This mode allows the user to zoom into graphical
regions displayed on the plot.

258
 Data Display

Calling Convention
ActivateZoom

Parameters
None

Optional
None

Return
Boolean ActivateZoom The state of zoom mode

Privilege
Read-Write

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\nbsstd.cnf”
If (Disp.ActivateZoom = False) Then Disp.ActivateZoom = True

Getting the Number of ROIs

This property will return the number of spectral ROIs that are currently being displayed
in the spectral plot.

Calling Convention
NumberOfSpectralRois

Parameters
None

Optional
None

Return
Long NumberOfSpectralRois The number of ROIs

Privilege
Read-Only

Example
Dim Disp as New Mvc

259
Component Programming Library Reference

Disp.Open “c:\genie2k\camfiles\pu240.cnf”
If (Disp.NumberOfSpectralRois < 1) Then
DeleteRoisMenu.Enabled = False
End If

Display Refresh Rate

This property will allow you to define the refresh rate of the display. Units are in milli-
seconds. This property is applicable to the spectral plot only.

Calling Convention
DisplayUpdateRate

Parameters
None

Optional
None

Return
long DisplayUpdateRate If 0 then the updates occur as fast as the data can be trans-
ferred from the device to the computer.

Privilege
Read-Write

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\nbsstd.cnf”
Disp.DispalyUpdateRate = 1000

Auto-Scale During Acquisitions

This property activates the auto-scale feature. If true, the plots y-axis limits are automati-
cally readjusted during an acquisition.

Calling Convention
AutoScale

Parameters
None

Optional
None

260
 Data Display

Return
Boolean AutoScale The state of auto-scale

Privilege
Read-Write

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly
‘See if display points is on. If not, activate it.
If (Disp.AutoScale = False) Then Disp.AutoScale = True

Displaying Grid Lines

These properties will allow you to display or hide the plot grid lines. This property is ap-
plicable to the spectral plot only.

Calling Conventions
ShowXAxisGridLines

ShowYAxisGridLines

Parameters
None

Optional
None

Return
Boolean ShowXGridLines If true, the x-axis gridlines are displayed

Boolean ShowYGridLines If true, the y-axis gridlines are displayed

Privilege
Read-Write

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\nbsstd.cnf”
Disp.ShowYAxisGridLines = true
Disp.ShowXAxisGridLines = false

261
Component Programming Library Reference

Displaying Spectral Plot Borders

These properties will allow you to display or hide the plot borders, x-axis, and y-axis
ticks. This property is applicable to the spectral plot only.

Calling Convention
ShowPlotBorders

Parameters
None

Optional
None

Return
Boolean ShowPlotBorders If true, the plot borders are displayed

Privilege
Read-Write

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\nbsstd.cnf”
Disp. ShowPlotBorders = true

Changing the Number of Y-Axis Tick Marks

This property allows you to define the number of y-axis ticks when the plot borders are
visible.

Calling Convention
NumberOfTicks

Parameters
None

Optional
None

Privilege
Read-Write.

262
 Data Display

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.NumberOfTicks = 5

Activating Energy X-Axis Scaling

This property displays the spectral plot x-axis in units of energy.

Calling Convention
XAxisAsEnergy

Parameters
None

Optional

None

Return
Boolean XAxisAsEnergy True if the x-axis is displayed in units of energy

Privilege
Read-Write

Example
Disp.Open "c:\genie2k\camfiles\naidemo.cnf", ReadOnly
'Display energy x-axis
If (Disp.XAxisAsEnergy = False) Then Disp.XAxisAsEnergy = True

Hiding or Showing the Status Window

This property will all you to hide or show the status window which appears at the top of
the plot.

Calling Convention
ShowStatus

Parameters
None

Optional
None

263
Component Programming Library Reference

Return
Boolean ShowStatus If true, the status information window is displayed. Other-
wise it is hidden.

Privilege
Read-Write

Example
Dim Disp as New Mvc
Dim File1 as New DataAccess
Dim Det as DeviceAccess
File1.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly
Disp.CurrentDataSource = File1
‘Hide the status window
Disp.ShowStatus = False

Hiding or Showing the Information Spreadsheet

This property will all you to hide or show the information spreadsheet which appears at
the bottom of the plot.

Calling Convention
ShowInfo

Parameters
None

Optional
None

Return
Boolean ShowInfo If true, the information window is displayed. Otherwise it
is hidden.

Privilege
Read-Write

Example
Dim Disp as New Mvc
Dim File1 as New DataAccess
Dim Det as DeviceAccess
File1.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly
Disp.CurrentDataSource = File1
‘Hide the information window
Disp.ShowInfo = False

264
 Data Display

Displaying Input Device Status

All of the input devices for a detector may be displayed via this property. If this property
is true, device settings and status are displayed in the information window. If this prop-
erty is false, ROI information is displayed in the information window.

For neutron datasources this property will display the neutron device settings. If this
property is false, the rate statistics are displayed in the information window.

Calling Conventions
ShowInputDevSpreadSheet

Parameters
None

Optional
None

Privilege
Read-Write

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.ShowInputDevSpreadSheet = true

Displaying Computational Information

Computations related to the spectral ROIs or neutron coincidence rates are displayed in
the information spreadsheet when this property is activated.

Calling Conventions
ShowCalculationSpreadSheet

Parameters
None

Optional
None

Privilege
Read-Write

265
Component Programming Library Reference

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.ShowCalculationSpreadSheet= true

Displaying Spectral Data Values

Spectral data are displayed in the information spreadsheet when this property is activated.
As the peak cursor is move the appropriate spreadsheet row is highlighted. As the ROI
cursors are moved the ROI region is highlighted.

Calling Convention
ShowSpectralDataSpreadSheet

Parameters
None

Optional
None

Privilege
Read-Write

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite,
SpectroscopyDetectorDisplay.ShowSpectralDataSpreadSheet = true

Displaying Peak Area, Calibration, and NID Results

This property will display the nuclide lines associate with the nuclide that the peak cursor
is on top of. If this property is set to true, the calibration information at the peak cursor
and the identified nuclide associated with the peak channel value are displayed. This in-
formation is displayed in the information grid and in a plot legend on the spectral plot.

Calling Convention
ShowSpectralPeakInformation

Parameters
None

Optional
None

266
 Data Display

Return
Boolean ShowSpectralPeakInformation

Privilege
Read-Write. Run time only.

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
Disp.ShowSpectralPeakInformation = True

Displaying Nuclide Lines on the Plot

This property will display the nuclide lines associate with the nuclide that the peak cursor
is on top of as vertical annotation line. Solid lines represent the nuclide energy line that
has been identified by NID. The dashed lines represent unidentified line. Annotation line
color is defined by the property defined in “NID Annotation Colors” on page 256.

Calling Convention
ShowSpectralNuclideAnnotationsLines

Parameters
None

Optional
None

Return
Boolean ShowSpectralNuclideAnnotationsLines

Privilege
Read-Write. Run time only.

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
Disp.ShowSpectralNuclideAnnotationsLines = True

Activating Linear Y-Axis Scaling

This property activates the linear y-axis scaling for the spectral plot only. If true, the
y-axis is linear. Otherwise, it is logarithmic.

267
Component Programming Library Reference

Calling Convention
LinearScale

Parameters
None

Optional
None

Return
Boolean LinearScale The state of linear scaling

Privilege
Read-Write.

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly
‘See if linear scaling is on. If not, activate it.
If (Disp.LinearScale = False) Then Disp.LinearScale = True

Displaying Data Points

This property activates the display of data points. If true, the data points are plotted. Oth-
erwise, the points are connected with a line.

DisplayPoints

Parameters
None

Optional
None

Return
Boolean DisplayPoints The state of displaying points

Privilege
Read-Write

268
 Data Display

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\naidemo.cnf”, ReadOnly
‘See if display points is on. If not, activate it.
If (Disp.DisplayPoints = False) Then Disp. DisplayPoints = True

Filling Spectral ROIs

This property activates the spectral plot ROI filling. This property allows the application
developer to display the spectral ROIs as filled colored regions on the plot.

Calling Convention
FillSpectralRois

Parameters
None

Optional
None

Return
Boolean FillSpectralRois The state of fill ROIs

Privilege
Read-Write

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\active_mult_assay.cnf”, ReadOnly
If (Disp.FillSpectralRois = False) Then Disp. FillSpectralRois = True

Displaying Compressed or Uncompressed Spectral Data

This property allows you to view the compressed or uncompress spectral data in the
spectral plot. The main spectral plot by default displays compressed spectral data if the
spectrum size is greater than 1024 channels. Remember showing all data points affects
the performance of the user interface.

Calling Convention
ShowCompressData

Parameters
None

269
Component Programming Library Reference

Optional
None

Privilege
Read-Write

Example
Dim Display as New Mvc
Display.Open “Det1”, ReadWrite, SpectroscopyDetector
Display.ShowCompressedData = false

Determining if a Datasource Has Both Neutron and Spectroscopic

Data
This property will allow you to determine if the datasource has both neutron and spectro-
scopic data.

Calling Convention
HasNeutronAndSpectroscopy

Parameters
None

Optional
None

Return
Boolean HasNeutronAndSpectroscopy If true, the current datasource has both types of
data

Privilege
Read-Only

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
If (Disp.HasNeutronAndSpectroscopy) Then
DisplayTypes.Enable = true
Endif

Changing the Type of Display

This property will get or set the type of data display. There are two types of displays
SpectroscopyPlot and NeutronSpreadSheet. If the datasource has both neutron and spec-
troscopic data, this property provides the ability to view either types of data.

270
 Data Display

Calling Convention
DisplayType

Parameters
None

Optional
None

Return
DisplayTypes DisplayType The type of display to use for displaying data.

Privilege
Read-Write

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
If (Disp.HasNeutronAndSpectroscopy) Then
Disp.DisplayType = NeutronSpreadSheet
Endif

Changing the Plot Point Size

This property will get or set the point size for the plot data points.

Calling Convention
PlotPointSize

Parameters
None

Optional
None

Return
PointSize PlotPointSize The point size.

Privilege
Read-Write

271
Component Programming Library Reference

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
Disp.PlotPointSize = Small

Determining if Coincidence Rates are Being Displayed

This property will allow you to determine if time series coincidence rates are being dis-
played.

Calling Convention
ShowingRatePlot

Parameters
None

Optional
None

Return
Boolean ShowingRatePlot If true, time series rate data is being displayed

Privilege
Read-Only

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
If (Disp.ShowingRatePlot) Then
PlotSettingsWidget.Enable = true
Endif

Determining if Coincidence Histograms are Being Displayed

This property will allow you to determine if coincidence rate histograms are being dis-
played.

Calling Convention
ShowingRateDistribution

Parameters
None

272
 Data Display

Optional
None

Return
Boolean ShowingRateDistribution If true, rate distributions are being displayed

Privilege
Read-Only

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
If (Disp.ShowingRateDistribution) Then
HistogramBinWidget.Enable = true
Endif

Determining if Multiplicity Data is Being Displayed

This property will allow you to determine if multiplicity data is being displayed.

Calling Convention
ShowingMultiplicity

Parameters
None

Optional
None

Return
Boolean ShowingMultiplicity If true, multiplicity data is being displayed

Privilege
Read-Only

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
If (Disp.ShowingMultiplicity) Then
PlotSettings.Enable = true
Endif

Determining if Scalar Data is Being Displayed

This property will allow you to determine if scalar data is being displayed.

273
Component Programming Library Reference

Calling Convention
ShowingScalars

Parameters
None

Optional
None

Return
Boolean ShowingScalars If true, scalar data is being displayed

Privilege
Read-Only

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
If (Disp.ShowingScalars) Then
PlotSettingsWidget.Enable = true
Endif

Number of Standard Deviations

This property will allow you to define the number of standard deviations for the coinci-
dence rate plot or scalar plot.

Calling Conventions
NumberOfStandardDeviations

Parameters
None

Optional
None

Return
Single NumberOfStandardDeviations The number of standard deviations.

Privilege
Read-Write

274
 Data Display

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
Disp.NumberOfStandardDeviations = 3.0

Number of Coincidence Bins

This property will allow you to define the bin size used to compute the relative frequency
distribution of the coincidence plot. The affect of this property is visible when probability
histograms are displayed, the PlotCoincidenceDistribution method.

Calling Convention
CoincidenceRateDistributionBinSize

Parameters
None

Optional
None

Return
Single CoincidenceRateDistributionBinSize The number of bins.

Privilege
Read-Write

Example
Dim Disp as New Mvc
Disp.Open “c:\genie2k\camfiles\pu240.cnf”
Disp.CoincidenceRateDistributionBinSize= 30.0

Displaying Coincidence Rates in a Spreadsheet

This property activates the display of coincidence rates in a spreadsheet. The rates along
with the statistical filter results are displayed.

Calling Convention
ShowCoincidenceSpreadsheet

Parameters
None

Optional
None

275
Component Programming Library Reference

Return
Boolean ShowCoincidenceSpreadsheet The state of displaying rates

Privilege
Read-Write

Example
Dim Disp as New Mvc

Disp.Open “c:\genie2k\camfiles\active_mult_assay.cnf”, ReadOnly

‘See if display rates is on. If not, activate it.

If (Disp. ShowCoincidenceSpreadsheet = False)Then
Disp. ShowCoincidenceSpreadsheet = True

Peak Labeling
Peak Labeling is used to get or set the following properties:

Name Description Type Rights

PeakLabelColor Set Peak Labeling Color LONG Read-Only
PeakLabelProperties Set Peak Labeling PeakLabeling Read-Only
Properties Option
NuclideLibraryName Select Nuclide Library BSTR Read-Only
Name
SelectVariableTolerance Set Variable tolerance or Boolean Read-Only
Fixed tolerance selection
flag
SetVariableToleranceValue Set Variable tolerance Double Read-Only
value
SetFixedToleranceValue Set Fixed tolerance value Double Read-Only
EnergyUnitsInformation Set Energy Unit VARIANT ARRAY Read-Only
Information. It contains with following
variant array with member types:
following items: 1. BSTR
1. Enegy Unit 2. DOUBLE
2. Energy Conversion 3. LONG
Factor
3. Energy Precision

276
 Data Display

Name Description Type Rights

ActivityUnitsInformation Set Activity Unit VARIANT ARRAY Read-Only
Information. It contains with following
variant array with member types:
following items: 1. DOUBLE
1. Activity Conversion
Factor

Data Display Events

The following outgoing events are supported.

Processing Peak Cursor Events

Whenever the peak cursor is moved an event is triggered. This event may be caught by
setting up a handling facility.

Calling Convention
UpdatePeakInfo(ByVal Single Energy, ByVal Long Chan, ByVal Long Counts)

Parameters
Single Energy The energy value at the peak cursor (keV).

Long Chan The channel value at the cursor.

Long Counts The counts at the cursor.

Processing R OI Cursor Events

Whenever the ROI cursors is moved an event is triggered. This event may be caught by
setting up a handling facility.

Calling Convention
UpdateROIInfo(ByVal Single LeftRoiEnergy, ByVal Long LeftRoiChan,
ByVal Single RightRoiEnergy, ByVal LongRightRoiChan,
ByVal Single CentroidEnergy, ByVal Long CentroidChan,
ByVal Single Area, ByVal Single AreaUnc, ByVal Single Integral,
ByVal Single Fwhm, ByVal Single Fwtm, ByVal Single GaussianRatio)

Parameters
Single LeftRoiEnergy The left ROI energy (keV)

Long LeftRoiChan The left ROI channel

Single RightRoiEnergy The right ROI energy (keV)

277
Component Programming Library Reference

Long RightRoiChan The right ROI channel

Single CentroidEnergy The centroid energy

Long CentroidChan The centroid channel

Single Area The background substracted area

Single AreaUnc The background substracted area uncertainty

Single Integral The integral

Single Fwhm The FWHM (keV)

Single Fwtm The FWTM (keV)

Single GaussianRatio The Gaussian Ratio

Processing Time Events

Whenever a detector is acquiring the time information must be updated. This event may
be caught by setting up a handling facility.

Calling Convention
UpdateTimeInfo(ByVal String Start, ByVal Double ElapsedReal,
ByVal Double ElapsedLive, ByVal Double DeadTime)

Parameters
String Start The start time.

Double ElapsedReal The elapsed real time.

Double ElapsedLive The elapsed live time.

Double DeadTime The dead time.

Processing Neutron Rate Events

Whenever a neutron device is acquiring the coincident rate information must be updated.
This event may be caught by setting up a handling facility.

Calling Convention
UpdateRateInfo(ByVal String Start, ByVal Double ElapsedTime, ByVal Single Totals,
ByVal Single Reals, ByVal Single Accids, ByVal Single Doubles,
ByVal Single Triples, ByVal Long Cycle)

Parameters
String Start The start time.

278
 Data Display

Double ElapsedTime The elapsed time.

Single Totals The totals rate.

Single Reals The reals rate.

Single Accids The accidentals rate.

Single Doubles The doubles rate.

Single Triples The triples rate.

Long Cycle The current cycle.

Processing Device Status Events

Whenever a device is acquiring the device status is updated. This event may be caught by
setting up a handling facility.

Calling Convention
UpdateDeviceStatus (ByVal Long StatusCode, ByVal String Description)

Parameters
String Description The description of the status string.

Long StatusCode The status code. There is a VB data type which is defined
as DeviceStatus. This type may be used to determine the
status information.

Processing Mouse Events

Whenever a mouse button is pressed over the display object the information is sent to
VB. This event may be caught by setting up a handling facility.

Calling Convention
MouseDown (ByVal Integer Button, ByVal Integer Shift, ByVal Single x,
ByVal Single y)

Parameters
Integer Button Defines which button was pressed
0: Left button
1: Middle button
2: Right button

Integer Shift Not used.

Single x The mouse x position (pixels).

Single y The mouse y position (pixels).

279
Component Programming Library Reference

Processing Asynchronous Message Events

Since this object is multi-threaded, errors need to be reported in an asynchronous manner.
Therefore, error events have been created to solve this problem. This event may be
caught by setting up a handling facility.

Calling Convention
AsynchronousMessages(ByVal Long Code, ByVal String Message)

Parameters
Long Code The error code which can be passed to the status handler
object (StatHdlr.dll).

String Message The error string.

Drag and Drop Open Event

This event is fired at the end of a drag and drop open. One file or a group of files may be
dragged onto this component the files are opened and this event is fired.

Calling Convention
DragAndDropOpen()

Parameters
None

Interactive Data Fit Control

Genie2K requires a software component to display calibration data and compute calibra-
tion parameters. A new software component has been developed to meet this require-
ment. This component is known as Interactive Data Fit (IDF). The IDF component was
designed to display data and compute parameters for a different models like Polynomial,
Rational, Exponential, etc. The IDF component provides different methods to plot the
data according to the model specified. The user can interact with the plot to remove
points or evaluate specific plot points. The plot consists of measurements, uncertainty
bars, used to display the measurement uncertainty and a continuous curve representing
the model. The user can over plot a variety of data sets and models. Also the component
supports plotting in three dimensions. It also allows the user to cut plot or spreadsheet
information and paste them into a some other applications.

This component may be added to a VB project by selecting “Project”-“Components”,

280
 Interactive Data Fit Control

then in the Components dialog, select “Canberra Interactive Data Fit Library”. An icon
similar to the one in Figure 20 will appear in the VB toolbar.

Figure 20 Data Fit

Library Icon

Double click on this icon and it will appear on your VB form. This icon will appear only
during design time. There are no properties visible in the property toolbar list; all proper-
ties and methods become visible during coding.

Interactive Data Fit Control Data Type

This DataAccess is defined by the following methods:

WindowToCopy The window to copy to the clipboard

DataPtSymbol The data point symbol type

ModelType The fit model type

MessageCodes Component Error/Warning messages

281
Component Programming Library Reference

Interactive Data Fit Control Methods

The methods are summarized below.

Data Display

Plot Plots data or a model to fit

PlotEx Plots data using information passed in a matrix
OverPlot Over plots data sets that are within a similar y-axis
range
OverPlotLabels Defines a plot legend for the over plot
Plot3d Plots 3-dimensional data
HighlightPlane Highlights a plane on the surface plot
AddModelToFit Adds mulitple models to a data set
Labels Defines plot labels
DeletePoint Deletes the data point the plot cursor is on
DeletePointEX Deletes points from an over plot
UnDeletePoint Restores previously deleted point
UnDeletePointEx Restores points from an over plot when you want to
restore common x-axis points
UnDeleteAll Restores all previously deleted points
UnDeleteAllEx Restores all points from an over plot when you want
to restore common x-axis points
Compute Starts a computation to determine the new
calibration parameters
AbortComputation Aborts a computation
NextPoint Moves the cursor to the next data point
PreviousPoint Moves the cursor to the previous data point
MoveCursor Moves the cursor to a specific data point
GetData Retrieves the current non-deleted plot points
GetModelInfo Retrieves currrent fit data
SetCurrentModel Selects the current model
CoefficientsToFix Holds a coefficient at a constant value
SetPolynomialOrder Changes the polynomial order
ComputeStatistics Computes the fit statistics
Evaluated Determines the value of a point
EnableStatusLabels Displays data in the status window

282
 Interactive Data Fit Control

Optimize Computes the optimal coefficients

OptimizeAndEvaluate Computes the optimal coefficients to evaluate a
point
GetDualLowModelInfo Extracts the low energy model information
SetStatusLabel Sets the text displayed in the status bar
ScaleAxes Changes the scale axes
MaximizePlot Displays the plot in full screen mode

Display Limits

ZoomOut Zooms out one aperture

SetPlotLimits Changes the plot limits
GetPlotLimits Gets the current plot limits

Exporting Data

ExportData Exports data to a text file

CopyToClipBoard Copies graphics or highlighted data to the
Clipboard
PrintDialog Displays a print dialog

283
Component Programming Library Reference

ModelType Type

idfRational A rational function (y=a*x/(1+b*x))

idfPower A power function (y = a*x^b)
idfExponential An exponential function
(y = a*(1-exp(b*x)))
idfSimpleExponential A simple exponential (y = a*exp(b*x))
idfPolynomial A polynomial (y=a+b*x+c*x^2+…)
idfDualEff A dual eff model (see Genie 2000
Customization Tools)
idfLinearEff A linear eff model (see Genie 2000
Customization Tools)
idfEmpiricalEff An empirical eff model (see Genie 2000
Customization Tools)
idfLogLinearInterpolate A linear interpolation using logarithmic
spacing along the x-axis.
idfFarFieldSlab A far field slab model
(y = b*(1-exp(a*x))/(a*x))
idfFarFieldSphere A far field sphere model (y = 3b*
[1- 2*[1/(a*x) + exp(-a*x)*
[1 + 1/(a*x)]/(a*x)]/(a*x)]/(2*a*x))
idfLinearSquareRoot Square-root model (y=a+b*x^.5)
idfWeightedMean Computes a weighted mean. (see Genie
2000 Customization Tools)
idfNone No model. This will display just the data
points.

Plotting Data
This method plots data and or a model to fit.

Calling Convention
Plot(Single X(), Single Y(), Single Unc(), ModelType Type, String Name, Long Color,
DataPtSymbol Sym, Single Coeff(), Double Covar(, ), Boolean CoeffsToFix(), Vari-
ant Extra())

Parameters
Single X() The x points

284
 Interactive Data Fit Control

Single Y() The y points

Single Unc() The uncertainties

ModelType Type (Optional) The type of calibration model

String Name (Optional) A name describing the model. If “” specified,

the component will use a specific name

Long Color (Optional) The color of the model and data points on the
plot. If 0, the value for the model property is used.

DataPtSymbol Sym (Optional) The symbol for the data set.

Single Coeff() (Optional) The coefficients. If 0, the coefficients are com-

puted.

Double Covar(, ) (Optional) The covariance matrix. If 0, the covariance is

computed when the coefficients are computed

Boolean CoeffsToFix() (Optional) An array of Booleans defining which coeffi-

cients are to be held constant in the fitting process. If 0, all
coefficients are allowed to vary.

Variant Extra (Optional) This is used only for idfDualEff or

idfPolynomial types. For idfPolynomial: Index 0 is the min
number of coefficients, Index 1 is the max number of coef-
ficients, and Index 2 is the number of coefficients. For
idfDualEff: Index 0 is the cross over value, Index 1 is the
order of the lower polynomial, and Index 2 thru n are the
lower polynomial coeffs.

Optional
ModelType Type A value of idfPolynomial

String Name A value of “”

Single Coeff() A value of 0

Double Covar( ,) A value of 0

Boolean CoeffsToFix() A value of 0

Long Color A value of 0

DataPtSymbol Sym A value of idfDot

Variant Extra A value of 0

Example
Dim x(0 to 10) as Single
Dim y(0 to 10) as Single

285
Component Programming Library Reference

Dim unc(0 to 10) as Single

Dim ii as Integer

For ii=0 to 10
x(ii) = ii;
y(ii)=x(ii)*x(ii)
ync(ii)=Sqrt(y(ii))
Next ii

‘Plot data with a polynomial fit

IDF.Plot x, y, unc, idfPolynomial

Extended Plotting Data

This method plots data and or a model to fit to the data where the data is passed as a ma-
trix to the method. The purpose of this method is to make displaying calibration data us-
ing the DataAccess component faster.

Calling Convention
PlotEx(Single Data(,,), ModelType Type, String Name, Long Color, DataPtSymbol Sym,
Single Coeff(), Double Covar(, ), Boolean CoeffsToFix(), Variant Extra())

Parameters
Single Data(,,) The data points. Dim (0,*) are the x points. Dim(1,*) are
the y points. Dim(2,*) are the uncertainties in y.

ModelType Type (Optional) The type of model.

String Name (Optional) A name describing the model. If “” specified,

the component will use a specific name

Long Color (Optional) The color of the model and data points on the
plot. If 0, the value for the model property is used.

DataPtSymbol Sym (Optional) The symbol for the data set.

Single Coeff() (Optional) The coefficients. If 0, the coefficients are com-

puted.

Double Covar(, ) (Optional) The covariance matrix If 0, the covariance is

computed when the coefficients are computed

Boolean CoeffsToFix() (Optional) An array of Booleans defining which coeffi-

cients are to be held constant in the fitting process. If 0, all
coefficients are allowed to vary.

286
 Interactive Data Fit Control

Variant Extra (Optional) This is used only for idfDualEff or

idfPolynomial types. For idfPolynomial: Index 0 is the min
number of coefficients, Index 1 is the max number of coef-
ficients, and Index 2 is the number of coefficients. For
idfDualEff: Index 0 is the cross over value, Index 1 is the
order of the lower polynomial, and Index 2 thru n are the
lower polynomial coeffs.

Optional
ModelType Type A value of idfPolynomial

String Name A value of “”

Single Coeff() A value of 0

Double Covar( ,) A value of 0

Boolean CoeffsToFix() A value of 0

Long Color A value of 0

DataPtSymbol Sym A value of idfDot

Variant Extra A value of 0

Example
Dim Src as New CamSource

‘Get the energy calibration points

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points and the current cal

IDF.PlotEx Src.Calibrations.Energy.Points, idfPolynomial, “Polynomial”, _
RGB(255, 0, 0), Src.Calibrations.Energy.Curve

‘Close the source

Src.Close

Over Plots
This method allows you to over plot a variety of data sets that are within a similar y-axis
range. While in over plot mode the user has the ability to evaluate any point on any over
plotted data set using the plot cursor. The user can change between over plot data sets by
pressing the up/down arrow keys or by calling the CurrentDataSet property.

Calling Convention
OverPlot (Single X(), Single Y(), Single Unc(), ModelType Type, String Name, Long
Color, DataPtSymbol Sym, Single Coeff(), Double Covar(, ), Boolean Clear)

287
Component Programming Library Reference

Parameters
Single X() The x points

Single Y() The y points

Single Unc() The uncertainties

ModelType Type (Optional) The type of model

String Name (Optional) A name describing the model. If “” specified,

the component will use a specific name

Long Color (Optional) The color of the model and data points on the
plot. If 0, the value for the model property is used.

DataPtSymbol Sym (Optional) The symbol for the data set.

Single Coeff() (Optional) The coefficients. If 0, the coefficients are com-

puted.

Double Covar(, ) (Optional) The covariance matrix. If 0, the covariance is

computed when the coefficients are computed

Boolean Clear (Optional) If true, the previous over plotted data is re-
moved.

Optional
ModelType Type A value of idfPolynomial

String Name A value of “”

Single Coeff A value of 0

Single Covar( ,) A value of 0

Long Color A value of 0

DataPtSymbol Sym A value of idfDot.

Boolean Clear A value of false

Example
Dim x(0 to 4) As Single
Dim y(0 to 4) As Single
Dim unc(0 to 4) As Single
Dim I As Long

For I=0 To 4
x(I) = .25*I
y(I) = x(I)*x(I)

288
 Interactive Data Fit Control

unc(I) = x(I)
Next I

‘Activate over plot and plot the Nbsstd energy cal

IDF.OverPlot x, y, unc, idfPolynomial, “Parabola”, RGB(255, 0, 0)

For I=0 To 4
x(I) = .25*I
y(I) = x(I)*x(I)*x(I)
unc(I) = x(I)
Next I

‘Over plot this cal with the previous one

IDF.OverPlot x, y, unc, idfPolynomial, “Cubic”, RGB(255, 0, 255)

Over Plot Legend

This method allows you to define a plot legend for the over plot. This method must be
called after the over plot has been completed.

Calling Convention
OverPlotLabels(Variant Labels)

Parameters
Variant Labels This is an array of legend strings

Optional
None

Example
Dim x(0 to 4) As Single
Dim y(0 to 4) As Single
Dim unc(0 to 4) As Single
Dim Labels(0 to 1) As String
Dim I As Long

For I=0 To 4
x(I) = .25*I
y(I) = x(I)*x(I)
unc(I) = x(I)
Next I

Labels(0) = “Parabola”
IDF.OverPlot x, y, unc, idfPolynomial, Labels(0), RGB(255, 0, 0)

289
Component Programming Library Reference

For I=0 To 4
x(I) = .25*I
y(I) = x(I)*x(I)*x(I)
unc(I) = x(I)
Next I

Labels(1) = “Cubic”
IDF.OverPlot x, y, unc, idfPolynomial, Labels(1), RGB(255, 0, 255)
IDF.OverPlotLabels Labels

Plotting in Three Dimensions

This method allows you to plot 3-dimensional data.

Calling Convention
Plot3d (Single X(), Single Y(,), Single Z(), String Title, String Xlabel, String Ylabel,
String Zlabel, Plot3dType Type)

Parameters
Single X() The x points (one dim array).

Single Y() The y points (two dim array). Dim 0 is has the same dimen-
sion as the X array. Dim 1 has the same dimension as the Z
array.

Single Z() The z points (one dim array).

String Title (Optional) The plot title.

String Xlabel (Optional) The x-axis label.

String Ylabel (Optional) The y-axis label.

String Zlabel (Optional) The z-axis label.

Plot3dType (Optional) The type of plot.

idfSurface: A surface plot is generated

idfPoints: A scatter plot is generated

Optional
String Title A value of “Title”

String Xlabel A value of “X-Axis”

String Ylabel A value of “Y-Axis”

String Zlabel A value of “Z-Axis”

290
 Interactive Data Fit Control

Plot3dType Type A value of idfPoints

Example
Dim x(0 to 4) As Single
Dim y(0 to 4, 0 to 4) As Single
Dim z(0 to 4) As Single
Dim I As Long
Dim J As Long

For I=0 To 4
For j=0 To 4
x(I) = .25*I
y(I, J) = x(I)*x(I)
z(I) = x(I)
Next J
Next I

‘Plot the multi-curve surface

IDF.Plot3d x, y, z, “Surface”, “x”, “y”, “z”, idfSurface

Highlight a Plane on the 3d Plot

This method allows you highlight a plane on the surface plot or the 3d scatter plot.

Calling Convention
HighlightPlane(Single Value, Long Color, Boolean IsXPlane)

Parameters
Single Value The plane value.

Boolean IsXPlane If true, the value is a plane in the x-axis. Otherwise, it is a plane
along the Z axis.

Long Color The color.

Optional
Boolean IsXPlane A value of true

Example
‘Plot the multi-curve surface
Dim x(0 to 4) As Single
Dim y(0 to 4, 0 to 4) As Single
Dim z(0 to 4) As Single
Dim I As Long
Dim J As Long

291
Component Programming Library Reference

For I=0 To 4
For j=0 To 4
x(I) = .25*I
y(I, J) = x(I)*x(I)
z(I) = x(I)
Next J
Next I

‘Plot the multi-curve surface

IDF.Plot3d x, y, z, “Surface”, “x”, “y”, “z”, idfPoints
IDF.HighlightPlane z(0), False, RGB(0, 255, 0)

Adding Models To Plot

This method allows you to add multiple models to one data set. The models may be se-
lected for viewing by double clicking on the cell to the right of “Model Description:” in
the information spreadsheet or by using the CurrentModel method.

Calling Convention
AddModelToFit (ModelType Type, String Name, Boolean Clear, Single Coeff(), Double
Covar(, ), Boolean CoeffsToFix(), Variant Extra())

Parameters
ModelType Type (Optional) The type of model.

String Name (Optional) A name describing the model. If “” specified,

the component will use a specific name

Boolean Clear (Optional) If true, all models are cleared from the current
data set.

Single Coeff() (Optional) The coefficients. If 0, the coefficients are com-

puted.

Double Covar(, ) (Optional) The covariance matrix. If 0, the covariance is

computed when the coefficients are computed

Boolean CoeffsToFix() (Optional) An array of Booleans defining which coeffi-

cients are to be held constant in the fitting process. If 0, all
coefficients a allowed to vary.

Variant Extra (Optional) This is used only for idfDualEff or

idfPolynomial types. For idfPolynomial: Index 0 is the min
number of coefficients, Index 1 is the max number of coef-
ficients, and Index 2 is the number of coefficients. For
idfDualEff: Index 0 is the cross over value and Index 1 is
the order of the lower polynomial.

292
 Interactive Data Fit Control

Optional
String Name A value of “”

Boolean Clear A value of false

Single Coeff A value of 0 (indicates that the coefficients will be deter-

mined)

Double Covar( ,) A value of 0

Boolean CoeffsToFix () A value of 0

Variant Extra A value of 0

Example
Dim Src as New CamSource

‘Get the energy calibration points

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfNone

‘Close the source

Src.Close

‘Set the cal models

IDF.AddModelToFit idfEmpiricalEff, “Empirical”
IDF.AddModelToFit idfLinearEff, “Linear”

Setting Plot Labels

The method allows you to define your own plot labels

Calling Convention
Labels(String X, String Y, String Title, String Z)

Parameters
String X The x-axis label.

String Y The y-axis label.

String Title The plot title.

String Z The z axis label.

293
Component Programming Library Reference

Return
None

Optional
String Z A value of “ ”

Example
Dim Src as New CamSource

‘Get the energy calibration points

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfNone

‘Close the source

Src.Close

IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”

Deleting a Point
This method deletes the data point that the plot cursor is on and computes the model pa-
rameters. This option only works for the non 3d plot. If the point to be deleted is the
cross over point for the dual model, the cross over point is moved to the next data point.

The extended delete function, DeletePointEx(), should be used to delete points from an
over plot when you want to delete common x-axis points among all data sets.

Calling Conventions
DeletePoint(Long Index)

DeletePointEx(Long Index)

Parameters
Long Index (Optional) The index of the data point to delete. If –1 is speci-
fied, the cursor location is used.

Return
None

Optional
Long Index A value of –1

294
 Interactive Data Fit Control

Example
Dim Src as New CamSource

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfNone
Src.Close

IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”

‘Remove the second point

IDF.DeletePoint(1)

Undeleting A Point
This method will undelete a previously deleted point and computes the model parame-
ters. This option only works for the non 3d plot

The extended delete function, UnDeletePointEx(), should be used to delete points from
an over plot when you want to undelete common x-axis points.

Calling Conventions
UnDeletePoint()

UnDeletePointEx()

Parameters
None

Return
None

Optional
None

Example
Dim Src as New CamSource

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

295
Component Programming Library Reference

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfNone
Src.Close

IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”

‘Remove the second point

IDF.DeletePoint 1
If (IDF.IsComputing = False) Then IDF.UnDeletePoint

Undeleting All Points

This method will undelete all previously deleted point and computes the model parame-
ters. This option only works for the non 3d plot

The extended delete function, UnDeleteAllEx(), should be used to undelete all points
from an over plot when you want to undelete common x-axis points.

Calling Conventions
UnDeleteAll()

UnDeleteAllEx()

Parameters
None

Return
None

Optional
None

Example
Dim Src as New CamSource

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfNone
Src.Close

IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”

296
 Interactive Data Fit Control

‘Remove the second point

IDF.DeletePoint 1
If (IDF.IsComputing = False) then IDF.UnDeleteAll

Starting a Computation
Starts a computation to determine the new calibration parameters. All computations are
performed in another thread. Therefore, this method starts the computations of new cali-
bration parameter. Once the new parameters have been computed an event is dispatched.
The VB application developer must have an event handler set up to catch this event.

Calling Convention
Compute()

Parameters
None

Return
None

Optional
None

Example
Dim Src as New CamSource

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfLinearEff
Src.Close
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”

‘Force a new computation

IDF.Compute

Aborting a Computation
Aborts a computation. Computations are performed in a separate thread to prevent the
user interface from locking. This method will terminate the computational thread and re-
store the original calibration parameters. This method will not return until the computa-
tion thread has been terminated.

297
Component Programming Library Reference

Calling Convention
AbortComputation()

Parameters
None

Return
None

Optional
None

Example
Dim Src as New CamSource

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfLinearEff
Src.Close
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”

‘Force a new computation

IDF.Compute
If (IDF.IsComputing) then IDF.AbortComputations

Zoom Out
While in zoom mode there is the ability to zoom out to a previous zoom aperture. This
option only works for the non 3d plot

Calling Convention
ZoomOut()

Parameters
None

Optional
None

Changing Axis Limits

These methods will allow you to change or get the plot limits.

298
 Interactive Data Fit Control

Calling Convention
SetPlotLimits (Double MinX, Double MaxX, Double MinY, Double MaxY, Double
MinZ, Double MaxZ)

GetPlotLimits (Double MinX, Double MaxX, Double MinY, Double MaxY, Double
MinZ, Double MaxZ)

Parameters
Double MinX Min x value

Double MaxX Max x value

Double MinY Min y value

Double MaxY Max y value

Double MinZ Min z value

Double MaxZ Max z value

Optional
Double MinZ A value of 0

Double MaxZ A value of 0

Return
None

Example
Dim Src as New CamSource

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfLinearEff
Src.Close
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”
IDF.SetLimits 0, 2000, 0, 1

Copying Data Into Windows Applications

The plot or highlighted information in the spreadsheet may be copies into a Windows ap-
plication via this method.

Calling Convention
CopyToClipBoard(WindowToCopy Win)

299
Component Programming Library Reference

Parameters
WindowToCopy Win The window to copy.

idfData: Contents in the data window is

copied.

idfInformation: Contents in the information win-

dow is copied.

Optional
None

Exporting Data
The data points and model information may be exported to an ASCII text file via this
method.

Calling Convention
ExportData(String File)

Parameters
String File The name of the export file. If the file exists, it is overwritten.

Optional
None

Example
Dim Src as New CamSource

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfLinearEff
Src.Close
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”
IDF.ExportData “c:\temp\LinearEff.Txt”

Printing
A print dialog is displayed to allow the user to print the plot or the spreadsheet.

Calling Convention
PrintDialog(String Title, String SubTitle, String X, String Y, String Z)

300
 Interactive Data Fit Control

Parameters
String Title (Optional) The plot title or a header label for the spreadsheet
print out.

String SubTitle (Optional) The sub-title on the plot.

String X (Optional) The x-axis label.

String Y (Optional) The y-axis label.

String Z (Optional) The z-axis label.

Optional
String Title A value of “”. The plot label on the window is printed.

String SubTitle A value of “”. The plot label on the window is printed.

String X A value of “”. The plot label on the window is printed.

String Y A value of “”.The plot label on the window is printed.

String Z A value of “”.The plot label on the window is printed.

Example
Dim Src as New CamSource

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfLinearEff

Src.Close
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”
IDF.Print

Moving the Plot Cursor

These methods allow you to move the plot cursor to a specific location. The first two
methods move the plot cursor to the previous and next data points. The last method
moves the plot cursor to a specific location.

Calling Conventions
NextPoint()

PreviousPoint()

MoveCursor(Single X, Single Y, Single Unc)

301
Component Programming Library Reference

Parameters
Single X The x point.

Single Y The y point.

Single Unc The uncertainty in the y point.

Optional
None

Example
Dim Src as New CamSource

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfLinearEff
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”

‘Move cursor to the first point

IDF.MoveCursor Src.Param(CAM_F_DENERGY), Src.Param(CAM_F_DEFF),
_Src.Param(CAM_F_DEFFERR)

Src.Close

Getting the Plot Cursor Values

This method allows you to retrieve the values associated with the plot cursor.

Calling Convention
GetCursorValues(Single X, Single Y, Single Unc)

Parameters
Single X The x point.

Single Y The y point.

Single Unc The uncertainty in the y point.

Optional
None

Getting the Current Plot Data

This method allows you to retrieve the current non-deleted plot points

302
 Interactive Data Fit Control

Calling Convention
GetData(Variant X, Variant Y, Variant Unc)

Parameters
Variant X The x points. The variant that is returned is Single dimensioned
to the number of undeleted points.

Variant Y The y points. The variant that is returned is Single dimensioned

to the number of undeleted points.

Variant Unc The uncertainty in the y points. The variant that is returned is
Single dimensioned to the number of undeleted points.

Optional
None

Example
Dim Src as New CamSource
Dim X As Variant
Dim Y As Variant
Dim Unc As Variant

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”
‘Display the points
IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfLinearEff
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”
IDF.DeletePoint 1
IDF.GetData X, Y, Unc

Getting the Current Fit Parameters

This method allows you to retrieve the current fit information.

Calling Convention
GetModelInfo(Variant Coeff, Variant Covar, Variant Stats, Long Index)

Parameters
Variant Coeff The coefficients. The variant that is returned is Single
dimensioned to the number of coefficients.

Variant Covar The covariance matrix. The variant that is returned is Double
dimensioned to the number of coefficients (square matrix).

Variant Stats The fit statistics. The variant that is returned is Single
dimensioned to 2.

Index 0: reduced chi

Index 1: residual

303
Component Programming Library Reference

Long Index The index of the model to get the information from. If –1 is
specified, the current model is used.

Optional
Long Index A value of –1

Example
Dim Src as New CamSource
Dim Coeff As Variant
Dim Covar As Variant
Dim Stats As Variant

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfLinearEff
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”
IDF.DeletePoint 1
IDF.GetModelInfo Coeff, Covar, Stats

Selecting the Current Model to Display

This method allows you to select the current model to view. Each data set may have up to
25 models associated with it. You can add models to the current data by calling
AddModelToFit() method.

Calling Convention
SetCurrentModel(long Index)

Parameters
Long Index The index of the model to display.

Optional
Long Index A value of 0.

Example
Dim Src as New CamSource

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfLinearEff
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”
IDF.AddModelToFit idfEmpiricalEff, “Empirical”
IDF.SetCurrentModel 0

304
 Interactive Data Fit Control

Holding Coefficients Constant

This method allows you to hold a coefficient at a specific value during the fitting process.
This only works for the current model.

Calling Convention
CoefficientsToFix(Boolean List(), Boolean Compute)

Parameters
Boolean List() A list of bools indicating which coefficients to hold constant.

Boolean Compute If true, the coefficients are computed.

Optional
Boolean Compute A value of false

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim Coeffs(0 To 2) As Single
Dim FixP(0 To 2) As Variant

Dim I As Long

For I = 0 To 4
X(I) = I
Y(I) = X(I)*X(I)
Unc(I) = X(I)
Next I

Coeffs(0) = .25
Coeffs(1) = 1
Coeffs(2) = 2
FixP(0) = True
FixP(1) = False
FixP(2) = False
IDF.Plot X, Y, Unc, idfPolynomial, “Poly”, RGB(255, 0, 0), idfDiamond, Coeffs
IDF. CoefficientsToFix FixP, True

Changing a Polynomial Order

This method allows you to change the order of a polynomial model.

Calling Convention
SetPolynomialOrder(long Order, Boolean DualLower, Boolean Compute)

305
Component Programming Library Reference

Parameters
Long Order The order to set the polynomial to.

Boolean DualLower If true and the current model is a dual polynomial, the lower
polynomial order is set.

Boolean Compute If true, the coefficients are computed.

Optional
Boolean DualLower A value of false

Boolean Compute A value of false

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim I As Long

For I = 0 To 4
X(I) = I
Y(I) = X(I)*X(I)
Unc(I) = X(I)
Next I

IDF.Plot X, Y, Unc, idfPolynomial, “Poly”, RGB(255, 0, 0), idfDiamond

IDF. SetPolynomialOrder 3

Computing Fit Statistics

This method allows you to compute the fit statistics.

Calling Convention
ComputeStatistics (Single X(), Single Y(), Single Unc(), Single Coeffs(), ModelType
Model, Variant Stats)

Parameters
Single X() The x points.

Single Y() The y points.

Single Unc() The uncertianties in y.

Single Coeffs() The model coeffs.

ModelType Type The type of model.

Variant Stats The computed statistics. What is returned is s Single array.

306
 Interactive Data Fit Control

Dim [0]: Reduced Chi-Square

Dim [1]:The residual

Optional
None

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim Coeffs(0 To 1) As Single
Dim Stats As Variant

Dim I As Long

For I = 0 To 4
X(I) = I
Y(I) = X(I)*X(I)
Unc(I) = X(I)
Next I

Coeffs(0) = 0
Coeffs(1) = 1
IDF.ComputeStatistics X, Y, Unc, Coeffs, idfPolynomial, Stats

Evaluating a Point
This method allows you to determine the value of a point based on the current model in-
formation.

Calling Convention
Evaluated(Double Point, Double Value, Double Uncertianty)

Parameters
Double Point The point to evaluate.

Double Value The computed value.

Double Uncertianty The error in the computed value.

Optional
None

307
Component Programming Library Reference

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim I As Long
Dim Eval As Double
Dim EvalUnc As Double

For I = 0 To 4
X(I) = I
Y(I) = X(I)*X(I)
Unc(I) = X(I)
Next I

IDF.Plot X, Y, Unc, idfPolynomial, “Poly”, RGB(255, 0, 0), idfDiamond

IDF.Evaluate(23.3, Eval, EvalUnc)

Status Window Options

This method allows you to display specific information in the status window.

Calling Convention
EnableStatusLabels (Boolean ShowUncertianties, Boolean ShowDelta)

Parameters
Boolean ShowUncertianties The data and model uncertainties are displayed at the cur-
sor point.

Boolean ShowDelta The difference between the model and the data at the cursor
point is displayed.

Optional
None

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim I As Long

For I = 0 To 4
X(I) = I
Y(I) = X(I)*X(I)
Unc(I) = X(I)
Next I

308
 Interactive Data Fit Control

IDF.Plot X, Y, Unc, idfPolynomial, “Poly”, RGB(255, 0, 0), idfDiamond

IDF.EnableStatusLabels False

Fitting Without a Plot

This method allows you to compute the optimal coefficients without having to display
the fit results in a plot.

Calling Convention

Optimize (Single X(), Single Y(), Single Unc(), ModelType Type, Boolean
CoeffsToFix(), Variant Extra(), Variant Coeff, Variant Covar, Variant
LowCoeff, Variant LowCovar)

Parameters
Single X() The x points.

Single Y() The y points.

Single Unc() The uncertainties.

ModelType Type The type of calibration model:

Boolean CoeffsToFix() An array of Booleans defining which coefficients are to be

held constant in the fitting process. If 0, all coefficients are
allowed to vary.

Variant Extra This is used only for idfDualEff or idfPolynomial types.

For idfPolynomial: Index 0 is the min number of coeffi-
cients, Index 1 is the max number of coefficients, and In-
dex 2 is the number of coefficients. For idfDualEff: Index 0
is the cross over value and Index 1 is the order of the lower
polynomial.

Long Extra(): If Model Type is idfPolynomial the Extra pa-

rameter must be an array of “Longs” where Index 0 is the
min number of coefficients, Index 1 is the Max number of
coefficients and Index 2 is the number of coefficients.

Variant Extra(): If the Model Type is idfDuallEff then the

Extra parameter must be an array of variants (with longs
values stored into it) where Index 0 is the Cross Over value
and Index 1 is the order of the low polynomial.

Variant Extra: All other models do not require the Extra pa-
rameter therefore a Null/0 should be passed.

Variant Coeff The coefficients (returned). The data type is an array of

Singles(). A value of 0 indicates ignore this argument.

309
Component Programming Library Reference

Variant Covar The covariance matrix (returned). The data type returned is
an array of Doubles( , ). A value of 0 indicates ignore this
argument.

Variant LowCoeff The coefficients for the low energy polynomial if the
model type is idfDualEff. A value of 0 indicates ignore this
argument.

Variant LowCovar The covariance for the low energy polynomial if the model
type is idfDualEff. A value of 0 indicates ignore this argu-
ment.

Optional
None

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim Coeff As Variant
Dim I As Long

For I = 0 To 4
X(I) = I
Y(I) = X(I)*X(I)
Unc(I) = X(I)
Next I

IDF.Optimize X, Y, Unc, Coeffs, idfPolynomial, 0, 0, Coeff, 0, 0, 0

Evaluation of a Point on the Model

This method allows you to compute the optimal coefficients to evaluate a point on the
model without having to display the fit results in a plot.

Calling Convention
OptimizeAndEvaluate (Single X(), Single Y(), Single Unc(), ModelType Type, Boolean
CoeffsToFix(), Variant Extra(), Double X, Double Y, Double
Unc)

Parameters
Single X() The x points.

Single Y() The y points.

Single Unc() The uncertainties.

ModelType Type The type of calibration model:

310
 Interactive Data Fit Control

Boolean CoeffsToFix() An array of Booleans defining which coefficients are to be

held constant in the fitting process. If 0, all coefficients are
allowed to vary.

Variant Extra This is used only for idfDualEff or idfPolynomial types.

For idfPolynomial: Index 0 is the min number of coeffi-
cients, Index 1 is the max number of coefficients, and In-
dex 2 is the number of coefficients. For idfDualEff: Index 0
is the cross over value and Index 1 is the order of the lower
polynomial.

Double X The point to evaluate the model at.

Double Y (Returned) The computed value.

Double Unc (Returned) The error in the computed value.

Optional
None

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim Eval As Double
Dim EvalUnc as Double
Dim I As Long

For I = 0 To 4
X(I) = I
Y(I) = X(I)*X(I)
Unc(I) = X(I)
Next I

IDF.OptimizeandEvaluate X, Y, Unc, Coeffs, idfPolynomial, 0, 0, 23.4, Eval, EvalUnc

Get Dual Low Energy Model Information

This method allows you extract the low energy model information for the dual model
type.

Calling Convention
GetDualLowModelInfo(Variant Coeff, Variant Covar, Variant Stats, Long Index);

Parameters
Variant Coeff The coefficients (returned). The data type is an array of Sin-
gles().

311
Component Programming Library Reference

Variant Covar The covariance matrix (returned). The data type returned is an
array of Doubles( , ).

Variant Stats The fit statistics (returned). The data type returned is an array of
Singles().

Long Index The index of the dual model to get the information from. If –1, it
is assumes that the current model is the dual model.

Optional
Long Index A value of -1

Example
Dim Src as New CamSource
Dim HiCoeff As Variant
Dim LoCoeff As Variant
Dim HiCovar As Variant
Dim LoCovar As Variant
Dim HiStats As Variant
Dim LoStats As Variant

Src.Open “c:\genie2k\camfiles\nbsstd.cnf”

‘Display the points

IDF.PlotEx Src.Calibrations.Efficiency.EfficiencyPoints, idfDualEff
Src.Close
IDF.Labels “Energy”, “Efficiency”, “Efficiency Calibration”

IDF.GetModelInfo HiCoeff, HiCovar, HiStats

IDF.GetDualLowModelInfo LoCoeff, LoCovar, LoStats

Status Bar Text

This method allows you set the text displayed in the status bar.

Call Convention

SetStatusLabel(String Label, Boolean Highlight)

Parameters
String Label The text to display in the status bar.

Boolean Highlight (Optional) If true, the text is displayed in red.

Optional
Boolean Highlight A value of False

312
 Interactive Data Fit Control

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim I As Long

For I = 0 To 4
X(I) = I
Y(I) = X(I)*X(I)
Unc(I) = X(I)
Next I

IDF.Plot X, Y, Unc, idfPolynomial, “Poly”, RGB(255, 0, 0), idfDiamond

IDF.SetStatusLabel “Done”

Scaling Axes
This method allows you change the scale of the data. This can be used to change the units
of the data without affecting the fitting process. This method must be called before pass-
ing the data to the plot object.

Calling Convention
ScaleAxes(Double XScale, Double Yscale)

Parameters
Double Xscale The x-axis scale factor.

Double Yscale The y-axis scale factor.

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim I As Long

For I = 0 To 4
‘Meter
X(I) = I

‘Fractional value
Y(I) = X(I)*X(I)/100.0
Unc(I) = X(I)/100.0
Next I

313
Component Programming Library Reference

‘Display in millimeters and percentage

IDF.ScaleAxes 1/1000.0, 100.0
IDF.Plot X, Y, Unc, idfPolynomial, “Poly”, RGB(255, 0, 0), idfDiamond

Maximize to Full Screen

This method allows you to maximize the plot to full screen. Once in full screen mode you
can exit be pressing escape or selecting the title base.

Calling Convention
MaximizePlot()

Parameters
None

Example
Dim X(0 To 4) As Single
Dim Y(0 To 4) As Single
Dim Unc(0 To 4) As Single
Dim I As Long

For I = 0 To 4
‘Meter
X(I) = I

‘Fractional value
Y(I) = X(I)*X(I)/100.0
Unc(I) = X(I)/100.0
Next I

IDF.Plot X, Y, Unc, idfPolynomial, “Poly”, RGB(255, 0, 0), idfDiamond

IDF.MaximizePlot

Interactive Data Fit Control Properties

The properties for this component are defined below.

Display Options

DataPointColor Changes the color of the data points

ModelColor Changes the model color
LowDualCurveColor Changes the color of the low dual polynomial curve
BackgroundColor Changes the background color of the plot

314
 Interactive Data Fit Control

AxisAndLabelColor Changes the color of the plot axes and labels

FitEnvelopColor Changes the color of the fit uncertainty envelope
CursorColor Changes the color of the plot cursor
CrossOverColor Changes the color of the cross over annotation line
LogXAxis Changes the x-axis scale
LogYAxis Changes the-axis scale
CursorFollowData Allows the plot cursor to follow data points or
evaluate a point on the model curve
ActivateZoom Activates zoom mode

Information Display

ShowDataSpreadSheet Displays the data via a plot or spreadsheet

ShowCovariance Displays the covariance matrix in a spreadsheet
AllowEdits Enables/disables the edit mode of a spreadsheet
ShowsNumberOfDeleted Shows the number of deleted points in the
spreadsheets
ShowStatus Displays or hides the status information window at
the top of the plot
ShowInfo Displays or hides the status information window at
the base of the plot
IsWarning Displays a warning message
IsError Displays an error message
Message Returns the status message text by the status code

Gridlines

NumberofTicks Changes the number of y-axis ticks

ShowsXAxisGridlines Displays or hides x-axis gridlines
ShowYAxisGridlines Displays or hides y-axis gridlines

315
Component Programming Library Reference

Plot Method

NumberOfPts Returns the number of calibration points

NumberofPtsDeleted Returns the number of deleted calibration
points
NumberOfModels Returns the number of models associated
with the data set
ShowFitEnvelop Displays the n-sigma uncertainty in the fit
NumberOfStandardsDevsOfFit Retrieves or sets the number of standard
deviations in the displayed fit uncertainty
DualModelCrossOver Sets the dual cross over value for the current
model
EnableCrossOverCursor Enables/disables the crossover cursor
CurrentDataSet Defines the current data set to place the plot
cursor
IsComputing Determines if component is currently
computing
DualAsSingle Uses the higher polynomial model in the
efficiency calibration model as a single
model
LinearEstimationTechnique Change the estimation technique used to
determine the optimal model coefficients

Data Point Colors

This property allows you to change the color of the data points and error bars.

Calling Convention
DataPointColor

Parameters
None

Optional
None

Return
OLE_COLOR DataPointColor The color.

316
 Interactive Data Fit Control

Privilege
Read-Write

Model Color
This property allows you to change the model color.

Calling Convention
ModelColor

Parameters
None

Optional
None

Return
OLE_COLOR ModelColor The color.

Privilege
Read-Write

Low Dual Curve Color

This property allows you to change the color of the low dual polynomial curve.

Calling Convention
LowDualCurveColor

Parameters
None

Optional
None

Return
OLE_COLOR LowDualCurveColor The color

Privilege
Read-Write

317
Component Programming Library Reference

Background Color
This property allows you to change the background color of the plot.

Calling Convention
BackgroundColor

Parameters
None

Optional
None

Return
OLE_COLOR BackgroundColor The color

Privilege
Read-Write

Plot Axes And Label Color

This property allows you to change the color of the plot axes and labels.

Calling Convention
AxisAndLabelColor

Parameters
None

Optional
None

Return
OLE_COLOR AxisAndLabelColor The color

Privilege
Read-Write

Fit Envelope Color

This property allows you to change the color of the fit uncertainty envelope.

318
 Interactive Data Fit Control

Calling Convention
FitEnvelopColor

Parameters
None

Optional
None

Return
OLE_COLOR FitEnvelopColor The color

Privilege
Read-Write

Cursor Color
This property allows you to change the color of the plot cursor.

Calling Convention
CursorColor

Parameters
None

Optional
None

Return
OLE_COLOR CursorColor The color

Privilege
Read-Write

Cross Over Color

This property allows you to change the color of the cross over annotation line.

Calling Convention
CrossOverColor

319
Component Programming Library Reference

Parameters
None

Optional
None

Return
OLE_COLOR CrossOverColor The color

Privilege
Read-Write

Data Point Symbols

This property allows you to change the symbol for the current data set.

Calling Convention
DataPointSymbol

Parameters
None

Optional
None

Return
DataPtSymbol Symbol The symbol

Privilege
Read-Write

Log/Linear Axis Scales

This property allows you to change the scale of the x or y axes.

Calling Convention
LogXAxis

LogYAxis

Parameters
None

320
 Interactive Data Fit Control

Optional
None

Return
Boolean Val If true, the scale is log

Privilege
Read-Write

Cursor Options
This property allows the user to setup the plot cursor to follow the data points or evaluate
a point on the model curve. If this property is set to true, the plot cursor moves amongst
data points. If this property is false, the plot cursor evaluate the model at the point where
the cursors is at.

Calling Convention
CursorFollowData

Parameters
None

Optional
None

Return
Boolean CursorFollowData The state

Privilege
Read-Write

Activating Zoom Mode

This property activates the zoom mode. This mode allows the user to zoom into graphical
regions displayed on the plot.

Calling Convention
ActivateZoom

Parameters
None

321
Component Programming Library Reference

Optional
None

Return
Boolean ActivateZoom The state of zoom mode

Privilege
Read-Write

Display a Plot or Spreadsheet

This property displays the data via a plot or a spreadsheet.

Calling Convention
ShowDataSpreadSheet

Parameters
None

Optional
None

Return
Boolean ShowDataSpreadSheet If true, data points are displayed in a spreadsheet

Privilege
Read-Write

Displaying the Covariance Matrix

This property causes the covariance matrix to be displayed in the information spread-
sheet.

Calling Convention
ShowCovariance

Parameters
None

Optional
None

322
 Interactive Data Fit Control

Return
Boolean ShowCovariance If true, the covariance is displayed

Privilege
Read-Write

Changing the Number of Y-Axis Tick Marks

These properties will allow you to change the number of y-axis grid lines. Note: Minor
y-axis ticks is always 4.

Calling Convnetion
NumberOfTicks

Parameters
None

Optional
None

Return
Long NumberOfTicks The number of y-axis major ticks.

Privilege
Read-Write

Displaying Grid Lines

These properties allow you to display or hide the plot grid lines

Calling Convention
ShowXAxisGridLines

ShowYAxisGridLines

Parameters
None

Optional
None

Return
Boolean ShowXAxisGridLines If true, the x-axis gridlines are displayed.

323
Component Programming Library Reference

Boolean ShowYAxisGridLines If true, the y-axis gridlines are displayed.

Privilege
Read-Write

Hiding or Showing the Status Window

This property will allow you to hide or show the status window which appears at the top
of the plot.

Calling Convention
ShowStatus

Parameters
None

Optional
None

Return
Boolean ShowStatus If true, the status information window is displayed. Other-
wise it is hidden.

Privilege
Read-Write

Hiding or Showing the Information Window

This property will allow you to hide or show the information window which appears at
the bottom of the plot.

Calling Convention
ShowInfo

Parameters
None

Optional
None

Return
Boolean ShowInfo If true, the information window is displayed. Otherwise it
is hidden.

324
 Interactive Data Fit Control

Privilege
Read-Write

Number of Points
This property returns the number of calibration points.

Calling Convention
NumberOfPts

Parameters
None

Optional
None

Privilege
Read-Only

Number of Deleted Points

This property returns the number of deleted calibration points.

Calling Convention
NumberOfPtsDeleted

Parameters
None

Optional
None

Privilege
Read-Only

Number of Models
This property returns the number of models associate with the data set.

Calling Convention
NumberOfModels

325
Component Programming Library Reference

Parameters
None

Optional
None

Privilege
Read-Only

Status Severity
All status messages have a severity associated with them. This severity defines whether a
message is an warning, or error message. There are two properties that may be used to
determine the severity of a message.

Calling Convention
IsWarning(MessageCodes Code)

IsError(MessageCodes Code)

Parameters
MessageCodes Status The status code to examine for severity level.

Return
Boolean bVal A value of true indicates that the message is of that speci-
fied severity level.

Optional
None

Retrieving Status Messages

This property returns the status message text defined by the status code.

Calling Convention
Message

Parameters
MessageCodes Code The message code to retrieve the status string.

Return
String Message String for the status

326
 Interactive Data Fit Control

Optional
None

Privilege
Read-Only

Activating/Deactivating Spreadsheet Edits

This property will activate or deactivate the ability to edit the information spreadsheet.

Calling Convention
AllowEdits

Parameters
None

Return
Boolean AllowEdits State of edit

Optional
None

Privilege
Read-Write

Displaying the Number Of Deleted Points

This property will activate or deactivate the ability to view the number of deleted points
in the information spreadsheet.

Calling Convention
ShowNumberOfDeleted

Parameters
None

Return
Boolean ShowNumberOfDeleted State of show deleted

Optional
None

327
Component Programming Library Reference

Privilege
Read-Write

Displaying the Fit Uncertainty

This property will activate or deactivate the ability to view the n-sigma uncertainty in the
fit. The number of standard deviations may be set with the NumberOfStandardDevsOfFit
property.

Calling Convention
ShowFitEnvelop

Parameters
None

Return
Boolean ShowFitEnvelop State of show fit uncertianty

Optional
None

Privilege
Read-Write

The Number of Standard Deviations in the Fit

This property will retrieve or set the number of standard deviations in the displayed fit
uncertainty. When the number of standard deviations is changed the fit envelope is re-
computed and redisplay only if the ShowFitEnvelop property is true.

Calling Convention
NumberOfStandardDevsOfFit

Parameters
None

Return
Single NumberOfStandardDevsOfFit The number of standard deviations

Optional
None

328
 Interactive Data Fit Control

Privilege
Read-Write

Dual Model Crossover Value

This property allows you to set or get the dual crossover value for the current model. If
the current model does not support dual crossover, nothing is done. When the crossover
point is set, the data set is search to find the closest value. This closest value is used as
the cross over point.

Calling Convention
DualModelCrossOver

Parameters
None

Return
Single DualModelCrossOver The dual cross over value

Optional
None

Privilege
Read-Write

Enabling The Crossover Cursor

This property allows you to enable or disable the movement of the crossover value using
a crossover cursor.

Calling Convention
EnableCrossOverCursor

Parameters
None

Return
Boolean EnableCrossOverCursor The state of the cross over cursor.

Optional
None

329
Component Programming Library Reference

Privilege
Read-Write

Sets the Current Data Set for the Plot Cursor

This property allows you to defined the current data set to place the plot cursor on during
overplots.

Calling Conventions
CurrentDataSet

Parameters
None

Return
Long CurrentDataSet The current data set. All data sets start at 0.

Optional
None

Privilege
Read-Write

Determining Computation Status

This property allows you to determine if the component is currently computing. During
computations you cannot make changes that affect the model results.

Calling Convention
IsComputing

Parameters
None

Return
Boolean IsComputing If true then the component is computing.

Optional
None

Privilege
Read-Only

330
 Interactive Data Fit Control

Changing Dual Efficiency Model Into a Single Efficiency Model

This property allows you to use the higher polynomial model in the efficiency calibration
model as a single model (i.e. there is no splicing of the lower and higher polynomial
models). This will hide the cross over point user interface widgets like the cross over cur-
sor and the cross over text entry field. The purpose of this feature it to prevent the user
interface from displaying information that the user does not need nor should be able to
change.

Calling Convention
DualAsSingle

Parameters
None

Return
Boolean DualAsSingle If true then the higher polynomial attributes are used to dis-
play and determine the model coefficients.

Optional
None

Privilege
Read-Write

Changing Linear Estimation Technique

This property allows you to change the estimation technique that is used to determine the
optimal model coefficients. This property currently is supported for the following mod-
els: idfPolynomial, idfEmpiricalEff, idfDualEff, and idfLinearEff. This property allows
you to change the parameter estimation technique to idfLinearLeastSquares (Linear Least
Squares) or idfSingularValuedDecomposition (SVD). By default all of the models listed
above are set to idfLinearLeastSquares. This property sets the technique for the current
model.

Calling Convention
LinearEstimationTechnique

Parameters
None

Return
LinearEstimationMethod Method The method to use.

idfLinearLeastSquares: Linear Least

Squares Fit

331
Component Programming Library Reference

IdfSingularValuedDecomposition: SVD Fit.

Optional
None

Privilege
Read-Write

Interactive Data Fit Control Events

The following outgoing events are supported.

Processing Mouse Events

Whenever a mouse button is pressed over the display object the information is sent to
VB. This event may be caught by setting up a handling facility.

Calling Convention
MouseDown (ByVal Integer Button, ByVal Integer Shift, ByVal Single x, ByVal Single
y)

Parameters
Integer Button Defines which button was pressed.

Integer Shift Not used.

Single x The mouse x position (pixels).

Single y The mouse y position (pixels).

Processing Plot Cursor Events

Whenever a plot cursor is changed via the mouse or the MoveCursorMethod this event is
fired. This event may be caught by setting up a handling facility.

Calling Convention
UpdateCursorInfo (ByVal Single X, ByVal Single Y, ByVal Single Unc)

Parameters
Single X The x-axis data point.

Single Y The y-axis data point.

Single Unc The uncertainty in the point.

332
 Interactive Data Fit Control

Processing Asynchronous Message Events

Since this object is multi-threaded, errors need to be reported in an asynchronous manner.
Therefore, error events have been created to solve this problem. This event may be
caught by setting up a handling facility.

Calling Convention
AsynchronousMessages (ByVal Long Code, ByVal String Message)

Parameters
Long Code The error code which can be passed to the status handler object
(StatHdlr.dll).

String Message The error string.

Processing OverPlot Events

While in over plot mode the user has the ability to evaluate any point on any plot using
the plot cursor. The user can change between over plot data set by pressing the up/down
arrow keys or by setting the CurrenctDataSet property. When the user changes to another
over plot data set this event is fired.

Calling Convention
OverPlotDataSetSelected (ByVal Long Set)

Parameters
Long Set The data set selected.

Processing Model Selection Events

Whenever the user changes the model type for a data set this event is fired.

Calling Convention
ModelSected (ByVal Long ModelIndex)

Parameters
Long ModelIndex The index of the model that is currently displayed.

Processing Dual Cross Over Change Events

Whenever the cross over value for the dual polynomial model is changed this event is
fired. This event is fired when the cross over is changed with the mouse cursor or by us-
ing the DualModelCrossOver property. The ComputationComplete event will follow this
event to indicate that the computations have completed.

333
Component Programming Library Reference

Calling Convention
CrossOverPointSet(ByVal Single CrossOver)

Parameters
Single CrossOver The cross over value.

Processing Computations Completed Event

Whenever the Compute method is called, computations are performed asynchronously.
The end of computations may be determined by catching this event. This event is sent
only when computations are computed using the following methods (DeletePoint,
DeletePointEx, UnDeletePoint, UnDeletePointEx, UnDeleteAllPoints,
UnDeleteAllPointEx, and Compute).

Calling Convention
ComputationComplete(ByVal Long NumComputed)

Parameters
Long NumComputed The number of models that were computed.

Processing Point Delete/Undelete Event

Whenever the Compute method is called, computations are performed asynchronously.
The end of computations may be determined by catching this event. This event is sent
only when computations are computed using the following methods (DeletePoint,
DeletePointEx, UnDeletePoint, UnDeletePointEx, UnDeleteAllPoints,
UnDeleteAllPointEx, and Compute).

Calling Convention
PointDelUnDel(ByVal Long Options, ByVal Long Index, ByVal Single X, ByVal Single
Y, ByVal Single Unc)

Parameters
Long Options Indicates whether the point was deleted or undeleted.

1: Point was deleted

0: Point was undeleted

–1: All points were undeleted

Long Index The array index of the point that was deleted/undeleted

Single X The x value of the deleted/undeleted point

Single Y The y value of the deleted/undeleted point

334
 Interactive Data Fit Control

Single Unc The unc value of the deleted/undeleted point

Exported C Routines
There a two exported C routines that may be used by developers that do not need a user
interface to compute a fit and who do not want to use Active-X programming. These rou-
tines allow developers to gain access to fitting data for all of the model types defined by
the IDF component. These routines are outlined below.

Fitting Data to a Model

This routine will fit data to any of the specified models. The routine will not return until
the fit is complete.

Calling Convention
IDFOptimize (VARIANT *X, VARIANT *Y, VARIANT *Unc, ModelType Model,
VARIANT *Coeffs2Fix, VARIANT *Extra, VARIANT *Coeff,
VARIANT *Covar, VARIANT *LowCoeff, VARIANT *LowCovar)

Parameters
VARIANT *X The sample points. This must be an array of single preci-
sion values.

VARIANT *Y The measurement values at the sample points. This must be

an array of single precision values.

VARIANT *Unc The measurement uncertainty. This must be an array of sin-

gle precision values.

ModeType Model The IDF models defined in the previous sections.

VARIANT *Coeffs2Fix The coefficients to hold constant during the fitting process.
This must be an array of Boolean values. If you do not
want to specify supply a value of NULL.

VARIANT *Extra Extra fit information. This is used only for idfDualEff or
idfPolynomial types. For idfPolynomial: Index 0 is the min
number of coefficients, Index 1 is the max number of coef-
ficients, and Index 2 is the number of coefficients. For
idfDualEff: Index 0 is the cross over value, Index 1 is the
order of the lower polynomial, and Index 2 thru n are the
lower polynomial coeffs. If you do not want to specify sup-
ply a value of NULL.

VARIANT *Coeff The coefficients (returned as a single precision array).

VARIANT *Covar The covariance matrix (returned as a double precision

square matrix). If you do not want supply a NULL.

335
Component Programming Library Reference

VARIANT *LowCoeff The dual poly low coeffs (returned as a single precision ar-
ray). If you do not want, supply a NULL.

VARIANT *LowCovar The dual poly low covariance matrix(returned as a double

precision square matrix). If you do not want , supply a
NULL.

Return
DWORD dwStat A status code. PAS__OK indicates success.

Evaluating a Fit
This routine will fit data to any of the specified models and evaluate the model at a point.
The routine will not return until the fit and computation is complete.

Calling Convention
IDFOptimizeAndEvaluate (VARIANT *X, VARIANT *Y, VARIANT *Unc,
ModelType Model, VARIANT *Coeffs2Fix, VARIANT *Ex-
tra, double dX, double *pdVal, double *pdUnc)

Parameters
VARIANT *X The sample points. This must be an array of single preci-
sion values.

VARIANT *Y The measurement values at the sample points. This must be

an array of single precision values.

VARIANT *Unc The measurement uncertainty. This must be an array of sin-

gle precision values.

ModeType Model The IDF models defined in the previous sections.

VARIANT *Coeffs2Fix The coefficients to hold constant during the fitting process.
This must be an array of Boolean values. If you do not
want to specify supply a value of NULL.

VARIANT *Extra Extra fit information. This is used only for idfDualEff or
idfPolynomial types. For idfPolynomial: Index 0 is the min
number of coefficients, Index 1 is the max number of coef-
ficients, and Index 2 is the number of coefficients. For
idfDualEff: Index 0 is the cross over value, Index 1 is the
order of the lower polynomial, and Index 2 thru n are the
lower polynomial coeffs. If you do not want to specify sup-
ply a value of NULL.

double dX The point to evaluate the mode at.

double *pdVal The computed value.

double *pdUnc The uncertainty in the computed value.

336
 Interactive Data Fit Control

Return
DWORD dwStat A status code. PAS__OK indicates success.

Library of Models
All of the models used by IDF have been consolidated into one library; this library is
known as ModelsLib.Lib. The sections below describe the C-functions that are used to
evaluate the model and aid in the computations of the model parameters.

Spectroscopy Energy And Shape Models

These models may be used in the calibration of spectroscopy detectors. There is one
model that is used to estimate the energy, low tail, and polynomial FWHM calibration;
this model is the polynomial model. The method that is used to determine the optimal
model parameters is linear least squares.

Calling Convention
double dPolynomialFnc (double dEvalPt, double *pdCoeff, double *pdGradiant, long
lNumCoeff)

Parameters
double dEvalPt The point to evaluate the model at.

double *pdCoeff The coefficients

double *pdGradient The gradient

long lNumCoeff The number of coefficients.

Return
double dVal The evaluated point.

The model that is used to perform a square root FWHM calibration is outlined below.
This method that is used to determine the optimal model parameters is
Levenberg-Marquart non-linear least squares. The initial model parameters are deter-
mined via linear least squares. The first routine is the evaluation routine; the second is
used to compute the initial estimate for the non-linear estimation method.

Calling Convention
double dSqrtFwhm (double dEvalPt, double *pdCoeff, double *pdGradiant, long
lNumCoeff)

long lEstimateSqrtFwhm (float *prX, float *prY, float *prUnc, long lNum,
MODELINFO_T *pstModel)

Parameters
double dEvalPt The point to evaluate the model at.

337
Component Programming Library Reference

double *pdCoeff The coefficients.

double *pdGradient The gradient

long lNumCoeff The number of coefficients.

float *prX The sample points.

float *prY The measured points.

float *prUnc The error in the measured points.

long lNum The number of points.

MODELINFO_T The model information (plot2d.h).

Return
double dVal The evaluated point.

long lStat A status code. PAS__OK indicates success.

Spectroscopy Efficiency Models

These models may be used in the calibration of spectroscopy detectors. The method used
to determine the model parameters is Levenberg-Marquart non-linear least squares. The
initial estimate used for the non-linear least squares method is determined by linear least
squares. The routines listed below are used to compute the initial estimate for the
non-linear least squares method with the exception of the weighted mean model. The
weighted mean model computes a weighted mean based in the variance or each data
point.

Calling Convention
long lEstimateLinearEff (float *prX, float *prY, float *prUnc, long lNum,
MODELINFO_T *pstModel)

long lEstimateEmpiricalEff (float *prX, float *prY, float *prUnc, long lNum,
MODELINFO_T *pstModel)

long lWeightedMean (float *prX, float *prY, float *prUnc, long lNum, MODELINFO_T
*pstModel)

Parameters
float *prX The sample points.

float *prY The measured points.

float *prUnc The error in the measured points.

long lNum The number of points.

338
 Interactive Data Fit Control

MODELINFO_T The model information (plot2d.h).

Return
long lStat A status code. PAS__OK indicates success.

Each model may be evaluated at a specified point via these routines.

Calling Convention
double dEmpiricalEff(double dEvalPt, double *pdCoeff, double *pd Gradient, long
lNumCoeff)

double dLinearEff (double dEvalPt, double *pdCoeff, double *pdGradient, long

lNumCoeff)

double dWeightedMean (double dEvalPt, double *pdCoeff, double *pdGradient, long

lNumCoeff)

Parameters
double dEvalPt The point to evaluate the model at.

double *pdCoeff The coefficients

double *pdGradient The gradient.

long lNumCoeff The number of coefficients.

Return
double dVal The evaluated point.

The dual polynomial model is handled in a different manner because of how complicated
the model definition is. The first routine is used to compute the model parameters. The
second routine is used to evaluate the model at a specified point.

Calling Convention
long lOptimizeDualEfficiency (float *prX, float *prY, float *prUnc, long lNum,
MODELINFO_T *pstModel)

double dDualEff(double dEvalPt, double *pdUnc, MODELINFO_T *pstModel)

Parameters
double dEvalPt The point to evaluate the model at.

double *pdUnc The computed uncertainty.

float *prX The sample points.

float *prY The measured points.

339
Component Programming Library Reference

float *prUnc The error in the measured points.

long lNum The number of points.

MODELINFO_T The model information (plot2d.h).

Return
double dVal The computed value.

long lStat A status code. PAS__OK indicates success.

The interpolation model is handled differently because model parameters are not opti-
mized.

double dLogLinearInterpolate (double dEvalPt, double *pdUnc, float *prX, float *prY,
float *prUnc, long lNumPts)

Parameters
double dEvalPt The point to evaluate the model at.

double *pdUnc The computed uncertainty.

float *prX The sample points.

float *prY The measured points.

float *prUnc The error in the measured points.

long lNumPts The number of points.

Return
double dVal

The computed value

Spectroscopy Efficiency versus Density Models

The method used to determine the model parameters is a combination of non-linear least
squares and simulated annealing. The initial estimate used for the non-linear least squares
method is determined by using Newton-Raphson method. The results from the non-linear
least squares are used as the starting point for simulated annealing. The covariance matrix
is determined by assuming the Cramer-Rao bound condition is met. The routines listed
below are used to compute the initial estimate for the non-linear least squares method.

Calling Convention
long lEstFarFieldSphere (float *prX, float *prY, float *prUnc, long lNum,
MODELINFO_T *pstModel)

340
 Interactive Data Fit Control

long lEstFarFieldSlab (float *prX, float *prY, float *prUnc, long lNum,
MODELINFO_T *pstModel)

Parameters
float *prX The sample points.

float *prY The measured points.

float *prUnc The error in the measured points.

long lNum The number of points.

MODELINFO_T The model information (plot2d.h).

Return
long lStat A status code. PAS__OK indicates success.

Each model may be evaluated at a specified point via these routines.

Calling Convention
double dFarFieldSphere (double dEvalPt, double *pdCoeff, double *pdGradiant, long
lNumCoeff)

double dFarFieldSlab (double dEvalPt, double *pdCoeff, double *pdGradiant, long

lNumCoeff)

Parameters
double dEvalPt The point to evaluate the model at.

double *pdCoeff The coefficients.

double *pdGradient The gradient.

long lNumCoeff The number of coefficients.

Return
double dVal The evaluated point.

General Non-Linear Models

The method used to determine the model parameters is a combination of non-linear least
squares and simulated annealing. The routines listed below are used to compute the ini-
tial estimate for the non-linear least squares method.

Calling Convention
long lEstimateExponentialEx (float *prX, float *prY, float *prUnc, long lNum,
MODELINFO_T *pstModel)

341
Component Programming Library Reference

long lEstimateRational (float *prX, float *prY, float *prUnc, long lNum,
MODELINFO_T *pstModel)

Parameters
float *prX The sample points.

float *prY The measured points.

float *prUnc The error in the measured points.

long lNum The number of points.

MODELINFO_T The model information (plot2d.h).

Return
long lStat A status code. PAS__OK indicates success.

The first routine computes the initial estimate based on the averaged results from New-
ton-Raphson. The second routine computes the initial estimated based on the average ra-
tion between points. The results from both methods are passed to the non-linear least
squares method. The results from the non-linear least squares method are then passed to
the simulated annealing method. The covariance matrix is computed based on the as-
sumption that Cramer-Rao lower bound is met.

Each model may be evaluated at a specified point via these routines.

Calling Convention
double dRationalFnc(double dEvalPt, double *pdCoeff, double *pdGradiant, long
lNumCoeff)

double dExponentialFnc(double dEvalPt, double *pdCoeff, double *pdGradiant, long

lNumCoeff)

Parameters
double dEvalPt The point to evaluate the model at.

double *pdCoeff The coefficients.

double *pdGradient The gradient.

long lNumCoeff The number of coefficients.

Return
double dVal The evaluated point.

342
 Interactive Data Fit Control

General Linear Models

The parameters for all linear models are computed using linear least squares. All linear
models have the form of a polynomial function therefore the evaluation function is a
polynomial.

Calling Convention
double dPolynomialFnc (double dEvalPt, double *pdCoeff, double *pdGradiant, long
lNumCoeff)

Parameters
double dEvalPt The point to evaluate the model at.

double *pdCoeff The coefficients.

double *pdGradient The gradient.

long lNumCoeff The number of coefficients.

Return
double dVal The evaluated point.

Model Statistics
The parameters for all linear models are computed using linear least squares. All linear
models have the form of a polynomial function therefore the evaluation function is a
polynomial.

Calling Convention
long lComputeStatsEx (DWORD dFncEx, float *prX, float *prY, float *prUnc, long
lNum, MODELINFO_T *pstModel)

long lComputeStats (DWORD dFnc, float *prX, float *prY, float *prUnc, long lNum,
double *pdCoef, double *pdStats, long lNumCoeff)

Parameters
DWORD dFncEx The address of the model function. The model function
must be of the form double (*pdModel)(double, double *,
MODELINFO_T *) where the first parameter is the evalua-
tion point, the second parameter is the computed
uncertianty, and the third parameter is the model informa-
tion.

DWORD dFnc The address of the model function. The model function
must be of the form double (*pdModel)(double, double *,
double *, long) where the first parameter is the evaluation
point, the second parameter is the coefficients, and the third
parameter is the gradient (NULL must be acceptable value)
and the for parameter is the number of coefficients.

343
Component Programming Library Reference

float *prX The sample points.

float *prY The measured points.

float *prUnc The error in the measured points.

long lNum The number of points.

double *pdCoeff The coefficients.

double *pdStats The computed statistics.

[0]: Reduced Chi-Square

[1]: Residual

long lNumCoeff The number of coefficients.

Return
long lStat A status code. PAS__OK indicates success.

Efficiency Calibration Control

A generic efficiency calibration component library has been developed that will perform
efficiency calibrations for a single density or multiple densities. This library consists of
two components.

The first component may be used to perform the initial efficiency calibration for a single
density. This component will allow you to define the calibration points. The second com-
ponent allows you to see the calibration. This component is capable of fitting different
efficiency models like Linear, Empirical, Dual, Interpolate etc. This component provides
a plot of the data and calibration model. There are two phases for this component: Phase I
and Phase II.

Using the Efficiency Calibration Phase I Component

This component may be added to a VB project by selecting “Project”-“Components”.

344
 Efficiency Calibration Control

The Components dialog box is displayed; select “Canberra Efficiency Calibration Li-
brary”. Select the icon shown in Figure 21.

Figure 21 Efficiency
Calibration Icon

The initial user interface that is displayed when the component is dropped onto a VB
form.

Note The datasource must have been analyzed using peak search and peak area anal-
ysis before running this control. All calculations are based on peak area results.

Efficiency Calibration Control Phase I Methods

Datasource Management

Open Opens the datasource and displays efficiency

calibration information
Close Closes the datasource
Save Save all datasource changes

Data Display

Delete Deletes data point from spreadsheet

Add Adds data point from spreadsheet

345
Component Programming Library Reference

Efficiency Calibration Data

Automatic Performs an analysis on all of the energy

peaks to determine efficiency for each peak
AddEfficiency Adds new efficiency calibration record
MergeEfficiency Merges efficiency calibration records
Refresh Changes the Efficiency Calibration user
interface
PutEnergyUnits Sets the energy display units
GetEnergyUnits Gets the energy display units
ListOfIds Lists the efficiency point identifiers
RemovePoints Removes points associated with a datasource
identifier

Opening a Datasource
This method opens the datasource and displays the efficiency calibration information.

Calling Convention
Open(Variant Source, EffCalOpenOps Options, DataSource Type)

Parameters
Variant Source The datasource to open. If this is a file name (i.e., String)
then the open options are used. If this is a DataAccess,
DeviceAccess, or CamDatasource object the datasource is
reopened.

EffCalOpenOps Options

(Optional) The open options

efcReadOnly: Open read only. Note: You can-

not delete points if the file is
opened read only.

efcReadWrite: Open read-write. This is a pro-

cess read write open. Therefore,
another component can open the
component in the same process
only.

346
 Efficiency Calibration Control

efcDirectAccess: Open with direct file access. This

implies that the VDM is by-
passed. This option improves the
speed of data transactions by a
factor of ten.

DataSource Type (Optional) The type of datasource to open. This is required

only if the argument Source is a String.

efcFile: File

efcDectecor: Detector

Optional
EffCalOpenOps Ops A value of efcReadOnly

DataSource Type A value of efcFile

Closing a Datasource
This method closes the datasource.

Calling Convention
Close(EffCalCloseOps Options)

Parameters
EffCalCloseOps Options (Optional) The close options

efcNoUpdate: Changes are not flushed to the

file.

EfcUpdate: Changes are flushed to the file.

Optional
EffCalCloseOps Ops A value of efcNoUpdate

Deleting A Point
This method deletes the data point from the spreadsheet. The point that is deleted is the
current point the mouse cursor is on. A message is sent via the event sink to signal when
deleting a point is allowable; this event is ChangesAllowed.

Calling Convention
Delete()

Parameters
None

347
Component Programming Library Reference

Return
None

Optional
None

Adding A Point
This method adds the data point to the spreadsheet. A point can be added only when the
last row of the spreadsheet has been completely filled in with values. A message is sent
via the event sink to signal when adding a point is allowable; this event is
ChangesAllowed.

The can only be 45 points in an efficiency calibration because of limitations in the CAM
file format. This method will not return an error under this condition; the point is not ac-
cepted.

Calling Convention
Add()

Parameters
None

Return
None

Optional
None

Automatic Efficiency Calibration

This method will perform an analysis on all of the energy peaks to determine the effi-
ciency for each peak. This routine requires a certificate for the datasource; see the certifi-
cate property on page 354.

This method will match the peaks in the spreadsheet to the peaks in the certificate (match
is based on an energy or variable energy tolerance). For each peak that matches a certifi-
cate peak an efficiency value is computed. The efficiency is computed by taking the de-
cay corrected and sample quantity corrected ratio of the peak areas. This is performed
using the Efcal1 analysis engine.

This method does not compute the calibration coefficients; only the efficiency and uncer-
tainty is computed for each peak that matches the certificate is computed. You must exe-
cute the efficiency calibration phase 2 component or Efcal2 engine to compute the
coefficients.

348
 Efficiency Calibration Control

Calling Convention
Automatic(Boolean PeakAnalysis)

Parameters
Boolean PeakAnalysis If true, peak analysis is performed before performing an ef-
ficiency calibration before performing an efficiency cali-
bration.

Return
None

Optional
None

Adding An Efficiency Calibration Record

This method adds a new efficiency calibration record or merges calibration entries. This
function may be used to build a multi-curve efficiency file. New entries are added based
on the following logic:

1. If the number of records in cal file == 0: this is a new calibration, build the new
curve in record 1.

2. If the number of records in cal file == 1 && density of spectrum == 0: merge

the new energies into record 1.

3. If the number of records in cal file == 1 && density of spectrum != 0: convert

from single curve to multicurve eff file (duplicate record 1 into record 2). Then
proceed as in next case (number of records > 1).

4. If the number of records in cal file > 1: this is a multi-curve calibration file.
Look for a matching density record:

found: move to record 1, merge in points and move the points back to the re-
cord found.

not found: build new efficiency curve (in record 1), then move into list of re-
cords in the right spot

where “density of spectrum” is defined by the CAM parameter CAM_F_SCWT.

It is assumed that peak search and peak area analysis has been performed on the input
file. The efficiencies for each peak defined in the certificate is computed (i.e., Efcal1 en-
gine is executed). The calibration coefficients are computed based on the new efficiency
points (i.e., Efcal2 engine is executed).

349
Component Programming Library Reference

It is also assumed that the default calibration type to use as defined by the parameter
CAM_T_EFFTYPE is defined in the spectral file. If it is not then the calibration type is
set to empirical. If the efficiency point already exists in the density record the point is
still added to allow the user to bias a point. The dual cross over is retained when adding
or merging points.

This method performs both phases of an efficiency calibration. The method was designed
to proceed through errors that may occur during phase 2. These errors may be caught by
setting and event handler for the AsynchronousMessages event. The types of errors that
are returned on method invocation are file i/o errors or errors that arise during phase 1
analysis.

The can only be 45 points in an efficiency calibration because of limitations in the CAM
file format. This method will not return an error under this condition; the point is not ac-
cepted.

Calling Convention
AddEfficiency(Variant Spec, Variant Certificate, Long Id, Boolean IgnoreDensity)

Parameters
Variant Spec This is the spectral file to add or merge into the current file.
This may be a DataAccess, DeviceAccess, or String object.

Variant Certificate This is the certificate file to add or merge into the current
file. This may be a DataAccess, DeviceAccess, or String
object. If this is a blank string (i.e. “”) then the CAM pa-
rameter CAM_T_EXPCERT is extracted from the spectral
file and is used.

Long Id This is an identifier for the spectral source.

Boolean IgnoreDensity The density information is ignored and the efficiency

points are added to record 1 in the calibration file

Return
None

Optional
None

Merging Efficiency Calibration Records

This method merges existing efficiency points from a datasource into the current effi-
ciency calibration. This function will examine the parameter CAM_F_CWTORDENSI to
determine if the input datasource has a density. If it does, the current calibration is search
to find a matching density record. If no matching record is found, a new density record is
created in the calibration. This new record will be inserted into a location such that the

350
 Efficiency Calibration Control

density records are in increasing order. If a match is found, the efficiency points are
merged. No energy points are rejected; this implies that you can weight an efficiency
point by inserting it multiple times. After the points are merged the calibration coeffi-
cients are computed. This method will merge every density record from the source cali-
bration into the destination calibration.

This method will not perform an efficiency calibration phase 1. This implies that the effi-
ciency for each peak is not computed; it is assumed that the efficiency for each points has
already been computed.

The method was designed to proceed through errors that may occur during phase 2.
These errors may be caught by setting and event handler for the AsynchronousMessages
event. The types of errors that are returned on method invocation are file I/O errors or
data verification errors.

The can only be 45 points in an efficiency calibration because of limitations in the CAM
file format. This method will not return an error under this condition; the point is not ac-
cepted.

Calling Convention
MergeEfficiency(Variant Spec, Long Id, Boolean IgnoreDensity)

Parameters
Variant Spec This is the spectral file to add or merge into the current file.
This may be a DataAccess, DeviceAccess, or String object.

Long Id This is an identifier for the spectral source.

Boolean IgnoreDensity The density information is ignored and the efficiency

points are added to record 1 in the calibration file

Return
None

Optional
None

Displaying Changes
This will force the UI to reload the calibration information and display it. This method
should be used to display changes incurred by external modification to the datasource.

Calling Convention
Refresh()

351
Component Programming Library Reference

Parameters
None

Optional
None

Changing the Energy Display Units

This will changed the displayed energy units

Calling Conventions
PutEnergyUnits(String Label, Single ScaleFactor)

GetEnergyUnits(String Label, Single ScaleFactor)

Parameters
String Label The label that is displayed with any parameter that has units of
energy

Single ScaleFactor The energy conversion factor. Base units are in keV. Therefore,
if you want to display MeV the conversion factor will be 1000.

Optional
None

Saving Calibration
This method will save all changes to the datasource.

Calling Convention
Save()

Parameters
None

Return
None

Optional
None

352
 Efficiency Calibration Control

Listing the Efficiency Point Identifiers

This method return a list of datasource descriptions associated with the points used in the
efficiency calibration. This list is a logical OR’ing of ids for every point in the file over
all densities.

Calling Convention
ListOfIds(Variant List)

Parameters
Variant List Returns an array of Longs.

Return
None

Optional
None

Removing Points Associated with a Datasource Identifier

This method remove all points that are match the datasource description. This method
will search through all density records. If all points have been removed from a density re-
cord the record is deleted.

The dual cross over is retained when the point that is deleted does not affect the order of
the lower or higher order curve. If the cross over point is deleted, it is set to the value of
0.0. Also, the calibration coefficients are recomputed after the points have been deleted.
Any errors that occur during the computations of the new coefficients are signaled
through the AsynchronousMessage event.

Calling Convention
RemovePoints(Long Id)

Parameters
Long IdThe datasource id.

Return
None

Optional
None

353
Component Programming Library Reference

Efficiency Calibration Control Phase I Properties

The properties for this component are defined below.

Name Description
Certificate Sets or gets the certificate name
CrossOver Set or remove cross over peak
Is Warning Displays warning message
IsError Displays error message
Message Returns the status message defined by the
status code
NumberOfPoints Return current number of calibration points
IsModified Return true if the calibration has been modified
AllowEdits Enables/disables edit mode
Properties Reserved for future use

Certificate
This property will set or get the certificate name for the datasource. When the certificate
is assigned to the datasource the certificate is opened and the certificate points are added
to the datasource. If the datasource already has calibration points, the certificate points
are appended to the datasource. If the datasource has points that match the certificate
points, you are prompted to overwrite or skip the calibration point.

Note The CAM Parameters CAM_F_VARTOLERANCE and

CAM_F_TOLERANCE are used to define the energy tolerance for the certifi-
cate peak energy match. The criterion used to define a peak match search all
peak energies in the datasource and find the minimum difference between the
datasource energy and the certificate energy. If the minimum difference is less
than or equal to the tolerance the certificate energy is added to the datasource.
If the minimum difference is equal to 0 then the certificate point matches a
peak in the datasource and a message box informs you of this. You can replace
the calibration point or skip this certificate energy.

Calling Convention
Certificate

Parameters
None

354
 Efficiency Calibration Control

Return
String Certificate

Privilege
Read-Write

Cross Over Point

This property will set or remove the cross over peak. The reference peak is defined when
the input focus is on the row that represents the peak and this property is assigned a value
of true. The text in this row is highlighted when the cross over peak has been set. To re-
move a cross over peak you can set the input focus on the current cross over peak row
and set the value of this property to false. When the text has been change from bold to
normal the cross over peak has been removed.

Calling Convention
CrossOver

Parameters
None

Return
Boolean CrossOver If true, the current highlighted peak is set as the cross over
peak.

Privilege
Read-Write

Status Severity
All status messages have a severity associated with them. This severity defines whether a
message is an warning, or error message. There are two properties that may be used to
determine the severity of a message.

Calling Conventions
IsWarning(MessageCodes Code)

IsError(MessageCodes Code)

Parameters
MessageCodes Status The status code to examine for severity level.

355
Component Programming Library Reference

Return
Boolean bVal A value of true indicates that the message is of that speci-
fied severity level.

Optional
None

Retrieving Status Messages

This property returns the status message text defined by the status code.

Calling Convention
Message

Parameters
MessageCodes Code The message code to retrieve the status string.

Return
String Message String for the status

Optional
None

Privilege
Read-Only

Number of Calibration Points

This property will return the current number of calibration points.

Calling Convention
NumberOfPoints

Parameters
None

Return
Long NumberOfPoints

Optional
None

356
 Efficiency Calibration Control

Privilege
Read-Only

Modify State
This property will return true if the calibration has been modified.

Calling Convention
IsModified

Parameters
None

Return
Boolean IsModified

Optional
None

Privilege
Read-Only

Activating/Deactivating Edits
This property will activate or deactivate the ability to delete points from the calibration.

Calling Convention
AllowEdits

Parameters
None

Return
Boolean AllowEdits State of edit

Optional
None

Privilege
Read-Write

357
Component Programming Library Reference

Properties
This property allows for future expansion of the property list. It currently supports the
following.

Calling Convention
Properties

Parameters
None

Optional
None

Efficiency Calibration Control Phase I Events

The following outing events are supported.

Processing Asynchronous Message Event

Since this object is multi-threaded, errors need to be reported in an asynchronous manner.
Therefore, error events have been created to solve this problem.

Calling Convention
AsynchronousMessages (ByVal Long Code, ByVal String Message)

Parameters
Long Code The error code which can be passed to the status handler object
(StatHdlr.dll)

String Message The error string.

Processing Enable Change Event

This event is fired whenever the spreadsheet is ready to delete or add a point.

Calling Convention
ChangesAllowed (ByVal Long ChangeOption, ByVal Long State)

Parameters
Long ChangeOption Indicates which options is enabled delete or add

0: Implies delete option

1: Implies add option

358
 Efficiency Calibration Control

Long State Defines whether the option is enabled or disabled

0: Implies disabled

1: Implies enabled

Processing Cell Selection Event

This event is fired whenever you select a cell on the spreadsheet.

Calling Convention
CellSelected(ByVal Long Row, ByVal Long Col)

Parameters
Long Row The row

Long Col The column

Modified CAM Parameters for Phase I

This section outlines the CAM parameters that are updated when a modification is per-
formed to the calibration points.

The following calibration parameters are modified by the control when a Save is per-
formed.

CAM Parameter Description

CAM_F_DENERGY Efficiency calibration energy point
CAM_F_DEFF Efficiency calibration efficiency point
CAM_F_DEFFERR Efficiency calibration efficiency error
CAM_F_CROSSOVER Dual cross over energy
CAM_T_EXPCERT The certificate
CAM_L_DEFFPTID The identifier for the calibration source

This component calls the lEfcal1 analysis engine. This engine will match the peaks in the
spreadsheet to the peaks in the certificate (match is based on an energy or variable energy
tolerance). For each peak that matches a certificate peak an efficiency value is computed.
The efficiency is computed by taking the decay corrected and sample quantity corrected
ratio of the peak areas.

359
Component Programming Library Reference

Exported Functions
This section outlines the several C functions that have been exported to allow non-COM
applications to use some of this components functionallity.

Adding Efficiency Calibration

Calling Convention
extern “C” DWORD AddEfficiency (VARIANT Cal, VARIANT Spec, VARIANT Cert,
long Id, VARIANT_BOOL IgnoreDensity)

Description
This added efficiency points to the calibration. See method AddEfficiency for details.

Parameters
VARIANT Cal A name of a file, CamDatasource, or a DataAccess inter-
face. This represents the calibration output file. All effi-
ciency points will be added to this datasource.

VARIANT Spec A name of a file or detectors, DataAccess interface, or

DeviceAccess interface. This file contains the counts for
the efficiency source.

VARIANT Cert A name of a file or a DataAccess interface. This is the cer-

tificate.

Long Id The Id of the efficiency points

VARIANT_BOOL IgnoreDen If true, the efficiency points are added to record 1 only.

Return
DWORD dwStat The status code. PAS__OK indicates success.

Merging Efficiency Calibration

Calling Convention
extern “C” DWORD MergeEfficiency (VARIANT Cal, VARIANT Spec, long Id,
VARIANT_BOOL IgnoreDensity)

Description
This merges efficiency points into the calibration. See method MergeEfficiency for de-
tails.

360
 Efficiency Calibration Control

Parameters
VARIANT Cal A name of a file, CamDatasource, or a DataAccess inter-
face. This represents the calibration output file. All effi-
ciency points will be added to this datasource.

VARIANT Spec A name of a file or detectors, CamDatasource, DataAccess

interface, or DeviceAccess interface. This file contains the
counts for the efficiency source.

Long Id The Id of the efficiency points.

VARIANT_BOOL IgnoreDen If true, the efficiency points are added to record 1 only.

Return
DWORD dwStat The status code. PAS__OK indicates success.

List of Calibration Identifiers

Calling Convention
extern “C” DWORD ListOfIds(VARIANT Cal, VARIANT *pList)

Description
This returns a list of all of the efficiency point id numbers. See method ListOfIds for de-
tails.

Parameters
VARIANT Cal A name of a file, CamDatasource, or a DataAccess interface.
This represents the calibration output file. All efficiency points
will be added to this datasource.

VARIANT *pList The list of Ids. This is an array of Longs starting at index 0.

Long Id The Id of the efficiency points.

Return
DWORD dwStat The status code. PAS__OK indicates success.

Removing Point By Identifier

Calling Convention
extern “C” DWORD RemoveCal(VARIANT Cal, long lId)

Description
This removes all efficiency points matching the id number. See method RemoveCal for
details.

361
Component Programming Library Reference

Parameters
VARIANT Cal

A name of a file, CamDatasource, or a DataAccess interface. This represents the calibra-

tion output file. All efficiency points will be added to this datasource.

Long Id

The Id of the efficiency points

Return
DWORD dwStat The status code. PAS__OK indicates success.

Using the Efficiency Calibration Phase II Component

This component may be added to a VB project by selecting “Project”-“Components”.
The Components dialog box is displayed; select “Canberra Efficiency Calibration Li-
brary”. Select the icon shown in Figure 22.

Figure 22 Efficiency
Calibration Icon

The initial user interface that is displayed when the component is dropped onto a VB
form.

Note The datasource must be populated with efficiency calibration points; this im-
plies the Efficiency Calibration Phase I must have been performed. All calcula-
tions are based on efficiency calibration points.

Efficiency Calibration Control Phase II Data Types

Efficiency Calibration Control Phase II defines the following enumeration types:

362
 Efficiency Calibration Control

EffCalOpenOps The datasource open options

EffCalCloseOps The datasource close options

DataSource The datasource types

PlotType The types of calibration plots

MessageCodes Component Error/Warning messages

Efficiency Calibration Control Phase II Methods

Datasource Management

Open Opens the datasource and displays efficiency

calibration information
Close Closes the datasource
Save Save all datasource changes

Data Display

DeletePoint Deletes data point that the plot cursor is on

UnDeletePoint Restores a previously deleted point
UnDeleteAll Restores all previously deleted points
AbortComputation Aborts a computation
PrintDialog Displays a print dialog
Refresh Reloads the calibration information

Display Limits

SetPlotLimits Changes the plot limits

GetPlotLimits Gets the current plot limits

363
Component Programming Library Reference

Efficiency Calibration Data

PutEnergyUnits Sets the energy display units

GetEnergyUnits Gets the energy display units
PutDensityUnits Sets the density display units
GetDensityUnits Gets the density display units

Opening a Datasource
This method opens the datasource and displays the efficiency calibration information.

Calling Convention
Open(Variant Source, EffCalOpenOps Options, DataSource Type)

Parameters
Variant Source The datasource to open. If this is a file name (i.e., String)
then the open options are used. If this is a DataAccess,
DeviceAccess, or CamDatasource object the datasource is
reopened.

EffCalOpenOps Options (Optional) The open options.

efcReadOnly: Open read only. Note: You can-

not delete points if the file is
opened read only.

efcReadWrite: Open read-write. This is a pro-

cess read write open. Therefore,
another component can open the
component in the same process
only.

efcDirectAccess: Open with direct file access. This

implies that the VDM is by-
passed. This option improves the
speed of data transactions by a
factor of ten.

DataSource Type (Optional) The type of datasource to open. This is required

only if the argument Source is a String.

efcFile: File

efcDectecor: Detector

364
 Efficiency Calibration Control

Optional
EffCalOpenOps Ops A value of efcReadOnly

DataSource Type A value of efcFile

Closing a Datasource
This method closes the datasource.

Calling Convention
Close(EffCalCloseOps Options)

Parameters
EffCalCloseOps Options (Optional) The close options.

efcNoUpdate: Changes are not flushed to the

file.

efcUpdate: Changes are flushed to the file.

Optional
EffCalCloseOps Ops A value of efcNoUpdate

Deleting A Point
This method deletes the data point that the plot cursor is on and computes the model pa-
rameters. This option only works for 2d plots. If the point to be deleted is the cross over
point for the dual model, the cross over point is moved to the next data point.

Note This method will not delete points from the density versus efficiency plot. The
reason is because deleting a density point will affect the density versus effi-
ciency plot at another energy because of the way these points are store in the
CAM format.

If Refresh method will be performed after deleting point(s), the component will
erase the current set of deleted point(s) and there will be no point(s) remain
undeleted. (Change I – Remove this comment).

Calling Convention
DeletePoint(Long Index)

Parameters
Long Index (Optional) The index of the data point to delete. If –1 is speci-
fied, the cursor location is used

365
Component Programming Library Reference

Return
None

Optional
Long Index A value of –1

Undeleting A Point
This method will undelete a previously deleted point and computes the model parame-
ters. This option only works for 2d plots.

Note This method does nothing for density versus efficiency plot because you can-
not delete a point from this type of plot.

If Refresh method will be performed after deleting point(s), the component will
erase the current set of deleted point(s) and there will be no point(s) remain
undeleted. (Change I – Remove this comment)

Calling Convention
UnDeletePoint()

Parameters
None

Return
None

Optional
None

Undeleting All Points

This method will undelete all previously deleted point and computes the model parame-
ters. This option only works for 2d plots.

Note This method does nothing for density versus efficiency plot because you can-
not delete a point from this type of plot.

Calling Convention
UnDeleteAll()

Parameters
None

366
 Efficiency Calibration Control

Return
None

Optional
None

Aborting a Computation
Aborts a computation. Computations are performed in a separate thread to prevent the
user interface from locking. This method will terminate the computational thread and re-
store the original calibration parameters. This method will not return until the computa-
tion thread has been terminated.

Calling Convention
AbortComputation()

Parameters
None

Return
None

Optional
None

Changing Axis Limits

These methods will allow you to change or get the plotting limits for either 3 d plot or
normal plot.

Calling Convention
SetPlotLimits (Double MinX, Double MaxX, Double MinY, Double MaxY, Double
MinZ, Double MaxZ)

GetPlotLimits (Double MinX, Double MaxX, Double MinY, Double MaxY, Double
MinZ, Double MaxZ)

Parameters
Double MinX Min x value

Double MaxX Max x value

Double MinY Min y value

Double MaxY Max y value

367
Component Programming Library Reference

Double MinZ Min z value

Double MaxZ Max z value

Optional
Double MinZ A value of 0

Double MaxZ A value of 0

Return
None

Changing the Energy Display Units

This will changed the displayed energy units.

Calling Convention
PutEnergyUnits(String Label, Single ScaleFactor)

GetEnergyUnits(String Label, Single ScaleFactor)

Parameters
String Label The label that is displayed with any parameter that has units of
energy

Single ScaleFactor The energy conversion factor. Base units are in keV. Therefore,
if you want to display eV the conversion factor will be 1000.

Optional
None

Changing the Density Display Units

This will changed the displayed density units.

Calling Convention
PutDensityUnits(String Label, Single ScaleFactor)

GetDensityUnits(String Label, Single ScaleFactor)

Parameters
String Label The label that is displayed with any parameter that has units of
density

Single ScaleFactor The energy conversion factor. Base units are in kg/l.

368
 Efficiency Calibration Control

Optional
None

Printing
A print dialog is displayed to allow the user to print the plot.

Calling Convention
PrintDialog(String Title, String SubTitle, String X, String Y, String Z)

Parameters
String Title (Optional) The plot title or a header label for the spreadsheet
print out.

String SubTitle (Optional) The sub-title on the plot

String X (Optional) The x-axis label

String Y (Optional) The y-axis label

String Z (Optional) The z-axis label

Optional
String Title A value of “”. The plot label on the window is printed.

String SubTitle A value of “”. The plot label on the window is printed.

String X A value of “”. The plot label on the window is printed.

String Y A value of “”.The plot label on the window is printed.

String Z A value of “”.The plot label on the window is printed.

Displaying Changes
This will force the UI to reload the calibration information and display it. This method
should be used to display changes incurred by external modification to the datasource.

Calling Convention
Refresh()

Parameters
None

Optional
None

369
Component Programming Library Reference

Saving Changes
This will store the current changes to the datasource.

Calling Convention
Save()

Parameters
None

Optional
None

Efficiency Calibration Control Phase II Properties

The properties for this component are defined below.

Name Description
DataPointColor Changes the color of the data points
ModelColor Changes the model color
LowDualCurveColor Changes the color of the low dual polynomial
curve
BackgroundColor Changes the background colcr of the plot
AxisAndLabelColor Changes the color of the plot axes and labels
CursorColor Changes the color of the plot cursor
CrossOverColor Changes the colcr of the cross over annotation
line
Is Warning Displays warning message
IsError Displays error message
Message Returns the status message defined by the
status code
AllowEdits Enables/disables edit mode
IsComputing Determines if component is currently
computing
Calibration Determines if the calibration plot is being
displayed
NumberOfPoints Return current number of calibration points

370
 Efficiency Calibration Control

IsModified Return true if the calibration has been modified

Properties Reserved for future use

Data Point Colors

This property allows you to change the color of the data points and error bars.

Calling Convention
DataPointColor

Parameters
None

Optional
None

Return
OLE_COLOR DataPointColor The color

Privilege
Read-Write

Model Color
This property allows you to change the model color.

Calling Convention
ModelColor

Parameters
None

Optional
None

Return
OLE_COLOR ModelColor The color

Privilege
Read-Write

371
Component Programming Library Reference

Low Dual Curve Color

This property allows you to change the color of the low dual polynomial curve.

Calling Convention
LowDualCurveColor

Parameters
None

Optional
None

Return
OLE_COLOR LowDualCurveColor The color

Privilege
Read-Write

Background Color
This property allows you to change the background color of the plot.

Calling Convention
BackgroundColor

Parameters
None

Optional
None

Return
OLE_COLOR BackgroundColor The color

Privilege
Read-Write

Plot Axes And Label Color

This property allows you to change the color of the plot axes and labels.

372
 Efficiency Calibration Control

Calling Convention
AxisAndLabelColor

Parameters
None

Optional
None

Return
OLE_COLOR AxisAndLabelColor The color

Privilege
Read-Write

Cursor Color
This property allows you to change the color of the plot cursor.

Calling Convention
CursorColor

Parameters
None

Optional
None

Return
OLE_COLOR CursorColor The color

Privilege
Read-Write

Cross Over Color

This property allows you to change the color of the cross over annotation line.

Calling Convention
CrossOverColor

373
Component Programming Library Reference

Parameters
None

Optional
None

Return
OLE_COLOR CrossOverColor The color

Privilege
Read-Write

Status Severity
All status messages have a severity associated with them. This severity defines whether a
message is an warning, or error message. There are two properties that may be used to
determine the severity of a message.

Calling Conventions
IsWarning(MessageCodes Code)

IsError(MessageCodes Code)

Parameters
MessageCodes Status The status code to examine for severity level.

Return
Boolean bVal A value of true indicates that the message is of that speci-
fied severity level.

Optional
None

Retrieving Status Messages

This property returns the status message text defined by the status code.

Calling Convention
Message

Parameters
MessageCodes Code The message code to retrieve the status string.

374
 Efficiency Calibration Control

Return
String Message String for the status

Optional
None

Privilege
Read-Only

Activating/Deactivating Edits
This property will activate or deactivate the ability to delete points from the calibration.

Calling Convention
AllowEdits

Parameters
None

Return
Boolean AllowEdits State of edit

Optional
None

Privilege
Read-Write

Determining Computation Status

This property allows you to determine if the component is currently computing. During
computations you cannot make changes that affect the model results.

Calling Convention
IsComputing

Parameters
None

Return
Boolean IsComputing If true then the component is computing.

375
Component Programming Library Reference

Optional
None

Privilege
Read-Only

Determining the Displayed Calibration

This property allows you to determine the calibration plot type that is currently being dis-
played.

Calling Convention
Calibration

Parameters
None

Return
PlotType Calibration The type of calibration

efcEnergyVsEfficiency: Energy vs. Efficiency

efcDensityVsEfficiency: Density vs. Efficiency

efcBoth: Both (i.e., 3-d surface)

Optional
None

Privilege
Read-Only

Number of Calibration Points

This property will return the current number of calibration points.

Calling Convention
NumberOfPoints

Parameters
None

Return
Long NumberOfPoints

376
 Efficiency Calibration Control

Optional
None

Privilege
Read-Only

Modify State
This property will return true if the calibration has been modified.

Calling Convention
IsModified

Parameters
None

Return
Boolean IsModified

Optional
None

Privilege
Read-Only

Properties
This property allows the programmer to set a number of properties that are not defined in
the interface.

Calling Convention
Properties

Parameters
None

Return
See table below.

Optional
None

377
Component Programming Library Reference

Privilege
See table below.

These properties are used to get or set the following properties:

Name Description Rights Type

PeakToTotal If true, the peak-to-total Read-Write Boolean
calibration is displayed
LogX If true, the x-axis is displayed in Read-Write Boolean
log scale
LogY If true, the y-axis is displayed in Read-Write Boolean
log scale
SpreadSheet If true, the data points are Read-Write Boolean
displayed in a spreadsheet
instead of a plot
Maximize If true, the plot is displayed in Read-Write Boolean
full screen

Efficiency Calibration Control Phase II Events

The following outing events are supported.

Processing Asynchronous Message Event

Since this object is multi-threaded, errors need to be reported in an asynchronous manner.
Therefore, error events have been created to solve this problem.

Calling Convention
AsynchronousMessages (ByVal Long Code, ByVal String Message)

Parameters
Long Code The error code which can be passed to the status handler object
(StatHdlr.dll)

String Message The error string

Processing Equation Change Event

This event is fired whenever the calibration has changed.

Calling Convention
EquationChanged (ByVal String Equation)

378
 Efficiency Calibration Control

Parameters

String Equation The new equation

Processing Plot Change Event

This event is fired whenever the plot type has changed.

Calling Convention
PlotChanged (ByVal PlotType Type)

Parameters
PlotType Type The type of plot.

efcEnergyVsEfficiency Energy vs Efficiency

efcDensityVsEfficiency Density vs Efficiency

efcSurface Surface plot

efcOverPlotEnergyVsEfficiency Energy vs Efficiency

overplot

Processing Cursor Change Event

This event is fired whenever the plot cursor has changed graphical position.

Calling Convention
CursorChanged (ByVal Single X, ByVal Single Y, ByVal Single Unc, ByVal Long Row)

Parameters
Single X The x graphical position

Single Y The y graphical position

Single Unc The y-uncertianty

Long Row The spreadsheet row. This is also the CAM record number.

Exported C Routines
This component computes efficiency and multi-curve efficiency using new algorithms. A
new multi-curve analysis engine has been written to use these new algorithms. The origi-
nal multi-curve analysis information may be found in “Software Requirements Specifica-
tion (SRS) for the Q2 Multi-Curve Efficiency Calculation.“ This analysis engine is
exported by this DLL.

379
Component Programming Library Reference

Multi-Curve Efficiency Engine

This routine will perform a multi-curve analysis on a CAM datasource. The routine will
not return until the analysis is complete.

Calling Convention
DWORD MultiCurveComputeDensity (HMEM hDSC, USHORT usPhase, void *pv1,
void *pv2)

Parameters
HMEM hDSC The CAM file handle

USHORT usPhase The analysis phase number

void *pv1 Not used

void *pv2 Not used

Return
DWORD dwStat A status code. 0 indicates success.

Modified CAM Parameters

This section outlines the CAM parameters that are updated when a modification is per-
formed to the calibration points.

The following calibration parameters are modified by the control when a Save is per-
formed.

CAM Parameter Description

CAM_F_DLCALFACi (i=1-6) Dual low energy calibration coeffs
CAM_F_DHCALFACi (i=1-10) Dual high energy calibration coeffs
CAM_G_LERRMATi (i=1-11) Dual low energy reduced covariance matrix
CAM_G_HERRMATi (i=1-19) Dual high energy reduced covariance matrix
CAM_F_DLCALCHI Dual low energy reduced chi-squared
CAM_F_DHCALCHI Dual high energy reduced chi-squred
CAM_F_LNCALFACi (i=1-10) Linear calibration coeffs
CAM_G_LNERRMATi (i=1-19) Linear reduced covariance matrix
CAM_F_LNCHISQ Linear reduced chi-squared
CAM_F_DCALFACi (i=1-7) Empirical calibration coeffs
CAM_F_DEFFEFAC Empirical calibration point residual

380
 Efficiency Calibration Control

CAM Parameter Description

CAM_F_EFFAVERR Empirical calibration average error
CAM_F_EMPCHISQ Empirical reduced chi-squared
CAM_F_AVRGEFF Average efficiency
CAM_F_AVRGEFFERR Average efficiency error
CAM_F_DENERGY Efficiency calibration energy point
CAM_F_DEFF Efficiency calibration efficiency point
CAM_F_DEFFERR Efficiency calibration efficiency error
CAM_F_CWTORDENSI Efficiency calibration density point
CAM_F_CROSSOVER Dual cross over energy
CAM_T_EFFTYPE Efficiency calibration model (energy vs.
efficiency)
CAM_T_EFFDENSTYP Efficiency calibration model (density vs.
efficiency)
CAM_X_DCALTIME The calibration date (changed only for
non-multicurve calibrations)
CAM_L_USEAVRG The use average flag (changed only for
non-multicurve calibrations).
CAM_L_EMPDEGREE Empirical efficiency degree
CAM_L_LNDEGREE Linear efficiency degree
CAM_L_DHDEGREE Dual high energy efficiency degree
CAM_L_DLDEGREE Dual low energy efficiency degree

For the case of Peak-To-Total calibration the following CAM parameters are modified.

CAM Parameter Description

CAM_F_PTCLCALFACi (i=1-6) Dual low energy calibration coeffs
CAM_F_PTCHCALFACi (i=1-10) Dual high energy calibration coeffs
CAM_G_PTCLERRMATi (i=1-11) Dual low energy reduced covariance matrix
CAM_G_PTCHERRMATi (i=1-19) Dual high energy reduced covariance matrix
CAM_F_PTCLCALCHI Dual low energy reduced chi-squared
CAM_F_PTCHCALCHI Dual high energy reduced chi-squred
CAM_F_PTCENERGY Efficiency calibration energy point

381
Component Programming Library Reference

CAM Parameter Description

CAM_F_PTCEFF Efficiency calibration efficiency point
CAM_F_PTCDEFF Efficiency calibration efficiency error
CAM_F_PTCCROSSOVER Dual cross over energy
CAM_L_PTCHDEGREE Dual high energy efficiency degree
CAM_L_PTCLDEGREE Dual low energy efficiency degree

Multi-Curve Efficiency Engine UI

The user interface for the multi-curve engine has been enhanced to allow the user to se-
lect the density vs. efficiency model.

A new DLL contains this user interface, MultiCurveUI.dll. The functionality of each con-
trol is tabulated below.

Control Description CAM Parameter

Energy Vs. Efficiency Cal Type Defines the energy vs. CAM_T_EFFTYPE
Effic. Cal
Efficiency Vs. Density Cal Type Defines the density vs. CAM_T_PRCEFFDENSTYP
Effic. Cal
Denisty Defines the density CAM_F_SCWT
Generate Report Generates a post CAM_L_EXPAUTOREP
analysis report

Associated with each control is a CAM parameter. This parameter contains the value that
will be used in the analysis.

After the analysis executes the density vs. efficiency model that was used during the
analysis may have changed. The CAM parameter that defines the density vs. efficiency
model that was used is CAM_T_EFFDENSTYP. The reason why this model may have
changed is because the fitting process may have failed for more than half the number of
energy points.

382
 Energy Calibration Control

Energy Calibration Control

A generic spectroscopic calibration component library has been developed that will per-
form energy and shape calibrations. The component library is capable of fitting the en-
ergy and shape calibration models for Energy, Shape, and FWHM models. There are two
phases for this component: Phase I and Phase II.

Energy calibration phase I allows you to select the peaks to use for energy and shape cal-
ibration and displays them. These peaks are then quantified via peak area analysis. The
results are displayed in a spreadsheet. This component used to select the peaks of interest
and a spreadsheet to display the selected peak information. This component is illustrated
below.

Energy calibration phase II is subset of Energy calibration phase I. Energy calibration

phase II displays the energy and shaped calibration based on the peaks selected from
phase I. This component consists of a plot that allows you to delete points from the cali-
bration. It also allow you to correlate the calibration data with the spectrum.

Using the Energy Calibration Phase I Component

This component may be added to a VB project by selecting “Project”-“Components”.
The Components dialog box is displayed; select “Canberra Energy Calibration Library”.
Select the icon shown in Figure 23.

Figure 23 Energy
Calibration Icon

The initial user interface that is displayed when the component is dropped onto a VB
form.

Energy Calibration Control Phase I Methods

The methods are summarized below.

383
Component Programming Library Reference

Datasource Management

Open Opens the datasource and displays efficiency

calibration information
Close Closes the datasource
Save Save all datasource changes

Cursors, Markers, and ROIs

Cursor Associates a highlited energy Value with a

channel
Marker Computes the FWHM and low tail parameters
based on the ROI position
NextRoi Moves the ROI cursors to the next ROI pair.
For neutron data the next histogram record or
scalar bank is displayed.
PreviousRoi Moves the ROI cursors to the previous ROI
pair. For neutron data the previous histogram
record or scalar bank is displayed.

Detector Controls

Start Starts the detector

Stop Stops the detector
Clear Clears the detector
Adjust Allows the detector hardware to be adjusted during
calibration

Energy Calibration Data

Add Adds a point to the calibration list

Delete Removes a point from the calibration list
Automatic Quantifies the centroid, FWHM, and low energy
tails for all points
MergeEfficiency Merges efficiency calibration records

384
 Energy Calibration Control

Refresh Changes the Efficiency Calibration user interface

PutEnergyUnits Sets the energy display units
GetEnergyUnits Gets the energy display units

Export Data

PrintDialog Displays a print dialog

Opening a Datasource
This method opens the datasource and displays the energy calibration information. The
datasource does not have to be populated with calibration points before open is called. A
datasource may be opened with a remote VDM using the CamDatasource interface, see
“Canberra CamDatasource Component (SDD).”

Calling Convention
Open(Variant Source, EcalOpenOptions Options, SourceType Type)

Parameters
Variant Source The datasource to open. If this is a file name (i.e., String)
then the open options are used. If this is a DataAccess,
DeviceAccess, or CamDatasource object the datasource is
reopened.

EcalOpenOptions Options (Optional) The open options

ecReadOnly: Open read only. Note: You can-

not delete points if the file is
opened read only.

ecReadWrite: Open read-write. This is a pro-

cess read write open. Therefore,
another component can open the
component in the same process
only.

ecDirectAccess: NOT SUPPORTED. (Change VI)

SourceType Type (Optional) The type of datasource.

ecFile: A CAM file

ecDetector: A detector

385
Component Programming Library Reference

Optional
EcalOpenOptions Ops A value of efcReadOnly

DataSource Type A value of ecFile

Closing a Datasource
This method closes the datasource.

Calling Convention
Close(EcalCloseOptions Options)

Parameters
EcalCloseOptions Options (Optional) The close options.

ecNoUpdate: Changes are not flushed to the

file.

ecUpdate: Changes are flushed to the file.

Optional
EcalCloseOptions Ops A value of ecNoUpdate

Adding A Point
This method adds a point to the calibration list. The point energy value must be manually
entered in the last row of the spreadsheet and then select add. A point may be added only
when the last row is highlighted in the spreadsheet. A message is sent via the event sink
to signal when adding a point is allowable; this event is ChangesAllowed.

Calling Convention
Add()

Parameters
None

Return
None

Deleting A Point
This method deletes a point from the calibration list. A point may be deleted only when
an energy point in the spreadsheet is highlighted. A message is sent via the event sink to
signal when deleting a point is allowable; this event is ChangesAllowed.

386
 Energy Calibration Control

Calling Convention
Delete()

Parameters
None

Return
None

Optional
None

Cursor
This method will associate the highlighted energy value with a channel on the Mvc. This
method will throw an error if a peak could not be fitted to the spectral region defined by
the cursor.

The ROI is determined based on an estimation of the FWHM based on the peak centroid
channel counts. This ROI is then used as an input parameter to the peak area engine that
computes the FWHM, low energy tail position, and peak centroid.

Calling Convention
Cursor()

Parameters
None

Return
None

Optional
None

Markers
This will compute the FWHM and low tail parameters based on the ROI marker position
on the Mvc display. An energy value must be highlighted in the spreadsheet. This
method will throw an error if a peak could not be fitted to the spectral region defined by
the markers.

The left and right ROI markers are used to define the ROI that is used as an input to the
peak area engine. The peak area engine computes the FWHM, low energy tail position,
and peak centroid.

387
Component Programming Library Reference

Calling Convention
Markers()

Parameters
None

Return
None

Optional
None

Automatic Calibration
These methods will quantify the centroid, FWHM, and low energy tail for all points in
the spreadsheet. This method will throw an error if a peak could not be fitted to a spectral
region defined in the list. The calibration point that could not be quantified will be high -
lighted.

For each peak centroid the ROI is determined based on an estimation of the FWHM
based on the peak centroid channel counts. Each ROI is then used as an input parameter
to the peak area engine that computes the FWHM, low energy tail position, and peak cen-
troid for each peak centroid in the spreadsheet.

Calling Convention
Automatic()

Parameters
None

Optional
None

Return
None

Detector Controls
These methods will control the detector. Start, stop, and clear control the acquisition of
data. Adjust will display a dialog so the hardware may be adjusted during a calibration.

Calling Conventions
Start()

388
 Energy Calibration Control

Stop()

Clear()

Adjust()

Parameters
None

Optional
None

Move ROI Cursors

These methods will allow you to move the ROI cursors to the next or previous ROI in the
Mvc display portion of the component.

Calling Conventions
NextRoi()

PreviousRoi()

Parameters
None

Return
None

Saving Changes
This will store the current changes to the datasource.

Calling Conventions
Save()

Parameters
None

Optional
None

389
Component Programming Library Reference

Displaying Changes
This will force the UI to reload the calibration information and display it. This method
should be used to display changes incurred by external modification to the datasource

Note On “Refresh”, the component will discard all the unsaved changes, made to the
CAM file.

Calling Convnetion
Refresh()

Parameters
None

Optional
None

Changing the Energy Display Units

This will changed the displayed energy units

Calling Conventions
PutEnergyUnits(String Label, Single ScaleFactor)

GetEnergyUnits(String Label, Single ScaleFactor)

Parameters
String Label The label that is displayed with any parameter that has
units of energy

Single ScaleFactor The energy conversion factor. Base units are in keV.
Therefore, if you want to display eV the conversion factor
will be 1/1000. (Change I)

Optional
None

Printing
A print dialog is displayed to allow the user to print the calibration plot or the calibration
spreadsheet.

Calling Convention
PrintDialog(String Title, String SubTitle, String X, String Y)

390
 Energy Calibration Control

Parameters
String Title (Optional) The plot title or a header label for the spread-
sheet print out.

String SubTitle (Optional) The sub-title on the plot.

String X (Optional) The x-axis label.

String Y (Optional) The y-axis label.

Optional
String Title A value of “”. The plot label on the window is printed.

String SubTitle A value of “”. The plot label on the window is printed.

String X A value of “”. The plot label on the window is printed.

String Y A value of “”.The plot label on the window is printed.

Energy Calibration Phase I Properties

The properties for this component are defined below.

Name Description
Certificate Sets or gets the reference peak
Reference Peak Sets or removes the reference peak
Is Warning Displays warning message
IsError Displays error message
Message Returns the status message defined by the
status code
AllowEdits Enables/disables edit mode
EditAllPoints Enables/disables the ability to change all
calibration points in the spreadsheet
NumberOfPoints Return current number of calibration points
IsModified Return true if the calibration has been modified
Properties Reserved for future use
LinearScale Activates linear scaling
Expand Activates expand mode
DisplayType Sets or gets cuurent display type

391
Component Programming Library Reference

RecalibMode Enables/disables recalibration mode

AutoScale Enables/disables autoscale mode

Certificate
This property will set or get the certificate name for the datasource. When the certificate
is assigned to the datasource the certificate is opened and the certificate points are added
to the datasource. If the datasource already has calibration points, the certificate points
are appended to the datasource. If the datasource has points that match the certificate
points, you are prompted to overwrite or skip the calibration point.

Note: The CAM Parameters CAM_F_VARECALTOL and CAM_F_ECALTOL are

used to define the energy tolerance for the certificate peak energy match. The
criterion used to define a peak match search all peak energies in the datasource
and find the minimum difference between the datasource energy and the certif-
icate energy. If the minimum difference is less than or equal to the tolerance
the certificate energy is added to the datasource. If the minimum difference is
equal to 0 then the certificate point matches a peak in the datasource and a
message box informs you of this. You can replace the calibration point or skip
this certificate energy.

Calling Convention
Certificate

Parameters
None

Return
String Certificate

Privilege
Read-Write

Reference Peak
This property will set or remove the reference peak. The reference peak is defined when
the input focus is on the row that represents the peak and this property is assigned a value
of true. The text in this row is highlighted when the reference peak has been set. To re-
move a reference peak you can set the input focus on the current reference peak row and
set the value of this property to false. When the text has been change from bold to normal
the reference peak has been removed.

392
 Energy Calibration Control

Calling Convention
RefencePeak

Parameters
None

Return
Boolean ReferencePeak If true, the current highlighted peak is set as the reference
peak.

Privilege
Read-Write

Status Severity
All status messages have a severity associated with them. This severity defines whether a
message is a warning or error message. There are two properties that may be used to de-
termine the severity of a message.

Calling Conventions
IsWarning(MessageCodes Code)

IsError(MessageCodes Code)

Parameters
MessageCodes Status The status code to examine for severity level.

Return
Boolean bVal A value of true indicates that the message is of that speci-
fied severity level.

Optional
None

Retrieving Status Message

This property returns the status message text defined by the status code.

Calling Convention
Message

Parameters
MessageCodes Code The message code to retrieve the status string.

393
Component Programming Library Reference

Return
String Message String for the status.

Optional
None

Privilege
Read-Only

Activating/Deactivating Edits
This property will activate or deactivate the ability to change calibration points.

Calling Convention
AllowEdits

Parameters
None

Return
Boolean AllowEdits State of edit

Optional
None

Privilege
Read-Write

Editing Spreadsheet Calibration Points

This property will activate or deactivate the ability to change all the calibration points in
the spreadsheet. If false the only point that may be manually entered is the energy value.

Calling Convention
EditAllPoints

Parameters
None

Return
Boolean EditAllPoints State of edit

394
 Energy Calibration Control

Optional
None

Privilege
Read-Write

Number of Calibration Points

This property will return the current number of calibration points. This returns the num-
ber of points that are used to determine the calibration coefficients. This implies that the
reference peak, 511 keV peak, and any channel, energy, FWHM, or low tail value that is
less than floating point minimum are not included in this number. The number of calibra-
tion records may be determined by performing a record count on the datasource after that
save method is called.

Calling Convention
NumberOfPoints

Parameters
None

Return
Long NumberOfPoints

Optional
None

Privilege
Read-Only

Modify State
This property will return true if the calibration has been modified.

Calling Convention
IsModified

Parameters
None

Return
Boolean IsModified

395
Component Programming Library Reference

Optional
None

Privilege
Read-Only

Properties
This property allows for future expansion of the property list. It currently supports the
following.

Name Description Access Type

MvcExpandBox Enable/Disable expand Read-Write Boolean
box
MvcLogYScale Enable/Disable logarithm y Read-Write Boolean
–axis scaling
MvcPlotBorders Enable/Disable the Read-Write Boolean
displaying of plot borders
on the Mvc display
DeviceCmd Execute a device Write-Only EcalDeviceCommand
command
Adjust Displays the hardware Write-Only Boolean
adjust dialog
UpdateRate The update rate in Read-Write Long
milliseconds for the Mvc
display

Calling Convention
PropertiesParameters

Parameters
None

Return
See table above.

Optional
None

396
 Energy Calibration Control

Privilege
See table above

Linear/Log Scale
This property allows to switch display from linear to log and vice versa. If True means
set to linear scale else set to log scale. (Valid only for Spectrum Display).

Calling Convention
LinearScale

Parameters
None

Return
Boolean LinearScale Current scale

Optional
None

Privilege
Read-Write

Expand On/Off
This property allows to turn on/off expand mode. (Valid only for Spectrum Display).

Calling Convention
Expand

Parameters
None

Return
Boolean Expand Current mode

Optional
None

Privilege
Read-Write

397
Component Programming Library Reference

Display Type
This property allows to set current display type or get current display type. (Valid only
for Spectrum Display).

Calling Convention
DisplayType

Parameters
None

Return
int DisplayType Current display type:

0 – Normal Plot
1 – Full Plot
2 – Fill Plot
3 – Envelope Plot

Optional
None

Privilege
Read-Write

Recalibration Mode On/Off

This property allows to turn on/off Recalibration mode. User is allowed to set this mode
only before opening datasource. By setting this flag will prevent modification of Energy
and Shaped calibration. By default this mode is false.

Calling Convention
RecalibMode

Parameters
None

Return
Boolean RecalibMode Current recalibration mode

Optional
None

398
 Energy Calibration Control

Privilege
Read-Write

Auto Scale On/Off

This property allows to turn on/off auto scale mode. (Valid only for Spectrum Display).

Calling Convention
AutoScale

Parameters
None

Return
Boolean AutoScale Current scale mode

Optional
None

Privilege
Read-Write

Energy Calibration Phase I Events

The following outgoing events are supported.

Processing Asynchronous Message Event

Since this object is multi-threaded, errors need to be reported in an asynchronous manner.
Therefore, error events have been created to solve this problem.

Calling Convention
AsynchronousMessages (ByVal Long Code, ByVal String Message)

Parameters
Long Code The error code which can be passed to the status handler object
(StatHdlr.dll).

String Message The error string

Processing Enable Change Event

This event is fired whenever the spreadsheet is ready to delete or add a point.

399
Component Programming Library Reference

Calling Convention
ChangesAllowed (ByVal Long ChangeOption, ByVal Long State)

Parameters
Long ChangeOption Indicates which options is enabled Delete or Add

0: Implies delete option

1: Implies add option
2: Implied Auto Calibration mode
Long State Defines whether the option is enabled or disabled.

0: Implies disabled
1: Implies enabled

Processing Mvc Cursor Moves

This event is fired whenever the Mvc peak cursor is moved.

Calling Convnetion
CursorMove (ByVal Single PeakEnergy, ByVal Long PeakChan, ByVal Single
LeftRoiEnergy, ByVal Long LeftRoiChan, ByVal Single RightRoiEnergy,
ByVal Long RightRoiChan)

Parameters
Single Energy The energy value at the peak cursor (keV).

Long Chan The channel value at the cursor.

Single LeftRoiEnergy The left ROI energy (keV).

Long LeftRoiChan The left ROI channel.

Single RightRoiEnergy The right ROI energy (keV).

Long RightRoiChan The right ROI channel.

Processing Cell Selection Event

This event is fired whenever you select a cell on the spreadsheet.

Calling Convention
CellSelected(ByVal Long Row, ByVal Long Col)

Parameters
Long Row The row

Long Col The column

400
 Energy Calibration Control

Processing Computation Completed Event

Whenever the Compute method is called, computations are performed asynchronously.
The end of computations may be determined by catching this event. This event is sent
only when computations are computed using the following methods (DeletePoint,
DeletePointEx, UnDeletePoint, UnDeletePointEx, UnDeleteAllPoints,
UnDeleteAllPointEx, and Compute).

Calling Convention
ComputationComplete(ByVal Boolean Success)

Parameters
Boolean Success Success or failure of computation.

Modified CAM Parameters for Energy Calibration Phase I

This section outlines the CAM parameters that are updated when a modification is per-
formed to the calibration points.

The following calibration parameters are modified by the control when a Save is per-
formed.

CAM Parameter Description

CAM_F_CALENERGY Energy calibration energy value
CAM_F_CALCENTROID Energy calibration centroid value
CAM_F_CALCENTERR Energy calibration centroid error
CAM_F_CALFWHM The computed FWHM value based on the current
energy calibration at the energy point.
CAM_L_CALFLAGS Energy calibration flags
CAM_F_SCENERGY The shape calibration energy value (equal to
CAM_F_CALENERGY)
CAM_F_SCFWHM The FWHM calibration point. This is computed via
peak area analysis at the peak centroid
(CAM_F_CALCENTROID)
CAM_F_SCFWHMERR The FWHM error.
CAM_F_SCTAIL1 The low tail calibration point. This is computed via
peak are analysis at the peak centroid
(CAM_F_CALCENTROID)
CAM_F_SCTAIL1ERR The low tail calibration error
CAM_F_SCTAIL2 Set to 0.0 (not used)

401
Component Programming Library Reference

CAM Parameter Description

CAM_F_SCTAIL2ERR Set to 0.0 (not used)
CAM_L_SCFLAGS The shape calibration flags. The mask
CAM_M_SCF_REFPEAK is used to define the
reference peak
CAM_L_SCSTART The left ROI used to compute FWHM and low tail
via peak area analysis
CAM_L_SCEND The right ROI used to compute FWHM and low tail
via peak area analysis.
CAM_T_EXPCERT The certificate

Algorithms for Energy Calibration Phase I

The heart of the computations is performed using lEncal1. This function is an old Genie
routine that is used to determine the centroid, FWHM, and low energy tail based on the
peak region of interest. See the Genie 2000 Operations Manual for more details.

Using the Energy Calibration Phase II Component

This component may be added to a VB project by selecting “Project”-“Components”.
The Components dialog box is displayed; select “Canberra Energy Calibration Library”.
Select the icon shown in Figure 24.

Figure 24 Energy
Calibration Icon

The initial user interface that is displayed when the component is dropped onto a VB
form.

402
 Energy Calibration Control

Note The data source must be populated with energy calibration points; this implies
the Energy Calibration Phase I must have been performed. All calculations are
based on energy and shape calibration points.

Energy Calibration Control Phase II Data Types

Energy Calibration Control Phase II defines the following enumeration types.

This section tabulates all of the enumeration types this component exports.

Name Description

EcalOpenOptions The data source open options

EcalCloseOptions The data source close options

DataSource The data source types

MessageCodes Component Error/Warning messages

EcalDeviceCommand The command to send to a detector.

Energy Calibration Control Phase II Methods

The methods are summarized below.

Operaton Desription
Open Opens the datasource and displays energy
calibration information
Close Closes the datasource
DeletePoint Deletes the calibration point the plot cursor is
on
UnDeletePoint Restores previously deleted calibration point
UnDeleteAll Restores all previously deleted calibration
points
SetPlotLimits Changes the plot limits
GetPlotLimits Gets the current plot limits
PrintDialog Displays a print dialog

403
Component Programming Library Reference

Operaton Desription
Save Save all datasource changes
Refresh Changes the Energy Calibration user interface

Opening a Data Source

This method opens the data source and displays the energy calibration information. The
data source must be populated with calibration points before calling this method. If you
do not have calibration points, the component will throw an error.

Calling Convention
Open(Variant Source, EcalOpenOptions Options, SourceType Type)

Parameters
Variant Source The data source to open. If this is a file name (i.e., String)
then the open options are used. If this is a DataAccess,
DeviceAccess or CamDatasource object, the data source is
reopened.

EcalOpenOptions Options (Optional) The open options.

ecReadOnly: Open read only. Note: You can-

not delete points if the file is
opened read only.

ecReadWrite: Open read-write. This is a pro-

cess read write open. Therefore,
another component can open the
component in the same process
only.

ecDirectAccess: Open with direct file access. This

implies that the VDM is by-
passed. This option improves the
speed of data transactions by a
factor of ten.

SourceType Type (Optional) The type of data source.

ccFile: A CAM file

ecDetector: A detector

Closing a Data Source

This method closes the data source.

404
 Energy Calibration Control

Calling Convention
Close(EcalCloseOptions Options)

Parameters
EcalCloseOptions Options (Optional) The close options.

ecNoUpdate: Changes are not flushed to the

file.

ecUpdate: Changes are flushed to the file.

Deleting A Point
This method deletes the calibration point that the plot cursor is on and computes the cali-
bration parameters.

Note The number of energy and shape points must be equal. Therefore, when a point
is deleted from one calibration type the other types have the associated point
removed and the calibrations are computed. Also, the shape calibration points
are based on using the energy calibration slope parameter. Therefore, when a
point is deleted the energy calibration must be recomputed. Then the energy
calibration slope is used to determine the shape calibration points. Finally, the
shape calibration is computed.

Calling Convention
DeletePoint(Long Index)

Parameters
Long Index (Optional) The index of the data point to delete. If –1 is
specified, the cursor location is used

Return
None

Optional
Long Index A value of –1

Undeleting A Point
This method will undelete a previously deleted calibration point and computes the cali-
bration parameters.

405
Component Programming Library Reference

Note The number of energy and shape points must be equal. Therefore, when a point
is undeleted from one calibration type the other types have the associated point
added and the calibrations are computed. Also, the shape calibration points are
based on using the energy calibration slope parameter. Therefore, when a point
is undeleted the energy calibration must be recomputed. Then the energy cali-
bration slope is used to determine the shape calibration points. Finally, the
shape calibration is computed.

Calling Convention
UnDeletePoint()

Parameters
None

Return
None

Optional
None

Undeleting All Points

This method will undelete all previously deleted calibration points and computes the cali-
bration parameters.

Note The number of energy and shape points must be equal. Therefore, when all
points are undeleted from one calibration type the other types have all points
undeleted and the calibrations are computed. Also, the shape calibration points
are based on using the energy calibration slope parameter. Therefore, when all
points are undeleted the energy calibration must be recomputed. Then the en-
ergy calibration slope is used to determine the shape calibration points. Finally,
the shape calibration is computed.

Calling Convnetion
UnDeleteAll()

Parameters
None

Return
None

Optional
None

406
 Energy Calibration Control

Changing Axis Limits

These methods will allow you to change or get the plotting limits for calibration plot.

Calling Conventions
SetPlotLimits(Double MinX, Double MaxX, Double MinY, Double MaxY)

GetPlotLimits(Double MinX, Double MaxX, Double MinY, Double MaxY)

Parameters
Double MinX Min x value.

Double MaxX Max x value.

Double MinY Min y value.

Double MaxY Max y value.

Optional
None

Return
None

Printing
A print dialog is displayed to allow the user to print the calibration plot or the calibration
spreadsheet.

Calling Convention
PrintDialog(String Title, String SubTitle, String X, String Y)

Parameters
String Title (Optional) The plot title or a header label for the spread-
sheet print out.

String SubTitle (Optional) The sub-title on the plot.

String X (Optional) The x-axis label.

String Y (Optional) The y-axis label.

Optional
String Title A value of “”. The plot label on the window is printed.

String SubTitle A value of “”. The plot label on the window is printed.

407
Component Programming Library Reference

String X A value of “”. The plot label on the window is printed.

String Y A value of “”.The plot label on the window is printed.

Saving Changes
This will store the current changes to the data source.

Calling Convention
Save()

Parameters
None

Optional
None

Displaying Changes
This will store the force the UI to reload the calibration information and display it. This
method should be used to display changes incurred by external modification to the data
source.

Calling Convention
Refresh()

Parameters
None

Optional
None

Energy Calibration Control Phase II Properties

The properties for this component are defined below.

Name Description
FwhmColor Changes the color of the data points
Low/TailColor Changes the color of the error bars
EnergyColor Changes the color of the model

408
 Energy Calibration Control

BackgroundColor Changes the background colcr of the

calibration plot
AxisAndLabelColor Changes the color of the plot axes and labels
CursorColor Changes the color of the plot cursor
Is Warning Displays warning message
IsError Displays error message
Message Returns the status message defined by the
status code
AllowEdits Enables/disables edit mode
IsComputing Determines if component is currently
computing
NumberOfPoints Return current number of calibration points
IsModified Return true if the calibration has been modified
Properties Reserved for future use

Calibration Colors
This property allows you to change the color of the data points, error bars and model for
a particular calibration.

Calling Conventions
FwhmColor

LowTailColor

EnergyColor

Parameters
None

Return
OLE_COLOR Color The color

Privilege
Read-Write

409
Component Programming Library Reference

Background Color
This property allows you to change the background color of the calibration plot.

Calling Convention
BackgroundColor

Parameters
None

Return
OLE_COLOR BackgroundColor The color

Privilege
Read-Write

Plot Axes And Label Color

This property allows you to change the color of the plot axes and labels of the calibration
plot.

Calling Convention
AxisAndLabelColor

Parameters
None

Return
OLE_COLOR AxisAndLabelColor The color

Privilege
Read-Write

Cursor Color
This property allows you to change the color of the plot cursor of the calibration plot.

Calling Convention
CursorColor

Parameters
None

410
 Energy Calibration Control

Return
OLE_COLOR CursorColor The color

Privilege
Read-Write

Status Severity
All status messages have a severity associated with them. This severity defines whether a
message is a warning or error message. There are two properties that may be used to de-
termine the severity of a message.

Calling Convnetion
IsWarning(MessageCodes Code)

IsError(MessageCodes Code)

Parameters
MessageCodes Status The status code to examine for severity level.

Return
Boolean bVal A value of true indicates that the message is of that speci-
fied severity level.

Retrieving Status Messages

This property returns the status message text defined by the status code.

Calling Convention
Message

Parameters
MessageCodes Code The message code to retrieve the status string.

Return
String Message String for the status

Privilege
Read-Only

Activating/Deactivating Edits
This property will activate or deactivate the ability to delete points from the calibration.

411
Component Programming Library Reference

Calling Convention
AllowEdits

Parameters
None

Return
Boolean AllowEdits State of edit

Privilege
Read-Write

Determining Computation Status

This property allows you to determine if the component is currently computing. During
computations you cannot make changes that affect the model results.

Calling Convention
IsComputing

Parameters
None

Return
Boolean IsComputing If true then the component is computing.

Privilege
Read-Only

Number of Calibration Points

This property will return the current number of calibration points that have been used to
compute the calibration coefficients. This implies that the reference peak, 511 keV peak,
deleted points, and any channel, energy, FWHM, or low tail value that is less than float-
ing point minimum are not included in this number.

Calling Convnetion
NumberOfPoints

Parameters
None

412
 Energy Calibration Control

Return
Long NumberOfPoints

Optional
None

Privilege
Read-Only

Modify State
This property will return true if the calibration has been modified.

Calling convention
IsModified

Parameters
None

Return
Boolean IsModified

Optional

None

Privilege
Read-Only

Properties
This property allows the programmer to set a number of properties that are not defined in
the interface.

Calling Convention
Properties

Parameters
None

Return
See table below.

413
Component Programming Library Reference

Optional
None

Privilege
See table below.

These properties are used to get or set the following properties:

Name Description Rights Type

MvcExpandBox Enable/Disable the Mvc expand Read-Write Boolean
box
PlotEvaluateFWHM Switches the plot cursor to the Read-Write Boolean
FWHM if True. Otherwise,
switches the plot cursor to the
low tail calibration curve
MvcLogYScale Changes the Mvc y-axis scaling Read-Write Boolean
to linear or logarithm
MvcPlotBorders Displayes the Mvc plot boarders Read-Write Boolean
TrackPoints If True the plot cursor moves Read-Write Boolean
from data point to data point.
Otherwise, the plot cursor
moves along the calibration
curve
SpreadSheet If true, the data points are Read-Write Boolean
displayed in a spreadsheet
instead of a plot
UpdateRate The update rate in milliseconds Read-Write Long
for the Mvc display

Energy Calibration Control Phase II Events

The following outing events are supported.

Processing Asynchronous Message Event

Since this object is multi-threaded, errors need to be reported in an asynchronous manner.
Therefore, error events have been created to solve this problem.

Calling Convention
AsynchronousMessages (ByVal Long Code, ByVal String Message)

414
 Energy Calibration Control

Parameters
Long Code The error code which can be passed to the status handler
object (StatHdlr.dll)

String Message The error string

Processing Computation Completed Event

Whenever the Compute method is called, computations are performed asynchronously.
The end of computations may be determined by catching this event. This event is sent
only when computations are computed using the following methods (DeletePoint,
DeletePointEx, UnDeletePoint, UnDeletePointEx, UnDeleteAllPoints,
UnDeleteAllPointEx, and Compute).

Calling Convention
ComputationComplete(ByVal Boolean Success)

Parameters
Boolean Success Success or failure of computation

Modified CAM Parameters for Phase II

This section outlines the CAM parameters that are updated when a modification is per-
formed to the calibration points.

The following calibration parameters are modified by the control when a Save is per-
formed.

CAM Parameter Description

CAM_F_CALENERGY Energy calibration energy value
CAM_F_CALCENTROID Energy calibration centroid value
CAM_F_CALCENTERR Energy calibration centroid error
CAM_F_CALFWHM The computed FWHM value based on the current
energy calibration at the energy point.
CAM_L_CALFLAGS Energy calibration flags
CAM_F_SCENERGY The shape calibration energy value (equal to
CAM_F_CALENERGY)
CAM_F_SCFWHM The FWHM calibration point. This is computed via
peak area analysis at the peak centroid
(CAM_F_CALCENTROID)

415
Component Programming Library Reference

CAM Parameter Description

CAM_F_SCFWHMERR The FWHM error.
CAM_F_SCTAIL1 The low tail calibration point. This is computed via
peak are analysis at the peak centroid
(CAM_F_CALCENTROID)
CAM_F_SCTAIL1ERR The low tail calibration error
CAM_F_SCTAIL2 Set to 0.0 (not used)
CAM_F_SCTAIL2ERR Set to 0.0 (not used)
CAM_L_SCFLAGS The shape calibration flags. The mask
CAM_M_SCF_REFPEAK is used to define the
reference peak
CAM_L_SCSTART The left ROI used to compute FWHM and low tail
via peak area analysis
CAM_L_SCEND The right ROI used to compute FWHM and low tail
via peak area analysis.
CAM_F_ECOFFSET Energy calibration offset
CAM_F_ECSLOPE Energy calibration slope
CAM_F_ECQUAD Energy calibration quadratic
CAM_F_FWHMOFF FWHM calibration offset
CAM_F_FWHMSLOPE FWHM calibration slope
CAM_F_C1TAIL1 Low tail calibration offset
CAM_F_C2TAIL1 Low tail calibration slope
CAM_F_ECALCHISQ Energy calibration reduced chi-square
CAM_F_FWHMCHISQ FWHM calibration reduced chi-square
CAM_F_TAIL1CHISQ Low tail calibration reduced chi-square
CAM_X_ECALTIME Energy calibration date
CAM_X_SCALTIME FWHM calibration date
CAM_ASFBADCAL Bad calibration flag (set to 0 cleared)

CAM Dialog Control

A component library has been developed that can be used to display a dialog to load and
save CAM formatted. These dialogs allow you to browse through directories that contain

416
 CAM Dialog Control

CAM data files. These dialogs allow you to view data files, detectors, counters, nuclide
libraries, certificates, calibration files, and ROI files.

These dialogs do not load the datasource they simply provide a user interface for you to
list various types of datasource to load into your application. The dialogs will return the
information that has been entered into the user interface. This information you can use to
load the datasource into your application.

This component may be added to a VB project by selecting “Project”-“Components”

then the Components dialog, select “Canberra Open/Save Dialog Library”. An icon simi-
lar to the one in Figure 25 will appear in the VB toolbar.

Figure 25 Open/Save
Icon

Double click on this icon and it will appear on your VB form. This icon will appear only
during design time. There are no properties visible in the property toolbar list: all proper-
ties and methods become visible during coding.

CAM Dialog Control Data Types

CAM Dialog Control defines the following enumeration types:

DataSourceOpenMask The datasource open dialog masks

DataSourceSaveMask The datasource save as dialog masks

DataSourceCalMask Datasource calibration masks

ServerType The types of VDM servers

OpenDataSourceType The type of datasource

417
Component Programming Library Reference

CAM Dialog Control Methods

The methods are summarized below.

Operation Description
OpenDataSource Opens all files, counters, or detectors
OpenROI Opens all ROI files
OpenCalibration Opens all calibration files
OpenCertificate Opens all certificate files
OpenNuclideLib Opens all nuclide library files
SaveAs Save all

Note The following sections will display the calling format for each property and
method supported by this component interface. All calling formats and exam-
ples are displayed using Visual Basic notation.

Open Datasource Dialog

This method displays a dialog that will list all of the files, counters, or detectors on you
system in the specified directory path.

Calling Convention
OpenDataSource (Boolean Cancelled, String File, Boolean ReadOnly,
OpenDataSourceType Type, DataSourceOpenMask Mask, String Title,
String Dir, String Extension, String HelpFile, Long Type, Long
ConfigRec, String ShellId)

Parameters
Boolean Cancelled (Out) Returns true if the user canceled the dialog.

String File (Out) The datasource that was selected.

Boolean ReadOnly (Out) Returns true if the read-only check box was se-
lected.

OpenDataSourceType Type (Out) Returns the type of datasource.

camdlgFile: File

camdlgDetector: Detector

DataSourceOpenMask Mask The options:

camdlgShowCamFileRadio Show file radio

button

418
 CAM Dialog Control

camdlgShowCamDetectorRadio Show detector radio

button

camdlgShowCamCounterRadio Show counter radio

button

camdlgShowReadOnlyCheck Show read-only

check box

camdlgShowInfo Show information

view

camdlgOpenDefault Default options

which is
camdlgShowCamFile
Radio|
camdlgShowCamDet
ectorRadio|
camdlgShowReadOn
lyCheck|
camdlgShowInfo

String Title The title on the dialog.

String Dir The open directory. If is “” then the Genie-2K CAM file
directory is used.

String Extension The file extension.

String Helpfile The name of the help file.

Long Type (Out) The type of VDM

camdlgTypeB: Local VDM

camdlgTypeF: Type ‘F’

camdlgTypeM: Remote VDM

Long ConfigRec (Out) The configuration record.

String ShellId The shell ID.

Optional
DataSourceOpenMask Mask A value of camdlgOpenDefault

String Title A value of “”

String Dir A value of “”

String Extension A value of “*.cnf”

String Helpfile A value of “”

419
Component Programming Library Reference

Long Type A value of NULL

Long ConfigRec A value of NULL

String ShellId A value of “”

Open ROI File Dialog

This method displays a dialog that will list all of the ROI files.

Calling Convention
OpenROI (Boolean Cancelled, String File, Boolean ByEnergy, String Title, String Dir,
String HelpFile, Long Type, Long ConfigRec, String ShellId)

Parameters
Boolean Cancelled (Out) Returns true if the user canceled the dialog.

String File (Out) The datasource that was selected.

Boolean ByEnergy (Out) Returns true if the energy check box was selected.

String Title The title on the dialog.

String Dir The open directory. If is “” then the Genie-2K CAM file di-
rectory is used.

String Helpfile The name of the help file.

Long Type (Out) The type of VDM

camdlgTypeB: Local VDM

camdlgTypeF: Type ‘F’

camdlgTypeM: Remote VDM

Long ConfigRec (Out) The configuration record.

String ShellId The shell ID.

Optional
String Title A value of “”

String Dir A value of “”

String Helpfile A value of “”

Long Type A value of NULL

Long ConfigRec A value of NULL

420
 CAM Dialog Control

String ShellId A value of “”

Calibration File Dialog

This method displays a dialog that will list all of the calibration files.

Calling Convention
OpenCalibration (Boolean Cancelled, String File, Boolean Energy, Boolean Efficiency,
Boolean Append, String Title, String Dir, String HelpFile, Long Type,
Long ConfigRec, String ShellId)

Parameters
Boolean Cancelled (Out) Returns true if the user canceled the dialog.

String File (Out) The datasource that was selected.

Boolean Energy (Out) Returns true if the energy check box was selected.

Boolean Eff (Out) Returns true if the effiency check box was selected.

Boolean Append (Out) Returns true if the append check box was selected.

DataSourceCalMask Mask The options

camdlgShowEnergy Show energy check box

camdlgShowEfficiency Show efficiency check box

camdlgShowAppend Show append check box

camdlgCalDefault Default options which is

camdlgShowEnergy|
camdlgShowEfficiency|
camdlgShowAppend

String Title The title on the dialog

String Dir The open directory. If is “” then the Genie-2K CAL file di-
rectory is used.

String Helpfile The name of the help file

Long Type (Out) The type of VDM

camdlgTypeB: Local VDM

camdlgTypeF: Type ‘F’

camdlgTypeM: Remote VDM

Long ConfigRec (Out) The configuration record.

421
Component Programming Library Reference

String ShellId The shell ID.

Optional
DataSourceOpenMask Mask A value of camdlgCalDefault

String Title A value of “”

String Dir A value of “”

String Helpfile A value of “”

Long Type A value of NULL

Long ConfigRec A value of NULL

String ShellId A value of “”

Certificate Open Dialog

This method displays a dialog that will list all of the certificate files.

OpenCertificate (Boolean Cancelled, String File, String Title, String Dir, String
HelpFile, Long Type, Long ConfigRec, String ShellId)

Parameters
Boolean Cancelled (Out) Returns true if the user canceled the dialog.

String File (Out) The datasource that was selected.

String Title The title on the dialog

String Dir The open directory. If is “” then the Genie-2K CAM file di-
rectory is used.

String Helpfile The name of the help file

Long Type (Out) The type of VDM

camdlgTypeB: Local VDM

camdlgTypeF: Type ‘F’

camdlgTypeM: Remote VDM

Long ConfigRec (Out) The configuration record.

String ShellId The shell ID.

Optional
String Title A value of “”

422
 CAM Dialog Control

String Dir A value of “”

String Helpfile A value of “”

Long Type A value of NULL

Long ConfigRec A value of NULL

String ShellId A value of “”

Nuclide Library Open Dialog

This method displays a dialog that will list all of the nuclide library files.

Calling Conventions
OpenNuclideLib (Boolean Cancelled, String File, String Title, String Dir, String
HelpFile, Long Type, Long ConfigRec, String ShellId)

Parameters
Boolean Cancelled (Out) Returns true if the user canceled the dialog.

String File (Out) The datasource that was selected.

String Title The title on the dialog

String Dir The open directory. If is “” then the Genie-2K CAM file di-
rectory is used.

String Helpfile The name of the help file

Long Type (Out) The type of VDM

camdlgTypeB: Local VDM

camdlgTypeF: Type ‘F’

camdlgTypeM: Remote VDM

Long ConfigRec (Out) The configuration record.

String ShellId The shell ID.

Optional
String Title A value of “”

String Dir A value of “”

String Helpfile A value of “”

Long Type A value of NULL

423
Component Programming Library Reference

Long ConfigRec A value of NULL

String ShellId A value of “”

Save As Dialog
This method displays a dialog that will allow you to get information about where to save
a datasource (i.e., nuclide library, calibration, data file, certificate, or ROI file).

Calling Conventions
SaveAs (Boolean Cancelled, String File, String FileTitle, String Description, String
Geom, DataSourceSaveMask Mask, String Title, String Dir, String Extension,
String HelpFile, Long Type, Long ConfigRec, String ShellId)

Parameters
Boolean Cancelled (Out) Returns true if the user canceled the dialog.

String File (Out) The datasource that was selected.

String FileTitle This is the title of the file. This is returned if the save
mask is camdlgShowTitle or
camdlgShowCertificateName.

String Description This is the description. This has different means based
on the user DataSourceSaveMask. If the mask is
camdlgShowDescription this will be the description.

String Geom This is the name of the geometry if the save mask is
camdlgShowGeometry.

DataSourceSaveMask Mask The save as display masks.

camdlgShowDescription: Show description

edit field.

camdlgShowTitle: Show title edit field.

camdlgShowGeometry: Show geometry edit

field.

camdlgShowCertificateName: Show certificate de-

scription field.

camdlgSaveDefault: Save default which is

camdlgShowDescript
ion.

String Title The title on the dialog

String Dir The open directory. If is “” then the Genie-2K CAM file
directory is used.

424
 Adjust Control

String Helpfile The name of the help file.

Long Type (Out) Not used

Long ConfigRec (Out) Not used

String ShellId The shell ID.

Optional
DataSourceSaveMask Mask A value of camdlgSaveDefault

String Title A value of “”

String Dir A value of “”

String Helpfile A value of “”

Long Type A value of NULL

Long ConfigRec A value of NULL

String ShellId A value of “

Adjust Control
The Adjust Control is a control which supports the User Interface components necessary
to adjust hardware inputs. This is done by displaying a control that is similar to the cur-
rent MCA Adjust dialog in the Acquisition and Analysis applications. This control can be
embedded in any form including modeless and modal forms. All adjust operations are
asynchronously performed in a background thread to avoid any substantial slowdown in
the user interface of the rest of the application. The Adjust Control also supports event
callbacks to inform any clients of changes in the device.

This component may be added to a VB project by selecting Project | Components, then in

the Components dialog, select “Canberra Adjust Control”. An icon similar to the one in
Figure 26 will appear in the VB toolbar.

425
Component Programming Library Reference

Figure 26 Adjust Icon

Double click on this icon and it will appear on your VB form. Note that the control is
fixed in size to support a fixed number of controls lengthwise. When first added to a form
the control will appear virtually blank. It will remain this way until a DeviceAccess ob-
ject is set into the object.

Adjust Control Methods

The following methods are supported:

Operation Description
SetDevice Assign a device to the control
CloseDevice Unassign the device
Busy Is the device busy adjusting

Setting a Device
Sets a device into the control. This will populate the screen with the DeviceAccess’s ad-
justable input devices.

Calling Convention
SetDevice([in] DevAcc As DeviceAccess, [Devices As AdjustDeviceTypes = adjALL])

Parameters
DevAcc The device access object to adjust. Should be open and
writable. If the input contains no adjustable devices then an
error will be returned and the function will fail.

426
 Adjust Control

Devices A combination of one or more AdjustDeviceTypes. Only

those devices specified will be displayed in the control. By
default, all are.

adjAll adjLFC

adjADC adjMCS

adjMXR adjProtocol

adjDigStab adjPwrMgmt

adjSmpChngr adjVacuum

adjAmp adjGainDSP

adjHVPS adjFilterDSP

adjPreAmp adjPulser

Optional
Devices = adjAll

Example
Dim DA As DeviceAccess
Set DA = New DeviceAccess
DA.Connect “DET1”
AdjustControl1.SetDevice DA, adjADC + adjSmpChngr

Closing the Device

Sets the device in the control to nothing. The adjust screen will then go blank. This step
is not required when closing the adjust control.

Calling Convention
CloseDevice ()

Parameters
None

Optional
None

427
Component Programming Library Reference

Example
:
: ‘ Do modal operations

AdjustControl1.CloseDevice
DA.Disconnect

Checking for Busy

Some adjust operations may take some time. During that time the adjust control is dis-
abled but you may want to prevent other operations until the adjust is complete. This
function offers a method to check that state.

Calling Convention
Boolean Busy()

Parameters
None

Returns
Boolean Is busy?

Optional
None

Example
Private Sub Ok_Click()
If(AdjustControl1.Busy) Then
Exit Sub
Else
Unload Me
EndIf
End Sub

Changes in the Adjust Control

When a user makes a change to the settings the control will notify the programmer via
this event.

Calling Convention
AdjustChange(AdjustEvents Ev, long ErrorCode)

Parameters
AdjustEvents AdjustEvents may be one or more of the following:

428
 Adjust Control

adjChange The adjust control has modified

the DS.

adjError An error (ErrorCode) occured

adjBegin The device is starting an Adjust.

adjEnd The device is ending the Adjust.

ErrorCode A 32 bit errorcode.

Example
Private Sub AdjustControl1_AdjustChange(ByVal Ev As _AdjustEvents,
ByVal ErrorCode As Long)

If (Ev And adjChange) Then

m_bAdjChange = True
End If

If (Ev And adjError) Then

m_Status = ErrorCode
End If

If (Ev And adjBegin) Then

DisableMenu
End If

If (Ev And adjEnd) Then

EnableMenu
End If

End Sub

Adjust Control Properties

Status Severity
All status messages have a severity associated with them. This severity defines whether a
message is a warning message or an error message. There are two properties that may be
used to determine the severity of a message.

Calling Convention
Boolean IsError(Long ErrorCode)
Boolean IsWarning(Long ErrorCode)

Parameters
long ErrorCode The status code to examine for severity level.

429
Component Programming Library Reference

Return
Boolean bVal A value of true indicates that the message is of that speci-
fied severity level.

Optional
None

Example
AdjustControl1.SetDevice myDET
Exit Sub

ErrorHandler:
If(IsError(Err.Number)) Then
MsgBox AdjustControl1.Message(Err.Number)
Else If(IsWarning(Err.Number) Then
MsgBox Err.Description
Resume Next
EndIf
End Sub

Retrieving Status Messages

This property returns the status message text defined by the status code.

Calling Convention
String Message(MessageCode Code)

Parameters
Long MessageCodes Code The message code to retrieve the status string.

Return
String Message String for the status

Optional
None

Privilege
Read-Only

Example
AdjustControl1.SetDevice myDET
Exit Sub

430
 Sequence Analyzer

ErrorHandler:
If(IsError(Err.Number)) Then
MsgBox AdjustControl1.Message(Err.Number)
Else If(IsWarning(Err.Number) Then
MsgBox Err.Description
Resume Next
EndIf
EndSub

Sequence Analyzer
The Sequence Analyzer component is capable of analyzing and editing a Genie 2000
analysis sequence (ASF) file.

Note: Settings applied via the Analysis Sequence Editor’s Sequence Preferences dia-
log apply only to that specific sequence when run in the current session of Ge-
nie 2000. They do not apply to sequences run using this component.

The functions of analyzing and editing are provided seperately in two components: the
SequenceAnalyzer analyzes and the AnalysisEditor edits. Both are contained within the
same COM server DLL. The use of these components is described below.

SequenceAnalyzer
This component may be added to a VB project by selecting Project | Components, then in
the Components dialog, select “Canberra Sequence Analyzer Library”. An icon similar to
the one in Figure 27 will appear in the VB toolbar.

Figure 27 Sequence
Analyzer Icon

Double click on this icon and it will appear on your VB form. This icon will appear only
during design time. There are no properties visible in the property toolbar list; all proper-
ties and methods become visible during coding.

Variables should be declared of type: SequenceAnalyzer

431
Component Programming Library Reference

Methods
The following methods are defined in the interface:

Operation Description
Analyze Analyze a Datasource
Abort Abort an analysis

Analyzing a Datasource
This method will analyze a datasource using an ASF file or the internal sequence defined
in the datasource.

Calling Convention
Analyze ([in] DS as Object, [in, out] Step As Integer = 0, [in, opt] Seq As String = “”,
[in, opt] Async As Bool = FALSE, [in, opt] Alpha As Bool = FALSE,
[in, opt] ReportOnly As Bool = FALSE, [in, opt] Report As Bool = TRUE,
[in, opt] OutFile As String = “”, [in, opt] Reporter As ReportViewer = Noth-
ing)

Parameters
DS as Object The Datasource to analyze: must be an open DataAccess or
DeviceAccess Object.

Step as Integer The Step number to start the sequence on. Step numbers
are 1 based, But 0 will also start at step 1. This alos returns
the final step number to be executed. This way if recover-
able errors occur during a step, the client may continue ex-
ecution.

Seq as String The full path name of an Analysis Sequence File. If not
specified the DS’s internal sequence will be used.

Async as Bool Allow the analysis to occur asynchronously. If the value is

true, the function will return immediately and analysis will
occur in a background thread to prevent holding up the rest
of the application. If false, the function will not return until
analysis is complete (or an error is encountered)

Alpha as Bool The sequence contains Alpha Analysis Engines.

ReportOnly As Bool If true, only the report steps of the sequence will be exe-
cuted.

Report As Bool If false, report steps will be skipped during analysis.

432
 Sequence Analyzer

OutFile As String Full path name to an output file for report results. If not
specified the default report file for the datasourc will be
used.

Reporter As ReportViewer ReportViewer to output ‘screen’ report results too.

Optional
Step as Integer Default = 0

Seq as String Default = “”. If not specified the DS’s internal sequence
will be used.

Async as Bool Default = False

Alpha as Bool Default = False

ReportOnly As Bool Default=False

Report As Bool Default=True

OutFile As Strin Default = “” If not specified the default report file for the
datasource will be used.

Reporter As ReportViewer Default = NULL. If not specified, reports to screen are not
output.

Example
Dim DS As DataAccess
Dim SA As SequenceAnalyzer
Dim Step As Integer
Set DS = New DataAccess
DS.Open “C:\Genie2k\Camfiles\NBSSTD.CNF”, aReadWrite
Set SA = New SequenceAnalyzer
Step = 1
SA.Analyze (DS, Step, “C:\Genie2k\CtlFiles\ECAL_SHO.ASF”, False, False, False,
True, ,ReportViewer1)
DS.Close dUpdate
Set DS = Nothing
Set SA = Nothing

Aborting an Analysis
This will abort an asynchronous analysis sequence. Note that the abort may be delayed as
it will only occur between steps.

Calling Convention
Abort()

Parameters
None

433
Component Programming Library Reference

Optional
None

Events
The following outgoing event is supported:

Calling Convention
AnalyzeDone(hRes As Long, nStep As Integer)

The AnalyzeDone event is fired from the Analyze object when an analysis is completed.
Using this, a client can be notified when an analysis is completed, the return code of the
last analysis step, and the last step of the sequence executed. This is particularly useful if
the sequence was analyzed asynchronously.

Parameters
hRes As Long An error code interpretable by the status handler.

nStep As Long The last step to execute

Analysis Editor
The analysis editor control is embeddable within a VB form to allow editing features pre-
viously only available from the “Analysis Sequence Editor”. This control allows the cli-
ent to set a particular datasource into the Editor for editing. When the user is done
editing, the control allows the client to save the current sequence into a Datasource.

To embed in a VB form, add the “Canberra Sequence Analyzer Library” via the compo-
nents option. The ASE icon will appear on the controls toolbar. Drag this onto a form.
Note that the control is not resizable and does not contain buttons for opening/clos-
ing/and saving a datasource. These are the responsibility of the client.

Methods
The Analysis Editor supports the following methods:

Operation Description
SetSequence Open a sequence for editing
GetSequenceChanges Retrieve any changes made during edits
IsChanged Has user made any changes
New Sequence Create a new sequence for editing

434
 Sequence Analyzer

Opening a Sequence for Editing.

This allows any datasource sequence to be edited.

Calling Convention
SetSequence([in] Input As Object, [in, opt] Alpha As Bool, [in, opt] ReadOnly As Bool)

Parameters
Input As Object Datasource containing the sequence to edit. Must be an
open DataAccess or DeviceAccess object.

Alpha As Bool Contains Alpha sequence steps.

ReadOnly As Bool Do not allow the user to edit.

Optional
None

Retrieving User Changes

The changes a user made will not be written back to the datasource by default. Instead
this more flexible method is used where any datasource can accept the changes.

Calling Convention
GetSequenceChanges([in] Output As Object)

Parameters
Output As Object Datasource to save changes to. Must be an open and
writable DataAccess or DeviceAccess object. NOTE: this
does not do a flush of the datasource.

Detecting if the UserHas Made Changes

Returns a boolean value to indicate if changes have been made.

Calling Convention
IsChanged()

Creating a New Sequence

The user may wish to create a new sequence. This routine will clear the current steps
listbox and discard any changes made previously:

Calling Convention
NewSequence([in, opt] Alpha As Bool=FALSE, [in, opt] NAI As Bool=FALSE)

435
Component Programming Library Reference

Parameters
Alpha As Bool Will contain Alpha sequence steps.

NAI As Bool In combination with the Alpha param, determines the de-
fault detector type and calibration parameters used in the
datasource

Reporting
The Reporting function supports display and printing of text and RTF files. This is di-
vided into components: ReportViewer for displaying reports and Reporter for printing re-
port files. Both are contained within the same COM server DLL.

To add support for more report formatting commands, the ReportViewerExtensions inter-
face has been added to ReportViewer. This new component interface has methods for
identifying enhanced reports, loading an existing report, and exporting a report to a PDF
file. Note that the base Report Viewer’s Copy and CopyAll commands will not work on
generated or loaded enhanced reports.

The Reporting function may be added to a VB project by selecting Project | Components,

then in the Components dialog, select “Canberra Reporting Library”. An icon similar to
the one in Figure 28 will appear in the VBtoolbar.

Figure 28 Reporting
Library Icon

Double click on this icon and it will appear in your VB form. The control allows the cli-
ent to select in RTF and Text report files. The control also allows concatenation of these
types so that multiple files can be added to the view. The control supports clearing the
view, copying selected text, and printing of the reports as well.

436
 Reporting

Reporter Viewer
This component is used for displaying reports.

Methods
The following methods are supported:

Name Description
Clear Clears contents of the report
PrintOut Prints contents of the report (WYSIWYG)
Copy Copies selected text to the clipboard in text and
RTF formats (not for enhanced reports)
CopyAll Copies all text to the cipboard (not for enhanced
reports)
LoadText Concatenates a text file (from a given offset) to
the report
LoadRTF Concatenates an RTF file
SaveText Saves the contents of the report as a Text File
SaveRTF Saves the contents of the report as an RTF file
ExecuteReport Executes a Genie2000 Style report

Clearing the View

Clears the contents of the report.

Calling Convention
Clear()

Parameters
None

Return
None

Optional
None

Printing the View

Prints the contents of the report

437
Component Programming Library Reference

Calling Convention
PrintOut([in]Printer As String)

Parameters
Printer Specifies the name of the printer to output to. Default is the
default printer set up in the OS

Return
None

Optional
None

Copy the selected text to the clipboard

Copies the selected text to the clipboard in both text and RTF format for pasting into
other applications. Note: This method will not work on enhanced reports.

Calling Convention
Copy()

Parameters
None

Return
None

Optional
None

Copy all the text to the clipboard

Copies all the text to the clipboard in both text and RTF format for pasting into other ap-
plications. Note: This method will not work on enhanced reports.

Calling Convention
CopyAll()

Parameters
None

Return
None

438
 Reporting

Optional
None

Viewing a text file

Concatenates a text file, potentially from a given offset, into the report view.

Calling Convention
LoadText([in] Filename As String, [in, out, opt] Offset As Long=0, [in, opt] Length= 0)

Parameters
Filename As String Full pathname of text file to load

Offset As Long Offset into file to read text from

Length As Long Number of characters to read from the file

Return
Length As Long Number of characters read from the file

Optional
Offset As Long Default = 0

Length As Long Length = 0 (read All)

Viewing an RTF file

Concatenates a RTF file into the report view.

Calling Convention
LoadRTF([in] Filename As String)

Parameters
Filename As String Full pathname of text file to load

Return
None

Optional
None

Saving the Report Contents as a Text File

Saves the entire report as a text file.

439
Component Programming Library Reference

Calling Convention
SaveText([in] Filename As String, [in] Overwrite As Boolean)

Parameters
Filename As String Full pathname of text file to load

Overwrite As Boolean If true, should overwrite if exists. If false, return error if the
file exists.

Return
None

Optional
None

Saving the Report Contents as an RTF File

Saves the entire report as an RTF file.

Calling Convention
SaveRTF([in] Filename As String, [in] Overwrite As Boolean)

Parameters
Filename As String Full pathname of text file to load

Overwrite As Boolean If true, should overwrite if exists. If false, return error if the
file exists.

Return
None

Optional
None

Executing a Genie 2000 Report Template

Executes a given template and section against a Datasource. This datasource must be a
DataAccess object or a DeviceAccess object.

Calling Convention
ExecuteReport ([in] Datasource As Object, [in] Template As String,
[in] Section As String, [in] Ops As ReportOps=(rptPage1|rptScreen),
[in] Sigma As Single, [in] ActivityUnits As String,
[in] ActivityMultiplier As Single)

440
 Reporting

Parameters
Datasource As Object Must be an open DataAccess or DeviceAccess object. This
is the Datasource to report on.

Template As String Name of the report template file. Does not require a full
path if the template is in the directory pointed to by the en-
vironment variable RTPLFILES.

Section As String Specifies the section name in the report. Section may be
“<All>” which will execute all sections.

Ops As ReportOptions The standard report options:

rptScreen report to screen(in the viewer)

rptPrinter report to printer

rptNewFile creates a new report file

rptPage1 restarts page numbering

rptNewPage starts on a new page

Sigma As Single Sigma is the Error multiplier.

ActivityUnits As String Units to report activity in.

ActivityMultiplier Multiplier conversion from µCi to desired units.

Returns
None

Optional
Ops As ReportOptions rptScreen | rptPage1

Sigma As Single 0.0 (uses value from datasource)

ActivityUnits As String 0.0 (if not specified)

ActivityMultiplier 0.0

Properties
The following are supported besides the standard properties(size, position..) and are
available read/write at design and run time:

BackColor color of Background (White is default).

441
Component Programming Library Reference

Font font of text reports (Courier New, 12pt is default) Note that changing this property
will not change the font of the currently displayed text but instead only affect subsequent
reports.

BorderStyle 3d or flat (3d is default).

Setting the Report Background Color

Sets or gets the report viewer’s background color.

Calling Convention
BackColor

Type
OLE_COLOR

Default
White

Example
Dim Y as OLE_COLOR
Y = Reportviewer1.Color

Setting the Report Font

Sets or gets the reports veiwer’s font. Changing this will affect subsequent reports only.

Calling Convention
Font

Type
IFontDisp (StdFont)

Default
Courier New, 9pt

Example
Dim X As StdFont
Set X = ReportViewer1.Font
X.Bold = True
Set ReportViewer1.Font = X
ReportViewer1.LoadText “C:\Autoexec.bat”

BorderStyle
Sets or gets the report viewer’s Borderstyle.

442
 Reporting

Calling Convention
BorderStyle

Type
BorderStyle (rptFlat or rpt3d)

Default
rpt3d

Example
ReportViewer1.BorderStyle = rptFlat

Examples
Private Sub Clear_Click()
ReportViewer1.Clear
End Sub
Private Sub Open_Click()
ReportViewer1.LoadText(“C:\Autoexec.bat”)
End Sub
Private Sub Execute_Click()
Dim DS As DataAccess
Set DS = New DataAccess
DS.Open “E:\Genie2k\Camfiles\NBSSTD.CNF”, dReadWrite
ReportViewer1.ExecuteReport DS, “Analysis.tpl”, “<All>”,
rptPage1|rptPrinter
DS.Close dUpdate
Set DS = Nothing
End Sub

Reporter Viewer Extension

The Reporter Viewer Extension interface has support for identifying enhanced reports,
loading an existing report and exporting a report to a PDF file.

Methods
The following methods are supported:
• IsEnhanced returns true if the report file has the $ETEMPLATE command on
the first line of the report file.
• ExportReport generates a PDF file of the loaded report file.
• LoadTextEx loads a report file into memory from a report file from a given
offset, and based in the provided screen and print flags performs the necessary
functions.

443
Component Programming Library Reference

IsEnhanced
Returns true if the report file has the $ETEMPLATE command on the first line of the re-
port file, else returns false.

Calling Convention
IsEnhanced([in]Report Name As String)

Parameters
Report Name specifies the name of the file to open and look for the enhanced report file
identifier($ETEMPLATE).

Return
True if the enhanced report identifier ($ETEMPLATE) is on the first line of the report.
False if the enhanced report identifier is not on the first line of the report file.

Optional
None

ExportReport
Exports the load report file to a PDF format file.

Calling Convention
ExportReport([in]ExFileName as String)

Parameters
ExFileName specifies the name of the PDF file the data is being exported to.

Return
None

Optional
None

LoadTextEx
Loads a report file into memory from the report file at a given offset

Calling Convention
LoadTextEx([in]Filename As String, [in]Offset As Long, [in]Length As Long,
[in]ScreenFlag As Boolean, [in]PrintFlag As Boolean);

Parameters
Filename As String Name of the report file to be loaded.

444
 Reporting

Offset As Long File offset into report file where loading is to start.

Length As Long Length of report file to load; if 0, load to the end of the file.

ScreenFlag As Boolean Show the report window after being loaded.

PrintFlag As Boolean Print the report after being loaded.

Return
None

Optional
None

Example
' RptViewer is the ReportViewer control placed on the VB form
Dim RptViewerEx As CanberraReporterLibCtl.IReportViewerExtensions
Set RptViewerEx = RptViewer.Object
RptViewer.LoadTextEx “C:\\GENIE2k\\REPFILES\\NBSSTD.RPT”, 0, True, False
RptViewerEx.ExportReport “C:\\GENIE2k\\REPFILES\\NBSSTD.PDF"

Properties
The following are properties are supported through the extended interface. PreviewScale
and PaperView are available read/write at run time. The remaining properties are
write-only at runtime.

Name Description
PreviewScale([in\out] PreviewScale As Long)

PaperView([in\out] pPaperView As Boolean)

PDFAuthor([in] Author As String)

PDFTitle([in] Title As String)

PDFSubject([in] Subject As String)

PDFKeyword([in] Keyword As String)

PDFCreator([in] Creator As String)

Setting the enhanced report PreviewScale

Sets or gets the enhanced report preview scale.

445
Component Programming Library Reference

Calling Convention
PreviewScale

Type
Long

Default
100

Example
‘ RptViewer is the ReportViewer control placed on the VB form
Dim RptViewerEx As CanberraReporterLibCtl.IReportViewerExtensions
Dim lRtn As Long
Set RptViewerEx = RptViewer.Object
lRtn = RptViewerEx.PreviewScale

Setting the enhanced report PaperView

Sets or gets the enhanced report paper view. Paper view is the report in the window is
shown as a piece of paper.

Calling Convention
PaperView

Type
Boolean

Default
True

Setting the enhanced report PDFAuthor

Sets the enhanced report PDFAuthor.

Calling Convention
PDFAuthor

Type
String

Default
None

446
 Reporting

Setting the enhanced report PDFTitle

Sets the enhanced report PDFTitle.

Calling Convention
PDFTitle

Type
String

Default
The datasource name

Setting the enhanced report PDFSubject

Sets the enhanced report PDFSubject.

Calling Convention
PDFSubject

Type
String

Default
None

Setting the enhanced report PDFKeyword

Sets the enhanced report PDFKeyword.

Calling Convention
PDFKeyword

Type
String

Default
None

Setting the enhanced report PDFCreator

Sets the enhanced report PDFCreator.

Calling Convention
PDFCreator

447
Component Programming Library Reference

Type
String

Default
Genie 2000

Reporter
The Reporter is used to print out a single text or RTF file. This can be invoked in
VisualBasic by adding a reference to the “Canberra Reporting Library”. Variable may be
declared of type: Reporter.

Methods
The following method is supported.

Print a File
Prints a given file.

Calling Convention
PrintFile([in] FileName As String, [in] bRTF As Boolean)

Parameters
Filename As String File to print

RTF As Boolean Is file Text (False) or RTF (True)

Return
None

Optional
None

Properties
The following read/write poperties are supported at runtime:

Name Description
Printer Name of printer – defaults to default printer
Font Font to use when printing text; write only

448
 Error Handling

Setting the Reporter’s Printer

Sets or gets the reporter’s printer.

Calling Convention
Printer

Type
String

Default
“” (The default printer)

Example
Dim X as New Reporter
X.Printer = “CID1”
X.PrintFile “C:\Autoexec.bat”, False

Setting the Report Font

Sets or gets the reporter’s font.

Calling Convention
Font

Type
IFontDisp (StdFont)

Default
Courier New, 9pt

Example
Dim X As StdFont
Dim RPT As New Reporter

X.Bold = True
RPT.Font = X
RPT.PrintFile “C:\Autoexec.bat”, False

Error Handling
When the components encounter an error, an error will be raised in Visual Basic.
Catching and handling these errors is critical to your application running properly. Please
see all Error Handling topics in your Visual Basic help for more information.

449
Component Programming Library Reference

Any error code returned by the components may have a severity of an error or a warning.
To test this the following methods are provided in all components.

Boolean IsError(Long ErrorCode)

Boolean IsWarning(Long ErrorCode)

To retrive a string associated with an error code the following method is provided. Al-
though in most cases this is not necessary since Err.Description contains this text already,
this may be useful for situations where the Error context has gone away but you have
stored the error number for later processing.

Calling Convention
String Message(Long ErrorCode)

Parameters
Long ErrorCode

Optional
None

Example
Public Sub SetUpAdjust(DeviceAccess myDET)
On error goto ErrorHandler
AdjustControl1.SetDevice myDET
Exit Sub
ErrorHandler:
If(IsError(Err.Number)) Then
MsgBox AdjustControl1.Message(Err.Number)
Else If(IsWarning(Err.Number) Then
MsgBox Err.Description
Resume Next
EndIf
End Sub

450
 The InSpector 2000 Simulator

4. MCA Input Definition

The first step in using your Genie 2000 system is to create at least one MCA Input Defi-
nition (MID) so the system knows what kind of MCA is installed in or connected to your
system.

This chapter demonstrates how to create the definition with both the MID Wizard and the
MID Editor, using the DSA-2000 MCA as an example. Instructions for setting up your
MCA will be found in its user’s manual.

For most systems, you’ll use the MID Wizard to help you set up your Input Definition
quickly and easily. But if your Input Definition is more complex than the MID Wizard
was designed to handle, you’ll have to create your definition in the MID Editor, which is
covered in detail starting on page 455.

For System 100 and AccuSpec MCAs, refer to the Historical Canberra MCAs.pdf file on
your Genie 2000 CD-ROM. For AIM MCAs, refer to the Model 556A User’s Manual.

The InSpector 2000 Simulator

Genie 2000 V2.1 and later includes InSpector 2000 Simulator, software designed as a tu-
torial for, or a demonstration of, Genie 2000, without the need for an actual MCA, a de-
tector, and associated front-end electronics. The Simulator mimics a fully functioning
InSpector 2000 and works within Genie 2000 as though it were an actual MCA, with
working Adjust Controls and simulated data acquisition.

For more information on the Simulator, please refer to Appendix E, The InSpector 2000
Simulator.

The MID Wizard

To use the MID Wizard, open the Genie 2000 folder and select the MID Wizard icon to
start the definition process.

Restrictions
The Wizard does not support:
• Definition of multiplexer (MXR) inputs. This includes devices such as the
Alpha Analyst.
• Configuration of remote VDMs.

451
MCA Input Definition

For these situations, you must use the MID Editor (page 455).

Using the Wizard

To use the MID Wizard, open the Genie 2000 folder and select the MID Wizard icon to
see the Step 1 screen.

Note: The screens shown here are examples; the screens you see may vary, depend-
ing on the MCA type you specify.

Step 1
The first screen (Figure 29) lets you select the MCA you’re creating the definition for.
Click on the ‘+’ next to the “Network MCAs” board type, choose DSA-2000, then click
the Next button.

Figure 29 Selecting the MCA

Step 2
The Step 2 screen (Figure 30) will ask you to define the MCA’s Full Memory size, Sta-
tion address, and the acquisition mode, PHA or MCS.

452
 The MID Wizard

Figure 30 Configuring the MCA

Step 3
The Step 3 screen (Figure 31) asks for an Input Name, the Detector Type, Memory
Groups and the Number of Channels.

You can change the default Input Name if you like, but if the field is empty, you won’t
be able to go to the next screen

With the Memory Groups box selected, the full memory can be divided into two or more
memory groups. The number of groups depends on the Number of Channels setting.

Figure 31 Assigning the Detector Type

453
MCA Input Definition

Steps 4 and 5
Steps 4 and 5 are not used in setting up the DSA-2000.

Step 6
The Step 6 screen in Figure 32 asks you to define the high voltage power supply’s
Range, Voltage Limit and working Voltage.

Figure 32 Defining the High Voltage Parameters

Step 7
The Step 7 screen in Figure 33 displays a summary of the current MCA’s configuration
for review and lets you enter the name of the MID file that the configuration is to be
saved to.

Figure 33 Summary of MCA Configuration

454
 The MCA Input Definition Editor

Ending the Definition

To complete your Input Definition, select Finish. The input that you just defined will be
stored as an MID file, using the name you specified in Step 7. The new MID file will au-
tomatically be loaded into the MCA Runtime Configuration Database (described on page
470).

When you select Finish, you will be asked if you would like to define another input. An-
swering No will close the Wizard.

The Step 7 Input Name defaults to UNTITLED, which you’ll probably want to change to
something more meaningful. If the name you enter is the same as that of an existing MID
file, the system will ask if you want to overwrite the existing file.

The MCA Input Definition Editor

In addition to using the MID Editor to create a new input definition (MID File), it’s used
to edit an existing MID File. For instance, you might want to:

• Change the default settings for any of your MCA’s programmable components
• Replace a manual HVPS with a programmable HVPS and select its default
settings.

Basic Concepts
We’ll begin with some basic concepts that are important to understand before actually
getting into the details of how you define your system’s MCAs.

Multiple MCA Configurations

Since MCA definitions are saved in disk files, you can have as many definitions as you
like. For example, you might have one MCA defined as an 1K Sodium Iodide Spectros-
copy MCA in one file and another as a 2K Sodium Iodide Spectroscopy MCA in another
file. Before you start an experiment you simply pick the configuration you want to use.

Because an MCA definition file can include any or all of the MCAs that are available to
your system, you can use more than one MCA at a time. However, each MCA can be in-
cluded only once in a given definition file and each MCA in that file must have a unique
name.

Using the MCA Definition Files

To use an MCA Definition, you must first have saved the definition to disk as a file.
Once you’ve done that, all you have to do is load that file into the VDM’s internal MCA
Runtime Configuration Database. From that point on, all MCA operations will use the

455
MCA Input Definition

configuration information that was stored in the Definition File. To change to a new con-
figuration, all you have to do is replace the database’s contents with a new file.

Starting the MCA Input Definition (MID) Editor

Start the MID Editor by double clicking on its icon in the Genie 2000 Program Group. The
result will be the application window shown in Figure 34.

Note that the phrase “local:Untitled” in the title bar, means that the MID Editor is con-
nected to the local VDM and that no file is currently open; this is the default condition in
a non-networked environment.

Figure 34 The MID Editor Window

Building an MCA Definition

In creating an MCA Input Definition, you’ll use the MID Editor’s:

• Devices Menu to select the MCA and its front-end components: amplifier,
ADC, HVPS, and so forth.
• Settings Menu to define the operating characteristics and modes for each MCA
and its front-end components.

In this section we’ll explain how to add (and delete) the MID editor’s MCA entries and
will explain what the definition entry consists of. The next section. Defining an MCA on
page , explains how to create an Input Definition for a DSA-2000 MCA.

The remainder of this chapter discusses how the definition is saved to a disk file, how a
definition can be edited, and how to use a definition by loading the file into the MCA
Runtime Configuration Database.

456
 Building an MCA Definition

Adding an MCA
The Edit menu, shown in Figure 35, is used to add an MCA to or delete an MCA from an
MCA Input Definition.

Figure 35 The Edit Menu

To add an MCA, select the Add MCA command in the Edit menu. You’ll see the “Add
MCAs to Definition Table” Dialog Box (Figure 36).

Figure 36 The Add MCA Dialog

457
MCA Input Definition

This typical Add MCA tree view shows the MCAs grouped by MCA type. Clicking on
the ‘+’ next to a MCA type lets you choose a specific MCA.

You can add as many MCAs to the definition as are necessary for your system by high-
lighting one or more MCAs and clicking the Add button to add them to the MCA Defini-
tion Table. When you’ve finished adding MCAs, click on the Done button.

Please remember that this display, as well as many others in this chapter, are examples of
what you might see; your display will probably differ.

Interpreting the Definition Entry

As you can see in Figure 37, adding MCAs puts more than just the name of the MCA in
the definition table. Note the letter following the unit number in some of the Definition
Table items: M for a manually controlled unit, and P for a programmable unit.

Figure 37 An MCA HAs Been Added to the Table

MCA
This is the type of MCA device being used for this particular entry in the table.

Input
This is the name that will be used to refer to this specific hardware entry in the table. The
MID Editor automatically assigns these names sequentially as DETnn, starting with
nn=01. As we’ll see in “Input Setting” on page 467, you can easily change these names
to something you find more meaningful.

Size
This shows the number of data channels assigned to this input.

458
 Defining an MCA

Gain
This column describes the DSP Gain device associated with the DSA-2000.

Other Entries
All of the other entries, ADC, MXR, Stab, Amp and HV, tell you whether that kind of
component is assigned to the MCA and if it’s Manual or Programmable.

Deleting an MCA
If you want to remove an MCA that you have added to the definition, you can do it easily
by:

1. Selecting the table entry you want to delete.

2. Clicking on the Delete MCA command in the Edit menu to see the Dialog Box
in Figure 38. Click on OK to remove the entry.

Figure 38 The Delete MCA Dialog

Defining an MCA
This section discusses setting up a DSA-2000 MCA, which has a fully programmable
front end. That is, its DSP Gain, DSP Filter, Digital Stabilizer, MCS and High Voltage
Power Supply are all controlled from the host computer rather than manually with front
panel knobs and switches. To begin, click on the MCA entry in the Definition Table that
you want to set up.

459
MCA Input Definition

Devices
The Devices menu, shown in Figure 39, sets the parameters for the MCA and associated
devices. Some Devices are disabled (grayed out) because they aren’t used with your
MCA.

Figure 39 The Devices

Menu

MCA
Selecting the MCA command in the Devices menu pops up the Dialog Box shown in
Figure 40, which lets you set the Ethernet address for the DSA-2000 and select the type
of input.

• MCA Full Memory selects the DSA-2000’s full memory size.

• Station Address specifies the network address for communicating with the
module.
• DSA-2000 selects the DSA-2000’s input type.

460
 Defining an MCA

Figure 40 The MCA Device Setup Dialog

Sample Changer
The Sample Changer screen in Figure 41 lets you disable the sample changer interface,
(None) or enable the Internal Changer interface.

Figure 41 The Sample Changer Controls

Stabilizer, High Voltage, DSP Gain and DSP Filter

If any of these are available for your MCA, you’ll select either manual device or pro-
grammable device here. For the DSA-2000, these components are already selected, so
these screens are used for general information.

461
MCA Input Definition

The Settings
The following section describes those parameters for the DSA-2000 that can be accessed
from the MID Editor via the Settings menu (Figure 42).

Figure 42 The Settings

Menu

MCA Settings
For the DSA-2000, “This device has no adjustable controls”, so there’s nothing to do
here.

Stabilizer Settings
The Stabilizer maintains the stability of high resolution spectroscopy in applications in-
volving long count times or high count rates.

Selecting the Stabilizer command displays the Dialog Box shown in Figure 43.

Note This window’s initial focus is on the Cancel button; pressing the keyboard’s
ENTER key after making changes in this dialog box will cancel the changes. Be
sure to click on the OK button to accept the changes.

462
 Defining an MCA

Figure 43 The Stablizer Setting

Select the:
• Gain Centroid (in channels) of the reference peak at the high end of the
spectrum for gain stabilization,
• Gain Window width (in channels) of the upper and lower sampling windows
on either side of the gain reference peak,
• Gain Spacing (in channels) between the upper and lower sampling windows,
• Gain Ratio value (the ratio to maintain between the two gain windows),
• Zero Centroid (in channels) of the reference peak at the low end of the
spectrum,
• Zero Window (in channels) of the upper and lower sampling windows on
either side of the zero reference peak.
• Zero Spacing (in channels) between the upper and lower sampling windows,
• Zero Ratio, the ratio to maintain between the two zero windows,
• Gain Rate Divisor, the count rate dividers at the input to the Gain correction
register,
• Zero Rate Divisor, the count rate dividers at the input to the Zero intercept
correction register,
• Correction Range, the Gain Correction range to correct for drift.

High Voltage Settings

The High Voltage command, shown in Figure , adjusts the High Voltage Power Supply
(HVPS).

463
MCA Input Definition

Figure 44 The High Voltage Settings

Note: This window’s initial focus is on the Cancel button; pressing the keyboard’s
ENTER key after making changes in this dialog box will cancel the changes. Be
sure to click on the OK button to accept the changes.

Select the:
• Range must be set before the Voltage Limit or Voltage Control is adjusted. It
sets the HV Power Supply’s absolute voltage limit.
• Voltage limit establishes the HVPS’s maximum output voltage within the
selected range.
• Voltage sets the output of the HVPS between the Voltage Limit’s minimum
and maximum settings.
• Inh. Signal sets the pull-up voltage of the HV INH connector.

DSP Gain Settings

The DSP Gain settings screen (Figure 45) has three Gain controls. The combination of
Coarse and Fine Gain sets the overall system gain to match the requirements of the detec-
tor and energy application; overall gain is continuously variable from x2.0 to x1536. The
Fine Gain factor is dependent on the Super-Fine Gain (SFG) value. With the SFG set to
0.0000e-2, the Fine Gain covers a range of x0.4 to x1.6. The SFG value adds to the Fine
Gain factor and covers a range of 0.0000e -2 to 3.0000e-2.

464
 Defining an MCA

Figure 45 The DSP Gain Settings

Select the:
• Coinc Mode sets the devices gating mode (COINCidence or
ANTIcoincidence).
• Offset sets the devices digital offset in channels.
• LLD sets the devices Lower Level Discriminator (LLD) as a percentage of the
ADC’s full scale.
• Zero sets the device’s zero intercept as a percentage of the device’s full scale.
• Conv. Gain sets the device’s conversion gain.
• FDisc Mode sets the device’s Fast Discriminator threshold mode. AUTO
allows the threshold to be optimized automatically above the system noise
level; MANUAL allows the threshold to be manually adjusted.
• FDisc Setting sets the device’s Fast Discriminator threshold level.
• Inp. Polarity sets the device’s Input signal polarity.
• Inh. Polarity sets the device’s Inhibit signal polarity to either Positive or
Negative.

DSP Filter Settings

The DSP Filter settings screen (Figure 46) for the DSA-2000 contains the following con-
trols.

465
MCA Input Definition

Figure 46 The DSP Filter Settings

Select the:
• Rise Time sets the rise time and fall time of the digital filter time response.
• BLR Mode sets the baseline restorer mode.
• Preamp Type selects the Preamplifier type as either TRP or RC.
• Flat Top sets the flat top portion of the digital filter time response.

MCS Settings
If you chose either MCS or Both in the Devices | MCA menu (page ), you’ll select the
MCS Disc Mode in Figure 47.

Note: This window’s initial focus is on the Cancel button; pressing the keyboard’s
ENTER key after making changes in this dialog box will cancel the changes. Be
sure to click on OK to accept the changes.

• Disc Mode establishes the MCS mode to be used.

Figure 47 Choosing the MCS Disc Mode

466
 Saving the Input Definition

Input Settings
The Input command is used to change the name of the Input and set up the structure of
its memory via the Dialog Box shown in Figure 48. These commands are not available in
the Acquisition and Analysis application.

Figure 48 The Define Input Dialog

Note: This window’s initial focus is on the Cancel button; pressing the keyboard’s
ENTER key after making changes in this dialog box will cancel the changes. Be
sure to click on the OK button to accept the changes.

Select the:
• Input Name allows changing the default detector name is the name.
• Detector Type selects the type of detector to be used with this MCA.
• Input Size changes the number of channels assigned in the Devices | MCA
menu.
• Out of Service lets you make this Input temporarily unavailable.
• Memory Groups allows you to define a multi-memory group input.

Saving the Input Definition

After completing a definition, use the MID Editor’s File | Save (or Save as) command to
save the Definition file.

To remind you to save a changed definition, you’ll see an asterisk (*) next to the name of
the current definition in the Title Bar.

467
MCA Input Definition

CAUTION If you change an existing Input Definition, saving it will clear the Acquisi -
tion Start time. You will be asked to retain the existing energy calibration
information.

The File Descriptor

When a Definition is saved for the first time, the Save As file dialog box is automatically
opened. In this dialog box (Figure 49), you’ll see a File Descriptor field, which lets you
store a 32-character description with your file to make it easier to locate when you want
to use it again.

Figure 49 The Save As Dialog

Changing the Summary View

Before going on to see how to edit an existing Input Definition Table, one that you’ve
built previously and saved to disk, there’s one more menu to look at. This is the Sum-
mary menu, which is shown in Figure 50.

The Summary menu has two commands: By MCA and By Input, which change the or-
der in which the information in the Input Definition Table is displayed. By MCA means
that the first column of the table will display the MCA type that is being used for each
entry. If you choose By Input, the MCA and Input columns will be reversed in the dis-
play and the Inputs will be sorted alphabetically.

You can choose either method, but in the case of systems with a large number of inputs,
“By Input” is an easier display to understand than “By MCA”.

468
 Editing an MCA Definition

Figure 50 The Summary Menu

Editing an MCA Definition

To edit an MCA Definition, use the MID Editor’s File | Open command to select the file
and open it in the editor.

Editing a File in the Runtime Configuration Database

If the Definition you want to edit has been loaded into the MCA Runtime Configuration
Database, it must first be unloaded before it can be opened in the editor. See “Unloading
the Database” on page 472for instructions.

Viewing the File Details

If you’re not sure which file you want to edit, select a file, then click on the Info button
to see further information about the file, as shown in Figure 51.

Figure 51 The File Info Display

469
MCA Input Definition

The key piece of information here is the File Descriptor, which you added when the file
was first saved. This should help you decide if the file you selected is the one you want to
edit.

Editing the Definition

All of the menus and commands available for defining an MCA are also used for editing
a definition. Just select the entry you want to change and apply the commands as before,
then Save the Definition file.

The New Command

If you want to create a totally new MCA Definition, the File menu’s New command
clears the definition table so you can begin a new definition.

Because New is a destructive operation, selecting it will cause the program to ask for a
confirmation in one of two ways:

1. If the Definition currently being displayed has not been changed since it was last
saved (no asterisk in the Title Bar), you will be asked if you want to erase the
current Definition. Click on OK to erase it, or Cancel to return to the Input
Definition Editor.

2. If the Definition currently being displayed has been changed but not saved, you
will be given a chance to save it.

The Input Definition Report

The File menu’s Report command always saves to a disk file, but if you click on Yes in
the dialog box that pops up, you can send the report to a disk file and print the report as
well. Click on No to save it to a disk file without printing the report.

Using MCA Definition Tables

The whole purpose behind building MCA Input Definitions is to let the DSA-2000 know
the number and types of MCAs you’ll be using with your system. You do this by loading
one or more MCA Definition Files into the MCA Runtime Configuration Database.

This database is shared by all of the programs which make up the DSA-2000 software
package, and is used by those programs to gain access to the actual MCA hardware in
your system. In this section we’ll take a look at the procedures used for setting up that
database.

470
 Using MCA Definition Tables

Viewing the Current Database

To view the current contents of the database, click on the Database menu’s View com-
mand, which will pop up the display shown in Figure . If you click on a line in the list,
you can use the Device and Settings menus to look at details of that definition. Click on
OK to close the View window.

Figure 52 Viewing the Database

Loading and Unloading Definitions

Before you can use an MCA Definition, you’ll have to load it into the database, so we’ll
start with that process. Note that you can’t edit a loaded database; you’ll first have to un-
load it as described in “Unloading the Database” on page 472).

The Load/Unload functions will be disabled while any Acquisition and Analysis applica-
tions are running and have open datasources. This prevents one user from altering the
runtime database while another user is accessing it.

Loading the Database

A new Definition can be loaded into the Database with the Load to command, which
brings up the Dialog Box in Figure 53, which lets you choose the file to be loaded into
the database.

Loading Multiple Definitions

Though you will usually use only one definition at a time, there may be times when you
want to load more than one definition. To do this, be sure that the Input name in each of
the Definition Files is unique.

If you try to load an Input Definition which contains a duplicate Input name, you’ll see
an error message telling you that the requested Definition can’t be loaded.

471
MCA Input Definition

Figure 53 The Load To Dialog

Unloading the Database

Though some of the programmable front end controls, such as ADC Gain or Amplifier
Gain, are initially set with the MCA Input Definition Editor, many may also be adjusted
in the Acquisition and Analysis application while you’re collecting data. These adjust-
ments can be stored in the database (with File | Save), and when you Unload the data-
base, are saved in an Input Definition File for future sessions.

The Unload Process

To unload a Database, click on the Database menu’s Unload from command, which will
bring up the Dialog Box shown in Figure 54. If several choices are listed, there are multi-
ple definitions in the database.

472
 Using MCA Definition Tables

Figure 54 The Unload Dialog

Click on the one you want to unload, then click on the Unload from button. Note that
this menu item is disabled if the MCA Runtime Configuration Database is currently be-
ing used by another application.

473
CAM Files

5. CAM Files
Among the types of data that have to be stored when a sample is counted are: the spec-
trum itself, elapsed timing information, the description of the sample, calibration infor-
mation, and so forth. In addition, if you analyze the data, the results of the analyses must
be stored.

All of these data types are stored in a single place: a CAM file. Access to the data is con-
trolled by subroutines called the Configuration Access Method.

No longer do you have to keep track of multiple files (calibration, data, library, results,
header, and so forth) to recreate an analysis. In the Genie family of products, all of this
data is stored in a single file, so that you can be confident that full sample records are
available.

Additionally, CAM Files allow you to access data by parameter name. If you need to ex-
tract particular information, for special programs for example, you can do so without spe-
cific knowledge of physical data structures: You simply access the data by name.

A CAM file contains two kinds of data: parameters and spectral data. A parameter is a
single number or text string, such as preset real time or the sample identification string,
with each parameter being given a symbolic code by which it can be accessed. Spectral
data is an array of 32-bit integers.

Configuration Data and Parameters

The different kinds of data which make up a configuration are separated into “classes” of
information. The data composing each class of information is considered to be relatively
independent of the data in other classes.

The classes of information are acquisition setup parameters, geometry parameters, sam-
ple parameters, and so forth. A configuration is a collection of data of various classes,
which is stored in “parameter blocks”. In general, there will be only one block of a par-
ticular class per configuration.

New applications may require new classes of information and may require different kinds
and formats of information for existing classes. Therefore, each class is grouped into
“types”, which serve to identify the contents and format of data in a block.

474
 Creating a Configuration

In general, programs will know only about information classes, not the types within a
class.1

The basic unit of configuration data is the “parameter”. (Spectral data is considered sepa-
rately). Each parameter is referenced by a symbolic name or numeric code, and has a par-
ticular data type (such as longword integer, floating point, text string). Examples of
parameters are the elapsed live time, the energy calibration quadratic factor, and the sam-
ple identification string.

For some information classes, such as peak search results, the characteristics of the data
demands that parameters be repeated over and over. Therefore, parameters can be
grouped into “records”, and the records can be repeated as many times as need be (for
peak search results, once for each peak found). This process can be carried one step fur-
ther, where parameters can be grouped within records into “tabular entries”. An example
of this is in the nuclide library, where each record represents one nuclide; for each nu-
clide, there are tabular entries describing the energy lines associated with that nuclide.
Thus, to completely specify a “record tabular” parameter, one would have to indicate the
parameter name or code, the record number, and the tabular entry number. (Parameters
which are not contained in records or tabular entries are called “common” parameters).

Spectral data access is handled through a separate mechanism, since it is generally ac-
cessed in bulk amounts. A particular channel is specified by its channel number (starting
from 1) and its row number (for dual parameter spectra; this terminology replaces the old
term “groups” in this context). Spectral data is always treated as 32-bit signed integers.

Creating a Configuration
A configuration can be created in one of three ways using Genie 2000/Genie-PC soft-
ware:

1. Via the MID Editor Save function (this is how hardware datasources are
created).

2. Via the FILECNVT command.

3. Via the MOVEDATA command.

1. Though some classes of data in this chapter are not supported by Genie 2000/Genie-PC software, they are included here
for completeness and for consistency with Genie-VMS documents.

475
CAM Files

Initial Parameters
Whenever a configuration is created, a set of CAM operating parameters is automatically
initialized with the following default values, many of which are common to all detectors
types and some of which are dependent on the specific detector type.

Values Common to All Detector Types

CAM Parameter Value

CAM_L_BYTES 4

CAM_L_ROWS 1

CAM_L_GROUPS 1

CAM_L_ECFENCAL 1

CAM_L_ECFFWCAL 1

CAM_L_ECFT1CAL 1

CAM_L_ECALTERMS 0

CAM_L_ITERATIONS 10

CAM_L_PEAKSTART 1

CAM_L_PASTART 1

CAM_L_MSCHANS 19

CAM_L_NBACKTERMS 2

CAM_L_PRGAINSHFT 1

CAM_L_MAXGAINPASS 10

CAM_L_NSIGMA 1

CAM_L_SHOWROIS 1

CAM_L_DOUNKSRCH 1

CAM_L_CURSORCH 1

CAM_L_RPTFSCREEN 1

CAM_L_RPTFNEWFILE 1

CAM_L_PEAKEND 65535

CAM_L_PAEND 65535

CAM_F_FWHMCONST 50.0

CAM_F_SQUANT 1.0

CAM_F_SENSITVTY 3.0

CAM_F_CHISENSITVTY 4.0

476
 Initial Parameters

CAM_F_RSENSITVTY 4.0

CAM_F_SECSENS 1.75

CAM_F_SUMSENSITVTY 1.0

CAM_F_SQUANTMULT 1.0

CAM_F_OVERWIND1 0.3

CAM_F_OVERWIND2 0.3

CAM_F_REJMDASIG 2.5

CAM_F_REJMDACONST 3.0

CAM_F_UNIDCONST 6.0

CAM_F_HALFLIFERAT 8.0

CAM_F_ABUNDANLIM 75.0

CAM_F_WTMLIMIT 3.0

CAM_F_MDACONFID 5.0

CAM_F_ACTIVMULT 1.0

CAM_F_CONFID 0.3

CAM_F_SIGMA 1.0

CAM_F_MDAADDCONST 2.71

CAM_F_MDAMULTCONST 3.29

CAM_T_ECALTYPE POLY

CAM_T_SUNITS Unit

CAM_T_ROIPSTYP Net

CAM_T_GAINSHIFT AUTO

CAM_T_WEIGHTING Derived

CAM_T_ACTIVUNITS µCi
CAM_F_PRFWHMPKLEFT 2.0

CAM_F_PRFWHMPKRGHT 2.0

CAM_F_PRFWHMPKMULT 5.0

CAM_F_UNIDREJ 3.0

CAM_F_DCSAMPDIST 0.5

477
CAM Files

Values Dependent on the Detector Type

CAM Parameter Alpha NaI Ge

CAM_L_BACKGNDCHNS 0 4 4

CAM_L_PRNBKCHN 0 4 4

CAM_L_USEAVRG 1 0 0
2
CAM_F_ECSLOPE 10000.0 2048.0 2048.0

CAM_F_ECALCNV 1000.0 1.0 1.0

CAM_F_FWHMOFF 25.0 -7.0 1.0

CAM_F_FWHMSLOPE 0.0 2.0 0.03

CAM_F_ECALTOL 25.0 30.0 1.5

CAM_F_VARECALTOL 1.0 0.75 1.5

CAM_F_GSENSITVTY 35.0 35.0 10.0

CAM_F_AREAWIND1 1.0 1.0 2.5

CAM_F_AREAWIND2 1.5 1.5 3.0

CAM_F_INTFWIND1 1.5 1.5 3.0

CAM_F_INTFWIND2 2.5 2.5 4.0

CAM_F_BACKREJ 1.0 1.0 0.0

CAM_F_VARREJ 1.0 1.0 0.0

CAM_F_GAINREJ 0.005 0.005 0.0001

CAM_F_UNIDETOL 0.5 0.5 1.5

CAM_F_TOLERANCE 20.0 20.0 1.0

CAM_F_VPWIDTH 3.0 1.2 3.0

CAM_F_VARTOLERANCE 0.5 0.5 1.0

3
CAM_T_EXPLIB ALPHA.NLB STDLIB.NLB STDLIB.NLB
3
CAM_T_PEAKLIB ALPHA.NLB STDLIB.NLB STDLIB.NLB
3
CAM_T_REPTEMPLATE ALPHA.TPL ANALYSIS.TPL ANALYSIS.TPL

CAM_T_ECALUNITS MeV keV keV

CAM_T_FWCALTYPE CONSTANT SQRT SQRT

CAM_T_EFFTYPE AVERAGE DUAL DUAL

2. This number is divided by the number of channels in the configured ADC.

3. These include the full path name, found using the proper environment variable.

478
 Configuration Parameter Descriptions

CAM_T_ROIPSBTYP NONE STEP STEP

CAM_T_RPTSECTNAME µCi_Report HEADER HEADER

CAM_L_PRUSEVBKCHN 0 1 1

Configuration Parameter Descriptions

Configuration parameters are described in the following sections, one section per infor-
mation class. The classes described are:

1. Acquisition parameters. This class describes the setup of the configuration’s

electronics, contains calibration information, and describes the current state of
the configuration.

2. Sample parameters. This class describes the sample, or whatever is being

measured.

3. Geometry parameters. This class describes the relationship between the sample
and the detector system (for instance, efficiency).

4. Processing parameters. This class describes how the data is to be processed, and
some of the results of that processing.

5. Data. This class actually contains the spectral data acquired.

6. Peak Search results. This class describes the results of the peak search analysis.

7. NID results. Actually two classes of information (one for nuclides and one for
energy lines), these classes both describe the nuclides searched for by NID, and
contain the results of the analysis.

8. Display parameters. This class describes how the data is displayed.

9. Certificate parameters. This class contains the information that describes a

certificate file.

10. Calibration Results parameters. These two classes of information are used to
store intermediate data (energy/channel pairs, etc.) used to calculate the
calibration equations.

11. Analysis Control parameters. This class describes the contents of Analysis
Sequence Files.

479
CAM Files

12. QA File parameters. These two classes of information are used to described both
the definitions (QA Parameter Definitions) and actual QA data (QA Results)
stored in a Genie QA file.

13. Miscellaneous parameters. There are numerous other classes of information that
are used to store application specific (e.g. Whole Body Counting, Safeguards
systems) sets of parameters and data.

Each parameter’s symbolic code is listed with a brief description. The symbolic codes all
have a standard format:

CAM_type_name

where “name” is the name of the parameter, and “type” specifies the returned type of the
parameter, as given below:

B – byte

W – word (INTEGER*2)

L – longword (INTEGER*4)

Q – quadword

F – floating point (REAL*4) 4

D – double precision floating point (REAL*8)

G – G format double precision floating point (REAL*8)

X – date/time (both absolute and delta).

T – character string (CHARACTER*n)

For example, the elapsed live time parameter has the symbolic code CAM_X_ELIVE.
The “X” specifies that the parameter is a date-time stamp. “ELIVE” is the name of the
parameter. The energy calibration offset parameter is identified by CAM_F_ECOFFSET.
The “F” specifies that the parameter is a F format floating point number (REAL*4);
“ECOFFSET” is the name of the parameter.

4. Floating point values are stored in DEC format.

480
 Acquisition Parameters

Flag Parameters
A number of parameters are “flag words”: each bit in the parameter has a particular mean-
ing. For example, the first bit in the preset mode flags parameter (CAM_L_PMODE)
means that acquisition should terminate after running for a certain amount of live time.
Each of these bits in the flag words have a symbolic code, with the format:

CAM_M_flagname_bitname

Where “flagname” identifies the flag word and “bitname” identifies the bit in that word.

Individual Parameters
Many of these flags can also be accessed as individual parameters; this is especially use-
ful in editors. In the CAM Parameters listings, each individual parameter is shown in
brackets below its flag parameter. For example:

CAM_M_PMOD_LIVE Terminate on preset livetime

[CAM_L_PMLIVE]

Acquisition Parameters
The acquisition parameter block is composed of common parameters relating to the entire
configuration, and a number of records, each record describing an input ADC to the con-
figuration. The symbolic name for this class is CAM_CLS_ACQP.

Common Parameters
CAM_T_CTITLE Configuration title (32 characters) (see note 1 on
page 504)

CAM_T_CPNAME Configuration physical name (32 characters)

CAM_T_ACQMOD Acquisition mode (PHA+, PHA–, MCS+, etc.)

(4 chars)

CAM_L_CMASK Coincidence mask

CAM_L_BYTES Bytes/channel

CAM_L_CHANNELS Channels/row

CAM_L_ROWS Number of rows

CAM_L_GROUPS Number of groups

CAM_L_EXTRA Number of extra bytes/channel

481
CAM Files

CAM_F_ASAMPDIST Shelf-detector distance (mm)

CAM_L_PMODE Preset mode flags

CAM_M_PMOD_LIVE Terminate on preset livetime

[CAM_L_PMLIVE]

CAM_M_PMOD_REAL Terminate on preset real time

[CAM_L_PMREAL]

CAM_M_PMOD_SWEEPS Terminate on preset sweeps

[CAM_L_PMSWEEPS]

CAM_M_PMOD_TOTALS Terminate on preset totals

[CAM_L_PMTOTALS]

CAM_M_PMOD_LEVEL Terminate on preset level

[CAM_L_PMLEVEL]

CAM_M_PMOD_AREA Terminate on preset net area

[CAM_L_PMAREA]

CAM_M_PMOD_PERR Terminate on preset percent error

[CAM_L_PMPERR]

CAM_F_ACQAIRTEMP Air temperature (°C)

CAM_F_ACQAIRPRESS Barometric pressure (in mm)

CAM_F_ACQHUMIDITY Relative humidity (in percent)

CAM_X_PREAL Preset real time

CAM_X_PLIVE Preset live time

CAM_X_MAXPLIVE Maximum preset live time (used by “count to

minimum MDA” applications)

CAM_L_PTOTAL Preset total counts

CAM_L_PSWEEPS Preset sweeps

CAM_L_PLEVEL Preset level

CAM_L_PTSCHAN Preset total area start channel

CAM_L_PTSROW Preset total area start row

CAM_L_PTECHAN Preset total area end channel

482
 Acquisition Parameters

CAM_L_PTEROW Preset total area end row

CAM_F_PAREA Preset net area

CAM_F_PPERR Preset net area % error

CAM_F_PNETENG Preset net counts energy

CAM_F_DWELL MCS dwell time (seconds)

CAM_F_ECOMP Elapsed computational preset

CAM_L_ESWEEPS Elapsed sweeps

CAM_L_ACQPHYSADDR Acquisition memory address

CAM_Q_TOTALEVENTS Total number of events (MPA only)

CAM_L_PARAMSEVENT Parameters (words) per event

CAM_L_AGROUP Current acquire group

CAM_L_ACQINTVEC Interrupt vector (/4)

CAM_T_ACQOPNAME Name of person who acquired spectrum (32

characters) (see note 1 on page 504)

CAM_L_BACKGNDCHNS Channels used for display background

CAM_F_DTLIMIT Deadtime limit (%); used by stack monitor if

DODTTEST is true

CAM_L_ACQNUMMEAS Number of replicate measurements requested

CAM_L_ACQNUMMEASA Number of replicate measurements actually per-

formed

CAM_L_DSCOPESFAC Digital scope smoothing factor (1-32)

CAM_L_ACQMFLGS Acquisition mode flags

CAM_M_ACQMF_WAITACQCOMP Wait for acquisition complete

[CAM_L_WAITACQCOMP]

CAM_M_ACQMF_DETNOTAVAIL Detector not available

[CAM_L_DETNOTAVAIL]

CAM_M_ACQMF_DETHASSC Detector associated with serial sample

[CAM_L_DETHASSC] changer

CAM_M_ACQMF_SCMANUAL Sample changer in manual mode

[CAM_L_SCMANUAL]

483
CAM Files

CAM_M_ACQMF_SCIGNORETO Ignore sample changer timeout

[CAM_L_SCIGNORETO]A +

CAM_M_ACQMF_MEETMDA Count until required MDAs are met

[CAM_L_MEETMDA]

CAM_M_ACQMF_DODTTEST Perform deadtime limit test

[CAM_L_DODTTEST]

CAM_M_ACQMF_SCAN This is a scanning detector

[CAM_L_ACQFSCAN]

CAM_M_ACQMF_SEG This is a segmented detector

[CAM_L_ACQFSEG]

CAM_M_ACQMF_MSS MSS data is collected for this detector

[CAM_L_ACQFMSS]

CAM_M_ACQMF_TRANS This data includes transmission peaks

[CAM_L_ACQFTRANS]

CAM_M_ACQMF_COLLIMATOR This counter has a selectable collimator/

[CAM_L_ACQFCOLLIMAT] geometry

CAM_M_ACQMF_AUTOCOL Automatic collimator

[CAM_L_ACQFAUTOCOL]

CAM_M_ACQMF_SEPSEG Segments are separated (vs. adjacent)

[CAM_L_ACQFSEPSEG]

CAM_M_ACQMF_DOSEDONE Dosimeter assay has been performed

[CAM_L_WACQDOSEDONE]

CAM_M_ACQMF_HELSCAN Do helical scan

[CAM_L_WACQHELSCAN]

CAM_M_ACQMISGAMMA NDA 2000 gamma target

[CAM_L_ACQMF_ISGAMMA]

CAM_M_ACQMISNEUT NDA 2000 neutron target

[CAM_L_ACQMF_ISNEUT]

CAM_M_ACQMF_ISDDAMCS NDA 2000 DDA/MCS target

CAM_M_ACQMF_ISQUANTG NDA 2000 Quantitative gamma results file

CAM_M_ACQMF_ISMEASISO NDA 2000 Measured isotopics results file

CAM_M_ACQMF_ISSHUFFMCS NDA 2000 Shuffler MCS target

484
 Acquisition Parameters

CAM_L_ASTATUS Acquisition status flags

CAM_M_ASTF_ACQUIRE Acquisition state (on-true/off-false)

[CAM_L_ACQUIRE]

CAM_M_ASTF_CCFEMOD Module modified during acquisition

[CAM_L_ASTFCCFEMOD]

CAM_M_ASTF_BADCAL Bad calibration data in configuration

[CAM_L_ASTFBADCAL]

CAM_M_ASTF_CCERR Computer controlled NIM error

[CAM_L_ASTFCCERR]

CAM_M_ASTF_RAMBACK RAM is battery backed-up (Inspector only)

[CAM_L_ASTFRAMBACK]

Sample Changer Parameters

CAM_T_SCADDRESS ICB address for sample changer (14 characters)

CAM_T_CHANGERTYPE Sample changer type (8 characters)

CAM_T_CHANGERID Sample changer serial number (8 characters)

CAM_L_SCHANGER Sample changer status

CAM_L_SCMAXSAMPLES Sample changer capacity (samples)

CAM_L_PLCHERROR PLC hard error register

CAM_L_PLCSERROR PLC soft error register

CAM_L_PLCOOSREASON PLC out-of-service register

Neutron Shift Register (JSR-12) Parameters

CAM_L_SRHVPS HVPS voltage

CAM_F_SRGATEWIDTH Gate width (µs)

CAM_F_SRPREDELAY Predelay (µs)

CAM_X_SRCOUNTTIME Preset cycle count time

CAM_X_SRPRESETTIME Total preset count time

(SRPRESETTIME/SRCOUNTTIME measure-
ment cycles will be made)

CAM_T_SRGAMDETNAME Name of the gamma detector associated with the

neutron detector (16 characters)

485
CAM Files

CAM_T_SRADDRESS Address (or device name) of the shift register

(10 characters)

CAM_T_SRIDENT Identification/serial number of the shift Register

(16 characters)

CAM_F_SRLONGDELAY Long delay time (µs)

Power Management Parameters

(Inspector only)

CAM_T_PWRMTYPE Power Management module type (8 characters)

CAM_T_PWRMID Power Management module identification (8

characters)

CAM_L_PWRMSTBYDELY Standby delay time (minutes)

CAM_L_ACQSTRTDELAY Acquisition start delay time (seconds)

CAM_T_PWRMMODE Power Management mode (Full, Save, AC) (4

characters); the InSpector 2000 stores A/C in-
stead of AC

CAM_L_PWRMBATTERY Number of battery selected

CAM_T_PWRMBATA Battery A status (Good, Low, Bad) (4 charac-

ters)

CAM_T_PWRMBATB Battery B status (Good, Low, Bad) (4 charac-

ters)

CAM_F_PWRMBATAVOLT Battery A voltage

CAM_F_PWRMBATBVOLT Battery B voltage

CAM_L_PWRMFLAGS Power management flags

CAM_M_PWRM_BATS Both batteries are discharged to the warning

[CAM_L_PWRMFBATS] level

CAM_M_PWRM_COMM Communications between the MCA and the

[CAM_L_PWRMFCOMM] Power Manager have failed

CAM_M_PWRM_BATSEL Battery select: True=A, False=B

[CAM_L_PWRMFBATSEL]

CAM_M_PWRM_RESET The MCA has undergone a power reset

[CAM_L_PWRMFRESET]

486
 Acquisition Parameters

CAM_M_PWRM_FAULT ±12 V supply fault

[CAM_L_PWRMFFAULT]

Segmented Gamma Scanner Parameters

CAM_L_WACQNSEG Highest segment number (stored as UBYTE)

CAM_L_WACQSKIPSEGS Number of initial segments to skip

CAM_F_WACQSEGWIDTH Segment width (mm)

CAM_F_WACQSEGCTIME Segment count time (seconds)

CAM_F_WACQTRCTIME Transmission count time (seconds)

CAM_F_WACQOFFSET Starting position from drum bottom (mm)

CAM_F_WACQSTEPLEN Steps/mm

CAM_T_WACQADDRESS Motor controller device address (12 characters)

CAM_T_WACQMCTYPE Motor controller type (8 characters)

CAM_T_WACQROTSPEED Rotation speed (rpm)

CAM_L_ACQFWACQREAL Flag in ACQMFLGS: count times are real times

(default is live times)

CAM_T_WACQPASSMODE SGS pass mode: “One pass with”, “One pass

without”, “Two pass” (16 chars)

CAM_F_WACQDELTA Increments in mm to move scanning platform

per position

CAM_L_WACQNPOS Number of scan platform positions

CAM_L_WACQPOS Scan platform position

CAM_L_WACQDET Relative detector number

CAM_L_WACQTRANSRC Transmission source number (0-n)

CAM_L_WACQCOLPOS Collimator/geometry position (0-n)

CAM_L_WACQSEGMENT Current segment number

CAM_F_WACQAVEDOSE Average dose for the first dosimeter (µSv/hr)

CAM_F_WACQMAXDOSE Maximum dose for the first dosimeter (µSv/hr)

487
CAM Files

CAM_L_WACQDOSETYP1 The characteristics of the first dosimeter: 0 = un-

known or not available; 1 = far; 2 = near, to the
side; 3 = near, on the top; 4 = near, on the
bottom

CAM_F_WACQAVEDOSEn Average dose for the nth dosimeter (µSv/hr),

where n is 2 to 8

CAM_F_WACQMAXDOSEn Maximum dose for the nth dosimeter (µSv/hr),

where n is 2 to 8

CAM_L_WACQDOSETYPn The characteristics of the nth dosimeter, where n

is 2 to 8. See WACQDOSETYP1

CAM_F_WACQAVEDOSED Average reading from “distant” dosimeter

CAM_F_WACQMAXDOSED Maximum reading from “distant” dosimeter

CAM_L_WACQSEGVIEWS Number of TGS views per segment

CAM_L_WACQSEGCELLS Number of TGS cells per segment

CAM_L_ATGSSCANMODE TGS scanning mode: 0 = traverse starts at edge

of item, 1 = traverse starts at center of item

CAM_F_SHFDWELLHOME Shuffler home position dwell time (seconds)

CAM_F_SHFDWELLITEM Shuffler item position dwell time (seconds)

CAM_L_PSHUFFLES Preset shuffles

CAM_L_ESHUFFLES Elapsed shuffles

CAM_F_WACQDUALGSEP Dual gamma tower separation distance (mm)

CAM_L_WACQDUALGMOD Dual gamma tower scanning mode

CAM_L_WACQDETGEOM Dual gamma tower geometrical position mask

CAM_L_WACQFREVSCAN Reverse platform scan direction

CAM_L_ACQFGAINSTBL Enable gain stabilization

Neutron Generator Parameters

CAM_F_AZETARATE Neutron generator pulse rate (Hz)

488
 Acquisition Parameters

Dose Calibration Parameters

CAM_F_ADBIFACA Dose-by-isotope calibration factor A. These fac-
tors are used by the dose-by-isotope calculation
engine: dose = net cps * (A + B*e + C*e2 + D*e3
+ E*e4), where e is the photopeak energy in keV.

CAM_F_ADBIFACB Dose-by-isotope calibration factor B

CAM_F_ADBIFACC Dose-by-isotope calibration factor C

CAM_F_ADBIFACD Dose-by-isotope calibration factor D

CAM_F_ADBIFACE Dose-by-isotope calibration factor E

CAM_F_AFSDFACA Full-spectrum dose low-energy curve calibration

factor A. The form of the full-spectrum dose
low-energy equation is dose = A*e + B*e 2 +
C*e3 + D*e4, where e is the average spectrum
energy in keV.

CAM_F_AFSDFACB Full-spectrum dose low-energy curve calibration

factor B

CAM_F_AFSDFACC Full-spectrum dose low-energy curve calibration

factor C

CAM_F_AFSDFACD Full-spectrum dose low-energy curve calibration

factor D

CAM_F_AFSDFACE Full-spectrum dose high-energy curve calibration

factor E. The form of the full-spectrum dose
high-energy equation is dose = E * eF.

CAM_F_AFSDFACF Full-spectrum dose high-energy curve calibra-

tion factor F

CAM_F_AFSDFACG Full-spectrum dose calibration calibration cross-

over energy, in keV: below this energy, the
low-energy equation will be used; at or above
this energy, the high-energy equation will be
used.

CAM_F_APMNOMTHRESH Nominal threshold

CAM_F_APMHYSTFAC Hysteresis factor

CAM_F_AGAMDOSERATE Instantaneous gamma dose rate (µSv/h)

CAM_F_ANEUTDOSERAT Instantaneous neutron dose rate (µSv/h)

CAM_F_AGAMCOUNTRAT Instantaneous gamma count rate

489
CAM Files

CAM_F_ANEUTCOUNTRA Instantaneous neutron count rate

Vendor Spare Common Acquisition Parameters

CAM_F_CHSPn Hardware spare parameter n, where n is 1 to 5

User Spare Common Acquisition Parameters

CAM_F_ASPn User spare floating value n, where n is 1 to 3

Common Tabular Parameters

CAM_X_ASTIME Acquisition start time (see note 2 on page 504)

CAM_X_EREAL Elapsed real time (see note 2 on page 504)

CAM_X_ELIVE Elapsed live time (see note 2 on page 504)

Record Parameters

High Voltage Power Supply Parameters

CAM_T_HVPSADDRESS ICB address for high voltage supply (10 charac-
ters)

CAM_T_HVPSTYPE Type (8 characters)

CAM_T_HVPSID HVPS serial number (8 characters)

CAM_F_VOLTAGE HVPS high voltage setting

CAM_F_HVPSVOLTLIM HVPS voltage limit

CAM_F_HVPSRANGE HVPS range (+ or – and value) (Inspector only)

CAM_F_HVPSLEAKAGE Leakage current (nA) (Alpha Analyst only)

CAM_L_HVPSFLAGS HVPS flags

CAM_M_HVPSF_OVLE Overload latch enable

[CAM_L_HVPSFOVLE]

CAM_M_HVPSF_INHLE Inhibit latch enable

[CAM_L_HVPSFINHLE]

CAM_M_HVPSF_LVINH 5 V/12 V inhibit

[CAM_L_HVPSFLVINH]

490
 Acquisition Parameters

CAM_M_HVPSF_POL Output polarity

[CAM_L_HVPSFPOL]

CAM_M_HVPSF_INH Inhibit
[CAM_L_HVPSFINH]

CAM_M_HVPSF_OV Overload
[CAM_L_HVPSFOV]

CAM_M_HVPSF_STAT Status (on/off)

[CAM_L_HVPSFSTAT]

CAM_M_HVPSF_ONLINE HVPS on-line

[CAM_L_HVPSFONLINE]

CAM_M_HVPSF_OVINRES HVPS inhibit/overload reset

[CAM_L_HVPSFOVINRES]

CAM_M_HVPSF_ATTEN Module attention required

[CAM_L_HVPSFATTEN]

CAM_M_HVPS_FAULT HVPS fault

[CAM_L_HVPSFAULT]

CAM_M_HVPSF_ALARMS S5000 HV alarms enable

[CAM_L_HVPSFALARMS]

CAM_M_HVPSF_SHUTDN S5000 HV shut down

[CAM_L_HVPSFSHUTDN]

CAM_L_HVPSVFLAGS HVPS verification failure flags field

CAM_M_HVPSVF_ID ID verification failure

[CAM_L_HVPSVFID]

CAM_M_HVPSVF_VOLT Voltage verification failure

[CAM_L_HVPSFVOLT]

CAM_M_HVPSVF_OVLE Overload latch enable verification failure

[CAM_L_HVPSVFOVLE]

CAM_M_HVPSVF_INHLE Inhibit latch enable verification failure

[CAM_L_HVPSVFINHLE]

CAM_M_HVPSVF_LVINH 5 V/12 V inhibit verification failure

[CAM_L_HVPSVFLVINH]

CAM_M_HVPSVF_POL Output polarity verification failure

[CAM_L_HVPSVFPOL]

491
CAM Files

CAM_M_HVPSVF_STAT Status verification failure

[CAM_L_HVPSVFSTAT]

Amplifier Parameters
CAM_T_AMPADDRESS ICB address for amplifier (10 characters)

CAM_T_AMPTYPE Amplifier type (8 characters)

CAM_T_AMPID Amplifier serial number (8 characters)

CAM_T_PRAMPTYPE Preamplifier type (RC, TRP) (8 characters)

CAM_F_AMPGAIN Amplifier gain

CAM_F_AMPHWGAINn Hardware dependent amp gain n, where n is 1 to 3

CAM_T_AMPSHAPEMODE Amplifier shaping mode (8 characters)

CAM_L_AMPPZ Amplifier pole/zero

CAM_T_AMPBLRTYPE Base-line restoration type (SYM, ASYM) (8

characters)

CAM_T_AMPDTCTYPE Dead-time control type (Normal, LFC) (8 char-

acters)

CAM_F_AMPTC Amplifier time constant (µs)

CAM_F_AMPPENERGY Pulser energy (MeV) (Alpha Analyst only)

“Pulser energy”

CAM_F_AMPPGAIN Pulser energy vs. value slope (Alpha Analyst

only) “Pulser gain”

CAM_F_AMPPOFFSET Pulser offset

CAM_F_AMPFILTERRT DSP Filter Rise Time

CAM_F_AMPFILTERFT DSP Filter Flat Top duration

CAM_T_AMPFDMODE DSP Fast Discriminator Mode

CAM_F_AMPFD DSP Fast Discriminator Setting

CAM_F_AMPPURG DSP PUR Guard Setting

CAM_L_AMPLTTRIM Live time correction adjustment

CAM_F_AMPICR Incoming count rate

CAM_L_AMPINPUTCTRL S5000 input control mode: 0 = preamp, 1 = am-

plifier, 2 = ADC

492
 Acquisition Parameters

CAM_F_AMPDISCRIM S5000 discriminator

CAM_L_AMPFLAGS Amplifier mode flags (front panel switches)

CAM_M_AMPF_DIFF Differential (vs. normal) input

[CAM_L_AMPFDIFF]

CAM_M_AMPF_NEGPOL Negative (vs. positive) polarity

[CAM_L_AMPFNEGPOL]

CAM_M_AMPF_COMPINH Complement inhibit polarity

[CAM_L_AMPFCOMPINH]

CAM_M_AMPF_PUREJ Pileup rejection enable/disable

[CAM_L_AMPFPUREJ]

CAM_M_AMPF_ONLINE Amplifier on-line

[CAM_L_AMPFONLINE]

CAM_M_AMPF_MOTRBUSY Amplifier motor busy

[CAM_L_AMPFMOTRBUSY]

CAM_M_AMPF_PZBUSY Amplifier pole/zero adjust busy

[CAM_L_AMPFPZBUSY]

CAM_M_AMPF_ATTEN Module attention required

[CAM_L_AMPFATTEN]

CAM_M_AMPF_PZSTART Start auto pole/zero adjust

[CAM_L_AMPFPZSTART]

CAM_M_AMPF_PZFAIL Auto pole/zero adjust failed

[CAM_L_AMPFPZFAIL]

CAM_M_AMPF_MOTRFAIL Amplifier motor has failed

CAM_M_AMPF_INPATT Input attenuator enabled (Inspector only)

[CAM_L_AMPFINPATT]

CAM_M_AMPF_INHTRP TRP Inhibit mode (off=Auto, on=Manual)

[CAM_L_AMPINHTRPMOD] (DSP only)

CAM_M_AMPF_PULSER Pulser enabled (Alpha Analyst only)

[CAM_L_AMPFPULSER] “Pulser”

CAM_L_LLDAUTOMODE LLD Mode: Auto vs. Manual (bit in

CAM_L_AMPFLAGS:
CAM_M_AMPF_AUTOMODE)

493
CAM Files

CAM_L_GAINATTMODE Gain Attenuator on/off (bit in

CAM_L_AMPFLAGS:
CAM_M_AMPF_ATTMODE)

CAM_L_AMPVFLAGS Amplifier verification failure flags field

CAM_M_AMPVF_ID ID verification failure

[CAM_L_AMPVFID]

CAM_M_AMPVF_PRAMPT Preamp type verification failure

[CAM_L_AMPVFPRAMPT]

CAM_M_AMPVF_HWGAINn HW gain n verification failure, where n is 1 to

[CAM_L_AMPVFHWGAINn] 3

CAM_M_AMPVF_SHAPEM Shaping mode verification failure

[CAM_L_AMPVFSHAPEM]

CAM_M_AMPVF_PZ Pole/zero verification failure

[CAM_L_AMPVFPZ]

CAM_M_AMPVF_BLRTYPE Base-line restore type verification failure

[CAM_L_AMPVFBLRTYPE]

CAM_M_AMPVF_DTCTYPE Dead-time control type verification failure

[CAM_L_AMPVFDTCTYPE]

CAM_M_AMPVF_TC Time constant verification failure

[CAM_L_AMPVFTC]

CAM_M_AMPVF_NEGPOL Negative polarity verification failure

[CAM_L_AMPVFNEGPOL]

CAM_M_AMPVF_COMPINH Complement inhibit verification failure

[CAM_L_AMPVFCOMPINH]

CAM_M_AMPVF_PUREJ Pileup rejection verification failure

[CAM_L_AMPVFPUREJ]

CAM_M_AMPVF_DIFF Differential input verification failure

[CAM_L_AMPVFDIFF]

Gain Device
CAM_T_GAINADDRESS ICB address for the gain device (10 chars)

CAM_T_GAINTYPE Gain device type (8 chars)

CAM_T_GAINID Gain device serial number (8 chars)

494
 Acquisition Parameters

CAM_F_GAININHIBIT Gain inhibit setting (microseconds) (put with

other GAINxxx parameters)

Filter Device
CAM_T_FLTADDRESS ICB address for the filter device (10 chars)

CAM_T_FLTTYPE Filter device type (8 chars)

CAM_T_FLTID Filter device serial number (8 chars)

Digital Spectrum Stabilizer Parameters

CAM_T_DSSADDRESS ICB address for DSS (10 characters)

CAM_T_DSSTYPE DSS type (8 characters)

CAM_T_DSSID DSS serial number (8 characters)

CAM_F_DSSWIN1AR Analog range window 1

CAM_F_DSSWIN2AR Analog range window 2

CAM_T_DSSWIN1MODE Window 1 mode (OFF, ON, HOLD) (4 charac-

ters)

CAM_T_DSSWIN2MODE Window 2 mode (OFF, ON, HOLD) (4 charac-

ters)

CAM_L_STABWIN1C Stabilization window 1 centroid channel

CAM_L_STABWIN1R Stabilization window 1 range (channels)

CAM_L_STABWIN1S Stabilization window 1 spacing (channels)

CAM_L_STABWIN2C Stabilization window 2 centroid channel

CAM_L_STABWIN2R Stabilization window 2 range (channels)

CAM_L_STABWIN2S Stabilization window 2 spacing (channels)

CAM_F_STABRATE Stabilization rate for window 1 (in seconds)

CAM_F_STABRATE2 Stabilization rate for window 2 (in seconds)

CAM_F_STABCORR1 Window 1 correction factor

CAM_F_STABCORR2 Window 2 correction factor

CAM_L_DSSEVMULT1 Window 1 event multiplier factor

CAM_L_DSSEVMULT2 Window 2 event multiplier factor

495
CAM Files

CAM_F_DSSZERORATIO Zero window ratio

CAM_F_DSSGAINRATIO Gain window ratio

CAM_L_DSSFLAGS DSS flags

CAM_M_DSSF_W1RNG Use NaI range for window 1

[CAM_L_DSSFRNGWIN1]

CAM_M_DSSF_W2RNG Use NaI range for window 2

[CAM_L_DSSFRNGWIN2]

CAM_M_DSSF_OVERRNG Overrange
[CAM_L_DSSFOVERRNG]

CAM_M_DSSF_OVERRNG1 Window 1 overrange

[CAM_L_DSSFOVERRNG1]

CAM_M_DSSF_OVERRNG2 Window 2 overrange

Loss-Free-Counting Module Parameters

CAM_T_LFCADDRESS ICB address for LFC (10 characters)

CAM_T_LFCTYPE LFC module type (8 characters)

CAM_T_LFCID LFC module serial number (8 characters)

CAM_L_LFCFLAGS LFC module flags field

MCS/MSS Module Parameters

CAM_T_MCSTYPE MCS type (8 characters)

CAM_T_MCSID MCS serial number (8 characters)

CAM_T_MCSADDRESS Address of MCS/DMSS on the ICB

CAM_L_MCSINPUT DMSS input number

CAM_L_MCSGROUPS Number of MSS groups

CAM_F_MCSSCANWSIZE Scan window

CAM_F_MCSSCANSTART Scan start

CAM_F_MCSSCANEND Scan end

CAM_F_MCSLLD SCA LLD

CAM_F_MCSULD SCA ULD

496
 Acquisition Parameters

CAM_L_MCSFLAGS MCS flags field

CAM_M_MCSF_EXTCLOCK External (vs. internal) clock

[CAM_L_MCSEXTCLOCK]

CAM_M_MCSF_DATA1ST Put MSS data first

[CAM_L_MCSDATA1ST]

CAM_M_MCSF_EXTADV External (vs. internal) advance

[CAM_L_MCSEXTADV]

CAM_M_MSCF_SWMODE If 0, the MCS unit adds the results of the

[CAM_L_MSCFSWMODE] current sweep to each channel; if 1, the
channel contents are replaced

CAM_M_MSCF_EXTSTART Enable external start (DSA 2000)

[CAM_L_MSCFEXTSTART]

CAM_M_MSCF_EXTSTOP Enable external stop (DSA 2000)

[CAM_L_MSCFEXTSTOP]

CAM_M_MSCF_SWDONE If 1, the final sweep was completed; if 0, the

[CAM_L_MSCFSWDONE] final sweep was partial

Multiplexer Parameters
CAM_T_MUXTYPE Multiplexer type (8 characters)

CAM_T_MUXID Multiplexer serial number (8 characters)

CAM_L_FIRSTMUXINP Number of mux input for group 1

CAM_T_MUXMODE Multiplexer mode (8 characters)

CAM_L_MUXINPUTS Number of multiplexer inputs

CAM_L_MUXFLAGS Multiplexer flags field

CAM_M_MUXF_DEPMUX Dependent (vs. independent) multiplexer

[CAM_L_MUXFDEPMUX]

ADC Parameters
CAM_T_ADCADDRESS ICB address for ADC (10 characters)

CAM_T_ADCTYPE ADC Type (8 characters)

CAM_T_ADCID ADC serial number (8 characters)

497
CAM Files

CAM_L_ADCRANGE ADC range

CAM_L_ADCOFFSET ADC offset

CAM_T_ADCACQMODE ADC acquisition mode (PHA, SVA) (8 charac-

ters)

CAM_T_ADCPNAME ADC physical name (31 characters)

CAM_L_CNVGAIN Conversion gain

CAM_F_LLD Lower level discriminator

CAM_F_THRESHOLD ADC LLD threshold

CAM_F_ULD Upper level discriminator

CAM_F_ZERO Zero

CAM_F_STROBE Strobe timing (seconds)

CAM_L_ADCFLAGS ADC mode flags

CAM_M_ADCF_ANTIC Anti-coincidence mode

[CAM_L_ADCFANTIC]

CAM_M_ADCF_LATEC Late (vs. early) coincidence mode

[CAM_L_ADCFLATEC]

CAM_M_ADCF_DELPK Delayed (vs. auto) peak detect

[CAM_L_ADCFDELPK]

CAM_M_ADCF_CIMCAIF CI (vs. ND) ADC interface

[CAM_L_ADCFCIMCAIF]

CAM_M_ADCF_NONOV Non-overlap transfer mode

[CAM_L_ADCFNONOV]

CAM_M_ADCF_ONLINE ADC on-line

[CAM_L_ADCFONLINE]

CAM_M_ADCF_LTCPUR LTC/PUR signal

[CAM_L_ADCFLTCPUR]

CAM_M_ADCF_ATTEN Module attention required

[CAM_L_ADCFATTEN]

CAM_M_ADCF_AMPINTERNAL Use internal amplifier (Inspector only)

[CAM_L_AMPINTERNAL]

498
 Acquisition Parameters

CAM_L_ADCVFLAGS ADC verification failure flags field

CAM_M_ADCVF_ID ID verification failure

[CAM_L_ADCVFID]

CAM_M_ADCVF_RANGE Range verification failure

[CAM_L_ADCVFRANGE]

CAM_M_ADCVF_OFFSET Offset verification failure

[CAM_L_ADCVFOFFSET]

CAM_M_ADCVF_ACQMODE Acquisition mode verification failure

[CAM_L_ADCVFACQMODE]

CAM_M_ADCVF_CNVGAIN Conversion gain verification failure

[CAM_L_ADCVFCNVGAIN]

CAM_M_ADCVF_LLD LLD verification failure

[CAM_L_ADCVFLLD]

CAM_M_ADCVF_ULD ULD verification failure

[CAM_L_ADCVFULD]

CAM_M_ADCVF_ZERO Zero verification failure

[CAM_L_ADCVFZERO]

CAM_M_ADCVF_ANTIC Anti-coincidence verification failure

CAM_M_ADCVF_LATEC Late coincidence mode verification failure

CAM_M_ADCVF_DELPK Delayed peak detect verification failure

CAM_M_ADCVF_NONOV Non-overlap transfer verification failure

CAM_M_ADCVF_LTCPUR LTC/PUR signal verification failure

Multichannel Analyzer Parameters

CAM_T_MCATYPE MCA type (8 characters)

CAM_T_MCAHWVERSION MCA Hardware version (8 characters)

CAM_T_MCAID MCA serial number (8 characters)

CAM_L_ALARMCOUNTS Alarm counts (Alpha Analyst only)

CAM_X_ALARMTIME Alarm elapsed time (Alpha Analyst only)

CAM_L_MCAFLAGS MCA alarm parameter flags

499
CAM Files

CAM_M_MCAF_CRARMED Count rate alarm armed (Alpha Analyst

[CAM_L_MCAFCRARMED] only)

Energy Calibration Parameters

CAM_T_ECALTYPE Energy calibration type (8 characters)

CAM_X_ECALTIME Energy calibration time

CAM_L_ECALTERMS Number of terms in energy calibration polyno-

mial

CAM_F_ECOFFSET Energy calibration offset

CAM_F_ECSLOPE Energy calibration slope

CAM_F_ECQUAD Energy calibration quadratic term

CAM_F_ECALFAC1 Energy calibration cubic term

CAM_F_ECALFAC2 Energy calibration 4th order term

CAM_F_ECALFAC3 Energy calibration 5th order term

CAM_T_ECALUNITS Energy calibration units (16 characters)

CAM_F_ECALCHISQ Energy calibration Chi square

CAM_F_ECALCNV Energy calibration conversion factor

CAM_L_ECALFLAGS Calibration flags field

CAM_M_ECF_ENCAL Perform energy calibration? (Y/N)

[CAM_L_ECFENCAL]

CAM_M_ECF_FWCAL Perform FWHM calibration? (Y/N)

[CAM_L_ECFFWCAL]

CAM_M_ECF_T1CAL Perform low energy tail calibration? (Y/N)

[CAM_L_ECFT1CAL]

CAM_M_ECF_T2CAL Perform tail two calibration? (Y/N)

[CAM_L_ECFT2CAL]

CAM_M__PULSER Calibration includes pulser data

[CAM_L_ECFPULSER]

Peak Shape Calibration Parameters

CAM_T_FWCALTYPE FWHM calibration type (8 characters)

500
 Acquisition Parameters

CAM_X_SCALTIME Shape calibration time

CAM_F_FWHMOFF FWHM offset: square root equation

CAM_F_FWHMSLOPE FWHM slope: square root equation

CAM_F_FWHMCHISQ Square-root FWHM calibration Chi square

CAM_F_C1FWHM FWHM polynomial offset

CAM_F_C2FWHM FWHM polynomial slope

CAM_F_C3FWHM FWHM polynomial quadratic coefficient

CAM_F_FWPOLYCHISQ Polynomial FWHM calibration Chi square

CAM_F_C1TAIL1 Low energy tail offset

CAM_F_C2TAIL1 Low energy tail slope

CAM_F_TAIL1CHISQ Low energy tail fit chi-square

CAM_F_C1TAIL2 Additional tail offset

CAM_F_C2TAIL2 Additional tail slope

CAM_F_TAIL2CHISQ Additional tail fit chi-square

CAM_F_FWHMCONST Constant FWHM; Alpha Spec only (channels)

Special Purpose Calibration Parameters

CAM_F_FW511 FWHM of 511 keV peak

CAM_F_T1511 Low energy tail of 511 keV peak

CAM_F_T2511 Additional tail of 511 eV peak

CAM_F_FWREF FWHM of reference peak

CAM_F_T1REF Low energy tail of reference peak

CAM_F_T2REF Additional tail of reference peak

Pulse Pileup Calibration Parameters

CAM_F_PILEUP Pulse pileup correction factor

Reference Peak Correction Calibration

CAM_F_AREFENG Reference peak energy

501
CAM Files

CAM_F_AREFRATE Reference peak rate

CAM_F_ADREFRATE Error in reference peak rate

CAM_X_AREFDATE Reference rate measurement date

CAM_X_AREFHLF Reference nuclide half life

CAM_T_AREFHLFUNITS Reference nuclide half life units (1 character)

CAM_F_ATGSREFRATE Reference peak count rate for TGS analysis

User Spare Acquisition Parameters

CAM_F_ASP4 User spare floating value 4

CAM_F_ASP5 User spare floating value 5

CAM_T_ASPSTR User spare string (32 characters)

Alternate Linear Energy Calibration Parameters

CAM_F_ECALLCOF Linear energy calibration offset

CAM_F_ECALLCSL Linear energy calibration slope

Vacuum Device Parameters

CAM_T_VACDEVTYPE Vacuum Type (8 chars)

CAM_T_VACADDRESS Vacuum device address (12 characters)

CAM_T_VACDEVID Vacuum device ID (serial number) (12 charac-

ters)

CAM_F_VACAIRTHICK Air thickness (µg/cm2) “Air Thickness”

CAM_F_VACPRESSET Vacuum pressure setting (Torr) “Acquire On”

CAM_F_VACPRESREAD Vacuum pressure reading “Pressure”

CAM_F_VACMINTHRESH Vacuum minimum threshold “Bias Off”

CAM_F_VACMAXTHRESH Vacuum maximum threshold “Bias On”

CAM_T_VACVALVE Valve state (8 chars) “Valve”

CAM_T_VACSTATUS Status (8 characters)

CAM_L_VACFLAGS Vacuum device flags

502
 Acquisition Parameters

CAM_M_VACF_REGULATED Pressure regulated

[CAM_L_VACFREG]

MGAU Calibration
CAM_F_ENRICHCAL93 MGAU 93 keV calibration factor

CAM_F_ENRICHCAL186 MGAU 186 keV calibration factor

Miscellaneous Parameters
CAM_L_UPPERGATE Upper gate (ND76DP only)

CAM_T_MIDPATH MID path name (16 characters)

CAM_T_DETNAME Detector name (16 characters)

CAM_F_ACQDETVOL Detector volume (cm3)

CAM_F_ACQDETDIAM Detector diameter (cm)

CAM_F_ACQDETWIDTH Detector height/width

CAM_F_ACQDETTC Detector time constant

CAM_F_ACQDETDEPTH Detector depth (mm)

CAM_F_ACQMGAEFSL MGA efficiency slope

CAM_F_ACQMGAEFCV MGA efficiency curvature

CAM_T_DETTYPE Detector type (ie, NaI, HPGe, Alpha, etc.) (8

characters)

CAM_T_DETENGTYPE Detector type: Low-energy vs. Normal (8 char-

acters) (put this after DETTYPE)

CAM_T_ACQINPUTID Detector ID (serial number) (12 characters)

CAM_T_CHAMBERSTAT Chamber status (8 characters)

CAM_F_DETTEMP Detector temperature

CAM_T_DETID Detector serial number (12 characters)

Record Tabular Entry Parameters

CAM_L_ECALLCCH Linear energy calibration channel

CAM_F_ECALLCDE Linear energy calibration delta E

503
CAM Files

CAM_F_DETnPERCENTS Percent of counts from detector n in summed

spectra, where n is 1 to 8

Notes
1. The CTITLE and ACQOPNAME parameters actually use the same physical
space in the configuration. Therefore a given application should use one or the
other, but not both, of these parameters.

2. When accessing acquisition time data in a file, the tabular entry number should
be set to the number of the group whose time information is desired (currently,
either 1 or 2).

3. The parameters WGRUMASS, WGRUMASSERR, WNRUMASS,

WNRUMASSERR, MCRUMASS, MCRUMASSERR, WNRPUMDAERR,
WNRISOMDAERR, WGRTMUMDAERR, WDRISOMDAERR and
MCRISOMDAERR cannot be accessed by their names, only by symbolic code.
They can be accessed via programming in languages, such as C, not by utilities
such as GETPARS, PARS, and FDS files (on PC platforms), or PARS,
PARS/GUI, and FPL files (on VMS platforms).

Sample Parameters
All sample parameters are common parameters. The symbolic name for this class is
CAM_CLS_SAMP.

Common Parameters
CAM_T_STITLE Sample title (64 characters)

CAM_T_SIDENT Sample identification (16 characters)

CAM_T_STYPE Sample type (16 characters)

CAM_T_SGEOMTRY Sample geometry (16 characters)

CAM_T_SLOCTN Sample location (32 characters)

CAM_F_SQUANT Sample quantity

CAM_F_SQUANTERR Error in sample quantity

CAM_T_SUNITS Sample units (16 characters)

CAM_F_SUNITSCF Sample units conversion factor (used in NDA

2000 to convert from kg to report quantity units)

CAM_X_SDEPOSIT Sample deposition start date/time

504
 Sample Parameters

CAM_X_STIME Sample deposition end date / sample time

CAM_F_SSYSERR Random sample error (%)

CAM_F_SSYSTERR Non-random sample error (%)

CAM_F_SONFLOW Flow rate at start of sample collection

CAM_F_SOFFFLOW Flow rate at end of sample collection

CAM_F_SPRES Sample pressure

CAM_F_STEMP Sample temperature

CAM_F_SPOWER Reactor percent power

CAM_T_SCOLLINIT Initials of sample collector (4 characters)

CAM_T_SCOLLNAME Name of sample collector (24 characters)

CAM_T_SANALNAME Name of sample analyst (24 characters)

CAM_L_SAMPNUM Sample number

CAM_T_SAMPLEPT Sample point (32 characters)

CAM_T_SDESCn Sample description n (64 characters), where n is

1 to 4

CAM_F_SSTVACPRES Start vacuum pressure (psig)

CAM_F_SENDVACPRES End vacuum pressure (psig)

CAM_T_SAMPLERID Sampler identification (16 characters)

CAM_T_SSHELF Shelf name (8 characters)

CAM_T_SREASON Reason for sample collection (64 characters)

CAM_T_SRWP Radiation work permit number (16 characters)

CAM_F_SCOLEFF Sample collection efficiency (fraction)

CAM_F_STRACEAMT Tracer quantity (used in alpha spectroscopy)

CAM_T_SBATCHID Batch ID (16 characters)

Plant/Site Parameters
CAM_L_SSTATION Station code for multi-site utilities

CAM_T_SPLTNAME Plant name (32 characters)

505
CAM Files

CAM_L_SREACTORUNIT Reactor unit number

CAM_F_SMWT Megawatts thermal of reactor

Air Sampling Parameters

CAM_T_SASID Air sample identification (16 characters)

CAM_T_SRWPLIST RWP/SRWP list (96 characters)

CAM_X_SCOVSTART Coverage period start date

CAM_X_SCOVEND Coverage period end date

CAM_T_SSURVID Survey Identification (16 characters)

CAM_X_SSURVDATE Survey date

CAM_T_SSURVLOC Survey location code (16 characters)

CAM_T_SSURVENT Person entering survey data (24 characters)

WBC-Related Sample Parameters

CAM_F_SPARTSIZE Inhalation particle size (um)

CAM_T_SEMPNAME Subject name (32 characters)

CAM_T_SEMPID Subject ID (12 characters)

CAM_T_SEMPLOYER Employer name (32 characters)

CAM_T_SJOBCODE Job code (32 characters)

CAM_T_SSEX Subject gender (male/female/unknown) (8 char-

acters)

CAM_X_SBIRTHDATE Subject’s birthdate

CAM_T_SFREQUENCY Frequency of count (16 characters)

CAM_T_STLDNUM TLD number (5 characters)

CAM_T_SWBCID WBC ID (5 characters)

CAM_T_SSTHGT WBC chair seat height (5 characters)

CAM_T_SFTBPOS WBC chair front-to-back position (5 chars)

CAM_T_STHYPOS WBC chair thyroid position (5 characters)

CAM_X_SUPTKDAT Uptake date/time

506
 Sample Parameters

CAM_T_SOPINIT Operator’s initials (4 characters)

CAM_F_SHEIGHT Subject height (inches or cm)

CAM_F_SWEIGHT Subject weight (pounds or kg)

CAM_F_SCWT Subject chest wall thickness (cm); this parameter

is also used for the sample density value (in
g/cm3) for waste assay applications

CAM_F_SCWTERROR Uncertainty in CWT

CAM_F_SU235ENRICH % U-235 enrichment

CAM_F_SWBCCRn WBC count rate n, where n is 1 to 8

Waste Assay Parameters

CAM_F_SWCONTEW Container empty weight

CAM_F_SWCONTGW Container gross weight

CAM_F_SWCONTNW Container net weight

CAM_F_SWCONTNWERR Error in net weight

CAM_F_SWCONTVOL Container volume (liters)

CAM_F_SWCONTVOLERR Error in volume

CAM_F_SWCONTUDENS User-entered density (kg/L)

CAM_T_SWCONTSHAPE Container shape (16 characters)

CAM_F_SWCONTLEN Container box length or drum diameter (m)

CAM_F_SWCONTHEIGHT Container height (m)

CAM_F_SWCONTGCF Container geometric correction factor

CAM_T_SWCONTMATRIX Container matrix (16 characters)

CAM_F_SWCONTFULL % full

CAM_T_SLENUNITS Sample length units

CAM_F_SLENCONV Length units conversion factor

CAM_T_SWTUNITS Sample weight units

CAM_F_SWTCONV Weight units conversion factor

CAM_T_SVOLUNITS Sample volume units

507
CAM Files

CAM_F_SVOLCONV Volume units conversion factor

CAM_T_SCTRNAME Counter Name (8 characters)

CAM_T_SCTRDESC Counter Description (32 characters)

CAM_T_SARRNAME Arrangement Name (8 characters)

CAM_T_SARRDESC Arrangement Description (32 characters)

CAM_T_SGRPNAME Group Name (8 characters)

CAM_T_SGRPDESC Group Description (32 characters)

CAM_T_SINFOFDS Sample Information parameter edit file (16 char-

acters)

CAM_T_SINFOTYPE Sample Information type (16 characters)

CAM_L_SINFOSEQ Sample Demographics sequence number

CAM_T_SPROCTYPE Analysis Processing type (16 characters) [indi-

vidual/cal check/etc.]

CAM_T_SAMPASF1 Standard Analysis Sequence file name (16 char-

acters)

CAM_T_SAMPASF2 Bulk Analysis Sequence File Name (16 charac-

ters)

CAM_L_SFREPPLT Include plot in output report (part of

CAM_L_SFLAGS longword)

CAM_L_SUNITTYPE Type of units used where 0: English; 1: Metric

CAM_T_SNODENAME Node name of the system the sample was col-

lected on (64 characters)

User Spare Sample Parameters

CAM_T_SSPRSTRn User spare string n (16 characters), where n is 1
to 11

CAM_T_SSPBSTR1 User spare “big” string 1 (64 characters)

CAM_X_SSPTIME User spare date-time

CAM_X_SSPDTIME User spare elapsed time

CAM_X_SSPDTIMEn User spare elapsed time n, where n is 2 to 8

CAM_L_SSPIn User spare integer value n, where n is 1 to 16

508
 Sample Parameters

CAM_F_SSPn User spare floating value n, where n is 2 to 32

Alpha Analyst Parameters

CAM_T_SELEMENT Sample element description (32 chars)

CAM_T_SMATRIX Sample matrix description (32 chars)

CAM_T_SPROTOCOL Sample processing protocol description (32

chars)

CAM_T_SSTATUS Sample status (8 chars)

CAM_T_SPROTOFILE Protocol file name (96 chars)

CAM_L_SMATRIXNUM Sample matrix number

CAM_L_SELEMENTNUM Sample element number

CAM_L_SGEOMNUM Sample geometry number

CAM_F_EXTCHEMYIELD Externally calculated sample recovery factor

CAM_F_EXTCHEMYERR Error in externally calculated sample recovery

factor

CAM_F_CONTROLVOL Volume (in mL) of control

Sample Flags Fields

CAM_L_SFLAGS Sample flags field

CAM_M_SF_SP1 Flags bit 0

[CAM_L_SFSP1]

CAM_M_SF_SP2 Flags bit 1

[CAM_L_SFSP2]

CAM_M_SF_SP3 Flags bit 2

[CAM_L_SFSP3]

CAM_M_SF_SP4 Flags bit 3

[CAM_L_SFSP4]

CAM_V_SF_SHOWER Shower taken before count? (Y/N)

[CAM_L_SFSHOWER]

CAM_M_SF_SPECIAL Special clothing? (Y/N)

[CAM_L_SFSPECIAL]

CAM_M_SF_CHAMSPEC Chamber specific processing

[CAM_L_SFCHAMSPEC]

509
CAM Files

CAM_M_SF_INTERRUPT Was interrupted

[CAM_L_SFINTERRUPT]

CAM_M_SF_ABORTED Was aborted

[CAM_L_SFABORTED]

CAM_M_SF_CALCOUNT Count was for calibration purposes

[CAM_L_SFCALCOUNT]

Geometry Parameters
The geometry parameters block contains a number of records, each containing an effi-
ciency calibration. The symbolic name for this class is CAM_CLS_GEOM. The first re-
cord contains the calibration to be used in calculation of efficiency by efficiency
correction, NID and MDA analysis algorithms. The remaining records, if any, represent
efficiency at specific chest-wall thicknesses or item densities.

Record Parameters
CAM_X_DCALTIME Detector efficiency calibration time

CAM_T_EFOPNAME Operator who performed efficiency calibration

(24 characters)

CAM_T_EFAPNAME Name of efficiency approver (24 characters)

CAM_X_EFAPDATE Date of efficiency approval

CAM_T_DETSTATUS Detector status (32 characters)

CAM_T_EFCALVERS Efficiency calibration version (16 characters)

CAM_X_LASTCALD Date of previous calibration

CAM_T_SHELF Shelf identification (1 character)

CAM_T_GEOMETRY Geometry identification (16 characters)

CAM_T_DETECTOR Detector identification (16 characters)

CAM_T_CHAIR Chair identification (16 characters)

CAM_F_DCREFDIST Geometry reference distance

CAM_F_DCSAMPDIST Actual geometry distance

CAM_T_EFFTYPE Efficiency model to be used in analysis:

SPLINE, EMPIRICAL, AVERAGE, DUAL or
LINEAR (8 characters)

510
 Geometry Parameters

CAM_T_ISOCSFILE ISOCS calibration file name (96 characters)

CAM_T_DETYP Detector type: Ge, NaI, LEPS, … (8 characters)

CAM_F_CWTORDENSI Chest wall thickness or density

CAM_F_CWTORDENSIER Uncertainty in chest wall thickness or density

CAM_L_DCALFLAGS Detector calibration flags

CAM_M_DCAL_USEAVRG Use average efficiency (used for Alpha

Spec)

CAM_M_DCAL_USEEMPEFF Use EMPIRICAL calibration function

[CAM_L_USEEMPEFF]

CAM_M_DCAL_USELUNGCNT Use multi-record lung counting calibration

data. There is one record per calibration en-
ergy: with the tabular entries being chest
wall thickness, efficiency, uncertainty trip-
lets.

CAM_M_DCAL_GEOMNOTAPP Geometry not approved

[CAM_L_GEOMNOTAPP]

WBC and Lung Counter Parameters

CAM_F_SCANST Scan start position

CAM_F_SCANEND Scan end position

CAM_F_LCENERGY Calibration energy (keV)

CAM_F_LCCONST Constant term which multiplies exponential

CAM_F_LCEXP Exponential coefficient

CAM_F_LCGOF Fit linear correlation coefficient

Empirical Efficiency Model Calibration Parameters

CAM_L_EMPDEGREE Degree of EMPIRICAL polynomial (0-5)

CAM_F_DCALFAC1 EMPIRICAL scaling parameter

CAM_F_DCALFAC2 EMPIRICAL efficiency factor 2 (constant)

CAM_F_DCALFAC3 EMPIRICAL efficiency factor 3 (linear)

CAM_F_DCALFAC4 EMPIRICAL efficiency factor 4 (quadratic)

511
CAM Files

CAM_F_DCALFAC5 EMPIRICAL efficiency factor 5 (cubic)

CAM_F_DCALFAC6 EMPIRICAL efficiency factor 6 (4th order)

CAM_F_DCALFAC7 EMPIRICAL efficiency factor 7 (5th order)

CAM_F_EMPCHISQ EMPIRICAL fit reduced chi-square

CAM_F_EFFAVERR Average error in empirical efficiency fit

Alpha Spectroscopy Efficiency Calibration Parameters

CAM_F_AVRGEFF Average efficiency

CAM_F_AVRGEFFERR Uncertainty in average efficiency

Dual Polynomial Efficiency Model Calibration Parameters

CAM_F_CROSSOVER Polynomial crossover energy

CAM_L_DLDEGREE Degree of low energy polynomial (0-3)

CAM_L_DHDEGREE Degree of high energy polynomial (0-5)

CAM_F_DLCALFAC1 Dual: Low energy offset

CAM_F_DLCALFAC2 Dual: Low energy slope

CAM_F_DLCALFAC3 Dual: Low energy quadratic term

CAM_F_DLCALFAC4 Dual: Low energy cubic term

CAM_F_DLCALFAC5 Dual: Low energy 4th order term

CAM_F_DLCALFAC6 Dual: Low energy 5th order term

CAM_F_DLCALCHI Low energy fit chi-square

CAM_F_DHCALFAC1 Dual: High energy offset

CAM_F_DHCALFAC2 Dual: High energy slope

CAM_F_DHCALFAC3 Dual: High energy quadratic term

CAM_F_DHCALFAC4 Dual: High energy cubic term

CAM_F_DHCALFAC5 Dual: High energy 4th order term

CAM_F_DHCALFAC6 Dual: High energy 5th order term

CAM_F_DHCALFAC7 Dual: High energy 6th order term

CAM_F_DHCALFAC8 Dual: High energy 7th order term

512
 Geometry Parameters

CAM_F_DHCALFAC9 Dual: High energy 8th order term

CAM_F_DHCALFAC10 Dual: High energy 9th order term

CAM_F_DHCALCHI High energy fit chi-square

CAM_G_LERRMATn Dual: Low energy error matrix n, where n is 1 to

11

CAM_G_HERRMATn Dual: High energy error matrix n, where n is 1 to

19

Linear Efficiency Model Calibration Parameters

CAM_L_LNDEGREE Linear: Polynomial degree (0-9)

CAM_F_LNCHISQ Linear: Reduced fit chi-square

CAM_F_LNCALFAC1 Linear: Offset

CAM_F_LNCALFAC2 Linear: Slope

CAM_F_LNCALFAC3 Linear: Quadratic term

CAM_F_LNCALFAC4 Linear: Cubic term

CAM_F_LNCALFAC5 Linear: 4th order term

CAM_F_LNCALFAC6 Linear: 5th order term

CAM_F_LNCALFAC7 Linear: 6th order term

CAM_F_LNCALFAC8 Linear: 7th order term

CAM_F_LNCALFAC9 Linear: 8th order term

CAM_F_LNCALFAC10 Linear: 9th order term

CAM_G_LNERRMATn Linear: Error matrix n, where n is 1 to 19

User Spare Geometry Parameters

CAM_F_DSP1 User spare floating value 1

CAM_F_DSP2 User spare floating value 2

Record Tabular Entry Parameters

CAM_F_DENERGY Energy (keV) or chest wall thickness (cm); see
the CAM_M_DCAL_USELUNGCNT flag

513
CAM Files

CAM_F_DEFF Computed efficiency

CAM_F_DEFFERR Uncertainty in efficiency

CAM_F_DEFFEFAC Efficiency interpolation error (EMPIRICAL

only)

CAM_L_DEFFPTID Data point source ID

CAM_F_DEFFCOICF Cascade summing correction factor

CAM_F_DEFFCOICFERR Uncertainty in cascade summing correction fac-

tor

CAM_L_DEFFFLAGS Efficiency point flags:

CAM_M_DEFF_CSCDONE Cascade summing correction has been done

[CAM_L_DEFFCSCDONE] for this energy

Processing Parameters
This processing parameters block is designed for standard single parameter NID applica-
tions and contains analysis parameters for many applications. The symbolic name for this
class is CAM_CLS_PROC.

CAM_L_PROCFLAGS Processing flags

CAM_M_PROC_FIT Fit singlets (peak search)

[CAM_L_PRFIT]

CAM_M_PROC_ALPHA Use Alpha peak search

[CAM_L_DOALPHA]

CAM_M_PROC_NOSMOOTH Don’t smooth data (Alpha peak search)

CAM_M_PROC_CRITLEVEL Do critical level test (peak search)

[CAM_L_CRITLEVEL]

CAM_M_PROC_PROPAGATE Propagate all errors

[CAM_L_PROPAGATE]

CAM_M_PROC_VARDT Do variable dead-time correction

[CAM_L_PRVARDT]

CAM_M_PROC_COLLTIME Do collection time decay correction

[CAM_L_PRCOLLTIME]

514
 Processing Parameters

CAM_M_PROC_DOLIBEFF Do library-based efficiency

[CAM_L_DOLIBEFF]

CAM_M_PROC_KEYLINE Perform key-line analysis

[CAM_L_PRKEYLINE]
2
CAM_M_PROC_LLDCONST Include k term in LLD equation
[CAM_L_PRLLDCONST]

CAM_M_PROC_CALCMDA Compute a posteriori MDA

[CAM_L_PRCALCMDA]

CAM_M_PROC_CALCWGT Use fitted spectrum for weighting factors

(Alpha-M)

CAM_M_PROC_THRSHFT Perform a threshold shift (Alpha-M)

CAM_M_PROC_ANALCNT Perform geometry analysis (WBC only)

CAM_M_PROC_INCREP Include geometry in report (WBC only)

CAM_M_PROC_GAINSHFT Perform gain shift correction (Gamma-M)

[CAM_L_PRGAINSHFT]

CAM_M_PROC_SYSERRDTL Include systematic error in detection limits

[CAM_L_PRSYSERRDTL]

CAM_M_PROC_REFCORR Perform reference peak correction

[CAM_L_PRREFCORR]

CAM_M_PROC_USEVARETOL Use FWHM variable energy tolerance

[CAM_L_USEVARETOL]

CAM_M_PROC_DOSCOLEFF Do collection efficiency correction

[CAM_L_DOSCOLEFF]

CAM_M_PROC_DOCHEMYIELD Do chemical yield correction

[CAM_L_DOCHEMYIELD]

CAM_M_PROC_MGAFIXCD Use fixed cadmium thickness? (Y/N) (MGA

[CAM_L_PRMGAFIXCD] only)

CAM_M_PROC_MGAFIXPU Use fixed plutonium thickness? (Y/N)

[CAM_L_PRMGAFIXPU] (MGA only)

CAM_M_PROC_MGASAM241 Freshly separated 241Am ? (Y/N) (MGA

[CAM_L_PRMGASAM241] only)

CAM_M_PROC_MGAUSELOW Use 38-59 keV region (241Am sep.)? (Y/N)

[CAM_L_PRMGAUSELOW] (MGA only)

CAM_M_PROC_MGAUPRES Uranium present in sample? (Y/N) (MGA

[CAM_L_PRMGAUPRES] only)

515
CAM Files

CAM_M_PROC_SHOWROIS Display regions-of-interest? (Y/N)

[CAM_L_SHOWROIS]

CAM_M_PROC_DOUSERPL Perform user peak locate? (Y/N)

[CAM_L_PRDOUSERPL]

CAM_M_PROC_FWHMREJ Perform FWHM based rejection of singlets?

[CAM_L_PRFWHMREJ] (Y/N) [standard peak search only]

CAM_M_PROC_FIXFWHM Fix FWHM to calibration value during fit-

[CAM_L_PRFIXFWHM] ting? (Y/N)

CAM_L_PROCFLAGS2 More processing flags

CAM_M_PROC2_ROIMCA Interactive peak fit: filter by ROIs

[CAM_L_SHOWROIMCA]

CAM_M_PROC2_ENERGYFLTR Interactive peak fit: filter by energy

[CAM_L_ENERGYFLTR]

CAM_M_PROC2_NUCLFLTR Interactive peak fit: filter by nuclide name

[CAM_L_NUCLFLTR]

CAM_M_PROC2_CHISQFLTR Interactive peak fit: filter by chi-square

[CAM_L_CHISQFLTR]

CAM_M_PROC2_FWRATFLTR Interactive peak fit: filter by FWHM ratio

[CAM_L_FWRATFLTR]

CAM_M_PROC2_MLTPLTFLTR Interactive peak fit: filter multiplets only

[CAM_L_MLTPLTPKFLTR]

CAM_M_PROC2_NOFLTR Interactive peak fit: no filter

[CAM_L_NOFLTR]

CAM_M_PROC2_ERRREJ Perform % error rejection in NID

[CAM_L_PRERRREJ]

CAM_M_PROC2_MRLREJ Perform minimum report level rejection in

[CAM_L_PRMRLREJ] NID

CAM_M_PROC2_MINMDA Report minimum MDAs

[CAM_L_PRMINMDA]

CAM_M_PROC2_RPTCL Report critical level

[CAM_L_PRRPTCL]

CAM_M_PROC2_USEMDACONSTS Use “user-specified” MDA constants

[CAM_L_USEMDACONSTS]

516
 Processing Parameters

CAM_M_PROC2_DOUNKSRCH Do Gamma-M “unknown” peaks search

[CAM_L_DOUNKSRCH]

CAM_M_PROC2_DISACQDECAY Disable decay during acquisition time cor-

[CAM_L_DISACQDECAY] rection

CAM_M_PROC2_N1.5UTBC Disable neutron background correction

[CAM_L_PRNONEUTBC]

CAM_M_PROC2_NEUTDOMC Do neutron multiplication correction

[CAM_L_PRNEUTDOMC]

CAM_M_PROC2_MGAFIXPB Fix lead thickness (MGA only)

[CAM_L_PRMGAFIXPB]

CAM_M_PROC2_MGAAMHETRO Am-241 is heterogenous (MGA only)

[CAM_L_PRMGAAMHETRO]

CAM_M_PROC2_DOINTERF Perform Interference correction (Used by

[CAM_L_PRDOINTERF] ABACOS-Plus)
2
CAM_M_PROC2_AIST2G Use T G instead of A in calculation of reals
[CAM_L_PRNEUTAIST2G] rate (used neutron filter engines)

CAM_M_PROC2_CLRB4ACQ Clear data before starting acquisition (Genie

[CAM_L_PRCLRB4ACQ] 2000/Genie-PC only)

CAM_M_PROC2_NEUTUSETOT Use Total counts rather than Reals in Pu

[CAM_L_PRNEUTUSETOT] mass and MDA calculations

CAM_M_PROC2_NEUTFITZZ Constrain Pu mass curves to go through 0,0

[CAM_L_PRNEUTFITZZ]

CAM_M_PROC2_NEUTMLT1OK The neutron multiplication factor will be al-

[CAM_L_PRNEUTMLT1OK] lowed to be less than 1 (but greater than 0);
normally, the factor must be greater than or
equal to 1

CAM_M_PROC2_USEROIFILE For ROI-driven peak searches, indicates that

[CAM_L_PRUSEROIFILE] the ROIs should be read from the file indi-
cated by the ROIFILE parameter. By de-
fault, the ROIs are read from the
configuration being analyzed

CAM_M_PROC2_REJECT0PKS Indicates that peaks with 0 area are to be re-

[CAM_L_PRREJECT0PKS] jected (this flag is not supported by all peak
search algorithms)

CAM_M_PROC2_VARYLTAIL Indicates that the low energy tail may be

[CAM_L_PRVARYLTAIL] varied during multiplet fitting

517
CAM Files

CAM_M_PROC2_ADDPKRES Used by some peak searches: indicates that

[CAM_L_PRADDPKRES] peaks found are to be added to those found
by previous searches (the default is to over-
write previous peak results)

CAM_L_PRLEVUSEMDA Flag to indicate whether MDA should be

used in level calculations/summing

CAM_L_PRLEVBOUNDS Flag to indicate whether activity or upper

level used in calculations

CAM_L_PRDORESID Flag to enable/disable residual search

CAM_L_PROCFLAGS3 Still more processing flags

CAM_M_PROC3_DOMDATEST Perform MDA test during NID

[CAM_L_PRDOMDATEST]

CAM_M_PROC3_USEVBKCHN Use variable FWHM for continuum determi-

[CAM_L_PRUSEVBKCHN] nation

CAM_M_PROC3_USEVPWIDTH Use variable VPWIDTH parameter for

[CAM_L_PRUSEVPWIDTH] MDA ROI calculations

CAM_M_PROC3_MGAALWAYS Best of MGA/NID: always use MGA

[CAM_L_PRMGAALWAYS]

CAM_M_PROC3_COMBAVE NID Combiner: do an average instead of a

[CAM_L_PRCOMBAVE] sum

CAM_M_PROC3_SSNOSHIFT Shift/Sum engine: don’t do gain shift

[CAM_L_PRSSNOSHIFT]

CAM_M_PROC3_SSNOLTCORR Shift/Sum engine: don’t do live time correc-

[CAM_L_PRSSNOLTCORR] tion

CAM_M_PROC3_SSSERIAL Shift/Sum engine: do live time correction in

[CAM_L_PRSSSERIAL] serial mode

CAM_M_PROC3_MGANOABORT MGA and MGAU only: return success sta-

[CAM_L_PRMGANOABORT] tus except for I/O related errors

CAM_M_PROC3_MGAUUSEMGA MGAU only: perform no processing if valid

[CAM_L_PRMGAUUSEMGA] MGA results are already present

CAM_M_PROC3_NOREFPEAK Disable reference peak correction (“new”

[CAM_L_PRNOREFPEAK] reference peak engine only)

CAM_M_PROC3_NOBACKCOR Disable background subtraction (“new” ref-

[CAM_L_PRNOBACKCOR] erence peak engine only)

518
 Processing Parameters

CAM_M_PROC3_COMBAVENOW NID results combination engine: Combine

[CAM_L_PRCOMBAVENOW] using non-weighted average

CAM_M_PROC3_MGAUMGAOUT MGAU should output results compatible

[CAM_L_PRMGAUMGAOUT] with MGA

CAM_M_PROC3_NEUTMULTI Perform multiplicity analysis

[CAM_L_NEUTMULTI]

CAM_M_PROC3_NEUTDOALHAI Perform known alpha multiplicity analysis

[CAM_L_NEUTDOALPHA]

CAM_M_PROC3_NEUTDOMFACT Perform known multiplication multiplicity

[CAM_L_NEUTDOMFACT] analysis

CAM_M_PROC3_NEUTDOEFF Perform known efficiency multiplicity anal-

[CAM_L_NEUTDOEFF] ysis

CAM_M_PROC3_NEUTDOEALHAI Perform known efficiency and alpha multi-

[CAM_L_NEUTDOEALPHA] plicity analysis

CAM_M_PROC3_NEUTDOEMFACT Perform known efficiency and multiplica-

[CAM_L_NEUTDOEMFACT] tion multiplicity analysis

CAM_M_PROC3_NEUTDOSDTAV Compute singles, doubles, and triples using

[CAM_L_NEUTDOSDTAVG] sample mean

CAM_M_PROC3_PRNEUTDOMCD Use MC doubles mass calibration

[CAM_L_PRNEUTDOMCD]

CAM_M_PROC3_PRNEUTUSERE Use reals mass calibration

[CAM_L_PRNEUTUSERE]

CAM_M_PROC3_NEUTUSEKEFF Use K-norm efficiency to compute mass

[CAM_L_NEUTUSEKEFF]

CAM_L_PROCFLAGS4 Still more processing flags again

CAM_M_PROC4_LROIBYENG Load ROIs by energy

[CAM_L_PRLROIBYENG]

CAM_M_PROC4_FORCEROI Flag used by Simple Library Driven to tell

[CAM_L_PRFORCEROI] engine to generate ROIs based on FWHM

CAM_M_PROC4_CHECKADJPK Check for adjacent peaks

[CAM_L_PRCHECKADJPK]

CAM_M_PROC4_NOMCONSTT Disable multiplicity consistency test

[CAM_L_PRNOMCONSTT]

519
CAM Files

CAM_M_PROC4_CHKFIDUTST True if the “fiducial peaks” test is to be per-

[CAM_L_PRCHKFIDUTST] formed

CAM_M_PROC4_DOAUTOWST Perform Automated Waste Analysis

[CAM_L_PRDOAUTOWST]

CAM_M_PROC4_HZFRACKNWM High-Z fractions are known

[CAM_L_PRHZFRACKNWN]

CAM_M_PROC4_DOMGAVCHCK Perform MGA and MGAU results validity

[CAM_L_PRDOMGAVCHCK] test (enables execution of the MGA Validity
Check analysis engine)

CAM_M_PROC4_DOTMUWIPP Perform TMU and WIPP calculations (used

[CAM_L_PRDOTMUWIPP] by NDA 2000)

CAM_M_PROC4_ADDEFFERR Include chi-square in efficiency error

[CAM_L_PRADDEFFERR]

CAM_M_PROC4_NOTRCLAMP Do not clamp transmission ratio to mini-

[CAM_L_PRNOTRCLAMP] mum transmission value. Instead, reject
transmission peaks whose ratio is at or be-
low the minimum

CAM_M_PROC4_TRBKGSUB Subtract item background from transmission

[CAM_L_PRTRBKGSUB] data. This option can be used with two-pass
transmission data to subtract the contribu-
tion of the transmission nuclide in the item
from the transmission pass data

CAM_M_PROC4_DOCOLLAR Do neutron collar analysis

[CAM_L_PRDOCOLLARAN]

CAM_M_PROC4_DOACTMULT Do active multiplicity analysis

[CAM_L_PRDOACTMULT]

CAM_M_PROC4_DOKNWNMASS Do “known Pu mass” analysis

[CAM_L_PRDOKNWNMASS]

CAM_M_PROC4_USESTRLIB Use stored nuclide library for analysis

[CAM_L_PRUSESTRLIB]

CAM_M_PROC4_TGSMBSEXEC Perform TGS efficiency and MBS template

[CAM_L_PRTGSMBSEXEC] creation

CAM_M_PROC4_NITAPPLYCF Apply the NIT correction factor, if available

[CAM_L_PRNITAPPLYCF]

CAM_M_PROC4_CLRB4IACQ Clear data before first acquisition only; data

[CAM_L_PRCLRB4IACQ] will not be cleared for subsequent acquisi-
tion cycles

520
 Processing Parameters

CAM_M_PROC4_DISPGERES Display gain evaluator results

[CAM_L_PRDISPGERES]

CAM_M_PROC4_LBSOPTCAL Library Correlation: Store optimized energy

[CAM_L_PRLBSOPTCAL] and FWHM calibration slope terms

CAM_M_PROC4_HCAPPLYCF Apply the hydrogen correction factor to the

[CAM_L_PRHCAPPLYCF] coincidence masses if other criteria are
attained

Peak Search Processing Parameters

CAM_F_SENSITVTY Sensitivity

CAM_F_GSENSITVTY Gaussian sensitivity

CAM_F_FWHMREJRATIO Measured/Expected FWHM rejection threshold

CAM_L_ITERATIONS Maximum number of iterations

CAM_L_PEAKSTART Peak search start channel

CAM_L_PEAKEND Peak search end channel

CAM_F_LOCSMTH Peak location smoothing factor (FWHM)

CAM_F_MULTSMTH Multiplet search smoothing factor (FWHM)

CAM_L_PASTART Peak analysis start channel

CAM_L_PAEND Peak analysis end channel

CAM_F_PRFWHMPKMULT Number of expected FWHMs to search in deter-

mining whether a peak is in a multiplet

CAM_F_PRFWHMPKLEFT Limit in FWHMs of peak left boundary search

CAM_F_PRFWHMPKRGHT Limit in FWHMs of peak right boundary search

CAM_F_PRMINPEAKSEP Minimum peak separation (in terms of FWHM)

CAM_L_PRNBKCHN Number of average background channels

CAM_F_PRVBKCHN Variable continuum channels (FWHM)

CAM_F_PRVROIWIDTH Multiplier applied to FWHM when Simple Li-

brary driven engine is generating ROIs

Hypermet Peak Search Processing Parameters

CAM_F_CHISENSITVTY Chi square sensitivity

521
CAM Files

CAM_F_RSENSITVTY Residuals sensitivity

Singlet Peak Search Processing Parameters

CAM_L_MSCHANS Median width for smoothing function

CAM_F_SECSENS Secondary sensitivity

Alpha Peak Search Processing Parameters

CAM_F_SUMSENSITVTY Sum sensitivity cutoff

ROI Peak Search Processing Parameters

CAM_T_ROIPSTYP Computation Mode: GROSS or NET

CAM_T_ROIPSBTYP Background type: LINEAR or STEP

Gamma-M Peak Search Processing Parameters

CAM_F_AREAWIND1 Phase 1: Area window (FWHM)

CAM_F_AREAWIND2 Phase 2: Area window (FWHM)

CAM_F_INTFWIND1 Phase 1: Interference window (FWHM)

CAM_F_INTFWIND2 Phase 2: Interference window (FWHM)

CAM_F_OVERWIND1 Phase 1: Overlap window (FWHM)

CAM_F_OVERWIND2 Phase 2: Overlap window (FWHM)

CAM_L_NBACKTERMS Number of background terms (0-2)

CAM_F_BACKREJ Background rejection factor

CAM_F_VARREJ Peak height variance rejection factor

CAM_L_PRGAINSHFT Perform gain shift? (Y/N)

CAM_L_MAXGAINPASS Maximum number of gain passes

CAM_F_GAINREJ Gain shift rejection factor

CAM_F_REJMDASIG MDA rejection sigma

CAM_F_REJMDACONST MDA rejection constant

CAM_F_UNIDETOL Unidentified line energy tolerance

522
 Processing Parameters

CAM_F_UNIDREJ Unidentified line rejection factor

CAM_F_UNIDCONST Unidentified line constant

Calibration Processing Parameters

CAM_F_ECALTOL Energy calibration energy tolerance

CAM_F_VARECALTOL Energy calibration variable tolerance (FWHM)

CAM_F_ECALSMOOTH NaI Init calib smoothing factor (FWHM)

Alpha-M Processing Parameters

CAM_F_SQUANTMULT Sample quantity multiplier

CAM_T_GAINSHIFT Gain shift type: NONE, AUTO or ITER (4 char-

acters)

CAM_T_WEIGHTING Weighting type: NONE, COUNTS or

DERIVED (7characters)

CAM_F_SIGMAREJ N-sigma rejection coefficient

CAM_L_CALCWGT Weights based on derived data?

CAM_L_THRSHFT Perform threshold shift?

MGA Processing Parameters

CAM_F_MGAFCDABS Fixed cadmium absorber thickness (this value is
overridden by the value specified in the neutron
detector data block)

CAM_F_MGAFPUABS Fixed plutonium absorber thickness (this value

is overridden by the value specified in the neu-
tron sample processing parameters data block)
242
CAM_T_MGAPU242TYP Pu calc. method (Decl/Old/New) (12 charac-
ters)

CAM_F_MGADECPU242 Declared 242Pu abundance fraction (this value is

overridden by the value specified in the neutron
declaration block)

CAM_X_MGARCTOCHEM Reactor exit to chemical sep. time (this value is

overridden by the value specified in the neutron
declaration block)

523
CAM Files

CAM_T_PRMGAANALTYP Analysis type (8 characters); STD or SOL (for

solutions)

CAM_L_PRMGANSPEC Number of spectra to analyze; this should be 1

unless a high energy spectral file is available,
when it should be a 2. The high energy spectral
file should have the same name as the low en-
ergy file, except with a CN2 extension.

CAM_F_PRMGAMINCNTS Total spectral counts required for MGA to oper-

ate

CAM_F_PRMGALEDETLM Low energy spectrum (129 and 208 keV peaks)

detection limit uncertainty (%)

CAM_F_PRMGAHEDETLM High energy spectrum (208 and 414 keV peaks)

detection limit uncertainty (%)

CAM_F_PRMGAUCALFAC MGAU calibration factor

CAM_T_PRMGAREFNUCL Best of MGA/NID: reference nuclide name (8

characters)

CAM_L_PRMGAUMODE MGAU processing mode: 0=standard, 1=enrich-

ment meter with unknown Fe thickness, 2=en-
richment meter, 3=enrichment meter calibration
with unknown Fe, 4= enrichment meter calibra-
tion with known Fe

CAM_F_PRMGAU235FCT MGAU 235U fluorescence factor

CAM_F_PRMGAU238FCT MGAU 238U fluorescence factor

CAM_F_PRMGAUFE MGAU Fe thickness (mm)

CAM_F_PRMGAUFEDENS MGAU Fe density

CAM_F_PRMGAUAL MGAU Al thickness

CAM_L_PRMGAU186SR MGAU maximum search range (channels) for

186 keV peak

CAM_F_PRMGAU93PKRT MGAU minimum 93 keV peak

height-to-background ratio

CAM_F_PRMGAU208SEN MGAU 208 keV peak sensitivity

CAM_F_PRUENRICH Uranium enrichment (%)

CAM_F_PRUENRICHERR error in Uranium enrichment

CAM_F_PRMGAU122FW Max permissible FWHM (keV) at 122 keV

524
 Processing Parameters

CAM_X_PRAMSEPLIMIT Maximum Am separation time

CAM_F_PRMGAMAXNQF Maximum fit value

CAM_F_PRMAX122FWHM Maximum 122 keV FWHM (for validity test; in

eV)

CAM_F_PRMAXMGAPUER Maximum error in 240Pu effective (in percent)

CAM_T_PRMGAAVEPEAK Used in MGA Results Averaging engine: Nu-

clide whose primary gamma determines results
weighting (Pu-239, Pu-241, U-235) (8 charac-
ters)

CAM_F_PRMAXDT Maximum allowed deadtime (in percent)

CAM_F_PRMINPU239 Minimum allowed Pu-239 abundance

CAM_F_PRMAXPU239 Maximum allowed Pu-239 abundance

CAM_T_PRFIDUPEAKS Space, tab, or comma separated list of fiducial

photopeak energies

CAM_F_PRMAXRPVSDTD Maximum allowed percent difference between

reference peak deadtime vs. MCA deadtime

CAM_F_PRMAXFIDUFIT Maximum allowed fiducial peak fit

CAM_T_PRCFFIDUPEAKS List of fiducial peak energies for Cf-252; values

are separated by comma, space, or tab (32 char-
acters)

CAM_T_PRCMFIDUPEAKS List of fiducial peak energies for Cm-244; val-

ues are separated by comma, space, or tab (32
characters)

Nuclide ID Processing Parameters

CAM_F_TOLERANCE Energy tolerance

CAM_F_VARTOLERANCE Variable energy tolerance (FWHM)

CAM_F_HALFLIFERAT Half-life ratio

CAM_F_ABUNDANLIM Abundance limit (%)

CAM_L_MPCTYPE MPC type to be reported

CAM_F_WTMLIMIT Limit for WT mean test

CAM_F_VPWIDTH Variable peak width

525
CAM Files

CAM_F_MDACONFID % confidence level for MDA

CAM_L_NSIGMA N sigma error to report

CAM_T_ACTIVUNITS Units of activity (for NID report, 16 chars)

CAM_F_ACTIVMULT Activity conversion factor (from µCi)

CAM_F_CONFID NID confidence index threshold

CAM_F_SIGMA Report uncertainty multiplier

CAM_T_BUILDUPTYPE Activity build-up type (DEPOSIT or IRRAD)

CAM_L_PRCSCTYPE Determines if Cascade summing correction is to

be performed: 0 for no, 1 for yes

WBC-Specific Processing Parameters

CAM_T_DOSEUNITS Dose reporting units (8 chars)

CAM_F_WBCDOSECOMIT ICRP-2 dose commitment period (years)

CAM_F_DOSEMULT Dose conversion factor (from mrem)

CAM_F_WBCDIL Derived investigation level (% of ALI)

CAM_T_PSTYPE Peak search type: STANDARD, LIBRARY,

SINGLET, ROI or GAMMA-M

CAM_L_ANALCNT Sum/Shift during count? (Y/N)

CAM_L_INCREP Include in report? (Y/N)

CAM_T_LIBNAME Library to be used for analysis

CAM_F_PWARNFIT Warning level for fit value

CAM_F_PWARNACT Warning level for activity

CAM_F_DOSETIME Dose commitment time (years)

Interactive Peak Search Processing Parameters

CAM_T_PLOTSCALE Plot scaling (LIN, LOG, SQRT) (4 characters)

CAM_F_ENERGYPKFLTR Select the peak region closest to this energy

CAM_F_CHISQPKFLTR Select multiplets with chi-square values greater

than this value

526
 Processing Parameters

CAM_F_FWRATPKFLTR Select peak regions whose ratio of measured to

expected FWHM exceeds this value

CAM_T_NUCLPKFLTR Select peak regions associated with this nuclide

(12 characters)

User Spare Processing Parameters

CAM_F_PRSPn User spare floating value n, where n is 1 to 3

CAM_F_PRSSPn User spare string n (16 characters), where n is 1

to 3

Reference Peak Processing Parameters

CAM_F_REFENG Reference peak energy

CAM_F_REFRATE Reference peak rate

CAM_F_DREFRATE Uncertainty in reference peak rate

CAM_X_REFDATE Reference rate measurement date

CAM_X_REFHLF Half-life of reference nuclide

CAM_T_REFHLFUNITS Units for reference nuclide half-life

Neutron Analysis Parameters

Coincidence Analysis
CAM_T_PRPUMUNITS Neutron analysis mass units string (16 charac-
ters)

CAM_F_PRPUMCF Conversion factor between external mass units

and grams

CAM_F_PRNEUTSFTMLL Totals filter lower rate limit

CAM_F_PRNEUTNSIGMA Totals filter rejection value (in standard devia-

tions)

CAM_F_PRNEURNSIGMA Reals filter (in standard deviations)

CAM_F_NEUTT2GTMLL T2G filter lower rate limit

CAM_F_NEUTT2GNSIG T2G filter (in standard deviations)

CAM_F_PRNEUTT2GPLM T2G filter precision test limit (%)

527
CAM Files

CAM_T_PRNEUTISOSRC Isotopics to use in Pu mass calculation

(DECLARED or MEASURED) (8 characters)

CAM_L_PRNERRMLIM Number of neutron measurements at or above

which the measured standard deviation is used
instead of the computed error. If this value is 0,
the computed error is always used.

CAM_T_PRNEFFTYPE Type of reals-to-mass calibration curve:

POLYNOMIAL, POWER, EXPONENTIAL,
RATIONAL (16 characters)

CAM_X_PRNEUTPRDATE Mass/isotopics prediction date

CAM_F_PRNBKGARAT Background rates adjustment factor

CAM_F_PRNSETIMEADJ Neutron cycle time adjustment factor

(CAM_F_NACQSETIME, the neutron cycle
time, is set to this value times
CAM_X_SRCOUNTTIME, if this value is
non-zero).

CAM_F_PRHCAASTHRES Coincidence AAS CF threshold required for ap-

plication of hydrogen correction factor

Multiplicity Analysis
CAM_F_PRNMFLOWLIM Upper multiplicity parameter limit

CAM_F_PRNMFHIGHLIM Lower multiplicity parameter limit

CAM_F_PRNEUTALPHA Known alpha value for multiplicity analysis

CAM_F_PRNEUTALPHER Uncertainty in known alpha

CAM_F_PRNEUTMFACT Known multiplication value for multiplicity

analysis

CAM_F_PRNEUTMFACER Uncertainty in the known multiplication

CAM_F_PRNEUTEFF Known efficiency value

CAM_F_PRNEUTEFFER Uncertainty in known efficiency

CAM_F_PRONESNSIGMA Ones rate filter n-sigma limit

CAM_L_PRNLSTHTYPE List mode histogram type: 0 = signal triggered, 1

= random triggered

CAM_F_PRNLSTHFREQ List mode random trigger frequency; if 0, then

the average count rate will be used

528
 Processing Parameters

CAM_F_PRNPREDELAY List mode histogram predelay (microseconds)

CAM_F_PRNGATEWIDTH List mode histogram gate width (microseconds)

CAM_F_PRNLONGDELAY List mode histogram long delay (microseconds)

CAM_F_PRNLSTCYCTIM List mode acquisition cycle time (seconds)

Automated Waste Analysis Parameters

CAM_F_PRAASLRGLIM AAS Large Limit

CAM_F_PRAWAHZLIM High-Z mass limit (kg) determines what is con-

sidered HZ

CAM_F_PRCMCFNSIGMA Cm/Cf Significance limit – N*Sigma – used for

determining if Cm, Cf, or Pu from Cm/Cf analy-
sis is significant

CAM_F_PRONESTOTLIM Ones Rate Totals limit, if totals rate is then Ones

rate anal is suitable

CAM_F_PRTRUNTOTLIM Truncation Totals Rate limit

240
CAM_F_PRAWAP240LIM Pu Effective Mass cutoff for KM, and Trun
analysis

Waste Assay Parameters

CAM_T_PRVOLUNITS Volume units (8 characters)

CAM_F_PRVOLCF Volume units conversion factor (should be ini-

tialized to 1 for liters)

CAM_T_PRDENSUNITS Density units (8 characters)

CAM_F_PRDENSCF Density units conversion factor (should be ini-

tialized to 1 for kg/L)

CAM_F_PRDPRATERLIM Differential peak ratio error limit

CAM_F_PRTRRATERLIM Transmission ratio error limit

CAM_F_PRP2AFAILOVR Peak to average failover ratio

CAM_T_PRCOMBMATMOD Combined matrix correction engine mode (8

characters)

CAM_F_PRT2AFAILOVR Transmission to average density failover ratio

CAM_F_PRMINTRANS Minimum transmission ratio (%)

529
CAM Files

CAM_F_PRMATRIXZ1 Matrix element 1 Z

CAM_F_PRMATRIXZ1FR Proportion of element 1 (as a fraction) in the

matrix

CAM_F_PRMATRIXZ2 Matrix element 2 Z

CAM_F_PRMATRIXZ2FR Proportion of element 2

CAM_F_PRMATRIXZ3 Matrix element 3 Z

CAM_F_PRMATRIXZ3FR Proportion of element 3

Miscellaneous Parameters
CAM_L_PARENTWDGT Widget/handle to parent window (used in GUI
Interactive Peak Fit)

CAM_L_SHELLHNDL Presentation Manager shell handle (used in OS/2

Interactive Peak Fit)

CAM_T_SADCHAR Sample Analysis Database character (12 charac-

ters)

CAM_F_PRTRACERAMT Amount of tracer added to samples

CAM_L_PRNITCFTYPE Type of NIT correction factor desired: 0 = mini-

mized KdP, 1 = KdP VWA, 2 = measured
VWA, 3 = radial VWA, 4 = axial VWA

Action Level Parameters

CAM_F_PRLEV1ALARM1 Sum action level 1 alarm level 1

CAM_F_PRLEV1ALARM2 Sum action level 1 alarm level 2

CAM_F_PRLEV2ALARM1 Sum action level 2 alarm level 1

CAM_F_PRLEV2ALARM2 Sum action level 2 alarm level 2

Shift/Sum Processing Parameters

CAM_L_PRSHIFTSTART Start channel in source spectra of data to be
Shift/Summed

CAM_L_PRSHIFTCHANS Number of channels from source spectra to be

Shift/Summed

CAM_T_PRSSLTCTYPE Live time correction mode: REFERENCE, or

FIXED (16 characters)

530
 Processing Parameters

Non-Uniformity Detection Analysis Parameters

CAM_F_PRNUDSENERG Energy of line (in keV) of transmission source
which marks matrix nonuniformity

CAM_T_PRNUDSNUCL Name of nuclide which marks source

non-uniformity (8 characters)

K-Edge Processing Parameters

CAM_F_PRKEDBLIMLL Start energy of lower continuum window (keV)

CAM_F_PRKEDBLIMLU End energy of lower continuum window (keV)

CAM_F_PRKEDBLIMUL Start energy of upper continuum window (keV)

CAM_F_PRKEDBLIMUU End energy of upper continuum window (keV)

CAM_F_PRKEDREF1ENG Reference peak 1 energy (keV)

CAM_F_PRKEDREF2ENG Reference peak 2 energy (keV)

CAM_F_PRKEDNORMENG Normalization energy (keV)

CAM_T_PRKEDELEMNT1 Name of element 1 (16 characters)

CAM_T_PRKEDELEMNT2 Name of element 2 (16 characters)

CAM_F_PRKEDMUNORM1 Mu of normalization energy of element 1

(cm2/gr)

CAM_F_PRKEDMUNORM2 Mu of normalization energy of element 2

(cm2/gr)

CAM_F_PRKEDDCL235 Default declared U-235 enrichment (%)

CAM_F_PRKEDDPUAWT Default declared Pu atomic weight (grams/mole)

CAM_F_PRKEDDNORMV Default K-edge normalization value

CAM_F_PRKEDKEDE1 Energy of k-edge for element 1 (keV)

CAM_F_PRKEDKEDE2 Energy of k-edge for element 2 (keV)

CAM_F_PRKEDFTLL1 Start energy of lower fitting window for element

1 (keV)

CAM_F_PRKEDFTLU1 End energy of lower fitting window for element

1 (keV)

CAM_F_PRKEDFTUL1 Start energy of upper fitting window for element

1 (keV)

531
CAM Files

CAM_F_PRKEDFTUU1 End energy of upper fitting window for element

1 (keV)

CAM_F_PRKEDFTLL2 Start energy of lower fitting window for element

2 (keV)

CAM_F_PRKEDFTLU2 End energy of lower fitting window for element

2 (keV)

CAM_F_PRKEDFTUL2 Start energy of upper fitting window for element

2 (keV)

CAM_F_PRKEDFTUU2 End energy of upper fitting window for element

2 (keV)

Self-Absorption Correction Parameters

CAM_T_SABSEQTYPE The type of equation to use (FULL or PARTIAL
self-absorption; 8 characters)

CAM_L_SABSMINPK The minimum number of peaks to use for fitting

CAM_F_SABSBETAM The minimum acceptable value for the parame-

ter beta

CAM_F_SABSALPHAM The minimum acceptable value for the parame-

ter alpha

TMU Analysis Parameters

General
CAM_F_PRLLWLIM LLW decision limit

CAM_F_PRMAXFGE Maximum FGE allowed; expert review required

if this value is exceeded

CAM_F_PRWCFAC Uncertainty multiplication factor in LLW deci-

sion equation

CAM_L_PRMMOVERRIDE Multi-modality Results selection override: al-

lows the automatic selection of which results to
use to be overridden: 0 = use automatic selec-
tion, 1 = passive neutron, 2 = quantitative
gamma, 3 = DDA, 4 = passive neutron Pu +
quantitative gamma U

532
 Processing Parameters

CAM_T_PRTMUISOSRC Isotopics actually used by TMU analysis (writ-

ten by TMU engines; 8 characters, either “Mea-
sured” or “Declared”)

CAM_F_PRDDASSCTOFF DDA self-shielding cutoff (grams FGE)

CAM_F_PRGUDDACTOFF Gamma Uranium DDA assay cutoff (grams U)

240
CAM_F_PR240RSCTOFF Pu effective mass review cutoff (grams)

CAM_F_PRGFDDACTOFF Gamma FGE DDA assay cutoff (grams FGE)

240
CAM_F_PR240SSCTOFF Pu effective mass self-shielding cutoff (grams)

Gamma TMU
CAM_F_PR414129LIM Maximum allowed ratio of the 239Pu – 414 keV
activity to 129 keV activity

CAM_F_PRGMATRIXERR 1-sigma relative uncertainty in matrix correction

measurement (this value is empirically deter-
mined)

CAM_F_PRLUMPFAC1 Lump uncertainty factor equation coefficient 1

CAM_F_PRLUMPFAC2 Lump uncertainty factor equation coefficient 2

CAM_F_PRMAXGPUMASS Maximum allowed total Pu mass

CAM_F_PRMINGPU239 Minimum allowed 239Pu mass (g)

CAM_F_PRMAXGPU239 Maximum allowed 239Pu mass

CAM_F_PRMAXGUMASS Maximum allowed total U mass

CAM_F_PRMAXGU233 Maximum allowed 233U mass

CAM_F_PRMAXGU235 Maximum allowed 233U mass

CAM_F_PRGRMAXFAC1 Rmax equation offset coefficient

CAM_F_PRGRMAXFAC2 Rmax equation slope coefficient

CAM_F_PRGRMAXFAC3 Rmax equation quadratic coefficient

CAM_F_PRGRMINFAC1 Rmin equation offset coefficient

CAM_F_PRGRMINFAC2 Rmin equation slope coefficient

CAM_F_PRGRMINFAC3 Rmin equation quadratic coefficient

CAM_F_PRMAXDENSITY Maximum suggested item density

533
CAM Files

CAM_F_PRMINAMRATIO Maximum 241Am/239Pu activity ratio

CAM_F_PRMINNPRATIO Maximum 237Np/239Pu activity ratio

CAM_F_PRISOCPUNSIG Maximum allowed difference (in sigma) be-

tween measured and declared 239Pu, 240Pu, and
235
U

CAM_F_PRISOCAMNSIG Maximum allowed difference (in sigma) be-

tween measured and declared 241Am

Passive Neutron TMU

CAM_F_PRAASCORERR 1-sigma additional relative error in
Add-a-Source correction factor

CAM_F_PRNMAXMFAC1 Maximum multiplication equation slope

CAM_F_PRNMAXMFAC2 Maximum multiplication equation offset

CAM_F_PRHZREALS Increase in reals rate per gram of high-Z mate-

rial

CAM_F_PRAASCFCTOF1 Add-a-Source correction factor “warning level”

CAM_F_PRAASCFCTOF2 Add-a-Source correction factor “alarm level”

CAM_F_PRAASERRLIM Add-a-Source correction factor error limit

CAM_F_PRNMAXRMIN Maximum value for Rmin

CAM_F_PRNMINRMAX Minimum value for Rmax

CAM_F_PRNRMAXFAC1 Rmax equation offset

CAM_F_PRNRMAXFAC2 Rmax equation slope

CAM_F_PRNRMINFAC1 Rmin equation offset

CAM_F_PRNRMINFAC2 Rmin equation slope

CAM_F_PRMAXNCYCREJ Upper limit (in %) of cycles rejected

CAM_F_PRMAXNALPHA Maximum value for alpha

DDA TMU Analysis Parameters

CAM_F_PRDDATMUMCA Matrix correction error factor a

CAM_F_PRDDATMUMCB Matrix correction error factor b

CAM_F_PRDDATMUMCC Matrix correction error factor c

534
 Processing Parameters

CAM_F_PRDDAMAXRMIN Maximum value for Rmin

CAM_F_PRDDAMINRMAX Maximum value for Rmax

CAM_F_PRDDATMUPTA Rmin calibration factor a

CAM_F_PRDDATMUPTB Rmin calibration factor b

CAM_F_PRDDATMUPTC Rmax calibration factor a

CAM_F_PRDDATMUPTD Rmax calibration factor b

CAM_F_PRDDATMUSSA Self-shielding error calibration factor a

CAM_F_PRDDATMUSSB Self-shielding error calibration factor a

CAM_F_PRDDATMUSSM0 Self-shielding calibration reference mass

DDA Processing Parameters

CAM_F_PRDDAFLEGLLM Lower rate limit for chamber early gate flux
monitor (cps)

CAM_F_PRDDAFLEGHLM Upper rate limit for chamber early gate flux

monitor (cps)

CAM_F_PRDDADEFMI Default moderator index

CAM_F_PRDDADEFAI Default absorption index

CAM_F_PRDDAMAXMI Maximum moderator index

CAM_F_PRDDAMINMI Minimum moderator index

CAM_F_PRDDATHRMI Threshold moderator index

CAM_F_PRDDAMINAI Minimum absorption index

CAM_F_PRDDATHRAI Threshold absorption index

CAM_F_PRDDADEFAMCF Default (supplied) active matrix correction fac-

tor

535
CAM Files

TGS Processing Parameters

Collimator and Geometry Parameters

CAM_L_PRTGSCOLTYPE Collimator type: 0 = Circular Collimator and
Detector; 1 = Rectangular Collimator, Square
Detector; 2 = Rectangular Collimator,Circular
Detector; 3 = Diamond Collimator, Circular De-
tector; 4 = Variable Collimator, Circular Detec-
tor

CAM_F_PRTGSCOLLEN Collimator length (cm)

CAM_F_PRTGSCOLDIST Collimator distance (cm)

CAM_F_PRTGSCOLWDTH Collimator width (cm)

CAM_F_PRTGSCOLHGT Collimator height (cm)

CAM_F_PRTGSDETDIAM Detector diameter (cm)

CAM_F_PRTGSCOLTRIM Trim width (cm)

CAM_F_PRTGSCOLLOFF Left offset (cm)

CAM_F_PRTGSLAYERCO Layer coupling

CAM_F_PRTGSXOFFSET X offset (cm)

CAM_F_PRTGSCOLXOFF Collimator X offset (cm)

CAM_F_PRTGSEFFDPTH TGS detector effective depth (cm)

Analysis Parameters
CAM_F_PRTGSAREDAMP ART emission damping factor

CAM_L_PRTGSAREITER ART emission iterations

CAM_F_PRTGSAREMAXV ART emission maximum voxel value

CAM_F_PRTGSAREMINV ART emission minimum voxel value

CAM_L_PRTGSEMEITER EM emission iterations

CAM_F_PRTGSEMEMINV EM emission minimum voxel value

CAM_F_PRTGSARTDAMP ART transmission damping factor

CAM_L_PRTGSARTITER ART transmission iterations

CAM_F_PRTGSARTMAXV ART transmission maximum voxel value

536
 Processing Parameters

CAM_F_PRTGSARTMINV ART transmission minimum voxel value

CAM_F_PRTGSMINTCPS Minimum transmission rate (cps)

CAM_L_PRTGSMETHOD Emission fit method flags (for SET METHOD)

CAM_L_PRTGSMFEMFIT Do EM full drum fit

CAM_L_PRTGSMFARFIT Do ART full drum fit

CAM_L_PRTGSMFL0ZSI Force layer 0 to have a zero s-image

CAM_L_PRTGSMFNNLSU In EM fits, make the NNLS pre-image the

upper limit

CAM_L_PRTGSMFUNILF Use uniform layer fit

CAM_L_PRTGSMFUSEAR Use ART transmission fit, not NNLS

CAM_L_PRTGSMFAREFL ART emission flags (for SET ART_S_CODE)

CAM_L_PRTGSAEFNLB No lower bound in image

CAM_L_PRTGSAEFNUB No upper bound in image

CAM_L_PRTGSAEFUCIM Use current image as starting point

CAM_L_PRTGSAEFRAND Random cycle order

CAM_L_PRTGSAEFNOCT No convergence test

CAM_L_PRTGSAEFSMIN Use s-image as lower bound

CAM_L_PRTGSAEFSMAX Use s-image as upper bound

CAM_L_PRTGSMFARTFL ART transmission flags (for SET

ART_U_CODE)

CAM_L_PRTGSATFNLB No lower bound in image

CAM_L_PRTGSATFNUB No upper bound in image

CAM_L_PRTGSATFUCIM Use current image as starting point

CAM_L_PRTGSATFRAND Random cycle order

CAM_L_PRTGSATFNOCT No convergence test

537
CAM Files

CAM_L_PRTGSATFSMIN Use u-image as lower bound

CAM_L_PRTGSATFSMAX Use u-image as upper bound

CAM_L_PRTGSMCITER Number of Monte Carlo iterations (used to cal-

culate uncertainties)

Library Correlation Parameters

CAM_F_PRSHAPCORTHR Library correlation: shape correlation threshold
(0 to 1)

CAM_F_PRSENSTHRESH Library correlation: sensitivity threshold (%)

CAM_F_PRGAINSHTOL Library correlation: gain shift tolerance (%)

CAM_F_PRSHAPERRTOL Library correlation: shape error tolerance (%)

CAM_F_PRFESHLDTOL Library correlation: shielding tolerance (in cm

Fe)

Display Parameters
The display parameters block is composed of common display parameters and variable
length region records, one region per record. Each region record contains tabular entries,
each with a channel and a row parameter. Normally, two entries will be present, which
represents single parameter regions. The symbolic name for this class is
CAM_CLS_DISP.

Common Parameters
CAM_T_DISPMODE Display mode (LOG, LIN, ALOG, ALIN)

CAM_L_DISPFLAGS Display flags

CAM_M_DISP_DISPTHRESHMD Display thresholds (MPA display only)

[CAM_L_DISPTHRESHMD]

CAM_M_DISP_DISPTRANSPAR Display in transparent mode (MPA display

[CAM_L_DISPTRANSPAR] only)

CAM_L_DISPSCH Display start channel

538
 Display Parameters

CAM_F_DISPSCHEN Display start channel energy

CAM_L_DISPSROW Display start row

CAM_F_DISPSROWEN Display start row energy

CAM_L_DISPECH Display end channel

CAM_F_DISPECHEN Display end channel energy

CAM_L_DISPEROW Display end row

CAM_F_DISPEROWEN Display end row energy

CAM_L_DISPSCOUNT Display start count

CAM_L_DISPECOUNT Display end count

CAM_L_DISPGROUP Display group

CAM_L_DISPCRATE Display count rate (counts/second)

CAM_Q_DISPTCOUNT Display total counts

CAM_Q_DISPNETCOUNT Display net counts

CAM_Q_DISPBKGCOUNT Display background counts

CAM_L_LMARKCH Left marker channel

CAM_F_LMARKCHEN Left marker channel energy

CAM_L_LMARKROW Left marker row

CAM_F_LMARKROWEN Left marker row energy

CAM_L_RMARKCH Right marker channel

CAM_F_RMARKCHEN Right marker channel energy

CAM_L_RMARKROW Right marker row

CAM_F_RMARKROWEN Right marker row energy

CAM_L_CURSORCH Cursor channel

CAM_F_CURSORCHEN Cursor channel energy

CAM_L_CURSORROW Cursor row

CAM_F_CURSORROWEN Cursor row energy

CAM_L_DISPTILT Display tilt (degrees)

539
CAM Files

CAM_L_DISPROT Display rotation (degrees)

CAM_L_DISPBOXTOP Expansion box top (ND9900 only)

CAM_L_DISPBOXBOT Expansion box bottom

CAM_L_DISPBOXLEFT Expansion box left edge

CAM_L_DISPBOXRIGHT Expansion box right edge

CAM_L_DISPUPDRATE Display update delay (centiseconds)

CAM_L_SCRNSAVER Screen saver timeout (ND9900 only)

CAM_T_LDROIFILE Loaded ROI file (96 characeters)

User Spare Display Parameters

CAM_F_DISSP1 User spare 1

CAM_F_DISSP2 User spare 2

CAM_T_DISSTRn Display spare string n (20 characters), where n is

1 to 6

MPA Display Parameters

CAM_L_DISPTHRESHn Threshold n upper limit, where n is 0 to 6

CAM_L_DISPTCOLORn Threshold n color, where n is 0 to 7

CAM_L_DISPBOXFRONT Expansion box start row

CAM_L_DISPBOXBACK Expansion box back row

Record Parameters
CAM_L_RGNTYPE Region type

Record Tabular Entry Parameters

CAM_L_RGNSTART Region start

CAM_L_RGNEND Region end

CAM_F_RGNSTARTEN Region start energy

CAM_F_RGNENDEN Region end energy

540
 Peak Search Results

Each region of interest is one record; the type of the region is defined by RGNTYPE.
Single parameter regions of interest will have one tabular entry: the start channel of the
region is RGNSTART; the end channel is RGNEND. Multiparameter regions of interest
have more than one tabular entry, each defining a X,Y coordinate with RGNSTART and
RGNEND, respectively.

Peak Search Results

The peak search results block contains several common parameters, and a number of re-
cords, each of which represents a peak. The symbolic name for this class is
CAM_CLS_PEAK.

Note: These calibration parameters are not used by the “new” reference peak engine; its
calibration parameters are kept in acquisition parameters.

Common Parameters
CAM_L_PSFLAGS Peak search processing flags

CAM_M_PSF_PEAKANAL Peak analysis done

[CAM_L_PSFPEAKANAL]

CAM_M_PSF_PILEUP Pulse pileup correction done

[CAM_L_PSFPILEUP]

CAM_M_PSF_SPLIN Efficiency computation done

[CAM_L_PSFSPLIN]

CAM_M_PSF_ENBACK Ambient background subtraction done

[CAM_L_PSFENBACK]

CAM_M_PSF_NAAINTF NAA interference correction done

[CAM_L_PSFNAAINTF]

CAM_M_PSF_SETEFF NAA SETEFF done

[CAM_L_PSFSETEFF]

CAM_M_PSF_REAGENT Reagent background subtraction done

CAM_M_PSF_NUDSDONE NUDS (Non-Uniformity Detection Soft-

[CAM_L_PSNUDSDONE] ware) done

CAM_M_PSF_NUDSMCL NUDS could not find the transmission peak

[CAM_L_PSNUDSMCL] in one spectrum

CAM_M_PSF_NUDSMNF NUDS count not find the transmission peak

[CAM_L_PSNUDSMNF] in any spectrum

541
CAM Files

CAM_M_PSF_NUDSSCL NUDS could not find the source peak in one

[CAM_L_PSNUDSSCL] spectrum

CAM_M_PSF_NUDSSNF NUDS could not find the source peak in any

[CAM_L_PSNUDSSNF] spectrum

CAM_T_PSNUDSVERS NUDS version (16 characters)

CAM_L_PSNUDSERROR NUDS error code: provides additional diag-

nostic information if NUDS cannot analyze
the data; allowed range: 0 through 255

CAM_M_PSF_REFPEAK Reference peak correction done (set when

[CAM_L_PSREFPEAK] reference peak correction successfully per-
formed)

CAM_M_PSF_REFPEAKERR Error in reference peak correction (set if ref-

[CAM_L_PSREFPEAKERR] erence peak correction could not be per-
formed)

CAM_M_PSF_ASTMSUMDONE ASTM summing engine done

[CAM_L_PSASTMSUMDON]

CAM_M_PSF_VCHECK Set when Spectrum Validity Check engine

[CAM_L_PSFVCHECK] has executed

CAM_M_PSF_VCHECKRVW Set if all Spectrum Validity tests fail and

[CAM_L_PSFVCHECKRVW] therefore the data should be reviewed

CAM_M_PSF_VCHECKREF Set if the Spectrum Validity reference peak

[CAM_L_PSFVCHECKREF] test failed

CAM_M_PSF_VCHECKFID Set if the Spectrum Validity fiducial peaks

[CAM_L_PSFVCHECKFID] test failed

CAM_M_PSF_VCHECKMDT Set if the Spectrum Validity Check refer-

[CAM_L_PSFVCHECKMDT] ence peak vs. MCA deadtime comparison
failed

CAM_M_PSF_STRIPBACK Library correlation: background stripping

[CAM_L_PSSTRIPBACK] performed

CAM_X_PPELIVE Pileup corrected live time

CAM_X_PSBKASTIME Acquisition start time (background spectrum)

CAM_X_PSBKELIVE Elapsed live time (background spectrum)

CAM_X_PSDATE Date/time peak search performed

CAM_X_PADATE Date/time peak analysis performed

542
 Peak Search Results

CAM_F_REFPKRATIO Reference peak ratio

CAM_F_DREFPKRAT Uncertainty in reference peak ratio

CAM_F_PSUDFWRATIO User defined FW ratio: 0.1 for FWTM, …

CAM_T_PEAKVERS Peak search version (16 characters)

CAM_T_PKANALVERS Peak analysis version (16 characters)

CAM_T_PILEUPVERS Pulse pileup version (16 characters)

CAM_T_SPLINVERS Efficiency calculation version (16 characters)

CAM_T_ENBACKVERS Background subtraction version (16 characters)

CAM_T_REAGENTVERS Reagent background subtraction version (16

characters)

CAM_L_PSGROUP Searched group number (always 1)

CAM_T_NAAINTFVERS NAA INTERF version (16 characters)

CAM_F_PSCHEMYIELD Chemical yield

CAM_F_PSDCHEMYIELD Error in chemical yield

CAM_F_PSNUDSMRATL NUDS matrix nonuniformity ratio (longitudinal)

CAM_F_PSNUDSMCSQL NUDS matrix nonuniformity chi-square (longi-

tudinal)

CAM_F_PSNUDSMRATV NUDS matrix nonuniformity ratio (vertical)

CAM_F_PSNUDSMCSQV NUDS matrix nonuniformity chi-square (verti-

cal)

CAM_F_PSNUDSSRATL NUDS source nonuniformity ratio (longitudinal)

CAM_F_PSNUDSSCSQL NUDS source nonuniformity chi-square (longi-

tudinal)

CAM_F_PSNUDSSRATV NUDS source nonuniformity ratio (vertical)

CAM_F_PSNUDSSCSQV NUDS source nonuniformity chi-square (verti-

cal)

CAM_L_PSREFPKAERR Reference peak analysis error code (0 if none)

CAM_F_PRREFPKETOL Reference peak analysis energy tolerance (used

by the “new” reference peak engine only)

543
CAM Files

Record Parameters
CAM_L_PSITER Number of iterations

CAM_L_PSAGANLINE AGA: record number of energy line

CAM_F_PSCENTRD Peak centroid

CAM_F_PSDCENTRD Uncertainty in centroid

CAM_F_PSENERGY Peak energy

CAM_F_PSDENERGY Uncertainty in energy

CAM_L_PSLEFT Peak left channel

CAM_L_PSPWIDTH Peak region width (channels) [Can also be ac-

cessed as CAM_L_PSWIDTH]

CAM_F_PSBACKGND Continuum background counts

CAM_F_PSDBACK Uncertainty in continuum background

CAM_F_PSFWHM Peak Full-Width at Half-Maximum in energy

units

CAM_F_PSDFWHM Uncertainty in FWHM

CAM_F_PSAREA Peak area

CAM_F_PSDAREA Uncertainty in peak area

CAM_F_PSORIGAREA Original peak area (uncorrected)

CAM_F_PSORIGERR Uncertainty in original peak area

CAM_F_PSCTSS Counts/second

CAM_F_PSCERR % error in area and counts/second

CAM_F_PSEFF Efficiency

CAM_F_PSEFERR Absolute error in efficiency

CAM_F_PSFIT Reduced chi-square for fit

CAM_L_PSBKCHAN Number of average background channels

CAM_F_PSLOCCENT Peak location centroid

CAM_F_PSDLOCCENT Uncertainty in peak location centroid

CAM_F_PSTAIL1 Low energy tail

CAM_F_PSDTAIL1 Uncertainty in low energy tail

544
 Peak Search Results

CAM_F_PSTAIL2 Additional tail

CAM_F_PSDTAIL2 Uncertainty in additional tail

CAM_F_PSSIGNIF Peak significance

CAM_F_PSGROSS Gross counts in peak region

CAM_F_PSAMBBACK Ambient background subtracted from net area

CAM_F_PSDAMBBACK Uncertainty in ambient background

CAM_F_PSFWXM User defined FWxM

CAM_F_PSDFWXM Uncertainty in user defined FWxM

CAM_F_PSPTCRATIO Peak/compton ratio

CAM_F_PSKVAL Peak significance value (“k”)

CAM_F_PSAGAGCF AGA: gain correction factor

CAM_F_PSAGAGCFERR AGA: gain correction factor error

CAM_F_PSGAINSHFT % gain shift from library energy (Gamma-M

only)

CAM_T_PSFITENGNAME Peak fit engine name (8 characters)

CAM_T_PSBACKTYPE Background type (1 character: S for step, L for

linear)

CAM_L_PSLBACKST Start channel of left background region

CAM_L_PSLBACKEN End channel of left background region

CAM_L_PSRBACKST Start channel of right background region

CAM_L_PSRBACKEN End channel of right background region

CAM_F_PSPEAKATTN Attenuation factor

CAM_F_PSPEAKATTNER Error in peak attenuation

CAM_F_PSORIGEFF Original efficiency

CAM_F_PSORIGEFFER Error in original efficiency

CAM_F_PSRBACK Reagent background subtracted from net area

CAM_F_PSDRBACK Uncertainty in reagent background

CAM_F_PSACCPS Attenuation corrected count rate (calculated by

ASTM sum algorithm)

545
CAM Files

CAM_F_PSCPSERR error in attenuated count rate (calculated by

ASTM sum algorithm)

CAM_F_PSCRITLEVEL Critical level

CAM_F_PSOGAINSHIFT Library correlation: optimized gain shift (%)

CAM_F_PSOSHAPEERR Library correlation: optmized shape error (%)

CAM_F_PSOFESHLDTHK Library correlation: optimized shielding thick-

ness (in cm Fe)

CAM_F_PSCORRNIDXSQ Library correlation: correlation NID chi-squared

CAM_L_PSPFLG Peak flags

CAM_M_PSP_KNOWN Known peak (set by NID)

[CAM_L_PSPKNOWN]

CAM_M_PSP_PFIT Peak is first of a fitted group (if a singlet is

[CAM_L_PSPPFIT] fit, then PFIT should be set and MULT
should be off)

CAM_M_PSP_MULT Peak is part of a multiplet

[CAM_L_PSPMULT]

CAM_M_PSP_ENBACK Ambient background subtracted from peak

[CAM_L_PSPENBACK] area

CAM_M_PSP_MANADD Peak was manually added

[CAM_L_PSPMANADD]

CAM_M_PSP_MANDEL Peak was manually deleted

[CAM_L_PSPMANDEL]

CAM_M_PSP_MANEDIT Peak was manually edited

[CAM_L_PSPMANEDIT]

CAM_M_PSP_ABERR Peak aberrations are present

[CAM_L_PSPABERR]

CAM_M_PSP_REFPK Reference peak

[CAM_L_PSPREFPK]

CAM_M_PSP_FITROI Invalid fit region-of-interest

[CAM_L_PSPFITROI]

CAM_M_PSP_FITCONVERGE Invalid fit convergence

[CAM_L_PSPFITCONV]

546
 Peak Search Results

CAM_M_PSP_PARANGEL Left limit clipped by PASTART

[CAM_L_PSPPARANGEL]

CAM_M_PSP_PARANGER Right limit clipped by PAEND

[CAM_L_PSPPARANGER]

CAM_M_PSP_PADONE Peak analysis has been performed

[CAM_L_PSPPADONE]

CAM_M_PSP_EFFINT Interpolated efficiency data (lung counting

[CAM_L_PSPEFFINT only)

CAM_M_PSP_VARYENG Peak centroid was allowed to vary

[CAM_L_PSPVARYENG]

CAM_M_PSP_VARYAREA Peak area was allowed to vary

[CAM_L_PSPVARYAREA]

CAM_M_PSP_VARYFWHM Peak FWHM was allowed to vary

[CAM_L_PSPVARYFWHM]

CAM_M_PSP_VARYLTAIL Peak low tail was allowed to vary

[CAM_L_PSPVARYLTAIL]

CAM_M_PSP_VARYHTAIL Peak high tail was allowed to vary

[CAM_L_PSPVARYHTAIL]

CAM_M_PSP_FROMLIBR Peak energy came from a library

CAM_M_PSP_REAGENT Net area was corrected for reagent back-

[CAM_L_PSPREAGENT] ground

CAM_L_PSTNIDDONE Tentative NID performed

CAM_M_PSP_ADJPEAK An adjacent peak may have affected this

[CAM_L_PSPADJPEAK] peak’s results

CAM_M_PSF_REAGENT Reagent background processed flags

[CAM_L_PSFREAGENT

CAM_M_PSP_TRACERPK Tracer peak? (Y/N)

[CAM_L_PSPTRACERPK]

CAM_M_PSP_PRESENT Used for ASP applications: this peak was

[CAM_L_PSPPRESENT] found to be present (i.e., statistically signifi-
cant at one or both sensitivity levels)

CAM_M_PSP_UNKNOWN Used for ASP applications: this peak is an

[CAM_L_PSPUNKNOWN] unknown (i.e., does not appear in the ROI
list)

CAM_M_PSP_USEDINSUM Used for ASP applications: this peak was

[CAM_L_PSPUSEDINSUM] used in the calculation of the Sum ROI

547
CAM Files

User Spare Peak Search Parameters

CAM_F_PSSP1 User spare

CAM_F_PSSP2 User spare

More Peak Search

A parameter class CAM_CLS_MOREPEAK, contains the results of Tentative NID. Each
record in this class corresponds with a peak record in the peak search results class, and
contains the names of the nuclide associated with that peak.

Common Parameters
CAM_T_PMTNIDVERS Tentative NID engine version (16 characters)

Record Tabular Parameters

CAM_T_PMNCLNAME Name of nuclide associated with peak (12 char-
acters)

Certificate Parameters
The certificate parameters block contains three common parameters, and a record for ev-
ery energy line described in a standard source’s calibration certificate. The symbolic
name for this class is CAM_CLS_CERTIF.

Common Parameters
CAM_T_CTFNAME Certificate title

CAM_X_CTFDATE Certificate date

CAM_F_CTFQUANT Certificate quantity

CAM_F_CTFECNVFAC Certificate energy conversion factor

CAM_T_CTFEUNITS Certificate energy units

CAM_T_CTFASTMMATRX Matrix description (32 characters)

CAM_T_CTFASTMMATER Material description (64 characters)

CAM_T_CTFIMAGEFILE Name of file containing scanned image of

source certificate paperwork (128 characters)

548
 Energy/FWHM Calibration Results Parameters

Record Parameters
CAM_T_CTFNUCL Nuclide name

CAM_F_CTFENER Line energy (keV)

CAM_X_CTFHLFLIFE Half life

CAM_T_CTFHLFUNITS Half life units

CAM_X_CTFHLFERR Uncertainty in half life

CAM_F_CTFRATE Emission rate (gammas or alphas/sec/unit quan-

tity)

CAM_F_CTFERROR % uncertainty in emission rate

CAM_F_CTFABUN % abundance

CAM_F_CTFASTMMASS Declared mass (grams)

CAM_F_CTFASTMMERR Error in declared mass

CAM_L_CTFAGAUSED AGA: this line was used by AGA

CAM_L_CTFFLAGS Certificate parameter flags

CAM_M_CTF_NOASKINI CAL/INITIAL will not use this line

[CAM_L_CTFNOASKINI]

CAM_M_CTF_TRACER This is a tracer line (alpha spectroscopy)

[CAM_L_CTFTRACER]

Energy/FWHM Calibration Results Parameters

The calibration results block contains a common parameter which describes the calibra-
tion analysis version, and a number of records which store information about each en-
ergy/centroid channel/FWHM point which is quantified at calibration time.

Please note that the offset and coefficients of the energy and FWHM calibrations are
stored in the acquisition parameters block (CAM_CLS_ACQP). Also note that the detec-
tor efficiency calibration’s energy/efficiency pairs and empirical fit parameters are stored
in the geometry parameters block (CAM_CLS_GEOM).

The symbolic name for this parameter block is CAM_CLS_CALRESULTS.

549
CAM Files

Common Parameters
CAM_T_CALVERS Calibrate version/ID (16 characters)

CAM_T_ECOPNAME Operator for last energy calibration (24 charac-

ters)

CAM_L_CURRPEAK Current peak record of interest

Record Parameters
CAM_F_CALENERGY Calibration energy

CAM_F_CALCENTROID Computed centroid

CAM_F_CALCENTERR Uncertainty in centroid

CAM_F_CALFWHM Computed FWHM

CAM_L_CALFLAGS Energy calibration flags field

CAM_M_ERF_POORFIT Poor fit during energy calibration? (Y/N)

[CAM_L_ERFPOORFIT]

CAM_M_ERF_511PEAK 511 keV peak? (Y/N)

[CAM_L_ERF511PEAK]

CAM_M_ERF_REFPEAK Reference peak? (Y/N)

[CAM_L_ERFREFPEAK]

Shape Calibration Results Parameters

The shape calibration results block contains a common parameter which describes the
shape calibration analysis version, and a number of records which store information
about each energy/FWHM/tail point which is quantified at calibration time.

Please note that the offset and coefficients of the FWHM and tail calibrations are stored
in the acquisition parameters block (CAM_CLS_ACQP). Also note that the detector effi-
ciency calibration’s energy/efficiency pairs and empirical fit parameters are stored in the
geometry parameters block (CAM_CLS_GEOM).

The symbolic name for this parameter block is CAM_CLS_SHAPECALRES.

Common Parameters
CAM_T_SCALVERS Calibrate version/ID (16 characters)

550
 Nuclide Library and Results

CAM_T_SCOPNAME Operator for last shape calibration (24 charac-

ters)

Record Parameters
CAM_F_SCENERGY Shape calibration energy

CAM_L_SCSTART ROI start channel

CAM_L_SCEND ROI end channel

CAM_F_SCFWHM Computed FWHM

CAM_F_SCFWHMERR Uncertainty in FWHM

CAM_F_SCTAIL1 Computed low energy tail

CAM_F_SCTAIL1ERR Uncertainty in low energy tail

CAM_F_SCTAIL2 Computed additional tail

CAM_F_SCTAIL2ERR Uncertainty in additional tail

CAM_L_SCFLAGS Shape calibration flags field

CAM_M_SCF_POORFIT Poor fit during shape calibration? (Y/N)

[CAM_L_SCFPOORFIT]

CAM_M_SCF_511PEAK 511 keV peak? (Y/N)

[CAM_L_SCF511PEAK]

CAM_M_SCF_REFPEAK Reference peak? (Y/N)

[CAM_L_SCFREFPEAK]

Nuclide Library and Results

The same format is used for nuclide libraries and results. The nuclide identification pro-
cess fills in information in the nuclide library. There are actually two classes of informa-
tion associated with nuclide libraries and results: nuclides, and lines. There can be three
types of the nuclide information class: Standard Nuclide Identification (NID), Neutron
Activation Analysis (NAA), and Whole Body Counting (WBC). There can be two types
of the energy line information class: NID/WBC, or NAA.

The fact that the nuclides and lines are associated by nuclide and line numbers (rather
than names and energies) speeds access but requires that when nuclides or lines are de-
leted or inserted by the nuclide editor, the editor scans all the entries in the other class

551
CAM Files

and correct the associated entry numbers. For this reason, it is strongly recommended that
records not be added or deleted by user programs.

The symbolic definitions for these classes are CAM_CLS_NUCL and

CAM_CLS_NLINES.

Nuclide Common Parameters

CAM_T_NCLTITLE Title of nuclide library (64 characters)

CAM_L_NIDFLAGS NID processing flags

CAM_M_NIDF_NID Nuclide identification done

[CAM_L_NIDFNID]

CAM_M_NIDF_MDA Detection limits computed

[CAM_L_NIDFMDA]

CAM_M_NIDF_INTERF Interference correction done

[CAM_L_NIDFINTERF]

CAM_M_NIDF_WTMEAN Weighted mean done

[CAM_L_NIDFWTMEAN]

CAM_M_NIDF_NFLUX FLUX done

CAM_M_NIDF_NAA NAA done

CAM_M_NIDF_SETABUN NAA set abundance to 100% done

CAM_M_NIDF_WBCDOSE WBCDOSE done

CAM_M_NIDF_EBAR E-bar done

[CAM_L_NIDFEBAR]

CAM_M_NIDF_PMTORSO %MPOB based on lower torso MPOB

CAM_M_NIDF_PMLUNGS %MPOB based on lung MPOB

CAM_M_NIDF_WBCICRP30 ICRP30 done

CAM_M_NIDF_VARDTCORR Variable dead time correction done

[CAM_L_NIDFVARDT]

CAM_M_NIDF_PROPAGATE (Not currently used)

CAM_M_NIDF_NIDCOMB NID Combiner done

[CAM_L_NIDFNIDCOMB]

552
 Nuclide Library and Results

CAM_M_NIDF_MGANID Best of MGA/NID done

[CAM_L_NIDFMGANID]

CAM_M_NIDF_CRECOV Chemical recovery analysis done

[CAM_L_NIDFCRECOVDN]

CAM_M_NIDF_MGANIDP MGA/NID combiner performed combina-

[CAM_L_NIDFMGANIDP] tion

CAM_M_NIDF_ASTMMASS ASTM Mass calculation done

[CAM_L_ASTMMASSDONE]

CAM_M_NIDF_ACTADJ Flag indicating activity correction per-

[CAM_L_NIDFACTADJ] formed

CAM_M_NIDF_ACTLVL Flag indicating action level calculation per-

[CAM_L_NIDFACTLVL] formed

CAM_M_NIDF_LV1CONC Level 1 activity/concentration flag

[CAM_L_NIDLEVEL1CON]

CAM_M_NIDF_LV2CONC Level 2 activity/concentration flag

[CAM_L_NIDLEVEL2CON]

CAM_M_NIDF_CSCDONE Cascade summing corrector done

[CAM_L_NIDFCSCDONE]

CAM_M_NIDF_PDCDONE Parent-daughter correction performed

[CAM_L_NIDFPDCDONE]

CAM_M_NCLF_ACT1ALRM1 Action level 1 alarm 1 triggered

[CAM_L_NCLACT1ALRM1]

CAM_M_NCLF_ACT1ALRM2 Action level 1 alarm 2 triggered

[CAM_L_NCLACT1ALRM2]

CAM_M_NCLF_ACT2ALRM1 Action level 2 alarm 1 triggered

[CAM_L_NCLACT2ALRM1]

CAM_M_NCLF_ACT2ALRM2 Action level 2 alarm 2 triggered

[CAM_L_NCLACT2ALRM2]

CAM_L_NIDFLACE Flag specifying whether LACE was processed

on this file

CAM_L_NLAGAUSED AGA: this line was used by AGA

CAM_T_NIDVERS NID version (16 characters)

CAM_T_MDAVERS MDA version (16 characters)

553
CAM Files

CAM_T_INTERFVERS INTERF version (16 characters)

CAM_T_WTMEANVERS WTMEAN version (16 characters)

CAM_T_MGANIDVERSN Best of MGA/NID versionn (16 characters)

CAM_T_NIDCOMBVERSN NID Combiner version (16 characters)

CAM_T_NCLCSCVRS Cascade summing corrector version (16 charac-

ters)

CAM_T_NCLPDCVERS Parent-daughter correction algorithm version

(16 characters)

CAM_L_LIBFLAGS Nuclide library flags field

CAM_M_LIBF_NOSORT Nuclide library is not sorted

[CAM_L_LIBFNOSORT]

CAM_T_NCLMPCLABn MPC report label n (16 characters), where n is 1

to 8

CAM_T_NCLMPCnAU MPC-n activity units (8 characters), where n is 1

to 8

CAM_T_NCLMPCnQU MPC-n sample quantity units (8 characters),

where n is 1 to 8

CAM_F_NCLMPCnQCF MPC-n sample quantity conversion factor,

where n is 1 to 8

CAM_L_NCLMPCFLAGS MPC flags field. The flags in NCLMPCFLAGS

are available as individual parameters

CAM_L_NCLMPCSQFn Non-standard quantity units for MPC-n,

where n is 1 to 8

CAM_L_NCLPT20SQF Non-standard quantity units for 10CFR20

concentration

CAM_F_DEQACTI Dose equivalent iodine (µci/unit)

CAM_F_DEQACTXE Dose equivalent xenon (µci/unit)

CAM_T_ACTADJVERS Activity correction engine version (16 charac-

ters)

554
 Nuclide Library and Results

CAM_T_ACTLVLVERS Action level engine version (16 characters)

CAM_L_NCLPUNKNOWN Number of unidentified/unused peak search re-

sults

CAM_G_NCLSUMACT Sum of activities (µCi)

CAM_F_NCLLEV1SUM Sum of relative level 1 values

CAM_F_NCLLEV2SUM Sum of relative level 2 values

CAM_F_NCLLEV1UCONV Level 1 unit conversion value

CAM_F_NCLLEV2UCONV Level 2 unit conversion value

CAM_T_NCLLEV1UNITS Level 1 units (8 characters)

CAM_T_NCLLEV2UNITS Level 2 units (8 characters)

CAM_L_NCLNUMFOUND Total number of nuclides identified

CAM_L_ASTMMASSANAE Error code from ASTM mass calculation engine

CAM_F_NCLCTRLRECOV Recovery (absolute value) of control

CAM_T_NCLCONTROLDS Control sample description (32 characters)

CAM_L_NCLSABSCE Error code from last self-absorption calculation

CAM_T_LACEVERS LACE Version string, stores current version of

LACE

Record parameter (per nuclide)

CAM_F_NCLOSRELDIF % difference (between original sample and du-
plicate)

CAM_X_NCLCOOLDATE Worst case cool down date (calculated by action

level engine)

NAA-Specific Common Parameters

CAM_T_NFLUXVERS NFLUX version

CAM_T_NAAVERS NAA version

CAM_F_ELTNFLUX Thermal neutron flux

CAM_F_ELENFLUX Epithermal neutron flux

CAM_F_ELFNFLUX Fast neutron flux

555
CAM Files

CAM_X_ELIRTIME Irradiation duration

CAM_T_ELSUNITS Sample units

CAM_X_ELSTIME Irradiation date-time

CAM_X_ELSDATE Synonymous with CAM_X_ELSTIME

WBC Counting Common Parameters

CAM_T_WBCDVERS WBC Dose version (16 characters)

Record Parameters (All Applications)

CAM_T_NCLNAME Nuclide name (8 characters; 12 for NAA)

CAM_T_NCLPARENT Name of parent nuclide (8 characters)

CAM_T_NCLDAUGHT Name of daughter nuclide (8 characters)

CAM_F_NCLPARENTRAT Parent-to-daughter decay ratio

CAM_F_NCLPARENTRER Uncertainty in parent-to-daughter ratio

CAM_T_NCLSBHDR Nuclide type (16 characters; 12 for NAA)

CAM_X_NCLHLFLIFE Half life

CAM_X_NCLHLFERR Half life uncertainty

CAM_T_NCLHLFUNITS Half life report units (2 characters; Y, D, M or

S)

CAM_F_NCLMPC Maximum permissible concentration 1

CAM_F_NCLMPCn Maximum permissible concentration n, where n

is 2 to 8

CAM_F_NCLDACD DAC – clearence day (µCi/ml)

CAM_F_NCLDACW DAC – clearence week (µCi/ml)

CAM_F_NCLDACY DAC – clearence year (µCi/ml)

CAM_T_NCLDACTYPE DAC type to be used (D/W/Y)

CAM_F_NCLBETA Average beta energy (MeV/dis)

CAM_F_NCLGAMMA Average gamma energy (MeV/dis)

CAM_F_NCLMAC Mass absorption coefficient

556
 Nuclide Library and Results

CAM_F_NCLATMMASS Atomic mass

CAM_G_NCLMDA MDA (µCi/unit)

CAM_F_NCLMDAERR Error in MDA

CAM_F_MDABKGND Background calculated by MDA

CAM_F_NCLABNLIM Nuclide dependent abundance limit (%)

CAM_F_NCLAFRAC Percent of total abundance

CAM_G_NCLDECAY Activity decay factor (= 1.0)

CAM_F_NCLDECAYERR Relative error in decay factor

CAM_G_NCLWTMEAN Weighted mean activity

CAM_G_NCLWTMERR Error in WTM activity

CAM_G_NCLORGWTM Original weighted mean activity

(NCLWTMEAN may be adjusted by activity
correction engines)

CAM_G_NCLORGWTMER Error in original weighted mean activity

CAM_F_NCLCONFID Computed confidence index

CAM_F_NCLEQUFAC Nuclide equivalence factor

CAM_G_NCLSUMACT Sum of activities (for EBAR)

CAM_F_NCLSUMACTERF Fractional error in NCLSUMACT

CAM_L_NCLKEY Entry number of key line

CAM_F_NCLMRL Minimum reporting level (µCi)

CAM_F_NCLERRREJ % error rejection level

CAM_F_NCLMDAENG Energy used for MDA computation

CAM_F_NCLECAD Effluent concentration air days (µCi/cc)

CAM_F_NCLECAW Effluent concentration air weeks (µCi/cc)

CAM_F_NCLECAY Effluent concentration air years (µCi/cc)

CAM_T_NCLECATYPE Effluent concentration air type (1 character: is

D, W, or Y for days, weeks, or years)

CAM_F_NCLECWD Effluent concentration water days (µCi/cc)

557
CAM Files

CAM_F_NCLECWW Effluent concentration water weeks (µCi/cc)

CAM_F_NCLECWY Effluent concentration water years (µCi/cc)

CAM_T_NCLECWTYPE Effluent concentration water type (1 character: is

D, W, or Y for days, weeks, or years)

CAM_F_NCLRSD Release to sewers days (µCi/cc)

CAM_F_NCLRSW Release to sewers weeks (µCi/cc)

CAM_F_NCLRSY Release to sewers years (µCi/cc)

CAM_T_NCLRSTYPE Release to sewers type (1 character: is D, W, or

Y for days, weeks, or years)

CAM_T_NCLPT20AU Activity units string for 10CFR20 concentra-

tions (8 characters)

CAM_T_NCLPT20QU Quantity units string for 10CFR20 concentra-

tions (8 character)

CAM_F_NCLPT20QCF 10CFR20 quantity units conversion factor (used

only if the “non-standard quantity units” flag is
set)

CAM_T_NCLRESSRC Source of nuclide results (4 characters); used

only in gamma waste assay applications

CAM_F_NCLSPECACT Activity to mass conversion factor (g/µCi)

CAM_F_NCLRPTLEV Reporting level (activity/unit)

CAM_F_NCLMETMDA MDA to be met (activity/unit)

CAM_X_NCLCOOLDATEN Cool down date (calculated by action level en-

gine)

CAM_L_NCLFLAGS Nuclide flags

CAM_M_NCLF_FDECAY Nuclide failed decay test

[CAM_L_NCLFFDECAY]

CAM_M_NCLF_FABUN Nuclide failed abundance test

[CAM_L_NCLFFABUN]

CAM_M_NCLF_IDENT Nuclide identified by NID

[CAM_L_NCLFIDENT]

558
 Nuclide Library and Results

CAM_M_NCLF_MDA Detection limit computed. (Note: this flag

[CAM_L_NCLFMDA] being set does not imply that the nuclide
was not identified; check the IDENT flag!)

CAM_M_NCLF_KEYOUT Key-line is outside spectral area

[CAM_L_NCLFKEYOUT]

CAM_M_NCLF_SHORTHL Half life is too short for MDA calculation

[CAM_L_NCLFSHORTHL]

CAM_M_NCLF_INTFREJ Nuclide rejected by interference abundance

[CAM_L_NCLFINTFREJ] test. (Note: This flag is set after an energy
line is rejected by interference which as a re-
sult forces the nuclide to fail the nuclide
abundance test. Setting this flag also implies
that the NCLF_FABUN flag is set and the
NCLF_IDENT flag is cleared.)

CAM_M_NCLF_FWTMEAN Nuclide failed weighted mean test. (Note:

[CAM_L_NCLFWTMEAN] This flag is set when all energy lines of a
nuclide are rejected and the key-line was not
identified by NID. An energy line is rejected
if it was not identified by NID, was rejected
by an interference engine, was rejected by
weighted mean because of an interference or
was rejected by weighted mean because it
failed the n-sigma test. Setting this flag also
implies that the NCLF_IDENT flag is
cleared.)

CAM_M_NCLF_NOAUTO No automatic act/MDA transfer (SADS

[CAM_L_NCLFNOAUTO] only)

CAM_M_NCLF_NORPTMDA Don’t report an MDA (NID only)

[CAM_L_NCLFNORPTMDA]

CAM_M_NCLF_SUBHEAD [Not currently used]

CAM_M_NCLF_FLUX Use absolute or FLUX method to compute

concentration (NAA only)

CAM_M_NCLF_RPTMDA Report an MDA (WBC only)

CAM_M_NCLF_MREJECT Nuclide was manually rejected

[CAM_L_NCLFMREJECT]

CAM_M_NCLF_MACCEPT Nuclide was manually accepted

[CAM_L_NCLFMACCEPT]

CAM_M_NCLF_MEDIT Nuclide was manually edited

[CAM_L_NCLFMEDIT]

559
CAM Files

CAM_M_NCLF_VARDTCORR Nuclide was variable dead time corrected

[CAM_L_NCLFVARDT]

CAM_M_NCLF_NOEBAR Don’t use in E-bar calculation

[CAM_L_NCLFNOEBAR]

CAM_M_NCLF_EBAR An E-bar has been computed

[CAM_L_NCLFEBAR]

CAM_M_NCLF_UNRESINT Nuclide contains an unresolved interference

[CAM_L_NCLFUNRESINT]

CAM_M_NCLF_ERRREJ Nuclide was rejected by % error test

[CAM_L_NCLFERRREJ]

CAM_M_NCLF_MRLREJ Nuclide was rejected by minimum reporting

[CAM_L_NCLFMRLREJ] level test

CAM_M_NCLF_SABSDONE Self-absorption correction done for this nu-

[CAM_L_NCLSABSDONE] clide

CAM_M_NCLF_PDCORRDN Parent-daughter correction has been applied

[CAM_L_NCLFPDCORRDN] to this nuclide

CAM_M_NCLF_NCLFUSETRU Include this nuclide in TRU activity calcula-

[CAM_L_NCLFUSETRU] tion

CAM_M_NCLF_USETAA Include this nuclide in total alpha activity

[CAM_L_NCLFUSETAA] calculation

CAM_M_NCLF_WIPP This nuclide is of interest to TMU

[CAM_L_NCLFWIPP]

CAM_M_NCLF_USEASFID This is the fiducial nuclide for gamma TMU

[CAM_L_NCLFUSEASFID]

CAM_M_NCLF_USEISO Use isotopic ratios to calculate TMU activ-

[CAM_L_NCLFUSEISO] ity for this nuclide

CAM_M_NCLF_LACED LACE has processed this nuclide

[CAM_L_NCLLCPROC]

CAM_L_NCLLCKEYREJ LACE rejected nuclide for key-line process-

ing

CAM_L_NCLLCSINGREJ LACE rejected nuclide due to single line

criteria

CAM_L_NCLFHAZNUCL This nuclide contributes to 95% of total ac-

tivity; this flag is set by the Gamma TMU
engine

560
 Nuclide Library and Results

CAM_L_NCLFLAGS2 More nuclide flags

CAM_M_NCLF2_PT20DAYS Report DAC Days values

[CAM_L_NCLPT20DAYS]

CAM_M_NCLF2_PT20WEEKS Report DAC Weeks values

[CAM_L_NCLPT20WEEKS]

CAM_M_NCLF2_PT20YEARS Report DAC Years values

[CAM_L_NCLPT20YEARS]

CAM_M_NCLF2_PT20EAD Report Effluent Air Days values

[CAM_L_NCLPT20EAD]

CAM_M_NCLF2_PT20EAW Report Effluent Air Weeks values

[CAM_L_NCLPT20EAW]

CAM_M_NCLF2_PT20EAY Report Effluent Air Years values

[CAM_L_NCLPT20EAY]

CAM_M_NCLF2_PT20EWD Report Effluent Water Days values

[CAM_L_NCLPT20EWD]

CAM_M_NCLF2_PT20EWW Report Effluent Water Weeks values

[CAM_L_NCLPT20EWW]

CAM_M_NCLF2_PT20EWY Report Effluent Water Years values

[CAM_L_NCLPT20EWY]

CAM_M_NCLF2_PT20RSD Report Sewers Days values

[CAM_L_NCLPT20RSD]

CAM_M_NCLF2_PT20RSW Report Sewers Weeks values

[CAM_L_NCLPT20RSW]

CAM_M_NCLF2_PT20RSY Report Sewers Years values

[CAM_L_NCLPT20RSY]

CAM_M_NCLF2_CANDIDATE Library correlation: This is a candidate nu-

[CAM_L_NCLFCANDIDAT] clide

CAM_T_NCLGRPNAME Group Name (8 characters)

CAM_F_NCLLEVEL1 Calculated level 1

CAM_F_NCLLEVEL2 Calculated level 2

CAM_F_NCLACTLEVEL1 Action level 1 value

CAM_F_NCLACTLEVEL2 Action level 2 value

561
CAM Files

CAM_F_NCLADJFACn Activity correction factor number n, where n is 1

to 3

CAM_F_NCLERRADJ Error adjustment factor

CAM_T_NCLOBSERVED Name of observed nuclide

CAM_G_NCLNSAWTM Weighted mean activity before self-absorption

correction

CAM_G_NCLNSAWTME Error on weighted mean activity before

self-absorption correction

CAM_L_SABSNPKFIT Number of peaks used in fit

CAM_F_NCLSABSBETA Fit parameter beta

CAM_F_NCLSABSBETAE Error on beta

CAM_F_NCLSABSALPHA Fit parameter alpha

CAM_F_NCLSABSALPHE Error on alpha

239
CAM_F_NCLPEFAC Pu equivalent activity factor (converts nuclide
activity to 239Pu equivalent activity)

CAM_F_NCLFGEFAC Fissile gram equivalent factor (converts nuclide

mass to 239Pu FGE)

CAM_F_NCLSPECPWR Specific power (watts/gram)

CAM_F_NCLDOTADJFAC DOT hazard level factor; see 49CFR173.435

CAM_F_NCLLCKEYOFF Key Line equation, offset (a0)

CAM_F_NCLLCKEYOFFE Key Line equation, offset uncertainty

CAM_F_NCLLCKEYSLO Key Line equation, first order coefficient - slope

(a1)

CAM_F_NCLLCKEYSLOE Key Line equation, uncertainty in slope

CAM_F_NCLLCWMOFF Weighted Mean equation, offset (a0)

CAM_F_NCLLCWMOFFE Weighted Mean equation, offset uncertainty

CAM_F_NCLLCWMSLO Weighted Mean equation, first order coefficient

- slope (a1)

CAM_F_NCLLCWMSLOE Weighted Mean equation, uncertainty in slope

CAM_F_NCLTENTNSIG Library correlation: tentative nuclide signifi-

cance

562
 Nuclide Library and Results

CAM_F_NCLOPTNSIG Library correlation: optimized nuclide signifi-

cance

CAM_F_NCLCORRCOEFF Library correlation: correlation coefficient

User Spare Nuclide Parameters

CAM_F_NCLSPn User spare floating value n, where n is 1 to 6

NAA-Specific Nuclide Parameters

CAM_F_NCLATMWGT Atomic weight (Note: this parameter is a dupli-
cate of NCLATMMASS)

CAM_F_NCLCRSEC Cross section 1 (barns)

CAM_F_NCLCRSEC1 Cross section 2 (barns)

CAM_F_NCLCRSEC2 Cross section 3 (barns)

CAM_T_NCLFLUX Cross section 1 type (T, E or F)

CAM_T_NCLFLUX1 Cross section 2 type (T, E or F)

CAM_T_NCLFLUX2 Cross section 3 type (T, E or F)

CAM_F_NCLCONC Concentration

CAM_F_NCLCONCERR Uncertainty in concentration

CAM_T_NCLCONCUNITS Concentration units

CAM_F_NCLPFRAC Parent abundance fraction

CAM_L_NCLFFLUX Use FLUX method to compute concentration

WBC Nuclide Parameters

ICRP2 Parameters

CAM_L_NCLRPTMDA List MDA on LONG report

CAM_X_NCLHLEFFTH Thyroid effective half-life

CAM_X_NCLHLEFFLU Lungs effective half-life

CAM_X_NCLHLEFFLT Torso effective half-life

CAM_X_NCLHLEFFWB Whole body effective half-life

CAM_X_NCLHLEFFCO Critical organ effective half-life

563
CAM Files

CAM_T_NCLHLUNTH Thyroid half-life report units

CAM_T_NCLHLUNLU Lungs half-life report units

CAM_T_NCLHLUNLT Torso half-life report units

CAM_T_NCLHLUNWB Whole body half-life report units

CAM_T_NCLHLUNCO Critical organ half-life report units

CAM_F_NCLMPBTH Thyroid max permissible burden (Bq)

CAM_F_NCLMPBLU Lungs max permissible burden (Bq)

CAM_F_NCLMPBLT Torso max permissible burden (Bq)

CAM_F_NCLMPBWB Whole body max permissible burden (Bq)

CAM_F_NCLAVGSTH Thyroid average S′ (rem/µCi-day)

CAM_F_NCLAVGSLU Lungs average S′ (rem/µCi-day)

CAM_F_NCLAVGSLT Torso average S′ rem/µCi-day)

CAM_F_NCLAVGQ50TH Thyroid average Q50 (µCi-day/µCi)

CAM_F_NCLAVGQ50LU Lungs average Q50 (µCi-day/µCi)

CAM_F_NCLAVGQ50LT Torso average Q50 (µCi-day/µCi)

CAM_F_NCLFRUPTH Thyroid fractional uptake

CAM_F_NCLFRUPLU Lungs fractional uptake

CAM_F_NCLFRUPLT Torso fractional uptake

CAM_F_NCLFRUPWB Whole body fractional uptake

CAM_F_NCLADLMTTH Thyroid administrative limit in %

CAM_F_NCLADLMTLU Lungs administrative limit in %

CAM_F_NCLADLMTLT Torso administrative limit in %

CAM_F_NCLADLMTWB Whole body administrative limit in %

CAM_F_NCLINPOWARN1 INPO activity warning level 1 (µCi)

CAM_F_NCLINPOWARN2 INPO activity warning level 2 (µCi)

CAM_F_NCLOBMPBTH Thyroid calculated % MPB

CAM_F_NCLOBMPBLU Lungs calculated % MPB

564
 Nuclide Library and Results

CAM_F_NCLOBMPBLT Torso calculated % MPB

CAM_F_NCLMPCHRTH Thyroid calculated MPC-Hr

CAM_F_NCLMPCHRLU Lungs calculated MPC-Hr

CAM_F_NCLMPCHRLT Torso calculated MPC-Hr

CAM_F_NCLD50TH Thyroid 50-year dose commitment (rem)

CAM_F_NCLD50LU Lungs 50-year dose commitment (rem)

CAM_F_NCLD50LT Torso 50-year dose commitment (rem)

CAM_F_NCLICRP2F2 ICRP-2 F2 value

CAM_F_NCLEFAEPD Effective absorbed energy/disintegration (MeV)

CAM_F_NCLORGMASS Critical organ mass (grams)

CAM_T_NCLORGNAME Critical organ name (16 characters)

ICRP30 Parameters
CAM_T_NCLSOLCLASS Solubility class (D, W or Y)

CAM_F_NCLALI Annual limit on intake (Bq)

CAM_F_NCLINTAKE Computed intake (µCi)

CAM_F_NCLRATE1 A11 to A12 transfer rate (/day)

CAM_F_NCLRATE2 A15 to A19 transfer rate (/day)

CAM_F_NCLRATE3 A16 to A19 transfer rate (/day)

CAM_F_NCLRATE4 A17 to A19 transfer rate (/day)

CAM_F_NCLRATE5 A18 to A19 transfer rate (/day)

CAM_F_NCLRATE6 A12 to A15 transfer rate (/day)

CAM_F_NCLRATE7 A12 to A16 transfer rate (/day)

CAM_F_NCLRATE8 A12 to A17 transfer rate (/day)

CAM_F_NCLRATE9 A12 to A18 transfer rate (/day)

CAM_L_NCLINTDET [Not currently used]

CAM_F_NCLDAC Derived air concentration (Bq/m3)

CAM_F_NCLCDE Committed dose equivalent (Sv/Bq-Intake)

565
CAM Files

CAM_F_NCLWCDE Weighted committed dose equivalent

(Sv/Bq-Intake)

Record Tabular Entry Parameters

CAM_L_NCLLINE Line number associated with nuclide

Energy Line Parameters

Common Parameters
CAM_T_NLECUNITS Library energy units

CAM_F_NLECCNVFAC Library energy conversion factor

Record Parameters
CAM_F_NLENERGY Line energy

CAM_F_NLENGERR Uncertainty in energy

CAM_F_NLABUN Percent abundance

CAM_F_NLABUNERR Error in abundance

CAM_L_NLPEAK Peak number for this line5

CAM_G_NLACTVTY Decay corrected activity in µCi/unit

CAM_G_NLERR Error estimate (in µCi/unit)

CAM_F_NLEFFICIENCY Efficiency at line energy

CAM_F_NLEFFERR Error in efficiency

CAM_G_NLMDA Minimum detectable activity

CAM_G_NLMDAERR Error in MDA

CAM_F_NLMDABKGND MDA background

CAM_G_NLDETLIMIT Detection limit (LD)

CAM_L_NLNUCL Nuclide number associated with this line

5. If the parameter CAM_L__NLPEAK_ has a non-zero value, the energy line has been positively identified.

566
 Nuclide Library and Results

CAM_T_NLPEAKORIGIN Peak origin (1 character): “ ” – normal; “A” –

annihilation; “S” – single escape; “D” – double
escape; “M” – miscellaneous

CAM_F_NLMDABKGNDER Error in background counts (NLMDABKGND)

CAM_F_NLMDANET Net counts in the region

CAM_F_NLMDANETERR Error in net counts

CAM_F_NLMDADECLVL Decision level (in counts)

CAM_L_NLMDALREGST Start channel of the left background region

CAM_L_NLMDALREGEND End channel of the left background region

CAM_L_NLMDARREGST Start channel of the right background region

CAM_L_NLMDARREGEND End channel of the right background region

CAM_F_NLCOICF Coincidence summing correction factor

CAM_F_NLDCOICF Uncertainty in summing correction factor

CAM_F_NLLCWMRAT LACE output: ratio of line activity to nuclide

weighted mean activity

CAM_F_NLLCWMRATERR LACE output: uncertainty in ratio of line activ-

ity to nuclide weighted mean activity

CAM_F_NLLCKLRAT LACE output: ratio of line activity to nuclide

key line activity

CAM_F_NLLCKLRATERR LACE output: uncertainty in ratio of line activ-

ity to nuclide key line activity

CAM_L_NLFLAGS Energy line parameter flags

CAM_M_NLF_PHOTO This is a photopeak

[CAM_L_NLFPHOTO]

CAM_M_NLF_KEYLINE This is the key line

[CAM_L_NLFKEYLINE]

CAM_M_NLF_ACCSUM This is an accidental sum line

[CAM_L_NLFACCSUM]

CAM_M_NLF_COINSUM This is a coincident sum line

[CAM_L_NLFCOINSUM]

567
CAM Files

CAM_M_NLF_BACKGND This is a background line

[CAM_L_NLFBACKGND]

CAM_M_NLF_BCKSCTR This is a backscatter line

[CAM_L_NLFBACKSCTR]

CAM_M_NLF_COMPTON This is a Compton edge

[CAM_L_NLFCOMPTON]

CAM_M_NLF_SESC This is a single escape line

[CAM_L_NLFSESC]

CAM_M_NLF_DESC This is a double escape line

[CAM_L_NLFDESC]

CAM_M_NLF_FWTMEAN Line rejected by weighted mean n-sigma test

[CAM_L_NLFWTMEAN]

CAM_M_NLF_WTMINTREJ Line rejected by weighted mean interference

test

CAM_M_NLF_FINTERF Line rejected by interference test. (Note: for

[CAM_L_NLFFINTERF] interfering nuclides this means that the inter-
ference correction was made to the inter-
fered line and, therefore, this line has no
more statisical information for the interfer-
ing nuclide. For interfered nuclides, this
means that when the correction was made
the resulting area was less than 0.0 (or the
critical level if the critical level test is being
done), so the line is rejected.)

CAM_M_NLF_ELOUT Energy line is outside spectral area

CAM_M_NLF_MDA MDA value calculated

CAM_M_NLF_OUTOFRNG Energy line not within peak search energy

range

CAM_M_NLF_USEBCK Forced MDA was calculated using back-

[CAM_L_NLFUSEBCK] ground counts

CAM_M_NLF_COIAPPLIED Coincidence summing applied to this line

[CAM_L_NLCOIAPP]

CAM_M_NLF_COINOTINVLVD Not involved in cascade

[CAM_L_NLCOINOTI]

CAM_M_NLF_NOUSEWTM Don’t use this line in weighted mean calcu-

[CAM_L_NLFNOUSEWTM] lation

568
 Interfering Nuclide List Parameters

CAM_M_NLF_LACED LACE has processed this line

[CAM_L_NLFLACED]

User Spare Energy Line Parameters

CAM_F_NLSP1 User spare

NAA Specific Energy Line Parameters

Standards
CAM_F_NLCONST NAA “constant”

CAM_F_NLCONSTERR Uncertainty in NAA “constant”

CAM_F_NLSUMWGTDATA Sum of weighted constants

CAM_F_NLSUMWGTS Sum of weights

Samples or Unknowns
CAM_F_NLCONC Computed Concentration

CAM_F_NLCONCERR Uncertainty in concentration

CAM_T_NLCONCUNITS Concentration units (4 characters)

Interfering Nuclide List Parameters

The interfering nuclide list parameter block contains a record for every pair of nuclides
which potentially interfere with each other. The symbolic name for this class is
CAM_CLS_INTERF.

Record Parameters
CAM_T_INTERFRED Interfered nuclide name (8 characters)

CAM_T_INTERFRING Interfering nuclide name (8 characters)

Interference Specific Parameters

CAM_F_INTERFCP Energy of clean peak

CAM_F_INTERFIP Energy of interfered peak

CAM_F_INTERFRAT Interfered/clean peak ratio

569
CAM Files

CAM_F_INTERFRATERR Absolute error in ratio

Interfering Nuclide Results Parameters

The interfering nuclide results parameter block contains a record for every pair of
nuclides which interfere with each other. The symbolic name for this class is
CAM_CLS_INTRES.

Record Parameters
CAM_T_INTREDN Interfered nuclide name (8 characters)

CAM_F_INTREDL Energy of interfered peak

CAM_T_INTRINGN Interfering nuclide name (8 characters)

CAM_F_INTRINGL Energy of interfering peak

CAM_L_INTRFLAGS Interference flags [No flags currently used]

NAA Run Descriptor Parameters

The run descriptor parameter block contains three common parameters, and a record for
each sample. The symbolic name for this class is CAM_CLS_NAARDF.

Common Parameters
CAM_T_RDFSUNITS Sample units (16 characters)

CAM_T_RDFUNKNL Unknown element library (32 characters)

CAM_X_RDFSDATE Sample date

CAM_F_RDFTNFLUX Thermal neutron flux (neutrons/cm2/sec)

CAM_F_RDFENFLUX Epithermal neutron flux (neutrons/cm2/sec)

CAM_F_RDFFNFLUX Fast neutron flux (neutrons/cm2/sec)

CAM_F_RDFIRTIME Irradiation duration

Record Parameters
CAM_T_RDFSTYPE Sample type: Standard or Unknown (1 charac-
ter)

570
 NaI (Alpha-M) Standard File Parameters

CAM_T_RDFCNFNAME Data configuration name (32 characters)

CAM_T_RDFNLIBNAME Element library name (32 characters)

CAM_T_RDFILIBNAME Interference library name (32 characters)

CAM_T_RDFSIDENT Sample identification (16 characters)

CAM_T_RDFSTITLE Sample title (64 characters)

CAM_F_RDFSQUANT Sample quantity

CAM_X_RDFRSDATE Sample date

CAM_X_RDFRIRTIME Irradiation duration

CAM_L_RDFGRPNUM Unknown sample group number

CAM_T_RDFUSRSTR1 User spare string number 1 (8 characters)

NaI (Alpha-M) Standard File Parameters

The run descriptor parameter block contains three common parameters, and a record for
each standard. The symbolic name for this class is CAM_CLS_NAISTD.

Common Parameters
CAM_T_SFEBACK Background configuration name (32 characters)

CAM_T_SFEACTUNITS Units of activity in standards file (16 characters)

CAM_F_SFEACTMULT Units to µCi conversion factor

Record Parameters
CAM_T_SFENUCLIDE Standard nuclide name (8 characters)

CAM_T_SFECONFIG Standard configuration name (32 characters)

CAM_X_SFEHLFLIFE Half-Life of standard nuclide

CAM_T_SFEHLFUNITS Half-Life units (8 characters)

CAM_G_SFEACTVTY Activity of standard (SFEACTUNITS)

CAM_X_SFEDATE Activity reference date

571
CAM Files

Scanning WBC Setup Parameters

The scanning whole body counting setup parameter block contains all of the parameters
necessary to setup the motor/controller used for a scanning WBC application. All param-
eters in this block are common parameters. The symbolic name for this class is
CAM_CLS_SCANWBC.

Common Parameters
CAM_T_SWBCSERPORT Serial port connected to controller (16 Charac-
ters)

CAM_T_SWBCCTLR Controller type: Modulynx or Slo-Syn (16 Char-

acters)

CAM_T_SWBCTYPE Type of whole body counter: Standup or Bed

(16 characters)

CAM_F_SWBCLENGTH Total scan length (in.)

CAM_F_SWBCPULINCH Pulses/inch

CAM_F_SWBCSTRTSPD Starting speed (in./sec)

CAM_F_SWBCACCEL Acceleration (in./sec/sec)

CAM_F_SWBCHOMESPD Home speed (in./sec)

CAM_F_SWBCMAXSPD Maximum speed (in./sec)

CAM_F_SWBCHOME Home position (in.)

CAM_F_SWBCINMCS Inches/MCS channel

CAM_F_SWBCMANSPD Manual operation speed: Slo-Syn only (in./sec)

CAM_L_SWBCDIR Direction of scan (+1 / -1)

Security Parameters
The security parameters block contains a record for each user account against which ac-
cess controls are to be applied. The use of this block is very application specific. The
symbolic name for this class is CAM_CLS_SECURITY.

Record Parameters
CAM_T_SECENTNAME Name or Initials to be entered (16 characters)

CAM_T_SECFULLNAME Name or Initials to be transferred (24 characters)

572
 Analysis Control Parameters

CAM_T_SECPASSWORD Password (16 characters)

CAM_L_SECMASK Security bit mask

CAM_L_SECBITn Security mask bit n, where n is 0 to 26

CAM_L_SECLEVEL Security level (Genie 2000/Genie-PC only)

CAM_M_SEC_BITn Security bit n, where n is 0 to 26

Analysis Control Parameters

The analysis control parameter block contains parameters which can be used in command
procedures (such as PROcount or ABACOS-PLUS) to control the analysis flow for an
application. The parameters include the “type” of analysis to be performed, the nuclide li-
brary to be used for nuclide analysis, the destination of hard-copy reports, etc.

This block may also define a sequence of analyses and reports to be executed. The se-
quence, one analysis or report per record (see below), is executed by the NDANALYZE
and Genie-ESP Analyze applications. The symbolic name for this class is
CAM_CLS_ANALCNTL.

Common Parameters
CAM_T_WBCOUNTER Name of whole body counter (24 characters)

CAM_T_EXPICRP ICRP2 or ICRP30 analysis? (2/30) (4 charac-

ters)

CAM_T_EXPHCOUT Destination of hard-copy reports: Printer or

Disk? (P/D) (10 characters)

CAM_T_EXPTITLE Experiment title (40 characters)

CAM_T_EXPCONTROL Control certificate filename (96 characters)

CAM_X_EXPPLIVE Preset live time

CAM_X_EXPPREAL Preset real time

CAM_X_EXPMAXPLIVE Maximum preset live time

CAM_L_EXPPTOTAL Preset total counts

CAM_L_EXPPTSCHAN Preset total counts start channel

573
CAM Files

CAM_L_EXPPTECHAN Preset total counts end channel

CAM_F_EXPPAREA Preset net area

CAM_F_EXPPERR Preset percent error

CAM_F_EXPPNETENG Preset area energy

CAM_L_EXPPSWEEPS Preset sweeps

CAM_L_EXPPLEVEL Preset level

CAM_L_EXPPMODE Preset mode flags

CAM_L_EXPPMLIVE Preset live time mode

CAM_L_EXPPMREAL Preset real time mode

CAM_L_EXPPMSWEEPS Preset sweeps mode

CAM_L_EXPPMAREA Preset area mode

CAM_L_EXPPMLEVEL Preset level mode

CAM_L_EXPPMPERR Preset error mode

CAM_T_EXPDDFNAME Name of detector definition file (32 characters)

CAM_T_EXPDSTUNITS Distance units: inches or cm (4 characters)

CAM_F_EXPDSTMULT Inches to UNITS conversion factor

CAM_L_EXPNUMDISP Number of spectral displays

CAM_L_EXPPSTYPE NDA 2000: Indicates the type of peak search to

be executed (0=none, 1=2nd difference, 2=sim-
ple library, 3=Gamma-M, 4=user-defined)

CAM_L_EXPNIDTYPE NDA 2000: Indicates the type of NID to be exe-

cuted (0=none, 1=NID with interference, 2=NID
without interference)

CAM_L_EXPISOTYPE NDA 2000: Indicates the type of isotopic analy-

sis to be executed (0=none, 1=MGA and
MGA/U)

CAM_L_EXPATTCORTYP NDA 2000: Attenuation correction algorithm

type (0=none, 1=transmission, 2=differential
peak)

574
 Analysis Control Parameters

CAM_L_EXPNUTYPE NDA 2000: Non-uniformity algorithm type

(0=none, 1=NUDS, 2=NUCS)

CAM_L_EXPPNIDTYPE NDA 2000: type of post-NID processing to be

performed (0=none, 1=Pu Self-Absorption)

CAM_L_EXPFLAGS Analysis control flags

CAM_M_EXPF_REPMDA Report MDAs? (Y/N)

[CAM_L_EXPREPMDA]

CAM_M_EXPF_AUTOSAV Store spectra on disk? (Y/N)

[CAM_L_EXPAUTOSAV]

CAM_M_EXPF_AUTOREP Generate hard-copy report? (Y/N)

[CAM_L_EXPAUTOREP]

CAM_M_EXPF_BACKSUB Subtract ambient background? (Y/N)

[CAM_L_EXPBACKSUB]

CAM_M_EXPF_ROIS Set regions-of-interest? (Y/N)

[CAM_L_EXPROIS]

CAM_M_EXPF_REPPK Include post-NID peak search report? (Y/N)

[CAM_L_EXPREPPK]

CAM_M_EXPF_REPPLT Include spectral plot on report? (Y/N)

[CAM_L_EXPREPPLT]

CAM_M_EXPF_REPWBP Include whole body peak search report?

[CAM_L_EXPREPWBP] (Y/N)

CAM_M_EXPF_REPDOSE Generate dose report? (Y/N)

[CAM_L_EXPREPDOSE]

CAM_M_EXPF_AFDOSE Perform dose calculation? (Y/N)

[CAM_L_EXPAFDOSE]

CAM_M_EXPF_DOWTM Perform weighted mean calculation? (Y/N)

[CAM_L_EXPDOWTM]

CAM_M_EXPF_REP10CFR Report 10CFR20 values?

[CAM_L_EXPREP10CFR]

CAM_M_EXPF_ENHDPGRID Enhanced Data Plot grid on/off

[CAM_L_EXPENHDPGRID]

CAM_M_EXPF_ENHDPXSCL Enhanced Data Plot X scale: energy vs.

[CAM_L_EXPENHDPXSCL] channels

575
CAM Files

CAM_M_EXPF_ENHDPSAVE Enhanced Data Plot save to file enable

[CAM_L_EXPENHDPSAVE]

CAM_T_PEAKASF Analysis sequence file to use for efficiency

calibration (96 characters)

CAM_T_TNIDLIB Tentative NID library (96 characters)

CAM_L_EXPPFLAGS Parameter prompting flags field

CAM_M_EXPPF_Bn Prompting flags bit n, where n is 0 to 31

[CAM_L_EXPPFBn]

CAM_L_EXPPFLAGS1 Parameter prompting flags field 1

CAM_L_EXPPF1SPn Prompting flags bit n, where n is 0 to 4

CAM_L_EXPRFLAGS Report generation flags field

CAM_M_EXPRF_PEAK Generate peak search report? (Y/N)

[CAM_L_EXPRFPEAK]

CAM_M_EXPRF_EFF Generate efficiency report? (Y/N)

[CAM_L_EXPRFEFF]

CAM_M_EXPRF_ACT Generate activity report? (Y/N)

[CAM_L_EXPRFACT]

CAM_M_EXPRF_SUM Generate summary report? (Y/N)

[CAM_L_EXPRFSUM]

CAM_M_EXPRF_PROP Generate propagate report? (Y/N)

[CAM_L_EXPRFPROP]

CAM_M_EXPRF_UNK Generate unidentified lines report? (Y/N)

[CAM_L_EXPRFUNK]

CAM_M_EXPRF_REJ Generate rejected nuclides report? (Y/N)

[CAM_L_EXPRFREJ]

CAM_M_EXPRF_INT Generate interference report? (Y/N)

[CAM_L_EXPRFINT]

CAM_M_EXPRF_MDA Generate detection limit report? (Y/N)

[CAM_L_EXPRFMDA]

576
 Analysis Control Parameters

CAM_M_EXPRF_MPC Generate MPC report? (Y/N)

[CAM_L_EXPRFMPC]

CAM_M_EXPRF_POST Generate post-NID peak search report?

[CAM_L_EXPRFPOST] (Y/N)

CAM_M_EXPRF_BRF Generate brief report? (Y/N)

[CAM_L_EXPRFBRF]

CAM_M_EXPRF_FMPC Generate fractional MPC report? (Y/N)

[CAM_L_EXPRFFMPC]

CAM_M_EXPRF_EQV Generate nuclide equivalence report? (Y/N)

[CAM_L_EXPRFEQV]

CAM_M_EXPRF_TRL Generate report trailer? (Y/N)

[CAM_L_EXPRFTRL]

CAM_M_EXPRF_SPn Spare report flag n, where n is 1 to 15

[CAM_L_EXPRFSPn]

CAM_T_EXPPLTDEV Name of hard-copy plotting device (16 charac-

ters)

CAM_T_EXPCERT Name of certificate file (96 characters)

CAM_T_SAMPFPL FPL to be used for sample input screen (96 char-

acters)

CAM_T_GUISAMPFPL GUI FPL to be used for sample input screen (96

characters)

CAM_T_PEAKLIB Name of peak search library (96 characters)

CAM_T_EXPBACK Name of ambient background configuration (96

characters)

CAM_T_NEUTBACKFILE Name of the neutron background configuration

(96 characters)

CAM_T_EXPLIB Name of NID nuclide library (96 characters)

CAM_T_EXPINT Name of interference library (96 characters)

CAM_T_SAMPLOG Name of sample log file (96 characters)

CAM_T_QAFILE Name of quality assurance file (96 characters)

CAM_T_ALPHMSTDS Name of Alpha-M standards file (96 characters)

577
CAM Files

CAM_T_SADFILE Name of sample analysis database file (96 char-

acters)

CAM_T_ROIFILE Name of ROI file used by some ROI-driven

peak location algorithms (82 characters)

CAM_T_REAGENTFILE Name of reagent background spectrum file (96

characters)

CAM_T_KEDREFSPEC K-edge reference (i.e., sample blank) spectrum

file name (96 characters)

CAM_T_TRANSFILE Name of the transmission spectral data file (96

characters)

CAM_T_MACFILE Name of the mass attenuation curve file (96

characters)

CAM_T_MGAHIGHFILE Name of high energy spectrum for MGA (if this

name is blank, and CAM_L_PRMGANSPEC is
2, then the file with the same name as the input
file but with a CN2 extension will be used) (96
characters)

CAM_T_MGAUCALFILE MGAU enrichment calibration file

CAM_T_EXPHDR1 Name of header file 1 (96 characters)

CAM_T_EXPHDR2 Name of header file 2 (96 characters)

CAM_T_REPTEMPLATE Report template file (96 characters)

CAM_T_RPTSECTNAME Report or report section name (16 characters)

CAM_T_SAVEFDS Saved datasource file name (128 characters)

CAM_T_EXPSTRIP Library correlation: background compensation

file name (128 characters)

CAM_T_PSHUFFILE Shuffler passive rates file (96 characters)

CAM_T_NSHUFFILE Shuffler active rates file (96 characters)

CAM_L_RPTFLAGS Report flags field

CAM_M_RPTF_SCREEN Send report to screen

[CAM_L_RPTFSCREEN]

CAM_M_RPTF_DISK Send report to disk

[CAM_L_RPTFDISK]

578
 Analysis Control Parameters

CAM_M_RPTF_PRINTER Queue disk file to printer after report com-

[CAM_L_RPTFPRINTER] plete

CAM_M_RPTF_PAGE1 Start this report on page 1

[CAM_L_RPTFPAGE1]

CAM_M_RPTF_NEWPAGE Start this report on new page

[CAM_L_RPTFNEWPAGE]

CAM_M_RPTF_NEWFILE Create new file for report (i.e., do not ap-

[CAM_L_RPTFNEWFILE] pend)

CAM_M_RPTF_ANAL0 General purpose engine flag

[CAM_L_RPTFANLA0]

CAM_L_PAGENUM Running page number

CAM_L_LINENUM Running line number

CAM_L_EXPAFLAGS Analysis flags field

CAM_M_EXPAF_EFF Perform efficiency calculation? (Y/N)

[CAM_L_EXPAFEFF]

CAM_M_EXPAF_BS Perform ambient background subtraction?

[CAM_L_EXPAFBS] (Y/N)

CAM_M_EXPAF_PP Perform pulse pileup correction? (Y/N)

[CAM_L_EXPAFPP]

CAM_M_EXPAF_NID Perform nuclide identification? (Y/N)

[CAM_L_EXPAFNID]

CAM_M_EXPAF_INT Perform interference correction? (Y/N)

[CAM_L_EXPAFINT]

CAM_M_EXPAF_WTM Perform weighted mean computation? (Y/N)

[CAM_L_EXPAFWTM]

CAM_M_EXPAF_DTL Perform detection limit computation? (Y/N)

[CAM_L_EXPAFDTL]

CAM_M_EXPAF_DOSE Include dose on WBC reports? (Y/N)

[CAM_L_EXPAFDOSE]

CAM_T_ACBATCHQ Name of processing BATCH queue

CAM_T_ACARCHNAME Name of archived configuration

579
CAM Files

CAM_T_ACARGSn Arguments parameter n, where n is 1 to 4

CAM_L_CACLARGn Integer argument parameter n, where n is 1 to 2

CAM_G_CACGARG1 Arguments DP float parameter 1

CAM_L_NUMALTINPS Number of alternate inputs

CAM_T_ALTINPUTn Alternate input n (96 characters), where n is 1 to

49

CAM_T_MEASISOFILE Name of measured isotopics file (96 characters)

CAM_T_QUANTGFILE Name of file that contains nuclide identification

results. If blank, the current datasource must
contain them.

CAM_T_PASSIVENFILE Passive neutron coincidence data and results file

(96 characters)

CAM_T_DDAFILE Active DDA data and analysis results file (96

characters)

CAM_T_PDDAFILE Passive data and analysis results file (96 charac-

ters)

CAM_T_NSHLDMCSFILE DDA shielded detector MCS spectrum

CAM_T_NBAREMCSFILE DDA bare detector MCS spectrum

CAM_T_NFLUXMONFILE DDA flux monitor MCS spectrum

CAM_T_NBARRMONFILE DDA barrel monitor MCS spectrum

CAM_T_TGSEROIFILE TGS emission ROI definition file name

CAM_T_TGSTROIFILE TGS transmission ROI definition file name

CAM_T_TGSTMAXFILE TGS transmission calibration measurement file

name

CAM_T_TGSSTNDFILE File that contains results of standard TGS analy-

sis

CAM_T_TGSBULKFILE File that contains results of TGS bulk analysis

CAM_T_TGSLAYERFILE File that contains results of TGS layered analy-

sis

CAM_T_CONTATTFILE Container attenuation calibration file name (96

characters)

CAM_T_NEUTACTBKGFL Active well background file (AmLi source only)

580
 Analysis Control Parameters

CAM_T_ACTIVENFILE Active well assay file (AmLi source plus item)

CAM_T_AGATRUESRC Source of true values for AGA (16 characters)

CAM_L_AGACONVERGE Enable AGA double-pass mode

CAM_L_AGAITERLIMIT AGA iteration limit

CAM_L_AGAADJZERO Enable AGA zero adjust

CAM_F_AGAMAXGAIN AGA maximum gain deviation

CAM_L_AGADOINITQA Do AGA initial Q/A transfer

CAM_L_AGADOFINQA Do AGA final Q/A transfer

CAM_X_AGASTARTTIME AGA start time

CAM_L_AGAITERDONE Number of AGA iterations

CAM_T_AGASTATUS AGA status (64 characters)

CAM_F_AGAAMPGAIN AGA amp gain

CAM_F_AGAADCZERO AGA ADC zero

CAM_F_AGATOLFACTOR AGA tolerance factor

CAM_F_AGAECOFFSET AGA energy cal offset

CAM_F_AGAECSLOPE AGA energy cal slope

CAM_F_AGAECQUAD AGA energy cal quadratic

CAM_F_AGAECALFAC1 AGA energy cal cubic

CAM_F_AGAECALFAC2 AGA energy cal 4th order coeff

CAM_F_AGAECALFAC3 AGA energy cal 5th order coeff

CAM_L_AGAUSEASF Use ASF in AGA gain evaluation

CAM_L_AGADONE AGA done

CAM_F_AGARELCRIT AGA reliability criterion

CAM_L_AGAACCEPTED AGA results accepted

CAM_T_NLSTSIGNFILE File containing signal-triggered list mode data

(96 characters)

CAM_F_NLSTRANDFILE File containing random-triggered list mode data

(96 characters)

581
CAM Files

CAM_L_EXPENHDPTYPE Enhanced Data Plot type

CAM_L_EXPENHDPNORD Display nuclide ID on spectrum: ascending/de-

scending

CAM_L_EXPENHDPNSRC Nuclide ID source: library or analysis

Record Parameters
CAM_T_ACENGNAME Name of analysis module (16 characters)

CAM_T_ACTARGn Analysis module string argument n (32 charac-

ters), where n is 1 to 3

CAM_T_ACTEMPLATE Report template file name (96 characters)

CAM_G_ACGARGn Analysis module DP floating argument n, where

n is 1 to 3

CAM_L_ACLARGn Analysis module integer argument n, where n is

1 to 3

CAM_L_ACFLAGS Analysis module flags field

CAM_M_RPTF_SCREEN Send report to screen

[CAM_L_ACFSCREEN]

CAM_M_RPTF_DISK Send report to disk

[CAM_L_ACFDISK]

CAM_M_RPTF_PRINTER Queue disk file to printer after report com-

[AM_L_ACFPRINTER] plete

CAM_M_RPTF_PAGE1 Start this report on page 1

[CAM_L_ACFPAGE1]

CAM_M_RPTF_NEWPAGE Start this report on new page

[CAM_L_ACFNEWPAGE]

CAM_M_RPTF_NEWFILE Create new file for report (i.e., do not ap-

[CAM_L_ACFNEWFILE] pend)

CAM_M_RPTF_ANAL0 General purpose engine flag

[CAM_L_ACFANAL0]

582
 QA Parameter Definition Parameters

QA Parameter Definition Parameters

The quality assurance parameter definition parameters is composed of a set of parameters
which describe a data item to be transferred from a spectral data configuration to a qual-
ity assurance configuration. Each record in this parameter block describes one such data
item. The symbolic name for this class is CAM_CLS_QAPDR.

Record Parameters
CAM_X_PENTRY Parameter definition entry time

CAM_X_PEDIT Parameter definition last time edited

CAM_T_PNAME Parameter name (16 characters)

CAM_T_PERRNAME Parameter name for uncertainty (16 characters)

[used if STDERROR flag is set]

CAM_T_PERRTYPE Error type (ABSOLUTE, RELATIVE or

PERCENT) (8 characters)

CAM_T_PDESC Parameter description (32 characters)

CAM_L_PPARIND Tabular entry index for parameter value

CAM_T_PUNITS Reporting units (16 characters)

CAM_F_PCNVFCTR Reporting units conversion factor

CAM_T_PPTYPE Parameter type (GENERIC, PEAK, NUCLIDE,

LINE, BCKGND or MANUAL) (8 characters)

CAM_T_PPTYPEDESC Parameter type description (16 characters)

CAM_T_PNUCLIDE Nuclide name (16 characters) [used if parameter

type is NUCLIDE or LINE]

CAM_F_PENERGY Line energy [used if parameter type is PEAK or

LINE]

CAM_L_PSCHAN Gross counts start channel [used if parameter

type is BCKGND]

CAM_L_PECHAN Gross counts end channel [used if parameter

type is BCKGND]

CAM_F_PINVEST Investigation sigma level [used if SAMPLE or

USER flags are set]

CAM_F_PACTION Action sigma level [used if SAMPLE or USER

flags are set]

583
CAM Files

CAM_X_PSTARTDATE Statistics start date [used if SAMPLE flag is set]

CAM_X_PENDDATE Statistics end date [used if SAMPLE flag is set]

CAM_F_PSDMEAN Sample-driven mean [used if SAMPLE flag is

set] (this value is recomputed each time a report
is generated)

CAM_F_PSDSTDEV Sample-driven standard deviation [used if

SAMPLE flag is set] (this value is recomputed
each time a report is generated)

CAM_F_PBIASTRUE “True” parameter value [used if BIAS flag is

set]

CAM_X_PBIASSTDATE Bias test start date

CAM_X_PBIASENDATE Bias test end date

CAM_F_PUDMEAN User-driven mean [used if USER flag is set]

CAM_F_PUDSTDEV User-driven standard deviation [used if USER

flag is set]

CAM_F_PLOLIM Lower limit for parameter value [used if

BOUNDARY flag is set]

CAM_F_PUPLIM Upper limit for parameter value [used if

BOUNDARY flag is set]

CAM_L_PSTARTREC Start report results record number

CAM_L_PENDREC End report results record number

CAM_L_PNMEANSMPLS or Trend test: test for last N samples above or

below mean

CAM_L_PMSLOPESMPLS For Trend test: test for last M samples with in-
creasing or decreasing slope

CAM_L_PDFLAGS Parameter definition flags field

CAM_M_PDF_STDERROR Parameter has associated uncertainty

[CAM_L_PDFSTDERROR]

CAM_M_PDF_BOUNDARY Perform (by default) upper/lower bounds

[CAM_L_PDFBOUNDARY] test

CAM_M_PDF_SAMPLE Perform (by default) sample-driven

[CAM_L_PDFSAMPLE] N-Sigma test

584
 QA Results Parameters

CAM_M_PDF_USER Perform (by default) user-driven N-Sigma

[CAM_L_PDFUSER] test

CAM_M_PDF_BIAS Perform (by default) bias test

[CAM_L_PDFBIAS]

CAM_M_PDF_BSINV Multi-measurement bias investigation flag

[CAM_L_PDFBSINV] (computed at time of report)

CAM_M_PDF_BSACT Multi-measurement bias action flag (com-

[CAM_L_PDFBSACT] puted at time of report)

CAM_M_PDF_DOBOUND Do bounds test

[CAM_L_PDFDOBOUND]

CAM_M_PDF_DOSAMPLE Do sample-driven test

[CAM_L_PDFDOSAMPLE]

CAM_M_PDF_DOUSER Do user-defined test

[CAM_L_PDFDOUSER]

CAM_M_PDF_DOBIAS Do bias test

[CAM_L_PDFDOBIAS]

CAM_M_PDF_TREND Perform trend test

[CAM_L_PDFTREND]

CAM_M_PDF_DOTREND Do Trend Test in the Full Report

[CAM_L_PDFOTREND]

QA Results Parameters
The quality assurance results parameters is composed of a set of parameters which de-
scribe a particular quality assurance measurement. Each record in this parameter block
describes one such measurement. Listed in [ ] after each parameter is the spectral config-
uration parameter which is copied to it during the transfer process. The symbolic name
for this class is CAM_CLS_QARREC.

Record Parameters
CAM_X_RMEASR Measurement time for results record
[CAM_X_ASTIME] (Note: Results records will
be sorted by this measurement time field).

CAM_X_RENTRY Results record entry time

CAM_X_REDIT Results record last edited time

585
CAM Files

CAM_T_RSAMPID Sample identification (16 characters)

[CAM_T_SIDENT]

CAM_X_RDEPTIME Sample deposition time

[CAM_X_SDEPOSIT]

CAM_T_RBUILDUPTYPE Build-up type (8 characters)

[CAM_T_BUILDUPTYPE]

CAM_X_RSDATE Sample date

[CAM_X_STIME]

CAM_X_RELTIME Elapsed live time

[CAM_X_ELIVE]

CAM_X_RERTIME Elapsed real time

[CAM_X_EREAL]

CAM_F_RSQUANT Sample quantity

[CAM_F_SQUANT]

CAM_T_RSUNITS Sample quantity units (16 characters)

[CAM_T_SUNITS]

CAM_T_RANALYST Name of sample analyst (24 characters)

[CAM_T_SANALNAME]

CAM_L_RRFLAGS Results record flags field

CAM_M_RRF_REJECT Entire record has been rejected

CAM_M_RRF_TBIAS Bias trend alarm flag

[CAM_L_PDFTBIAS]

CAM_M_RRF_TSLOPE Slope trend alarm flag

[CAM_L_PDFTSLOPE]

CAM_M_RRF_TBIAS Last N samples exhibit a positive or nega-

[CAM_L_RRFTBIAS] tive bias trend

CAM_M_RRF_TSLOPE Last M samples exhibit monotonically in-

[CAM_L_RRFTSLOPE] creasing or decreasing trend

Tabular Entry Parameters

CAM_F_RVALUE Parameter value (Note: all integers and double
precision values are converted to single preci-
sion floats at transfer time)

586
 MGA Results Parameters

CAM_F_RDVALUE Parameter uncertainty (Note: all integers and

double precision values are converted to single
precision floats at transfer time)

CAM_L_RVFLAGS Parameter value flags [2 bytes only]

CAM_M_RVF_STORED Parameter has been stored

[CAM_L_RVFSTORED]

CAM_M_RVF_EDITED Parameter has been edited

[CAM_L_RVFEDITED]

CAM_M_RVF_REJECT Parameter has been rejected

[CAM_L_RVFREJECT]

CAM_M_RVF_RECREJ Parameter has been rejected as part of a re-

[CAM_L_RVFRECREJ] cord rejection

CAM_M_RVF_SDINV Sample-driven investigation flag (computed

[CAM_L_RVFSDINV] at time of report)

CAM_M_RVF_SDACT Sample-driven action flag (computed at time

[CAM_L_RVFSDACT] of report)

CAM_M_RVF_UDINV User-driven investigation flag (computed at

[CAM_L_RVFUDINV] time of report)

CAM_M_RVF_UDACT User-driven action flag (computed at time of

[CAM_L_RVFUDACT] report)

CAM_M_RVF_LUABV Bounds above flag (computed at time of re-

[CAM_L_RVFLUABV] port)

CAM_M_RVF_LUBLW Bounds below flag (computed at time of re-

[CAM_L_RVFLUBLW] port)

CAM_M_RVF_BSINV Bias investigation flag (computed at time of

[CAM_L_RVFBSINV] report)

CAM_M_RVF_BSACT Bias action flag (computed at time of report)

[CAM_L_RVFBSACT]

MGA Results Parameters

The MGA results parameter block is composed of a series of common and record param-
eters which summarize the results of a Multi-Group Analysis (MGA). The symbolic
name for this class is CAM_CLS_MGARESULTS.

587
CAM Files

Common Parameters
CAM_L_MGAFLAGS MGA results flags field. These flags are avail-
able as individual parameters

CAM_L_MGADONE MGA results have been generated

CAM_L_MGAERRnn MGA error nn occurred, where nn is 01 to

31

CAM_L_MGAFLAGS2 Additional MGA results flags

CAM_L_MGAERRnn MGA error nn occurred, where nn is 32 to

42

CAM_M_MGAF2_DECAYDONE Isotopics combination has decay-corrected

measured isotopics

CAM_T_MGAVERSION MGA version information (16 characters)

CAM_L_MGATYPE Indicates the type of MGA analysis: 0 for stan-

dard MGA, 1 for MGAU

CAM_F_PUTHICK Plutonium thickness (g/cm2)

CAM_F_CDTHICK Cadmium thickness (g/cm2)

CAM_F_QFIT Fit chi-square

CAM_F_NQFIT Normalized fit chi-square

CAM_F_UTOPU U/Pu ratio (from fluorescence x-rays)

CAM_F_DUTOPU Uncertainty in U/Pu ratio

241
CAM_F_AMTOPU241 Am/241Pu weight ratio

CAM_F_DAMTOPU241 Uncertainty in 241Am/241Pu weight ratio

CAM_X_AMSEPTIME Time since Am separation

CAM_X_DAMSEPTIME Uncertainty in time since Am separation

CAM_X_USEPTIME Time since U separation

240
CAM_F_PU240EFF Pu effective

CAM_F_DPU240EFF Uncertainty in 240Pu effective

CAM_F_FWHM122 FWHM for 122 keV peak (eV)

588
 MGA Results Parameters

CAM_F_FWHM208 FWHM for 209 keV peak (eV)

243
CAM_L_MFAM243NP239 Am/239Np present?
241
CAM_F_PU241TOPU239 Pu/239Pu ratio

CAM_F_PUXRFINT Plutonium X-ray fluorescence intensity

CAM_F_PUDXRFINT Uncertainty in plutonium X-ray fluorescence in-

tensity

CAM_F_MGATOTSPOW Total specific power (mW/g)

CAM_F_DTOTSPOW Uncertainty in total specific power

CAM_F_MGAPUSCONC Pu solution concentration

CAM_F_MGAPUCERR Error in Pu solution concentration

CAM_F_MGAPUSCFAC Pu solution concentration correction factor

95
CAM_F_MGAZR95CONC Zr concentration

CAM_F_MGAZR95CERR Error in 95Zr concentration

95
CAM_F_MGANB95CONC Nb concentration

CAM_F_MGANB95CERR Error in 95Nb concentration

103
CAM_F_MGARU103CONC Ru concentration

CAM_F_MGARU103CERR Error in 103Ru concentration

106
CAM_F_MGARU106CONC Ru concentration

CAM_F_MGARU106CERR Error in 106Ru concentration

137
CAM_F_MGACS137CONC Cs concentration

CAM_F_MGACS137CERR Error in 137Cs concentration

144
CAM_F_MGACE144CONC Ce concentration

CAM_F_MGACE144CERR Error in 144Ce concentration

CAM_F_MGATOTCOUNTS Total number of counts in low energy spectrum

CAM_T_MGALEFILE Low energy spectrum file name (name only; 32

characters)

CAM_T_MGAHEFILE High energy spectrum file name (name only; 32

characters)

CAM_X_MGAHELIVE High energy spectrum live time

589
CAM Files

CAM_X_MGAHEREAL High energy spectrum real time

235
CAM_L_MGAU235REC U results record number
237
CAM_L_MGANP237REC Np results record number
238
CAM_L_MGAU238REC U results record number
243
CAM_L_MGAAM243REC Am results record number
241
CAM_F_MGAAM100ABN Am abundance relative to 239Pu based on 100
keV region analysis (hetrogenous 241Am only;
otherwise, will be 0)

CAM_F_MGAAM100ABNE % error in 241Am abundance relative to 239Pu

based on 100 keV region analysis
241
CAM_F_MGAAM300ABN Am abundance relative to 239Pu based on 300
keV region analysis (hetrogenous 241Am only;
otherwise, will be 0)

CAM_F_MGAAM300ABNE % error in Am-241 abundance relative to 239Pu

based on 300 keV region analysis
241
CAM_F_MGAAM600ABN Am abundance relative to 239Pu based on 600
keV region analysis (hetrogenous 241Am only;
otherwise, will be 0)

CAM_F_MGAAM600ABNE % error in Am-241 abundance relative to 239Pu

based on 600 keV region analysis

CAM_F_MGA100600DIF Percent difference between the 241Am abundance

relative to 239Pu based on the 100 keV region
analysis and the 600 keV region analysis
(hetrogenous Am-241 only; if homogenous, is
set to 0)

CAM_F_MGAAMSTDD Result of heterogenous 241Am calculation; if ho-

mogenous, is set to 0

CAM_F_MGAAMBETA Result of heterogenous 241Am calculation; if ho-

mogenous, is set to 0

CAM_F_MGAERRx Error amplification value x, where x is A to

CAM_L_MGAVCHECK

Validity tests failed: one flag per test

CAM_L_MGAVCHECK0 Validity test 0 (Q < MAX Q)

CAM_L_MGAVCHECK1 Validity test 1 (122 keV FWHM too large)

CAM_L_MGAVCHECK2 Validity test 2 (dead time too large)

590
 MGA Results Parameters

CAM_L_MGAVCHECK8 Validity test 8 (MGA only; Am separation time

too large)

CAM_L_MGAVCHECK9 Validity test 9 ( only; 240Pu error too large)

CAM_L_MGAVCHECK10 Validity test 10 ( only; 239Pu out of valid range)

CAM_L_MGAVCHECK16 Validity test 16 ( only; 235U out of valid range)

Record Parameters
CAM_T_VARNAME MGA variable (isotope) name (16 characters)

CAM_L_VARNUMBER MGA variable (isotope) number (16 characters)

CAM_F_RELABN Relative abundance

CAM_F_DRELABN Uncertainty in relative abundance

CAM_F_DRELABNR Uncertainty in relative abundance ratio

CAM_F_WGTPCTM Weight % at measurement time

CAM_F_DWGTPCTM Uncertainty in weight % at measurement time

CAM_F_WGTPCTD Weight % at declaration time

CAM_F_DWGTPCTD Uncertainty in weight % at declaration time

CAM_F_MGAPRWEIGHT Weight % at prediction time

(PRNEUTPRDATE); this is calculated by the
neutron decay correction engine, not MGA itself

CAM_F_MGAPRWTERR Error in predicted weight %

CAM_F_SPECPWR Specific power

CAM_F_MGA241RELABN Abundance relative to Pu-241

CAM_F_MGA241RAE Error (%) abundance relative to Pu-241

CAM_G_VCVMn Var/ matrix column n, where n is 1 to 16

CAM_L_MGAISOFLAGS Isotope Flags

CAM_L_MGAISODECL True if this isotope came from declared

isotopics

591
CAM Files

Neutron Acquisition and Results

The Neutron Acquisition and Results block contains two types of data

1. Neutron acquisition data, which is stored as a series of records, each of which is

the total, real, and accidental counts data from a single neutron shift register
measurement. These measurements will be filtered and converted to mean rates
by filter analysis engines.

All analyses take the measurement date from the first measurement record
(whether rejected or not).

2. Neutron analysis results data, which consists of the averaged and filtered
neutron acquisition data, and the calculated Plutonium mass. Various
intermediate analysis results values are also stored.

All mass values are as of the measurement date (see note 1, above).

The symbolic name for this class is CAM_CLS_NEUTACQ.

General Information
CAM_L_NACQFLAGS Neutron analysis flags (these indicate what anal-
yses have been performed)

CAM_M_NACQF_ACTIVEU Active uranium well assay

[CAM_L_NACQACTIVEU]

CAM_M_NACQF_CHKSUM Consistency check engine

CAM_M_NACQF_SDTCALC Singles, doubles, and triples engine

CAM_M_NACQF_NMULTI Multiplicity data has been acquired

CAM_M_NACQF_TFILTERED Neutron data has been filtered by a Totals

filter

CAM_M_NACQF_RFILTERED Neutron data has been filtered by a Reals fil-

ter

CAM_M_NACQF_T2G Neutron data has been filtered by a T2G fil-

ter

CAM_M_NACQF_NEUTRONICS Neutronics analysis (i.e., Pu mass) has been

performed

CAM_M_NACQF_CFCMDET Set if the californium/curium detection

[CAM_L_NACQFCFCMDET] engine executed successfully

592
 Neutron Acquisition and Results

252
CAM_M_NACQF_CFDET Set if Cf was detected
[CAM_L_NACQFCFDET]
244
CAM_M_NACQF_CMDET Set if Cm was detected
[CAM_L_NACQFCMDET]

CAM_M_NACQF_AASCFTH Add-a-Source correction factor was above

[CAM_L_NACQFAASCFTH] the calibration range

CAM_M_NACQF_AWADONE Automated waste assay analysis was done

[CAM_L_NACQFAWADONE]

CAM_M_NACQF_AASCFTL Add-a-Source correction factor was below

[CAM_L_NACQFAASCFTL] the calibration range

CAM_M_NACQF_CFAVL Cf has been quantified (via neutron analy-

[CAM_L_NACQFCFAVL] sis)

CAM_M_NACQF_CFMAVL Cm has been quantified (via neutron analy-

[CAM_L_NACQFCMAVL] sis)

CAM_M_NACQF_PUMTH Validity test: NCC Pu mass was above cali-

[CAM_L_NACQFPUMTH] bration range

CAM_M_NACQF_PUMTL Validity test: NCC Pu mass was below cali-

[CAM_L_NACQFPUMTL] bration range

CAM_M_NACQF_ONESDONE Ones Engine has been executed and pro-

[CAM_L_NACQONESDONE] duced a mass

CAM_M_NACQF_CRRDONE Cosmic Ray Rejection Algorithm has been

[CAM_L_NACQFCRRDONE] executed and produced a mass

CAM_M_NACQF_CMCFDONE Cm/Cf engine has been executed and pro-

[CAM_L_NACQCMCFDONE] duced a mass

CAM_M_NACQF_ONESFILT Ones rate filter engine executed

CAM_M_NACQF_TRIPFILT Triples rate filter engine executed

CAM_M_NACQF_MULTINOROOTS No roots found in multiplicity analysis

CAM_M_NACQF_COINNOROOTS No roots found in coincidence analysis

CAM_M_NACQF_MULTI2ROOTS More than one root found in multiplicity

analysis

CAM_M_NACQF_COIN2ROOTS More than one root found in coincidence

analysis

CAM_M_NACQF_LSTMODE Neutron acquisition results were derived

[CAM_L_NACQFLISTMOD] from list mode data

593
CAM Files

CAM_T_NACQFILTER The type and revision(s) of the filter engines that

have been performed (44 characters)

CAM_T_NACQNEUTENG The type and revision of the neutronics analysis

engine (16 characters)

CAM_L_NACQFAWASTAT Automated waste assay analysis status: 0 if suc-

cessful

CAM_T_NACQANALYST The name of the neutronics analyst (16 charac-

ters)

CAM_T_NACQNORMVERS The type and version of the K-factor calculation

engine (16 characters)

CAM_T_NACQAASVERS Add-a-Source correction engine version (16

characters)

CAM_T_NACQISOSRC Isotopics used in analysis (12 characters; will be

either “Declared” or “Measured”)

CAM_L_NACQLSTHTYPE List mode histogram type: 0 = signal triggered, 1

= random triggered

CAM_F_NACQLSTFREQ List mode random trigger frequency

CAM_L_NACQLSTSTAT List mode histogram engine status: 0 is no error

Filter Engine Results

CAM_F_NACQMEANTOT Mean totals rate (counts/second)

CAM_F_NACQMEANTERR Computed 1-sigma error in mean totals rate

CAM_F_NACQMTSTDD Measured standard deviation of mean totals rate

CAM_F_NACQMEANREAL Mean reals rate (counts/second)

CAM_F_NACQMEANRERR Computed 1-sigma error in mean reals rate

CAM_F_NACQCALCWR Reals error weighting factor (W)

CAM_F_NACQMRSTDD Measured standard deviation of mean reals rate

CAM_F_NACQMEANACC Mean accidentals rate (counts/second)

CAM_F_NACQMASTDD Measured standard deviation of mean

accidentals rate

CAM_F_NACQAVGSGL Mean singles rate

594
 Neutron Acquisition and Results

CAM_F_NACQAVGSERR Error in singles rate

CAM_F_NACQAVGDBL Mean doubles rate

CAM_F_NACQAVGDERR Error in doubles rate

CAM_F_NACQAVGTPL Mean triples rate

CAM_F_NACQAVGTERR Error in triples rate

CAM_L_NACQUNREJM Number of unrejected measurements

CAM_F_NACQTMEASTIM Total elapsed time of unrejected measurements

CAM_L_NACQNT2GREJ Number of measurements rejected by T2G filter

CAM_L_NACQNTOTREJ Number of measurements rejected by totals filter

CAM_L_NACQNREALREJ Number of measurements rejected by reals filter

CAM_F_NACQONESTIME Total elapsed time for unrejected ones measure-

ments

CAM_L_NACQONESREJ Number of measurements rejected by Ones filter

CAM_L_NACQNCHKREJ Number of consistency check rejected runs

Measurement Correction Results

CAM_F_NACQMEANDTT Deadtime-corrected mean totals rate (counts/sec-
ond)

CAM_F_NACQMEANDTTE 1-sigma error in deadtime-corrected mean totals

rate

CAM_F_NACQMEANDTR Deadtime-corrected mean reals rate (counts/sec-

ond); see note below

CAM_F_NACQMEANDTRE 1-sigma error in deadtime-corrected mean reals

rate

CAM_F_NACQMEANBCT Normalized/background-corrected mean totals

rate (counts/second); see note below

CAM_F_NACQMEANBCTE 1-sigma error in normalized/back-

ground-corrected mean totals rate

CAM_F_NACQMEANBCR Normalized/background-corrected mean reals

rate (counts/second)

CAM_F_NACQMEANBCRE 1-sigma error in normalized/back-

ground-corrected mean reals rate

595
CAM Files

CAM_F_NACQMCREALS Multiplication-corrected mean reals rate

(counts/second)

CAM_F_NACQMCREALER 1-sigma error in multiplication-corrected mean

reals rate

CAM_F_NACQAVGCSGL Measurement correction singles

CAM_F_NACQAVGCDBL Measurement corrected doubles

CAM_F_NACQAVGCTPL Measurement corrected triples

CAM_F_NACQAVGCSER Error in measurement corrected singles

CAM_F_NACQAVGCDER Error in measurement corrected doubles

CAM_F_NACQAVGCTER Error in measurement corrected triples

CAM_F_NACQAVGCSDC Singles-Doubles covariance

CAM_F_NACQAVGCSTC Singles-Triples covariance

CAM_F_NACQAVGCDTC Doubles-Triples covariance

CAM_F_NACQMCDBLS Multiplication corrected doubles rate

CAM_F_NACQMCDBLSER Error in multiplicity corrected doubles rate

CAM_F_NACQAVGONES Mean Ones Rate

CAM_F_NACQAVGONEER Error in the mean ones rate

CAM_F_NACQAVGTRNS Mean Filtered Truncated Singles Rate

CAM_F_NACQAVGTRNSE Error in the Mean Filtered Truncated Singles

Rate

CAM_F_NACQAVGTRND Mean Filtered Truncated Doubles Rate

CAM_F_NACQAVGTRNDE Error in the Mean Filtered Truncated Doubles

Rate

CAM_F_NACQAVGTRNT Mean Filtered Truncated Triples Rate

CAM_F_NACQAVGTRNTE Error in the Mean Filtered Truncated Triples

Rate

CAM_F_NACQAVGCONE Measurement corrected ones rate

CAM_F_NACQAVGCOER Error in the measurement corrected ones rate

CAM_F_NACQAVGCTRNS Measurement corrected truncated Singles rate

596
 Neutron Acquisition and Results

CAM_F_NACQAVGCTSE Error in the Measurement corrected truncated

Singles rate

CAM_F_NACQAVGCTRND Measurement corrected truncated Doubles rate

CAM_F_NACQAVGCTDE Error in the Measurement corrected truncated

Doubles rate

CAM_F_NACQAVGCTRNT Measurement corrected truncated Triples rate

CAM_F_NACQAVGCTTE Error in the Measurement corrected truncated

Triples rate

CAM_F_NACQAVGCTSDC Measurement Corrected Truncated Singles Dou-

bles CoVariance

CAM_F_NACQAVGCTSTC Measurement Corrected Truncated Singles

Triples CoVariance

CAM_F_NACQAVGCTDTC Measurement Corrected Truncated Doubles

Triples CoVariance

Standard Coincidence Analysis Results

CAM_F_NACQSFACTOR S-factor

CAM_F_NACQSFACERR Error in S factor

CAM_F_NACQALPHA Alpha

CAM_F_NACQMFACTOR M-factor
240
CAM_F_NACQPU240EFF Pu effective mass (grams)

CAM_F_NACQPU240ERR 1-sigma estimated error (i.e., counting statistics

error only) in 240Pu effective mass

CAM_F_NACQPU240NER 1-sigma normal error (i.e., including all sources

of error) in 240Pu effective mass

CAM_F_NACQPUMASS Plutonium mass (grams)

CAM_F_NACQPUMEERR 1-sigma estimated error (i.e., counting statistics

error only) in Pu mass

CAM_F_NACQPUMNERR 1-sigma normal error (i.e., including all sources

of error) in Pu mass

CAM_F_NACQPUMDIFF % difference between measured and declared Pu

mass: 100*(declared-measured)/declared

597
CAM Files

CAM_F_NACQPUMNSDIF 1-sigma difference between measured and de-

clared Pu mass

CAM_F_NACQPREDPUM Predicted Pu mass (grams); this is the calculated

Pu mass decay corrected to the prediction date
(PRNEUTPRDATE)

CAM_F_NACQPREDPUME Error in predicted Pu mass

CAM_F_NACQPUMATDT Pu mass (grams) as of the declared Pu mass date

(NDCLPUMDATE)

CAM_F_NACQPUMEATDT Error in Pu mass as of the declaration date

240
CAM_F_NACQMDA Pu MDA (grams)

CAM_F_NACQMDAERR Error in 240Pu MDA

239
CAM_F_NACQ239FEG Pu fissile gram equivalent (FEG) n
239
CAM_F_NACQ239FEGER Pu FEG error
239
CAM_F_NACQ239EQACT Pu equivalent activity (Ci)
239
CAM_F_NACQ239EQAER Pu equivalent activity error

CAM_F_NACQDHEAT Decay heat

CAM_F_NACQDHEATER Decay heat error

CAM_F_NACQAACTVTY Alpha activity

CAM_F_NACQAACTER Alpha activity error

Multiplicity Analysis Results

CAM_F_NACQMALPHA Alpha value based on multiplicity analysis

CAM_F_NACQMALPHAER Alpha value error

CAM_F_NACQMMFACT Multiplication value based on multiplicity analy-

sis

CAM_F_NACQMMFACTER Multiplication value error

CAM_F_NACQMPU240EF Effective mass based on multiplicity analysis

CAM_F_NACQMPU240NE Measured effective mass error based on multi-

plicity analysis

CAM_F_NACQMPU240ER Estimated effective mass error based on multi-

plicity analysis

598
 Neutron Acquisition and Results

CAM_F_NACQMPUMASS Total Pu mass based on multiplicity analysis

CAM_F_NACQMPUMNERR Error in total Pu mass based on multiplicity

analysis

CAM_F_NACQMPUMEERR Estimated error in total Pu mass based on multi-

plicity analysis

CAM_F_NACQPREDMPU Predicted Pu mass based on multiplicity analysis

CAM_F_NACQPREDMPUE Error in predicted Pu mass based on multiplicity

analysis

CAM_F_NACQMPUDIFF Percent difference in Pu Mass based on multi-

plicity analysis

CAM_F_NACQMPUNSDIF One sigma difference in Pu mass based on mul-

tiplicity analysis
239
CAM_F_NACQM239FEG Pu FEG (from multiplicity)

CAM_F_NACQM239FEGE Error in 239Pu FEG (from multiplicity)

239
CAM_F_NACQM239EQAC Pu equivalent activity (from multiplicity)

CAM_F_NACQM239EQAE Error in 239Pu equivalent activity (from multi-

plicity)

CAM_F_NACQMDHEAT Decay heat (from multiplicity)

CAM_F_NACQMDHEATER Error in Decay heat (from multiplicity)

CAM_F_NACQMAACTVTY Alpha activity (from multiplicity)

CAM_F_NACQMAACTER Error in Alpha activity (from multiplicity)

Waste Analysis Results

240
CAM_F_NACQFPU240EF Pu effective mass

CAM_F_NACQFPU240ER 1-sigma absolute uncertainty in 240Pu effective

mass

CAM_F_NACQFPUMASS Pu mass

CAM_F_NACQFPUMERR 1-sigma absolute uncertainty in Pu mass

240
CAM_F_NACQFMDA Pu effective MDA

CAM_F_NACQFMDAERR 1-sigma absolute error in 240Pu MDA

599
CAM Files

Ones Rate Analysis Results

240
CAM_F_NACQPU240ONE Pu effective mass from Ones rate analysis,
non-multiplication corrected
240
CAM_F_NACQP240ONER Pu effective mass error from Ones rate analy-
sis, non-multiplication corrected
240
CAM_F_NACQTDBL240 Pu effective mass from truncated doubles rate

CAM_F_NACQTDBL240E Error in 240Pu effective mass from truncated dou-

bles rate
240
CAM_F_NACQTDBLMDA Pu effective MDA from truncated doubles rate

CAM_F_NACQTDBLMDAE E in 240Pu effective MDA from truncated dou-

bles rate (note: this parameter is not accessable
via parameter name)

CAM_L_NACQONESSTAT Ones engine status flag; 0=success

CAM_F_NACQONESMDA Ones Rate 240Pu effective mass MDA

CAM_F_NACQONESMDAE Ones Rate 240Pu effective mass MDA uncertainty

Cosmic Ray Rejection Analysis Results

CAM_L_NACQFCRRSTAT Cosmic Ray Rejection engine status; 0 = suc-
cessful

CAM_F_NACQNTHZMASS Matrix mass

CAM_F_NACQNTHZMER Matrix mass uncertainty Non-Truncated – 1

sigma
240
CAM_F_NACQCRNT240 Pu Effective mass from Cosmic Rejection
Analysis – Non-Truncated

CAM_F_NACQCRNT240E 1-sigma absolute uncertainty in 240Pu Effective

mass from Cosmic Rejection Analysis –
Non-Truncated

CAM_F_NACQNTCRMDA Non-Truncated Cosmic Ray Rejection 240Pu Ef-

fective mass MDA

CAM_F_NACQNTCRMDAE Non-Truncated Cosmic Ray Rejection 240Pu Ef-

fective mass MDA uncertainty

CAM_F_NACQTHZMASS Matrix mass Truncated

CAM_F_NACQTHZMER Matrix mass uncertainty Truncated – 1 sigma

600
 Neutron Acquisition and Results

240
CAM_F_NACQCRT240 Pu Effective mass from Cosmic Rejection
Analysis – Truncated

CAM_F_NACQCRT240E 1-sigma absolute uncertainty in 240Pu Effective

mass from Cosmic Rejection Analysis – Trun-
cated

CAM_F_NACQTCRMDA Truncated Cosmic Ray Rejection 240Pu Effective

mass MDA

CAM_F_NACQTCRMDAE Truncated Cosmic Ray Rejection 240Pu Effective

mass MDA uncertainty

Cm/Cf Analysis Results

CAM_L_NACQCMCFSTAT Cm/Cf Engine status; 0 = successful
240
CAM_F_NACQCMCF240 Pu effective mass from Cm/Cf analysis

CAM_F_NACQCMCF240E Error in 240Pu effective mass from Cm/Cf analysis

CAM_F_NACQCMMASS Cm mass

CAM_F_NACQCMMASSER Error in Cm mass

CAM_F_NACQCFMASS Cf mass

CAM_F_NACQCFMASSER Error in Cf mass

240
CAM_F_NACQCMCFMDA Pu effective MDA from Cm/Cf analysis
240
CAM_F_NACQCMCFMDAE Pu effective MDA uncertainty from Cm/Cf
analysis

Coincidence Collar Analysis Results

CAM_F_NACQCLRCF1 Source decay correction factor

CAM_F_NACQCLRCF1ER Uncertainty in source decay correction factor

CAM_F_NACQCLRCF2 Poison rod correction factor

CAM_F_NACQCLRCF2ER Uncertainty in poison rod correction factor

CAM_F_NACQCLRCF3 Heavy metal correction factor

CAM_F_NACQCLFCF3ER Uncertainty in heavy metal correction factor

CAM_F_NACQCLRMASS Neutron collar mass

CAM_F_NACQCLRMASSE Uncertainty in neutron collar mass

601
CAM Files

Active Multiplicity Analysis Results

CAM_F_NACQACPLNG Coupling

CAM_F_NACQACPLNGER Uncertainty in coupling

CAM_F_NACQAFMASS Active fissile mass (g)

CAM_F_NACQAFMASSER Uncertainty in active fissile mass

CAM_F_NACQASNGLSC Singles scattering

CAM_F_NACQASNGLSCE Uncertainty in singles scattering

Record Parameters
CAM_L_NACQSFLAGS Measurement flags

CAM_M_NACQSF_TREJECT Rejected by Totals filter

[CAM_L_NACQSREJECT]

CAM_M_NACQSF_RREJECT Rejected by Reals filter

[CAM_L_NACQSRREJECT]
2
CAM_M_NACQSF_T2GREJECT Rejected by T G filter
[CAM_L_NACQST2GREJ]

CAM_M_NACQSF_CHKREJECT Rejected by checksum test

[CAM_L_NACQSCHKREJ]

CAM_M_NACQSF_CHKREJECT Consistency check reject mask

[CAM_L_NACQSCHKREJ]

CAM_M_NACQSF_ONESREJECT Run rejected by the ones rate filter

[CAM_L_NACQSONESREJ]

CAM_X_NACQSTIME Time of this measurement

CAM_F_NACQSETIME Elapsed time of this measurement (seconds)

CAM_F_NACQSTOTALS Total counts

CAM_F_NACQSREALS Real counts

CAM_F_NACQSACC Accidental counts

CAM_F_NACQSDOUBLES Uncorrected Doubles counts

CAM_F_NACQSTRIPLES Uncorrected Triples counts

CAM_F_NACQSONES Ones counts

602
 Neutron Declaration Data

CAM_F_NACQSTRUNSGL Truncated Singles counts

CAM_F_NACQSTRUNDBL Truncated Doubles counts

CAM_F_NACQSTRUNTPL Truncated Triples counts

CAM_L_NACQSSCALER1 Contents of first auxiliary scaler. The auxiliary

scalers are supported only for the JSR-14 shift
register. In the JSR-14’s 2150 emulation mode,
the scalers are read and reset for each measure-
ment cycle. In the JSR-12 emulation mode, the
scalers are read only on the last measurement
cycle.

CAM_L_NACQSSCALER2 Contents of second auxiliary scaler

Note: Prior to mass calculations, the reals and totals rates must be corrected. There
are three corrections done, in the following order: 1) deadtime correction; 2)
background correction; 3) normalization. However, common analysis codes
perform these corrections in two steps. The descriptions of the corrected rates
above (NACQMEANDTT, NACQMEANBCT, etc.), are accurate for
LANL-derived algorithms.

CEA-derived algorithms perform the rate correction slightly differently:

deadtime correction and background correction are performed in one step, and
normalization is done as one step. CEA algorithms store the result of their
deadtime/background correction in the parameters labeled “deadtime cor-
rected”, and the result of their normalization in the parameters labeled “nor-
malized/background corrected”.

In all cases, the end result of the three corrections is stored in parameters la-
beled “normalized/background corrected”.

Neutron Declaration Data

The Neutron Declaration Data block contains isotopic declaration and mass information.
This information is compared against the results of neutronics analysis to generate “mea-
sured vs. declared” reports.

Isotopic abundances (actually entered as weight %) are stored one isotope per record; the
name of the isotope should be entered in a standard format (i.e., Pu-242, PU-242, etc.) so
that it can be properly identified by neutronics analysis.

The symbolic name for this class is CAM_CLS_NEUTDECL.

603
CAM Files

Common Parameters
CAM_T_NDCLTITLE Declaration title (64 characters)

CAM_T_NDCLIDENT Declaration ID (16 characters)

CAM_T_NDCLPUMUNITS Mass units string (by default, grams) (8 charac-

ters). This string (and the following conversion
factor) may optionally be used by editors and re-
ports to convert between external mass units and
internal mass units (always grams).

CAM_F_NDCLPUMCF Conversion factor between mass report units and

grams (in units/gram)

CAM_T_NDCLSTYPE Name of the sample type of the material de-

scribed by this declaration (16 characters)

CAM_X_NDCLPUDATE Pu isotopics date

CAM_T_NDCLPUSRC Pu isotopics source (16 characters)

CAM_X_NDCLAMDATE Am isotopics date

CAM_T_NDCLAMSRC Am isotopics source (16 characters)

CAM_X_NDCLR2CSTIME The time between removal from the reactor and

chemical separation

CAM_X_NDCLPUMDATE Pu mass declaration date

CAM_F_NDCLPUMASS Pu mass (grams)

CAM_F_NDCLPUMASSER Error in Pu mass

CAM_F_NDCLWGTFCTR Pu weight to mass conversion factor;

NDCLPUMASS is always multiplied by this
value to convert a Pu weight to a Pu mass

CAM_F_NDCLDCPUM Decay-corrected Pu mass (grams) (calculated by

neutronics analysis)

CAM_F_NDCLDCPUMERR Error in decay-corrected Pu mass (calculated by

neutronics analysis)

CAM_F_NDCLPRPUM Predicted Pu mass (grams), decay-corrected to

the prediction date (PRNEUTPRDATE)

CAM_F_NDCLPRPUMERR Error in the predicted Pu mass

CAM_F_NDCLUMASS Declared U mass (grams) as of the U declaration

date

CAM_F_NDCLUMASSERR Uncertainty in the declared U mass

604
 Neutron Declaration Data

CAM_F_NDCLTREALS True (known) reals rate; if non-zero, this value

is used in the calculation of the proposed nor-
malization constant.

CAM_F_NDCLTREALSER Error in the true reals rate

CAM_F_NDCLREFV Sample reals rate correction factor (used in the

computation of the reals rate for Pu standards)

CAM_T_NDCLNAME Declaration name utilized by the database (8

characters)

CAM_L_ NDCLTYPE Declaration type enumeration utilized to identify

the declaration type (4 integers)

CAM_X_NDCLUDATE Declared U isotopics date

CAM_X_NDCLOIDATE Declared “other isotopes” (that is, other than Pu,

U, and Am) date

These parameters are used only in ANCC applications:

CAM_F_NDCLPOISFRAC Poison fraction (%)

CAM_F_NDCLPOISFRER uncertainty in poison fraction

CAM_L_NDCLFUELRODS Total number of fuel rods (including poison

rods)

CAM_L_NDCLPOISRODS Number of poison rods

CAM_L_NDCLFLAGS Declaration Flags

CAM_L_NDCLFVCISOOK Declaration has been verified against mea-

sured isotopics

CAM_L_NDCLFVCISONG Declaration does not match measured

isotopics
252
CAM_L_NDCLFCFPRES Cf may be present
244
CAM_L_NDCLFCMPRES Cm may be present

Record Parameters
CAM_T_NDCLISONAME Isotope name (16 characters)

CAM_F_NDCLWEIGHT Weight %

CAM_F_NDCLWEIGHTER Error in weight %

605
CAM Files

CAM_F_NDCLDCWEIGHT Decay-corrected weight % (calculated by

neutronics analysis; decay corrected to the neu-
tron acquisition date)

CAM_F_NDCLDCWTERR Error in decay-corrected weight %

CAM_F_NDCLPRWEIGHT Predicted weight %; this is the declared weight

% decay-corrected to the prediction date
(PRNEUTPRDATE)

CAM_F_NDCLPRWTERR Error in predicted weight %

Neutron Detector Data

The Neutron Detector Efficiency Data block contains data for a neutron detector which
are not dependent on the type of sample (data which is dependent on both the type of
sample and a particular detector is stored in the Neutron Sample-dependent Detector Data
block).

The symbolic name for this class is CAM_CLS_NEUTDET.

Common Parameters
CAM_T_NDETNAME Detector name (16 characters)

CAM_X_NDETCALDATE Calibration date

CAM_T_NDETANALYST Calibration analyst’s name

CAM_F_NDETK1 Normalization factor [K]

CAM_F_NDETK1ERR Error in normalization factor

CAM_F_NDETPROPK1 Proposed normalization constant (computed by

the neutronics engine)

CAM_F_NDETPROPK1ER Error in proposed normalization constant

CAM_F_NDETK1DIFF 1-sigma difference between the current and pro-

posed normalization constants

CAM_F_NDETDTCF1 Totals deadtime correction factor 1

CAM_F_NDETDTCF2 Totals deadtime correction factor 2

CAM_F_NDETDTCF3 Reals deadtime correction factor 1 [A]

CAM_F_NDETDTCF4 Reals deadtime correction factor 2 [B]

606
 Neutron Sample-Dependent Detector Data

CAM_F_NDETENSRO0 Ensslin ρ0

CAM_F_NDETCDTHICK Cadmium absorber thickness (g/cm2)

CAM_F_NDETDIEAWAY Detector dieaway time (µs)

CAM_F_NDETHICDTHK High energy cadmium thickness (mm) (MGA)

CAM_F_NDETHICDCF High energy cadmium thickness correction fac-

tor (MGA)

CAM_F_NDETHIPBTHK High energy detector lead thickness (mm)

(MGA)

CAM_F_NDETMDELTA Detector deadtime

CAM_F_NDETMDELTAER The detector deadtime error

CAM_F_NDETMDBLDTCF Doubles deadtime coefficient

CAM_F_NDETMTPLDTCF Triples deadtime coefficient

CAM_F_NDETDBLGATEF Doubles gate fraction

CAM_F_NDETGATEFER Doubles gate fraction error

CAM_F_NDETTPLGATEF Triples gate fraction

CAM_F_NDETTGATEFER Triples gate fraction error

Neutron Sample-Dependent Detector Data

The Neutron Sample-dependent Detector Data block contains parameters which are spe-
cific to a particular neutron detector and sample type. Detector parameters which are in-
dependent of a particular sample type are stored in the Neutron Detector Data block.

There are four groups of data in this block

• The weighting factors used in computing the uncertainty in totals and reals
rates.
• The coefficients for the linear equation used in converting multiplication
corrected reals rates to 240Pu effective mass.
• The coefficients for the quadratic equation used in converting non
240
multiplication corrected reals rates to Pu effective mass.
• The raw data triplets (240Pu effective, reals rate, multiplication-corrected reals
rate) used in generating the coefficients; these are stored as record parameters.

607
CAM Files

The symbolic name for this class is CAM_CLS_NEUTEFF.

General Information
CAM_T_NEFFDETNAME Detector name (16 characters)

CAM_T_NEFFSTIDENT Sample type name (16 characters)

CAM_T_NEFFSTTITLE Sample type title (64 characters)

CAM_X_NEFFCALDATE Calibration date

CAM_T_NEFFANALYST Calibration analyst’s name (16 characters)

CAM_T_NEFFCURVEID Identification of the calibration curve (16 char-

acters)

CAM_F_NEFFTUWF Totals uncertainty weighting factor [W]

CAM_F_NEFFRUWF Reals uncertainty weighting factor [W]

CAM_F_NEFFLOWLIM Lower limit of mass (grams) for which these

curves are valid

CAM_F_NEFFHIGHLIM Upper limit of mass (grams) for which these

curves are valid

CAM_F_NEFFRHO0 Sample-specific ρ0

CAM_F_NEFFDIEAWAY Sample-specific dieaway time (µs)

CAM_F_NEFFMGAHFRAC Fraction of sample in high energy path (MGA)

CAM_F_NEFFDETEFF Raw uncorrected detector efficiency

CAM_F_NEFFDETEFFER Detector efficiency error

CAM_F_NEFFDETCEFF K-normalized detector efficiency

CAM_F_NEFFDETCEFFER Error in normalized efficiency

CAM_F_NEFFCORRFAC1 Multiplicity mass correction factor 1

CAM_F_NEFFCF1ERROR Uncertainty in multiplicity mass correction fac-

tor 1

CAM_F_NEFFCF1PARMA Multiplicity mass correction factor CF1 equation

parameter A

CAM_F_NEFFCF1PARMB Multiplicity mass correction factor CF1 equation

parameter B

608
 Neutron Sample-Dependent Detector Data

CAM_F_NEFFCF1PARMC Multiplicity mass correction factor CF1 equation

parameter C

CAM_F_NEFFCF1VARA Multiplicity mass correction factor CF1 equation

parameter A variance

CAM_F_NEFFCF1VARB Multiplicity mass correction factor CF1 equation

parameter B variance

CAM_F_NEFFCF1VARC Multiplicity mass correction factor CF1 equation

parameter C variance

CAM_F_NEFFCF1VARAB Multiplicity mass correction factor CF1 equation

parameter A,B covariance

CAM_F_NEFFCF1VARAC Multiplicity mass correction factor CF1 equation

parameter A,C covariance

CAM_F_NEFFCF1VARBC Multiplicity mass correction factor CF1 equation

parameter B,C covariance

CAM_F_NEFFCORRFAC2 Multiplicity mass correction factor 2

CAM_F_NEFFCF2ERROR Uncertainty in multiplicity mass correction fac-

tor 2

CAM_F_NEFFCF2PARMA Multiplicity mass correction factor 2 equation

parameter A

CAM_F_NEFFCF2PARMB Multiplicity mass correction factor 2 equation

parameter B

CAM_F_NEFFCF2PARMC Multiplicity mass correction factor 2 equation

parameter C

CAM_F_NEFFCF2VARA Multiplicity mass correction factor 2 equation

parameter A variance

CAM_F_NEFFCF2VARB Multiplicity mass correction factor 2 equation

parameter B variance

CAM_F_NEFFCF2VARC Multiplicity mass correction factor 2 equation

parameter C variance

CAM_F_NEFFCF2VARAB Multiplicity mass correction factor 2 equation

parameter A,B covariance

CAM_F_NEFFCF2VARAC Multiplicity mass correction factor 2 equation

parameter A,C covariance

CAM_F_NEFFCF2VARBC Multiplicity mass correction factor 2 equation

parameter B,C covariance

609
CAM Files

CAM_L_NEFFTRUNCL Multiplicity histogram truncation level

CAM_T_NEFFCALDBR Mass calibration database record ID

CAM_F_NEFFSHFZMMF0 Shuffler zero matrix mass calibration (cps/g)

CAM_F_NEFFSHFZMV00 Variance in shuffler zero matrix mass calibration

CAM_L_NEFFFLAGS Flags

CAM_M_NEFF_FORCETHRU0 Force fits through 0,0

CAM_M_NEFFF_CM Cm mass calibration has been defaulted

CAM_M_NEFFF_CF Cf mass calibration has been defaulted

CAM_M_NEFFF_AWAPU AWA Pu mass calibration has been de-

faulted

CAM_M_NEFFF_HZZ1 High-Z Z1 mass calibration has been de-

faulted

CAM_M_NEFFF_HZZ2 High-Z Z2 mass calibration has been de-

faulted

CAM_M_NEFFF_PU NCC/Multiplicity Pu mass calibration has

been defaulted

CAM_M_NEFFF_U Uranium mass calibration is present

240
Multiplication-Corrected Reals Pu Calibration
CAM_F_NEFFMCOFF Offset

CAM_F_NEFFMCOFFV Variance in offset

CAM_F_NEFFMCSLOPE Slope

CAM_F_NEFFMCSLOPEV Variance in slope

CAM_F_NEFFMCCOVAR Covariance between offset and slope

CAM_F_NEFFMCRSS Residual squares sum

CAM_F_NEFFMCRCHI Multiplication corrected reals mass calibration

reduced chi-square

240
Non-Multiplication-Corrected Reals Pu Calibration
CAM_F_NEFFNMCOFF Offset

610
 Neutron Sample-Dependent Detector Data

CAM_F_NEFFNMCOFFV Variance in offset

CAM_F_NEFFNMCSLOPE Slope

CAM_F_NEFFNMCSLOPV Variance in slope

CAM_F_NEFFNMCQUAD Quadratic

CAM_F_NEFFNMCQUADV Variance in quadratic

CAM_F_NEFFNMCOSC Covariance between offset and slope

CAM_F_NEFFNMCOQC Covariance between offset and quadratic

CAM_F_NEFFNMCSQC Covariance between slope and quadratic

CAM_F_NEFFNMCRSS Residual squares sum

CAM_F_NEFFNMCCUB Cubic coefficient

CAM_F_NEFFNMCCUBV Variance for the cubic coefficient

CAM_F_NEFFNMCOCC Covariance between the offset and cubic coeffi-

cient

CAM_F_NEFFNMCSCC Covariance between slope and cubic coefficient

CAM_F_NEFFNMCQCC Covariance between the quadratic and cubic co-

efficient

CAM_F_NEFFNMCRCHI Reals mass calibration polynomial reduced

chi-square

240
Pu Calibration (Power Function)
CAM_F_NEFFNMCPMAN Power function mantissa

CAM_F_NEFFNMCPEXP Power function exponent

CAM_F_NEFFNMCPMANV Power function mantissa variance

CAM_F_NEFFNMCPEXPV Power function exponent variance

CAM_F_NEFFNMCPMEC Power function covariance

CAM_F_NEFFNMCPRSS Power function residual

CAM_F_NEFFNMCPRCHI Reals mass calibration power function reduced

chi-square

611
CAM Files

240
Non-Multiplication-Corrected Reals Pu Calibration
(Exponential Function)
CAM_F_NEFFNMCEMAN Exponential function mantissa

CAM_F_NEFFNMCEEXP Exponential function exponent

CAM_F_NEFFNMCEMANV Exponential function mantissa variance

CAM_F_NEFFNMCEEXPV Exponential function exponent variance

CAM_F_NEFFNMCEMEC Exponential function covariance

CAM_F_NEFFNMCERSS Exponential function residual

CAM_F_NEFFNMCERCHI Reals mass calibration exp. function reduced

chi-square

240
Non-Multiplication-Corrected Reals Pu Calibration (Rational
Function)
CAM_F_NEFFNMCRNUM Rational function numerator coefficient

CAM_F_NEFFNMCRDEN Rational function denominator coefficient

CAM_F_NEFFNMCRNUMV Rational function numerator variance

CAM_F_NEFFNMCRDENV Rational function denominator variance

CAM_F_NEFFNMCRNDC Rational function covariance

CAM_F_NEFFNMCRRSS Rational function residual

CAM_F_NEFFNMCRRCHI Reals mass calibration rational function reduced

chi-square

240
Non-Multiplication-Corrected Totals Pu Calibration
CAM_F_NEFFTNMCOFF Offset

CAM_F_NEFFTNMCOFFV Variance in offset

CAM_F_NEFFTNMCSL Slope

CAM_F_NEFFTNMCSLV Variance in offset

CAM_F_NEFFTNMCOSC Covariance between offset and slope

CAM_F_NEFFTNMRCHI Totals mass calibration reduced chi-square

612
 Neutron Sample-Dependent Detector Data

240
Multiplication-Corrected Doubles Pu Calibration
CAM_F_NEFFMMCSLOPE Multiplication corrected doubles mass calibra-
tion slope coefficient

CAM_F_NEFFMMCOFF Multiplication corrected doubles mass calibra-

tion offset coefficient

CAM_F_NEFFMMCSLOPV Multiplication corrected doubles mass calibra-

tion slope variance

CAM_F_NEFFMMCOFFV Multiplication corrected doubles mass calibra-

tion offset variance

CAM_F_NEFFMMCCOVAR Multiplication corrected doubles mass calibra-

tion covariance

CAM_F_NEFFMMCRSS Multiplication corrected doubles mass calibra-

tion residual squares sum

CAM_F_NEFFMMCRCHI Multiplication corrected doubles mass calibra-

tion reduced chi-square

Multiplicity Ones Rate 240Pu Calibration

CAM_F_NONESPUSLP Ones Rate Slope Calibration factor for 240Pu Ef-
fective

CAM_F_NONESZ1SLP Ones Rate Matrix Slope Calibration factor for

Matrix 1

CAM_F_NONESZ2SLP Ones Rate Matrix Slope Calibration factor for

Matrix 2

CAM_F_NONESPUSLPER Ones Rate Slope Calibration factor error for

240
Pu Effective

CAM_F_NONESZ1SLPER Ones Rate Matrix Slope Calibration factor error

for Matrix 1

CAM_F_NONESZ2SLPER Ones Rate Matrix Slope Calibration factor error

for Matrix 2

Non-Truncated Multiplicity 240Pu Calibration

CAM_F_NEFFMMCDSLP Multiplication corrected Doubles Slope

CAM_F_NEFFMMCDSLPV Multiplication corrected Doubles Slope variance

CAM_F_NEFFMMCTSLP Multiplication corrected Triples Slope for 240Pu

Effective

613
CAM Files

CAM_F_NEFFMMCTSLPV Multiplication corrected Triples Slope variance

for 240Pu Effective

CAM_F_NEFFMMCDTCOV Multiplication corrected Doubles-Triples

Covariance for 240Pu Effective

Truncated Multiplicity 240Pu Calibration

CAM_F_NEFFTRUNPUD Truncated Doubles linear calibration parameter
for 240Pu Effective

CAM_F_NEFFTRUNPUT Truncated Triples linear calibration parameter

for 240Pu Effective

CAM_F_NEFFTRUNPUDE Truncated Doubles calibration parameter vari-

ance for 240Pu Effective

CAM_F_NEFFTRUNPUTE Truncated Triples calibration parameter variance

for 240Pu Effective

CAM_F_NEFFTPUDTCOV Truncated Doubles-Triples calibration

covariance for 240Pu Effective

Truncated Multiplicity Spallation Calibration

CAM_F_NEFFTRUNZ1D Truncated Doubles linear calibration parameter
for matrix 1

CAM_F_NEFFTRUNZ1T Truncated Triples linear calibration parameter

for matrix 1

CAM_F_NEFFTRUNZ1DE Truncated Doubles linear calibration parameter

variance for matrix 1

CAM_F_NEFFTRUNZ1TE Truncated Triples linear calibration parameter

variance for matrix 1

CAM_F_NEFFTRUNZ1CV Truncated Doubles Triples linear calibration pa-

rameter covariance for matrix 1

CAM_F_NEFFTRUNZ2D Truncated Doubles linear calibration parameter

for matrix 2

CAM_F_NEFFTRUNZ2T Truncated Triples linear calibration parameter

for matrix 2

CAM_F_NEFFTRUNZ2DE Truncated Doubles linear calibration parameter

variance for matrix 2

CAM_F_NEFFTRUNZ2TE Truncated Triples linear calibration parameter

variance for matrix 2

614
 Neutron Sample-Dependent Detector Data

Non-Truncated Multiplicity Cm/Cf Calibration

CAM_F_NEFFCMDCAL Curium Doubles calibration parameter

CAM_F_NEFFCMTCAL Curium Triples calibration parameter

CAM_F_NEFFCMDCALER Curium Doubles calibration parameter variance

CAM_F_NEFFCMTCALER Curium Triples calibration parameter variance

CAM_F_NEFFCMDTCOV Curium Doubles Triples calibration

CAM_F_NEFFCFDCAL Californium Doubles calibration parameter

CAM_F_NEFFCFTCAL Californium Triples calibration parameter

CAM_F_NEFFCFDCALER Californium Doubles calibration parameter vari-

ance

CAM_F_NEFFCFTCALER Californium Triples calibration parameter vari-

ance

CAM_F_NEFFCFDTCOV Californium Doubles Triples calibration

covariance

DDA Calibration
CAM_F_NEFFDDATYPE Differential Dieaway analysis type: 0 = 239Pu
equivalent mass; 1 = 235U equivalent mass

CAM_F_NEFFDDAZMMF zero matrix calibration factor for equivalent

mass

CAM_F_NEFFDDASAA0 Self absorption parameter zero

CAM_F_NEFFDDASAA1 Self absorption parameter one

CAM_F_NEFFDDASAA2 Self absorption parameter two

CAM_F_NEFFDDASAA3 Self absorption parameter three

CAM_F_NEFFDDAZMV00 zero matrix calibration factor variance

CAM_F_NEFFDDASV00 Self absorption parameter zero variance

CAM_F_NEFFDDASV11 Self absorption parameter one variance

CAM_F_NEFFDDASV22 Self absorption parameter two variance

CAM_F_NEFFDDASV33 Self absorption parameter three variance

CAM_F_NEFFDDAEQMLL Lower mass limit for equivalent mass (grams)

615
CAM Files

CAM_F_NEFFDDAEQMHL Upper mass limit for equivalent mass (grams)

Record Parameters
240
CAM_F_NEFFR240EM Pu effective mass (grams)

CAM_F_NEFFR240EMER Error in 240Pu effective

CAM_F_NEFFRREALS Reals rate (counts/second)

CAM_F_NEFFRREALSER Error in reals rate

CAM_F_NEFFRMCREALS Multiplication-corrected reals rate (counts/sec-

ond)

CAM_F_NEFFRMCREALE Error in multiplication-corrected reals rate

CAM_F_NEFFRTOTALS Totals rate (counts/second)

CAM_F_NEFFRTOTALSE Error in totals rate

CAM_T_NEFFRCNTFILE Mass calibration count file (96 characters)

CAM_X_NEFFRCNTDATE Mass calibration count file acquisition date

Neutron Sample Processing Parameters

The Neutron Sample Processing Parameters block contains processing parameters spe-
cific to a particular type of sample (but not dependent on a particular detector). The sym-
bolic name for this class is CAM_CLS_NEUTSPROC.

Common Parameters
CAM_T_NSPRTITLE Title for this sample type (64 characters)

CAM_T_NSPRIDENT Identification string (one word) for this sample

type (16 characters)

CAM_T_NSPRNAME Sample type name utilized by the database (8

characters)

CAM_L_NSPRGROUP Sample type group enumeration utilized to iden-

tify the sample type group (4 integers)

CAM_F_NSPRAPU238MF Alpha Pu-238 multiplication factor [K1]

CAM_F_NSPRAPU239MF Alpha Pu-239 multiplication factor [K2]

CAM_F_NSPRAPU240MF Alpha 240Pu multiplication factor [K3]

616
 Neutron Sample Processing Parameters

CAM_F_NSPRAPU241MF Alpham 241Pu ultiplication factor [K4]

CAM_F_NSPRAPU242MF Alpham 242Pu ultiplication factor [K5]

CAM_F_NSPRAAM241MF Alpha 241Pu multiplication factor [K6]

CAM_F_NSPRADENFAC Alpha denominator factor [K7]

CAM_F_NSPRAPU238DF Alpha 248Pu denominator factor [K8]

CAM_F_NSPRAPU240DF Alpha 240Pu denominator factor

CAM_F_NSPRAPU242DF Alpha 242Pu denominator factor [K9]

CAM_F_NSPRSPU238MF S-factor 238Pu multiplication factor [K11]

CAM_F_NSPRSPU240MF S-factor 240Pu multiplication factor

CAM_F_NSPRSPU242MF S-factor 242Pu multiplication factor [K12]

CAM_F_NSPRENSNMF Ensslin neutron multiplication factor [K10]

CAM_F_NSPRENSRTC Ensslin R/T correlation factor

CAM_F_NSPRWA Alpha sample-type correction factor [Wa]

CAM_F_NSPRPUTHICK Plutonium thickness (g/cm2)

CAM_F_NSPRCFRTRAT Californium R/T ratio level

CAM_F_NSPRMGASTEEL Container steel thickness (mm) (MGA)

CAM_F_NSPRMGAPB Container lead thickness (mm) (MGA)

CAM_F_NSPRMGA242C0 MGA Pu-242 multiplier constant

CAM_F_NSPRMGA242Cn MGA Pu-242 coefficient n, where n is 1 to 9

CAM_F_NSPK3PCFA Poison rod correction factor A

CAM_F_NSPK3PCFAERR Error in poison rod correction factor A

CAM_F_NSPK3PCFB Poison rod correction factor B

CAM_F_NSPK3PCFBERR Error in poison rod correction factor B

CAM_F_NSPK3PCFC Poison rod correction factor C

CAM_F_NSPK3PCFCERR Error in poison rod correction factor C

CAM_F_NSPK4HMFA Heavy metal factor A

CAM_F_NSPK4HMFAERR Error in heavy metal factor A

617
CAM Files

CAM_F_NSPK4HMFB Heavy metal factor B

CAM_F_NSPK4HMFBERR Error in heavy metal factor B

CAM_F_NSPK5MCFA Matrix correction factor A

CAM_F_NSPK5MCFAERR Error in matrix correction factor A

CAM_F_NSPPSVFA Passive factor A

CAM_F_NSPPSVFAERR Error in passive factor A

CAM_F_NSPPSVFB Passive factor B

CAM_F_NSPPSVFBERR Error in passive factor B

CAM_F_NSPPSVFC Passive factor C

CAM_F_NSPPSVFCERR Error in passive factor C

CAM_F_NSPPSVFD Passive factor D

CAM_F_NSPPSVFDERR Error in passive factor D

CAM_F_NSPCRFAC Collar counter cross calibration factor

CAM_F_NSPCRFACERR Error in collar counter cross calibration factor

CAM_X_NSPCRFACDATE Collar counter cross calibration factor date

CAM_T_NSPRPOISDESC Poison rod description (64 characters)

CAM_F_NSPRPOISAFAC Poison rod absorption factor

CAM_L_NSPRFUELRODS Number of fuel rods in reference assembly

CAM_L_NSPRFLAGS Neutron Sample Processing Parameter Flags

CAM_M_NSPRF_UPRES Uranium present? (used by MGA)

[CAM_L_NSPRFUPRES]

CAM_M_NSPRF_THERMAL False=Fast Mode (cadmium); True=Thermal

[CAM_L_NSPACTVMODE] Mode (no cadmium)

240
CAM_F_NSPPU240FR Pu spontaneous fission rate per mass

CAM_F_NSPSMOMENT(1-3) Moments of spontaneous fission

CAM_F_NSPIMOMENT(1-3) Moments of induced fission

618
 Neutron Sample Processing Parameters

DDA Parameters
CAM_F_NSPRDDAMIA0 Moderator index parameter zero

CAM_F_NSPRDDAMIA1 Moderator index parameter one

CAM_F_NSPRDDAMIA2 Moderator index parameter two

CAM_F_NSPRDDAMIA3 Moderator index parameter three

CAM_F_NSPRDDAMCFA0 Moderator correction factor parameter zero

CAM_F_NSPRDDAMCFA1 Moderator correction factor parameter one

CAM_F_NSPRDDAACFA0 Absorption correction factor parameter zero

CAM_F_NSPRDDAACFA1 Absorption correction factor parameter one

CAM_F_NSPRDDABKGSF Background scale factor

CAM_F_NSPRDDAIBKA0 Interrogating background parameter zero

CAM_F_NSPRDDAIBKA1 Interrogating background parameter one

CAM_F_NSPRDDAIBKA2 Interrogating background parameter two

CAM_F_NSPRDDAIBKA3 Interrogating background parameter three

CAM_F_NSPRDDAEQBA0 Equivalent mass bias parameter zero

CAM_F_NSPRDDAEQBA1 Equivalent mass bias parameter one

CAM_F_NSPRDDAEQBA2 Equivalent bias parameter two

CAM_F_NSPRDDAMIV00 Moderator index parameter zero variance

CAM_F_NSPRDDAMIV11 Moderator index parameter one variance

CAM_F_NSPRDDAMIV22 Moderator index parameter two variance

CAM_F_NSPRDDAMIV33 Moderator index parameter three variance

CAM_F_NSPRDDAMIV01 Moderator index parameter zero, one covariance

CAM_F_NSPRDDAMIV02 Moderator index parameter zero, two covariance

CAM_F_NSPRDDAMIV03 Moderator index parameter zero, three

covariance

CAM_F_NSPRDDAMIV12 Moderator index parameter one, two covariance

CAM_F_NSPRDDAMIV13 Moderator index parameter one, three

covariance

619
CAM Files

CAM_F_NSPRDDAMIV23 Moderator index parameter two, three

covariance

CAM_F_NSPRDDAMCV00 Moderator correction factor parameter zero vari-

ance

CAM_F_NSPRDDAMCV11 Moderator correction factor parameter one vari-

ance

CAM_F_NSPRDDAMCV01 Moderator correction factor parameter zero, one

covariance

CAM_F_NSPRDDAACV00 Absorption correction factor parameter zero

variance

CAM_F_NSPRDDAACV11 Absorption correction factor parameter one vari-

ance

CAM_F_NSPRDDAACV01 Absorption correction factor parameter zero, one

covariance

CAM_F_NSPRDDAIBV00 Interrogating background parameter zero vari-

ance

CAM_F_NSPRDDAIBV11 Interrogating background parameter one vari-

ance

CAM_F_NSPRDDAIBV22 Interrogating background parameter two vari-

ance

CAM_F_NSPRDDAIBV33 Interrogating background parameter three vari-

ance

CAM_F_NSPRDDAIBV01 Interrogating background parameter zero,one

covariance

CAM_F_NSPRDDAIBV02 Interrogating background parameter zero,two

covariance

CAM_F_NSPRDDAIBV03 Interrogating background parameter zero,three

covariance

CAM_F_NSPRDDAIBV12 Interrogating background parameter one,two

covariance

CAM_F_NSPRDDAIBV13 Interrogating background parameter one,three

covariance

CAM_F_NSPRDDAIBV23 Interrogating background parameter two,three

covariance

CAM_F_NSPRDDAIBKX1 First extra interrogating background parameter

620
 Neutron Sample Processing Parameters

CAM_F_NSPRDDAIBKX2 Second extra interrogating background parame-

ter

CAM_F_NSPRDDAIBKMO Interrogating background parametric form:

0 = standard NDA 2000, 1 = SWEPP,
3 = NUCLECO

CAM_F_NSPRDDAMBV00 Equivalent mass bias parameter zero variance

CAM_F_NSPRDDAMBV11 Equivalent mass bias parameter one variance

CAM_F_NSPRDDAMBV22 Equivalent mass bias parameter two variance

Shuffler Parameters
CAM_F_NSPRSHFMCFA0 Shuffler matrix parameter zero

CAM_F_NSPRSHFMCFA1 Shuffler matrix parameter one

CAM_F_NSPRSHFMCFA2 Shuffler matrix parameter two

CAM_F_NSPRSHFMCFA3 Shuffler matrix parameter three

CAM_F_NSPRSHFMCFA4 Shuffler matrix parameter four

CAM_F_NSPRSHFMCFA5 Shuffler matrix parameter five

CAM_F_NSPRSHFMCV00 Shuffler matrix parameter zero variance

CAM_F_NSPRSHFMCV11 Shuffler matrix parameter one variance

CAM_F_NSPRSHFMCV22 Shuffler matrix parameter two variance

CAM_F_NSPRSHFMCV33 Shuffler matrix parameter three variance

CAM_F_NSPRSHFMCV44 Shuffler matrix parameter four variance

CAM_F_NSPRSHFMCV55 Shuffler matrix parameter five variance

CAM_F_NSPRSHFMCV01 Shuffler matrix parameter zero,one covariance

CAM_F_NSPRSHFMCV02 Shuffler matrix parameter zero,two covariance

CAM_F_NSPRSHFMCV03 Shuffler matrix parameter zero,three covariance

CAM_F_NSPRSHFMCV04 Shuffler matrix parameter zero,four covariance

CAM_F_NSPRSHFMCV05 Shuffler matrix parameter zero,five covariance

CAM_F_NSPRSHFMCV12 Shuffler matrix parameter one,two covariance

CAM_F_NSPRSHFMCV13 Shuffler matrix parameter one,three covariance

621
CAM Files

CAM_F_NSPRSHFMCV14 Shuffler matrix parameter one,four covariance

CAM_F_NSPRSHFMCV15 Shuffler matrix parameter one,five covariance

CAM_F_NSPRSHFMCV23 Shuffler matrix parameter two,three covariance

CAM_F_NSPRSHFMCV24 Shuffler matrix parameter two,four covariance

CAM_F_NSPRSHFMCV25 Shuffler matrix parameter two,five covariance

CAM_F_NSPRSHFMCV34 Shuffler matrix parameter three,four covariance

CAM_F_NSPRSHFMCV35 Shuffler matrix parameter three,five covariance

CAM_F_NSPRSHFMCV45 Shuffler matrix parameter four,five covariance

CAM_F_NSPRSHFRMAX Shuffler maximum fast/thermal flux ratio

CAM_F_NSPRSHFRMAXE Uncertainty in maximum F/T flux ratio

CAM_F_NSPRSHFRMIN Shuffler minimum fast/thermal flux ratio

CAM_F_NSPRSHFRMINE Uncertainty in minimum F/T flux ratio

CAM_F_NSPRSHFGCFA0 Shuffler geometry parameter zero

CAM_F_NSPRSHFGCFA1 Shuffler geometry parameter one

CAM_F_NSPRSHFGCFA2 Shuffler geometry parameter two

CAM_F_NSPRSHFGCV00 Shuffler geometry parameter zero variance

CAM_F_NSPRSHFGCV11 Shuffler geometry parameter one variance

CAM_F_NSPRSHFGCV22 Shuffler geometry parameter two variance

CAM_F_NSPRSHFGCV01 Shuffler geometry parameter zero,one

covariance

CAM_F_NSPRSHFGCV02 Shuffler geometry parameter zero,two

covariance

CAM_F_NSPRSHFGCV12 Shuffler geometry parameter one,two covariance

Attenuation Correction Calibration Parameters

This parameter block describes an attenuation curve. Its symbolic code is
CAM_CLS_ATTENCALIB.

622
 Absorption Measurement Calibration/Result
Parameters

Common Parameters
CAM_X_ACCCALTIME Calibration time

CAM_T_ACCOPNAME Analyst’s name (16 characters)

CAM_T_ACCTITLE Curve title (64 characters)

CAM_T_ACCVERSION Calibration engine version (16 characters)

CAM_L_ACCDEGREE µ(E) Polynomial degree (0-9) (Stored as

UBYTE)

CAM_F_ACCCHISQ Reduced fit χ2

CAM_F_ACCCALFAC1 Offset

CAM_F_ACCCALFAC2 Slope

CAM_F_ACCCALFACn nth order term, where n is 3 to 10

CAM_G_ACCERRMATn Error matrix n, where n is 1 to 19

Record Parameters
CAM_F_ACCENERGY Energy (keV) for known µ(E)

CAM_F_ACCMU Known µ(Ε)

CAM_F_ACCMUERR Error in known µ(Ε)

Absorption Measurement Calibration/Result Parameters

This parameter block contains absorption calibration and measurement results. Results
parameters are indicated by “[R]” and must be zeroed when a peak analysis is done. The
block’s symbolic code is CAM_CLS_ABSMEASRES.

Common Parameters
CAM_L_AMRFLAGS Analysis flags

CAM_M_AMRF_DP Differential peak attenuation done

[CAM_L_AMRFDP]

CAM_M_AMRF_TR Transmission correction done

[CAM_L_AMRFTR]

CAM_M_AMRF_AD Average density correction done

[CAM_L_AMRFAD]

623
CAM Files

CAM_M_AMRF_COMBINED Combined matrix correction done

[CAM_L_AMRFCOMBINED]

CAM_M_AMRF_DPFOVR Differential peak attempted but failed over

[CAM_L_AMRFDPFOVR] to average density

CAM_M_AMRF_TRFOVR Transmission correction attempted but failed

[CAM_L_AMRFTRFOVR] over to average density

CAM_M_AMRF_DPREJECT All differential peak pairs rejected

[CAM_L_AMRFDPREJECT]

CAM_M_AMRF_TRREJECT All transmission peaks rejected

[CAM_L_AMRFTRREJECT]

CAM_M_AMRF_TRMIN Transmission was below minimum value for

[CAM_L_AMRFTRMIN] at least one peak

CAM_M_AMRF_DPSREJ Some differential peak pairs rejected

[CAM_L_AMRFDPSREJ]

CAM_M_AMRF_TRSREJ Some transmission peaks rejected

[CAM_L_AMRFTRSREJ]

CAM_L_AMRTRCORTYPE Transmission correction type: 0 = standard

(empty-container) mode, 1 = no-container
(ASTM) mode

CAM_X_TRNCCALTIME No-container calibration count acquisition start

time

CAM_X_TRNCCNTTIME No-container calibration count elapsed real time

CAM_T_AMRDPVERS Differential peak engine version (16 characters)

CAM_T_AMRTRVERS Transmission correction engine version (16

characters)

CAM_T_AMRADVERS Average density engine version (16 characters)

CAM_T_AMRCMVERS Combined matrix correction engine version (16

characters)

CAM_X_AMRCALTIME Calibration time

CAM_X_AMRTRCALTIME Transmission calibration measurement start time

CAM_X_AMRDPCALTIME Differential peak calibration measurement start

time

CAM_T_AMROPNAME Calibration analyst’s name (16 characters)

624
 Absorption Measurement Calibration/Result
Parameters

CAM_F_AMRSEGnCFAC Segment n correction factor, where n is 1 to 36

CAM_F_AMRRHOTDP Mean ρt from differential correction

CAM_F_AMRRHOTDPER Error in mean ρt from differential correction

CAM_F_AMRRHOTTR Mean ρt from transmission correction

CAM_F_AMRRHOTTRER Error in mean ρt from transmission correction

CAM_F_AMRRHOTAD Mean ρt from average density correction

CAM_F_AMRRHOTADER Error in mean ρt from average density correc-

tion

CAM_F_AMRAVERHOT Final average ρt

CAM_F_AMRAVERHOTER Error in final average ρt

CAM_L_AMRANALERROR Analysis error code: provides additional diag-

nostic information if the density correction algo-
rithm cannot perform the correction; allowed
range: 0 through 255

CAM_L_AMRTCALCNTID Transmission calibration count sequence num-

ber

CAM_T_AMRTCDESC Transmission calibration description (64 charac-

ters)

Record Parameters
CAM_T_AMRNUCLIDE Nuclide name (8 characters)

CAM_T_AMRRECTYPE Record type: DIFF or TRANS (8 characters)

Differential Peak Parameters

CAM_F_AMRENERGY1 Peak 1 energy (keV)

CAM_F_AMRENERGY2 Peak 2 energy (keV)

CAM_F_AMREPAREARAT Empty container peak area ratio

CAM_F_AMREPRATERR Error in empty peak area ratio

CAM_F_AMRSPAREARAT Sample peak ½ area ratio

CAM_F_AMRSPRATERR Error in sample peak area ratio

CAM_F_AMRRHOT ρt

625
CAM Files

CAM_F_AMRRHOTERR Error in ρt

Transmission Correction Parameters

CAM_F_AMRTENERGY Peak energy

CAM_F_AMRTEAREA Empty container peak area

CAM_F_AMRTEAREAERR Error in empty container peak area

CAM_F_AMRTSAREA Sample peak area

CAM_F_AMRTSAREAERR Error in sample peak area

CAM_F_AMRTRATIO Area ratio

CAM_F_AMRTRATIOERR Error in area ratio

CAM_F_AMRTNAREA No-container corrected peak area

CAM_F_AMRTNAREAERR Error in no-container peak area

CAM_F_AMRRECTRANS Empty container transmission

CAM_F_AMRRECTRANSE Error in empty container transmission

CAM_X_AMRTNHL Nuclide half life

CAM_T_AMRNTHLU Half life units (1 character)

CAM_L_AMRRFLAGS Transmission peak flags

CAM_M_AMRRF_REJECTED This transmission peak was not found or has

[CAM_L_AMRRFREJECT] been rejected

CAM_M_AMRRF_MINIMUM This transmission peak transmission ratio

[CAM_L_AMRRFMINIMUM] was below the minimum and was set to the
minimum

Differential Peak Absorption Correction Calibration /

Results
These parameters store the calibration and analysis results for the differential peak ab-
sorption correction engine, which calculates density (ρt) based on the differential absorp-
tion of pairs of photopeaks. This class replaces the differential peak data stored in
Absorption Measurement Calibration/Results class. The symbolic name for this class is
CAM_CLS_DIFFPEAK.

626
 Differential Peak Absorption Correction
Calibration / Results

Common Parameters
CAM_L_DIFPFLAGS Flags

CAM_M_DIFPF_DONE Differential peak correction has been per-

formed

CAM_F_DIFPRHOTDP ρt from differential peak

CAM_F_DIFPRHOTDPER Error in differential peak ρt

CAM_F_DIFPRHOTAD ρt from average density

CAM_F_DIFPRHOTADER Error in average density ρt

CAM_T_DIFPVERS Differential peak correction engine version

CAM_X_DIFPCALTIME Date/time when differential peak calibration was

created

CAM_T_DIFPOPNAME Calibration analyst

CAM_F_DIFPAVERHOT Average ρt

CAM_F_DIFPAVERHOTE Error in average ρt

CAM_T_DIFPCDESC Calibration description (64 characters)

CAM_L_DIFPCALCNTID Calibration count sequence number

Record Parameters
CAM_T_DIFPNUCLIDE Nuclide name

CAM_F_DIFPENERGY1 Energy 1

CAM_F_DIFPENERGY2 Energy 2

CAM_F_DIFPEPRAT Empty container (i.e., reference) peak ratio

CAM_F_DIFPEPRATERR Error in empty container peak ratio

CAM_F_DIFPSPRAT Sample (i.e., unknown) peak ratio

CAM_F_DIFPSPRATERR Error in sample peak ratio

CAM_F_DIFPRHOT ρt

CAM_F_DIFPRHOTERR Error in ρt

627
CAM Files

Safeguards Parameters
The safeguards parameter block is composed of common parameters relating to the entire
safeguards system, and a number of records, each record describing an input (a Data Ac-
quisition System) to the system. The symbolic name for this class is
CAM_CLS_SFGSETUP.

Common Parameters
CAM_T_SFGFAC Facility name (64 characters)

CAM_T_RAWNAME1 Device/directory for primary raw data file (96

characters)

CAM_T_RAWNAME2 Device/directory for secondary raw data file (96

characters)

CAM_T_EMQNAME Device/directory for event manager queue file

(96 characters)

CAM_T_AMQNAME Device/directory for alarm manager queue files

(96 characters)

DAS Parameters
CAM_X_DASCMDTMR DAS command timer

CAM_X_DASACKTMR DAS acknowledge timer

CAM_X_DASTRNTMR DAS data transmission timer

CAM_X_DASLFADUR DAS “look-for” acknowledge duration

CAM_X_DASACKFRQ DAS acknowledge check frequency

CAM_X_DASRTLTMR DAS timer after retry limit reached

CAM_X_DASMPDEL DAS main process delay

CAM_X_DASFSFTMR DAS timer after one file service failure

CAM_X_DASCSFTMR DAS timer after complete file service failure

CAM_X_SWWTDOGTO Software watchdog timeout

HDC Parameters
CAM_T_UIDIR UIP / HDC command directory

CAM_L_MAXDDPSIZE Maximum DDP size (bytes)

628
 Safeguards Parameters

CAM_L_NUMEVCOMP Number of events before EMQ compression

CAM_X_HDCTIMEOUT HDC timeout period

CAM_L_RETRYLIMIT Retry limit

CAM_X_HDCHIBER HDC loop hibernation time

AMP Parameters
CAM_X_AMPHIBER AMP loop hibernation time

EMP Parameters
CAM_X_EMPHIBER EMP loop hibernation time

CAM_L_EMQRDMAX Maximum number of measurements before call-

ing APP

CAM_X_EMPWAITDEL Maximum wait for companion data

UIP Parameters
CAM_X_BACKSRCINT UIP background search interval

Neutron Analysis Parameters

CAM_F_ALP238MULT Alpha computation Pu-238 multiplication factor
(n1)

CAM_F_ALP239MULT Alpha computation Pu-239 multiplication factor

(n2)

CAM_F_ALP240MULT Alpha computation 240Pu multiplication factor

(n3)

CAM_F_ALP241MULT Alpha computation 241Pu multiplication factor

(n4)

CAM_F_ALP242MULT Alpha computation 242Pu multiplication factor

(n5)

CAM_F_ALPAMMULT Alpha computation 241Am multiplication factor

(n6)

CAM_F_ALPDENMULT Alpha computation denominator multiplier (d)

CAM_F_S238MULT S computation 238Pu multiplication factor (P)

CAM_F_S240MULT S computation 240Pu multiplication factor (Q)

629
CAM Files

CAM_F_S242MULT S computation 242Pu multiplication factor (R)

CAM_F_CFRTRATIO Californium reals/totals ratio threshold

CAM_F_A238MULT Alpha computation 238Pu denominator factor

CAM_F_A240MULT Alpha computation 240Pu denominator multipli-

cation factor

CAM_F_A242MULT Alpha computation 242Pu denominator multipli-

cation factor

Record Parameters

DAS Parameters
CAM_T_DASID DAS identification (16 characters)

CAM_T_DASLOC DAS location (16 characters)

CAM_L_JSRVOLT JSR-12 high voltage

CAM_L_JSRGWIDTH JSR-12 gate width (microseconds)

CAM_F_JSRPREDEL JSR-12 pre-delay (microseconds)

CAM_X_JSRCNTTIM JSR-12 count time

CAM_F_ADCZERO ADC zero (± 3% of full scale)

CAM_F_ADCULD ADC ULD (% of full scale)

CAM_F_ADCLLD ADC LLD (% of full scale)

CAM_T_FILESVCE1 Primary DAS-to-Host file service (96 charac-

ters)

CAM_T_FILESVCE2 Secondary DAS-to-Host file service (96 charac-

ters)

CAM_T_GAMMADEF Gamma configuration default file (96 charac-

ters)

CAM_L_DASGAMMAMEM Number of gamma memory pages

CAM_L_DASNEUTMEM Number of neutron memory pages

CAM_L_DASSENSORMEM Number of sensor memory pages

630
 Safeguards Parameters

EMP Parameters
CAM_F_QCENERGY Quality control energy

CAM_F_EMPGQCETOL Gamma QC energy tolerance

CAM_F_CENTLLIM QC centroid lowerlimit

CAM_F_CENTULIM QC centroid upperlimit

CAM_F_FWHMLLIM QC FWHM lower limit

CAM_F_FWHMULIM QC FWHM upper limit

CAM_F_FWTMLLIM QC FWTM lower limit

CAM_F_FWTMULIM QC FWTM upper limit

CAM_L_EMPNSTEVOB Standard number of objects per event

CAM_X_EMPNSTOPDUR Standard duration of stop

CAM_F_EMPNMINGROW Minimum growth of totals count rate

CAM_X_EMPNMINDUROB Minimum duration of neutron object

CAM_X_EMPNMAXDUROB Maximum duration of neutron object

CAM_X_EMPNMAXGAPOB Maximum gap between two neutron objects

CAM_X_EMPGAMMAXDUR Maximum duration of gamma object

CAM_X_EMPGAMMAXGAP Maximum gap between two gamma objects

CAM_F_EMPMATCHTOL Object match tolerance (0-1)

CAM_L_EMPGIDSTCH Inter-DAS gamma check start channel

CAM_L_EMPGIDENCH Inter-DAS gamma check end channel

CAM_F_EMPGIDTOL Inter-DAS gamma check tolerance (n-sigma)

CAM_F_EMPNIDTOL Inter-DAS neutron check tolerance (n-sigma)

CAM_F_EMPNPHIT Totals sigma multiplier

CAM_F_EMPNPHIR Reals sigma multiplier

CAM_F_EMPNPHIA Accidentals sigma multiplier

CAM_F_EMPNPHIT2G T2G sigma multiplier

631
CAM Files

ASDEM Parameters
CAM_X_MAXCOUNT Maximum “uncompressed” count period (tmax)

CAM_L_DASMINPTS Minimum number of measurements included in

neutron global packet (N)

CAM_F_DASNEPT Neutron event page’s test threshold (h)

CAM_F_DASNEPDP Neutron event page’s test damping parameter

(delta)

CAM_F_DASNBPT Neutron background page’s test threshold

(h-star)

CAM_F_DASNBPDP Neutron background page’s test damping param-

eter (delta-star)

CAM_L_DASMTTPTS Number of points used for MTT (r)

CAM_F_DASMTTTHR MTT test threshold (beta)

CAM_L_DASVMTTPTS Number of points used for MTT verification

(r-prime)

CAM_F_DASVMTTTHR MTT verification test threshold (beta-prime)

CAM_L_DASSTBPTS Number of points used for stability test (r-star)

CAM_L_DASSTBXPTS Number of extra points used in stability test (q)

CAM_F_DASSTBMULT Stability test multiplier (alpha)

CAM_F_DASBCMPMULT Multiplier used in background comparison test

CAM_L_DASTMAXPTS Number of statistics points used after tmax (na)

CAM_F_DASSIGMULT Sigma estimate multiplier (phi)

CAM_L_DASGSTART Gamma background sum start channel

CAM_L_DASGEND Gamma background sum end channel

CAM_X_DASGCNTTIM Gamma statistics count time

CAM_L_DASGMINPTS Minimum number of measurements included in

gamma global packet (N)

CAM_F_DASGEPT Gamma event page’s test threshold (h)

CAM_F_DASGEPDP Gamma event page’s test damping parameter

(delta)

632
 Safeguards Parameters

CAM_F_DASGDTT Gamma event acquisition start/end dead time

threshold (%)

CAM_L_DASGTMAXPTS Number of statistics points used after gamma

tmax

CAM_F_DASGSIGMULT Gamma sigma estimate multiplier (phi)

Neutron Detector Parameters

CAM_F_NEFFMULT Neutron efficiency multiplier

CAM_F_DNEFFMULT Uncertainty in neutron efficiency multiplier

CAM_F_DETDTDEL1 Detector dead time totals correction factor 1

CAM_F_DETDTDEL2 Detector dead time totals correction factor 2

CAM_F_DETDTDEL3 Detector dead time reals correction factor 1

CAM_F_DETDTDEL4 Detector dead time reals correction factor 2

Neutron Analysis Parameters

CAM_F_ENSROZERO Ensslin Rho zero factor

CAM_F_ENSNEUTMULT Ensslin neutron multiplicity factor (KE)

CAM_F_ENSRTCORR Reals/Totals Correlation

Generic Flags Parameters

CAM_L_DASFLAGS DAS flags field

CAM_M_DASF_COMPRESS Compress neutron data

[CAM_L_DASFCOMPRESS]

CAM_M_DASF_USENEUT Acquire neutron data

[CAM_L_DASFUSENEUT]

CAM_M_DASF_USEGAMMA Acquire gamma data

[CAM_L_DASFUSEGAMMA]

CAM_M_DASF_USESENS Acquire sensor data

[CAM_L_DASFUSESENS]

CAM_M_DASF_USESWD Use software watchdog

[CAM_L_DASFUSESWD]

CAM_M_DASF_PRIMARY Primary DAS

[CAM_L_DASFPRIMARY]

633
CAM Files

CAM_M_DASF_CCADC Computer controlled ADC

[CAM_L_DASFCCADC]

CAM_M_DASF_SUMGAM Sum gamma spectra from adjacent objects

[CAM_L_DASFSUMGAM]

Special Uses Parameters

The “special uses” parameter block contains both common and record type parameters.
This block is used by Canberra for custom software packages and is also available for
customer use. The symbolic name for this class is CAM_CLS_SPECIAL.

Common Parameters
CAM_L_SUCINTn Common Integer n, where n is 1 to 8

CAM_F_SUCREALn Common Real n, where n is 1 to 8

CAM_T_SUCSTRING1 Common String 1 (255 characters)

CAM_T_SUCSTRING2 Common String 2 (255 characters)

CAM_T_SUCSTRING3 Common String 3 (255 characters)

CAM_T_SUCSTRING4 Common String 4 (255 characters)

CAM_T_SUCSTRING5 Common String 5 (16 characters)

CAM_T_SUCSTRING6 Common String 6 (16 characters)

CAM_T_SUCSTRING7 Common String 7 (16 characters)

CAM_T_SUCSTRING8 Common String 8 (16 characters)

CAM_T_SUCSTRING9 Common String 9 (256 characters)

CAM_T_SUCSTRING10 Common String 10 (32 characters)

CAM_T_SUCSTRING11 Common String 11 (32 characters)

CAM_T_SUCSTRING12 Common String 12 (16 characters)

CAM_T_SUCSTRING13 Common String 13 (16 characters)

CAM_X_SUCDATEn Common Date/Time n, where n is 1 to 3

CAM_X_SUCTIMEn Common elapsed time n, where n is 1 to 3

634
 MCS Parameters

CAM_L_SUCFLAGS Common Flags Field

CAM_M_SUCF_FLAGn Common Flag Bit n, where n is 0 to 4

[CAM_L_SUCFLAGn]

Record Parameters
CAM_L_SURINTn Record Integer n, where n is 1 to 8

CAM_F_SURREALn Record Real n, where n is 1 to 12

CAM_T_SURSTRING1 Record String 1 (255 characters)

CAM_T_SURSTRING2 Record String 2 (255 characters)

CAM_T_SURSTRING3 Record String 3 (16 characters)

CAM_T_SURSTRING4 Record String 4 (16 characters)

CAM_T_SURSTRING5 Record string 5 (16 characters)

CAM_T_SURSTRING6 Record string 6 (16 characters)

CAM_T_SURSTRING7 Record string 7 (32 characters)

CAM_T_SURSTRING8 Record string 8 (32 characters)

CAM_T_SURSTRING9 Record string 9 (32 characters)

CAM_T_SURSTRING10 Record string 10 (32 characters)

CAM_T_SURSTRING11 Record string 11 (64 characters)

CAM_T_SURSTRING12 Record string 12 (64 characters)

CAM_X_SURTIMEn Record elapsed time n, where n is 1 to 4

CAM_X_SURDATEn Record date/time n, where n is 1 to 4

CAM_L_SURFLAGS Record Flags Field

CAM_M_SURF_FLAGn Record Flag Bit n, where n is 0 to 6

[CAM_L_SURFLAGn]

MCS Parameters
The MCS data block is composed of common parameters used to define the overall oper-
ation of the software MCS function and record parameters which define the ROIs being

635
CAM Files

monitored. The actual MCS data is stored as normal spectral data. The symbolic name for
this class is CAM_CLS_MCSDATA.

Common Parameters
CAM_F_MCSCDWELL Dwell time

CAM_T_MCSCDSRC Dwell source (4 characters –

LIVE/REAL/EXTN)

CAM_L_MCSCCHANS Number of MCS channels

CAM_L_MCSCCACHESIZ Number of MCS advances to cache before flush

to disk

CAM_L_MCSCFLAGS MCS flags longword

CAM_L_MCSCEXTADV External advance flag

CAM_L_MCSCCPSALRM Alarm level (cps) exceeded

CAM_L_MCSCPTIMEX Processing time exceeded dwell time

Record Parameters
CAM_T_MCSCRGNDESC Region description string (32 characters)

CAM_F_MCSCRSTART Start of region (in keV)

CAM_F_MCSCREND End of region (in keV)

CAM_F_MCSCCPSLEV Alarm level (cps)

CAM_F_MCSCGAIN MCS Gain term

CAM_F_MCSCOFFSET MCS Offset term

CAM_T_MCSCUNITS MCS units (4 characters)

CAM_L_MCSCRFLAGS Region flags longword

CAM_L_MCSCNET Gross (0) or Net (1) counts

636
 K-Edge Calibration Parameters

K-Edge Calibration Parameters

The K-Edge Calibration parameters block contains calibration information for a K-Edge
instrument station. The symbolic name for this class is CAM_CLS_KEDCAL.

CAM_T_KCDESCRIP Calibration description (64 characters)

CAM_X_KCCALTIME Calibration time

CAM_F_KCDELMU1 Delta mu for element 1 across the k-edge

CAM_F_KCDELMU2 Delta mu for element 2 across the k-edge

CAM_F_KCDELMU12 Delta mu for element 1 across element 2 k-edge

CAM_F_KCDELMU21 Delta mu for element 2 across element 1 k-edge

CAM_F_KCDELMUX1 Delta mu for element 1 at the k-edge

CAM_F_KCDELMUX2 Delta mu for element 2 at the k-edge

CAM_F_KCPATHLEN Path length/diameter of sample container (cm)

CAM_T_KCANALYST Calibration analyst’s name (16 characters)

K-Edge Analysis Results Parameters

The K-Edge Analysis Result parameters block contains the analysis results from a single
assay performed by a K-Edge instrument. Results from both k-edge and XRF detectors
are stored. The symbolic name for this class is CAM_CLS_KEDRES.

CAM_L_KRFLAGS K-edge analysis results flags

CAM_M_KRF_KEDDONE K-edge analysis done

[CAM_L_KRFKEDDONE]

CAM_T_KRANALVERS Analysis engine(s) version (64 characters)

CAM_T_KRPROTOCOL Analysis protocol (64 characters)

CAM_F_KRREFCH1 Reference peak 1 channel

CAM_F_KRREFCH2 Reference peak 2 channel

CAM_F_KRCONC1 Element 1 concentration (g/L)

CAM_F_KRCONC1ERR Error in element 1 concentration

637
CAM Files

CAM_F_KRCONC2 Element 2 concentration (g/L)

CAM_F_KRCONC2ERR Error in element 2 concentration

CAM_F_KRXCONC1 Extrapolated element 1 concentration (g/L)

CAM_F_KRXCONC1ERR Error in extrapolated element 1 concentration

CAM_F_KRXCONC2 Extrapolated element 2 concentration (g/L)

CAM_F_KRXCONC2ERR Error in extrapolated element 2 concentration

CAM_F_KRACONC1 Average element 1 concentration (g/L)

CAM_F_KRACONC1SD Standard deviation of average element 1 concen-

tration

CAM_F_KRACONC2 Average element 2 concentration (g/L)

CAM_F_KRACONC2SD Standard deviation of average element 2 concen-

tration

CAM_F_KRCONC1RAT Ratio of reference concentration to measured

concentration for element 1

CAM_F_KRCONC1RATER Error in ratio of reference concentration to mea-

sured concentration for element 1

CAM_F_KRCONC2RAT Ratio of reference concentration to measured

concentration for element 2

CAM_F_KRCONC2RATER Error in ratio of reference concentration to mea-

sured concentration for element 2

CAM_F_KRKED1CH 1st element’s k-edge position (in channels)

CAM_F_KRKED2CH 2nd element’s k-edge position (in channels)

CAM_F_KRREF1FWHM FWHM (in keV) of reference peak 1

CAM_F_KRREF2FWHM FWHM (in keV) of reference peak 2

CAM_F_KRTOTALCPS Total count rate (cps)

CAM_F_KRHVCUTOFF HVPS cutoff energy (keV)

CAM_F_KRSPNORMFAC Spectrum normalization factor

CAM_F_KRTEMPCORFAC Temperature correction factor

CAM_F_KRROI1OFF ROI 1 fit offset

CAM_F_KRROI1OFFERR Error in ROI 1 fit offset

638
 Neutron Multiplicity Data

CAM_F_KRROI1SLOPE ROI 1 fit slope

CAM_F_KRROI2OFF ROI 2 fit offset

CAM_F_KRROI2OFFERR Error in ROI 2 fit offset

CAM_F_KRROI2SLOPE ROI 2 fit slope

CAM_F_KRROI3OFF ROI 3 fit offset

CAM_F_KRROI3OFFERR Error in ROI 3 fit offset

CAM_F_KRROI3SLOPE ROI 3 fit slope

CAM_F_KRROI4OFF ROI 4 fit offset

CAM_F_KRROI4OFFERR Error in ROI 4 fit offset

CAM_F_KRROI4SLOPE ROI 4 fit slope

Neutron Multiplicity Data

This class records multiplicity data acquired from neutron shift registers. The data from
each measurement run or cycle is contained in a record. At the start of each record are the
reals and accidentals counts based on the multiplicity histogram, and the raw totals of the
histogram. Then there are record tabular entries for each non-zero bin of the multiplicity
histogram. There should be a one-to-one relationship between the records in this block
and the records in the Neutron Acquisition/Results block. The symbolic name for the
class is CAM_CLS_NEUTMULTI.

Common Parameters
CAM_L_NMULTFLAGS Multiplicity flags

CAM_M_NMULTF_INT Bin data stored as integer values in

[CAM_L_NMULTINT] CAM_L_NMULTBINVAL; otherwise,
probability values are stored in
CAM_F_NMULTPROB

CAM_M_NMULTF_LSTMODE Histograms derived from list mode data

[CAM_L_NMULTFLSTMOD]

CAM_L_NMULTTRUNCL Multiplicity histogram truncation level

CAM_L_NMULTLSTHTYPE List mode histogram type: 0 = signal triggered, 1

= random triggered

CAM_F_NMULTLSTFREQ List mode random trigger frequency

639
CAM Files

Record Parameters
CAM_F_NMULTACCS Accidentals count based on the multiplicity his-
togram

CAM_F_NMULTRAS Reals+accidentals count based on the multiplic-

ity histogram

CAM_F_NMULTATOT Accidentals multiplicity histogram total

CAM_F_NMULTRATOT Reals+accidentals multiplicity histogram total

CAM_F_NMULTRATRUNC Fraction of the total area remaining in the

reals+accidentals histogram after truncation

CAM_F_NMULTATRUNC Fraction of the total area remaining in the

accidentals histogram after truncation

NMULTNUMROAL Number of record tabular entries used for

Rossi-Alpha distribution

NMULTNUMFEYN Number of record tabular entries used for

Feynman distribution

Record Tabular Parameters

CAM_F_NMULTPROB The probability of multiplicity I (note that either
NMULTPROB or NMULTBINVAL are used,
depending on NMULTINT)

CAM_L_NMULTBINVAL Multiplicity bin i value

CAM_L_NMULTBINNO The i th multiplicity histogram bin number

Add-a-Source Calibration Parameters

This class describes the results of an Add-a-Source calibration for an active neutron
counter. For a description of the Add-a-Source technique, see the Genie Neutron Assay
Software Technical Reference Manual. The symbolic name for this class is CAM Class
CAM_CLS_AASCALIB.

Common Parameters
CAM_L_AASFLAGS Add-a-Source Flags

CAM_L_AASCALDONE Add-a-source calibration done

[CAM_M_AASF_CALDONE]

640
 Add-a-Source Calibration Parameters

CAM_M_AASF_NSIGREJ Add-a-Source correction factor failed due to

[CAM_L_AASNSIGREJ] N-sigma rejection

CAM_M_AASF_FAILED Add-a-Source correction failed

[CAM_L_AASFAILED]

CAM_M_AASF_NOAASFILE AAS file not found

[CAM_L_AASNOASSFILE]

CAM_M_AASF_NOREFFILE AAS reference file not found

[CAM_L_AASNOREFFILE)]

CAM_M_AASF_CFLTUNITY AAS CF less than unity

[CAM_L_AASCFLTUNITY)]

CAM_M_AASF_CFCLAMPED AAS CF clamped to unity

[CAM_L_AASCFCLAMPED]

CAM_M_AASF_LOWHIGHLIM AAS perturbation lower than lower lim or

[CAM_L_AASLOWHIGHLM] higher than high limit

CAM_X_AASCALDATE Add-a-source calibration date

CAM_T_AASANALYST Calibration analyst’s name (16 characters)

CAM_T_AASDETNAME Counter name (16 characters)

CAM_T_AASCURVEID Calibration curve ID (16 characters)

CAM_T_AASCONTAINER Container name (for which this calibration is

valid) (16 characters)

CAM_F_AASREAAZERO Reals calibration polynomial offset

CAM_F_AASREAAONE Reals calibration polynomial slope

CAM_F_AASREAATWO Reals calibration polynomial quadratic

CAM_F_AASREAATHREE Reals calibration polynomial cubic

CAM_F_AASTOTAZERO Totals calibration polynomial offset

CAM_F_AASTOTAONE Totals calibration polynomial slope

CAM_F_AASTOTATWO Totals calibration polynomial quadratic

CAM_F_AASTOTATHREE Totals calibration polynomial cubic

CAM_F_AASREAVAR00 Reals calibration offset error

CAM_F_AASREAVAR11 Reals calibration slope error

641
CAM Files

CAM_F_AASREAVAR22 Reals calibration quadratic error

CAM_F_AASREAVAR33 Reals calibration cubic error

CAM_F_AASREAVAR01 Reals calibration offset and slope covariance

CAM_F_AASREAVAR02 Reals calibration offset and quadratic covariance

CAM_F_AASREAVAR12 Reals calibration slope and quadratic covariance

CAM_F_AASREAVAR13 Reals calibration slope and cubic covariance

CAM_F_AASREAVAR23 Reals calibration quadratic and cubic covariance

CAM_F_AASTOTVAR00 Totals calibration offset error

CAM_F_AASTOTVAR11 Totals calibration slope error

CAM_F_AASTOTVAR22 Totals calibration quadratic error

CAM_F_AASTOTVAR33 Totals calibration cubic error

CAM_F_AASTOTVAR01 Totals calibration offset and slope covariance

CAM_F_AASTOTVAR02 Totals calibration offset and quadratic

covariance

CAM_F_AASTOTVAR03 Totals calibration offset and cubic covariance

CAM_F_AASTOTVAR12 Totals calibration slope and quadratic

covariance

CAM_F_AASTOTVAR13 Totals calibration slope and cubic covariance

CAM_F_AASTOTVAR23 Totals calibration quadratic and cubic

covariance

CAM_F_AASTLOWLIM Totals calibration low mass limit

CAM_F_AASTHIGHLIM Totals calibration high mass limit

CAM_F_AASRLOWLIM Reals calibration low mass limit

CAM_F_AASRHIGHLIM Reals calibration high mass limit

CAM_F_AASREAARCHI Reals calibration reduced chi-square

CAM_F_AASTOTARCHI Totals calibration reduce chi-square

CAM_T_AASHZEFFDBR High-Z efficiency calibration database record ID

CAM_T_AASHZBCKDBR High-Z background calibration database record

ID

642
 Add-a-Source Calibration Parameters

CAM_T_AASCALDBR Add-a-Source calibration database record

CAM_F_AASREFTOT AaSreferencetotalsrate

CAM_F_AASREFTOTER AaSreferencetotalsrateerror

CAM_F_AASREFREAL AaSreferencerealsrate

CAM_F_AASREFREALER AaSreferencerealsrateerror

CAM_X_AASREFSTIME AaSreferenceacquisitiondate

CAM_F_AASDCREFTR Decay-corrected reference totals rate

CAM_F_AASDCREFTRE Error in decay-corrected reference totals rate

CAM_F_AASDCREFRR Decay-corrected reference reals rate

CAM_F_AASDCREFRRE Error in decay-corrected reference reals rate

CAM_F_AASXHZBFELIN High-Z Background triples mass calibration lin-

ear term for iron (cps/kg)

CAM_F_AASXHZBFEV11 High-Z Background triples mass calibration

variance for iron (cps/kg)

CAM_F_AASXHZBPBLIN High-Z Background triples mass calibration lin-

ear term for lead (cps/kg)

CAM_F_AASXHZBPBV11 High-Z Background triples mass calibration

variance for lead (cps/kg)

CAM_F_AASHZBFERXCV High-Z Background Doubles Triples mass cali-

bration for iron (cps/kg)

CAM_F_AASREALSCF Add-a-Source reals correction factor

CAM_F_AASREALSCFER Uncertainty in reals correction factor

CAM_F_AASREALSCFZ Reals correction factor to the Z power

CAM_F_AASTOTLSCF Add-a-Source totals correction factor

CAM_F_AASTOTLSCFER Uncertainty in totals correction factor

CAM_F_AASTOTALSCFZ Totals background reduction correction factor

Record Parameters
CAM_F_AASREACALXR Reals absorption perturbation

CAM_F_AASTOTCALXR Totals absorption perturbation

643
CAM Files

CAM_F_AASREACALXRE Error in reals absorption perturbation

CAM_F_AASTOTCALXRE Error in totals absorption perturbation

CAM_F_AASREACALYR Reals volume perturbation

CAM_F_AASTOTCALYR Totals volume perturbation

CAM_F_AASREACALYRE Error in reals volume perturbation

CAM_F_AASTOTCALYRE Error in totals volume perturbation

CAM_T_AASRPNTFILE Add-a-source calibration point file (96 charac-

ters)

CAM_X_AASRPNTDATE Add-a-source calibration point file date

CAM_T_AASREFFILE AAS reference drum file name (128 characters)

CAM_T_AASMATFILE AAS matrix drum file name (128 characters)

CAM_T_VOLREFFILE Volume reference drum file name (128 charac-

ters)

CAM_T_VOLMATFILE Volume matrix drum file name (128 characters)

ASTM Mass Calibration Parameters

This class stores count rate to isotopic mass calibration data used by the ASTM Mass cal-
culation engine. The information in this class describes a single combination of materials
(i.e., nuclides) in a matrix. Each record in the class describes a nuclide; each record has a
variable number of tabular entries, each of which indicates the measured count rate seen
for a given nuclide mass. Symbolic name CAM_CLS_ASTMCAL.

Common Parameters
CAM_T_ASTMCALMATER Material type (64 characters)

CAM_T_ASTMCALMATRX Matrix type (32 characters)

CAM_X_ASTMCALDATE Calibration date/time

CAM_T_ASTMCANALYST Calibration analyst’s name (16 characters)

Record Parameters
CAM_T_ASTMCNUCLIDE Nuclide name (8 characters)

CAM_F_ASTMCENERGY Peak energy line used for this nuclide

644
 ASTM Mass Calibration Parameters

CAM_F_ASTMCLOMASS Low mass limit (grams) of curve validity

CAM_F_ASTMCHIMASS High mass limit (grams) of curve validity

CAM_F_ASTMCOFF Calibration curve offset

CAM_F_ASTMCSLOPE Calibration curve slope

CAM_F_ASTMCQUAD Calibration curve quadratic term

CAM_F_ASTMCOFFVAR Variance in calibration curve offset

CAM_F_ASTMCSLOPEV Variance in calibration curve slope

CAM_F_ASTMCQUADVAR Variance in calibration curve quadratic

CAM_F_ASTMCOSCOV Calibration curve offset-slope covariance

CAM_F_ASTMCOQCOV Calibration curve offset-quadratic covariance

CAM_F_ASTMCSQCOV Calibration curve slope-quadratic covariance

CAM_L_ASTMCORDER Order of the curve polynomial for this nuclide

CAM_L_ASTMCNFLAGS Per nuclide flags

CAM_L_ASTMCFZERO Force fit through zero

Record Tabular Entry

CAM_F_ASTMCMASS Declared reference mass (grams)

CAM_F_ASTMCMASSERR Error in declared mass

CAM_F_ASTMCRATE Measured count rate

CAM_F_ASTMCRATEERR Error in measured count rate

CAM_F_ASTMCDCRATE Decay corrected count rate

CAM_F_ASTMCDCRATEE Error in decay corrected count rate

CAM_L_ASTMCSEQNUM Sequence number of the calibration measure-

ment; if 0, the data was entered manually

CAM_L_ASTMCMFLAGS Flags

CAM_M_ASTMCM_REJECT This mass measurement has been rejected

645
CAM Files

Peak-to-Total Calibration
This class stores the peak-to-total calibration coefficients. The symbolic name for this
class is: CAM_CLS_PTCALIB.

Common Parameters
CAM_T_PTCVERS PT Calibration version (16 characters)

CAM_X_PTCALDATE Peak-to-total calibration date

CAM_F_PTCCROSSOVER Polynomial crossover energy

CAM_L_PTCLDEGREE Degree of low energy polynomial

CAM_L_PTCHDEGREE Degree of high energy polynomial

CAM_F_PTCLCALFAC1 Low energy offset

CAM_F_PTCLCALFAC2 Low energy slope

CAM_F_PTCLCALFAC3 Low energy quadratic term

CAM_F_PTCLCALFAC4 Low energy cubic term

CAM_F_PTCLCALFAC5 Low energy 4th order term

CAM_F_PTCLCALFAC6 Low energy 5th order term

CAM_F_PTCLCALCHI Low energy fit chi-square

CAM_F_PTCHCALFAC1 High energy offset

CAM_F_PTCHCALFAC2 High energy slope

CAM_F_PTCHCALFAC3 High energy quadratic term

CAM_F_PTCHCALFAC4 High energy cubic term

CAM_F_PTCHCALFAC5 High energy 4th order term

CAM_F_PTCHCALFAC6 High energy 5th order term

CAM_F_PTCHCALFAC7 High energy 6th order term

CAM_F_PTCHCALFAC8 High energy 7th order term

CAM_F_PTCHCALFAC9 High energy 8th order term

CAM_F_PTCHCALFAC10 High energy 9th order term

CAM_F_PTCHCALCHI High energy fit chi-square

646
 Coincidence Summing Library

CAM_G_PTCLERRMATn Low energy error matrix n, where n is 1 to 11

CAM_G_PTCHERRMATn High energy error matrix n, where n is 1 to 19

Record Parameters
CAM_F_PTCENERGY PT Energy

CAM_F_PTCEFF PT Efficiency (absolute)

CAM_F_PTCDEFF Uncertainty in PT efficiency

Coincidence Summing Library

This class stores the basic information for each line to be considered in coincident sum-
ming correction.The symbolic name for this class is: CAM_CLS_COILIB.

Common Parameters
CAM_T_COILIBVERS Library version

Record parameters
CAM_F_COILENERGY Line energy

CAM_L_COILCODE Line identifier

CAM_F_COILBRANCH Line abundance (%)

CAM_F_COILCONVER Internal conversion correction factor

CAM_F_COILYIELD Line yield (%)

CAM_L_COILFLAGS Flags

CAM_M_COILF_INVOLVED True if involved in a cascade

Coincidence Summing Chain Library

This class contains information describing energy line cascades. The symbolic name for
this class is: CAM_CLS_COICHAIN.

647
CAM Files

Record parameters
CAM_L_COICCODE Line identifier

CAM_F_COICL0 Energy of line for which summing effect is ob-

served

CAM_F_COICL1 Energy of line composing the summing

in/out/sum chain

CAM_F_COICL2 Energy of line composing the summing

in/out/sum chain

CAM_F_COICL3 Energy of line composing the summing

in/out/sum chain

CAM_F_COICL4 Energy of line composing the summing

in/out/sum chain

CAM_F_COICL5 Energy of line composing the summing

in/out/sum chain

CAM_L_COICTYPE Type of line: 0=summing in, 1=summing out,

2=subcascade

Passive Neutron TMU Analysis Results

These parameters store the results of TMU analysis of passive neutron assay results data.
The TMU analysis essentially incorporates additional factors in the calculation of uncer-
tainties. In addition, values required for WIPP are calculated. The symbolic name for the
class is CAM_CLS_NEUTTMU.

Common Parameters
CAM_L_WNRFLAGS Flags

CAM_L_WNRFDATAAVL Results can be used

CAM_L_WNRFDONE TMU analysis has been performed

CAM_L_WNRFDREVIEW If true, expert data review is required

CAM_L_WNRRVWFLG0 Data validity test failed: Add-a-Source CF

< lower calibration limit

CAM_L_WNRRVWFLG1 Data validity test failed: Add-a-Source CF

> upper calibration limit

CAM_L_WNRRVWFLG2 Data validity test failed: Add-a-Source CF

> upper warning level 1

648
 Passive Neutron TMU Analysis Results

CAM_L_WNRRVWFLG3 Data validity test failed: Add-a-Source CF

> upper warning level 2

CAM_L_WNRRVWFLG4 Data validity test failed: 239Pu calibration

> upper limit

CAM_L_WNRRVWFLG5 Data validity test failed: 239Pu calibration

< lower limit

CAM_L_WNRRVWFLG6 Data validity test failed: Cf or Cm detected

but not analyzed

CAM_L_WNRRVWFLG7 Error in Add-a-Source CF > upper limit

CAM_L_WNRRVWFLG8 Data validity test failed: too many cycles re-

jected

CAM_L_WNRRVWFLG9 Data validity test failed: maximum FGE ex-

ceeded

CAM_L_WNRSTATUS Engine error status: if 0, no error

CAM_T_WNRVERSION Engine version identification string

CAM_F_WNRBKGERR Background effect error (1-sigma relative)

CAM_F_WNRMLTERR Maximum multiplication error (1-sigma relative)

CAM_F_WNRPTERR Matrix-source distribution error (1-sigma rela-

tive)

CAM_F_WNRRMIN Rmin

CAM_F_WNRRMAX Rmax

CAM_F_WNRAACT Total alpha activity

CAM_F_WNRAACTERR 1-sigma absolute uncertainty in Total alpha ac-

tivity

CAM_F_WNRTRUACT TRU Activity

CAM_F_WNRTRUACTERR 1-sigma absolute uncertainty in TRU activity

CAM_F_WNRDHEAT Decay heat

CAM_F_WNRDHEATERR 1-sigma absolute uncertainty in decay heat

239
CAM_F_WNRFGE Pu Fissile Gram Equivalent

CAM_F_WNRFGEERR 1-sigma absolute uncertainty in FGE

649
CAM Files

CAM_F_WNRFGEMDA FGE MDA (grams)

CAM_L_WNRWCLASS 0 if the item is considered LLW; non-zero other-

wise

CAM_F_WNRPUMDA Pu MDA (note: this is Pu, not 240Pu)

CAM_F_WNRPUMDAERR 1-sigma absolute uncertainty in Pu mass MDA

(see note 3 on page 504)

CAM_F_WNRPUMASS Pu mass

CAM_F_WNRPUMASSERR 1-sigma absolute uncertainty in Pu mass

CAM_F_WNRUMASS U mass (see note 3 on page 504)

CAM_F_WNRUMASSERR 1-sigma absolute uncertainty in U mass (see

note 3 on page 504)
239
CAM_F_WNRPU239EA Pu equivalent activity

CAM_F_WNRPU239EAER 1-sigma absolute uncertainty in 239Pu EA

Record Parameters
There is one record per isotope.

CAM_T_WNRISONAME Isotope name (8 characters)

CAM_F_WNRISOACT Isotope activity

CAM_F_WNRISOACTERR 1-sigma absolute uncertainty in activity

CAM_L_WNRISOACTSRC Source of isotope activity: 0 = none, 1 = isotopic

ratio

CAM_F_WNRISOMDA Isotope MDA

CAM_F_WNRISOMDAERR 1-sigma absolute uncertainty in the MDA (see

note 3 on page 504)

CAM_F_WNRSPECACT Isotope specific activity (µCi/g)

Gamma TMU Analysis

These parameters store the results of TMU analysis of quantitative gamma assay results
data. The TMU analysis essentially incorporates additional factors in the calculation of
uncertainties. In addition, values required for WIPP are calculated. The symbolic name
for the class is CAM_CLS_GAMMATMU.

650
 Gamma TMU Analysis

Common Parameters
CAM_L_WGRFLAGS Flags

CAM_L_WGRFPDATAAVL Set if Pu results can be used (i.e., clear if Pu

results are suspect)

CAM_L_WGRFUDATAAVL Set if U results can be used (i.e., clear if U

results are suspect)

CAM_L_WGRFDONE Set if engine has executed

CAM_L_WGRFDREVIEW Set if expert review is suggested

CAM_L_WGRFFNIDENT Set if NID identified the fiducial nuclide

CAM_L_WGRFPUIDENT Set if 239Pu identified

CAM_L_WGRFUIDENT Set if 235U identified

CAM_L_WGRRVWFLG0 Data validity flag: density too high

CAM_L_WGRRVWFLG1 Data validity flag: deadtime too high

CAM_L_WGRRVWFLG2 Data validity flag: 233U too high

CAM_L_WGRRVWFLG3 Data validity flag: 235U too high

CAM_L_WGRRVWFLG4 Data validity flag: U mass too high

CAM_L_WGRRVWFLG5 Data validity flag: 414/129 activity ratio too

high

CAM_L_WGRRVWFLG6 Data validity flag: 239Pu too high

CAM_L_WGRRVWFLG7 Data validity flag: Pu mass too high

CAM_L_WGRRVWFLG8 Data validity flag: spectrum validity test

failed

CAM_L_WGRRVWFLG9 Data validity flag: 239Pu/241Am ratio too low

CAM_L_WGRRVWFLG10 Data validity flag: 239Pu/237Np ratio too low

CAM_L_WGRRVWFLG11 Data validity flag: maximum FGE exceeded

137
CAM_L_WGRFCSNOINTF Cs interference test performed: no interfer-
ence detected
137
CAM_L_WGRFCSAMINTF Cs interference test performed: Am inter-
ference detected

651
CAM Files

CAM_L_WGRSTATUS Engine error code; 0 if none

CAM_T_WGRVERSION Engine version string (16 characters)

CAM_F_WGRSRCERR 1-sigma relative uncertainty due to source

non-uniformity

CAM_F_WGRLUMPERR 1-sigma relative uncertainty due to lumps

CAM_F_WGRAACT Total alpha activity

CAM_F_WGRAACTERR 1-sigma absolute uncertainty in total alpha activity

CAM_F_WGRTRUACT TRU activity

CAM_F_WGRTRUACTERR 1-sigma absolute uncertainty in TRU activity

239
CAM_F_WGRFGE Pu fissile gram equivalent (FGE)

CAM_F_WGRFGEERR 1-sigma absolute uncertainty in FGE

CAM_F_WGRFGEMDA FGE MDA (grams)

CAM_F_WGRDHEAT Decay heat

CAM_F_WGRDHEATERR 1-sigma absolute uncertainty in decay heat

CAM_F_WGRPUMASS Pu mass

CAM_F_WGRPUMASSERR 1-sigma absolute uncertainty in Pu mass

CAM_F_WGRUMASS U mass (see note 3 on page 504)

CAM_F_WGRUMASSERR 1-sigma absolute uncertainty in U mass (see

note 3 on page 504)
239
CAM_F_WGRPU239EA Pu equivalent activity (PE)

CAM_F_WGRPU239EAER 1-sigma absolute uncertainty in PE

CAM_F_WGRRMAX The ratio of maximum system response to vol-

ume averaged response

CAM_F_WGRRMIN The ratio of minimum system response to vol-

ume averaged response

CAM_L_WGRWCLASS 0 if the item is considered LLW; non-zero other-

wise

Record Parameters
CAM_T_WGRTMUNAME Nuclide name(8 characters)

652
 Multi-Modality Results Combination Parameters

CAM_F_WGRTMUACT Activity

CAM_F_WGRTMUACTERR 1-sigma absolute uncertainty in activity

CAM_L_WGRTMUACTSRC Source of isotope activity: 0 = none, 1 = isotopic

ratio, 2 = gamma activity, 3 = derived activity

CAM_F_WGRTMUMDA MDA

CAM_F_WGRTMUMDAERR 1-sigma absolute uncertainty in MDA (see note

3 on page 504)

CAM_F_WGRSPECACT Specific activity for nuclide (µCi/g)

Multi-Modality Results Combination Parameters

This class contains the results of the multi-modality results combination engine, which
combines the results of the quantitative gamma, passive neutron coincidence, and DDA
TMU engines.

The symbolic name for the class is CAM_CLS_MMCOMBO

CAM_L_MCRFLAGS Flags

CAM_M_MCRF_DONE Combination analysis has been performed

[CAM_L_MCRFDONE]

CAM_M_MCRF_REVIEW Expert data review is suggested

[CAM_L_MCRFREVIEW]

CAM_M_MCRF_RESCOMPF Results comparison test failed

[CAM_L_MCRFRESCOMPF]

CAM_L_MCRFFGEMAX Maximum FGE exceeded

[CAM_M_MCRF_MAXFGE]

CAM_M_MCRF_GFNNOTID The fiducial nuclide was not identified by

gamma analysis

CAM_T_MCRVERSION Engine version identification (16 characters)

CAM_L_MCRSTATUS Engine error status: if 0, no error

CAM_L_MCRINPCOMB Data available combination

653
CAM Files

CAM_L_MCROUTCOMB Source of results from this engine: 0 = unde-

fined, 1 = passive neutron, 2 = quantitative
gamma, 3 = DDA, 4 = passive neutron Pu +
quantitative gamma U

CAM_F_MCRPUMASS Pu mass

CAM_F_MCRPUMASSERR 1-sigma absolute uncertainty in Pu mass

CAM_F_MCRUMASS U mass (see note 3 on page 504)

CAM_F_MCRUMASSERR 1-sigma absolute uncertainty in U mass (see

note 3 on page 504)
239
CAM_F_MCRFGE Pu Fissile Gram Equivalent

CAM_F_MCRFGEERR 1-sigma absolute uncertainty in FGE

CAM_F_MCRFGEMDA FGE MDA (grams)

CAM_F_MCRTRUACT TRU Activity

CAM_F_MCRTRUACTERR 1-sigma absolute uncertainty in TRU activity

CAM_F_MCRAACT Total alpha activity

CAM_F_MCRAACTERR 1-sigma absolute uncertainty in Total alpha ac-

tivity
239
CAM_F_MCRPU239EA Pu equivalent activity

CAM_F_MCRPU239EAER 1-sigma absolute uncertainty in 239Pu EA

CAM_F_MCRDHEAT Decay heat

CAM_F_MCRDHEATERR 1-sigma absolute uncertainty in decay heat

CAM_L_MCRWCLASS 0 if the item is considered LLW; non-zero other-

wise

Record Parameters
CAM_T_MCRISONAME Isotope name (8 characters)

CAM_F_MCRISOACT Isotope activity

CAM_F_MCRISOACTERR 1-sigma absolute uncertainty in activity

CAM_L_MCRISOACTSRC Source of isotope activity: 0 = none, 1 = isotopic

ratio, 2 = gamma activity, 3 = derived activity

CAM_F_MCRISOMDA Isotope MDA

654
 Differential Dieaway Analysis Results
Parameters

CAM_F_MCRISOMDAERR 1-sigma absolute uncertainty in the MDA (see

note 3 on page 504)

CAM_F_MCRSPECACT Isotope specific activity

Differential Dieaway Analysis Results Parameters

This class contains the results of Differential Dieaway Analysis (DDA); the symbolic
name for the class is CAM_CLS_DDARESULTS. This is an active neutron assay tech-
nique that uses interrogating neutrons from a pulsed generator to induce fission in the
measured item. The data is collected using multichannel analyzers in MCS mode.

This class is organized as follows:

• Common parameters: Store the results of the DDA mass analysis.

• Record parameters: There is one record per source of data (bare detectors,
shielded detectors, chamber flux monitor, barrel flux monitor), storing the net
count rate.
• Record tabular parameters: There is one tabular entry per gate, storing the gate
start and end times/channels and total count rate.

Common Parameters
CAM_L_DDAFLAGS DDA analysis Flags

CAM_M_DDAF_MASSTL Lower equivalent mass limit violated

[CAM_L_DDAFMASSTL]

CAM_M_DDAF_MASSTH Upper equivalent mass limit violated

[CAM_L_DDAFMASSTH]

CAM_M_DDAF_CRTL Chamber early gate lower rate limit violated

[CAM_L_DDAFCRTL]

CAM_M_DDAF_CRTH Chamber early gate upper rate limit violated

[CAM_L_DDAFCRTH]

CAM_M_DDAF_DONE Mass engine executed and computed a mass

[CAM_L_DDAFDONE]

CAM_M_DDAF_MITL Moderator index too low

[CAM_L_DDAFMITL]

CAM_M_DDAF_MITH Moderator index too high

[CAM_L_DDAFMITH]

655
CAM Files

CAM_M_DDAF_AITL Absorber index too low

[CAM_L_DDAFAITL]

CAM_M_DDAF_AITH Absorber index too high

[CAM_L_DDAFAITH]

CAM_L_DDASTATUS Mass engine error status (0 = no error)

CAM_T_DDAVERSION Mass engine version (16 characters)

CAM_F_DDAMODINDEX Moderator index

CAM_F_DDAABSINDEX Absorption index

CAM_F_DDAMODCF Moderator matrix correction factor

CAM_F_DDAABSCF Absorption matrix correction factor

CAM_F_DDAAMATRIXCF Active matrix correction factor

CAM_F_DDAINTERRBKG Interrogating background

CAM_F_DDAEQMASSINI Initial equivalent fissile mass – matrix correction

only

CAM_F_DDASELFABSCF Self absorption correction factor

CAM_F_DDAEQMASSSAC E mass corrected for self absorption

CAM_F_DDAEQMASSBC Equivalent mass corrected for bias

CAM_F_DDAEQMASSBCE Uncertainty in equivalent mass corrected for

bias

CAM_F_DDAEQMASSMDA Equivalent mass MDA (grams)

CAM_F_DDAPUMASS Pu-total Mass (grams)

CAM_F_DDAPUMASSE Uncertainty in Pu-total Mass (grams)

CAM_F_DDAUMASS U-total Mass (grams)

CAM_F_DDAUMASSE Uncertainty in U-total Mass (grams)

CAM_F_DDAUMASSMDA U mass MDA (grams)

CAM_F_DDACHMBRATE Chamber monitor net count rate

CAM_F_DDACHMBRATEE Chamber monitor net rate error

CAM_F_DDAPUMASSE Pu-total mass MDA (grams)

656
 Differential Dieaway Analysis Results
Parameters

CAM_F_DDACHMBBLRAT Barrel to chamber flux ratio (unitless)

CAM_F_DDACHMBBLRAE Barrel to chamber flux ratio uncertainty

(unitless)

CAM_F_DDACHMBBARAT Bare to chamber flux ratio (unitless)

CAM_F_DDACHMBBARAE Bare to chamber flux ratio uncertainty (unitless)

CAM_F_DDACHMBSHRAT Shielded to chamber flux ratio (unitless)

CAM_F_DDACHMBSHRAE Shielded to chamber flux ratio uncertainty ()

CAM_T_DDAISOSRC Source of the isotopic ratios used in the analysis;

either “Measured” or “Declared” (8 characters)

Record Parameters
CAM_L_DDASOURCETYP Source type: 0 = Shielded; 1 = Bare; 2 = Sys-
tem; 3 = Flux Monitor; 4 = Barrel Monitor

CAM_F_DDAREALELAPS Real elapsed time

CAM_F_DDANSRATE Net totals rate

CAM_F_DDANSRATEERR Net totals rate uncertainty

CAM_F_DDAINVDWELL Inverse of MCS dwell time (s-1)

CAM_F_DDATRIGFREQ Neutron Generator pulse frequency (active) or

MCS sweep frequency (passive)

Record Tabular Parameters

CAM_L_DDAGATETYPE Gate type: 0 = Early Gate; 1 = Late Gate

CAM_F_DDAGATEDELAY Delay in sec for this gate

CAM_F_DDAGATEWIDTH Gate width in sec for this gate

CAM_F_DDAGATEFSTRT ROI Start in fractional channels for this gate

CAM_F_DDAGATEFSTOP ROI Stop in fractional channels for this gate

CAM_L_DDAGATEISTRT ROI Start in integral channels for this gate

CAM_L_DDAGATEISTOP ROI Stop in integral channels for this gate

CAM_F_DDAEFFELAPS Effective elapsed time for this gate

CAM_F_DDASRATE Raw totals rate for this gate

657
CAM Files

CAM_F_DDASRATEERR Raw totals rate uncertainty for this gate

Differential Dieaway TMU Results

These parameters store the results of TMU analysis of differential dieaway assay results
data. The TMU analysis essentially incorporates additional factors in the calculation of
uncertainties. In addition, values required for WIPP are calculated.

The symbolic name for the class is CAM_CLS_DDATMU.

Common Parameters
CAM_L_WDRFLAGS Flags

CAM_M_WDRF_DATAAVL Results can be used

[CAM_L_WDRFDATAAVL]

CAM_M_WDRF_DONE analysis has been performed

[CAM_L_WDRFDONE]

CAM_M_WDRF_DREVIEW If true, expert data review is required

[CAM_L_WDRFDREVIEW]

CAM_M_WDRF_RVWFLG0 Data review flag 0: gamma differential peak

[CAM_L_WDRRVWFLG0] test failed

CAM_L_WDRRVWFLG5 Data review flag: maximum FGE exceeded

CAM_L_WDRSTATUS Engine error status: if 0, no error

CAM_T_WDRVERSION Engine version identification string (16 charac-

ters)

CAM_F_WDRDHEAT Decay heat

CAM_F_WDRDHEATERR 1-sigma absolute uncertainty in decay heat

239
CAM_F_WDRFGE Pu Fissile Gram Equivalent

CAM_F_WDRFGEERR 1-sigma absolute uncertainty in FGE

CAM_F_WDRFGEMDA FGE MDA

CAM_F_WDREQMASSERR 1-sigma absolute error in equivalent mass

CAM_F_WDRMATRIXERR Matrix error (1-sigma relative)

CAM_F_WDRPTERROR Source distribution error (1-sigma relative)

658
 Differential Dieaway TMU Results

CAM_F_WDREQMASSERR 1-sigma absolute error in equivalent mass

CAM_F_WDRPUMASSERR 1-sigma absolute uncertainty in Pu mass

CAM_F_WDRUMASS U mass

CAM_F_WDRUMASSERR 1-sigma absolute uncertainty in U mass

239
CAM_F_WDRPU239EA Pu equivalent activity

CAM_F_WDRPU239EAER 1-sigma absolute uncertainty in 239Pu EA

CAM_F_WDRAACT Total alpha activity

CAM_F_WDRAACTERR 1-sigma absolute uncertainty in Total alpha ac-

tivity

CAM_F_WDRTRUACT TRU Activity

CAM_F_WDRTRUACTERR 1-sigma absolute uncertainty in TRU activity

CAM_L_WDRWCLASS 0 if the item is considered LLW; non-zero other-

wise

CAM_F_WDRRMAX Maximum point source response

CAM_F_WDRRMIN Minimum point source response

Record Parameters
There is one record per isotope.

CAM_T_WDRISONAME Isotope name (8 characters)

CAM_F_WDRISOACT Isotope activity

CAM_F_WDRISOACTERR 1-sigma absolute uncertainty in activity

CAM_L_WDRISOACTSRC Source of isotope activity: 0=none, 1=isotopic

ratio

CAM_F_WDRISOMDA Isotope MDA

CAM_F_WDRISOMDAERR 1-sigma absolute uncertainty in the MDA (see

note 3 on page 504)

CAM_F_WDRSPECACT Isotope specific activity

659
CAM Files

TGS ROI Definitions

This class defines the ROIs to be used in TGS analysis. The symbolic name for the class
is CAM_CLS_TGSROIDEFS.

Common Parameters
CAM_L_TROIDFLAGS Flags

CAM_M_TROI_FTYPE This file contains transmission ROIs (other-

[CAM_L_TROIDFTYPE] wise, contains emission ROIs)

CAM_T_TROIDCOMMENT Comments (64 characters)

CAM_X_TROIDEDITDAT Date/time of last edit

Record Parameters (one record per ROI)

CAM_L_TROIDROITYPE ROI type: 0 = normal, 1 = reference peak

CAM_T_TROIDNUCLIDE Nuclide name (8 characters)

CAM_F_TROIDENERGY Peak energy

CAM_F_TROIDFIDU Energy of the “fiducial” ROI. When a fiducial

ROI is specified (i.e., this parameter is
non-zero), the mass results of the current ROI
are set to the mass of the fiducial ROI scaled by
the total counts of the current ROI. The value of
this parameter must exactly match the
TROIDENERGY value of the fiducial ROI.

CAM_F_TROIDCALFACT Calibration factor

CAM_F_TROIDCALFACE uncertainty in calibation factor

CAM_F_TROIDATTEN Attenuation factor (emission ROIs only)

CAM_F_TROIDLSTART Left ROI start energy

CAM_F_TROIDLEND Left ROI end energy

CAM_F_TROIDPSTART Peak ROI start energy

CAM_F_TROIDPEND Peak ROI end energy

CAM_F_TROIDRSTART Right ROI start energy

CAM_F_TROIDREND Right ROI end energy

CAM_L_TROIDROIFLAG ROI-specific flags

660
 TGS ROI Results

CAM_M_TROI_MULTIPLET Used for ASP applications: this ROI is a

[CAM_L_TROIDFMULTM] member of a multiplet

CAM_M_TROI_NOEVALUATE Used for ASP applications: do not evaluate

[CAM_L_TROIDFNOEVAL] this ROI or use in Sum ROI calculation;
unknown peaks at this energy should be ig-
nored

CAM_M_TROI_NOSUM Used for ASP applications: do not include

[CAM_L_TROIDFNOSUM] this ROI in Sum ROI calculation

TGS ROI Results

This class contains the areas for each TGS ROI for each view; that is, in this class there
will be one record per defined ROI per view. The symbolic name for the class is
CAM_CLS_TGSROIRES.

Record Parameters
CAM_L_TROIRROINUMB ROI number; this corresponds to the number of
the ROI definition record

CAM_L_TROIRVIEWNUM View number

CAM_F_TROIRLEFT Left ROI area

CAM_F_TROIRPEAK Peak ROI area

CAM_F_TROIRRIGHT Right ROI area

CAM_L_TROIREREAL Elapsed real time (in ms) for the spectrum con-
taining this ROI

CAM_L_TROIRELIVE Elapsed live time (in ms) for the spectrum con-
taining this ROI

CAM_L_TROIRFLAGS Flags

CAM_M_TROI_REFPK This ROI is for the reference peak

[CAM_L_TROIRFREFPK]

CAM_M_TROI_TRANS This is a transmission ROI

[CAM_L_TROIRFTRANS]

661
CAM Files

Voxel Data
This class contains 3-D data generated by imaging applications. Each record contains a
complete 3-D data set; tabular entries contained in each record represent each data point
(i.e., voxel). Three common parameters indicate the X, Y, and Z dimensions of the data
sets; i.e., the number of tabular entries in each record should be X * Y * Z. The symbolic
name for this class is CAM_CLS_VOXELS.

Common Parameters
CAM_L_VOXXDIM Image X dimension

CAM_L_VOXYDIM Image Y dimension

CAM_L_VOXZDIM Image Z dimension

Record Parameters
CAM_L_VOXRECTYPE Data set type. The interpretation of this field is
application dependent.

CAM_T_VOXRECID1 Data set identification string (16 characters).

CAM_F_VOXRECID2 Data set identification value

CAM_F_VOXRECID3 Data set identification

CAM_F_VOXRVALUE1 Spare record parameter 1

CAM_F_VOXRVALUE2 Spare record parameter 2

CAM_F_VOXRVALUE3 Spare record parameter 3

CAM_F_VOXRVALUE4 Spare record parameter 4

CAM_F_VOXRVALUE5 Spare record parameter 5

CAM_F_VOXRVALUE6 Spare record parameter 6

CAM_F_VOXRVALUE7 Spare record parameter 7

CAM_F_VOXRVALUE8 Spare record parameter 8

CAM_F_VOXRVALUE9 Spare record parameter 9

CAM_F_VOXRVALUE10 Spare record parameter 10

Record Tabular Parameters

CAM_F_VOXVALUE Voxel value

662
 NIT Calibration Parameters

CAM_F_VOXVALUEUNC Uncertainty in voxel value

NIT Calibration Parameters

These parameters contain calibration information used by the “Neutron Imaging Tech-
nique” analysis engine; the results of execution of the engine are also stored in this class.
The symbolic name for the class is CAM_CLS_NITCALIB.

Common Parameters
CAM_F_NITGEOMCF NIT geometry correction factor; this value is the
NIT engine result

CAM_L_NITGEOMCFTYP Type of NIT correction factor: 0 = Minimized

KdP, 1 = KdP VWA, 2 = Measured VWA, 3 =
radial VWA, 4 = axial VWA

CAM_F_NITGEOMCFER Uncertainty in NIT geometry correction factor

CAM_L_NITFLAGS Flags

CAM_L_NITFCALDONE Calibration was completed

CAM_L_NITFENGDONE NIT engine successfully executed

CAM_X_NITCALDATE Date NIT calibration accomplished

CAM_T_NITENGVERS Engine version (8 characters)

Record Parameters
CAM_T_NITRSRCID ID (16 characters + null term.) designating
source position and calibration item

CAM_F_NITRSRCKDP KdP value for given source position (calculated

from record tabular)

CAM_F_NITRSRCCF Correction factor (CF) for source position and

item (derived from cal. assay)

CAM_F_NITRSRCCFER Uncertainty in CF

CAM_F_NITRSRCRPOS Radial position of source in cm

CAM_F_NITRSRCVPOS Vertical position of source in cm

CAM_L_NITRSRCFLAGS FLAGs parameter

663
CAM Files

CAM_L_NITRFACTIVE FLAG - active = 1, passive = 0

Record Tabular Parameters

CAM_L_NITRGEOMID Geometry ID

CAM_L_NITRDWELLID Dwell position ID

CAM_F_NITRRATE Count rate for geometry/dwell position

CAM_F_NITRRATEER Uncertainty in count rate

Shuffler Assay Results

These parameters contain the results of NDA 2000 Cf252 Shuffler Analysis. The sym-
bolic name for this class is CAM_CLS_SHFLRRESULTS.

Common Parameters
CAM_L_SHFFLAGS Flags

CAM_T_SHFVERSION Engine version (16 characters)

CAM_F_SHFU235MASS U-235 mass (grams)

CAM_F_SHFU235MASSE Uncertainty in U-235 mass

CAM_F_SHFU235MDA U-235 MDA (grams)

CAM_F_SHFMATRIXCF Matrix correction factor

CAM_F_SHFMATRIXCFE Uncertainty in matrix correction factor

CAM_F_SHFAXIALCF Axial response correction factor

CAM_F_SHFAXIALCFE Uncertainty in axial response correction fac-

tor

CAM_F_SHFRINGRAT Ring ratio

CAM_F_SHFRINGRATE Uncertainty in ring ratio

CAM_F_SHFFSTTHRRT Fast/thermal flux monitor ratio for the top of

the drum

CAM_F_SHFFSTTHRRM Fast/thermal flux monitor ratio for the mid-

dle of the drum

664
 Shuffler Assay Results

CAM_F_SHFFSTTHRRB Fast/thermal flux monitor ratio for the bot-

tom of the drum

Record Parameters
CAM_T_SHFRDSRCNAME Name of detector datasource (16 characters)

CAM_L_SHFRDSRCGEOM Geometry ID for datasource (utilised for imag-

ing)

CAM_F_SHFRRATE Net “average” rate for datasource over all shuf-

fles, scans and/or positions, and index positions

CAM_F_SHFRRATEE Uncertainty in net “average” rate for datasource

over all shuffles, scans and/or positions

CAM_F_SHFRRELAPSED Real elapsed time for datasource over all shuf-

fles, scans and positions

CAM_F_SHFRINVDWELL Inverse of MCS time-per-channel

CAM_F_SHFRTRIGFREQ Rate (average) at which MCS is reset (i.e., trig-

gered)

Record Tabular Parameters

CAM_L_SHFRTROITYPE Type of ROI

CAM_L_SHFRTROIGEOM The scan geometry associated with this ROI,

e.g., scan position, index position, etc.

CAM_F_SHFRTROIDELY ROI start position, in seconds, with respect to

external trigger

CAM_F_SHFRTROIWIDT ROI width in seconds

CAM_F_SHFRTROISTAR ROI start in fractional channels

CAM_F_SHFRTROIEND ROI stop in fractional channels

CAM_L_SHFRTROIISTA ROI start in integral channels

CAM_L_SHFRTROIIEND ROI stop in integral channels

CAM_F_SHFRTROIERT Effective elapsed time for this ROI

CAM_L_SHFRTROICNTS Gross counts in ROI

CAM_F_SHFRTROIGCR Gross count rate for ROI

CAM_F_SHFRTROIGCRE Uncertainty in gross count rate for ROI

665
CAM Files

Datasource Name List

These parameters indicate the names of datasources or files that are associated with this
data. This class can be used in place of the alternate input parameters
(CAM_T_ALTINPUTn) or the Special Uses class. The symbolic name for the class is
CAM_CLS_DSNNAMES.

Record Parameters
CAM_T_DSNNAME Datasource or file name (128 characters)

CAM_L_DSNINT1 General purpose integer parameter

Hydrogen Correction Calibration/Results Parameters

These parameters contain the calibration for and the results of NDA 2000 Hydrogen Cor-
rection Analysis. The symbolic name for this class is CAM_CLS_HYDROCORR.

Common Parameters
CAM_F_HCPARMA Hydrogen correction model factor A

CAM_F_HCPARMB Hydrogen correction model factor B

CAM_F_HCPARMC Hydrogen correction model factor C

CAM_F_HCCOVAA Factor A variance

CAM_F_HCCOVBB Factor B variance

CAM_F_HCCOVCC Factor C variance

CAM_F_HCCOVAB Factor A-B covariance

CAM_F_HCCOVAC Factor A-C covariance

CAM_F_HCCOVBC Factor B-C covariance

CAM_F_HCREFRATIO Reference Triples to Doubles ratio for the VWA

zero matrix

CAM_F_HCREFRATIOER Uncertainty in the reference Triples to Doubles

ratio

CAM_F_HCCORRFACT Computed hydrogen correction factor

CAM_F_HCCORRFACTER Uncertainty in the correction factor

666
6. Development Tools Environment
The Genie 2000 Programming Library was developed specifically to be used with
Microsoft Visual C++, Professional Edition, version 6.0. This product includes an inte-
grated development environment called Microsoft Developer Studio. If you prefer, the
compiler and linker can be invoked directly from a command line session.

Please note that it is also possible to call the Genie 2000 Programming Library routines
using Microsoft Visual Basic, Professional Edition, version 6.0. Consult with Canberra to
obtain additional information on how to do this.

To run Visual C++, Professional Edition, you need:

• A PC with a Pentium 90 MHz or higher processor.

• Windows NT V4.0, Windows 2000, or Windows XP.
• A minimum of 64 MB of RAM for Windows NT/2000 or 128 MB for
Windows XP. In the Genie 2000 environment, more memory will generally
improve performance.
• Hard disk space required:
Typical installation: 175 MB
Minimum installation: 120 MB
Maximum installation: 500 MB
CD-ROM installation (tools can be run from the compact disk): 50 MB
• CD-ROM drive
• 32-bit protected mode CD-ROM driver
• VGA or higher-resolution (800 x 600 min.) monitor (super VGA
recommended)
• Microsoft mouse or compatible pointing device

Note: If you are using Visual C++, Professional Edition V6.0 or above (32 bit OS),
you’ll have to change one of the project settings.

• Under the Project\Settings menu, select TAB C\C++, Category: Code

Generation, field: Struct Member Alignment. Change the default value of 8
bytes to 2 bytes.
• Under the Tools\Options menu, select the Directories tab. Select the “Include
files” item in the “Show Directories for” list box. Add the S560 directory path,
<Genie-2000 S560 Software Installation Path>\S560, at the end. Select the
“Library files" item in the “Show Directories for” list box. Add the S560
directory path, <Genie-2000 S560 Software Installation Path>\S560, at the end.
Select OK to save these changes.

667
Genie 2000 Error Codes

7. Genie 2000 Error Codes

Errors returned from software components of the software environment conform to the
following notation.

Error codes are returned as 32-bit hexadecimal numbers (for example, 278e2a, see below
for interpretation) where:
Bits 0 - 15: Specific error code value

Bits 16 - 19: Error class as defined below

Bits 20 - 27: Error level as defined below

Error levels (bits 20 - 27) include:

Hex 1: Hardware Protocol driver error

Hex 2: VDM Driver error

Hex 3: VDM error

Hex 4: IPC error

Hex 5: Client (SAD access routine) error

Hex 6: Application error

Error classes (bits 16 - 19) include:

Hex 0: None, specific error value is sufficient.

Hex 1: Command class.

Hex 2: Hardware class.

Hex 3: Communications class.

Hex 4: Operating system class.

Hex 5: Environment variable class.

Hex 6: Data conversion class.

668
 CAM Error Codes

Hex 7: CAM class.

Hex 8: ‘C’ runtime library class.

Given the above description, an error code such as 278e2a would indicate a VDM driver
error level of the class CAM. The low order 16 bits (8e2a) denote an actual CAM error
code which means ‘file already opened’. Below is a detailed list of common 32-bit error
codes with the corresponding error message; a brief description of the error is presented
where appropriate.

System-level errors that are considered less common, such as memory allocation errors,
are presented like this:

General <level-name> Error:

Source: <a>
Class: <b>
Number: <cccc> (<ddddd>)where:

<level-name>: Error level (such as SAD or CAM)

<a>: Error level number (in hex)
<b>: Error class number (in hex)
<cccc>: Specific error code (in hex)
<ddddd>: Specific error code (in decimal)

CAM Error Codes

CAM file access error codes will be reported as a hex number 27xxxx; common ‘xxxx’
codes include:

805A: Parameter not on file.

The specified CAM parameter does not exist in the datasource being accessed.

8092: Failed to find, access or open file.

809A: Error closing file.

80A2: Error reading from file.

80AA: Error writing to file.

8102: Block (class) not on file.

CAM block missing (for instance, a specified CAM class does not exist in the
datasource being accessed).

669
Genie 2000 Error Codes

8362: Number too large for storage.

8E2A: File is open and not shareable.

8E62: File already exists.

8E6A: Invalid file name.

The syntax of the specified file name is invalid (needs to be bbbbbbbb.eee).

8E7A: Destination file is open.

IPC Errors
IPC error codes will be reported as a hex number 4yxxxx (y is the particular class as de-
scribed above); common ‘xxxx’ codes include:

FFFE: Timeout during communications with VDM.

FFFD: Error -3 attempting communications with VDM.

Miscellaneous communications error (most likely that the VDM is not currently
running).

FFFB: No access to IPC server (no VDM running).

FFF4: Network Configuration File error.

Configuration file not found or other internal configuration file error.

FFF3: Error –13 attempting communication with VDM.

Message transaction already in progress.

–nn: Error (–nn) communicating with VDM.

VDM Errors
VDM error codes will be reported as a hex number 3yxxxx (y is the particular class as
described above); common xxxx codes include:

7: A path named by an environment variable was not found.

A pathname does not exist as specified by an environment variable.

670
 Analysis Module Errors

C: A required environment variable was not found by the VDM.

A system-required environment variable was not found.

13: Datasource is unknown to the VDM.

Specified detector/counter datasource is not in the Runtime Database.

17: Action disabled – datasource not verified.

19: Can’t effect change of busy datasource in Runtime Database.

21: Major verification error encountered when opening the specified detector
datasource.

22: Busy but never opened.

Specified detector datasource is currently busy, but not being monitored by the
VDM.

23: Minor verification error encountered when opening the specified detector
datasource.

Analysis Module Errors

There are two groups of analysis module error codes: one group will be reported as a hex
number in the range 61xxxx, the other as a hex number in the range E8xxxx (listing starts
on page 674).

Common 61 ‘xxxx’ codes

1: Function not supported by this algorithm.

2: ROI is too small to solve.

3: Too few points for the calculation.

Not enough points were available to perform the specified calculation (for example,
a third order energy calibration requires four data points).

4: Too many lines for internal arrays.

5: Equation type not supported by this algorithm.

6: Need Energy Calibration in order to proceed.

7: Need Efficiency Calibration in order to proceed.

671
Genie 2000 Error Codes

8: Need FWHM Calibration in order to proceed.

9: Need Low Tail Calibration in order to proceed.

A: Need High Tail Calibration in order to proceed.

B: Need Peak Locate results in order to proceed.

C: Need Peak Area results in order to proceed.

D: Need Peak Search results in order to proceed.

E: Need Nuclide Library Info in order to proceed.

F: Too many nuclides for internal arrays.

10: Need DUAL Efficiency Calibration in order to proceed.

11: Setup data is invalid.

Setup parameters required for a particular algorithm are invalid (for example, a
Start/Stop range of 0 to 0 would be invalid for a peak locate).

12: Expected/Calculated data is invalid.

Data resulting from previous operations (for example, live time) is invalid for this
algorithm.

13: Sample data is invalid.

14: Need Efficiency Correction results in order to proceed.

15: Data invalid – Counts Per Second (for instance, area) is 0.

16: Data invalid - Efficiency is 0.

17: Need Nuclide-ID info in order to proceed.

18: No energy calibration information available.

20: Background file not found, or open error.

21: Library file not found, or open error.

23: Certificate file not found, or open error.

25: Too many peaks in the ROI.

26: No multiplets allowed in the datasource.

672
 Analysis Module Errors

Acquisition Errors
The following errors are possible during acquisition:

50: Input already busy.

Energy Calibration Errors

The following errors are possible during energy calibration:

100: Singular matrix – no solution.

An error has occurred while fitting a curve to the specified points; add or delete
points until a suitable set of points for a curve solution is present.

102: Couldn’t find a peak.

A peak could not be found at the specified cursor position.

103: Couldn’t fit a Gaussian to the peak.

The shape of the specified peak is poor (for instance, not a Gaussian). Typical cause
is poor selection of peak via the cursor.

104: Insufficient data for required calculations.

105: Insufficient memory for dynamic variables.

Efficiency Calibration Errors

The following errors are possible during efficiency calibration:

200: No peaks in the efficiency list.

Peak Locate Errors

The following errors are possible during peak locate:

300: No nuclides in the library.

301: Mismatch in library entries.

Peak Area Analysis Errors

The following errors are possible during peak area analysis:

400: Can’t resolve peaks in a multiplet.

401: Too many peaks in the analysis range. Maximum is 500.

673
Genie 2000 Error Codes

402: Peak Locate results were not ordered by peak centroid.

Area Correction Errors

The following errors are possible during area correction:

600: No Peak Area results in background file.

601: No Peak Search results in background file.

602: No peak found matching the tracer/reference peak.

603: Setup half-life is zero.

604: Peak has zero net counts.

650: None of the peaks were identified.

651: No efficiency calibration or tracer information found.

Activity Correction Errors

The following errors are possible during activity correction:

700: Unexpected return from interference correction.

701: Incompatible previous activity correction – rejected nuclide or line/peak link

broken.

Control Recovery Error

The following error is possible during activity correction:

800: Energy line of control’s nuclide could not be found.

Common E8 ‘xxxx’ codes

8E14: Memory Allocation Error

9222: Need calibration to proceed

967A: Nuclide Library not specified

9682: Unable to open specified library

968A: Internal error – Number of channels in spectrum is zero

9692: Starting channel number is greater than end channel number

969A: Unable to write peak location results

674
 Geometry Composer Errors

96A2: Unable to read user ROI file flag

96AA: User specified ROI file not specified

96BA: Unable to open user specified ROI file

96B2: Bad values for ROI limits, unable to continue

96CA: No sigma value given for 2nd difference coefficients

96D2: Significance threshold value out of range or missing

96DA: Elapsed Live Time is ≤ 0

96E2: Energy or Variable FWHM tolerance is < 0

96EA: Could not fit peak(s) due to bad fit shape parameters

Geometry Composer Errors

LoadMuLibr
100 Can’t open file with mu-library. Check the existence of the file pointed to by
the :ATTENUATION_LIBRARY statement in file SPACE.INI.

101 Can’t find predefined material in the library. The material assigned for some
geometry component is absent in the connected library. Insert the desired ma-
terial into the library.

102 Error while reading the attenuation library. Problem with the mu-library. The
library may be corrupted; use its backup version.

103 Arrays to store attenuation coeffs. are full. Only 10 energy intervals may be
used to describe the polynomial that represents the energy dependence of mass
attenuation coefficient.

104 End of file with mu-library is reached, no more records exist.

Mu-Editor
500 Error while accessing of a function in LoadMuLibr.dll. The Dll may be cor-
rupted; re-install it.

501 Cannot find LoadMuLibr.dll.

502 Error during treatment of substance composition. The old mu-library format
may have been used. You may use either the construction of a new substance
from elements (via chemical formula) and/or the substances prepared in the
Windows version of the mu-library editor.

675
Genie 2000 Error Codes

503 Error during conversion of the formula to the new mu-library format. While
reading the DOS formatted Mu-Library the program was unable to convert a
substance composition into the new format. Try to prepare this substance di-
rectly using the Windows version of the program.

504 Error in Dll (.dll) while performing the selected operation.

505 Cannot load the ISOCS path data. Either file SPACE.INI was not found or the
statement :ATTENUATION_LIBRARY was not found in SPACE.INI.

506 Error while deleting a material from the library. Internal error in muedit.dll.

507 Invalid value of density. Density must be greater than 0 and less than 20.

508 Internal error while attempting to insert the material.

509 The formula is too long to be inserted into the library. You can subdivide the
material composition into a few components.

510 The material ‘water’ or ‘dry air’ cannot be deleted.

511 Trying to input a string inside another substring (parenthesis).

512 Substance name coincides with an element name. The problem is corrected by
adding a prefix (asterisk).

513 Name of substance coincides with an element name, correct it first.

605 Too many components, the reserved arrays are full.

609 Impossible to delete because of formula traceability. The next substance(s)

refer for ‘%1’:

610 Impossible to insert because of formula traceability. The next substance(s) ref-
er for ‘%1’:

GeomEdit
100 Not enough room between source and detector to put Absorber(s)

701 Can’t get address of DLL function

702 Can’t load DLL

703 Can’t load Material Info from library

704 The material pointed to in the template geometry is not found in the current
mu-library. The material must be added before proceeding.

705 The geometry description must include a detector.

676
 Geometry Composer Errors

706 The detector specified in the geometry file is missing from the local file De-
tector.txt. Check the existence of the detector characterization file in the
ISOCS directory! The geometry file refers to a detector record that has been
deleted, or the current Detector.txt file has been modified.

707 Cannot append detector(s) to the Combo Box.

708 Cannot load the selected detector from file Detector.txt. Check for an appro-
priate record (for the selected detector) in Detector.txt.

709 A detector must be selected.

710 The number of template versions exceeds the maximum allowed. To enter a
new version first delete one or more existing versions.

711 Invalid template version name.

712 The template version name is already in use.

713 Cannot open template version file. A system error occurred while opening the
template version file. Version information could not be saved.

714 Cannot open the predefined beaker file. Check that the beaker file is not cur-
rently being used by another program.

715 Invalid parameter in pre-defined beaker file. The line of data must contain 7
parameters.

716 Not a valid contour ID. The ID did not correspond to one of the three types of
contour (i, o or b).

717 Invalid number of parameters (less than 4)! The record structure in file de-
scribing contour.

718 Cannot load DLL with template information. When the Edit Dimensions dia-
log was called, the program could not load the template dll. This situation may
arise when attempting to edit a .GEO file of a particular geometry template
that is not available in the current GC configuration.

719 Cannot get the address of a function in the template dll. This is a system error.
It may be due to a corrupted dll and may be necessary to reinstall.

720 New user template version may be based only on the default template version.
A new user template version cannot be based on an existing geometry file that
itself is based on a user template version. Use the version that is not marked as
[user].

721 The material ‘%1’ referenced in the geometry file is not available in the cur-
rent mu-library. Please replace it with an available material or add the material
to the mu-library.

677
Genie 2000 Error Codes

722 The geometry definition contains the material ‘%1’ which is not available in
the current mu-library. Would you like to replace this material with and avail-
able one?

723 Density for the source material is missing. Mass of the source cannot be calcu-
lated.

724 Cannot load .dll.

725 Cannot get address of function in .dll. This is an internal (system) error.

726 Cannot find the bitmap containing the template drawing. The bitmap file must
exist in the directory specified by the :TMPL_BITMAPS keyword in
Space.ini.

727 The file containing the template drawing is not a valid bitmap (.bmp) file.

728 Cannot continue. Check the :PROGRAM keyword in Space.ini. The directory
path specified by the :PROGRAM keyword is missing or invalid, or Space.ini
itself may be missing.

729 Cannot retrieve the address of a function in the computational DLL. Isocs_ge-
neric.dll may be corrupted. You may need to re-install.

730 Cannot load computational DLL. Check existence of isocs_generic.dll in di-

rectory specified by the :PROGRAM keyword in Space.ini.

731 Cannot open contour description file for writing.

732 Cannot open the file containing cylindrical collimator parameters. This file is
located in the directory specified by the :C_COLLIMATOR keyword in
Space.ini.

733 Invalid record in collimator file.

734 Cannot open file containing under water housing parameters. This file is lo-
cated in the directory specified by the :UW_HOUSING keyword in Space.ini.

735 Cannot open file containing rectangular collimator parameters. This file is lo-
cated in the directory specified by the :R_COLLIMATOR keyword in
Space.ini.

736 Select a collimator type first.

737 Cannot execute the operation. The collimator type must be selected first.

738 The collimator name has not been identified. The record will be saved as a
new record.

739 Cannot open file to save collimator data. Check that the file is not being used
by another program.

678
 Geometry Composer Errors

740 Please specify a name for the record: none is not valid!

741 Please confirm deletion of user version %1.

743 Versions library has been updated.

744 Please select the version to be deleted.

745 Template version has been saved.

746 Cylindrical collimator record has been successfully stored.

747 Rectangular collimator record has been successfully stored.

748 Housing record has been successfully stored.

749 Detector name is longer than 19 characters. Please make the necessary correc-
tion to the detector file. The detector is not included in the list of available de-
tectors.

750 Please confirm deletion of the collimator record.

751 Please confirm deletion of the housing record.

752 Cannot launch MuEditor.exe. Check the existence of this file in the directory
specified by the :PROGAM keyword in Space.ini.

753 Please confirm replacement of the record #%1: %2.

754 Cylindrical Collimator

755 Rectangular Collimator

756 Housing

757 Material in the string #’%1’ is missing. Select the proper material from the list
box or none if the geometry component is absent. In the latter case the line’s
data will be ignored.

758 Data Validation

759 Only positive numbers greater than 1.0E-4 mm may be entered.

760 Cannot load BMP file for plotting. The bitmap file must exist in the directory
specified by the :TMPL_BITMAPS keyword in Space.ini.

Geometry Composer
100 OLE initialization failed. Make sure that the OLE libraries are the correct ver-
sion.

104 Windows sockets initialization failed.

679
Genie 2000 Error Codes

1002 Variable ‘SPACE’ is not found in the environment.

1003 File Space.ini cannot be opened.

1004 The preset path statement is not found in file Space.

1005 Cannot open file detector. with detector parameters. Check whether detec-
tor.txt is present in the directory specified by the :DETECTOR_PAR keyword
in Space.ini.

1006 Error in format of file Space.ini. Check format of Space.ini: each line should
have a format of keyword=path.

1007 System error while reading the detector list file.

1008 Check format of the detector list file (8 columns per line are allowed).

1009 Program cannot open templates list file (template.cnf).

1010 Templates list file (template.cnf) has an invalid format.

1011 System error while reading the templates list file (template..

1012 Cannot load the template DLL file.

1013 Cannot access exported DLL function. This is a system error which occurred
when the program attempted to access the DLL.

1014 Unable to locate the geometry files directory. The program cannot locate the
directory specified by the :GEOMETRY keyword in Space.ini. The results
will be stored in the root directory.

1015 Cannot open ISOCS geometry (.GIS) file to store geometry description data.

1016 Directory specified by the :PROGRAM keyword in file Space.ini is invalid.

1017 Internal error in ISOCS program.

1018 Cannot open efficiency (.ECC) file generated by ISOCS.

1019 Error while reading ISOCS efficiency (.ECC) file: invalid number of columns
in file.

1020 Error while reading ISOCS efficiency (.ECC) file: invalid number of energies
in file.

1021 Internal error calling efficiency curve function in .dll.

1022 Error returned from efficiency curve function in .dll.

1023 Cannot load .dll. Check existence of this file in the directory specified by the
:PROGRAM keyword in Space.ini.

680
 Geometry Composer Errors

1024 Internal error: generation failed.

1025 Error attempting to open .ECC file generated by ISOCS: cannot find
:ECC_OUTPUT keyword in file Space.ini.

1026 Unrecognized file format: the file is not in a .GEO format.

1027 The function computing efficiency returned with an error.

1028 Internal system error attempting to call a function in _generic.dll.

1029 Cannot load _generic.dll.

1030 The geometry (.GEO) file was created by later version of Geometry Com-
poser than is currently running. The program may have failed attempting to
read a file. Please update your Geometry Composer.

1031 Cannot open file containing geometry data.

1032 Internal arrays for importing ISOCS geometry are full. Check the .GIS file
and insure that all contained data are valid.

1033 Cannot open the Clipboard to store the template picture for export to Excel.

1034 Cannot empty the Clipboard.

1035 Unable to write template picture to the Clipboard.

1036 Do you wish to overwrite existing configuration file?

1037 Cannot open back-up copy of Space. (Space.bak).

1038 No geometry templates are available. Please check Options/Configuration

menu item. Check for the existence of the template DLLs (lgt_xx.dll and
igt_xx.dll) in the directory specified by the :PROGRAM keyword in
Space.ini.

1039 Filename of the Computational DLL does not match its content. The file may
have been renamed.

1040 Cannot find the bitmap containing the template drawing. The bitmap file must
exist in the directory specified by the :TMPL_BITMAPS keyword in
Space.ini.

1041 The file containing the template drawing is not a valid bitmap (.bmp) file.

1042 Program cannot run because of a missing keyword. One of the required
keywords in Space.ini is missing.

1043 Cannot find the directory specified by the :GEOMETRY keyword in file
Space.ini.

681
Genie 2000 Error Codes

1044 The selected folder does not correspond to standard file storage convention.
Save the file anyway?

1045 Confirm selection!

1046 Cannot create new directory.

1047 Cannot open the energy list file.

1048 Error in format of energy list file. Each line should contain two comma delim-
ited fields: Energy and Efficiency Error.

1049 Cannot open energy list file for writing.

1050 Error while requesting information about a computational DLL.

1051 Program cannot continue: cannot find one of the required keywords in file
Space.ini.

1052 Internal system error: problem calling a function in the computational DLL.

1053 Cannot load computational DLL. Check existence of DLL in directory speci-
fied by the :PROGRAM keyword in Space.ini.

1054 Cannot delete temporary file .txt. This is required in order to execute the next
ISOCS computation.

1055 Cannot open temporary file to store beaker description during geometry test-
ing.

1056 Cannot find generated file. Export to Excel is stopped.

1057 Excel is being launched...Please answer the following questions from Excel:

1058 Cannot launch ‘Excel’.

1059 Efficiency curve may be generated after saving the geometry file.

1060 Geometry test has run successfully.

1061 Geometry test has failed:

1062 Error

1063 Variable ‘SPACE’ is not found in the environment.

1064 File Space.ini cannot be opened. Check for the existence of this file in the di-
rectory specified by the SPACE environment variable.

1065 The preset statement is not found in file Space.ini.

682
 Geometry Composer Errors

1066 Cannot open file detector. with detector parameters. Check existence of this
file in the directory specified by the :DETECTOR_PAR keyword in file
Space.ini.

1067 Error in format of file Space.ini. Check format of Space.ini: each line should
have a format of keyword=path.

1101 Cannot find the bitmap containing the template drawing. The bitmap file must
exist in the directory specified by the :TMPL_BITMAPS keyword in
Space.ini.

1102 Please select the energy to be deleted.

1103 An Efficiency Calibration Calculation (ECC) process is already running. Wait

for its termination before launching another ECC process.

1104 Efficiency data points have been generated.

1105 Filename of the Template DLL does not match its content. The file may have
been renamed.

1106 Temperature is below the lower temperature limit (deg C):

1107 Temperature is above the upper temperature limit (deg C):

1108 Pressure exceeds the upper pressure limit (mm Hg):

1109 ISOCS environment is not found. Program cannot run.

1110 File Space.ini or a required keyword in Space.ini was not found. The program
cannot access data needed for creation of a new document. Only existing doc-
uments may be opened.

1111 Cannot move generated .ECC file from temporary to destination directory.
System error number (errno)

1112 Configuration list is empty. New document cannot be created: no templates

are available.

1113 Cannot update configuration. File Space.ini or the :PROGRAM keyword in

space.ini was not found.

1114 You have loaded a previous version of a GEO file. To make the picture avail-
able open the Edit/Dimensions dialog and save the GEO file.

1115 Cannot create backup of template list file (template.bak). While updating the
configuration the program could not rename template.cnf to ‘template.bak.

1116 Cannot update template list file (template.cnf). While updating the configura-
tion the program could not rename the temporary copy of the template list file
(template.tmp) back to the permanent file name (template.cnf).

683
Genie 2000 Error Codes

1117 List is full. Cannot append new energy value to the list used for ECC genera-
tion. Max lines in the list is 100.

1118 % elements have been loaded.

1119 The valid energy interval is:

1120 The energy value is already in the list.

1121 The Error value is missing.

LGT_101
101 Windows sockets initialization failed.

200 Not enough room between source and detector to put Absorber(s)

Invalid volume: upper part of beaker is not filled The data in line 4 will be re-
set Input correct values

LGT_104
101 Windows sockets initialization failed.

200 Not enough room between source and detector to put Absorber(s)

201 Please specify thickness of side walls

202 Please select material of side walls

203 Please specify thickness of bottom wall

204 Please select material of bottom wall

LGT_106
101 Windows sockets initialization failed.

200 Not enough room for Absorber(s)

201 Invalid volume. If you wish to change sample volume, correct the dimensions.

202 Please select material for the container.

203 Please specify thickness of container walls.

LGT_107
101 Windows sockets initialization failed.

200 Not enough room for Absorber(s)

201 Please select material for the container.

684
 Geometry Composer Errors

202 Please specify thickness of container walls.

LGT_108
101 Windows sockets initialization failed.

200 Detector does not fit into Marinelli beaker well. See the “Endcap INFO” frame
on the dialog panel.

201 Invalid volume: upper part of beaker is not filled. The data in line 4 will be re-
set. Input correct values.

202 Sample is below detector plane.

203 Invalid data: only positive values are permitted.

204 Invalid data for detector well: both of them must be zero or not zero.

205 Invalid data for detector well: 3.1 must be greater than 2.1 + 4*1.1.

206 Container diameter must be greater than detector diameter.

207 Please select a material for the container.

LGT_112
101 Windows sockets initialization failed.

200 Please select a material for the beaker walls.

201 Sample volume is too large to fit into the beaker.

202 Not enough room for the sample.

LGT_12
101 Windows sockets initialization failed.

200 Please select a wall material.

201 Please specify the height of at least one of the layers: 2.1 or 3.1.

LGT_3
101 Windows sockets initialization failed.

200 Please select material for walls.

201 Please specify height of at least one of the layers: 2.1 or 3.1.

LGT_6
101 Windows sockets initialization failed.

685
Genie 2000 Error Codes

200 Please select material for walls.

201 Please specify height of layer.

LGT_7
101 Windows sockets initialization failed.

200 Please select material for the walls.

201 Sum of shells exceeds diameter: (1.1+ 2.1) > 1.2

202 Please select material for the sample.

203 Please select material for Source-Shell.

204 Please select material for Source.

LGT_8
101 Windows sockets initialization failed.

200 Detector does not fit into Marinelli beaker well. See the “Endcap INFO” frame
on the dialog panel.

201 Parameters 3.1 and 4.1 must be set in the current context.

Report Module Errors

Report module error codes will be reported as a hex number 60xxxx; common xxxx
codes include:

1: Memory Allocation Error.

2: Template file not specified.

3: Report section not specified.

4: Parsing error(s) detected.

Errors have been detected during the compilation phase of generating a report.
Look at the report file for a more detailed description of errors.

5: Temp. file creation error.

6: Error communicating with VDM.

7: Error during disk file access.

8: Error during CAM file access.

686
 QA Routine Errors

9: Invalid intermediate file

Find the directory named by the RTPLFILES environment variable; find a

subdirectory with the base name of the template file you’re using; delete the *.ITF
files from that subdirectory and try again.

QA Routine Errors
Errors in the Transfer and Analyze routines will be reported as a hex number 60xxxx.
Common xxxx codes include:

380: General communication failure.

381: Memory allocation error.

384: The record being transferred has the same time-stamp as one that’s already on
file - but there’s no over-write flag.

385: No records to transfer.

386: Nuclide or Nuclide line not found.

38C: Warning that the bias test was not performed because one or more values had
error = 0.

38D: Bad date range specified.

38E: Warning that not all tests were performed.

38F: Cannot transfer to hardware.

MID Editor Errors

MID Editor error codes will be reported as a hex number 3yxxxx (y is the particular class
as described above); common xxxx codes include:

15: MID file <name> is loaded in the Runtime Database.

This error indicates that the specified MID file to be opened for edit is loaded in the
Runtime Database. It must be unloaded before it can be edited.

19: That file defines an input which is acquiring.

This error indicates that the specified MID file cannot be unloaded because a detec-
tor defined within it is currently acquiring data.

687
Genie 2000 Error Codes

1B: An already-loaded file has an input with the same name.

An attempt was made to load an MID file into the Runtime Database containing at
least one input name that already appears in the Runtime Database. Input names
must be unique within any instance of the Runtime Database.

1C: That file is not loaded.

The specified MID file to be unloaded from the Runtime Database is not currently
loaded.

1D: An already-loaded file has a hardware device at the same board number or ad-
dress.

An attempt was made to load an MID file into the Runtime Database containing at
least one hardware device with a board number (S100) or address (AIM) that al-
ready appears in the Runtime Database. Hardware device addressing must be
unique within any instance of the Runtime Database.

Input Datasource Errors

A detector datasource (or input) is made up of an MCA and various front-end devices,
such as an Amplifier, an ADC, or a high-voltage power supply. The process of configur-
ing an input via the MID Editor was discussed in Chapter 3. No actual hardware is re-
quired until you decide to use an input by opening it up in a Genie 2000 software
application.

Open/Verify Errors
The system perform a verification on an input datasource when it is first opened; verifi-
cation is defined as checking to make sure that the input can be communicated with and
is configured as defined by the MID Editor. There are various errors that verification can
determine; they are divided into three categories: fatal errors, major errors, and minor er-
rors.

Fatal Errors
This class of error indicates that the open of the specified input datasource has failed.
This error will be reflected in an appropriate error message from the various system soft-
ware applications.

Busy but never open

This condition arises when the VDM, in responding to a request for opening an input, de-
tects that the input is busy without being monitored. This can be caused by the VDM be-
ing closed and restarted (or the computer being soft-rebooted) while an input is
acquiring.

688
 Input Datasource Errors

Unlike the other fatal errors, the Gamma and Alpha applications will present the user
with three options in handling this condition:

• Cancel the open operation.

• Proceed with the open and continue acquisition on the input datasource. Note
that no verification is performed in this case.
• Proceed with the open by aborting the acquisition and verifying the input
datasource.

Hardware not Available

This error is due to a failure in detecting the presence of some device that makes up the
input. Some of the causes for this error include:

Incorrect board no. (S100)

Incorrect I/O address (Accuspec)

Incorrect Ethernet address (AIM)

1520 defined and not present (S100)

No response from unit (Inspector)

Owner Mismatch:
This condition indicates that the input being opened is currently “owned” by another user
and cannot be accessed. This is caused when an attempt is made to open an AIM input
and the AIM device is currently being accessed by another VDM; that is, another user.

Baud Rate not Supported by Serial Port Hardware

This condition indicates that the serial port hardware in the computer does not support
the data transfer (baud) rate selected in the MID Editor. Try a slower rate.

Major Errors
This class of error indicates that the open of the specified input datasource has failed. Un-
like a fatal error, this error class is handled differently by the Gamma and Alpha applica-
tions. Upon detecting this class of error, the applications will automatically bring up the
Status screen which presents more detailed information as to the errors that were encoun-
tered. Upon exiting the Status screen, the user is directed back to the main window, just
as if a fatal error occurred.

689
Genie 2000 Error Codes

Hardware Failure
This error is returned when an open of an input detects that one of the devices comprising
the input has failed. Note that this error always indicates that a device, such as ICB NIM,
has notified the system software that it has failed.

Model No. Mismatch

This error is returned when an open of an input detects that one of the devices comprising
the input does not match the model number as configured by the MID Editor; that is, the
input was configured to include an 9641 HVPS and the open/verify process found a 9645
HVPS.

Minor Errors
This class of error indicates that the open of the specified input datasource was partially
successful in that all devices comprising the input were located and communicated with;
however, discrepancies were found in the actual configuration of one or more devices. In
the Gamma and Alpha applications, the user will be presented with three options in han-
dling this condition (the system job commands will treat this class of error as fatal):

1. Cancel the open operation.

2. Proceed with the open and ignore the minor error. In this case, the system
software will set a “questionable data” flag in the datasource as a reminder of
this error condition. The “Ready LED” will be set to YELLOW for any ICB
devices defined for this input datasource.

If the open was initiated from the Acquisition and Analysis application, its
Status field will have been changed to red and its Status Report will display an
asterisk (*) next to the parameter in question. When the error has been corrected,
both error flags can be cleared by updating the Status Report screen.

3. Proceed with the open and accept the minor error. No “questionable data” flag is
set in this case and the input datasource is updated with the conflicting
parameter values. The “Ready LED” will be set to GREEN for any ICB devices
defined for this input datasource.

Serial No. Mismatch

This error is returned when an open of an input detects that one of the devices comprising
the input does not match the serial number detected last time it was opened and used.
This error will occur when an ICB device, such as a 9641 HVPS, is removed for re-
pair/maintenance and is replaced with another unit.

Operational Errors
After verification is performed, two additional checks, Questionable Data and Question-
able Calibration, are made on the input datasource while it is being opened.

690
 Input Datasource Errors

Questionable Data – This condition (indicated by CAM parameter ASTFCCERR) oc-

curs whenever:

1. An error occurs during acquisition.

2. A minor verification error is detected during open and is ignored (see

“Open/Verify Errors” on page 688).

This error is cleared by accepting the condition at open time.

Questionable Calibration – This condition (indicated by CAM parameter

ASTFBADCAL) occurs whenever a hardware setting is changed. It is intended to flag
the user about changes in the hardware characteristics that could potentially affect the en-
ergy/shape calibration. This error is cleared either by accepting the condition at open
time or by performing a valid energy/shape calibration.

After an input datasource is opened by a system software application, the input is moni-
tored by the VDM for any change in status. The parameters that are monitored vary,
based on the input datasource; that is, on the types of devices that comprise the input.
Some typical parameters that are monitored include:

• Has the device failed since open?

• Has there been a communications error since open?
• Has the device gone through a power reset since open?
• High voltage status change; for instance, inhibit or overload.
• Any readable parameters that can possibly change since open, such as the
shaping time constant on a 9615 ICB Amplifier.
• RAM keepalive battery is low (Inspector only)
• Both power batteries are low (Inspector only)

The way a change in status is handled varies between system software applications:

When the Gamma or Alpha application detects a change in status, it will change the
background color of the input’s Status Line from white to red. This tells the user that
there has been a change at the hardware level. The Status Report screen in the Acquisi-
tion and Analysis application will show an asterisk next to the changed parameter. When
the error has been corrected, both error flags can be cleared by updating the Status Report
screen.

The Genie 2000 WAIT command does monitor change in status during its execution. If a
change is detected, the WAIT command will return to the user with an appropriate error
message and error return code.

691
Genie 2000 Error Codes

Stabilizer Window Outside Channel Limits

This error message can be triggered by one of three conditions:

1. The Centroid channel plus one half of the number of Spacing channels plus the
Window width yields a channel which is greater than the number of channels in
the input.

2. The Centroid channel minus one half of the number of Spacing channels minus
the Window width yields a channel which is less than one.

3. The Zero Centroid channel is greater than the Gain Centroid channel.

692
8. LabSOCS/ISOCS Error Codes
This listing of error codes and their corresponding messages is included as an aid to trou-
bleshooting problems that may occur in data entry and/or other operations. Extensive er-
ror testing is done in various parts of the program, especially when editing or creating
geometries.

Exiting the Geometry Composer screen causes a three-part error validation routine to be
called.

1. First, the GeomEdit module compares the input values to generic rules for all
templates;

2. Next the values are compared to template-specific requirements for various

parameters;

3. Last, a test is carried out by the computational dll for that template to make sure
that the full computation will run. This is the same test that is called when using
the “Check Geometry Validity” function.

The validation routine uses error messages box with different titles than standard error
message.

• If title of the box is “Data Validation Error #xyz”, it means that error was detected
in GeomEdit or the template dll.
• If the title of the box is “Data Validation Error [from computational module]:
#xyz” it means that error was detected in the computational dll.
• If the title of the box is “Data Validation Warning: #xyz”, it comes from
conditions within the template dll.
Other similar error testing is done in Mu-Editor while creating/editing materials and for
ISOCS while creating/editing collimators or external housings.

There are several sets of error messages described in this appendix.

1. General errors, starting page 694.

2. Geometry composer errors, starting on page 723.

3. ISOCS multi-efficiency errors, starting on page 731.

4. ISOCS template-dependent errors, starting page 732.*

693
LabSOCS/ISOCS Error Codes

5. LabSOCS template-dependent errors, starting page 746.*

*To find template-dependent error messages, first locate the name of the template that
was used, then find the error number within that template.

The error codes and their messages are presented as:

• The number of the error message.
• The text of the error message in caps.
• An explanation of the error message.

General Errors
#256 AN EFFICIENCY CALIBRATION CALCULATION (ECC) PROCESS IS
ALREADY RUNNING.
WAIT FOR ITS TERMINATION BEFORE LAUNCHING ANOTHER ECC
PROCESS.
This error message can appear when you try to launch the Efficiency Calibra-
tion Calculation [ECC] process before the previously launched ECC has com-
pleted. Launching two concurrent ECC processes is prohibited.

#257 CAN’T OPEN INPUT FILE WITH THE TEMPLATE DESCRIPTION.

Make sure that the template description contained in the input geometry file
really exists in the current configuration.

#258 UNKNOWN TEMPLATE NAME.

An invalid template name is declared in the template geometry description
file.
Make sure that you use a valid template name.

#259 TEMPLATE NAME IS MISSING.

The template name is not defined in the geometry description file.

#260 CAN’T ALLOCATE MEMORY TO READ THE FILE WITH THE TEM-
PLATE DESCRIPTION.
There is not enough memory to continue the program. It is a system error.

#261 FILE WITH TEMPLATE DESCRIPTION IS EMPTY.

There is no data in the template geometry description file.

#262 FILE WITH LIST OF CYLINDRICAL COLLIMATORS IS NOT FOUND.

Check the file indicated via the :C_COLLIMATOR keyword in SPACE. file.
Make sure that the :C_COLLIMATOR keyword is not missing in the
“SPACE.INI” file. Then check keyword’s definition, then try again This key-
word should point to the full name of the file with descriptions of the cylindri-
cal collimator parameters.

694
 General Errors

#263 FILE WITH LIST OF DETECTORS IS NOT FOUND.

Check the file indicated via the :DETECTOR_PAR keyword in SPACE.INI
file.
Make sure that the :DETECTOR_PAR keyword is not missing in the
“SPACE.INI” file. Then check keyword’s definition, then try again This key-
word should point to the full name of the file with descriptions of the detector
parameters.

#264 THE DCG FILE NAME DECLARED IN THE DETECTOR ROW DE-
SCRIPTION IS NOT FOUND.
The description of the detector parameters includes the Detector Calibration
Generator [DCG] filename that is used to calculate the efficiency at the point
with the arbitrary XYZ coordinates. Make sure that the pointed DCG-filename
really exists.

#265 THE DETECTOR NAME IS MISSING IN THE INPUT PARAMETER

FILE.
The geometry description should refer to the symbolic name of detector that is
used in the measurement. Make sure that you indicate any detector name in
the geometry description.

#266 THE ENERGY LIST IS EMPTY.

The geometry description should refer to the list of energies that are used to
approximate the efficiency vs. energy function. Make sure you define the list
of energies.

#267 NEGATIVE VALUE ENTERED FOR EITHER ENERGY OR ERROR.

The geometry description refers to the list of energies that are used to approxi-
mate the efficiency vs. energy function. Check the list of energies for negative
values. Negative values are not allowed.

#268 THE ERROR ARRAY IS SHORTER THAN THE ENERGY ARRAY.

The geometry description refers to the list of energies that are used to approxi-
mate the efficiency vs. energy function. Make sure that the list contains the
same number of error values as the number of energy values.

#269 THE ENERGY ARRAY IS SHORTER THAN THE ERROR ARRAY.

The geometry description refers to the list of energies that are used to approxi-
mate the efficiency vs. energy function. Make sure that the list contains the
same number of energy values as the number of error values.

#270 FILE WITH LIST OF RECTANGULAR COLLIMATORS IS NOT FOUND.

Check the file indicated via the :R_COLLIMATOR keyword in SPACE. file.
Make sure that the :R_COLLIMATOR keyword is not missing in the
“SPACE.INI” file. Then check keyword’s definition, then try again This key-
word should point to the full name of the file with descriptions of the rectan-
gular collimator parameters.

695
LabSOCS/ISOCS Error Codes

#272 FILE WITH LIST OF HOUSINGS IS NOT FOUND.

Check the file indicated via the :UW_HOUSING keyword in SPACE. file.
Make sure that the :UW_HOUSING keyword is not missing in the
“SPACE.INI” file. Then check keyword’s definition, then try again This key-
word should point to the full name of the file with descriptions of the under-
water housing parameters.

#273 FILE NAME WITH THE PREDEFINED ENERGY LIST IS NOT FOUND.
The geometry description refers to the list of energies that are used to approxi-
mate the efficiency vs. energy function. The list of energies can be defined in
two different ways. User can input energies either directly from the keyboard
or by pointing to the name of the file that contains the list of energies. This er-
ror can appear when the pointed filename does not exist.

If you use the default filename, then make sure that the
:PREDEFINED_ELIST keyword of SPACE.INI file points to an existing file-
name.

#274 THE DCG FILE FORMAT IS INCOMPATIBLE WITH THE

LabSOCS/ISOCS SOFTWARE VERSION.
The description of the detector parameters includes the Detector Calibration
Generator [DCG] filename that is used to calculate the efficiency at the point
with the arbitrary XYZ coordinates. ISOCS software versions 1.2e and earlier
will work with DCG files generated using an older methodology. ISOCS ver-
sions 3.0 and later will work with DCG files generated using a new method.
The above error message can appear when the selected DCG file is damaged
or when the DCG creation method is incompatible with the ISOCS software
version.

#275 NOT ENOUGH ROOM FOR ABSORBER.

The space between the source and detector is not enough to accommodate the
generic absorber with the specified thickness. Change the total thickness of the
used generic absorber(s).

#276 DETECTOR IS BEHIND THE ABSORBER.

The above error message will appear when the definition of the detector loca-
tion makes it go through the generic absorber. Change the detector location
parameters and/or the total thickness of the used generic absorbers.

#277 DETECTOR IS BEHIND THE SOURCE REFERENCE PLANE.

The above error message will appear when the definition of the detector loca-
tion makes it go through the source reference plane. Change the detector loca-
tion parameters.

#278 NEGATIVE COLLIMATOR DIMENSION. SEE THE COLLIMATOR

DESCRIPTION.
It means that the value of one or more collimator dimensions is negative.

#279 INVALID DIMENSION FOR COLLIMATOR FRONT OPENING.

An invalid parameter value was used to define the conical [pyramidal] slope
of the front opening for the circular [rectangular] collimator.

696
 General Errors

#280 COLLIMATOR DOESN’T HAVE ENOUGH ROOM TO ACCOMMODATE

THE DETECTOR.
The collimator was defined so that the detector can’t be located inside the
collimator. Change the inside dimensions of collimator.

#281 COLLIMATOR IS BEHIND THE ABSORBER.

The collimator location was defined in such a way that the collimator goes
through the generic absorber. Change the detector location parameters or/and
the total thickness of the used generic absorbers.

#282 COLLIMATOR IS BEHIND THE SOURCE REFERENCE PLANE.

The detector location was defined in such a way that the collimator goes
through the source reference plane. Change the detector location parameters
or/and the collimator dimensions.

#283 INVALID HOUSING DIMENSION. SEE THE HOUSING DESCRIPTION.

It means that the value of one or more dimensions of the underwater housing
is negative or zero.

#284 HOUSING DOESN’T HAVE ENOUGH ROOM TO ACCOMMODATE

THE COLLIMATOR.
The underwater housing was defined in such a way that the defined collimator
can’t be located inside the housing. Change the inside dimensions of the hous-
ing.

#285 HOUSING DOESN’T HAVE ENOUGH ROOM TO ACCOMMODATE

THE DETECTOR.
The underwater housing was defined in such a way that the detector can’t be
located inside the housing. Change the inside dimensions of the housing.

#286 HOUSING IS BEHIND THE ABSORBER.

The detector location was defined in such a way that the underwater housing
goes through the generic absorber. Change the housing location parameters
or/and the total thickness of the used generic absorbers.

#287 HOUSING IS BEHIND THE SOURCE REFERENCE PLANE.

The detector location was defined in such a way that the underwater housing
goes through the source reference plane. Change the housing location parame-
ters.

#288 DETECTOR REFERENCE POINT IS BEHIND THE SOURCE

REFERENCE PLANE.
This source-detector geometry is not allowed [parameter sd1 0]. Change the
source-detector geometry so that the detector reference point is located in front
of the source reference plane.

697
LabSOCS/ISOCS Error Codes

#289 SOURCE-DETECTOR DISTANCE [SD1 PARAMETER] IS UNDEFINED.

A value must be entered in the ‘sd1’ field of the source-detector row. If the
‘sd1’ field is supposed to be zero, a zero (not a blank) must be entered. The
other ‘sdx’ fields may be left blank, and in those cases a blank is interpreted as
a zero. As an example, an entry of sd1=0 with sd2, sd3, sd4, and sd5 left blank
on the source-detector row is acceptable, and will run without any error mes-
sages.

#290 IF SOURCE-DETECTOR DISTANCE sd1=0, THEN sd4=sd2 and sd5=sd3

ARE REQUIRED.
The detector reference point is found to be on the source reference plane. To
prevent indeterminacy, only source-detector locations that satisfy the criterion
of sd4=sd2 and sd5=sd3 are allowed. Change the source-detector location pa-
rameters to fulfill the criterion of sd4=sd2 and sd5=sd3, if the sd1 distance is
required to be zero.

#292 A NEGATIVE CONCENTRATION VALUE.

A string of the source dimension table contains a negative value for the radio-
activity relative concentration. Make sure that the radioactivity relative con-
centration values are non-negative.

#293 NON RADIOACTIVE SAMPLE.

The radioactivity relative concentration is zero for all source layers. It means
that the sample is non-radioactive. Change the radioactivity relative concentra-
tions so that at least one of the source layers has a positive non-zero value.

#294 RADIOACTIVITY CONCENTRATION VALUE IS INDICATED FOR A

SOURCE WITH ZERO OR NEGATIVE THICKNESS.
A negative source layer dimension is detected in a string of the source table.
Or a layer with zero thickness has a non-zero value for the radioactivity con-
centration. Make sure that the source dimension table contains only
non-negative values defining the layer thickness. If the zero thickness layer is
used, make sure that the corresponding radioactivity concentration is zero.

#295 IMPOSSIBLE SAMPLE-DETECTOR LOCATION. CHECK BOTH THE

sd4 and sd5 VALUES.
This error message can appear to prevent the system math run-time error that
could occur due to rounding off while calculation of the trigonometrical func-
tions. The probability of the appearance of this error message is negligible.
But, if it appears, it means that the sd4 or/and the sd5 absolute value is too big.

#296 CAN’T OPEN THE AUXILIARY FILE: ECC_DATA.

The ECC_DATA is the auxiliary file that is used to store the intermediate in-
formation while the Efficiency Calibration Calculation [ECC] process is run-
ning. If this message appears, it means that the ECC_DATA file is damaged
due to some system error. The ECC process cannot be continued.

698
 General Errors

#297 CAN’T OPEN FILE WITH THE MU-LIBRARY TO CHECK THE INDI-
CATED MATERIALS IN THE TEMPLATE DESCRIPTION.
Most probably the materials library file has not been found. Make sure that the
materials library file exists, then try again.

#298 CAN’T FIND THE ‘DRYAIR’ MATERIAL TO GENERATE THE HUMID

AIR ATTENUATION.
ISOCS software uses the fixed material name to generate the attenuation/en-
ergy function for the humid air. This material name is expected to define the
dry air chemical content. If this name doesn’t exist in the materials library,
then the above error message appears. Include the ‘dryair’ material in the ma-
terials library, then try again.

#299 CAN’T FIND THE ‘WATER’ MATERIAL TO GENERATE THE HUMID

AIR ATTENUATION.
ISOCS software uses the fixed material name ‘water’ to generate the attenua-
tion/energy function for the humid air. This material name is expected to de-
fine the water chemical content. If this name doesn’t exist in the materials
library, then the above error message appears. Include the ‘water’ material in
the materials library, then try again.

#300 THE AIR TEMPERATURE VALUE IS OUT OF 0,100 C DEGREE

INTERVAL.
The [-50, 100 degree of Celsius] interval is limit of the air temperature range
for ISOCS software. Make sure that the value of the air temperature is within
the above interval, then try again.

#301 THE AIR RELATIVE HUMIDITY VALUE IS OUT OF ,100 p.c.

INTERVAL.
The [0, 100 %] interval is limit of the relative humidity range. Make sure that
the value of the relative humidity is within the above interval, then try again.

#302 THE AIR BAROMETRIC PRESSURE IS TOO LOW FOR GIVEN T and
RH.
Doing a model computation, user could err estimating the Barometric Air
Pressure [BAP] at the given temperature and Relative Humidity [RH]. The
BAP is a sum of the dry air and the Saturated Water Steam [SWS] partial pres-
sures, where the SWS partial pressure depends on only the temperature and
RH. Thus the BAP anyway may not be less than the SWS partial pressure at
given T and RH. For example, the BAP may not be zero if the RH is not zero.
To prevent the invalid BAP value inserted by user, software checks the in-
equality: BAP ≥ SWS partial pressure. If this inequality is not fulfilled, then
software outputs the above message. Change the BAP value, then try again.

#303 THE AIR BAROMETRIC PRESSURE VALUE IS TOO HIGH (2000 mm

Hg).
The 2000 mm.Hg. value is set as some reasonable limitation for the Air Baro-
metric Pressure [BAP]. Make sure that the BAP value is less than the above
limit, then try again.

699
LabSOCS/ISOCS Error Codes

#304 MATERIAL OR DENSITY PROBLEM. SEE THE SOURCE TABLE.

Either the material name without the density value or the density value with-
out the material name is indicated in the table of the source description. Make
sure that each material name is used with the density value, then try again.

#305 d.1 PARAMETER MAY NOT BE ZERO IF MATERIAL IS PRESENT. SEE

THE SOURCE TABLE.
A material name and/or a non-zero density value is not allowed for a zero
thickness layer. Make sure that both the material name and the density value
are not used for the zero thickness layers, then try again.

#306 BOTH MATERIAL AND DENSITY ARE UNDEFINED. SEE THE

SOURCE TABLE.
Both a material and its density are required for any non-zero thickness layer.
Make sure the source, collimator, and underwater housing definitions don’t
contain a non-zero thickness value without both the material name and the
density value being defined. Then try again.

#307 A MATERIAL NAME USED IN THE TEMPLATE DESCRIPTION

DOESN’T EXIST IN THE MATERIALS LIBRARY.
Each material name that is used in the template description should exist in the
materials library. Make sure that all the used material names are valid and re-
ally exist in the materials library. Then try again.

#308 HOUSING INSIDE MATERIAL DENSITY IS ZERO.

This message can appear if an underwater housing is used. Inside material de-
fines environment [usually air] inside the housing. The error message means
that the inside material name is indicated with the density zero value. Make
sure that this density value is positive, then try again.

#309 HOUSING INSIDE MATERIAL NAME DOESN’T EXIST IN LIBRARY.

This message can appear if an underwater housing is used. Inside material de-
fines environment [usually air] inside the housing. The error message means
that the indicated inside material name doesn’t exist in the materials library.
Make sure that the used material name is valid and really exists in the materi-
als library. Then try again.

#310 HOUSING OUTSIDE MATERIAL DENSITY IS ZERO.

This message can appear if an underwater housing is used. Outside material
defines environment [e.g. water] outside the housing. The error message
means that the outside material name is indicated with the density zero value.
Make sure that this density value is positive, then try again.

#311 HOUSING OUTSIDE MATERIAL NAME DOESN’T EXIST IN LIBRARY.

This message can appear if an underwater housing is used. Outside material
defines environment [e.g. water] outside the housing. The error message
means that the indicated outside material name doesn’t exist in the materials
library. Make sure that the used material name is valid and really exists in the
materials library. Then try again.

700
 General Errors

#312 SAMPLE GOES THROUGH ABSORBER. CHECK THE LOCATION

DISTANCES.
The source/detector location parameters are defined in such a way that the
source goes through the absorber layer. Change the source/detector location
parameters and/or the total thickness of the used generic absorbers.

#313 SAMPLE GOES THROUGH DETECTOR.

The source/detector location parameters are defined in such a way that the
source goes through the detector. Change the source/detector location parame-
ters.

#315 OUT OF THE CALIBRATION ENERGY OR [AND] DISTANCE REGION.

The source is located too far from the detector. And the current DCG file can’t
support the Efficiency Calibration Calculation [ECC] at these distances. Or the
current DCG file can’t support the ECC at the required energy values. Change
source/detector location parameters and/or the list of energies, then try again.

#317 NOT ENOUGH MEMORY TO ALLOCATE ‘SPACE.INI’ FILE.

There is not enough memory to continue the program. It is a system error.

#318 CAN’T FIND THE ‘SPACE’ VALUE IN PROCESS ENVIRONMENT.

The ISOCS software searches for the ‘SPACE’ value in the process environ-
ment to determine the SPACE.INI file location. This error message means that
the ISOCS software is incorrectly installed. Most probably the registry entries
for the ‘SPACE’ value are invalid.

#319 CAN’T OPEN ‘SPACE.INI’ FILE.

The ‘space.ini’ file contains the structure of directories that are used while
running the ISOCS software. The error message means that the ‘space.ini’ file
is not found. Make sure that the ‘space.ini’ file really exists. If so, then most
probably, the registry entries for the ‘SPACE’ value are invalid.

#320 THE ‘SPACE.INI’ FILE IS EMPTY.

The ‘space.ini’ file should contain the structure of directories that are used
while running the ISOCS software. The error message means that the
‘space.ini’ file is blank.

#322 THE :SPACE_CALIBRATION KEYWORD IS MISSING IN ‘SPACE.INI’

FILE.
The :SPACE_CALIBRATION keyword determines the folder where the files
with the DCGs are stored. Include both the :SPACE_CALIBRATION key-
word and its definition in the ‘space.ini’ file, then try again.

#323 THE :SOURCE_PARAMETERS KEYWORD IS MISSING IN ‘SPACE.INI’

FILE.
In case of batch-mode of ISOCS, the :SOURCE_PARAMETERS keyword
determines the folder where the files with the template geometry description
are stored. Include both the :SOURCE_PARAMETERS keyword and its defi-
nition in the ‘space.ini’ file, then try again.

701
LabSOCS/ISOCS Error Codes

#324 THE :ATTENUATION_LIBRARY KEYWORD IS MISSING IN

‘SPACE.INI’ FILE.
The :ATTENUATION_LIBRARY keyword determines the folder where the
files with the materials library are stored. Include both the
:ATTENUATION_LIBRARY keyword and its definition in the ‘space. file,
then try again.

#326 THE :TABLE_KIT KEYWORD IS MISSING IN ‘SPACE.INI’ FILE.

The :TABLE_KIT keyword determines the folder that is used to store the in-
termediate data while ISOCS running. This folder is also used to store both the
‘fatalerr.txt’ file containing the error messages and the ‘report.txt’ file contain-
ing the results on the integral convergence while the ECC. Include both the
:TABLE_KIT keyword and its definition in the ‘space.ini’ file, then try again.

#327 THE :ECC_OUTPUT KEYWORD IS MISSING IN ‘SPACE.INI’ FILE.

The :ECC_OUTPUT keyword determines the folder that is used to store the
results on the Efficiency Calibration Calculation [ECC]. Include both the
:ECC_OUTPUT keyword and its definition in the ‘space.ini’ file, then try
again.

#328 THE :COINCIDENCE KEYWORD IS MISSING IN ‘SPACE.INI’ FILE.

The :COINCIDENCE keyword determines the folder that is used to store the
information supporting the further computation on coincidence. Include both
the :COINCIDENCE keyword and its definition in the ‘space.ini’ file, then try
again.

#329 EITHER AN INVALID MATERIAL OR DENSITY VALUE IN

DETECTOR PARAMETERS.
The description of the detector parameters uses a number of the material
names. Make sure that each material name is indicated with a non-zero density
value. Then try again.

#330 A MATERIAL IN DETECTOR DESCRIPTION IS NOT IN THE LIBRARY.

The description of the detector parameters uses a number of material names.
The error message means that an indicated material name doesn’t exist in the
materials library. Make sure that all the used material names are valid and re-
ally exist in the materials library. Then try again.

#331 TEMPLATE’S NAME IS TOO LONG.

Check the file indicated via the :ISOCS_TMPL_NAME keyword in
SPACE.INI file.
The file indicated via the :ISOCS_TMPL_NAME keyword is intended to store
the list of the template names. The error message means that a template name
length exceeds the 255 symbols limit. Change the template name, then try
again.

702
 General Errors

#332 CAN’T OPEN FILE WITH THE LIST OF ISOCS TEMPLATE NAMES.
Check the full filename indicated via the :ISOCS_TMPL_NAME keyword in
SPACE.INI file.
The list of the template names is stored in the file that location is indicated via
the :ISOCS_TMPL_NAME keyword of ‘space.ini’ file. Make sure that the in-
dicated file really exists. Then try again.

#333 THE FILE WITH THE LIST OF ISOCS TEMPLATE NAMES IS EMPTY.
Check the file indicated via the :ISOCS__NAME keyword in SPACE.INI file.
The list of the template names is stored in the file that location is indicated via
the :ISOCS_TMPL_NAME keyword of ‘space.ini’ file. The error message
means that the indicated file was blank. Restore the template names to the
file,, then try again.

#334 EMPTY TEMPLATE NAME FOUND.

Check the file indicated via the :ISOCS__NAME keyword in SPACE. file.
The list of the template names is stored in the file that location is indicated via
the :ISOCS_TMPL_NAME keyword of ‘space.ini’ file. The error message
means that one of the names was found blank. Replace the blank name with a
valid template name, then try again.

#335 ORDER NUMBER OF THE TEMPLATE NAME IS MISSING.

Check the file indicated via the :ISOCS_TMPL_NAME keyword in
SPACE.INI file.
The list of the template names is stored in the file that location is indicated via
the :ISOCS_TMPL_NAME keyword of ‘space.ini’ file. Each template name
of the list goes with the order number that is intended for further use in ISOCS
software. The error message means that one of the names was found without
the order number. Insert the lost order number in a proper way, then try again.

#336 CAN’T OPEN ECC_DATA FILE TO RETRIEVE THE TEMPLATE

PARAMETERS FROM DISK.
ISOCS uses the auxiliary ‘ECC_DATA’ file to store the template parameters
in the internal representation. The error message means that the ‘ECC_DATA’
file can not be open due to some system error. The ISOCS can not be contin-
ued.

#337 ECC_DATA FILE CONTAINS AN INVALID TEMPLATE NAME.

ISOCS uses the auxiliary ECC_DATA’ file to store the template parameters in
the internal representation. The error message means that the ‘ECC_DATA’
file contains an unexpected template name. Make sure that the file assigned
via the :ISOCS_TMPL_NAME keyword contains the proper list of the tem-
plate names. Then try again.

703
LabSOCS/ISOCS Error Codes

#338 THE NUMBER OF ITERATIONS FOR ECC INTEGRATION MUST BE

GREATER THAN OR EQUAL TO 3.
The Efficiency Calibration Computation [ECC] process uses an iterative
Monte-Carlo numeric integration method that doubles the number of random
points at the end of every iteration. The ECC requires at least 3 iterations to
estimate the convergence of the efficiency integral. Also, the maximum num-
ber of random points [N] that ISOCS can generate is 2 20. Thus, if random
points for the first iteration [n1] is set to a value greater than 2 18, then for the
third iteration the number of random points would exceed 2 20, and the above
error message would appear. Change the n1 value so that the product 8*n1
product does not exceed 220.

#339 CAN’T WRITE BACK FILE FOR THE RUN+ADD MODE OF .

This error message can appear when ISOCS is applied for a multi-detector
measurement system. This is the system error that could most probably indi-
cate insufficient space on hard disk to write the file back. Program cannot be
continued.

#340 CAN’T CREATE FILE TO WRITE THE ECC RESULTS.

This is the system error that could most probably indicate insufficient space on
hard disk to write the ECC results. Program cannot be continued.

#341 SOME DIMENSION OF SAMPLE IS TOO SMALL. ECC CAN’T BE

DONE.
Some dimension of sample is too small making the sample volume 1e-15
mm3. To avoid the math run-time errors due to rounding while computation,
the 1e-15 mm3 has been set in ISOCS as the limit for sample volume. Change
the sample dimensions, then try again.

#342 DLL FOR THE TEMPLATE INDICATED IN THE GEOMETRY DESCRIP-

TION FILE IS NOT FOUND.
DLL loading failed while trying to find it in the directory assigned via
:PROGRAM keyword in SPACE.INI file.
Each geometry template is supported by the corresponding n.DLL that should
be located in the directory assigned via the :PROGRAM keyword. Where n=1,
2, … is the order number of the geometry template. To determine the n value,
see the list of the template names in the file assigned via the
:ISOCS_TMPL_NAME keyword in ‘space.ini’ file. Then make sure that the
DLL with that n exists in the directory assigned via the :PROGRAM keyword.
Then try again. If the required n.DLL is absent, the program cannot be contin-
ued.

#343 THE CURRENT TEMPLATE DLL FAILED.

This is a system error. The program cannot be continued.

704
 General Errors

#344 THE ISOCS_PBAR.DLL IS MISSING.

DLL loading failed while trying to find it in the directory assigned via
:PROGRAM keyword in SPACE.INI file.
The ISOCS_PBAR.DLL is intended to support displaying both the geometry
template main parameters and the ECC progress. Make sure that the
ISOCS_PBAR.DLL exists in the directory assigned via the :PROGRAM key-
word. Then try again.

#345 THE :PROGRAM KEYWORD IS MISSING IN ‘SPACE.INI’ FILE.

The :PROGRAM keyword determines the folder that is used to store the exe-
cutable programs for ISOCS. Include both the :PROGRAM keyword and its
definition in the ‘space.ini’ file, then try again.

#346 THE :C_COLLIMATOR KEYWORD IS MISSING IN ‘SPACE.INI’ FILE.

The :C_COLLIMATOR keyword determines the file that is used to store the
descriptions of the available cylindrical collimators. Include both the
:C_COLLIMATOR keyword and its definition in the ‘space. file, then try
again.

#347 THE :R_COLLIMATOR KEYWORD IS MISSING IN ‘SPACE.INI’ FILE.

The :R_COLLIMATOR keyword determines the file that is used to store the
descriptions of the available rectangular collimators. Include both the
:R_COLLIMATOR keyword and its definition in the ‘space. file, then try
again.

#348 THE :UW_HOUSING KEYWORD IS MISSING IN ‘SPACE.INI’ FILE.

The :UW_HOUSING keyword determines the file that is used to store the de-
scriptions of the available underwater housings. Include both the
:UW_HOUSING keyword and its definition in the ‘space.ini’ file, then try
again.

#349 ECC WAS INTERRUPTED DUE TO PROGRESS BAR ERROR: Can’t find
ISOCS_CreateProgressBar function.
This is a system error. Program can not be continued.

#350 ECC WAS INTERRUPTED DUE TO PROGRESS BAR ERROR: Can’t find
ISOCS_RefreshProgressBar function.
This is a system error. Program cannot be continued.

#351 ECC WAS INTERRUPTED DUE TO PROGRESS BAR ERROR: Can’t find
ISOCS_DestroyProgressBar function.
This is a system error. Program cannot be continued.

#352 ECC WAS INTERRUPTED DUE TO PROGRESS BAR ERROR: Can’t de-
stroy Progress Bar.
This is a system error. Program cannot be continued.

#353 ECC WAS INTERRUPTED DUE TO PROGRESS BAR ERROR: Can’t Cre-
ate Progress Bar.
This is a system error. Program cannot be continued.

705
LabSOCS/ISOCS Error Codes

#354 ECC WAS INTERRUPTED DUE TO PROGRESS BAR ERROR: Can’t Re-
fresh Progress Bar.
This is a system error. Program cannot be continued.

#355 ECC INTERRUPTED BY USER.

During the execution of the Efficiency Calibration Computation [ECC], the
user has pushed the STOP button to interrupt the ECC.

#356 SPACE AVAILABLE ON DISK IS NOT ENOUGH TO WRITE

COINCIDENCE CALCULATION DATA.
This error message can appear when ISOCS was run in ‘coincidence’ mode to
store on hard disk the information supporting the further computation on coin-
cidence. But, it was found during computation that the hard disk doesn’t have
sufficient space for the program to continue.

#357 THE :DETECTOR_PAR KEYWORD IS MISSING IN ‘SPACE.INI’ FILE.

The :DETECTOR_PAR keyword determines the file that is used to store the
descriptions of the available detectors. Include both the :DETECTOR_PAR
keyword and its definition in the ‘space.ini’ file, then try again.

#358 THE :ISOCS__NAME KEYWORD IS MISSING IN ‘SPACE.INI’ FILE.

The :ISOCS_TMPL_NAME keyword determines the file that is used to store
the list of the available template names. Include both the
:ISOCS_TMPL_NAME keyword and its definition in the ‘space.ini’ file, then
try again.

#359 ORDER NUMBER OF THE TEMPLATE NAME IS TOO BIG.

Check the file indicated via the :ISOCS_TMPL_NAME keyword in
SPACE.INI file.
The list of the template names is stored in the file that location is indicated via
the :ISOCS_TMPL_NAME keyword of ‘space.ini’ file. Each template name
of the list goes with the order number that is intended for the further use in
ISOCS software. The error message means that the order number exceeds the
allowed maximum of 40. Change the invalid order number, then try again.

#360 DECLARED CYLINDRICAL COLLIMATOR NAME IS NOT FOUND.

Check the file indicated via the :C_COLLIMATOR keyword in SPACE.INI
file.
The :C_COLLIMATOR keyword determines the file that is used to store the
descriptions of the available cylindrical collimators. Each collimator descrip-
tion includes a collimator name that is used as reference to identify the re-
quired collimator in the geometry template description. The above error
message means that the cylindrical collimator name indicated in the geometry
template description was not found in the file containing cylindrical collimator
descriptions. Make sure that the required collimator name is included in the
file with the cylindrical collimator descriptions. Then try again.

706
 General Errors

#361 DECLARED RECTANGULAR COLLIMATOR NAME IS NOT FOUND.

Check the file indicated via the :R_COLLIMATOR keyword in SPACE.INI
file.
The :R_COLLIMATOR keyword determines the file that is used to store the
descriptions of the available rectangular collimators. Each collimator descrip-
tion includes a collimator name that is used as reference to identify the re-
quired collimator in the geometry template description. The above error
message means that the rectangular collimator name indicated in the geometry
template description was not found in the file containing rectangular
collimator descriptions. Make sure that the required collimator name is in-
cluded in the file with the rectangular collimator descriptions. Then try again.

#362 DECLARED HOUSING NAME IS NOT FOUND.

Check the file indicated via the :UW_HOUSING keyword in SPACE.INI file.
The :UW_HOUSING keyword determines the file that is used to store the de-
scriptions of the available underwater housings. Each housing description in-
cludes a housing name that is used as reference to identify the required
housing in the geometry template description. The above error message means
that the housing name indicated in the geometry template description was not
found in the file containing housing descriptions. Make sure that the required
housing name is included in the file with the housing descriptions. Then try
again.

#363 DECLARED DETECTOR NAME IS NOT FOUND.

Check the file indicated via the :DETECTOR_PAR keyword in SPACE.INI
file.
The :DETECTOR keyword determines the file that is used to store the de-
scriptions of the available detectors. Each detector description includes a de-
tector name that is used as reference to identify the required detector in the
geometry template description. The above error message means that the detec-
tor name indicated in the geometry template description was not found in the
file with detector descriptions. Make sure that the required detector name is in-
cluded in the file with detector descriptions. Then try again.

#364 THE :PREDEFINED_ELIST KEYWORD IS MISSING IN ‘SPACE.INI’

FILE.
The :PREDEFINED_ELIST keyword determines the file that is used to store
the list of the energies that can be used as default in the ECC process. Include
both the :PREDEFINED_ELIST keyword and its definition in the ‘space.ini’
file, then try again.

#365 TEMPLATE NAME USED IN THE GEOMETRY DESCRIPTION FILE IS

TOO LONG.
Among the other parameters, the geometry template description always con-
tains the geometry template name. The above error message means that the
length of the name exceeds 255 characters. Change the name, then try again.

707
LabSOCS/ISOCS Error Codes

#366 THE NAME OF THE BEAKER DESCRIPTION FILE USED IN THE

GEOMETRY FILE IS TOO LONG.
In case of the pre-defined container shape, the geometry template description
may refer to the name of a file that contains the definition of the beaker con-
tour. The above error message means that the length of the name exceeds 255
characters. Change the name, then try again.

#367 HOUSING NAME IS TOO LONG.

The geometry template description may refer to the name to identify the de-
scription of the underwater housing parameters. The above error message
means that the length of the name exceeds 255 characters. Change the name,
then try again.

#368 CYLINDRICAL COLLIMATOR NAME IS TOO LONG.

The geometry template description may refer to the name to identify the de-
scription of the cylindrical collimator parameters. The above error message
means that the length of the name exceeds 255 characters. Change the name,
then try again.

#369 RECTANGULAR COLLIMATOR NAME IS TOO LONG.

The geometry template description may refer to the name to identify the de-
scription of the rectangular collimator parameters. The above error message
means that the length of the name exceeds 255 characters. Change the name,
then try again.

#370 DETECTOR NAME IS TOO LONG.

The geometry template description always refers to the name to identify the
description of the detector parameters. The above error message means that
the length of the name exceeds 255 characters. Change the name, then try
again.

#371 SYNTAX ERROR. THE NAME OF FILE WITH PREDEFINED ENERGIES

IS EXPECTED AS A QUOTED STRING.
The geometry template description may refer to the name to identify the file
containing the list of the predefined energies. The used filename should be
quoted [the double quote symbols are required]. The above error message
means the invalid syntax for the used filename. Correct the filename syntax,
then try again.

#372 NAME OF FILE WITH THE PREDEFINED ENERGIES IS TOO LONG.

The geometry template description may refer to the name to identify the file
containing the list of the predefined energies. The above error message means
that the length of the filename exceeds 255 characters. Change the filename,
then try again.

708
 General Errors

#373 INVALID LENGTH UNIT.

The geometry template description may indicate the length in any of the fol-
lowing units:
MM means millimeter;
CM means centimeter;
M means meter;
IN means inch;
FT means foot.
If the length unit is not indicated, the MM is used as default.
The above error means that an invalid syntax was detected for the length unit.
Change the length unit definition, then try again.

#374 INVALID DENSITY UNIT.

The geometry template description may indicate the density in any of the fol-
lowing units:
G/CU.C means the gram per cubic centimeter;
KG/CU.M means the kilogram per cubic meter;
LB/CU.FT means the pound per cubic foot;
If the density unit is not indicated, the G/CU.C is used as default.
The above error means that an invalid syntax was detected for the density unit.
Change the density unit definition, then try again.

#375 INVALID PRESSURE UNIT.

The geometry template description may indicate the air pressure in any of the
following units:
MM.HG means the millimeters of the mercury column;
BAR means the 1 technical atmosphere;
IN.HG means the inches of the mercury column;
KPA means the kilopascal;
If the air pressure unit is not indicated, the MM.HG is used as default.
The above error means an invalid syntax was detected for the air pressure unit.
Change the air pressure unit definition, then try again.

#376 INVALID TEMPERATURE UNIT.

The geometry template description may indicate the air temperature in units of
either F [Fahrenheit degrees] or C [Celsius degrees]. If the air temperature unit
is not indicated, the unit C is used as default. The above error means that an
invalid syntax was detected for the air temperature unit. Change the air tem-
perature unit definition, then try again.

#377 FILE INTENDED TO STORE THE RESULTS HAS A LONG NAME.

The geometry template description may refer to the name to identify the file
that is intended to store the ECC results. The above error message means that
the length of the filename exceeds 255 characters. Change the filename, then
try again.

#378 FULL FILE NAME PATH IS TOO LONG.

A fully qualified file name cannot exceed 260 characters.

709
LabSOCS/ISOCS Error Codes

#601 SAMPLE IS OUT OF THE COMPLEX BOX CONTAINER. SEE THE

SOURCE TABLE.
The sum of the height of the source layers is greater than the container inside
height. Change the sample height or/and the inside container height, then try
again.

#602 AN INVALID DIMENSION IN THE RECTANGULAR HOT SPOT.

CHECK THE HOT SPOT DIMENSIONS IN SOURCE TABLE.
Upon checking the ‘complex box’ template dimensions, it was found that
some dimension defining the source concentration is negative. Make sure that
all parameters defining the source concentration are positive, then try again.

#603 RECTANGULAR HOT SPOT IS OUT OF CONTAINER.

Upon checking the ‘complex box’ template definition, it is found that some of
the parameters that define the hot spot location make the concentrated source
to be out of container. Change the concentrated source location to place it in-
side the container. Then try again.

#651 SAMPLE IS OUT OF THE SIMPLE BOX CONTAINER. CHECK THE

SOURCE TABLE.
The sum of the height of the source layers is greater than the container inside
height. Change the sample height or/and the inside container height, then try
again.

#751 SAMPLE IS OUT OF THE COMPLEX CYLINDER CONTAINER. CHECK

THE SOURCE TABLE.
The sum of the height of the source layers is greater than the container inside
height. Change the sample height or/and the inside container height, then try
again.

#752 AN INVALID DIMENSION FOR SPHERICAL HOT SPOT. CHECK THE

HOT SPOT DIMENSIONS IN SOURCE TABLE.
Upon checking the ‘complex cylinder’ template dimensions, it was found that
some parameter(s) defining the spherical hot spot is negative. Make sure that
all parameters defining the concentrated source are positive, then try again.

#753 SPHERICAL HOT SPOT IS OUT OF CONTAINER.

Upon checking the ‘complex cylinder’ template definition, it was found that
some of the parameters defining the hot spot location make the concentrated
source to be out of container. Change the concentrated source location to place
it inside the container. Then try again.

#801 SAMPLE IS OUT OF THE SIMPLE CYLINDER CONTAINER. CHECK

THE SOURCE TABLE.
The sum of the height of the source layers is greater than the container inside
height. Change the sample height or/and the inside container height, then try
again.

710
 General Errors

#851 NOT ENOUGH ROOM FOR THE SPHERE TEMPLATE SOURCES.

Upon checking the ‘sphere’ template definition, it is found that the inside di-
ameter of the shell is too small to accommodate the sources. Change the shell
inside diameter and/or the shell thickness, then try again.

#901 WELL DIAMETER TOO SMALL TO FIT THE DETECTOR.

The ‘well or Marinelli beaker’ template dimensions are defined such that the
detector cannot be located inside the well. Check the well diameter, the con-
tainer thickness, and the horizontal detector location to fix the error. Then try
again.

#902 UNDERWATER HOUSING OR COLLIMATOR IS IN CONFLICT WITH

MARINELLI REFERENCE PLANE.
This error message appears if the source-detector location in the ‘well or
Marinelli beaker’ template is defined such that the collimator and/or the un-
derwater housing assembly is in conflict with the Marinelli reference plane. In
ISOCS, the Marinelli reference plane is located at the bottom of the well.
Check the collimator, underwater housing, and source-detector parameters to
fix the error.

#951 A NEGATIVE DIMENSION VALUE IS INDICATED IN THE PIPE

TEMPLATE. CHECK TABLE OF SAMPLE PARAMETERS.
Some of dimensions in the ‘pipe’ template were found to be negative. Make
sure that all dimensions of the sample are positive, then try again.

#952 PIPE DIAMETER IS TOO SMALL. NOT ENOUGH ROOM FOR SOURCE
No.2.
Upon checking the ‘pipe’ template dimensions it is found that the pipe inside
diameter is not enough to locate source No.2. Make sure that source No.2 can
be located inside the pipe, then try again.

#1001 SPHERICAL SOURCE IS OUT OF DRUM.

Upon checking the ‘special sphere’ template dimensions it was found that the
drum doesn’t have enough room to include the spherical source. Change the
drum inside dimensions or/and the sphere total diameter to fix the error. Then
try again.

#1051 AO VALUE IS OUT OF THE [0,1] LIMIT. REENTER AO..

The message can appear if the ‘Exponential Circular Plane’ template is used.
Ao is one of the parameters that define the functional form of the radioactivity
distribution inside the source layer. For more details see description of the
‘Exponential Circular Plane’ template. Make sure that Ao≤ 1.

#1052 DMAX IS GREATER THAN SOURCE THICKNESS. REENTER DMAX.

The message can appear if the ‘Exponential Circular Plane’ template is used.
Dmax is one of the parameters that defines the functional form of the radioac-
tivity distribution inside the source layer. For more details see description of
the ‘Exponential Circular Plane’ template. Make sure that the value of Dmax
is less than the source thickness.

711
LabSOCS/ISOCS Error Codes

#1053 DRL VALUE MUST BE POSITIVE. REENTER DRL.

The message can appear if the ‘Exponential Circular Plane’ template is used.
Dmax is one of the parameters that defines the functional form of the radioac-
tivity distribution inside the source layer. For more details see description of
the ‘Exponential Circular Plane’ template. Make sure that DRL is positive,
then try again.

#1101 THE BEAKER DESCRIPTION FILE IS EMPTY.

The ‘beaker’ template may refer to a file that is intended to store the definition
of a pre-defined container shape. That file was found to be blank. Make sure
you use the proper file, then try again.

#1102 CAN’T OPEN THE BEAKER DESCRIPTION FILE.

The ‘beaker’ template may refer to a file that is intended to store the definition
of a pre-defined container shape. The error message means that the filename
cannot be found in the folder assigned via the :SOURCE_PARAMETERS
keyword in the SPACE. file. Ensure that the file really exists, then try again.

#1103 TOO MANY MATERIAL NAMES ARE USED IN THE BEAKER

DESCRIPTION FILE.
The ‘beaker’ template may refer to a file that is intended to store the descrip-
tion of a pre-defined container shape. The error message means that the beaker
description uses too many material names [maximum limit is 8 different mate-
rial names]. Change the beaker description taking into account this limitation,
then try again.

#1104 ZERO OR NEGATIVE VALUE OF A MATERIAL DENSITY IS USED IN

THE BEAKER DESCRIPTION FILE.
The ‘beaker’ template may refer to a file that is intended to store the descrip-
tion of a pre-defined container shape. The error message means that the beaker
description contains a non-positive value to indicate a material density. Make
sure that all the density values are positive, then try again.

#1105 AN INVALID ID-NAME OF FRAGMENT IS USED IN THE BEAKER

DESCRIPTION FILE.
The letters O | I | B are allowed to identify the type [ID-name] of a fragment
belonging to the inner | outer | boundary contour, respectively. Make sure you
use proper ID-names in the beaker description. Then try again.

#1106 DEFAULT MATERIAL NAME MAY NOT BE USED IN THE 1st ROW OF
THE BEAKER DESCRIPTION FILE.
The beaker description may use the default material name in any row of de-
scription except the 1st row. Define the material in the 1st row of description,
then try again.

712
 General Errors

#1107 AN UNDEFINED MATERIAL NAME IS FOUND IN THE BEAKER

DESCRIPTION FILE.
The beaker description may use the default material name in any row of de-
scription except the 1st row. The description syntax requires the comma sym-
bol separating the material name even if it is defaulted. If a comma delimiter is
absent, the material name is assumed to be improperly defined, causing the
above error message. Make sure you use comma where the default name is de-
sired. Then try again.

#1108 A NEGATIVE DIAMETER VALUE IS FOUND IN THE BEAKER

DESCRIPTION FILE.
Among other parameters the beaker description contains the diameter values
to define the fragments of the beaker contours. The error message means that
the description includes a negative diameter value. Make sure you use only
non-negative diameter values in the beaker description. Then try again.

#1109 DENSITY VALUE IS NOT ALLOWED IF DEFAULT MATERIAL NAME

IS USED IN THE BEAKER DESCRIPTION FILE.
The beaker description may use the default material name in any row of de-
scription except the 1st row. However, a density value should not be entered if
the material name in a row is indicated as default. Remove the density value
for the defaulted material name. Then try again.

#1110 NEITHER A MATERIAL NAME NOR A DENSITY IS ALLOWED FOR A

BOUNDARY FRAGMENT IN THE BEAKER DESCRIPTION FILE.
The beaker description may contain fragments defining inner, outer, and
boundary contours. Boundary fragments may be defined only at a contour
node where fragments with two different materials join. Therefore, neither a
material name nor a density value is allowed in the definition of a boundary
fragment. Remove the material name and/or the density value from the bound-
ary fragment contour definition.

#1111 NUMBER OF FRAGMENTS USED IN THE BEAKER DESCRIPTION

FILE EXCEEDS 200.
The ‘beaker’ template may refer to a file that is intended to store the descrip-
tion of a pre-defined container. The description may contain fragments defin-
ing the inner, outer, and boundary contours. The maximum number of
fragments that can be used in the description is 200. Modify the description so
that the number of fragments used is less than 200. Then try again.

#1116 INNER CONTOUR IS MISSING IN THE BEAKER DESCRIPTION FILE.

The beaker description may include the inner, outer, and boundary contours.
While the outer contour and the boundary contour are not required to be pres-
ent, it is mandatory that the inner contour be present in the description. The
above error message means that no fragments belonging to the inner contour
were found in the beaker description.

713
LabSOCS/ISOCS Error Codes

#1117 TOO FEW INNER CONTOUR FRAGMENTS IN THE BEAKER

DESCRIPTION FILE.
The above error message means that, upon checking the beaker description, it
was found that the inner contour consists of only a single fragment. At least
two inner contour fragments are required to be present [the simplest conical
beaker]. Change the description to fix the error, then try again.

#1118 TOO FEW OUTER FRAGMENTS IN THE BEAKER DESCRIPTION FILE.

It is possible to define a beaker with a zero wall-thickness, (.e) without an
outer contour. But if the outer contour is indeed defined, then it should consist
of at least 2 fragments [the simplest conical beaker]. The above error message
indicates that the outer contour consists of only a single fragment.

#1119 BOUNDARY FRAGMENTS ARE NOT ALLOWED IN THE BEAKER

DESCRIPTION FILE IF OUTER CONTOUR IS MISSING.
It is possible to define a beaker with a zero wall-thickness, (i.e) without an
outer contour. But when the outer contour is not defined, it is not valid to de-
fine a boundary fragment, since the length of the boundary fragment would
become zero. Remove the boundary fragment(s) to fix the error. Then try
again.

#1120 A BOUNDARY NODE ISN’T JOINED TO ANY FRAGMENT IN THE

BEAKER DESCRIPTION FILE.
The ‘beaker’ template may refer to file that contains the description of a
pre-defined container. The description may contain definitions of inner, outer,
and boundary contours. The inner, outer, and boundary contour definitions
consist of fragments. A fragment is a line segment connecting two nodal
points defined in the Cartesian coordinate system. The beaker description re-
quires that each boundary fragment be joined with another [or inner, or outer,
or boundary] fragment end. Change the erroneous node coordinates to fix the
error. Then try again.

#1121 THE BEAKER DESCRIPTION FILE CONTAINS A BOUNDARY NODE

LOCATED ON THE BEAKER SYMMETRY AXIS.
Since a boundary fragment is assumed to separate two different materials, the
boundary end may not be located on the beaker rotation axis. Otherwise, the
symmetrical fragments would consist of the different materials. Change the er-
roneous node coordinates to fix the error. Then try again.

#1122 THE BEAKER DESCRIPTION FILE CONTAINS TWO COINCIDING

FRAGMENTS.
A VERTICAL BOUNDARY FRAGMENT IS ONE OF THEM.
Neither an inner nor an outer fragment is allowed to fully coincide with a
boundary fragment. Note that the above error message contains a more precise
definition identifying the erroneous boundary fragment as a vertical fragment.
Change the erroneous fragment coordinates to fix the error. Then try again.

714
 General Errors

#1123 THE BEAKER DESCRIPTION FILE CONTAINS TWO FRAGMENTS

INTERSECTING AT A NON-NODAL POINT.
It is required that none of the defined fragments intersect any other fragment at
a point other than the nodal points. Change the erroneous fragment coordi-
nates to fix the error. Then try again.

#1124 THE BEAKER DESCRIPTION FILE CONTAINS TWO COINCIDING

FRAGMENTS. A BOUNDARY FRAGMENT IS ONE OF THEM.
Neither an inner nor an outer fragment is allowed to fully coincide with a
boundary fragment. Change the erroneous fragment coordinates to fix the er-
ror. Then try again.

#1125 A DISCONTINUITY OF THE INNER CONTOUR IS FOUND IN THE

BEAKER DESCRIPTION FILE.
It is required that all fragments of the inner contour must be joined end to end
making up a continuous polygonal line that starts and ends on the beaker sym-
metry axis. If it is not the case, the above error message appears. Change the
erroneous fragment coordinates to fix the error. Then try again.

#1126 A DISCONTINUITY OF THE OUTER CONTOUR IS FOUND IN THE

BEAKER DESCRIPTION FILE.
It is required that all fragments of the outer contour must be joined end to end
making up a continuous polygonal line that starts and ends on the beaker sym-
metry axis. If it is not the case, the above error message appears. Change the
erroneous fragment coordinates to fix the error. Then try again.

#1127 THE BEAKER DESCRIPTION FILE CONTAINS INVALID DEFINITION

OF MATERIALS AT A BOUNDARY FRAGMENT.
Each boundary fragment is expected to separate two different materials in the
container wall. While checking the beaker description, these two materials
identification is made in two different ways, namely, through the left and right
end of a boundary fragment. If the identified materials at the left end don’t
correspond to ones identified at the right end, then the above message is gen-
erated. Make sure you identify properly the materials for both the inner and
outer contour. Then try again.

#1128 A BOUNDARY NODE IS EXPECTED BETWEEN TWO INNER

CONTOUR FRAGMENTS WITH DIFFERENT MATERIAL
DEFINITIONS.
Two inner contour fragments are joined at a node of the inner contour. The
above error message is generated if a boundary fragment is not joined at the
node where two inner contour fragments with different materials are joined.
Make sure you identify properly the coordinates for all the boundary frag-
ments. Then try again.

715
LabSOCS/ISOCS Error Codes

#1129 A BOUNDARY NODE IS EXPECTED BETWEEN TWO OUTER

FRAGMENTS OF THE BEAKER DESCRIPTION FILE.
Two outer contour fragments are joined at a node of the outer contour. The
above error message is generated if a boundary fragment is not joined at the
node where two outer contour fragments with different materials are joined.
Make sure you identify properly the coordinates for all the boundary frag-
ments. Then try again.

#1130 THE BEAKER DESCRIPTION FILE CONTAINS UNCHAINED

FRAGMENT[S] IN THE INNER CONTOUR.
It is required that all fragments of the inner contour be joined end to end mak-
ing up a continuous polygonal chain that starts and ends on the beaker symme-
try axis. The above error message is generated if a discontinuity is detected in
the chain of fragments defining the inner contour.

#1131 THE BEAKER DESCRIPTION FILE CONTAINS UNCHAINED

FRAGMENT[S] IN THE OUTER CONTOUR.
It is required that all fragments of the outer contour be joined end to end mak-
ing up a continuous polygonal chain that starts and ends on the beaker symme-
try axis. The above error message is generated if a discontinuity is detected in
the chain of fragments defining the outer contour.

#1132 THERE IS NO INNER FRAGMENT STARTING ON THE SYMMETRY

AXIS.
It is required that all fragments of the inner contour be joined end to end mak-
ing up a continuous polygonal chain that starts and ends on the beaker symme-
try axis. When that continuous polygonal chain does not start/stop on the
beaker symmetry axis, the above error message is generated. Make sure that
the inner contour starts and stops on the beaker symmetry axis. Then try again.

#1133 THERE IS NO OUTER FRAGMENT STARTING ON THE SYMMETRY

AXIS.
It is required that all fragments of the outer contour be joined end to end mak-
ing up a continuous polygonal chain that starts and stops on the beaker sym-
metry axis. When that continuous polygonal chain does not start/stop on the
beaker symmetry axis, the above error message is generated. Make sure that
the outer contour starts and stops on the beaker symmetry axis. Then try again.

#1142 SAMPLE IS LOCATED SO THAT IT INTERSECTS DETECTOR.

The above error message is generated if a conflict is detected in the definition
of the source/detector location in the ‘beaker’ template. Review the beaker de-
scription file to make sure that the inner and the outer contours are properly
defined so that there is enough room for locating the detector. Or change the
source/detector location parameters. Then try again.

716
 General Errors

#1143 SOURCE IS OUT OF BEAKER.

The above error message is generated if the inside height of the beaker is less
than the sum of the heights of the source layers that are defined in the ‘beaker’
template. Review the beaker description file to make sure that both the inner
and the outer contours are properly defined so that there is to enough room to
accommodate the source layers. Or change the source height parameter, then
try again.

#1144 DETECTOR IS BEHIND THE ABSORBER.

A conflict was detected between the detector location defined in the ‘beaker’
template and the generic absorber thickness. Change the parameters of the
source/detector location or/and the total thickness of the used generic absorb-
ers.

#1151 INVALID START-STOP ANGLES FOR THE INSIDE SOURCE.

USE COUNTERCLOCKWISE DIRECTION AS POSITIVE TO INDICATE
BOTH THE START AND STOP ANGLES.
The ‘round tube’ template description uses ‘start’ and ‘stop’ angles (in de-
grees)to define the limits of the inside source. Both negative and positive an-
gle values are allowed. Positive angles are measured in the counterclockwise
direction. The start angle should not be greater than the stop angle. The above
error message means that in the inside source definition, the start angle is
greater than the stop angle. Change the start or stop angle for the inside source
definition then try again.

#1152 INVALID START-STOP ANGLES FOR THE OUTSIDE SOURCE.

USE COUNTERCLOCKWISE DIRECTION TO INDICATE BOTH THE
START AND STOP ANGLES.
The ‘round tube’ template description uses ‘start’ and ‘stop’ angles (in de-
grees)to define the limits of the outside source. Both negative and positive an-
gle values are allowed. Positive angles are measured in the counterclockwise
direction. The start angle should not be greater than the stop angle. The above
error message means that in the outside source definition, the start angle is
greater than the stop angle. Change the start or stop angle for the outside
source definition then try again.

#1153 INVALID LENGTH OF THE INSIDE SOURCE.

The ‘round tube’ template description defines the inside source length using
the distance of the right and left ends of the source relative to the right end of
the tube. The above error message means that the inside source right end is
farther way from the right end of the tube than the inside source left end. Fix
the error, then try again.

#1154 INVALID LENGTH OF THE OUTSIDE SOURCE.

The ‘round tube’ template description defines the outside source length using
the distance of the right and left ends of the source relative to the right end of
the tube. The above error message means that the outside source right end is
farther way from the right end of the tube than the outside source left end. Fix
the error, then try again.

717
LabSOCS/ISOCS Error Codes

#1155 INSIDE SOURCE IS OUT OF TUBE.

The ‘round tube’ template description defines both the left and right ends of
the inside source relative to the right end of the tube. The above error message
means that the right and/or left end of the inside source exceeds the length of
the tube. Fix the error, then try again.

#1156 OUTSIDE SOURCE IS OUT OF TUBE.

The ‘round tube’ template description defines both the left and right ends of
the outside source relative to the right end of the tube. The above error mes-
sage means that the right and/or left end of the outside source exceeds the
length of the tube. Fix the error, then try again.

#1157 INVALID TUBE DIMENSION.

The ‘round tube’ template description should contain definitions of the tube
wall thickness, inside diameter, and the length. Both the wall thickness and the
inside diameter may not be less than zero. The tube length is required to be
greater than zero. The above error message means that one or more of the
above tube parameters are invalid. Fix the error, then try again.

#1158 ANGLE ABSOLUTE VALUE 360 DEGREES IS NOT ALLOWED.

The ‘round tube’ template description uses angles (in degrees) to define the
limits of both inside and outside sources. Both negative and the positive angle
values are allowed. Positive angles are measured in the counterclockwise di-
rection. The absolute value of an angle must not exceed 360 degrees. Fix the
error, then try again.

#1159 INVALID DIAMETER OF THE INSIDE SOURCE.

Upon checking the ‘round tube’ template description it is found that the inside
source diameter is too small or has a negative value. Change the tube wall
thickness and/or the tube inside diameter to fix the error. Then try again.

#1160 INVALID DIAMETER OF THE OUTSIDE SOURCE.

Upon checking the ‘round tube’ template description it is found that the out-
side source diameter is too small or the zero value. Change the inside diameter
of the tube to fix the error. Then try again.

#1201 TEMPLATE ORIENTATION PARAMETER FOR U-CHANNEL IS

MISSING.
The ‘U-channel’ can be defined in any one of four different orientations, de-
pending on sample geometry. The error message means that the orientation
parameter value is not found in the description. Insert the orientation parame-
ter in the ‘U-channel’ template description to fix the error, then try again.

#1202 INVALID PARAMETER VALUE FOR THE U-CHANNEL TEMPLATE

ORIENTATION.
THE 1,2,3, or 4 ARE ALLOWED FOR THE PARAMETER VALUE.
The ‘U-channel’template can be defined in any one of four different orienta-
tions, depending on sample geometry. The error message means that the orien-
tation parameter value is invalid. Make sure that the proper value is used to
define the orientation parameter, then try again.

718
 General Errors

#1203 SOURCE IS OUT OF U-CHANNEL.

The ‘U-channel’ template description defines both the left and right ends of
any source relative to the channel right end. The above error message means
that the right and/or left end of the source exceeds the length of the channel.
Fix the error, then try again.

#1204 INVALID LENGTH OF SOURCE IN THE U-CHANNEL TEMPLATE.

The ‘U-channel’ template description defines both the left and right ends of
any source relative to the channel right end. The above error message means
that the source right end is farther away from the right end of the channel than
the source left end. Fix the error, then try again.

#1205 U-CHANNEL TOP WALL IS TOO THICK.

The top wall thickness of the U-channel has been defined such that if the
thickness is doubled, it is greater than the outside height of the channel.
Change the top wall thickness to fix the error. Then try again.

#1206 U-CHANNEL SIDE WALL IS TOO THICK.

The side wall thickness of the U-channel has been defined such that side the
thickness is greater than the channel outside width. Change the side wall
thickness to fix the error, then try again.

#1207 ONE OR MORE OF THE U-CHANNEL OUTSIDE DIMENSIONS IS TOO

SMALL.
One of the U-channel parameters, namely, the U-channel width, the height, or
the length is either too small or has a negative value. Fix the error, then try
again.

#1251 TEMPLATE ORIENTATION PARAMETER FOR L-BEAM IS MISSING.

The ‘L-beam’ template can be defined using any one of four different orienta-
tions, depending on the sample geometry. The error message means that the
orientation parameter value is not found in the description. Insert the orienta-
tion parameter in the ‘L-beam’ template description to fix the error., then try
again.

#1252 INVALID PARAMETER VALUE FOR L-BEAM TEMPLATE

ORIENTATION.
THE 1,2,3, or 4 ARE ALLOWED FOR THE PARAMETER VALUE.
The ‘L-beam’ template can be defined using any one of four different orienta-
tions, depending on the sample geometry. The error message means that the
orientation parameter value is invalid. Make sure that the proper value is used
to define the orientation parameter, then try again.

#1253 SOURCE IS OUT OF L-BEAM.

The ‘L-beam’ template description defines both the left and right ends of any
source relative to the right end of the beam. The above error message means
that the right and/or left end of the source exceeds the length of the beam. Fix
the error, then try again.

719
LabSOCS/ISOCS Error Codes

#1254 INVALID LENGTH OF SOURCE IN THE L-BEAM TEMPLATE.

The ‘L-beam’ template description defines both the left and right ends of any
source relative to the right end of the beam. The above error message means
that the source right end is farther away from the right end of the beam than
the source left end. Fix the error, then try again.

#1255 L-BEAM BOTTOM WALL IS TOO THICK.

The thickness of the bottom wall of the L-beam bottom wall is greater than the
outside height of the beam. Change the bottom wall thickness to fix the error.
Then try again.

#1256 L-BEAM SIDE WALL IS TOO THICK.

The thickness of the L-beam side wall is greater than the outside width of the
beam. Change the side wall thickness to fix the error. Then try again.

#1257 ONE OR MORE OF THE L-BEAM DIMENSIONS IS TOO SMALL.

One or more of the L-beam dimensions, namely, the beam width, the height,
or the length is either too small or has a negative value. Fix the error then try
again.

#1301 TEMPLATE ORIENTATION PARAMETER FOR H-BEAM TEMPLATE IS

MISSING.
The ‘H-beam’ template can be defined in one of two different orientations, de-
pending on the sample geometry. The error message means that the orientation
parameter value is not found in description. Insert the orientation parameter in
the ‘H-beam’ template description to fix the error. Then try again.

#1302 INVALID PARAMETER VALUE FOR H-BEAM TEMPLATE

ORIENTATION. EITHER 1 OR 2 IS ALLOWED FOR THE PARAMETER
VALUE.
The ‘H-beam’ template can be defined in one of two different orientations, de-
pending on the sample geometry. The error message means that the orientation
parameter value is invalid. Make sure that the proper value is used to define
the orientation parameter. Then try again.

#1303 SOURCE IS OUT OF H-BEAM.

The ‘H-beam’ template description defines both the left and right ends of any
source relative to the beam right end. The above error message means that the
right and/or the left end of the source exceeds the length of the beam. Fix the
error, then try again.

#1304 INVALID LENGTH OF SOURCE IN H-BEAM TEMPLATE.

The ‘H-beam’ template description defines both the left and right ends of any
source relative to the beam right end. The above error message means that the
source right end is farther away from the right end of the beam than the source
left end. Fix the error, then try again.

#1305 H-BEAM CROSS-BAR IS TOO THICK.

The thickness of the H-beam cross-bar thickness is greater than the outside
height of the beam. Change the cross-bar thickness to fix the error. Then try
again.

720
 General Errors

#1306 H-BEAM SIDE WALL IS TOO THICK.

The thickness of the H-beam side wall is greater than the outside width of the
beam. Change the side wall thickness to fix the error. Then try again.

#1307 ONE OR MORE OF THE H-BEAM DIMENSIONS IS TOO SMALL.

One of the H-beam parameters, namely, the width, height, or the length is ei-
ther too small or has a negative value. Fix the error then try again.

#1351 SOURCE IS OUT OF RECTANGULAR TUBE.

The ‘rectangular tube’ template description defines both the left and right ends
of the source relative to the right end of the tube. The above error message
means that the right and/or left end of the source exceeds out the length of the
tube. Fix the error, then try again.

#1352 INVALID LENGTH OF SOURCE IN THE RECTANGULAR TUBE

TEMPLATE.
The ‘rectangular tube’ template description defines both the left and right ends
of the source relative to the right end of the tube. The above error message
means that the source right end is farther away from the right end of the tube
than the source left end. Fix the error, then try again.

#1353 THE RECTANGULAR TUBE WALL IS TOO THICK.

The wall thickness of the rectangular tube has defined such that if the thick-
ness is doubled, it is greater than either the outside width or the outside height
of the tube. Change the wall thickness to fix the error. Then try again.

#1354 ONE OR MORE OF THE RECTANGULAR TUBE DIMENSIONS IS TOO

SMALL.
One of the tube parameters, namely, the tube width, height, or the length is ei-
ther too small or has a negative value. Fix the error then try again.

#1401 DETECTOR IS OUT OF ROOM THROUGH THE SURFACE.

In the ‘room’ template description, the source/detector location can be defined
such that the detector penetrates through a non-radioactive wall of the room.
But the detector must not penetrate through a radioactive wall. The above er-
ror message means that the detector is found to penetrate through a radioactive
wall. Change the source-detector location parameters appropriately to fix this
error. Then try again.

#1402 ONE OR MORE OF THE ROOM DIMENSIONS IS TOO SMALL.

One of the room dimensions, namely, the room width, height, or the length is
either too small or has a negative value. Fix the error then try again.

#1451 SAMPLE IS OUT OF TANK CONTAINER. CHECK THE SOURCE

HEIGHT.
The source height in the tank template description is greater than the inside di-
ameter of the tank. Make sure that the source height doesn’t exceed the inside
tank diameter. Then try again.

721
LabSOCS/ISOCS Error Codes

#1452 ONE OR MORE OF THE SOURCE DIMENSIONS IN THE TANK

TEMPLATE IS TOO SMALL.
One or more of the tank container dimensions, namely, the height or the
length is either too small or has a negative value. Change the tank dimensions
appropriately to fix the error then try again.

#1453 ROTATION ANGLE IS OUT OF THE [0,360] DEGREES REGION.

The source inside the tank may be rotated relative to the container location.
The angle of rotation must be specified in the counterclockwise direction, and
must be in units of degrees. The value of the angle is required to be in the [0,
360] degrees range. The above error message means that an invalid rotation
angle value is specified in the ‘tank’ template description. Make sure that the
rotation angle value is within the [0, 360] degrees range. Then try again.

#1454 TANK TEMPLATE ORIENTATION PARAMETER IS MISSING.

The ‘tank’ template can be defined in one of two different orientations, de-
pending on the sample geometry. The error message means that the orientation
parameter value is not found in description. Insert the orientation parameter in
the ‘tank’ template description to fix the error. Then try again.

#1455 INVALID PARAMETER VALUE FOR TANK TEMPLATE

ORIENTATION.
USE THE 1 or 2 FOR THE PARAMETER VALUE.
The ‘tank’ template can be defined in one of two different orientations, de-
pending on the sample geometry. The error message means that the orientation
parameter value is invalid. Make sure that the proper value is used to define
the orientation parameter. Then try again.

#1501 SOURCE IS OUT OF THE CONE CONTAINER. CHECK THE SOURCE

HEIGHT.
The source height defined in the cone template exceeds the inside height of
the cone container. Make sure that the source height doesn’t exceed the inside
height of the cone. Then try again.

#1502 ONE OR MORE OF THE CONICAL SOURCE DIMENSIONS IS TOO

SMALL.
One or more of the cone container dimensions, namely, the height or the di-
ameter of is either too small or has a negative value. Change the cone dimen-
sions so that to fix the error then try again.

#1503 CONE DIAMETER NEGATIVE VALUE.

The minimal diameter of the cone is found to be negative. Change the nega-
tive value to fix the error. Then try again.

722
 Geometry Composer Errors

Geometry Composer Errors

LoadMuLibr
100 Can’t open file with mu-library. Check the existence of the file pointed to by
the :ATTENUATION_LIBRARY statement in file SPACE.

101 Can’t find predefined material in the library. The material assigned for some
geometry component is absent in the connected library. Insert the desired ma-
terial into the library.

102 Error while reading the attenuation library. Problem with the mu-library. The
library may be corrupted; use its backup version.

103 Arrays to store attenuation coeffs. are full. Only 10 energy intervals may be
used to describe the polynomial that represents the energy dependence of mass
attenuation coefficient.

104 End of file with mu-library is reached, no more records exist.

Mu-Editor
500 Error while accessing of a function in LoadMuLibr.dll. The Dll may be cor-
rupted; re-install it.

501 Cannot find LoadMuLibr.dll.

502 Error during treatment of substance composition. The old mu-library format
may have been used. You may use either the construction of a new substance
from elements (via chemical formula) and/or the substances prepared in the
Windows version of the mu-library editor.

503 Error during conversion of the formula to the new mu-library format. While
reading the DOS formatted Mu-Library the program was unable to convert a
substance composition into the new format. Try to prepare this substance di-
rectly using the Windows version of the program.

504 Error in Dll (.dll) while performing the selected operation.

505 Cannot load the ISOCS path data. Either file SPACE. was not found or the
:ATTENUATION_LIBRARY keyword was not found in SPACE.INI.

506 Error while deleting a material from the library. Internal error in muedit.dll.

507 Invalid value of density. Density must be greater than 0 and less than 20.

508 Internal error while attempting to insert the material.

509 The formula is too long to be inserted into the library. You can subdivide the
material composition into a few components.

510 The material ‘water’ cannot be deleted.

723
LabSOCS/ISOCS Error Codes

511 Trying to input a string inside another substring (parenthesis).

512 Substance name coincides with an element name. The problem is corrected by
adding a prefix (asterisk).

513 Name of substance coincides with an element name, correct it first.

605 Too many components, the reserved arrays are full.

609 Impossible to delete because of formula traceability. The next substance(s) re-
fer for ‘%1’:

610 Impossible to insert because of formula traceability. The next substance(s) re-
fer for ‘%1’:

GeomEdit
100 Not enough room between source and detector to put Absorber(s)

701 Can’t get address of DLL function

702 Can’t load DLL

703 Can’t load Material Info from library

704 The material pointed to in the template geometry is not found in the current
mu-library. The material must be added before proceeding.

705 The geometry description must include a detector.

706 The detector specified in the geometry file is missing from the local file De-
tector.txt. Check the existence of the detector characterization file in the
ISOCS directory! The geometry file refers to a detector record that has been
deleted, or the current Detector.txt file has been modified.

707 Cannot append detector(s) to the Combo Box.

708 Cannot load the selected detector from file Detector.txt. Check for an appro-
priate record (for the selected detector) in Detector.txt.

709 A detector must be selected.

710 The number of template versions exceeds the maximum allowed. To enter a
new version first delete one or more existing versions.

711 Invalid template version name.

712 The template version name is already in use.

713 Cannot open template version file. A system error occurred while opening the
template version file. Version information could not be saved.

724
 Geometry Composer Errors

714 Cannot open the predefined beaker file. Check that the beaker file is not cur-
rently being used by another program.

715 Invalid parameter in pre-defined beaker file. The line of data must contain 7
parameters.

716 Not a valid contour ID. The ID did not correspond to one of the three types of
contour (i, o or b).

717 Invalid number of parameters (less than 4)! The record structure in file de-
scribing contour.

718 Cannot load DLL with template information. When the Edit Dimensions dia-
log was called, the program could not load the template dll. This situation may
arise when attempting to edit a .GEO file of a particular geometry template
that is not available in the current GC configuration.

719 Cannot get the address of a function in the template dll. This is a system error.
It may be due to a corrupted dll and may be necessary to reinstall.

720 New user template version may be based only on the default template version.
A new user template version cannot be based on an existing geometry file that
itself is based on a user template version. Use the version that is not marked as
[user].

721 The material ‘%1’ referenced in the geometry file is not available in the cur-
rent mu-library. Please replace it with an available material or add the material
to the mu-library.

722 The geometry definition contains the material ‘%1’ which is not available in
the current mu-library. Would you like to replace this material with and avail-
able one?

723 Density for the source material is missing. Mass of the source cannot be calcu-
lated.

724 Cannot load .dll.

725 Cannot get address of function in .dll. This is an internal (system) error.

726 Cannot find the bitmap containing the template drawing. The bitmap file must
exist in the directory specified by the :TMPL_BITMAPS keyword in
Space.ini.

727 The file containing the template drawing is not a valid bitmap (.bmp) file.

728 Cannot continue. Check the :PROGRAM keyword in Space.ini. The directory
path specified by the :PROGRAM keyword is missing or invalid, or Space.ini
itself may be missing.

729 Cannot retrieve the address of a function in the computational DLL. Isocs_ge-
neric.dll may be corrupted. You may need to re-install.

725
LabSOCS/ISOCS Error Codes

730 Cannot load computational DLL. Check existence of isocs_generic.dll in di-

rectory specified by the :PROGRAM keyword in Space.ini.

731 Cannot open contour description file for writing.

732 Cannot open the file containing cylindrical collimator parameters. This file is
located in the directory specified by the :C_COLLIMATOR keyword in
Space.ini.

733 Invalid record in collimator file.

734 Cannot open file containing under water housing parameters. This file is lo-
cated in the directory specified by the :UW_HOUSING keyword in Space.ini.

735 Cannot open file containing rectangular collimator parameters. This file is lo-
cated in the directory specified by the :R_COLLIMATOR keyword in
Space.ini.

736 Select a collimator type first.

737 Cannot execute the operation. The collimator type must be selected first.

738 The collimator name has not been identified. The record will be saved as a
new record.

739 Cannot open file to save collimator data. Check that the file is not being used
by another program.

740 Please specify a name for the record: none is not valid!

741 Please confirm deletion of user version %1.

743 Versions library has been updated.

744 Please select the version to be deleted.

745 Template version has been saved.

746 Cylindrical collimator record has been successfully stored.

747 Rectangular collimator record has been successfully stored.

748 Housing record has been successfully stored.

749 Detector name is longer than 19 characters. Please make the necessary correc-
tion to the detector file. The detector is not included in the list of available de-
tectors.

750 Please confirm deletion of the collimator record.

751 Please confirm deletion of the housing record.

726
 Geometry Composer Errors

752 Cannot launch MuEditor.exe. Check the existence of this file in the directory
specified by the :PROGAM keyword in Space.ini.

753 Please confirm replacement of the record #%1: %2.

754 Cylindrical Collimator

755 Rectangular Collimator

756 Housing

757 Material in the string #’%1’ is missing. Select the proper material from the list
box or none if the geometry component is absent. In the latter case the line’s
data will be ignored.

758 Data Validation

759 Only positive numbers greater than 1.0E-4 mm may be entered.

760 Cannot load BMP file for plotting. The bitmap file must exist in the directory
specified by the :TMPL_BITMAPS keyword in Space.ini.

Geometry Composer
100 OLE initialization failed. Make sure that the OLE libraries are the correct ver-
sion.

104 Windows sockets initialization failed.

1002 Variable ‘SPACE’ is not found in the environment.

1003 File Space.ini cannot be opened.

1004 The preset path statement is not found in file Space.

1005 Cannot open file detector. with detector parameters. Check whether detec-
tor.txt is present in the directory specified by the :DETECTOR_PAR keyword
in Space.ini.

1006 Error in format of file Space.ini. Check format of Space.ini: each line should
have a format of keyword=path.

1007 System error while reading the detector list file.

1008 Check format of the detector list file (8 columns per line are allowed).

1009 Program cannot open templates list file (template.cnf).

1010 Templates list file (template.cnf) has an invalid format.

1011 System error while reading the templates list file (template.

1012 Cannot load the template DLL file.

727
LabSOCS/ISOCS Error Codes

1013 Cannot access exported DLL function. This is a system error which occurred
when the program attempted to access the DLL.

1014 Unable to locate the geometry files directory. The program cannot locate the
directory specified by the :GEOMETRY keyword in Space.ini. The results
will be stored in the root directory.

1015 Cannot open ISOCS geometry (.GIS) file to store geometry description data.

1016 Directory specified by the :PROGRAM keyword in file Space.ini is invalid.

1017 Internal error in ISOCS program.

1018 Cannot open efficiency (.ECC) file generated by ISOCS.

1019 Error while reading ISOCS efficiency (.ECC) file: invalid number of columns
in file.

1020 Error while reading ISOCS efficiency (.ECC) file: invalid number of energies
in file.

1021 Internal error calling efficiency curve function in .dll.

1022 Error returned from efficiency curve function in .dll.

1023 Cannot load .dll. Check existence of this file in the directory specified by the
:PROGRAM keyword in Space.ini.

1024 Internal error: generation failed.

1025 Error attempting to open .ECC file generated by ISOCS: cannot find
:ECC_OUTPUT keyword in file Space.ini.

1026 Unrecognized file format: the file is not in a .GEO format.

1027 The function computing efficiency returned with an error.

1028 Internal system error attempting to call a function in _generic.dll.

1029 Cannot load _generic.dll.

1030 The geometry (.GEO) file was created by later version of Geometry Com-
poser than is currently running. The program may have failed attempting to
read a file. Please update your Geometry Composer.

1031 Cannot open file containing geometry data.

1032 Internal arrays for importing ISOCS geometry are full. Check the .GIS file
and insure that all contained data are valid.

1033 Cannot open the Clipboard to store the template picture for export to Excel.

1034 Cannot empty the Clipboard.

728
 Geometry Composer Errors

1035 Unable to write template picture to the Clipboard.

1036 Do you wish to overwrite existing configuration file?

1037 Cannot open back-up copy of Space. (Space.bak).

1038 No geometry templates are available. Please check Options/Configuration

menu item. Check for the existence of the template DLLs (lgt_xx.dll and
igt_xx.dll) in the directory specified by the :PROGRAM keyword in
Space.ini.

1039 Filename of the Computational DLL does not match its content. The file may
have been renamed.

1040 Cannot find the bitmap containing the template drawing. The bitmap file must
exist in the directory specified by the :TMPL_BITMAPS keyword in
Space.ini.

1041 The file containing the template drawing is not a valid bitmap (.bmp) file.

1042 Program cannot run because of a missing keyword. One of the required
keywords in Space.ini is missing.

1043 Cannot find the directory specified by the :GEOMETRY keyword in file
Space.ini.

1044 The selected folder does not correspond to standard file storage convention.
Save the file anyway?

1045 Confirm selection!

1046 Cannot create new directory.

1047 Cannot open the energy list file.

1048 Error in format of energy list file. Each line should contain two comma delim-
ited fields: Energy and Efficiency Error.

1049 Cannot open energy list file for writing.

1050 Error while requesting information about a comput ational DLL.

1051 Program cannot continue: cannot find one of the required keywords in file
Space.ini.

1052 Internal system error: problem calling the function in the computational DLL.

1053 Cannot load computational DLL. Check existence of DLL in directory speci-
fied by the :PROGRAM keyword in Space.ini.

1054 Cannot delete temporary file *.txt. This is required in order to execute the next
ISOCS computation.

729
LabSOCS/ISOCS Error Codes

1055 Cannot open temporary file to store beaker description during geometry test-
ing.

1056 Cannot find generated file. Export to Excel is stopped.

1057 Excel is being launched…Please answer the following questions from Excel:

1058 Cannot launch ‘Excel’.

1059 Efficiency curve may be generated after saving the geometry file.

1060 Geometry test has run successfully.

1061 Geometry test has failed:

1062 Error

1063 Variable ‘SPACE’ is not found in the environment.

1064 File Space.ini cannot be opened. Check for the existence of this file in the di-
rectory specified by the SPACE environment variable.

1065 The preset statement is not found in file Space.ini.

1066 Cannot open file detector. with detector parameters. Check existence of this
file in the directory specified by the :DETECTOR_PAR keyword in file
Space.ini.

1067 Error in format of file Space.ini. Check format of Space.ini: each line should
have a format of keyword=path.

1101 Cannot find the bitmap containing the template drawing. The bitmap file must
exist in the directory specified by the :TMPL_BITMAPS keyword in
Space.ini.

1102 Please select the energy to be deleted.

1103 An Efficiency Calibration Calculation (ECC) process is already running. Wait

for its termination before launching another ECC process.

1104 Efficiency data points have been generated.

1105 Filename of the Template DLL does not match its content. The file may have
been renamed.

1106 Temperature is below the lower temperature limit (deg C):

1107 Temperature is above the upper temperature limit (deg C):

1108 Pressure exceeds the upper pressure limit (mm Hg):

1109 ISOCS environment is not found. Program cannot run.

730
 ISOCS Multi-Efficiency Errors

1110 File Space.ini or a required keyword in Space.ini was not found. The program
cannot access data needed for creation of a new document. Only existing doc-
uments may be opened.

1111 Cannot move generated file from temporary to destination directory. System
error number ()

1112 Configuration list is empty. New document cannot be created: no templates

are available.

1113 Cannot update configuration. File Space.ini or the :PROGRAM keyword in

space.ini was not found.

1114 You have loaded a previous version of a GEO file. To make the picture avail-
able open the Edit/Dimensions dialog and save the GEO file.

1115 Cannot create backup of template list file (template.bak). While updating the
configuration the program could not rename template.cnf to ‘template.bak.

1116 Cannot update template list file (template.cnf). While updating the configura-
tion the program could not rename the temporary copy of the template list file
(template.tmp) back to the permanent file name (template.cnf).

1117 List is full. Cannot append new energy value to the list used for ECC genera-
tion. Max lines in the list is 100.

1118 % elements have been loaded.

1119 The valid energy interval is:

1120 The energy value is already in the list.

1121 The Error value is missing.

1122 Cannot load DLL with template information. The program could not load the
template DLL.

1123 Cannot get the address of a function in the template DLL. This is a system er-
ror.

ISOCS Multi-Efficiency Errors

1300 CANNOT FIND ECC_OUTPUT STATEMENT IN SPACE.INI FILE
Check the contents of the SPACE.INI file.

1301 ENERGY LIST OF THIS FILE DOES NOT CORRESPOND TO THE LIST
OF ALREADY LOADED FILE(S)
On loading the second .ECC file into the table of files to be treated, the pro-
gram checks that the list of energies for this file is exactly the same as the list
of the first file (no energy tolerance is used).

731
LabSOCS/ISOCS Error Codes

1302 INVALID CONTENT OF CURRENT ECC FILE. PLEASE, GENERATE

THIS FILE AGAIN
Probably the contents of the input .ECC file is corrupted; generate it again.

1303 CAN NOT OPEN DESTINATION ‘MULTIEFFICIENCY’ DIRECTORY

An effort to make a new daughter directory (MultiEfficiency) in
..\geometry\in-situ\ has failed.

1304 CAN NOT LOAD ECC FILE (SEE ROW MARKED BY RED)
Usually this situation happens while loading the file containing the list of ECC
files. If one (or more) of .ECCfiles was erased (or moved) from the preset lo-
cation, the list will contain an invalid file. The program detects this situation
and marks the invalid file in red in the table with the input list.

1307 PLEASE, ENTER VALUE(S) OF WEIGHT (WEIGHTING FACTOR)

If the Weighted Average mode was selected, the Weight value must be indi-
cated in the table.

1308 PLEASE CHECK VALUE OF ‘WEIGHT’. ONLY FLOATING POINT

NUMBER GREATER THAN ZERO IS ALLOWED.

1309 FILE WITH SAME NAME ALREADY EXITS. REPLACE?

This message can be seen when saving a file (table on the Input screen or
.ECCfile on the Report screen).

1310 TOO LONG PARAMETER IN THE INPUT ECC LINE. THE INVALID
PARAMETER IS SHOWN ON THE FOLLOWING LINE
The message is generated while reading input .ECC files. The program found
that the argument is too long. The argument is detector name, template name,
filename, geometry name.

1311 SAVE MULTI-EFFICIENCY RESULTS?

Message appears on exit of Report screen if MEfficiency.ECC file is not saved
yet.

ISOCS Template-Dependent Errors

The error number for each set of template-dependent messages begins at 200. To find the
appropriate error message, first locate the name of the template that was used, and then
find its error number.

An error message may contain the symbols “%1” or “%2”. These are substitution fields,
and will be replaced by a specific value when the error message is generated. Usually the
fields are intended to print the number of layer (source) where a problem was detected to
provide a clearer indication of the error.

Note: Some error messages are typical and are repeated in many templates. Please re-
fer to the first appearance of the message for an additional explanation.

732
 ISOCS Template-Dependent Errors

Template
and
Error Message Comment
Error
Number
igt_1 CIRCULAR_PLANE
200 No radioactive layer is found. Set Rel.Conc. is not set for a layer (2-11)
up Rel.Conc. for radioactive layer which may be radioactive (has
RelConc field)
201 Please select material for walls Wall dimension (1.1) is selected, but
not the material
202 Material for walls is selected, Material is selected, but wall
Please set dimension dimension (1.1) is not
203 Layer is marked as radioactive, RelConc > 0 , but layer thickness is
set up its dimension or reset 0
Rel.Conc. value
204 Radioactive layer is defined. Dimension of layer and its RelConc.
Select material for it are defined, but a material is not
selected.
205 Please select material for Dimension 12.1 > 0, but material is
Absorber1 (its dimension was set) ‘none’
206 Please select material for Dimension 13.1 > 0, but material is
Absorber2 (its dimension was set) ‘none’
207 Material for Absorber is set. Set Material specified, but dimension
up its thickness or replace 12.1 and/or 13.1 is zero
material with ‘none’ if Absorber is
really absent
208 Non radioactive layer is defined. The layer is considered as
Select material for it nonradioactive since its RelConc= 0,
but its Material OR dimension is set
209 Non radioactive layer is defined. Warning message
This layer (line %1) will be
considered as absorber, not
source
igt_2 Complex_Box
200 No radioactive layer/source is Rel.Conc. is not set (2…6)
found. Set up Rel.Conc. for
radioactive layer
201 Please select material for walls The wall thickness is given, but not
its material
202 Material for walls is selected, The wall material is given, but not its
Please set dimension thickness

733
LabSOCS/ISOCS Error Codes

Template
and
Error Message Comment
Error
Number
203 Layer is marked as radioactive,
set up its dimension or reset
Rel.Conc. value
204 Radioactive layer is defined.
Select material for it
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Non radioactive layer is defined.
Select material for it
209 Non-radioactive layer is defined.
This layer (line %1) will be
considered as absorber, not
source
210 Concentrated Source is set. Dimension 6.1, 6.2 or 6.3 is zero
Define all its dimensions: 6.1, 6.2,
6.3
211 Concentrated Source is set. All dimensions (6.1, 6.2, 6.3) are set,
Select material for it but the material is not specified
igt_3 SIMPLE_BOX
200 No radioactive layer is found. Set
up Rel.Conc. for radioactive layer
201 Please select material for walls The wall thickness is given, but not
the material
202 Material for container is selected, The wall material is given, but not its
Please set dimension thickness
203 Layer is marked as radioactive,
set up its dimension or reset
Rel.Conc. value
204 Radioactive layer is defined.
Select material for it
205 Please select material for
Absorber1 (its dimension was set)

734
 ISOCS Template-Dependent Errors

Template
and
Error Message Comment
Error
Number
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Non radioactive layer is defined.
Select material for it
209 Non radioactive layer is defined.
This layer (line %1) will be
considered as absorber, not
source
211 Layer(s) does not fit container:
2.1+ 3.1 > 1.3
igt_4 RECTANGULAR_PLANE
200 No radioactive layer is found. Set
up Rel.Conc. for radioactive layer
201 Please select material for walls The wall thickness is given, but not
the material
202 Material for walls is selected, The wall material is given, but not its
Please set dimension thickness
203 Layer is marked as radioactive,
set up its dimension or reset
Rel.Conc. value
204 Radioactive layer is defined.
Select material for it
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Non radioactive layer is defined.
Select material for it

735
LabSOCS/ISOCS Error Codes

Template
and
Error Message Comment
Error
Number
209 Non radioactive layer is defined.
This layer (line %1) will be
considered as absorber, not
source
igt_5 COMPLEX_CYLINDER
200 No radioactive layer/source is
found. Set up Rel.Conc. for
radioactive layer
201 Please select material for walls The wall thickness is given, but not
the material
202 Material for walls is selected, The wall material is given, but not its
Please set dimension thickness
203 Layer is marked as radioactive,
set up its dimension or reset
Rel.Conc. value
204 Radioactive layer is defined.
Select material for it
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Non radioactive layer is defined.
Select material for it
209 Non radioactive layer is defined.
This layer (line %1) will be
considered as absorber, not
source
210 Spherical Source is set. Define its Rel.Conc for hotspot > 0, but
dimensions dimension 2.1 is 0
211 Spherical Source is set. Select (2.1 > 0) AND (Rel.Conc.2 > 0), but
material for it material is not defined
igt_6 SIMPLE_CYLINDER
200 No radioactive layer is found. Set
up Rel.Conc. for radioactive layer

736
 ISOCS Template-Dependent Errors

Template
and
Error Message Comment
Error
Number
201 Please select material for walls The wall thickness is given, but not
the material
202 Material for container is selected, The wall material is given, but not its
Please set dimension thickness
203 Layer is marked as radioactive,
set up its dimension or reset
Rel.Conc. value
204 Radioactive layer is defined.
Select material for it
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Non radioactive layer is defined.
Select material for it
209 Non radioactive layer is defined.
This layer (line %1) will be
considered as absorber, not
source
211 Layer(s) does not fit container:
2.1+ 3.1 > 1.3
igt_7 SPHERE
200 No radioactive source is found.
Set up Rel.Conc. for a radioactive
source
201 Please select material for shell The wall thickness is given, but not
the material
202 Material for shell is selected, The wall material is given, but not its
Please set dimension thickness
203 Source Shell is marked as
radioactive, set up its dimension
204 Source Shell is defined. Select
material for it.

737
LabSOCS/ISOCS Error Codes

Template
and
Error Message Comment
Error
Number
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Non radioactive Source-shell is Dimension 2.1 > 0 AND (Rel.Conc.2
defined. Select material for it. > 0), but material is not defined for
source shell
209 Non radioactive Source-shell is
defined. This layer (line %1) will
be considered as absorber, not
source.
211 Thickness(es) of Shell and Source
Shell does not fit shell diameter:
1.1*2+ 2.1*2 > 1.2
213 Non radioactive Source-shell is Dimension 2.1 > 0, but material is
defined. Set its dimension not set for source shell
igt_8 WELL_or_MARINELLI_BEAKER
200 Bottom slot of Marinelli beaker Dimension 1.2 < end cap diameter
does not fit detector. Look at the
‘Endcap INFO’ frame on the dialog
panel
201 Please select material for Dimension 1.1 > 0, but material is
Liner-Side ‘none’
202 Material for Liner-Side is selected, Material is selected, but dimension is
Please set dimension not set
203 Please set up length of bottom Dimension 1.3 is 0
part
204 Please select material for Dimension 2.1 > 0, but material is
Liner-End ‘none’
205 Material for Liner-End is selected, Material is selected, but dimension
Please set dimension 2.1 is 0
206 No radioactive layer is found. Set RelConc for both source layers is 0
up Rel.Conc. for radioactive layer.

738
 ISOCS Template-Dependent Errors

Template
and
Error Message Comment
Error
Number
207 Layer is marked as radioactive, If the RelConc for a source layer (3
set up its dimension or reset or 4) is non-zero, its thickness (3.1
Rel.Conc. value or 4.1) must be non-zero too
208 Radioactive layer is defined. Select a material for source (3 or 4)
Select material for it. matrix
igt_9 PIPE
200 No radioactive source is found.
Set up Rel.Conc. for radioactive
source."
201 Please select material for pipe The wall thickness is given, but not
the material
202 Material for container is selected, The wall material is given, but not its
Please set wall thickness thickness
203 Layer is marked as radioactive,
set up its dimension or reset
Rel.Conc. value
204 Radioactive layer is defined.
Select material for it
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Non radioactive layer is defined.
Select material for it
209 Non radioactive layer is defined.
This layer (line %1) will be
considered as absorber, not
source
210 Source %1 is set. Define its
dimensions: %2.(2-3)
211 Source(s) does not fit pipe: 2.1*2
+ 3.1 > 1.2
igt_10 SPECIAL_SPHERE

739
LabSOCS/ISOCS Error Codes

Template
and
Error Message Comment
Error
Number
200 No radioactive layer is found. Set
up Rel.Conc. for radioactive layer
201 Please select material for walls The wall thickness is given, but not
the material
202 Material for walls is selected, The wall material is given, but not its
Please set dimension thickness
203 Layer is marked as radioactive,
set up its dimension or reset
Rel.Conc. value
204 Radioactive layer is defined.
Select material for it
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Non radioactive shell is defined.
Select material for it
209 Non radioactive shell(s) is defined.
This shell (line %1) will be
considered as absorber, not
source
211 Source Core is set. Select Material.3=‘none’
material for it
212 Select material for container Material.2=‘none’
213 Non radioactive shell is defined. Material for a shell was assigned,
Set its dimension but its dimension (x.1) is missing
igt_11 EXPONENT_CIRCULAR_PLANE
200 Ao value is out of the (0-1) limit
201 Please select material for walls The wall thickness is given, but not
the material
202 Material for walls is selected, The wall material is given, but not its
Please set dimension thickness

740
 ISOCS Template-Dependent Errors

Template
and
Error Message Comment
Error
Number
204 Please select material for
Source-Layer
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Check line %1 (set dimension A component (dimension or material)
should be completed with material is missing from one of the layers
and vice versa) (1-3)
209 Please check parameters. (5.1+
5.2) can not exceed 5.1
igt_12 BEAKER
200 No radioactive layer is found. Set
up Rel.Conc. for radioactive
layer."
201 Please select material for walls The wall thickness is given, but not
the material
202 Material for container is selected, The wall material is given, but not its
Please set dimension thickness
203 Layer is marked as radioactive,
set up its dimension or n reset
Rel.Conc. value
204 Radioactive layer is defined.
Select material for it.
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
208 Non radioactive layer is defined.
Select material for it.

741
LabSOCS/ISOCS Error Codes

Template
and
Error Message Comment
Error
Number
209 Non radioactive layer is defined.
This layer (line %1) will be
considered as absorber, not
source
211 Layer(s) does not fit container:
2.1+ 3.1 > 1.3
igt_13 ROUND_TUBE
200 Please select material for walls The wall thickness is given, but not
the material
201 Material for walls is selected, The wall material is given, but not its
Please set dimension thickness
202 Invalid angle. The valid range is:
–360 ≤ Angle ≤ 360)
203 Angle 2.3 must be less than 2.4
(–360 ≤ Angle ≤ 360)
204 Angle 3.3 must be less than 3.4
(–360 ≤ Angle ≤ 360)
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Please set up source
concentration
208 No Source is pointed (insert data
2.2 or 3.2)
209 The contamination length exceed Dimension 3.2 dimension 1.3
the tube length (1.3)
210 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
igt_14 U_CHANNEL
200 Please select material for walls The wall thickness is given, but not
the material
201 Material for walls is selected, The wall material is given, but not its
Please set dimension thickness

742
 ISOCS Template-Dependent Errors

Template
and
Error Message Comment
Error
Number
202 Please select material for
Absorber1 (its dimension was set)
203 Please select material for
Absorber2 (its dimension was set)
204 Please set Orientation as 1 or 2 or
3 or 4
205 The Surface source length If(x.2 > 1.1), where x= 2-7
exceeds the object length (1.1)
206 Dimension x.1 must be less than
x.2 (x=2-7)
209 No radioactive surface is found
210 Set dimension(s) for radioactive
source
211 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
igt_15 L_BEAM
200 Please select material for walls The wall thickness is given, but not
the material
201 Material for walls is selected, The wall material is given, but not its
Please set dimension thickness
202 Please select material for
Absorber1 (its dimension was set)
203 Please select material for
Absorber2 (its dimension was set)
204 Please set Orientation as 1 or 2 or
3 or 4
205 The Surface source length
exceeds the object length (1.1)
206 Dimension x.1 must be less than
x.2 (x= 2-5)
209 No radioactive surface is found
210 Set dimension(s) for radioactive
source

743
LabSOCS/ISOCS Error Codes

Template
and
Error Message Comment
Error
Number
211 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
igt_16 H_BEAM
200 Material for walls is selected, The wall material is set but the
Please set dimension dimension is not given
201 Invalid volume: upper part of
beaker is not filled The data in line
4 will be reset Input correct values
202 Please select material for
Absorber1 (its dimension was set)
203 Please select material for
Absorber2 (its dimension was set)
204 Please set Orientation as 1 or 2
205 The Surface source length
exceeds the object length (1.1)
206 Dimension x.1 must be less than
x.2 (x=2-7)
209 No radioactive surface is found
210 Set dimension(s) for radioactive
source
211 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
igt_17 RECTANGULAR_TUBE
200 Please select material for walls The wall thickness is given, but not
the material
201 Material for walls is selected, The wall material is given, but not its
Please set dimension thickness
202 Please select material for
Absorber1 (its dimension was set)
203 Please select material for
Absorber2 (its dimension was set
205 The Surface source length
exceeds the object length (1.2)

744
 ISOCS Template-Dependent Errors

Template
and
Error Message Comment
Error
Number
206 Dimension x.1 must be less than
x.2 (x = 2–9)
209 No radioactive surface is found
210 Set dimension(s) for radioactive
source
211 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
igt_18 ROOM
200 No radioactive surface is found RelConc is zero for all surfaces
(2–7)
igt_19 TANK
200 Please select material for side The wall thickness is given, but not
wall the material
201 Material for side wall is selected, The wall material is given, but not its
Please set dimension thickness
202 Please select material for ends Material.2 is not selected
walls
203 Material for ends walls is selected, Material.2 is selected AND 2.1=0
Please set dimension
204 Please select material for
Absorber1 (its dimension was set)
205 Please select material for
Absorber2 (its dimension was set)
206 Please set Orientation as 1 or 2
207 No radioactive source found RelConc.3= 0
210 Set dimension for radioactive Dimension 3.1 is 0
source
211 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent
igt_20 CONE
200 Please select material for side The wall thickness is given, but not
wall the material

745
LabSOCS/ISOCS Error Codes

Template
and
Error Message Comment
Error
Number
201 Material for side wall is selected, The wall material is given, but not its
Please set dimension thickness
202 Please select material for ends
walls
203 Material for ends walls is selected,
Please set dimension
204 Please select material for
Absorber1 (its dimension was set)
205 Please select material for
Absorber2 (its dimension was set)
206 At least one dimension from 1.2,
1.3 must be set
207 Source is out of the cone
container: 1.4 < 3.1 Check the
source height
208 No radioactive source found
210 Set dimension for radioactive Dimension 3.1 is 0
source
211 Material for Absorber is set. Set
up its thickness or replace
material with ‘none’ if Absorber is
really absent

LabSOCS Template-Dependent Errors

The error number for each set of template-dependent messages begins at 200. To find the
appropriate error message, first locate the name of the template that was used, and then
find its error number.

Template
and
Error Message Comment
Error
Number
Lgt_101 CYLINDER_DISK_AND_POINT
200 Not enough room between source Dimension (5.1+ 4.1) > 6.1
and detector to put Absorber(s)

746
 LabSOCS Template-Dependent Errors

Template
and
Error Message Comment
Error
Number
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set up
its thickness or replace material
with ‘none’ if Absorber is really
absent
Lgt_104 SIMPLIFIED_BOX
200 Not enough room between source Dimension (5.1+ 4.1) > 6.1
and detector to put Absorber(s)
201 Please indicate thickness of side The material is given, but not the
walls side wall thickness
202 Please select material of side walls The side wall thickness is bottom
wall is given, but not the material
203 Please indicate thickness of bottom The bottom wall material is given,
wall but not the thickness
204 Please select material of bottom The bottom wall thickness is given,
wall but not the material
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set up
its thickness or replace material
with ‘none’ if Absorber is really
absent
Lgt_106 CYLINDER_FROM_SIDE
200 Not enough room for Absorber(s) Dimension 5.1< (3.1+ 4.1)
201 Invalid volume. If you wish to It is assumed that cylinder is fully
change sample volume, correct the filled. This assumption may not be
dimensions fulfilled if the dimensions are set
and user tries to change volume
202 Please select material for the Thickness of the container is given,
container but the material is not.
203 Please indicate thickness of Container material given, but not
container walls the thickness.
205 Please select material for
Absorber1 (its dimension was set)

747
LabSOCS/ISOCS Error Codes

Template
and
Error Message Comment
Error
Number
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set up
its thickness or replace material
with ‘none’ if Absorber is really
absent
Lgt_107 SIMPLIFIED_SPHERE
200 Not enough room for Absorber(s) Dimension 5.1< (3.1+ 4.1)
201 Please select material for container The thickness of container is given,
but not the material.
202 Please indicate thickness of The container wall material is
container wall given, but not the thickness.
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set up
its thickness or replace material
with ‘none’ if Absorber is really
absent
Lgt_108 SIMPLIFIED_MARINELLI_BEAKER
200 Detector does not fit into Marinelli
beaker well. See the ‘Endcap INFO’
frame on the dialog panel
202 Sample is below detector plane The sample must completely
occupy the well portion of the
Marinelli beaker. The error
indicates that the sample level is
below the detector end-cap plane.
203 Invalid data: only positive data are This error message may appear
permitted while testing the dimensions matrix
205 Invalid data for detector well: 3.1 3.1> (2.1+4*1.1)
must be greater than 2.1+4*1.1
206 Container diameter must be greater
then detector diameter
207 Please select a material for the
container
Lgt_112 SIMPLIFIED_BEAKER
200 Please select material for beaker The beaker wall thickness is given,
walls but not the material

748
 LabSOCS Template-Dependent Errors

Template
and
Error Message Comment
Error
Number
201 Sample volume too large to fit into
beaker
202 Not enough room for the sample. Dimension 2.1 > 1.4
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set up
its thickness or replace material
with ‘none’ if Absorber is really
absent
LGT_12 GENERAL_PURPOSE_BEAKER
200 Please select a wall material The beaker wall thickness is given,
but not the material
201 “Please indicate the height of at
least one of layers: 2.1 or 3.1
205 Please select material for
Absorber1 (its dimension was set)
206 Please select material for
Absorber2 (its dimension was set)
207 Material for Absorber is set. Set up
its thickness or replace material
with ‘none’ if Absorber is really
absent
Lgt_8 GENERAL_PURPOSE_MARINELLI_BEAKER
200 Detector does not fit into Marinelli
beaker well. See the ‘Endcap INFO’
frame on the dialog panel
201 Parameters 3.1 and 4.1 must be set Not currently used
in the current context

749
Index
A B
Absorption measurement, CAM file . . . . . . 623 Block
Acquisition Copying a. . . . . . . . . . . . . . . . . . . . . . . . . 87, 179
Aborting a . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 Creating a. . . . . . . . . . . . . . . . . . . . . . 65, 86, 179
Error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . 673 Deleting a. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Parameters, CAM file . . . . . . . . . . . . . . . . . . 481 Reading a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Pausing an . . . . . . . . . . . . . . . . . . . . . . . 134, 233 Writing a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Retrieving neutron measurements . . . . . . . . . 137 Boot parameters
Retrieving spectral measurements . . . . . . . . . 136 Setting or getting . . . . . . . . . . . . . . . . . . . . . . 144
Starting an . . . . . . . . . . . . . . . . . . . . . . . 133, 231
Stopping an . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Storing a measurement. . . . . . . . . . . . . . . . . . 226 C
Acquistion preset . . . . . . . . . . . . . . . . . 50 Calibration
Activating CAM file parameters . . . . . . . . . . . . . . . . . . . 549
Auto-scale during acquisition . . . . . . . . . . . . 260 Calibration files, opening . . . . . . . . . . . . 421
Expand mode . . . . . . . . . . . . . . . . . . . . . . . . . 257 Calibration information, storing . . . . . . . . 352
Linear y-axis scale . . . . . . . . . . . . . . . . . . . . . 267 Calibrations
Spectral plot ROI filling . . . . . . . . . . . . . . . . 269 Efficiency. . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Zoom mode . . . . . . . . . . . . . . . . . . . . . . . . . . 258 Energy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Activity correction error codes . . . . . . . . . 674 Fwhm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
ADC control properties . . . . . . . . . . . . . 158 Low energy tail . . . . . . . . . . . . . . . . . . . . . . . 106
Add a source parameters, CAM file . . . . . . 640 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Add-a-source . . . . . . . . . . . . . . . . . . 123 CAM
Adding Accessing a group of parameters . . . . . . . . . . 253
A data point . . . . . . . . . . . . . . . . . . . . . . . . . . 348 Accessing parameters . . . . . . . . . . . . . . . . . . 252
An ROI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 ASCII Date/time conversion . . . . . . . . . . . . . . 70
Efficiency calibration record . . . . . . . . . . . . . 349 C Date/time conversion . . . . . . . . . . . . . . . . . . 69
Multiple models to plot . . . . . . . . . . . . . . . . . 292 Copy classes of data. . . . . . . . . . . . . . . . . . . . . 57
Adding an MCA . . . . . . . . . . . . . . . . 457 Copy records . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Adjust control Current date/time conversion. . . . . . . . . . . . . . 68
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 426 Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Amplifier control properties . . . . . . . . . . 157 Data class structure . . . . . . . . . . . . . . . . . . . . . 24
Analysis Datasources . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Control, CAM file.. . . . . . . . . . . . . . . . . . . . . 573 Delete a record . . . . . . . . . . . . . . . . . . . . . . . . . 55
Module error codes . . . . . . . . . . . . . . . . . . . . 671 Information, retrieving. . . . . . . . . . . . . . . . . . . 39
Analysis editor Insert a record . . . . . . . . . . . . . . . . . . . . . . . . . 53
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Analysis engine Read an array of values . . . . . . . . . . . . . . . . . . 43
Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Read a list of values . . . . . . . . . . . . . . . . . . . . . 46
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Read a set of CAM parameters . . . . . . . . . . . . 48
Analyzing a datasource . . . . . . . . . . . . . 432 Return number of records . . . . . . . . . . . . . . . . 52
Architecture, software . . . . . . . . . . . . . . 23 Search for records . . . . . . . . . . . . . . . . . . . . . . 58
Area correction Write a list of values . . . . . . . . . . . . . . . . . . . . 47
Error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . 674 Write a set of CAM parameters . . . . . . . . . . . . 49
Array Write an array of values. . . . . . . . . . . . . . . . . . 44
CAM values, read . . . . . . . . . . . . . . . . . . . . . . 43 CAM Datasource
CAM values, write. . . . . . . . . . . . . . . . . . . . . . 42 Component. . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Assign a device to the control. . . . . . . . . . 426 Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Attenuation correction, CAM file. . . . . . . . 622 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

751
 CAM Dialog Safeguards . . . . . . . . . . . . . . . . . . . . . . . . . . . 628
Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . 417 Sample . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418 Scanning WBC setup . . . . . . . . . . . . . . . . . . . 572
CAM file Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Basic unit of configuration . . . . . . . . . . . . . . 475 Shape calibration . . . . . . . . . . . . . . . . . . . . . . 550
Classes of information . . . . . . . . . . . . . . . . . . 474 Special uses . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Contents of. . . . . . . . . . . . . . . . . . . . . . . . . . . 474 Certificate files, opening . . . . . . . . . . . . 422
Drag/drop to display . . . . . . . . . . . . . . . . . . . 255 Certificate parameters, CAM file . . . . . . . . 548
Error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . 669 Changing
Parameter array access. . . . . . . . . . . . . . . . . . . 97 Density display units . . . . . . . . . . . . . . . . . . . 368
Parameter code format . . . . . . . . . . . . . . . . . . 480 Energy display units . . . . . . . . . . . . . . . 368, 390
Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 Number of y-axis tick marks . . . . . . . . . 262, 323
Removing changes. . . . . . . . . . . . . . . . . . . . . . 86 plot axis labels . . . . . . . . . . . . . . . . . . . . . . . . 245
Saving changes . . . . . . . . . . . . . . . . . . . . . . . . 91 Plot limits. . . . . . . . . . . . . . . . . . . . 298, 367, 407
Single parameter array . . . . . . . . . . . . . . . . . . . 98 Plot point size . . . . . . . . . . . . . . . . . . . . . . . . 271
Spectral data access . . . . . . . . . . . . . . . . . . . . . 99 Plotting limits. . . . . . . . . . . . . . . . . . . . . . . . . 240
CAM file parameters The type of display . . . . . . . . . . . . . . . . . . . . 270
Absorption Measurement. . . . . . . . . . . . . . . . 623 Checking for busy. . . . . . . . . . . . . . . . 428
Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Clearing the view . . . . . . . . . . . . . . . . 437
Acquisition. . . . . . . . . . . . . . . . . . . . . . . . . . . 481 Clipboard, copying data/graphics to . . . . 241, 299
Add a source . . . . . . . . . . . . . . . . . . . . . . . . . 640 Closing
Analysis control . . . . . . . . . . . . . . . . . . . . . . . 573 A datasource . . . . . . 36, 226, 347, 365, 386, 404
Attentuation correction . . . . . . . . . . . . . . . . . 622 A device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427
Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . 549 Coincidence rate
Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . 548 Determining if being displayed . . . . . . . . . . . 272
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . 479 Number of standard Deviations . . . . . . . . . . . 274
Deleting a record . . . . . . . . . . . . . . . . . . . . . . . 89 Components
Deleting an entry . . . . . . . . . . . . . . . . . . . . . . . 90 CAM Datasource . . . . . . . . . . . . . . . . . . . . . . 162
Determining number of entries . . . . . . . . . . . 101 DataAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Determining number of records . . . . . . . . . . . 100 DeviceAccess. . . . . . . . . . . . . . . . . . . . . . . . . 126
Display. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 538 Efficiency Calibration Control (Phase I) . . . . 344
Find a record . . . . . . . . . . . . . . . . . . . . . . . . . 180 Efficiency Calibration Control (Phase II) . . . 362
Finding a record . . . . . . . . . . . . . . . . . . . . . . . . 90 Energy Calibration Control (Phase I) . . . . . . 383
Geometry . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510 Energy Calibration Control (Phase II) . . . . . . 402
Inserting a record . . . . . . . . . . . . . . . . . . . . . . . 88 Interactive Data Fit Control . . . . . . . . . . . . . . 280
Inserting an entry . . . . . . . . . . . . . . . . . . . . . . . 88 MVC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Interfering nuclide list . . . . . . . . . . . . . . . . . . 569 Configuration database, runtime . . . . . . . . 470
Interfering nuclide results . . . . . . . . . . . . . . . 570 Configuration parameters, CAM file . . . . . . 479
K-edge analysis results . . . . . . . . . . . . . . . . . 637 Control commands, issuing . . . . . . . . . . . 56
K-edge calibration . . . . . . . . . . . . . . . . . . . . . 637 Convert
MCS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635 ASCII date/time to CAM format . . . . . . . . . . . 70
MGA results. . . . . . . . . . . . . . . . . . . . . . . . . . 587 C date/time to CAM format . . . . . . . . . . . . . . . 69
NAA run descriptor . . . . . . . . . . . . . . . . . . . . 570 Current date/time to CAM format . . . . . . . . . . 68
NaI standard file . . . . . . . . . . . . . . . . . . . . . . 571 Energy value to a channel . . . . . . . . . . . . 93, 142
Neutron acquisition and results . . . . . . . . . . . 592 Copy
Neutron declaration data . . . . . . . . . . . . . . . . 603 CAM records . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Neutron detector data. . . . . . . . . . . . . . . . . . . 606 Classes of CAM data . . . . . . . . . . . . . . . . . . . . 57
Neutron sample processing . . . . . . . . . . . . . . 616 Data into a Windows Application . . . . . . . . . 241
Neutron Sample-dependent data . . . . . . . . . . 607 Copying
Nuclide library . . . . . . . . . . . . . . . . . . . . . . . . 551 A parameter block . . . . . . . . . . . . . . . . . . 87, 179
Peak search results . . . . . . . . . . . . . . . . . . . . . 541 A record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . 514 All text to clipboard . . . . . . . . . . . . . . . . . . . . 438
QA parameter definition . . . . . . . . . . . . . . . . 583 Data into a Windows Application . . . . . . . . . 299
QA results . . . . . . . . . . . . . . . . . . . . . . . . . . . 585 Selected text to clipboard. . . . . . . . . . . . . . . . 438

752
 Copying a record . . . . . . . . . . . . . . . . 145 Open a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
A record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Opening a. . 33, 84, 176, 346, 364, 385, 404, 418
Create a Retrieiving current datasource . . . . . . . . . . . . 248
block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Returning a name . . . . . . . . . . . . . . . . . . . . . . 249
File datasource . . . . . . . . . . . . . . . . . . . . . . . . . 36 Returning a type. . . . . . . . . . . . . . . . . . . . . . . 250
Local VDM connection . . . . . . . . . . . . . . . . . . 68 Saving a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Special VDM connection. . . . . . . . . . . . . . . . . 28 Storing changes to . . . . . . . . . . . . . . . . . . . . . 370
Standard VDM connection . . . . . . . . . . . . . . . 29 Datasources
Creating Determining number of . . . . . . . . . . . . . . . . . 250
A new sequence . . . . . . . . . . . . . . . . . . . . . . . 435 Retrieving a list . . . . . . . . . . . . . . . . . . . . . . . 251
A parameter block . . . . . . . . . . . . . . . . . . 86, 179 Date/time conversion
Current database, viewing the . . . . . . . . . 471 ASCII. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
C. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Current . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
D Defining
Data an MCA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 459
CAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Defining annotation color
Read spectral . . . . . . . . . . . . . . . . . . . . . . . . . . 39 For a nuclide energy line . . . . . . . . . . . . . . . . 256
Write spectral. . . . . . . . . . . . . . . . . . . . . . . . . . 40 For a nuclide key line . . . . . . . . . . . . . . . . . . 256
Data display Delete a
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277 Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 VDM connection . . . . . . . . . . . . . . . . . . . . . . . 30
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Deleting
Data points, displaying . . . . . . . . . . . . . 268 A parameter block . . . . . . . . . . . . . . . . . . . . . . 87
Data types A record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
CAM Datasource . . . . . . . . . . . . . . . . . . . . . . 162 All ROIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
CAM Dialog . . . . . . . . . . . . . . . . . . . . . . . . . 417 An entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
DataAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 An ROI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
DevicesAccess . . . . . . . . . . . . . . . . . . . . . . . . 126 Deleting an MCA . . . . . . . . . . . . . . . . 459
Efficiency Calibration Control (Phase II) . . . 362 Density display units, changing. . . . . . . . . 368
Energy Calibration Control (Phase II) . . . . . . 403 Detecting user changes . . . . . . . . . . . . . 435
DataAccess Determine
Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 A datasource name. . . . . . . . . . . . . . . . . . . . . 249
Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 A datasource type . . . . . . . . . . . . . . . . . . . . . 250
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 An open file . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Analyzer status. . . . . . . . . . . . . . . . . . . . . . . . 150
Database Analyzer type. . . . . . . . . . . . . . . . . . . . . . . . . 151
Loading a definition to. . . . . . . . . . . . . . . . . . 471 If a file exist . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Viewing the current . . . . . . . . . . . . . . . . . . . . 471 If coincidence histograms are being displayed
Datasource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Analyzing. . . . . . . . . . . . . . . . . . . . . . . . . . . . 432 If connected to a device . . . . . . . . . . . . . . . . . 152
CAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 If modified datasource . . . . . . . . . . 103, 154, 251
Close a . . . . . . . . . . . . . . . . . . . . . . . . . . . 36, 226 If multiplicity data is being displayed . . . . . . 273
Close all . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 If scalar data is being displayed . . . . . . . . . . . 273
Closing a . . . . . . . . . 85, 177, 347, 365, 386, 404 Number of datasources . . . . . . . . . . . . . . . . . 250
Determining if a source is loaded . . . . . . . . . 228 Number of entries . . . . . . . . . . . . . . . . . . . . . 101
Determining if modified . . . . . . . . 103, 154, 251 Number of records . . . . . . . . . . . . . . . . . . . . . 100
Displaying a specific source . . . . . . . . . . . . . 227 The file name . . . . . . . . . . . . . . . . . . . . . . . . . 100
Displaying next . . . . . . . . . . . . . . . . . . . . . . . 227 Development tools . . . . . . . . . . . . . . . 667
Displaying previous . . . . . . . . . . . . . . . . . . . . 228 Device setup . . . . . . . . . . . . . . . . . . 460
Editing a sequence . . . . . . . . . . . . . . . . . . . . . 435 DeviceAccess
Error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . 688 Component. . . . . . . . . . . . . . . . . . . . . . . . . . . 126
File, create a. . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Information, retrieving. . . . . . . . . . . . . . . . . . . 61 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127

753
 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Efficiency calibration error codes. . . . . . . . 673
Display Energy
A specific source . . . . . . . . . . . . . . . . . . . . . . 227 Calibration error codes. . . . . . . . . . . . . . . . . . 673
Coincidence rates. . . . . . . . . . . . . . . . . . . . . . 236 Energy Calibration Control (Phase I)
Coincidence rates in a spreadsheet . . . . . . . . 275 Component. . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Compressed spectral data. . . . . . . . . . . . . . . . 269 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Data points . . . . . . . . . . . . . . . . . . . . . . . . . . . 268 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Histograms. . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Identified nuclides and peak area results . . . . 266 Energy Calibration Control (Phase II)
Identified nuclides as annotation lines . . . . . . 267 Component. . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Input device status . . . . . . . . . . . . . . . . . . . . . 265 Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Neutron coincidence statistics . . . . . . . . . . . . 265 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Next ROI . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Plot grid lines . . . . . . . . . . . . . . . . . . . . . 261, 323 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Previous ROI . . . . . . . . . . . . . . . . . . . . . . . . . 237 Energy display units, changing. . . . 352, 368, 390
Print dialog. . . . . . . . . . . . . . . 241, 300, 390, 407 Enumerate VDMs . . . . . . . . . . . . . . . . 31
Refresh rate . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Environment
ROI computations . . . . . . . . . . . . . . . . . . . . . 265 Development tools . . . . . . . . . . . . . . . . . . . . . 667
Scalar bank data . . . . . . . . . . . . . . . . . . . . . . . 244 Error codes
Spectral data values . . . . . . . . . . . . . . . . . . . . 266 Acquisition. . . . . . . . . . . . . . . . . . . . . . . . . . . 673
Spectral plot borders . . . . . . . . . . . . . . . . . . . 262 Activity correction . . . . . . . . . . . . . . . . . . . . . 674
Uncompressed spectral data. . . . . . . . . . . . . . 269 Analysis module . . . . . . . . . . . . . . . . . . . . . . 671
Display parameters, CAM file . . . . . . . . . 538 Area correction . . . . . . . . . . . . . . . . . . . . . . . 674
Display type, changing . . . . . . . . . . . . . 270 CAM files . . . . . . . . . . . . . . . . . . . . . . . . . . . 669
DSA2000 MCA setup. . . . . . . . . . . . . . 460 Efficiency calibration. . . . . . . . . . . . . . . . . . . 673
DSC information, retrieving . . . . . . . . . . . 38 Energy calibration . . . . . . . . . . . . . . . . . . . . . 673
Geometry composer. . . . . . . . . . . . . . . . . . . . 675
Input datasource. . . . . . . . . . . . . . . . . . . . . . . 688
E IPC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Editing MID editor . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
An MCA Definition . . . . . . . . . . . . . . . . . . . . 469 Peak area analysis . . . . . . . . . . . . . . . . . . . . . 673
An MID Definition . . . . . . . . . . . . . . . . . . . . 469 Peak locate . . . . . . . . . . . . . . . . . . . . . . . . . . . 673
An open sequence . . . . . . . . . . . . . . . . . . . . . 435 Report module . . . . . . . . . . . . . . . . . . . . . . . . 686
Creating a new sequence for . . . . . . . . . . . . . 435 VDM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 670
Efficiency calibration Error information, getting . . . . . . . . . . . . 31
Add a record . . . . . . . . . . . . . . . . . . . . . . . . . 349 Errors
Cross over energy . . . . . . . . . . . . . . . . . . . . . 112 general . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 694
Dual efficiency coefficients . . . . . . . . . . . . . . 109 geometry composer . . . . . . . . . . . . . . . . . . . . 723
Efficiency points . . . . . . . . . . . . . . . . . . . . . . 112 ISOCS multi-efficiency . . . . . . . . . . . . . . . . . 731
Empirical efficiency coefficients . . . . . . . . . . 111 ISOCS template dependent . . . . . . . . . . . . . . 732
Linear efficiency coefficients . . . . . . . . . . . . 110 LabSOCS template dependent . . . . . . . . . . . . 746
Merging records. . . . . . . . . . . . . . . . . . . . . . . 350 Errors, operational . . . . . . . . . . . . . . . 690
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Evaluating a point in spectroscopy calibration . . 92
Efficiency Calibration Control (Phase I) Events
Components . . . . . . . . . . . . . . . . . . . . . . . . . . 344 Data Display . . . . . . . . . . . . . . . . . . . . . . . . . 277
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358 Efficiency Calibration Control (Phase I) . . . . 358
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345 Efficiency Calibration Control (Phase II) . . . 378
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 354 Energy Calibration Control (Phase I) . . . . . . 399
Efficiency Calibration Control (Phase II) Energy Calibration Control (Phase II) . . . . . . 414
Components . . . . . . . . . . . . . . . . . . . . . . . . . . 362 Interactive Data Fit Control . . . . . . . . . . . . . . 332
Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . 362 Example
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 Files, list of . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363 Program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370 Executing a report template . . . . . . . . . . . 440

754
 Expand mode . . . . . . . . . . . . . . . . . . 257 Interactive Data Fit Control
ExportReport . . . . . . . . . . . . . . . . . . 444 Components . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
F Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
File Interface
Determining if it exists . . . . . . . . . . . . . . . . . . 94 Analysis engine . . . . . . . . . . . . . . . . . . . . . . . . 72
Determining if open . . . . . . . . . . . . . . . . . . . . 102 Setup screen . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Exporting data . . . . . . . . . . . . . . . . . . . . 242, 300 Interfering nuclide parameters, CAM file . . . 569
Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 IPC error codes . . . . . . . . . . . . . . . . . 670
Retrieving the file name. . . . . . . . . . . . . . . . . 100 IsEnhanced . . . . . . . . . . . . . . . . . . . 444
Saving detector data. . . . . . . . . . . . . . . . . . . . 136 ISOCS
File datasource, create a . . . . . . . . . . . . . 36 multi-efficiency errors . . . . . . . . . . . . . . . . . . 731
Files template dependent errors . . . . . . . . . . . . . . . 732
Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Issue control commands . . . . . . . . . . . . . 56
Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Programming library . . . . . . . . . . . . . . . . . . . . 26
Flag Parameters . . . . . . . . . . . . . . . . . 481 K
FWHM Calibrations . . . . . . . . . . . . . . 108 K-edge CAM file parameters
Analysis results . . . . . . . . . . . . . . . . . . . . . . . 637
Calibration . . . . . . . . . . . . . . . . . . . . . . . . . . . 637
G
General errors . . . . . . . . . . . . . . . . . . 694
Genie-2000 software architecture . . . . . . . . 23 L
Geometry composer LabSOCS template dependent errors . . . . . . 746
errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 723 Library files, list of . . . . . . . . . . . . . . . . 27
Geometry composer error codes . . . . . . . . 675 Load
Geometry parameters, CAM file . . . . . . . . 510 A database . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Get error information. . . . . . . . . . . . . . . 31 A ROI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Multiple definitions . . . . . . . . . . . . . . . . . . . . 471
LoadTextEx . . . . . . . . . . . . . . . . . . . 444
H Local VDM connection, creating . . . . . . . . 68
Hiding
Information window . . . . . . . . . . . . . . . 264, 324
Plot grid lines . . . . . . . . . . . . . . . . . . . . . 261, 323 M
Status window . . . . . . . . . . . . . . . . . . . . 263, 324 MCA
High voltage Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 Defining in the MID . . . . . . . . . . . . . . . . . . . 459
High voltage control properties . . . . . . . . . 156 Editing a definition . . . . . . . . . . . . . . . . . . . . 469
Runtime configuration database . . . . . . . . . . 470
Using an MID definition . . . . . . . . . . . . . . . . 455
I MCA input definition
ICB direct access support . . . . . . . . . . . . 62 MID Wizard. . . . . . . . . . . . . . . . . . . . . . . . . . 452
Individual parameters . . . . . . . . . . . . . . 481 MCA input definition, MID wizard. . . . . . . 451
Information, retrieving DSC . . . . . . . . . . . 38 MCS CAM file parameters . . . . . . . . . . . 635
Input Methods
Datasource errors . . . . . . . . . . . . . . . . . . . . . . 688 Adjust control . . . . . . . . . . . . . . . . . . . . . . . . 426
Input definition Analysis editor . . . . . . . . . . . . . . . . . . . . . . . . 434
Loading multiple . . . . . . . . . . . . . . . . . . . . . . 471 CAM Dialog . . . . . . . . . . . . . . . . . . . . . . . . . 418
Using . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470 Data Display . . . . . . . . . . . . . . . . . . . . . . . . . 222
Input definition, printing . . . . . . . . . . . . 470 DataAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Input settings . . . . . . . . . . . . . . . . . . 467 DeviceAccess. . . . . . . . . . . . . . . . . . . . . . . . . 127
Input, select a member of . . . . . . . . . . . . 56 Efficiency Calibration Control (Phase I) . . . . 345
Insert a record . . . . . . . . . . . . . . . . . . 53 Efficiency Calibration Control (Phase II) . . . 363

755
 Energy Calibration Control (Phase I) . . . . . . 383 A sequence for editing . . . . . . . . . . . . . . . . . . 435
Energy Calibration Control (Phase II) . . . . . . 403 Operational errors . . . . . . . . . . . . . . . . 690
Interactive Data Fit Control . . . . . . . . . . . . . . 282
Reporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448
Reporter viewer . . . . . . . . . . . . . . . . . . . . . . . 437 P
Reporter viewer extension . . . . . . . . . . . . . . . 443 PaperView . . . . . . . . . . . . . . . . . . . 446
Sequence analyzer . . . . . . . . . . . . . . . . . . . . . 432 Parameter
MGA results, CAM file . . . . . . . . . . . . . 587 CAM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
MID editor Value, CAM, read . . . . . . . . . . . . . . . . . . 41 - 42
MID wizard . . . . . . . . . . . . . . . . . . . . . . . . . . 452 Parameter Block
MID editor Copying a. . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
adding an MCA . . . . . . . . . . . . . . . . . . . . . . . 457 Parameter code, CAM file . . . . . . . . . . . 480
Basic concepts of . . . . . . . . . . . . . . . . . . . . . . 455 Parameters
Creating a new definition. . . . . . . . . . . . . . . . 470 Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Defining an MCA . . . . . . . . . . . . . . . . . . . . . 459 Individual. . . . . . . . . . . . . . . . . . . . . . . . . . . . 481
Definition summary . . . . . . . . . . . . . . . . . . . . 468 PDFAuthor . . . . . . . . . . . . . . . . . . . 446
Deleting an MCA. . . . . . . . . . . . . . . . . . . . . . 459 PDFCreator . . . . . . . . . . . . . . . . . . . 447
Editing a definition . . . . . . . . . . . . . . . . . . . . 469 PDFKeyword . . . . . . . . . . . . . . . . . . 447
Entry, defining . . . . . . . . . . . . . . . . . . . . . . . . 456 PDFSubject . . . . . . . . . . . . . . . . . . . 447
MID wizard . . . . . . . . . . . . . . . . . . . . . . . . . . 451 PDFTitle . . . . . . . . . . . . . . . . . . . . 447
New definition . . . . . . . . . . . . . . . . . . . . . . . . 470 Peak area analysis error codes . . . . . . . . . 673
starting the . . . . . . . . . . . . . . . . . . . . . . . . . . . 456 Peak label
Summary view . . . . . . . . . . . . . . . . . . . . . . . . 468 Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
Using an MCA definition . . . . . . . . . . . . . . . 455 Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
MID editor error codes . . . . . . . . . . . . . 687 Peak locate error codes . . . . . . . . . . . . . 673
MID wizard . . . . . . . . . . . . . . . . 451 - 452 Peak search parameters, CAM file . . . . . . . 541
Moving a record . . . . . . . . . . . . . . 94, 145 Peak-to-total calibration
Moving spectral plot cursor . . . . . . . . . . . 239 CAM file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 646
Multi-efficiency errors, ISOCS . . . . . . . . . 731 Plot axis labels
Multiple MCA configurations . . . . . . . . . 455 Changing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Multiple View Control (MVC) . . . . . . . . . 221 Plot cursor
Moving. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Retrieving values associated with it. . . . . . . . 302
N Plot limits, changing . . . . . . 240, 298, 367, 407
NAA run descriptor, CAM file . . . . . . . . . 570 Plot points, changing the point size . . . . . . . 271
NaI standard file, CAM file . . . . . . . . . . . 571 Plotting
Naming conventions, variable . . . . . . . . . . 28 Coincidence rates. . . . . . . . . . . . . . . . . . 236, 242
Neutron CAM file parameters Neutron multiplicity histograms . . . . . . . . . . 244
Acquisition and results. . . . . . . . . . . . . . . . . . 592 Scalar bank data . . . . . . . . . . . . . . . . . . . . . . . 244
Declaration data . . . . . . . . . . . . . . . . . . . . . . . 603 Preset, acquisition . . . . . . . . . . . . . . . . 50
Detector data . . . . . . . . . . . . . . . . . . . . . . . . . 606 PreviewScale . . . . . . . . . . . . . . . . . . 445
Sample processing . . . . . . . . . . . . . . . . . . . . . 616 Print a file . . . . . . . . . . . . . . . . . . . . 448
Sample-dependent data . . . . . . . . . . . . . . . . . 607 Printing
Non-multiplication corrected properties . . . . 117 Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390, 407
Nuclide library files, opening . . . . . . . . . . 423 Graphics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Nuclide library parameters, CAM file . . . . . 551 Plot data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Number of entries returned. . . . . . . . . . . . 53 Printing an input definition . . . . . . . . . . . 470
Number of standard deviations . . . . . . . . . 274 Printing the view . . . . . . . . . . . . . . . . 437
Processing parameters, CAM file . . . . . . . . 514
Program, example . . . . . . . . . . . . . . . . 74
O Programming
Open errors . . . . . . . . . . . . . . . . . . . 688 Library files . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Opening Library routines . . . . . . . . . . . . . . . . . . . . . . . . 27
A datasource . . 33, 224, 346, 364, 385, 404, 418 Properties

756
 Data Display . . . . . . . . . . . . . . . . . . . . . . . . . 245 Access handle . . . . . . . . . . . . . . . . . . . . 102, 153
DataAccess . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Number of entries . . . . . . . . . . . . . . . . . . . . . . 53
DeviceAccess. . . . . . . . . . . . . . . . . . . . . . . . . 145 Number of records . . . . . . . . . . . . . . . . . . . . . . 52
Efficiency Calibration Control (Phase I) . . . . 354 Number of spectral ROIs in the spectral plot. 259
Efficiency Calibration Control (Phase II) . . . 370 ROI
Energy Calibration Control (Phase I) . . . . . . 391 Adding an . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Energy Calibration Control (Phase II) . . . . . . 408 Color types. . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Interactive Data Fit Control . . . . . . . . . . . . . . 314 Deleting a. . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Peak labeling . . . . . . . . . . . . . . . . . . . . . . . . . 276 Displaying next . . . . . . . . . . . . . . . . . . . . . . . 236
Reporter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 Displaying previous . . . . . . . . . . . . . . . . . . . . 237
Reporter viewer . . . . . . . . . . . . . . . . . . . . . . . 441 Loading a . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238
Reporter viewer extension . . . . . . . . . . . . . . . 445 Saving a . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
ROI files, opening . . . . . . . . . . . . . . . 420
ROI information
Q Retrieving . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
QA parameter definition, CAM file. . . . . . . 583 Storing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
QA results, CAM file . . . . . . . . . . . . . . 585 ROIs
Computing an. . . . . . . . . . . . . . . . . . . . . . 93, 143
Deleting all. . . . . . . . . . . . . . . . . . . . . . . . . . . 236
R Getting number of . . . . . . . . . . . . . . . . . . . . . 259
Read Routines, programming library. . . . . . . . . . 27
A block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Runtime configuration database . . . . . . . . 470
Array of CAM values . . . . . . . . . . . . . . . . . . . 43 Runtime database
CAM parameter value . . . . . . . . . . . . . . . . . . . 41 Adding an MCA to . . . . . . . . . . . . . . . . . . . . 457
List of CAM values . . . . . . . . . . . . . . . . . . . . . 46 definition of . . . . . . . . . . . . . . . . . . . . . . . . . . 470
Set of CAM parameters . . . . . . . . . . . . . . . . . . 48 Deleting an MCA from . . . . . . . . . . . . . . . . . 459
Spectral data. . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Loading a definition. . . . . . . . . . . . . . . . . . . . 471
Refresh rate, defining . . . . . . . . . . . . . . 260 Unloading a definition from . . . . . . . . . . . . . 472
Report
Error codes. . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Reporter S
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 Safeguards, CAM file . . . . . . . . . . . . . . 628
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 Sample parameters, CAM file . . . . . . . . . 504
Reporter viewer Save a datasource . . . . . . . . . . . . . . . . 35
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437 Saving
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441 As a text file. . . . . . . . . . . . . . . . . . . . . . . . . . 439
Reporter viewer extension As an RTF file . . . . . . . . . . . . . . . . . . . . . . . . 440
Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443 ROIs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445 Scalar data, determining if being displayed. . . 273
Reporting an input definition . . . . . . . . . . 470 Scanning WBC setup, CAM file . . . . . . . . 572
Requirements, analysis engine . . . . . . . . . . 71 Search for CAM records . . . . . . . . . . . . . 58
Retrieve Security parameters, CAM file . . . . . . . . . 572
A list of datasources. . . . . . . . . . . . . . . . . . . . 251 Select a member input . . . . . . . . . . . . . . 56
Average efficiency calibration coefficients . . 113 Sending a command to the acquisition device . 140
CAM information . . . . . . . . . . . . . . . . . . . . . . 39 Sending commands to the current device . . . 141
Datasource information . . . . . . . . . . . . . . . . . . 61 Sequence analyzer
DSC information . . . . . . . . . . . . . . . . . . . . . . . 38 Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434
Name of the device . . . . . . . . . . . . . . . . . . . . 150 Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Neutron measurement . . . . . . . . . . . . . . . . . . 137 Set up device . . . . . . . . . . . . . . . . . . 460
ROI information. . . . . . . . . . . . . . . . . . . . . . . . 51 Setting a device . . . . . . . . . . . . . . . . . 426
Spectral measurements . . . . . . . . . . . . . . . . . 136 Setting the current spectroscopic memory group 139
Uers changes . . . . . . . . . . . . . . . . . . . . . . . . . 435 Setting undefined properties . . . . . . . . . . 156
Return Setting up
A string array of MID detectors. . . . . . . . . . . 153 Detector before acquisition . . . . . . . . . . 131, 229

757
 Neutron device before acquisition . . . . . 132, 230 User changes
Setting/getting boot text. . . . . . . . . . . . . 144 Detecting . . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
Settings Retrieving . . . . . . . . . . . . . . . . . . . . . . . . . . . 435
High voltage. . . . . . . . . . . . . . . . . . . . . . . . . . 463 Using an input definition . . . . . . . . . . . . 470
Input. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467 Utility library routines . . . . . . . . . . . . . . 68
Stabilizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Setup screen interface . . . . . . . . . . . . . . 73
Shape calibration parameters, CAM file . . . . 550 V
Showing Variable naming conventions . . . . . . . . . . 28
Information window . . . . . . . . . . . . . . . 264, 324 VDM
Status window . . . . . . . . . . . . . . . . . . . . 263, 324 Create a standard connection . . . . . . . . . . . . . . 29
Simulator, InSpector 2000 . . . . . . . . . . . 451 Create special connection . . . . . . . . . . . . . . . . 28
Software architecture. . . . . . . . . . . . . . . 23 Delete connection . . . . . . . . . . . . . . . . . . . . . . 30
Special uses, CAM file . . . . . . . . . . . . . 634 Get a list of. . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Spectral data VDM error codes . . . . . . . . . . . . . . . . 670
Compressing data. . . . . . . . . . . . . . . . . . . . . . 178 Verify errors . . . . . . . . . . . . . . . . . . 688
get/set data . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Verifying the device settings . . . . . . . . . . 138
Read . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Viewing
Write . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 RTF file. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Spectral data values, displaying. . . . . . . . . 266 A text file . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
Spectral plot Next/previous NID nuclide result . . . . . . . . . 238
Background color. . . . . . . . . . . . . . . . . . . . . . 255 Next/previous nuclide line . . . . . . . . . . . . . . . 238
Displaying borders. . . . . . . . . . . . . . . . . . . . . 262
Spectral ROIs, filling . . . . . . . . . . . . . . 269
Stabilizer Settings . . . . . . . . . . . . . . . . 462 W
Status messages Write
Severity of. . . 103, 155, 326, 355, 374, 393, 411, A block . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
429 Array of CAM values . . . . . . . . . . . . . . . . . . . 44
Status severity. . . . . . . . . . . . . . . . . . 429 CAM parameter value . . . . . . . . . . . . . . . . . . . 42
Structure, CAM data class . . . . . . . . . . . . 24 List of CAM values . . . . . . . . . . . . . . . . . . . . . 47
Summary of MID definitions . . . . . . . . . . 468 Set of CAM parameters . . . . . . . . . . . . . . . . . . 49
Support for ICB devices . . . . . . . . . . . . . 62 Spectral data. . . . . . . . . . . . . . . . . . . . . . . . . . . 40

T Y
Template-Dependent Errors Y-axis scaling, activating . . . . . . . . . . . . 267
LabSOCS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746 Y-axis ticks, changing the number of marks . . 262,
Template-dependent errors, ISOCS. . . . . . . 732 323

U Z
Unloading a database definition . . . . . . . . 472 Zoom out . . . . . . . . . . . . . . . . . 239, 298

758
 Canberra (we, us, our) warrants to the customer (you, your) that for a period of ninety (90) days from the date of
shipment, software provided by us in connection with equipment manufactured by us shall operate in accordance with
applicable specifications when used with equipment manufactured by us and that the media on which the software is
provided shall be free from defects. We also warrant that (A) equipment manufactured by us shall be free from defects
in materials and workmanship for a period of one (1) year from the date of shipment of such equipment, and (B)
services performed by us in connection with such equipment, such as site supervision and installation services
relating to the equipment, shall be free from defects for a period of one (1) year from the date of performance of such
services.

If defects in materials or workmanship are discovered within the applicable warranty period as set forth above, we
shall, at our option and cost, (A) in the case of defective software or equipment, either repair or replace the software or
equipment, or (B) in the case of defective services, reperform such services.

LIMITATIONS
EXCEPT AS SET FORTH HEREIN, NO OTHER WARRANTIES OR REMEDIES, WHETHER STATUTORY,
WRITTEN, ORAL, EXPRESSED, IMPLIED (INCLUDING WITHOUT LIMITATION, THE WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE) OR OTHERWISE, SHALL APPLY. IN NO
EVENT SHALL CANBERRA HAVE ANY LIABILITY FOR ANY SPECIAL, EXEMPLARY, PUNITIVE, INDIRECT OR
CONSEQUENTIAL LOSSES OR DAMAGES OF ANY NATURE WHATSOEVER, WHETHER AS A RESULT OF
BREACH OF CONTRACT, TORT LIABILITY (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE.
REPAIR OR REPLACEMENT OF THE SOFTWARE OR EQUIPMENT DURING THE APPLICABLE WARRANTY
PERIOD AT CANBERRA'S COST, OR, IN THE CASE OF DEFECTIVE SERVICES, REPERFORMANCE AT
CANBERRA'S COST, IS YOUR SOLE AND EXCLUSIVE REMEDY UNDER THIS WARRANTY.

EXCLUSIONS
Our warranty does not cover damage to equipment which has been altered or modified without our written permission
or damage which has been caused by abuse, misuse, accident, neglect or unusual physical or electrical stress, as
determined by our Service Personnel.

We are under no obligation to provide warranty service if adjustment or repair is required because of damage caused
by other than ordinary use or if the equipment is serviced or repaired, or if an attempt is made to service or repair the
equipment, by other than our Service Personnel without our prior approval.

Our warranty does not cover detector damage due to neutrons or heavy charged particles. Failure of beryllium,
carbon composite, or polymer windows, or of windowless detectors caused by physical or chemical damage from the
environment is not covered by warranty.

We are not responsible for damage sustained in transit. You should examine shipments upon receipt for evidence of
damage caused in transit. If damage is found, notify us and the carrier immediately. Keep all packages, materials and
documents, including the freight bill, invoice and packing list.

When purchasing our software, you have purchased a license to use the software, not the software itself. Because
title to the software remains with us, you may not sell, distribute or otherwise transfer the software. This license allows
you to use the software on only one computer at a time. You must get our written permission for any exception to this
limited license.

BACKUP COPIES
Our software is protected by United States Copyright Law and by International Copyright Treaties. You have our
express permission to make one archival copy of the software for backup protection. You may not copy our software
or any part of it for any other purpose.

Revised 1 Apr 03