GMS - Getting Started
GMS - Getting Started
GMS 3.3
Gatan, Inc.
5794 W. Las Positas Blvd.
Pleasanton, CA 94588
t +1.925.463.0200
[email protected]
www.gatan.com
Page 2
Publisher
Gatan Inc.
Technical editors
Gatan Software Group
Date
July 2018
Table of contents
1 Introduction ................................................................................................................ 5
1.1 What’s new ................................................................................................................................................... 5
1.1.1 Technique-centric workflow ................................................................................................................... 5
1.1.2 Tabbed workspaces and data layout manager ..................................................................................... 6
1.1.3 Interactive microscope interface ............................................................................................................ 6
1.1.4 New EELS and EDS analysis ................................................................................................................ 6
1.2 Supported hardware..................................................................................................................................... 6
2 Licensing ..................................................................................................................... 9
2.1 Installing licenses ......................................................................................................................................... 9
2.2 Converting licenses from GMS 2.x to GMS 3.x ......................................................................................... 10
2.3 Installing the converted license for GMS 3.x ............................................................................................. 14
4 DigitalMicrograph ..................................................................................................... 19
4.1 Splash screen............................................................................................................................................. 20
4.2 Overview of the DigitalMicrograph software interface ............................................................................... 20
4.2.1 Techniques panel................................................................................................................................. 21
4.2.2 Microscope diagram panel and the display panel ............................................................................... 22
4.2.3 Workspaces and the view workspace ................................................................................................. 24
4.2.4 Image browser ..................................................................................................................................... 25
4.2.5 Right-click context based functionality................................................................................................. 26
4.2.6 Working with images ............................................................................................................................ 27
4.3 Additional installation information .............................................................................................................. 31
4.3.1 Folders ................................................................................................................................................. 31
4.3.2 Backups ............................................................................................................................................... 31
4.3.3 Plugins folder ....................................................................................................................................... 32
4.3.4 User preferences and custom functions .............................................................................................. 32
GMS 3.3
Introduction Page 4
1 Introduction
This document shows how to install Gatan Microscopy Suite® (GMS) 3 and highlights the main difference
between 2.x and 3.x from the user perspective.
• GMS 3.3 is supported on Windows 7 Pro/Ultimate (64-bit), Windows 10 Pro/LTSB, Windows Server
2008 R2 Enterprise (64-bit), Windows Server 2012 Standard (64-bit) and Windows Server 2016
Standard (64-bit). See Section 1.2 for details on restrictions for specific equipment.
• The new software is delivered on a DVD and/or self-extracting executable.
o It is important to check for a DVD reader on existing computers for upgrades
• Multiple installations of GMS software on the same computer are not supported
• GMS 3 requires a new set of licenses
o Pre-3.0 software licenses will not work
o Correctly supplying the Site ID (IID) and a list of existing equipment will allow for the smooth
creation of licenses needed for an upgrade
o Licensing issues are discussed in Section 2 of this document.
What’s new
The following sections discuss the new features introduced in GMS 3 software.
Technique-centric workflow
The guided workflow in GMS 3 software begins with the techniques panel containing a list of possible
techniques. Selecting one of the techniques reveals the guided workflow. It is also possible for users to
create their own custom technique with associated workflow.
GMS 3.3
Introduction Page 6
Supported hardware
Not all hardware works with GMS 3.x software or on all Windows Operating Systems. The following list
shows the hardware supported for GMS 3.0 and newer software. All legacy hardware not listed is not
supported.
1816.U1 Rio 16 camera in Not supported Not supported Not supported ≥GMS 3.30 ≥GMS 3.30
IS mode
2 Licensing
GMS 3.x software will require GMS 3 software 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 configurations, online and offline. There will be up to two sets of files for each
installation. One set will be online 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 offline with a *.glc license file and matching *.txt
file. These two sets of files come on two CDs marked appropriately: Online and Offline.
You should not install both the online and offline licenses on the same system. Doing so will result in the
GMS Software Installer defaulting to an offline installation.
For an upgrade, the upgrade 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.
Installations making use of an upgrade license(s) from GMS 2.x to GMS 3.x must complete the license
conversion process below to create the new permanent GMS 3.x license. New or non-upgrade installations
do not need to complete this step.
Installing licenses
Insert the appropriate license CD into the DVD drive; the LicenseSetup.exe application should automatically
start. If not, use Windows Explorer to browse to the DVD drive and double-click on the LicenseSetup.exe
file.
If you are installing new GMS 3 licenses for a new installation, then click on the Install button on the Gatan
License Setup screen (image above). If you are upgrading from GMS 2 and purchased upgrade licenses
click on the Upgrade button and skip to the next section, 2.2 Converting licenses from GMS 2.x to GMS 3.x
to continue with the Gatan LicenseConverter application.
Clicking the Install button starts the Gatan License Installer application. Once the screen below is shown,
then click on Install Licenses. The application will then install the licenses, pause briefly to indicate the
number of licenses installed, and then exit automatically. If a problem is encountered during installation, an
error message popup will be displayed. Otherwise, the license installation has been completed successfully.
Remove the CD from the DVD drive and proceed to Section 3 to install the GMS software.
The LicenseConverter will then read the licenses installed on the system. If no licenses are found in
the standard location, then a folder browse dialog is presented to enable entering an alternate
location to search.
2 Next click on the Browse for GMS 3 Upgrade License(s).
This will open a browse dialog that you can use to navigate to the location of the upgrade license(s)
to use. Select the upgrade license you wish to utilize then click the Open button. Typically, the
license(s) would be found on the license CD delivered with your new GMS 3 software.
3 After clicking on Open, the LicenseConverter will show information about the upgrade license that
was added. If you have more one upgrade license to add, then just repeat step 2 until all are loaded.
5 You will then be asked where to store the new license files.
Browse to an existing folder or chose to make a new folder and then click OK.
The LicenseConverter will make and store both the online and offline license files in the selected
folder.The new permanent GMS 3 licenses have now been created.
6 Click Exit to close the LicenseConverter program.
As mentioned earlier you should not install both the online and offline licenses on the same system.
Double-click on either the online or offline directory. Next, double-click on the LicenseInstaller.exe
file.
Once the screen below is shown, then click on Install Licenses.
The application will then install the licenses, pause briefly to indicate the number of licenses
installed, and then exit automatically. If a problem is encountered during installation, an error
message popup will be displayed. Otherwise, the license installation has been completed
successfully.
Following the completion of the license installation, continue with Section 3 to install the GMS
software.
Place the GMS software installation DVD in the drive; set up should automatically run. If it does not
run, then the installation can be initiated by double-clicking on the Setup.exe file.
It 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 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 online and offline licenses are present. In that
case, only the offline 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.
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 software version, backup 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.
4 DigitalMicrograph
In GMS 3.x DigitalMicrograph software, the user interface has undergone a major update. The palettes and
menus offer much of the same functionality as earlier versions but the look and feel and behavior has
changed significantly. The main changes in the DigitalMicrograph software interface are:
• Experiment oriented workflows
o Palettes are organized into Techniques
o Palettes can be collapsed if not needed
• Improved image management
o Workspaces organize data
o Automatic image layout
o Toolbars replaced by right-click menus providing context-based functionality
• Convenient window arranging
o Auto-snap to close edges
o Automatic resizing to match the window size
• Interactive microscope diagram
o Updates with changes in microscope
o Simply click on device/detector to activate
o Start simple acquisitions just by clicking
• Image browser
o Thumbnail strip display of all image windows
o Sortable, detachable, built-in image disposition functions
Splash screen
When starting the DigitalMicrograph software, a splash screen is displayed providing information about the
launch process. The screen shows the License ID, 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.
Techniques panel
Your specific equipment configuration and licensed options determine which Techniques shown. By clicking
on a Technique icon, the applicable palettes will be shown. You can use either the Home button or the drop-
down menu to change Techniques.
Much of what was previously displayed in the left-hand palettes in GMS 2 software is now contained in the
display panel. Simply select the display tab to see this information. The image information displayed is
associated with the frontmost image or view.
Clicking on the Pin icon will hide the entire left panel. Hovering the mouse cursor over the Microscope or
Display tab will momentarily restore the corresponding panel, clicking the Pin icon a second time will restore
the panel for constant display. The Techniques panel may also be pinned in a similar fashion.
A new workspaces tab is automatically created once the workspace image capacity threshold is reached.
This value is user controllable per technique.
Right-clicking on the active tab brings up a menu of options. Workspaces can be saved in entirety including
all images. The auto-arrangement of images, active capture workspace, and workspace options can also be
set up using the right-click menu.
A new workspace can be created by clicking on the + next to the last-named workspace.
Clicking on the X at the right-side of the tab will close the workspace. If the workspace contains any unsaved
images, you will be prompted to save them.
Image browser
The image browser window displays a thumbnail strip of all open images. The window can be scrolled
left/right and sorted in various ways by accessing the right-click menu, right-click on an image within the
browser window. Additional functions allow images to be managed/dispositioned into a designated
workspace.
The image browser window may be detached and floated to any desired location on your display. Just click
on the image browser window title bar and drag the window to the desired position. Alternatively, you can
right-click on the image browser tab and select Floating.
When moving image windows, DM software will auto-align (e.g., snap) images to other images that are
close by.
Resizing image windows is now restricted to avoid white border area. Resizing also auto-snaps to horizontal
and vertical borders making it easy to resize to match neighboring images.
Defining a databar by itself does not carry any implication about the attributes (e.g., position/color/font) of
these data items. The new concept of a document layout describes how to draw a particular databar, its
Getting Started Guide
DigitalMicrograph Page 29
position/color/font, 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
checkbox 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 software.
Scroll to the Layout menu and then select the desired function.
There are selections for adding or removing ( ) an existing scale-mark depending on the state. Also
available are add or remove ( ) an existing databar depending on the state. If a new databar is added, a
prompt is displayed to permit selection of the desired group name.
The last two selections ( ) 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.
The Set to page mode selection ( ) switches the document mode from image to the 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.
Next, acquire an image (or open an image document) to create an image document window. Then
right-click on the image and select Layout→ Add Databar ( ).
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,
right-click and select Layout→ Save layout ( ) to display the Save image document layout as:
dialog.
Define an appropriate name for the layout, which can also be set as the default for the indicated
document type and mode. 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, right-click and select
Layout→ Set to page mode 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.
Folders
On 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.
Backups
The installer will back up the entire contents of any previous GMS 2.x software installation in the
[CommonAppsDataFolder]\Gatan folder.
All preference files will be copied to the new preference file location as well as the Reference Images.
Plugins folder
Two 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 the DM software 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.
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.
5 Application layout
Other data that used to be stored in preferences are now stored in the registry. This applies to the location of
the application window, which floating windows are open, and where they are displayed. This data can be
found in HKEY_CURRENT_USER\Software\Gatan5\DigitalMicrograph. Deleting this key will result in
DigitalMicrograph software resetting to the default layout.
Note: Extreme care should be exercised when making any changes to the Windows registry.
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.
Normally, when the GMS 3.x installer performs an upgrade over a GMS 2.x or 3.x configuration, all
necessary hardware configuration and preference files would automatically be copied to their new locations.
However, in 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 the old computer to the new computer as
follows (see Appendix A: Common applications data folder for finding the OS location of the
CommonAppsDataFolder):
[CommonAppsDataFolder]\Gatan\Prefs
[CommonAppsDataFolder]\Gatan\Factory Configurations
[CommonAppsDataFolder]\Gatan\Prefs
[CommonAppsDataFolder]\Gatan\Reference Images
Appendix A: Common
applications data folder
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.
1 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.
And hit Enter. You are now in the C:\ProgramData folder as displayed in the address bar.