Installation Manual

OLYMPUS Stream [Vers.1.7]

IMAGE ANALYSIS SOFTWARE

Any copyrights relating to this manual shall belong to Olympus Soft Imaging
Solutions GmbH.
We at Olympus Soft Imaging Solutions GmbH have tried to make the informa-
tion contained in this manual as accurate and reliable as possible. Never-
theless, Olympus Soft Imaging Solutions GmbH disclaims any warranty of any
kind, whether expressed or implied, as to any matter whatsoever relating to this
manual.
No part of this document may be reproduced or transmitted in any form or by
any means, electronic or mechanical for any purpose, without the prior written
permission of Olympus Soft Imaging Solutions GmbH.

Microsoft Windows is a trademark of Microsoft Corporation which may be

registered in various countries.

© Olympus Soft Imaging Solutions GmbH

All rights reserved

Version 510_UMA_Installation-OlyStream17_en_Han_00
 Contents
1 The OLYMPUS Stream documentation..................................... 4
2 System requirements................................................................. 5
3 Getting Ready............................................................................ 6
4 Installing the software and camera driver .................................. 7
4-1 Installing the software ................................................................ 7
4-2 Connecting the camera and selecting the camera driver ........ 14
5 Starting and activating your software ...................................... 15
5-1 Starting the software................................................................ 15
5-2 Activating the software ............................................................ 15
6 Configuring the software.......................................................... 18
7 Acquiring your first images ...................................................... 21
8 Refreshing the software installation......................................... 23
9 Updating the software.............................................................. 25
10 Uninstalling the software ......................................................... 27
11 Any questions or problems? .................................................... 30

3
The OLYMPUS Stream documentation

1 The OLYMPUS Stream documentation

Documentation for the OLYMPUS Stream software is made up of several parts:

this installation manual, the online help, the user's manual and the database
manual.
In this installation manual, you can find the system requirements and learn
how to install and configure Stream.
In the user manual, you can find both an introduction to the product and an
explanation of the user interface. With the help of the extensive step-by-step
instructions, you can quickly learn the most important procedures for using
Stream. You can find the manual saved as a PDF file in the software's installa-
tion directory.
In the online help, you can find detailed help for all elements of your software.
An individual help topic is available for every command, every toolbar, every tool
window and every dialog box. Open help with the [Shift + F1] shortcut. Alter-
natively, if you have a dialog box open, you can click the question mark in its top
right corner.
New Stream users are advised to use the user manual to familiarize themselves
with the product and to use the online help for more detailed questions later.
The database manual applies to Stream database users and administrators. It
describes the work with databases and how databases are set up and
managed. You can find the manual saved as a PDF file in the software's instal-
lation directory. The database manual is currently available in English, German
and French. If you install Stream in another language, the English PDF file is
installed.

4
 System requirements

2 System requirements

The following system requirements are necessary to run OLYMPUS Stream:

CPU Intel CoreTM Duo 1.6 GHz or better

Operating system Microsoft® Windows® 7 Ultimate/Professional (32 Bit / 64 Bit)
or
Microsoft® Windows® XP Professional (32 Bit) SP3 or
Microsoft® Windows® Vista Ultimate (32 Bit) SP2
RAM 2 GB (minimum)
4 GB (recommended)
Free storage space For installing Stream, 1 GB free storage space is necessary.
on your hard disk If the PC where Stream is installed is also intended to be
used for storing the data created by Stream, you will need a
correspondingly larger hard disk.
Monitor resolution 1280x1024 with a 32 bit graphics card, 256 MB RAM or better
Ports DVD drive
USB port for the software protection dongle
USB2-ICH7 port or FireWire (IEEE1394) port for your camera
COM interface (RS232) for motorized microscopes, stages,
objective encoders, zoom encoders
Software for working In addition to Stream, for working with reports, MS-Word and
with reports MS-Excel are required for displaying and editing reports. This
is why you need Microsoft Office 2010 (32 Bit), 2007 or 2003.

For the software package OLYMPUS Stream Start, you don't

need Microsoft Office because report generation is not
included.
Web browser Microsoft Internet Explorer 6.0 or higher
Database manage- For the OLYMPUS Stream Motion software package:
ment system
Microsoft SQL Server 2008 Express or
Microsoft SQL Server 2005 Express (is part of the OLYMPUS
Stream setup)
In addition, the OLYMPUS Stream Enterprise software
package supports the following database management
systems:
Microsoft SQL Server 2005 / 2008 (Standard/Workgroup/
Enterprise Edition) or
Oracle 11g R2, Oracle 10g, Oracle XE

