GMS 2.

1 Getting Started
Contents
1 2 3 4 Whats New ........................................................................................................................................... 3 Licensing ................................................................................................................................................ 3 2.1 License Installer............................................................................................................................. 4 GMS 2.x Installer ................................................................................................................................... 4 Folders................................................................................................................................................... 8 4.1 4.2 4.3 4.4 5 6 5.1 6.1 6.2 6.3 7 Backups ......................................................................................................................................... 9 Plugins Folder ................................................................................................................................ 9 User Preferences and Custom Functions ...................................................................................... 9 Application layout ....................................................................................................................... 10 Migrating GMS Software Installation from Pre-2.0 to 2.x .......................................................... 10 DigiScan & GFA Hardware Changes ............................................................................................ 12 Installing other drivers ................................................................................................................ 12 Camera issues ............................................................................................................................. 13 Error on Camera Acquire .................................................................................................... 13

Moving to a New Computer................................................................................................................ 10 Supported Hardware........................................................................................................................... 11

6.3.1 7.1 7.2 7.3

DigitalMicrograph ............................................................................................................................... 13 Splash Screen .............................................................................................................................. 13 Opening and docking floating windows...................................................................................... 13 Modifying the toolbar and menu bar ......................................................................................... 16 To add or remove a button, menu, or command to or from a toolbar .............................. 16 To add labels to a toolbar ................................................................................................... 16 To open and close a toolbar................................................................................................ 16 Image Document Layout toolbar ........................................................................................ 18 Basic Workflow ................................................................................................................... 18

7.3.1 7.3.2 7.3.3 7.4 7.4.1 7.4.2 7.5 7.6 7.7 7.8

Databar and Layout..................................................................................................................... 17

The Output Window ................................................................................................................... 20 The FFT ........................................................................................................................................ 20 New .dm4 file format .................................................................................................................. 20 Scripting ...................................................................................................................................... 20 Accessing directories........................................................................................................... 20 Application Window ........................................................................................................... 21

7.8.1 7.8.2

7.8.3 7.8.4 7.8.5 8 8.1 8.2 9 9.1 9.2 10.1

Results Window .................................................................................................................. 21 RegisterScriptPalette() ........................................................................................................ 22 Calling WindowClose() from a modeless script dialog ........................................................ 22

Appendix A: Common Applications Data Folder ................................................................................. 23 Windows XP ................................................................................................................................ 23 Windows 7 .................................................................................................................................. 24 Windows XP ................................................................................................................................ 26 Windows 7 .................................................................................................................................. 26 Before You Begin ......................................................................................................................... 27 Identify Your Operating System .......................................................................................... 27 Identify the FireWire Driver Version You Need to Install ................................................... 27 Locate Driver Installation Folders ....................................................................................... 27 For Windows 7 You Must Downgrade System 1394 OHCI Driver....................................... 27 Installing the 2000 Compliant Version of Gatan GFA Driver............................................... 27 Installing the Legacy Version of Gatan GFA Driver ............................................................. 28 Installing the 2000 Compliant Version of Gatan FireWire Driver ....................................... 28 Installing the Legacy Version of Gatan FireWire Driver ...................................................... 30 Installing the 2000 Compliant Version of Gatan FireWire Driver ....................................... 30

Appendix B: User Data Folder ............................................................................................................. 26

10 Appendix C: Gatan FireWire Driver Software Installation .................................................................. 27 10.1.1 10.1.2 10.1.3 10.1.4 10.2 10.2.1 10.2.2 10.3 10.3.1 10.3.2 10.4 10.4.1

Installing on Windows XP ............................................................................................................ 27

Installing on Windows 7 32-bit ................................................................................................... 28

Installing on Windows 7 64-bit ................................................................................................... 30

11 Appendix D: Identifying GFA Version .................................................................................................. 31 12 Appendix E: Downgrading 1394 OHCI Driver ...................................................................................... 32 13 Appendix F: Gatan Ultrascan 1000 (894)/4000 (895) Driver Installation ........................................... 36 14 Appendix G: Gatan ES500W (782) 1394 Driver Installation................................................................ 38 14.1 How to Switch 1394 Host Adapter to Thesycon 1394 Stack ....................................................... 40 15 Appendix H: Gatan ES500W (782) LVDS Driver Installation ............................................................... 48 16 Appendix I: ES1000W Driver and Libraries Installation ...................................................................... 50 16.1 16.2 16.3 Installation of the Sapera LT Software ........................................................................................ 50 Installation of the Device Driver ................................................................................................. 50 Installation of the MegaPlus Library ........................................................................................... 52

17 Appendix J: Princeton Instruments 64-bit Driver and Libraries Installation ....................................... 55

Whats New
This document shows how to install GMS 2.x and highlights the main difference between 1.x and 2.x from the service and user perspective. GMS 2.x is supported on Windows XP-32, Windows 7-32, and Windows 7-64. The new software is delivered on a DVD. It is important to check for a DVD reader on existing computers on upgrades. Multiple installations of GMS software on the same computer are not supported. GMS 2.x requires a new set of licenses. Pre 2.0 software licenses will not work. Correctly supplying the Site ID (IID) and a list of existing equipment will allow for the smooth creation of new licenses for an upgrade. Licensing issues are discussed in Section 2 of this document. GMS 2.x now saves user files in the locations designated by Windows Client Software Logo Programs, which are different for Windows XP and Windows 7. These locations are discussed in Section 3. Section 6 discusses the supported hardware and other hardware related issues. Section 7 discusses the main new features of DigitalMicrograph

Licensing

