+ All Categories
Home > Documents > GMS - Getting Started

GMS - Getting Started

Date post: 24-Jan-2016
Category:
Upload: sergioodin4851
View: 117 times
Download: 8 times
Share this document with a friend
Description:
GUIA DE INICIO
Popular Tags:
67
1 GMS 2.3 – Getting Started Contents 1 What’s New ........................................................................................................................................... 3 2 Licensing................................................................................................................................................ 3 2.1 License Installer............................................................................................................................. 4 3 GMS 2.x Installer ................................................................................................................................... 4 4 Folders................................................................................................................................................... 8 4.1 Backups ......................................................................................................................................... 9 4.2 Plugins Folder ................................................................................................................................ 9 4.3 User Preferences and Custom Functions ...................................................................................... 9 4.4 Application layout ....................................................................................................................... 10 5 Moving to a New Computer................................................................................................................ 10 5.1 Migrating GMS Software Installation from Pre-2.0 to 2.x .......................................................... 10 6 Supported Hardware........................................................................................................................... 11 6.1 DigiScan & GFA Hardware Changes ............................................................................................ 12 6.2 Installing other drivers ................................................................................................................ 12 6.3 Camera issues ............................................................................................................................. 13 6.3.1 Error on Camera Acquire .................................................................................................... 13 7 DigitalMicrograph ............................................................................................................................... 13 7.1 Splash Screen .............................................................................................................................. 13 7.2 Opening and docking floating windows...................................................................................... 13 7.3 Modifying the toolbar and menu bar ......................................................................................... 16 7.3.1 To add or remove a button, menu, or command to or from a toolbar .............................. 16 7.3.2 To add labels to a toolbar ................................................................................................... 16 7.3.3 To open and close a toolbar................................................................................................ 16 7.4 Databar and Layout..................................................................................................................... 17 7.4.1 Image Document Layout toolbar ........................................................................................ 18 7.4.2 Basic Workflow ................................................................................................................... 18 7.5 The Output Window ................................................................................................................... 20 7.6 The FFT ........................................................................................................................................ 20 7.7 New .dm4 file format .................................................................................................................. 20 7.8 Scripting ...................................................................................................................................... 20 7.8.1 Accessing directories........................................................................................................... 20 7.8.2 Application Window ........................................................................................................... 21 7.8.3 Results Window .................................................................................................................. 21
Transcript
Page 1: GMS - Getting Started

1

GMS 2.3 – Getting Started

Contents

1 What’s New ........................................................................................................................................... 3

2 Licensing ................................................................................................................................................ 3

2.1 License Installer ............................................................................................................................. 4

3 GMS 2.x Installer ................................................................................................................................... 4

4 Folders ................................................................................................................................................... 8

4.1 Backups ......................................................................................................................................... 9

4.2 Plugins Folder ................................................................................................................................ 9

4.3 User Preferences and Custom Functions ...................................................................................... 9

4.4 Application layout ....................................................................................................................... 10

5 Moving to a New Computer ................................................................................................................ 10

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

6 Supported Hardware ........................................................................................................................... 11

6.1 DigiScan & GFA Hardware Changes ............................................................................................ 12

6.2 Installing other drivers ................................................................................................................ 12

6.3 Camera issues ............................................................................................................................. 13

6.3.1 Error on Camera Acquire .................................................................................................... 13

7 DigitalMicrograph ............................................................................................................................... 13

7.1 Splash Screen .............................................................................................................................. 13

7.2 Opening and docking floating windows ...................................................................................... 13

7.3 Modifying the toolbar and menu bar ......................................................................................... 16

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

7.3.2 To add labels to a toolbar ................................................................................................... 16

7.3.3 To open and close a toolbar ................................................................................................ 16

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

7.4.1 Image Document Layout toolbar ........................................................................................ 18

7.4.2 Basic Workflow ................................................................................................................... 18

7.5 The Output Window ................................................................................................................... 20

7.6 The FFT ........................................................................................................................................ 20

7.7 New .dm4 file format .................................................................................................................. 20

7.8 Scripting ...................................................................................................................................... 20

7.8.1 Accessing directories ........................................................................................................... 20

7.8.2 Application Window ........................................................................................................... 21

7.8.3 Results Window .................................................................................................................. 21

Page 2: GMS - Getting Started

2

7.8.4 RegisterScriptPalette() ........................................................................................................ 22