5
Getting Ready

3 Getting Ready

1) When you are using the Windows Vista operating system, an error may
occur if the PC goes into hibernation mode during Stream startup. Please
make sure hibernation mode is switched off for your PC.
2) The image data may be damaged unexpectedly. Please backup the data
regularly.
3) If the PC is carried with the software protection dongle inserted, the PC or
the dongle may become damaged. Please remove the software protection
dongle when you carry the PC.
4) Please note: if the camera cable is unplugged while the live image is dis-
played, the live image stops. It remains stopped even after the camera
cable has been plugged in again. Therefore, restart Stream and start the
live image again.
5) Stream cannot simultaneously be started twice.
6) Make sure your PC won't start a virus scan process during a time lapse
acquisition. The PC performance may be deteriorated due to the virus scan
so that images cannot be acquired with sufficient accuracy.
7) Before installing the software, read the installation manual of each device
that is to be controlled. Also refer to the corresponding device manuals for
any information on how to operate the connected devices, for example,
microscopes.

6
 Installing the software and camera driver

4 Installing the software and camera driver

Install Stream before you connect your camera with the PC.

To install your software, log on to your PC as administrator.

This section describes the installation process using Windows Vista. When
using Windows 7 or XP, the process is almost the same.

4-1 Installing the software

1) Close any and all running application programs.

2) Insert the software protection key (dongle) into one of your PC's USB ports.

 The Found New Hardware dialog box opens. The operating system
then tries to install a driver for the dongle.
3) Click the Cancel button here. The correct dongle driver is automatically
installed during software installation.
 The dialog box closes.
4) Place the DVD that has been supplied in your DVD drive.
 The installation program starts automatically. You only need to double-
click the setup.exe file if your computer's autorun function has been
deactivated.

7
Installing the software

 An installation wizard guides you through the entire software installa-

tion. Follow the instructions of the installation wizard, provide the
requested information, then click the Next > button to continue.
In the following, only some of the installation wizard's dialog boxes are
shown.

5) Read the license agreement carefully. If you agree, select the Yes,...
option and click the Next > button.
6) Follow the instructions until the Image Source Selection dialog box opens.
This dialog box shows a list with all cameras supported by your Stream
software package. Select the manufacturer on the left side, then select the

8
 Installing the software

check box next to the camera you want to use with Stream from the list on
the right side. It is possible to select several cameras.

 If you select a DP21 or DP26 camera, the default IEEE1394 device

driver is replaced by an OLYMPUS-specific IEEE1394 device driver.
Because of this, at this computer, you can only use other devices which
require the standard IEEE1394 device driver if you install another
IEEE1394 board.
7) Click the Next > button and follow the instructions in the installation wizard.
If you install either the OLYMPUS Stream Enterprise or the OLYMPUS
Stream Motion software package, the Database dialog box opens. Decide
here whether or not you want to install your own database management
system (see below). If you install a different OLYMPUS Stream software
package, you don't see steps 7 and 8.

• Select the Use database server in the local area network option if no
database management system should be installed on this PC. This
option may be useful if another PC is defined as the database server and
all databases are to be set up in the network. Also, this option is used
when a database management system is already installed on the PC.

9
Installing the software

• Select the Install local database server option if a database management

system should be installed on this PC. This means that you can set up
databases on your PC locally at a later date.

 If you select the Install local database server option, the setup process
for the database management system is added to the current Stream
installation. The installation then takes much longer.
The installation wizard displays two more dialog boxes: Configure
SQLServer 2005 Express and Setup Process, as shown below.
Choose a system administrator password with at least 8 characters.
In addition to text, it must include at least one number and one special
character (or, upper and lower case letters). Don't forget to take note of
the password!

10
Installing the software

11
Installing the software

8) If you install either the OLYMPUS Stream Enterprise or the OLYMPUS

Stream Motion software package, another Database dialog box opens.
Select here whether or not you want to define a standard database.

 The database you select here automatically opens each time you start
Stream from now on.
9) Click the Next > button and follow the instructions in the installation wizard.
 If you haven't installed a database server, you see this dialog box at the
end of installation:

12
 Installing the software

 If you installed the "Microsoft SQL Server 2005 Express" database