GMS 2.0 requires new licenses. All hardware is also licensed. If a license is not present for a specific piece of hardware, no support will be installed for that device. The new licenses come in two flavors, On-line and Off-line. There will be up to two sets of files for each installation. One set will be On-line with a .glc license file and a .txt file (which is a human readable representation of the license file set). The second set will be Off-line with a .glc license file and matching .txt file. These two sets of files come on two CDs marked appropriately On-line and Off-line. You should not install both the On-line and Off-line licenses on the same system. Doing so will result in the GMS Software Installer defaulting to an Off-line installation. There are also different license files for 32-Bit and 64-Bit installations. Mixing of these files on the same system will result in the GMS Installer using the licenses which match the Operating System. I.e. Windows 7-32 will use the 32-Bit licenses and Windows 7-64 will use the 64-Bit licenses. For an upgrade, the new licenses must match the existing IID (Site ID) of the current installation. The IID can be determined by looking into the license .txt file. It can also be found in the registry at HKEY_LOCAL_MACHINE\SOFTWARE\Gatan\SID. This is recommended for advanced systems users only.

2.1 License Installer

There is a new License Installer required for GMS 2.0. The new license installer is named LicenseInstaller.exe as opposed to the old version of LicenseInstall.exe. The new installer works in a similar fashion to the old license installer. The license files to be installed must be located in the same folder as the License Installer program. If you have been provided with one or more License Files CDs, place the appropriate CD in the drive and run the LicenseInstaller.exe program. Run the License Installer program and press the Install Licenses button. The installer will exit automatically if the licenses installed correctly.

GMS 2.x Installer

Installation is initiated by double clicking the setup.exe file in the Installer folder.

If may take a few minutes for the installer to extract, decompress, load and stabilize on the first wizard screen shown below:

Hit Next to produce the License Agreement wizard screen. Please read the displayed terms and conditions, and if you agree, select the I accept the terms in the license agreement radio button, and then hit the Next button. At this point a warning could appear if a mixture of 32 bit and 64 bit licenses are present. Only the licenses matching the current OS will be used. Also, a warning could appear if a mixture of On-line and Off-line licenses are present. In that case only the off-line licenses will be used. The next screen will show all the items licenses were installed for. There is no need to change any selections in this dialog, as there was for GMS 1.x

Hit the Next button to proceed.

If a package is selected, but has no installed license, a warning would be displayed:

Hit the OK button to return control to the Package Selection wizard screen. Then, unselect the referenced module(s). If the install is an upgrade (over an older GMS version), back-up information for the previous installation is provided. All information regarding the location of the back-up is displayed in the dialog. Note that the installer permits the choice between using the existing preferences or create new preferences.

Hit the Next button to proceed. If changes had been made to the selected items in the Package Selection dialog, or if a mixed set of licenses (on-line and off-line) were installed, a warning would be displayed which states that not all

licensed packages were selected. Either correct the situation by hitting the Back button, or continue by hitting the Install button. The software will now be installed and a progress screen will be displayed. During the installation process you may be asked to remove old licenses. Select the button that is appropriate for your situation. In most cases, No is the recommended choice.

For On-line installs in a Windows 7 environment, Windows Security screens may also be encountered for hardware driver components. Select Install this driver software anyway (or equivalent message).

When the installation completes, the following dialog is displayed:

Hit the Finish button. Installation is now complete. You may be asked to restart the system, depending on what modules were installed.

Choose Yes or No in the dialog.

Folders

Locations where files are installed and data files are stored have changed to meet Windows XP and Windows 7 requirements. Windows 7 User Access Controls will not allow a user to write new files or modify existing files in the Program Files folder (except software installers). On both Windows XP and Windows 7 there are two main locations for user writable data. Those are the [CommonAppsDataFolder]\Gatan folder and the [UserDataFolder]\Gatan folder. Appendix A and B show what actual folders [CommonAppsDataFolder] and [UserDataFolder] correspond to on the different operating systems.

4.1 Backups
The installer will back up the entire contents of any previous Pre GMS 2.0 installation in the [CommonAppsDataFolder]\Gatan folder. All preference files will be copied to the new preference file location as well as the Reference Images. On existing GMS 2.x installations, the installer will only back up the contents of the [CommonAppsDataFolder]\Gatan folder. Run time executables on the Program Files folder will not be backed up.

4.2 Plugins Folder

Since the traditional plugins folder in ..\Program Files\Gatan is no longer accessible to users, two additional locations have been made available for users to install their own plugins. 1. The system shared plugins folder is [CommonAppsDataFolder]\Gatan\Plugins. This folder is read at DM startup for any user. This would be the typical location for service plugins. 2. The user specific plugins folder is [UserDataFolder]\Gatan\Plugins where a user can put scripts and plugins that will only load when they are logged onto the system.

4.3 User Preferences and Custom Functions

In addition to the system preferences files stored in the [CommonAppsDataFolder]\Gatan\Prefs folder, there is also a user preferences folder in the user area: [UserDataFolder]\Gatan\Prefs. These folders contain the .prf file for preferences and stored Custom Functions. When installing scripts from within DigitalMicrograph the user has two choices regarding who has access to the installed script, see the radio buttons at the bottom of the dialog shown below.

When choosing Install for the current user only, the Custom Function is stored in [UserDataFolder]\Gatan\Prefs\DigitalMicrographCF8.prf. When choosing Install for all users, the Custom Function is stored in [CommonAppsDataFolder]\Gatan\Prefs\DigitalMicrographCF8.prf.

4.4 Application layout

Other data that used to be stored in preferences is now stored in the registry. This applies to the location of the application window, which floating windows and toolbars are open, and where they are displayed. This data can be found in HKEY_CURRENT_USER\Software\Gatan\DigitalMicrograph. Within this hive is a key called Workspace which contains the last stored layout of the application. Deleting this key will result in DigitalMicrograph resetting to the default layout. Other Keys refer to layouts created with the floating window layout manager. Note: Extreme care should be exercised when making any changes to the Windows registry.

Moving to a New Computer

If the GMS software is going to be migrated from one computer to another, certain files and folders that contain microscopy hardware setup data and preferences specific to your configuration environment will need to be copied from the old computer to the new computer.

5.1 Migrating GMS Software Installation from Pre-2.0 to 2.x