7.8.5 Calling WindowClose() from a modeless script dialog ........................................................ 22

8 Appendix A: Common Applications Data Folder ................................................................................. 23

8.1 Windows XP ................................................................................................................................ 23

8.2 Windows 7 .................................................................................................................................. 24

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

9.1 Windows XP ................................................................................................................................ 26

9.2 Windows 7 .................................................................................................................................. 26

10 Appendix C: Gatan FireWire Driver Software Installation .................................................................. 27

10.1 Before You Begin ......................................................................................................................... 27

10.2 Two Types of GFA’s Exist ............................................................................................................. 28

10.2.1 Identifying the GFA Type with Device Manager ................................................................. 28

10.3 Driver Configuration Summary by Operating System ................................................................. 29

10.4 Locate the Driver Installation Folders ......................................................................................... 29

10.5 Installing Drivers for Windows XP ............................................................................................... 29

10.5.1 Install the Appropriate GFA Driver ...................................................................................... 30

10.6 Installing Drivers for Windows 7 32-bit ...................................................................................... 32

10.6.1 Downgrade the Host Controller Driver ............................................................................... 32

10.6.2 Install the GFA Driver .......................................................................................................... 35

10.7 Installing Drivers for Windows 7 64-bit ...................................................................................... 39

10.7.1 Downgrade the Host Controller Driver ............................................................................... 39

10.7.2 Install the Compliant GFA Driver......................................................................................... 39

10.8 Trouble Shooting ......................................................................................................................... 39

10.8.1 DigiScan is not found by DigitalMicrograph ........................................................................ 39

10.8.2 DigitalMicrograph hangs during startup when ‘Digiscan Plug-in.dll’ is loading.................. 39

11 Appendix D: Gatan ES500W (782) 1394 Driver Installation ................................................................ 40

11.1 How to Switch 1394 Host Adapter to Thesycon 1394 Stack ....................................................... 42

12 Appendix E: Gatan ES500W (782) LVDS Driver Installation ................................................................ 50

13 Appendix F: ES1000W Driver and Libraries Installation...................................................................... 52

13.1 Installation of the Sapera LT Software ........................................................................................ 52

13.2 Installation of the Device Driver ................................................................................................. 52

13.3 Installation of the MegaPlus Library ........................................................................................... 54

14 Appendix G: StarTech Device Slot Expansion Enclosure System Driver Installation .......................... 57

15 Appendix H: Installing GMS Software for the Enfina 1000 on Windows 7 32 bit ............................... 59

15.1 Assumptions/Limitations/Requirements .................................................................................... 59

15.2 Installation Instructions .............................................................................................................. 59

Page 3: GMS - Getting Started

3

1 What’s 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

2 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.

Page 4: GMS - Getting Started

4

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 CD’s, 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.

3 GMS 2.x Installer Installation is initiated by double clicking the setup.exe file in the Installer folder.

Page 5: GMS - Getting Started

5

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.

Page 6: GMS - Getting Started

6

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

Page 7: GMS - Getting Started

7

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).

Page 8: GMS - Getting Started

8

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.

4 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: Common

Applications Data Folder and Appendix B: User Data Folder show what actual folders correspond to on

the different operating systems.

Page 9: GMS - Getting Started

9

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.

Page 10: GMS - Getting Started

10

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.

5 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: Common Applications Data Folder for OS dependent locations of the

CommonAppsDataFolder):

From (Old Computer) To (New Computer)

C:\Program Files\Gatan\DigitalMicrograph\Prefs [CommonAppsDataFolder]\Gatan\Prefs

C:\Program Files\Gatan\Factory Configurations [CommonAppsDataFolder]\Gatan\Factory Configurations

C:\Program Files\Gatan\Filter Control\Prefs [CommonAppsDataFolder]\Gatan\Prefs

C:\Program Files\Gatan\Reference Images [CommonAppsDataFolder]\Gatan\Reference Images

In addition, the following files should be copied to the indicated folders when a GIB device exists:

From (Old Computer) To (New Computer)

C:\Program Files\Gatan\Filter Control\GIB Settings.gdf [CommonAppsDataFolder]\Gatan\Prefs

C:\Program Files\Gatan\Filter Control\GIB Hardware

Description.ghd

[CommonAppsDataFolder]\Gatan\ Factory Configurations\Filter\GIF

Page 11: GMS - Getting Started