management system, you need to restart your PC. Because of this, the
dialog box looks different.

10) Click the Finish button.

 The software installation is now finished. Before starting Stream,
connect the camera to the PC (see the next section).

13
Connecting the camera and selecting the camera driver

4-2 Connecting the camera and selecting the camera driver

1) You may now connect your camera to your PC. With a FireWire camera,
plug one end of the FireWire cable into the jack of the camera connected
to the microscope. Plug the other end into a port on the FireWire board of
your PC or laptop.
 The camera is now connected to your computer. The camera driver
which was installed together with the software is used.
 Further information about connecting your camera can be found in your
camera manual.

Installing your camera driver retroactively

If the Found New Hardware Wizard dialog box opens when you
connect your camera to your PC, then the required camera driver was
not found. You can now install it retroactively. Do the following:
1) Answer the question Can Windows connect to Windows Update to search
for software? with No, not this time and click the Next > button.
2) In the next dialog box, select the Install from a list or specific location
(Advanced) and click the Next > button.
3) In the next dialog box, select the Don't search. I will choose the driver to
install. and click the Next > button.
 The next dialog box shows the correct camera driver.
4) Select the camera driver and click the Next > button.
 A MS-Windows warning message may pop up.
The information given in this dialog box is not important for the installa-
tion. Thus, click the Continue Anyway button.
5) Follow the instructions in the Found New Hardware Wizard software
wizard.
6) In the last dialog box, click the Finish button.
 The correct camera driver was correctly installed.

14
 Starting and activating your software

5 Starting and activating your software

5-1 Starting the software

1) To start the software, doubleclick on the Stream icon located on the MS-
Windows desktop.

2) The first time that you start Stream, you are asked to activate, configure
and calibrate Stream.
 You can find more information about this in the next sections.

5-2 Activating the software

In order to use the full functionality of Stream, you need to activate the software
within 30 days of installation. If this term runs out without activation, all functions
are made inactive. Until you complete the activation, you are prompted to do so
every day during this term.
If the PC where Stream is installed has an Internet connection, the activation
can be done from this PC.
If the PC where Stream is installed has no Internet connection, you can select
whether to receive the activation key via telephone or from another PC which
has an Internet connection. In each case, follow the instructions in the Activate
Product dialog box.
If the PC where Stream is installed has an Internet connection, the following
steps describe what to do.

15
Activating the software

1) When you start the software, you see this dialog box:

2) Click the Next > button.

 You see the following dialog box:

3) Click the Print Personal Copy... button if you want to see the information
which is sent to the activation server.

16
 Activating the software

4) Click the Activate button to process the activation.

 The connection to the activation server is acquired. If the activation was
successful, you see the following dialog box:

5) Click the Close button.

 Your software is now activated. You can see the activation key when
you open the Help > About menu.

17
Configuring the software

6 Configuring the software

You can only configure the system if you are logged on to the software
with the user rights Administrator or Power User. If you have installed
Stream yourself, you automatically have administrator rights.

After installing the software, you need to configure your system. Stream needs
this information in order to correctly control components, such as the motorized
components of the microscope, for example.

Preconditions for the configuration of motorized microscopes as well as

objective and zoom encoders
• The microscope needs to be connected with the PC which Stream runs
on. Where the GX or BX microscopes are concerned, you connect the
UCB control box to your PC with an RS232 cable.
• The microscope control box must be switched on.
• The interfaces between the microscope (or other motorized
components) and the computer which Stream runs on must be correctly
configured.
• The objective or zoom encoder must be connected to the corresponding
control unit. The control unit must be connected to the PC with a RS232
cable and switched on.

18
 Configuring the software

Specifying which hardware is available

When starting the software for the first time, the Device List dialog box opens
automatically. If you closed it, you can reopen it with the Acquire > Device List
command. In this dialog box, select the hardware that you use.

 Which entries are shown in this dialog box depends on the hardware
components selected during the software installation. That is why your
Device List dialog box may look different to the image here.
 You can find detailed information on this dialog box in the online help.

Configuring the specified hardware

After choosing all necessary entries and confirming the selection with OK, the
Device Settings dialog box is shown.
In this dialog box, you can make further specifications about the hardware that
is used. First, specify which objectives can be found at which position on the
nosepiece.
Only the objectives that you specified here can be selected or, if they are motor-
ized, controlled when acquiring an image in your software.
Your software needs to know which objective is used during image acquisition
in order to calibrate the images correctly.