As stated in Section 4, the installed GMS folder locations and structures have changed in version 2.0. Normally, when the GMS 2.x installer performs an upgrade over a pre-GMS 2.0 configuration, all necessary hardware configuration and preference files would automatically be copied to their new locations. However, for the case of switching to a new computer, these folders and files will need to be copied manually. All files in the following folders should be copied from their old to new locations as follows (see Appendix A for OS dependent locations of the CommonAppsDataFolder): From (Old Computer)
C:\Program Files\Gatan\DigitalMicrograph\Prefs C:\Program Files\Gatan\Factory Configurations C:\Program Files\Gatan\Filter Control\Prefs C:\Program Files\Gatan\Reference Images

To (New Computer)
[CommonAppsDataFolder] \Gatan\Prefs [CommonAppsDataFolder] \Gatan\Factory Configurations [CommonAppsDataFolder] \Gatan\Prefs [CommonAppsDataFolder] \Gatan\Reference Images

In addition, the following files should be copied to the indicated folders when a GIB device exists: From (Old Computer)
C:\Program Files\Gatan\Filter Control\GIB Settings.gdf C:\Program Files\Gatan\Filter Control\GIB Hardware Description.ghd

To (New Computer)
[CommonAppsDataFolder] \Gatan\Prefs [CommonAppsDataFolder] \Gatan\ Factory Configurations\Filter\GIF

10

Supported Hardware

Not all hardware works with GMS 2.x or on all Windows Operating Systems. The following list shows the hardware supported. All hardware not listed is not supported. TEM Product 776 ENFINA 777 StemPack (DigiScan II) 863 Tridiem 963 Quantum 806, 807 STEM Detector 894, 895 (UltraScan) 994 UltraScan XP 830, 831, 832, 833 (Orius) 782 ES500W 785 ES1000W 791, 792, 794, 795, 890 (MSC) Only 1394 Not supported Not supported Windows XP 32 Windows 7 32 Windows 7 64 Not supported

SEM Product XuM Online XuM Offline (Reconstruction) 3View MonoCL3/4 MonoCL3/4 Plus

Windows XP 32

Windows 7 32

Windows 7 64

11

SEM Product MonoCL3/4 Swift MonoCL3/4 Elite ChromaCL SmartEBIC

Windows XP 32

Windows 7 32

Windows 7 64

Notes: 1. The ENFINA is only supported on Windows XP, 32 bit. This is a restriction related to the drivers for the camera used in the ENFINA. 2. The 782, ES500W, comes in the original PCI card version (LVDS, or non-firewire), and the later FireWire (or 1394) version. Only the FireWire version is supported on Windows 7, 64 bit. 3. The 785, ES1000W, comes in the original version with a PCI card based frame-grabber board, and a newer PCIe based frame-grabber board. Only the PCIe based version is supported on Windows 7. 4. The MultiScan cameras are only supported on 32 bit operating systems.

6.1 DigiScan & GFA Hardware Changes

Existing DigiScan and GFA hardware will not work with Windows 7-64. This hardware requires reprogramming. All new DigiScan units and GFA devices shipped as of the release of GMS 2.0 will be modified to communicate with Windows 7-64. This new programming requires new drivers for systems using older versions of the hardware. This process is documented in Appendix C.

6.2 Installing other drivers

Procedures for installing drivers and related software for other devices are documented in Appendix F through Appendix J.

12

6.3 Camera issues 6.3.1 Error on Camera Acquire

When upgrading a system from GMS 1.x to GMS 2.x there may be issues with the Acquire button not working for one or all cameras. To resolve this problem first enter service mode, then perform the following steps for each camera installed on the system: 1. Select a camera 2. In the Camera menu select Edit Camera Tags 3. Delete the tagGroup named Acquisition Parameter Sets by highlighting this tagGroup and then hitting the Remove button. Exit service mode. At this point the Acquire button should work properly.

DigitalMicrograph

In GMS 2.0 the DigitalMicrograph user interface has been updated. Most of the palettes, toolbars and menus are the same as for earlier versions but some of the look and feel and behavior has changed. This section shows the main changes in the behavior of DigitalMicrograph.

7.1 Splash Screen

When starting DigitalMicrograph, a splash screen is displayed providing progress about the launch process. The screen shows the License ID, the application architecture (32 or 64 bit), the full version number, and progress on which plug-in is loading (in the bottom left hand corner).

A similar dialog is displayed when choosing About DigitalMicrograph from the Help menu.

7.2 Opening and docking floating windows

Opening floating windows is the same as it was for GMS 1.x: Open the Window menu Select the Floating Windows sub-menu Select the Window to be opened

13

Docking windows has changed slightly. When dragging a floating window by the title bar, guide diamonds appear indicating where the window can be docked. When moving the mouse over the guide diamond the position where the window will be docked is highlighted.

In the above screenshot the Camera Acquire window was dragged to the guide diamond in the center of the application window and the position where the docking would occur is highlighted in darker blue.

14

. In the above screenshot the Camera Acquire window is dragged on top of the guide diamond displayed on the Camera View window. When releasing the mouse in this position the window will be docked just below the Camera View window as shown but the highlighted area. GMS 2.x has the same restriction as earlier versions that only docking with windows of the same size is possible. Floating windows can be closed by hitting the x on the title bar of the floating window. It is no longer necessary to first undock the window before closing becomes possible. Just like in earlier versions the floating windows can be rolled up by hitting the bar. This button is only displayed if the window is docked with other windows. button in the title

15

7.3 Modifying the toolbar and menu bar

The toolbars and menu bar have grippers on the left end: move the toolbars and menu bar. . When clicking on this gripper you can

The toolbars and menu bar can be undocked by grabbing the gripper, and then moved to other locations. They will snap in their docked location and the whole application will rearrange appropriately. For example, it is possible to dock them on the sides or on the bottom of the application window. Toolbars can also be modified:

7.3.1 To add or remove a button, menu, or command to or from a toolbar

Click the down arrow at the right side of any toolbar, point to Add or Remove Buttons, point to the toolbar name, and then click the item you want to add or remove.

7.3.2 To add labels to a toolbar