11

6 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 Windows XP 32 Windows 7 32 Windows 7 64 Windows Server

2008 R2 (x64)

776, 876 (ENFINA) > GMS 2.31 Not supported

777 StemPack (DigiScan II) > GMS 2.30

850 GIF 2002, 860 GIF 2001 > GMS 2.12 Not supported

863 Tridiem Not supported

963, 965, 966 (Quantum) > GMS 2.30

967 Quantum LS Not supported > GMS 2.31

976, 977 (Enfinium) > GMS 2.11 Not supported

806, 807 (STEM Detector) > GMS 2.30

894, 895 (UltraScan) > GMS 2.21

994 UltraScan XP > GMS 2.21

830, 831, 832, 833 (Orius) > GMS 2.21

782 ES500W Only 1394 Not supported

785 ES1000W Not supported

791, 792, 794, 795, 890 (MSC) Not supported

1000 K2 Not supported > GMS 2.21

SEM Product Windows XP 32 Windows 7 32 Windows 7 64

XuM Online > GMS 2.10

XuM Offline (Reconstruction)

Page 12: GMS - Getting Started

12

SEM Product Windows XP 32 Windows 7 32 Windows 7 64

3View

MonoCL3/4

MonoCL3/4 Plus

MonoCL3/4 Swift > GMS 2.10

MonoCL3/4 Elite > GMS 2.10

ChromaCL

SmartEBIC

Notes:

1. The ENFINA is supported on Windows XP/7, 32 bit. This is a restriction related to the drivers for

the camera used in the ENFINA. See Appendicies for required special installation procedure on

Windows 7 32 bit.

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 “Legacy” 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: Gatan FireWire Driver

Software Installation.

6.2 Installing other drivers Procedures for installing drivers and related software for other devices are documented in the

Appendicies (sections 11. through 15).

Page 13: GMS - Getting Started

13

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.

7 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

Page 14: GMS - Getting Started

14

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.

Page 15: GMS - Getting Started

15

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 button in the title

bar. This button is only displayed if the window is docked with other windows.

Page 16: GMS - Getting Started

16

7.3 Modifying the toolbar and menu bar

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

move the toolbars and menu bar.

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.

Page 17: GMS - Getting Started

17

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.

Page 18: GMS - Getting Started

18

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.

Page 19: GMS - Getting Started

19

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.

Page 20: GMS - Getting Started

20

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 )

Page 21: GMS - Getting Started

21

For index and name use the following constants:

Directory Index Name

Application 1000 “application”

Common preferences 1004 “preference”

User preferences 1005 “user_preference”

Plug-ins 1008 “plugin”

Common plug-ins 1009 “common_plugin”

User Plug-ins 1010 “user_plugin”

Reference Images 1020 “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 Description

"void Result(double, string format)" Output the real number with the printf-style

format to the Results pane.

"void Result( dm_string )" Output the string to the Results pane.

"void Result(double)" Output the real number to the Results pane.

"void Result(complex)" Output the complex number to the Results pane.

"void Result(RGB)" Output the RGB number to the Results pane.

"void Notes( dm_string )" Output the string to the Notes pane.

"void Debug( dm_string )" Output the string to the Debug pane.

"void ClearResults( )" Erases all text from the Results pane.

"void ClearNotes( )" Erases all text from the Notes pane.

"void ClearDebug( )" Erases all text from the Debug pane.

“void OpenOutputWindow( )" Opens the Output window.

Page 22: GMS - Getting Started

22

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 un-

register 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.

Page 23: GMS - Getting Started

23

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”.

Page 24: GMS - Getting Started

24

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.

Page 25: GMS - Getting Started

25

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”

Page 26: GMS - Getting Started

26

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: 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: Common Applications Data Folder.

Page 27: GMS - Getting Started

27

10 Appendix C: Gatan FireWire Driver Software Installation

10.1 Before You Begin This document describes how to install drivers required for Gatan FireWire Adapter (GFA) devices, such

as DigiScan, DigiScan II, MSC and GIB. GFA devices talk to DigitalMicrograph via a FireWire connection to

the PC. This FireWire connection is managed on the equipment side by the GFA, and on the PC side by

an “IEEE 1394 Bus host controller”either on the PC motherboard or a separate PCI card.

Figure 10-1 FireWire connections between the PC and GFA devices

Figure 10-2 Two sets of devices as seen by Device Manager

