======================================================== Readme file for PrimaCode® Technologies Calibrate for Windows, v1.1.0 Copyright © -2008 2001 PrimaCode Technologies all rights reserved ========================================================= This document provides information that is intended to supplement the Online User's Guide for Calibrate. ========================================================= How to View This Document ========================================================= To view the Readme file on-screen, open it in Windows Notepad or another word processor. To print the Readme file, click Print on the File menu. ========================================================= CONTENTS ========================================================= 1. SYSTEM REQUIREMENTS 1.1 OPERATING SYSTEMS 1.2 SCREEN RESOLUTION 1.3 INTERNET EXPLORER 1.4 DISK SPACE REQUIREMENTS 1.5 WINDOWS NT/2000 PRIVILEGES 2. INSTALLING CALIBRATE 3. INSTALLED FILES 4. GETTING STARTED WITH CALIBRATE 4.1 USING SAMPLE DATA 4.2 USING YOUR OWN DATA 5. ABOUT SAMPLE DATA 6. KNOWN LIMITATIONS 7. TRIAL PRODUCT RESTRICTIONS 8. MANAGING PRODUCT LICENSE 9. UNINSTALLING CALIBRATE 10. TECHNICAL SUPPORT 11. UNFINISHED/UNTESTED FEATURES 12. VERSION HISTORY 1. SYSTEM REQUIREMENTS ========================================================= 1.1 OPERATING SYSTEM: --------------------------------------------------------- - Microsoft Windows 2000 or later installed - Microsoft .Net Framework 2.0 or later installed 1.2 SCREEN RESOLUTION: -------------------------------------------------------- While Calibrate for Windows will install with a screen resolution of 600 by 800 pixels, it is designed to run on computers with screen resolutions of 1024 by 768 pixels or better with full color. 1.3 INTERNET EXPLORER: --------------------------------------------------------- Internet Explorer version 6.0 (or higher) must be installed prior to installing Calibrate for Windows. 1.4 DISK SPACE REQUIREMENT: --------------------------------------------------------- Calibrate requires about 5 MB of free disk space for the installation. Once installed, Calibrate’s core files (not including fonts) require about 1.3 MB of disk space and the sample data requires only about 8 KB. 1.5 WINDOWS PRIVILEGES: -------------------------------------------------------- To install Calibrate on Windows NT/2000 computers, you must have administrative privileges. 2. INSTALLING CALIBRATE ========================================================= To install PrimaCode Calibrate, simply locate Calibrate’s Setup.exe file (or msi file) in My Computer and double click the file or if your prefer to use the Windows Start menu, click Run and then click Browse to locate the Setup.exe file on your CD Drive, click Open and then OK. 3. INSTALLED FILES ========================================================= On some versions of Windows, Calibrate will install the current version of Microsoft Windows Installer. In most instances, programs such as Microsoft Office will have already installed the program. However, if it is necessary to install this add-in, you will be required to reboot before installation of Calibrate is completed. Thereafter, any program requiring the Windows Installer will function without interruption. Calibrate installs the Microsoft redistributable True Type Font "Courier New"(comprised of four files), if it doesn’t already reside on your system. When uninstalling calibrate, these files remain on the system. Calibrate also installs two sample library files (containing a Baseline and Device) and two sets of sample observations for getting a quick feel for what Calibrate does. However, the sample libraries will not be installed if libraries files are found in the default library folder. This is to prevent a re-install or repair of Calibrate from overwriting other user defined baseline and device libraries. If you need to reinstall the sample libraries, you can move your libraries to a different location by using the Tools | Options | General tab and click on the Libraries changing the folder using the Path button. The remaining files installed will all be found in the Programs Files folder chosen at the time of installation. 4. GETTING STARTED WITH CALIBRATE ========================================================= 4.1 USING SAMPLE DATA --------------------------------------------------------- The quickest way to get started with Calibrate is to use the sample data that is installed with a complete install of Calibrate for Windows. Simply use the open menu to open one or both observation sets. They are located in your ‘My Documents | EDM Calibrations’ folder. Once opened, click the calibrate button (or Procedures | Calibrate EDM menu). Check one or both sets of observations and then click the Compute button. Calibrate then develops a detailed report of the measuring device’s statistics. Customize the report for viewing or printing using the Tools |Options menu and Report tab. Experiment with checking or un-checking individual observations to see how it affects the calibration reports Calibrate generates. To view input values, for any given observation, simply hover your mouse over the observation in the list until it is highlighted, the actual values input will be displayed in the group box under the list. You can also click an observation in the list to edit any of its parameters. However, if you change the sample data, you will be prevented from saving the changes. Also, if you delete a sample device or baseline library and then open one of the sample observation sets, the libraries will automatically be restored to the libraries. This feature works the same for all observation sets, thereby insuring you can always determine what instrument and baseline parameters were in use at the time of any calibration. 4.2 USING YOUR OWN DATA --------------------------------------------------------- To perform your own calibration, start by determining what the manufacture’s instrument constants are for your EDM. You can get this information from the documentation supplied with the instrument or by contacting the manufacturer directly. You will need to have on hand the carrier beam wavelength, the nominal index of refraction, the instrument’s scaling tolerance and the instrument’s constant tolerance. If you choose to have the instrument do atmospheric corrections internally, the wavelength and refractive index are not used. Enter the device information using the Tools | New Device Set Menu. Next go to the NGS web site (Help |NGS Data Sheets…) to retrieve the baseline values for a baseline near you. Enter this into Calibrate using the Tools | New 4 Mark Baseline menu item. You can define any number of device sets and baselines with Calibrate. Each is stored in a library file stored on your computer in the Calibrate folder of the system’s Application Data folder (see installed files) Next open the Tools | Options menu and click the Measure tab. Chose the appropriate measuring methods for your equipment. It is suggested that height of instrument be used for the slope reduction method to minimize observation errors. Click OK when you are done to save the new settings. Next click the New Observations button (File | New Observation Set menu). Chose an instrument and baseline from the dropdown lists and fill-in the dates, time and memo fields. Next click the New Observation button (Procedures | New Observation menu) and provide the required information. To move from filed to field, just click the Enter key on you keyboard (option set with the Tools | Tab On Enter Key menu item). When you are at the last input field, hit the keyboard’s enter key again, which will automatically activate the Next button bringing up the next observation dialog for the baseline. After all observations for the baseline have been entered, use the File | Save Observation menu to save the report to disk. Next make sure that a check mark precedes each observation in the set so that it will be included in the calibration. Then, click the Calibrate EDM button (Procedures | Calibrate EDM menu item), select (check) your new set observation set in the list of observation sets and click the compute button. That all there is to it!! You can repeat this procedure as many times as you like, including or excluding a single observation or whole observation sets. In this manner, you can group a number of observation sets for different dates together (i.e. group observation sets done before and after the time of a particular survey). You may also chose to exclude a particular observation that looked to be in error by removing the check mark preceding it in the list. Before or after you generating a calibration report, you can chose to include or exclude some of the information displayed in the report. The information displayed in the report on your screen will be the same information that is printed. You can also use the File | Send to menu to email the report to a colleague or agency requesting the calibration. 5. ABOUT SAMPLE DATA ========================================================= The sample data included with a Complete Install is comprised of two library files and two observation files containing the same instrument, baseline and data used as an example problem in the NOAA Technical Memorandum NOS NGS-10 publication entitled "USE OF CALIBRATION BASE LINES." Using those observation sets, you can generate results that coincide with each of the example problems found in the aforementioned publication. Note, however, that in some instances, the heights of instrument (HI) values have been modified to conform to Calibrate's validation rules. In such instances, an equal value was added to the HI at each end of a given observation (the slope remains unchanged). Calibrate used an assumed relative humidity of 50% to define the two observation sets. The resulting report will indicate values within the expected variance due to round off errors. Calibrate for Windows does not report the Critical Value of t (Student's t distribution for "Degrees of Freedom" at the 0.01 significance level) for scaling and constant factors in the same manner as is demonstrated in the aforementioned publication. Instead, Calibrate provides a number, called Unit Weight, that is the ratio of the test statistic (for scale or constant) and the Critical Values of t. If the quotient of these two values is less than one, then the associated scale or constant factor is considered statistically equal to zero. 6. KNOWN LIMITATIONS ========================================================= Calibrate supports baselines with only four or five marks(stations). If there is sufficient demand, a future version may be released supporting other configurations. Previous version of Calibrate used baseline and device libraries of a different format. Those library files and therefore any saved observations using baselines or devices saved in those libraries cannot be opened in the release candidate of Calibrate. 7. TRIAL PRODUCT RESTRICTONS ========================================================= No longer applicable 8. MANAGING PRODUCT LICENSE ========================================================= No longer applicable 9. UNINSTALLING CALIBRATE ========================================================= To uninstall Calibrate for Windows, run the Windows Control Panel | Add/Remove Programs applet found on the Windows Start menu under Settings. Locate the product named PrimaCode Calibrate and click the change/remove button. This will remove the installed files and settings from your computer. It will not remove files or settings that are a result of your use of the product such as devices defined, baselines defined, saved observation sets, etc. 10. TECHNICAL SUPPORT ========================================================= For technical support issues concerning the installation and use of Calibrate contact: PrimaCode Technologies 1005 High Street Hill Windsor, MA 01270 support@primacode.com 11. UNFINISHED/UNTESTED FEATURES ========================================================= Very little testing has been done using Mils and Gons angular units. This feature was included to accommodate some military and European instrument types. The use of Microwave type measuring devices is now a rare occurrence. However, to maintain compatibility with such instruments (and the possible need to enter older calibrations), this functionality was included in Calibrate for Windows. This feature also has undergone very little testing. No testing was done using Calibrate for Windows on early model computers with minimally required processors and memory. 12. VERSION HISTORY ========================================================= Version 1.0.25 (build 25) beta Numerous spelling errors were corrections. Up and Down arrow keys now scroll observations in main view. Highlighted observation now reflects entered data properly. Multiple files can now be chosen on File Open. Error from double clicking an observation in the observation list view was corrected. Labeling has been changed on items to better reflect displayed data. Grads changed to Gons. New Baseline button added to Options | Baselines dialog. Undo button and menu item added for restoring deleted observation item. During the install process, you can now designate a different folder for the program files. Corrected multiple errors in the display and reporting of HI’s and HI elevations for forward and reverse set conditions and in the dialog for input of observed data. Version 1.0.30 (build 30) beta Combined the forward and reverse observation sets, making the number of observations on a four point baseline equal 12. Changed some of the validation rules for HI’s and slope angles. Disabled the ability to enter a nominal index of refraction when defining an instrument set since there is only one nominal index of refraction for a given wave length that will result in no correction at the standard temperature, pressure and humidity. Corrected other labeling errors in Calibrate’s observation view and observing input dialog. Version 1.0.35 (build 35) beta Validation rules modified to accommodate up to ten (10) centimeters of error (prism offset constant error) for the first observation made in a new set. Thereafter, the same degree of error is allowed for each subsequent observation. Baseline Mark labels were made static. Therefore, if a baseline is defined in feet, the mark designation will display in feet even if input is set for meters. Fixed placement of focus in observation list following completion of editing an observation. Changed units of measure for EDM device wavelength from micrometers to nanometers. Changed units of measure for EDM device from nominal index of refraction to group refractive index. Changed requirements for defining a device to require both the wavelength and group refractive index since different manufacturers use different normal temperatures, pressures and humidity’s for computing the group refractive index. Fixed numerous small errors in the way Calibrate displays information. Tools | Options | Devices memo field can now be edited at any time. Options view’s column headings revised to better reflect which measured and published distances are being displayed. New, view and edit baseline dialogs revised to better describe distance required from NGS data sheets. Observation validation revised to re-compute the temporary instrument constant based upon all entered distances instead of the first. Observation validation revised to allow a variance of up to three times the manufacturer’s constant and scale factor rating for the EDM device. Observation dialog changed to always show next and back buttons and added OK button. Changed the Calibrate EDM list dialog to show only active documents observations when calibrate button is clicked. The list was changed to show all open observation documents so the user can switch between open documents. Fixed the error that occurred in the EDM Calibration dialog’s list box when a check mark or document name was double clicked. Removed the difference column from the calibration report and added the column for Max Error. Changed the end notes on the calibration report to convey more information and be more explicit. Changed the device dialog boxes to better reflect instruments specifications. Changed the menu names to product activation and product notice. Added a notification for the first observation entered in a new set, reminding the user that a device and baseline must be chosen first. a calibration report no longer has a column for the difference between observed and published. That column has been replaced with a column that displays the ratio of the residual to the maximum allowed error, based upon the manufacturer’s accuracy rating (standard deviation). This is provided in the form of a percentage. Therefore, if the instrument is measuring within the manufacture’s specifications, the percentage for each observation should be less than 100%. when changing an observation, document is now always marked as modified. Device was changed to remove prism offset and add measuring mode (course, fine). Device also changed to disable or enable EDM only atmospheric corrections to make it more intuitive that the user does not need to supply a wavelength and group refractive index. The observations dialog was changed to only allow atmospheric corrections by Calibrate if the device is defined with a group refractive index and wavelength. Calibration Report was changed to remove green text and make red text darker for printing on B&W printers. Also, additional red text was added for residuals that exceed manufacturer’s standard deviation. Changes made that affect shareware mode. Version 1.1.10 Release Candidate Calibrate was made into a freeware product, removing all licensing code and adding a Activation Dialog which required the user to register with PrimaCode Technologies. Support for the International Foot was added.