Click the down arrow at the right side of any toolbar, point to Add or Remove Buttons, select Customize In the Customize dialog select the Toolbars tab, select the Toolbar, and select the checkbox labeled Show text labels.

7.3.3 To open and close a toolbar

Click the down arrow at the right side of any toolbar, point to Add or Remove Buttons, select Customize In the Customize dialog select the Toolbars tab, select the checkboxes in front of each toolbars name to determine whether they should be displayed. You can also close a toolbar by first dragging it off the main tool area. Then hit the x button on its title bar.

16

7.4 Databar and Layout

In GMS 2.1, the concept of a databar has been revised and the new concept of a document layout has been added. Any number of databars, or groups of items, can be defined. This is done through the Global Info dialog (File\Global Info, Document Layout, Databar Items). Define a New databar group name, then include the desired data items by setting the appropriate checkboxes.

Defining a databar by itself does not carry any implication about the position/color/font (etc.) of these data items. The new concept of a document layout describes how to draw a particular databar, its position/color/font etc. and whether to draw a scale-mark. A given group of databar items can be associated with more than one document layout a document layout could be created for image mode and a different one for page mode, both of which refer to the same group of databar items. Image Documents now have a type. This defaults to Unknown but is set to Camera or DigiScan for documents containing images acquired from these devices. Layouts can be made the default for a particular document type and mode. Default layouts can be automatically applied after every acquisition. The check box on the layout page of the global info dialog does this. If there are no defined groups of databar items or layouts then checking this box will apply a scale-mark after every acquisition as in previous versions of GMS.

17

7.4.1 Image Document Layout toolbar

A new Layout toolbar has been added to make it easy to manage the scale-mark, groups of databar items and their layout (the old Databar menu commands and toolbar buttons have been removed):

The first two buttons ( ) add a new or remove an existing scale-mark. The next pair ( ) add a new or remove an existing databar. If a new databar is added, a prompt is displayed to permit selection of the desired group name. The Switch mode apply layout button ( ) switches the document mode from image to page and vice versa. It applies the default layout for that document type and mode in each case. This is convenient when you want a layout for viewing images as they acquired, but want to switch to a different layout for printing a document. The last two buttons ( ) apply or save a layout, prompting you for the layout name. When a layout is saved, there is an option to have it be the default layout for this document type and mode. This allows a particular group of databar items to be applied and laid out automatically after every camera or DigiScan acquisition.

7.4.2 Basic Workflow

The first step is to create a databar group. This is done on the Global Info dialog (see figure in Section 7.4); select the New button to display the Create new group of databar items dialog. Once a group name is defined it will appear in the groups list. Individual (data) items can be included in a group by activating the appropriate checkbox. The checkbox settings are automatically applied to the highlighted databar group name. Next, acquire an image (or open an image document) to create an image document window. Then, select the Add new databar button ( ).

Select the desired databar group name and press the OK button to add the associated data items to the image window. Now that the items are in the image document window, they can be moved, reorganized, change font, or colors as desired. Once the desired arrangement has been attained, select the Save layout button ( ) to display the Save image document layout as: dialog.

18

Define an appropriate name for the layout, which can also be set as the default for the indicated document type and mode. Now that an image document layout exists the Apply layout button ( ) can be used. Another useful step would be to format a layout for printing the image in page mode. Based on having saved the layout in the screen shown above, select the Switch mode apply layout button ( ) to produce the image shown below. In this state the individual items can be manipulated as desired, and then a new layout (for page mode) can be saved.

19

7.5 The Output Window

The GMS 1.x Results window has been changed to the Output window. The Output window is dockable in different locations of the application window and it consists of three different panes: Results, Notes and Debug. Docking of the Output window is similar to that of floating windows. When dragging the Output window guide diamonds will appear, and when moving the cursor on top of the guide diamond the new docked location will be highlighted. The three panes in the Output window are meant to help organize some of the results that were all sent to the same location in earlier versions. The Results pane is meant for sending real results of measurements etc. The Notes pane can be used by the user and is never written to by the application. The Debug pane is used to send error messages to the user. If an error message is sent, the Debug pane is automatically shown. If errors occur on start-up, then the Debug pane may contain more information information that in GMS 1.x was written to the Results window.

Opening and closing of the Output window can still be done from the Window menu as before.

7.6 The FFT

The FFT has been modified to now also include a Discrete Fourier Transform. This means that it is no longer required to have sizes equal to a power of 2.

7.7 New .dm4 file format

With the introduction of a 64-bit version of GMS, a file format is needed that can support very large files. The .dm3 format can only write files up to 4GB, so a new file format is introduced: .dm4. When trying to save a file that is larger than 4GB only the dm4 format will be available. Files saved in dm4 format cannot be opened by earlier versions of GMS. Files saved in dm3 format are compatible with earlier versions of GMS, and can be opened there. All files created with earlier versions of GMS can be opened in GMS 2.x.

7.8 Scripting
Most of the script commands that run on GMS 1.x will run unchanged on GMS 2.x. However, there are some changes and recommendations related to scripting that are described in this section.

7.8.1 Accessing directories

Non-administrators on Windows 7 computers are not allowed to write data in the application folder, which is why preferences and other files are now saved in official locations which depend on the operating system. For scripters to access those locations the following functions should be used:
dm_string GetApplicationDirectory( long index, bool create_if_necessary ) bool GetApplicationDirectory( dm_string app_dir_name, bool create_if_necessary, dm_string *dir_path )

20

For index and name use the following constants:

Directory Application Common preferences User preferences Plug-ins Common plug-ins User Plug-ins Reference Images Index 1000 1004 1005 1008 1009 1010 1020 Name application preference user_preference plugin common_plugin user_plugin reference_image

7.8.2 Application Window

The following script function existed in GMS 1.x, but was removed in GMS 2.0:
Window GetApplicationWindow()

This function has been added back in for GMS 2.1.

7.8.3 Results Window

The following script function existed in GMS 1.x, but has been removed in GMS 2.x:
Window GetResultsWindow( bool open )