Page 28: GMS - Getting Started

28

The drivers required for each of these two devices depend on the Operating System (OS). Gatan

provides drivers for Windows XP, Windows 7 32-bit, and Windows 7 64-bit. The remainder of this

Appendix explains the drivers needed for each OS, and how to ensure that the correct drivers are

installed.

10.2 Two Types of GFA’s Exist All new DigiScan II hardware ship with a new, 64-bit compatible GFA, otherwise known as “Compliant”.

Older DigiScan, GIB and MSC equipment might have an older stlye GFA known as “Legacy”. The Legacy

GFAs cannot be used in the Windows 7 64-bit OS. There are different drivers for these two GFA types.

Your GFA will need to be identified so that the appropriate driver can be installed.

10.2.1 Identifying the GFA Type with Device Manager To open the Device Manager in Windows 7, click on the Start button. In the box (directly above the Start

button) with the text “Search Programs and Files” type devmgmt.msc and then press the <Enter> key.

To open the Device Manager in Windows XP, click on the Start button. Select “Search” to display the

Search Results window. At “What do you want to search for?” select All files and folders. In the “All or

part of the file name box” type devmgmt.msc and in the “Look in:” box make sure “Local Hard Drives” is

selected, then press the Search button. Once this file has been found and displayed in the file list

double click the file name.

If the GFA drivers are not installed, the GFA device will be displayed under the “Other devices” node.

Right click on the GFA device and select “Properties” from the pop up menu. On the device Properties

screen select the Details tab. In the drop down list, look for and select “Hardware Ids”. A 64-bit

Compliant GFA will have the value shown in Figure 10-3 (1394\GATAN&GFAII), and a Legacy GFA will

have the value shown in Figure 10-4 (1394\50C0&10001).

Figure 10-3 Hardware Id of a “Compliant” GFA (will work in all OS’s)

Page 29: GMS - Getting Started

29

Figure 10-4 Hardware Id of a “Legacy” GFA (will NOT work in Win7 x64)

Notes:

• “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.

• “Legacy” here is unrelated to the OHCI Legacy stack mentioned elsewhere in this document.

• All versions of GMS software installed prior to GMS 2.0 release use Legacy GFA devices.

10.3 Driver Configuration Summary by Operating System

Operating System Host Controller Driver GFA Driver Type

Windows XP No Action Needed Compliant or Legacy

Windows 7 x32 Downgrade to Legacy Compliant or Legacy

Windows 7 x64 Downgrade to Legacy Compliant ONLY

10.4 Locate the Driver Installation Folders

• If you have installed or upgraded 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 GMS 2.0 you will find the drivers

on the CD included with the device.

10.5 Installing Drivers for Windows XP As shown in the table in Section 10.3, only the GFA driver needs to be installed for Windows XP.

However, which driver is to be installed depends on which GFA device type has been determined to be

present (see section 10.2.1).

Page 30: GMS - Getting Started

30

10.5.1 Install the Appropriate GFA Driver In Device Manager, right click on the GFA device and select “Update Driver” from the pop up menu.

Follow the steps shown in Figures 10-5 to 10-8 below.

Figure 10-5 Installing the GFA driver in Windows XP, Step 1

Figure 10-6 Installing the GFA driver in Windows XP, Step 2

Page 31: GMS - Getting Started

31

Figure 10-7 Installing the GFA driver in Windows XP, Step 3

Before pressing Next on the screen shown in the above figure, select the Browse button and navigate to

the appropriate driver location for your GFA type (see section 10.2.1 to identify which type you have):

For a “Legacy” GFA

[CommonAppsDataFolder]\Gatan\Drivers\FireWire\XP\Win32\GFA\Legacy

For a “Compliant” GFA

[CommonAppsDataFolder]\Gatan\Drivers\FireWire\XP\Win32\GFA\2000 Compliant

Once the path has been selected, press the Next button.

Figure 10-8 Installing the GFA driver in Windows XP, Step 4

Page 32: GMS - Getting Started

32

10.6 Installing Drivers for Windows 7 32-bit As shown in the table in section 10.3, two driver installs are required for Windows 7 x32: (1) downgrade

the Host controller to Legacy, and (2) install the GFA driver.

10.6.1 Downgrade the Host Controller Driver The (IEEE 1394 Bus) Host Controller manages all FireWire devices located inside the PC. Note that more