19
Configuring the software

 You can find detailed information on this dialog box in the online help.
Calibrating the system
Your software offers a calibration wizard to execute several calibration
processes. You can only work optimally with the system when all of the calibra-
tion processes have been performed.
Click the Calibrations... button in the Device Settings dialog box to start the cali-
bration wizard. If you don't want to calibrate the system right now but at a later
time, use the Acquire > Calibrations... command.

 Which calibration processes are available depends on the hardware

components that were selected during the software installation. That is
why your Calibrations dialog box may look different to the image here.

20
 Acquiring your first images

7 Acquiring your first images

After configuring and calibrating your software, you can acquire images. Do the
following:
1) Switch to the "Acquisition" layout. To do this, you can use the View >
Layout > Acquisition command.
2) On the Microscope Control toolbar, click the button with the objective that
you use for the image acquisition. The information about which objective
has been used is necessary for the correct image calibration.

 If you're working with a motorized microscope, the objective you've

chosen is automatically brought into the light path.
3) If you're working with a manual microscope, rotate the objective manually
into the light path.
 Note: When working with manual microscopes, it can be a good idea to
display the Image Calibration dialog box after each image acquisition.
To enable this function, select the Confirm magnification after acquisi-
tion check box in the Acquisition Settings dialog box.
In the Image Calibration dialog box, you can then confirm or change the
objective magnification you used. This ensures that the image is
properly calibrated. You can find detailed information on this function in
the online help.
4) Click the Live button in the Camera Control tool window.

 The live image is displayed.

5) Go to the required sample position in the live-image. To do so, move the
stage (either manually or by using the Stage Navigator tool window).
6) Bring the sample into focus (either manually or by using the Microscope
Control tool window).

21
Acquiring your first images

7) Check the color reproduction. If necessary, carry out a white balance. To

do so, click the White Balance on ROI button.
You can find this button on the Camera Control tool window's toolbar.

8) Check the exposure time. You can either automatically determine the
exposure time or enter the time manually.

9) Select the resolution you want, in the Resolution group.

10) In the Camera Control tool window, click the Snap button.
 The acquired image is shown in the document group.
 If a database is open and you haven't changed the default settings, the
Insert Image dialog box opens. Databases can only be opened with the
OLYMPUS Stream Enterprise and Motion software packages.
11) If you don't have an open database, use the File > Save As... command to
save the image. Use the recommended TIF file format.

22
 Refreshing the software installation

8 Refreshing the software installation

You can refresh your current software installation at any time. As opposed to a
software update (see next section), refreshing doesn't change the software
version. Because of this, you don't need a new software protection dongle and
you also don't need to activate the software again.

Refreshing the software installation can be necessary in the following

examples:
• You want to install a new camera driver.
• You want to install an example database.
• You need a local database server and want to install the Microsoft SQL
Server 2005 Express database management system.
When you refresh the software, your system configuration is not changed. So,
your settings in the Device List and Device Settings dialog boxes stay
unchanged.
Do the following in order to refresh your software installation:
1) Make sure that the software protection dongle is plugged in.
2) Place the DVD that has been supplied in your DVD drive.
 The installation program starts.
 The Welcome dialog box appears.
3) Select the Custom update option in order to be able to choose further
components.

Select the Automatic update option, if you don't want to change the selec-
tion of components made in the previous installation. This option is useful
for repairing a file in your software installation.

23
Refreshing the software installation

4) Click the Next > button to continue.

 If you select the Custom update option, you now see some dialog
boxes in which you can select additional components.
5) In the last dialog box, click the Finish button.
 You have now finished refreshing the software.
6) If you have chosen new hardware, start Stream and update the Device List
and Device Settings dialog boxes. In this case, you also need to carry out
individual calibrations again.

24
 Updating the software

9 Updating the software

Updating your software to a newer version is a similar procedure to refreshing

your software.
However, when you update the software, there are the following differences as
opposed to refreshing a previous software version:
• You require an updated software protection dongle.
• You require a DVD with the new software version.
• After completing the software update, you need to activate the software
again. To do so, you receive a new activation key.
When updating the software, your system configuration also remains
untouched. So, your settings in the Device List and Device Settings dialog
boxes stay unchanged.
Do the following in order to update your software:
1) Start Stream and select the Help > About menu command. Make a note of
the build number as shown in the About dialog box.
2) Make sure that the updated software protection dongle is plugged in.
3) Place the DVD that has been supplied in your DVD drive.
 The installation program starts.
 The Welcome dialog box appears.