This function was removed because the Results window is no longer scriptable window and cannot be passed to the scripting interface. In GMS 2.0 there is no work-around if this access is required. GMS 2.1 has functions added to interact with the new Output window (described in section 7.5). The following functions are available:
Function
"void Result(double, string format)" "void Result( dm_string )" "void Result(double)" "void Result(complex)" "void Result(RGB)" "void Notes( dm_string )" "void Debug( dm_string )" "void ClearResults( "void ClearNotes( "void ClearDebug( )" )" )"

Description
Output the real number with the printf-style format to the Results pane. Output the string to the Results pane. Output the real number to the Results pane. Output the complex number to the Results pane. Output the RGB number to the Results pane. Output the string to the Notes pane. Output the string to the Debug pane. Erases all text from the Results pane. Erases all text from the Notes pane. Erases all text from the Debug pane. Opens the Output window.

void OpenOutputWindow( )"

21

7.8.4 RegisterScriptPalette()
The function RegisterScriptPalette() now returns a boolean value indicating whether it successfully registered the palette.
bool RegisterScriptPalette( ScriptObject, string type, string name )

In GMS 1.x it returned a unique id that could be used to un-register the palette. In GMS 2.x you can unregister the palette by using its name:
void UnregisterScriptPalette( string name )

7.8.5 Calling WindowClose() from a modeless script dialog

In GMS 1.x it was possible to add a button to a script dialog and then call a function that caused the whole script dialog to close:
Class myDLG:UIframe { myDLG(object self) result("\n Create DLG") ~myDLG(object self) result("\n Kill DLG") void CloseButtonAction(object self) { self.GetFrameWindow().WindowClose(1) } TagGroup CreateDLG(object self) { TagGroup DLGtg,DLGtgItems DLGtg=DLGCreateDialog("my Dialog",DLGtgItems) DLGtgItems.DLGAddElement( DLGCreatePushButton("Close","CloseButtonAction")) return DLGtg } } { object dialog=Alloc(myDLG) dialog.Init( dialog.CreateDLG() ) dialog.display("") }

When running this script, and clicking on the Close button will crash GMS 2.x. To fix this problem the line in bold:
self.GetFrameWindow().WindowClose(1)

Needs to be replaced with the following line:

self.Close()

This fix is available in GMS 2.1.

22

8 Appendix A: Common Applications Data Folder 8.1 Windows XP

On Windows XP the Common Applications Data Folder is located at C:\Documents and Settings\All Users\Application Data. C:\Documents and Settings\All Users\Application Data is a hidden folder, so to browse to this folder you have two options: 1. Set the system up to show hidden folders: a. Open Explorer by double clicking on the Computer icon on the desktop. b. Choose Folder Options from the Tools menu.

c. In the Folder Options dialog, click the View tab, and select Show hidden files and folders.

23

d. Hit the OK button. The C:\Documents and Settings\All Users\Application Data is now displayed in Explorer and can be browsed to. 2. Browse by typing in the address bar: a. Open Explorer by double clicking on the Computer icon on the desktop. b. Double click Document and Settings. c. Double click All Users. d. Place the cursor in the address bar, type C:\Documents and Settings\All Users\Application Data and hit the enter key. e. Now double click the Gatan folder.

8.2 Windows 7
On Windows 7 (32 and 64 bit) the Common Applications Data Folder is located at C:\ProgramData. C:\ProgramData is a hidden folder, so to browse to this folder you have two options: 2. Set the system up to show hidden folders: a. Open Explorer by double clicking on the Computer icon on the desktop. b. Choose Folder Options from the Tools menu.

24

c. In the Folder Options dialog, click the View tab, and select Show hidden files, folders, and drives.

d. Hit the OK button. The C:\ProgramData is now displayed in Explorer and can be browsed to. 3. Browse by typing in the address bar: a. Open Explorer by double clicking on the Computer icon on the desktop. b. Place the cursor in the address bar and type C:\ProgramData

25

c. And hit Enter. You are now in the C:\ProgramData folder as displayed in the address bar.

9 Appendix B: User Data Folder 9.1 Windows XP

On Windows XP the User Data Folder is at C:\Documents and Settings\User-Name\Local Settings\Application Data where User-Name is the actual name of the Windows logon user. Both the Local Settings folder and the Application Data folder are hidden folders. So to be able to browse to this location you have to either choose to not hide hidden folders, or type the required path in the address bar, as explained in Appendix A for the Common Applications Data Folder.

9.2 Windows 7
On Windows 7 (32 and 64 bit) the User Data Folder is at C:\Users\User-Name\AppData\Local where User-Name is the actual name of the Windows logon user. The AppData folder is a hidden folder, so to be able to browse to this location you have to either choose to not hide hidden folders or type the required path in the address bar, as explained in Appendix A for the Common Applications Data Folder.

26

10 Appendix C: Gatan FireWire Driver Software Installation 10.1 Before You Begin
This document describes how to install Gatan FireWire drivers for GFA devices, such as DigiScan, DigiScan II, MSC and GIB. Gatan provides such drivers for XP, Windows 7 32-bit and Windows 7 64-bit operating systems. There are two sets of drivers: Legacy and 2000-Compliant. The Legacy driver is compatible with XP and Windows 7 32-bit. The 2000-Compliant driver is compatible with all three operating systems listed above. Note 1: Compliant here is shorthand for Configuration ROM format compliance only and should not be interpreted as a claim to the full compliance with the IEEE 1394 2000 Standard. Note 2: Legacy here is unrelated to the OHCI Legacy stack mentioned elsewhere in this document. Important: (1) You must use Legacy drivers for GFA Legacy devices and you must use 2000-Compliant drivers for GFA 2000-Complinat devices. (2) You must use 2000-Compliant version of GFA devices for Windows 7 64-bit. For the two other platforms you can use either Legacy or 2000-Compliant devices. Tip: All versions of GMS software installed prior to GMS 2.0 release use Legacy GFA devices.