than one host controller may exist on your system. See Figure 10-2 for an example where the PC has 3

FireWire devices. In this case, you need to be sure to locate and configure the correct controller (i.e. the

one that corresponds to the device in the PC that the FireWire cable from your equipment is connected

to). FireWire devices in the PC can be identified by using Device Manager to note the unique Hardware

IDs for each controller listed. Then, remove each Firewire PCI card (one at a time) and observe which

controller has disappeared in Device Manager. By using this process of elimination, a one-to-one map

should be able to be constructed allowing the correct controller to be managed.

The default driver in Windows 7 is most likely labled “Compliant” (see Figure 10-2, the first controller).

This must be changed to “Legacy” (see Figure 10-2, the second controller).

In Device Manager, right click on the correct host controller and select “Update Driver Software…” from

the pop up menu. Follow the steps shown in Figures 10-9 to 10-13 below.

Figure 10-9 Downgrading the Host Controller driver in Windows 7, Step 1

Page 33: GMS - Getting Started

33

Figure 10-10 Downgrading the Host Controller driver in Windows 7, Step 2

(select “Browse my computer…”)

Figure 10-11 Downgrading the Host Controller driver in Windows 7, Step 3

(select “Let me pick from a list…”)

Page 34: GMS - Getting Started

34

Figure 10-12 Downgrading the Host Controller driver in Windows 7, Step 4

(select the one with “Legacy” in the name)

Figure 10-13 Downgrading the Host Controller driver in Windows 7, Step 5

(correct configuration shown)

Page 35: GMS - Getting Started

35

10.6.2 Install the GFA Driver The GMS software installer should have correctly installed the GFA driver, so first check if it has done so

(see section 10.6.2.1). If not, you need to identify the GFA type (see section 10.2) and install the correct

driver based on that.

10.6.2.1 Confirm Driver Installation

In Device Manager,if the device “Gatan FireWire Adapter” is seen under the node “1394 Devices”, then

everything has been installed correctly. If “GATAN GFAII” is seen under the node “Other devices”, then

the GFA driver will need to be installed manually.

Figure 10-14 GFA device driver installed correctly

Page 36: GMS - Getting Started

36

Figure 10-15 GFA device driver NOT installed correctly

In this case, follow the instructions in the next section to install the correct GFA device drivers for

Windows 7.

Page 37: GMS - Getting Started

37

10.6.2.2 Install the Appropriate GFA Driver

In Device Manager, right click on the GFA device and select “Update Driver Software…” from the pop up

menu. Follow the steps shown in Figures 10-16 to 10-18 below.

Figure 10-16 Installing the GFA driver in Windows 7, Step 1

(select “Browse my computer…”)

Page 38: GMS - Getting Started

38

Figure 10-17 Installing the GFA driver in Windows 7, Step 2

Before pressing Next on the screen shown in the above figure, select the Browse button and navigate to

the appropriate driver location for your GFA type (see section 10.2.1 to identify which type you have):

For a “Legacy” GFA

[CommonAppsDataFolder]\Gatan\Drivers\FireWire\Win7\Win32\GFA\Legacy

For a “Compliant” GFA

[CommonAppsDataFolder]\Gatan\Drivers\FireWire\Win7\Win32\GFA\2000 Compliant

Once the path has been selected, press the Next button.

Figure 10-18 Installing the GFA driver in Windows 7, Step 3

(correct configuration shown)

Page 39: GMS - Getting Started

39

10.7 Installing Drivers for Windows 7 64-bit As shown in the table in section 10.3, two driver installs are required for Windows 7 x64: (1) downgrade

the Host controller to Legacy, and (2) install the Compliant GFA driver.

10.7.1 Downgrade the Host Controller Driver The procedure for Win7 x64 is the same as Win7 x32, so follow the instructions provided in section

10.6.1.

10.7.2 Install the Compliant GFA Driver The procedure for Win7 x64 is the same as Win7 x32 with the exception that only the 2000 Compliant

driver is supported. Follow the instructions provided in section 10.6.2.2, but at step 2 (Figure 10-17)

browse to the following location of the Compliant drivers:

[CommonAppsDataFolder]\Gatan\Drivers\FireWire\Win7\ x64

10.8 Trouble Shooting

10.8.1 DigiScan is not found by DigitalMicrograph

• Check the Debug tab of DigitalMicrograph’s output window. Often there will be an error