4) Select the Custom update option in order to be able to choose further
components.

Select the Automatic update option if you don't want to change the
selection of components from the previous installation.

25
Updating the software

5) Click the Next > button to continue.

 If you select the Custom update option, you now see some dialog
boxes in which you can select additional components.
6) In the last dialog box, click the Finish button.
 The software update is now finished.
7) Start Stream and select the Help > About menu command. Check in the
About dialog box whether the new build number is displayed.
8) If you have chosen new hardware, update the Device List and Device
Settings dialog boxes. In this case, you also need to carry out individual
calibrations.

26
 Uninstalling the software

10 Uninstalling the software

There are two ways to uninstall the software: from the MS-Windows control
panel or with the Stream installation wizard (using the Remove option). Both
procedures lead to the same result. In the following description, the uninstall
process is started from the control panel.

What is uninstalled?
Only the Stream software is uninstalled. If you installed the Microsoft SQL
Server 2005 Express database management system, this installation remains
on your PC.
The Microsoft SQL Server 2005 Express database management
system can only be removed by using the control panel. Afterwards,
your Stream databases can no longer be opened. So, firstly make
absolutely sure that you will either never need the databases again or
have made a complete backup of all databases. Only then should you
remove the Microsoft SQL Server 2005 Express database
management system!

Starting the uninstallation

To uninstall Stream, log on to your PC as administrator.

This section describes the uninstallation process using Windows Vista. When
using Windows 7 or XP, the Stream uninstall process is almost the same. Only
the Control Panel dialog box, which is a part of MS-Windows, may look different.
1) Close your software.
2) Click the Start button.
 You can find this button at the bottom left of the task bar.
3) Select the Control Panel entry from the start menu.

27
Uninstalling the software

4) In the dialog box shown, select the Uninstall a program entry.

5) Select Stream... from the list and click the Uninstall button.

6) You are asked whether you really want to uninstall Stream. Answer the
question with Yes.
 The uninstallation begins.
7) You'll be asked whether you want to save Stream's user specific settings.
Click the Yes button, if you want to retain the user specific settings.
Click the No button, if you want to delete the user specific settings, too.
8) In the next dialog box, click the Finish button.
 The uninstallation of Stream is completed.

28
 Uninstalling the software

 If you selected a DP21 or DP26 camera during the Stream installation,

the default EEE1394 device driver has been replaced by an OLYM-
PUS-specific IEEE1394 device driver. Please note that the default
IEEE1394 device driver doesn't automatically become active again
after the Stream uninstallation. You need to manually refresh the driver
in the Device Manager > Imaging Devices dialog box.

29
Any questions or problems?

11 Any questions or problems?

If you have any questions or any problems you’re having difficulty solving on
your own - even after consulting the relevant documentation - then contact our
customer service, preferably by e-mail. Our customer support team is happy to
help you.
1) Start Stream.
2) Try and specify when and under what exact conditions the problem occurs.
 Ideally, you should try to be able to reproduce the problem/error.
3) Make screenshots of any relevant messages which appear on your screen.
 To make a screenshot of the active dialog box, use the keyboard short-
cut [Alt + Print]. This copies the dialog box to the MS-Windows clip-
board. Then you can easily include the copied dialog box in an e-mail,
by pressing [Ctrl + V].
4) Use the Help > About command to open the About dialog box.
 The About dialog box shows you what software package you have, the
build number and the serial number of your version, as well as the
operating system being used. Please be sure to have all this informa-
tion available when you contact our customer service.
5) Using the Help > About > More System Information> Save Customer
Support Information As... command, create the SysInfo.zip file and save it
somewhere on your PC.
 This ZIP file contains further information about your software
installation.
6) Write an e-mail containing this information:
• Exact problem description (with screenshots attached)
• The information from the Help dialog box
• Your address and telephone number
7) Attach the SysInfo.zip file to your e-mail.
8) Send the e-mail to our customer service address:

[email protected]

30
Any questions or problems?

31
 OLYMPUS SOFT IMAGING SOLUTIONS GMBH
Johann-Krane-Weg 39, 48149 Münster, Germany
Phone: +49 (251) 7 98 00-0, Fax: +49 (251) 7 98 00-6060, [email protected]