10.1.1 10.1.2

Identify Your Operating System Identify the FireWire Driver Version You Need to Install

Your Operating System can be XP 32-bit, Windows 7 32-bit or Windows 7 64-bit.

Your Gatan FireWire device can be Legacy or 2000 Compliant type. Appendix D explains how to identify the FireWire driver for each type.

10.1.3

Locate Driver Installation Folders

If you are installing or upgrading to GMS 2.0 and higher, you will find drivers under the [CommonAppsDataFolder]\Gatan\Drivers folder. If you are installing a new GFA device on a version earlier than 2.0 you will find the drivers on the CD included with the device.

10.1.4

For Windows 7 You Must Downgrade System 1394 OHCI Driver

Downgrade the 1394 OHCI driver See Appendix E for the instructions.

10.2 Installing on Windows XP 10.2.1 Installing the 2000 Compliant Version of Gatan GFA Driver
Right-click the Unknown device node you identified as Gatan FireWire device node in Section 10.1.2, select Update Driver Software; Browse my computer for driver software and Navigate to the subfolder [CommonAppsDataFolder]\Gatan\Drivers\FireWire\XP\Win32\GFA\2000 Compliant to install the driver.

27

10.2.2

Installing the Legacy Version of Gatan GFA Driver

Typically there will be no need to (re)install the GFA Legacy driver on an XP system. If such a need arises, the driver can be installed by performing the steps in Section 10.2.1, but browsing to a different folder: [CommonAppsDataFolder]\Gatan\Drivers\FireWire\XP\Win32\GFA\Legacy to install the driver.

10.3 Installing on Windows 7 32-bit 10.3.1 Installing the 2000 Compliant Version of Gatan FireWire Driver
Step 1: Right-click the Unknown device node you identified as Gatan FireWire device node in Section 10.1.2, select Update Driver Software; Browse my computer for driver software and Navigate to the subfolder [CommonAppsDataFolder]\Gatan\Drivers\FireWire\Win7\Win32\GFA\2000 Compliant to install the driver. Important: You must verify that only controller(s) connected to GFAII devices run on a downgraded stack. To confirm this, follow steps below. Step 2: Verify that your FireWire device is plugged into IEEE 1394 port controlled by the 1394 OHCI Legacy Driver: display GFAII device properties (Device Manager, right-click on the Gatan FireWire Adapter node, select Properties). A correct device configuration is shown in Figure 10-1. An incorrect configuration is shown in Figure 10-2.

Figure 10-1

28

Figure 10-2

Step 3: If you have determined that Gatan FireWire Adapter is in an incorrect location, you must restore the original driver for this node. To do this, expand the IEEE 1394 Bus host controllers node in the Device Manager. Figure 10-3 shows example of a system with 3 different OHCI stacks installed. Your system configuration might be different.

Figure 10-3

29

Step 4: Replace stack for the Legacy node by 1394 OHCI Compliant Controller. Use the instructions in Appendix E (Downgrading 1394 OHCI Stack), however, in this case perform the reverse operation: replace a Legacy stack with a regular one. Step 5: Move to the next node under the IEEE 1394 Bus host controllers node and downgrade its 1394 Stack (keep track of the nodes you have already visited!). Go to Step 2. Step 6: Repeat Steps 2 5 until you achieve desired configuration.

10.3.2

Installing the Legacy Version of Gatan FireWire Driver

Step 1: Right-click the Unknown device node you identified as the Gatan FireWire device node in Section 10.1.2, select Update Driver Software; Browse my computer for driver software and Navigate to the subfolder [CommonAppsDataFolder]\Gatan\Drivers\FireWire\Win7\Win32\GFA\Legacy to install the driver. Step 2 Step 6: Refer to section Installing the 2000 Compliant Version of the Gatan FireWire Driver above.

10.4 Installing on Windows 7 64-bit 10.4.1 Installing the 2000 Compliant Version of Gatan FireWire Driver
Step 1: Right-click the Unknown device node you identified as Gatan FireWire device node in Section 10.1.2, select Update Driver Software; Browse my computer for driver software and Navigate to the subfolder [CommonAppsDataFolder]\Gatan\Drivers\FireWire\Win7\x64 to install the driver. Step 2 Step 6: Refer to section Installing the 2000 Compliant Version of the Gatan FireWire Driver above.

30

11 Appendix D: Identifying GFA Version

To identify the FireWire driver you need to install: a) Plug the GFA device you are installing into a FireWire port (typically, a 400 port you will be using for your device). b) Open Windows Device Manager. c) Look for Unknown device under the Other devices node.

Figure D-1 Showing the unique Hardware Ids values for the Legacy GFA device

Figure D-2 Showing the unique Hardware Ids values for the 2000 Compliant GFA device

31

12 Appendix E: Downgrading 1394 OHCI Driver

The following instructions describe how to revert to the Vista or legacy 1394 Host controller bus driver. This driver is provided for backwards compatibility for Firewire device drivers that are not compliant with the new Windows 7 OHCI driver architecture. Step 1: Open the Windows 7 Device Manager Click on the Start button. Now, type devmgmt.msc in the box with the text "Search Programs and Files" and press the <Enter> key. This will open the Device Manager:

Step 2: Expand the IEEE 1394 Bus host controllers node to see the installed 1349 host controllers. Note that there may be more than one listed. It is important that the correct controller is selected for the following steps to have the desired effect.

32

Step 3: Locate the Firewire (1394) controller in the Device Manager tree that you will be using with the GFA device, right click it, and select Update Driver Software... from the pop-up menu. This will open the Update Driver Software window:

Step 4: Now, select the Browse my computer for driver software (Locate and install driver software manually.) option. This will advance you to the next window where you will be prompted to browse for driver software on your computer. Read ahead, because you will not be doing any browsing.

33

Step 5: Now, beneath the browsing option select Let me pick from a list of device drivers on my computer (This list will show installed driver software compatible with the device, and all driver software in the same category as the device.). This will advance you to the next window where you will be prompted to select the device driver you want to install for this hardware.