message explaining why the DigiScan was not found.

• Run Device Manager. Check that the GFA shows up under the correct 1394 Devices heading. If

no GFA is seen in the Device Manager, check the firewire connections between the PC and

DigiScan.

• If the GFA is seen in the Device Manager and installed correctly, try a Disable/Re-enable cycle: in

Device Manager, right click on the GFA and select ‘Disable’. Wait a few seconds, then right click

again and select ‘enable’.

10.8.2 DigitalMicrograph hangs during startup when ‘Digiscan Plug-

in.dll’ is loading This is usually due to a bad FireWire connection. Reseat the connections on both the PC and DigiScan.

Page 40: GMS - Getting Started

40

11 Appendix D: 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”.

Page 41: GMS - Getting Started

41

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:

Page 42: GMS - Getting Started

42

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.

11.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

Page 43: GMS - Getting Started

43

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

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

Page 44: GMS - Getting Started

44

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

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

Page 45: GMS - Getting Started

45

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:

Page 46: GMS - Getting Started

46

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.

Page 47: GMS - Getting Started

47

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 don’t 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.

Page 48: GMS - Getting Started

48

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’:

Page 49: GMS - Getting Started

49

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.

Page 50: GMS - Getting Started

50

12 Appendix E: 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 Roper Scientific LVDS cable host adapter board needs to be installed

into a PCI-32 slot on your system and 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.

Roper Scientific LVDS Cable host adapter board (PCI-32) identification:

Step 2: 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:

Page 51: GMS - Getting Started

51

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:

Page 52: GMS - Getting Started

52

13 Appendix F: 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.

13.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.

13.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’):

Page 53: GMS - Getting Started

53

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.

Page 54: GMS - Getting Started

54

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:

13.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.

Step 2: Press “Next” When presented with a dialog similar to this:

Page 55: GMS - Getting Started

55

In the next dialog, select “Camera Link Serial” button and clsercor.dll in the “Vendor’s CL DLL” field:

Press “Next” to advance to the “Step 3” dialog (which summarizes the selected options). Then, press

“Finish” to complete the installation.

Page 56: GMS - Getting Started

56

Step 3 (Optional): OEM driver and libraries installation verification

The installation status can be verified by running DALSA’s 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.

Page 57: GMS - Getting Started

57

14 Appendix G: StarTech Device Slot Expansion Enclosure System

Driver Installation If the GMS software is going to be installed and run on a Dell T76x0 (or T3610) Precision Workstation

computer (Gatan p/n# 711.07776 or 711.07778) and the StarTech device slot expansion enclosure

system (Gatan p/n# 101780) is needed in order to accomodate acquisition device adapter cards, the

drivers described in this section can be installed in order to address any observed performance issues

affecting the quality of the acquired images.

The folders and driver files referenced in Step 6 will be present with a successful GMS software install

using “On-line” licenses. Begin this procedure with both the T76x0 computer and the StarTech device

slot expansion enclosure system powered off.

Step 1: Install the StarTech device slot expansion enclosure system's PCIe adapter card into an empty

PCIe slot on the T76x0's motherboard.

Step 2: Connect the cable from the StarTech device slot expansion enclosure system to the PCIe card

added to the T76x0 in step 1.

Step 3: (can be performed at a later time) Add the device adaper card(s) to the StarTech device slot

expansion enclosure system.

Step 4: Switch on the power to the StarTech device slot expansion enclosure system.

Step 5: Switch on the power to the T76x0, and complete the login/startup sequence.

Step 6: Browse to the following folder for the appropriate Windows 7 operating system:

32-Bit = “[CommonAppsDataFolder]\Gatan\Drivers\StarTech ExpnEnclSys\Win32”

64-Bit = “[CommonAppsDataFolder]\Gatan\Drivers\StarTech ExpnEnclSys\x64”.

Step 7: Run the driver installer program “Install.exe”. Accept the Windows Security Alert screen for

"Trusted Publisher Certificate", and complete any remaining driver installer screens that may be

displayed.

Step 8: Launch Device Manager to verify existance of the node 'PCIe\PCIe Driver' as shown in the figures

below:

Page 58: GMS - Getting Started

58

Figure 14-1 PCIe drivers installed correctly Windows 7 (32-bit)

Figure 14-2 PCIe drivers installed correctly Windows 7 (64-bit)

Page 59: GMS - Getting Started

59

15 Appendix H: Installing GMS Software for the Enfina 1000 on

Windows 7 32 bit

15.1 Assumptions/Limitations/Requirements

• These instructions are limited to covering the extra steps needed to install GMS and

associated drivers for the Enfina 1000 on Windows 7 32-bit systems.

• Propagation of any previous GMS version’s settings, calibrations, etc. are outside the scope

of these instructions and would need to be handled appropriately.

• Enfina 1000 is supported only in 32-bit Windows 7. 64-bit installations are not supported as

there are no available drivers.

• The applicable software license suites are Enfina Basic, Enfina Advanced, or Enfina ER.

15.2 Installation Instructions Step 1: Turn off the computer and install the Roper Serial (DB9) PCI card using standard practices.

Step 2: Restart the computer and login to Windows with a user having Windows Administrator

privileges.

Step 3: Install an applicable Enfina Software Suite license and any other GMS licenses using standard

practices.

Step 4: Install the GMS 2 software using standard practices.

Step 5: Open Windows Device Manager and confirm that the Roper Serial PCI card is setup to operate

properly. It will most likely need to have the drivers loaded/updated. If it is shown with a ‘?’ near the

‘PCI Device’ then follow the next steps, otherwise skip to step 6.

Right click on the PCI Device entry that has the warning icon, a popup dialog will be displayed.

Page 60: GMS - Getting Started

60

Next click on ‘Properties’ and then select the ‘Details’ tab. Now choose ‘Hardware Ids’ using the

Property drop down menu. Verify the values shown match those in the picture below.

Once verified click ‘OK’ to return to the preivous screen. Right click again on the ‘PCI Device’ enrty

to get to the popup dialog.

This time click on the ‘Update Driver Software…’option in the popup window. At the ‘Update Driver

Software’ dialog (below) select the “Browse my computer for driver software’ option.

Page 61: GMS - Getting Started

61

Browse to the ‘ProgramData\Gatan\Drivers\PICM\PCI\Win7\Win32’ directory and then click ‘Next’.

At the Windows Security dialog, click on ‘Install’.

Page 62: GMS - Getting Started

62

After the drivers have been updated Windows will show a success dialog.

The PCI card should now appear in Device Manager named as ‘Princeton PCI Interface’ with no

associated warning icon. The driver details can now be confirmed by right clicking on the ‘Princeton PCI

Interface’ entry and selecting ‘Properties’. Then click on the ‘Driver’ tab and finally click on the ‘Driver

Details’ button.

This step is complete and you can now exit Device Manager.

Step 6: The next step is to install Win 7/32 compatible PVCAM drivers. First insure that you have the

correct version of the pvcam32.exe (2.7.21.0). This file is installed as part of the GMS Enfina software

and is located in: C:\ProgramData\Gatan\Drivers\PICM\PCI\Win7\PVCAM32

Page 63: GMS - Getting Started

63

Double click to start the pvcam32.exe installer. Follow the ‘Typical’ installation – click the Next button at

each step keeping all the default selections.

Page 64: GMS - Getting Started

64

When the installation is nearly complete the installer will suggest a reboot. After clicking Next and then

Finish to complete the installation, reboot the system.

Step 7: Once the system has rebooted, login to Windows and make sure the camera controller power is

ON.

Step 8: Start DigitalMicrograph from the desktop shortcut. As the startup progresses Digital Micrograph

will display a dialog asking to ‘Select Camera Type’.

Page 65: GMS - Getting Started

65

Click on the ‘Camera Type’ drop down and then scroll to the bottom of the list. Select ‘Custom’.

Leave all other settings in the dialog unchanged. Select ‘OK’ to exit the dialog.

Page 66: GMS - Getting Started

66

Once DigitalMicrograph finishes startup the camera should be operational. Basic operation can now be

verified through the use of the View and Acquire palettes to capture unprocessed images.

Step 9: After camera operation has been verified the camera name should be changed to something

more meaningful. This can be done using the Camera Configuration dialog. Select the ‘Configure

Camera’ choice from the top menu item ‘Camera’.

Page 67: GMS - Getting Started

67

Change the entry ‘Custom 1’ to ‘Enfina’ then click on the ‘OK’ button to exit the dialog.

The new name will be utilized in all references the time DigitalMicrograph is started (some names will

change immediately, others require DM to be exited and restarted). Basic installation is now complete.


Recommended