Step 6: Now, select the 1394 OHCI Compliant Host controller with the word Legacy appended to it and then click Next. This will advance you to the next window where the driver will be installed.

34

Step 7: When the installation is complete you will advance to the final window where you are informed that Windows has successfully updated your driver software.

35

13 Appendix F: Gatan Ultrascan 1000 (894)/4000 (895) Driver Installation

This section describes installation of the device driver for Gatan Ultrascan US1000 (894) and US4000 (895) cameras. The installation steps are similar for all supported platforms: Windows XP, Windows 7 32-bit and Windows 7 64-bit. Step 1: Install the Ultrascan PCI adapter. Step 2: Identify Host Adapter in the Device Manager (most likely under the Other Devices node)

Make sure that device Hardware Ids match those shown in the figure above. Tip: Sometimes, Windows 7 mis-identifies the Ultrascan host adapter. For example, there is a case when the adapter is listed under the Sound, video and game controllers node as TARGA (Audio Controller). In such cases, use the Device Hardware Ids as shown in the figure above to identify the Ultrascan host adapter and uninstall drivers installed by Windows: right click on the mis-identified node, select Uninstall and this is important check the Delete the driver software for this device checkbox. Once this is done, perform steps described below.

36

Step 3: Install Device Driver Right click on the device driver node. In the above figure, the node name is Multimedia Controller. Select Update Driver Software and choose Browse my computer for driver software option and navigate to the driver installation folder: Windows XP or Windows 7 32-Bit = [CommonAppsDataFolder]\Gatan\Drivers\ARCamera\Win 7\Win32 Windows 7 64-Bit = [CommonAppsDataFolder]\Gatan\Drivers\ARCamera\Win 7\x64. If presented with a security dialog Windows cant verify the publisher of this driver software, select the Install this driver software anyway option. You will need to reboot your PC to complete driver installation. Once the drivers have been properly installed, the Ultrascan PCI adapter should be listed under the Transfer Cable Devices node in the Device Manager:

37

14 Appendix G: Gatan ES500W (782) 1394 Driver Installation

Step 1: Attach Camera to PC Plug the 1394 firewire cable into the 1394a adapter supplied with the camera unit. Step 2: Identify Device in the Device Manager Uninstalled devices are listed under Other devices as Unknown device. The following figure illustrates how to identify the ES500W 1394 camera:

Step 3: Install Driver Right click on the device driver node. In the above figure, the node name is Unknown device. Select Update Driver Software and choose Browse my computer for driver software option and navigate to the driver installation folder: Windows XP or Windows 7 32-Bit = [CommonAppsDataFolder]\Gatan\Drivers\CoolSnap\FireWire Windows 7 64-Bit = [CommonAppsDataFolder]\Gatan\Drivers\FireWire\Win 7\x64.

38

Step 4: Verify Installation From the GMS installation disk (DVD) locate the utility PMFWUtil.exe in the folder <DVD drive letter>:\Support\Camera\Photometrics\FirmwareUpdater. Run this application. In the Utilities menu, select Check Gap Count option:

Examine the results:

39

If the Current Gap Count is the same as the Optimum Gap Count, your installation succeeded (as shown in the previous figure). Some system configurations may not support the 1394 Photometrics camera. In such cases, the utility results might look like the following:

Notice that in this case the Current Gap Count is 63 and the Optimum Gap Count is 5. This is a suboptimal condition and the camera may not be fully functional. Installation of the Thesycon stack (described in the next section) can resolve this condition. Important: The ES500W 1394 camera must be plugged into 1394 adapter shipped to with the camera.

14.1 How to Switch 1394 Host Adapter to Thesycon 1394 Stack

Step 1: Navigate to the driver installation folder: [CommonAppsDataFolder]\Gatan\Drivers\CoolSnap\Theyscon FireWire Stack Run the Thesycon Installer by double-clicking on T1394bus_v1.29.2_full.exe

40

Step 2: The Thesycon Installer should open up (see below). Click Next.

Step 3: Accept the default Destination Folder. Click Install.

41

Step 4: Once the required files have been extracted click Next.

Step 5: Once the required files have been installed click Finish.

42

Step 6: Using Windows Explorer, navigate to: C:\Thesycon\T1394bus\v1.29.2\drv.install Open the 32bit folder for 32-bit Windows (XP or Win 7), or the 64bit folder for 64-bit Windows:

Step 7: After opening the appropriate folder (32bit is used in this example) the following list of files should be seen:

43

Step 8: Double click on the file t1394bus_installwizard. The Thesycon driver setup wizard should open. It should display all of the 1394 controllers present on the device. By clicking on/selecting this driver, the host controller details and driver details are shown below it.

In the figure above there are three (3) 1394 host controllers present in the system, with the third controller selected for driver replacement. Press the Switch to T1394bus driver button to switch to Thesycon driver.

Note that Microsoft was replaced by Thesycon in the Driver Provider column.

44

Step 9: Verify that the Thesycon driver for the controller connected to the ES500W 1394 camera has been installed. In the Device Manager, examine properties of the WDF Driver for Photometrics 1394 Cameras. Two cases are possible: a) you replaced OHCI driver on the controller connected to the ES500W camera b) you replaced OHCI driver on a different controller
Case b is illustrated below:

As can be seen, the controller still has an in-box Texas Instruments driver installed. This means that the ES500W camera is connected to a different controller and the driver on this controller needs to be restored to the original state.

Step 10: With the bottom line in the controller list as shown in Step 8, press Switch to in-box 1394 driver. This should result in the Driver Provider changing from Thesycon back to Microsoft.
Note: If during the process of switching to an in-box driver you are presented with a dialog asking to reboot, you dont have to do that. Instead, follow the steps below keeping track of which nodes you have visited. You can reboot later just once -- when the configuration where Thesycon driver is installed on the proper 1394 controller has been achieved.

45

In the figure above, the third controller in the list has been restored to its original state, and the first controller in the list is selected. Click Switch to T1394bus driver to replace the driver. You should see that the Driver Provider field has changed to Thesycon:

46

Step 11: Once again, open the properties screen for the WDF Driver for Photometrics 1394 Cameras as described in Step 9. If the correct device has still not been selected, repeat steps 9-10 again using one of the remaining untested devices.

The figure above illustrates a successful installation of the Thesycon driver for the 1394 controller connected to a Photometrics 1394 Camera.

47

15 Appendix H: Gatan ES500W (782) LVDS Driver Installation

Note: The information in this section is for the non-Firewire ES500W camera. This camera is supported on Windows XP 32-bit and Windows 7 32-bit operating systems only. Before installing the ES500W driver, the LVDS cable host adapter board needs to be installed into a PCI slot on your system and install GMS version 2.x needs to be installed. Then follow the steps below:

Step 1: Identify the LVDS cable card To identify your board open the Device Manager. If the drivers are not already installed, the board will be listed under the Other devices node and will most likely be identified as a Multimedia Video Controller. Right click on this node to produce the pop-up menu and select Properties. Then select the Details tab, followed by the Hardware Ids selection from the pick list. The screen below shows the unique hardware Id information for the board whether its drivers are installed or not. LVDS Cable host adapter board identification:

Step 3: Install the Device Driver Once the device with the Hardware Ids shown above has been located and with the (Multimedia Video Controller) Properties dialog displayed, select the Driver tab followed by the Update Driver button. The next screen that appears will depend on which operating system is running on your computer. If the operating system is Windows XP, select the radio button choices shown in the following sequence of screens:

48

If the operating system is Windows 7, the How do you want to search for driver software? screen will be displayed (instead of the above screens). Select the Browse my computer for driver software option to display the Browse for driver software on my computer screen. Click Browse(Win7) or Next (WinXP) and browse to the following folder (this location is the same for all operating systems): [CommonAppsDataFolder]\Gatan\Drivers\CoolSnap\PhotoMetricsPCI Select the Next button to perform the update. Once the driver is installed, the device shown on the previous page should be renamed and have moved to a new node as shown below:

49

16 Appendix I: ES1000W Driver and Libraries Installation

Before installing the ES1000W driver and library, the frame grabber card needs to be installed in your system and GMS version 2.x needs to be installed. Then follow the steps below: 1. Install the Sapera LT software suite 2. Install the driver for the frame grabber card 3. Install the MegaPlus Library Note: Currently, the ES1000W camera is supported on Windows XP 32-bit and Windows 7 32-bit operating systems.

16.1 Installation of the Sapera LT Software

Browse to the folder [CommonAppsDataFolder]\Gatan\Drivers\Sapera\Sapera LT 32-Bit and run Setup. Follow instructions on the screen. A system re-start will most likely be required.

16.2 Installation of the Device Driver

Step 1: Identify the Frame Grabber Board Gatan software supports the ES1000W on two frame grabbers: the X64 Xcelera-CL PX4 and the X64-CL. To identify your board open the Device Manager. If the driver is not already installed, the boards will be listed under the Other devices node as shown below. Also note that when the drivers are not installed, the boards are not always identified as an Unknown device. X64-CL Board identification (by the unique Hardware Ids):

50

X64 XCelera-CL PX4 board identification (by the unique Hardware Ids):

Step 2: Install the Device Driver If the X64-CL card has been installed: Browse to the folder [CommonAppsDataFolder]\Gatan\Drivers\Sapera\Sapera X64CL Legacy and run Setup.exe. Follow instructions on the screen. Select Automatic when presented with the dialog:

If the X64 XCelera-CL PX4 card has been installed: Browse to the folder [CommonAppsDataFolder]\Gatan\Drivers\Sapera\Sapera Xcelera-CL PX4 Driver and run Setup.exe. Follow instructions on the screen. Select Automatic if presented with a dialog similar to the one shown above.

51

Once the drivers are successfully installed, the device will automatically move from the Other devices node to the Imaging devices node with its designated name. The screen below shows the X64-CL as an example:

16.3 Installation of the MegaPlus Library

Step 1: Browse to [CommonAppsDataFolder]\Gatan\Drivers\Sapera\MegaPlus Central, run Setup.exe and follow instructions on the screen. 16.3.1.1 Step 2: Press Next When presented with a dialog similar to this:

In the next dialog, select Camera Link Serial button and clsercor.dll in the Vendors CL DLL field:

52

Press Next to advance to the Step 3 dialog (which summarizes the selected options). Then, press Finish to complete the installation.

53

Step 3 (Optional): OEM driver and libraries installation verification The installation status can be verified by running DALSAs CamExpert application: Start->All Programs->DALSA->Sapera LT->CamExpert The figure shown below is CamExpert running on a system with the X64-CL board installed. On the left side of the screen, in the Device palette, select the CameraLink Full Mono #1 node. This will cause the Camera palette (located below the Device palette) to populate. Find and expand the Redlake node, followed by the ES11000 node, then select the 1st sub-node as shown below:

The right side of the screen should populate with information similar to the above figure. The Grab control should also be functional.

54

17 Appendix J: Princeton Instruments 64-bit Driver and Libraries Installation

This section describes installation of PICam, the 64-bit device driver and libraries for Princeton Instruments cameras. Supported operating systems are: Windows 7 (64-bit)

Supported Princeton Instruments cameras are: PIXIS, PIXIS-XB, PIXIS-XF, PIXIS-XO ProEM Quad-RO

Step 1: Browse to [CommonAppsDataFolder]\Gatan\Drivers\Princeton Instruments\PICam, run picam install.exe and follow instructions on the screen. Step 2: Press Next When presented with the following dialog:

Only the PICam Runtime components are required.

55

Step 3: The default destination folder is recommended.

Step 4: Complete the installation sequence. Step 5: If warned about the driver software, select "Install this driver software anyway" to proceed.

Step 6: Reboot the computer at the end of installation. Step 7: Attach a supported camera and verify that it appears in the Windows Device Manager.

56