USER'S MANUAL

PIXCI® D
Revision 5

7 March 2000

For use with:
PIXCI® D Rev. 1.0 thru 3.0



Copyright © 2000 EPIX, Inc.
No part of this document may be reproduced, transmitted, photocopied, or translated into another language without the written consent of EPIX, Inc. Information in this document is subject to change without obligation or notice. EPIX, Inc. makes no warranty of any kind with regard to this document, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. EPIX, Inc. assumes no responsibility for any errors that may appear in this document. EPIX, Inc. reserves the right to make changes to the specifications of hardware and software at any time, without obligation or notice.

4MIP, SVIP, XCIP, XCAP, 4MEG VIDEO, 1MEG VIDEO, SILICON VIDEO MUX, QUICK SET VIDEO, 12-7MUX, IMAGE MEMORY EXPANSION, COC40, and COC402 are trademarks of EPIX, Inc.

EPIX, SILICON VIDEO, and PIXCI are registered trademarks of EPIX, Inc.

Other brand, product, and company names are trademarks or registered trademarks of their respective owners.

Printing: 8-Mar-2000

Table of Contents


1. Installation

Thank you for purchasing imaging products from EPIX, Inc. We expect them to perform to their specifications and we are available on the Internet, FAX, and telephone to help with installation or to answer questions about the use of our products for your application.

The PIXCI® D, D24, or D32 imaging board, for the PCI bus, is packed in a static dissipative bag. Please keep the bag and box in which the board was shipped should the need arise to return the board. Prior to opening the bag, place the bag near the PC into which the board will be installed.

The board may be installed prior to the XCAP software, or the software may be installed first.

    Turn off the power and remove the cover from the PC (if one is used with the PC) into which the PIXCI imaging board is to be installed.
  1. Select a vacant PCI bus slot and remove the metal bracket and screw covering the back panel slot with which it is aligned. Consult the reference manual for the PC if there is any doubt about which slot is a PCI bus slot.
  2. Use of a static free area and a wrist strap connected to the PC or to the static free area is suggested during installation. Walking can generate static electricity. Keep your feet stationary while removing the PIXCI imaging board from the anti-static bag. Hold the bag and the PC at the same time, or place the bag on the PC chassis and hold the chassis to dissipate the static charge that may have been created while transporting the board to the PC.
  3. Remove the PIXCI imaging board from the anti-static bag and insert it into the PCI bus connector. This can require up to 15 pounds of force. Do not use too much force as the board may not be inserted into the connector correctly, and the result can be damage to the connector and the board. Consult the reference manual for the PC if there is any doubt about which slot is a PCI bus slot. Note that some PCI bus slots may require a 3.3 volt compatible board. As of the date of this manual, the PIXCI D32 is only available for 5 volt PCI slots. Do not attempt to install the board in a 3.3 volt slot or in an AGP slot.
  4. Replace the screw to secure the PIXCI imaging board in the slot.

1.1. Cabling Connections

Refer to the ''Connections'' chapter for a signal list and drawing of the cable connections between the PIXCI and the Dalsa camera(s).

  1. Remove the power from all equipment to be connected.
  2. Following the cabling figure in the ''Connections'' chapter, connect the cable between the PIXCI, camera, and power supply. The PIXCI end of the cable has a 68 pin SCSI style miniature D connector. Do not plug it into a SCSI card. Connect the other end of the cable into the respective camera connectors.
  3. Power up the camera, PC, and monitor(s).
  4. On boot-up, if Windows asks for a driver for the newly installed hardware:
    1. If XCAP software is provided on compact disk (CD), then insert the CD into the CD drive. Indicate that Windows is to use:
          d:\drivers\win95    (for Win 95/98)
          d:\drivers\winNT    (for Win NT)
          d:\drivers\win2K    (for Win 2000)
      or
          d:\drivers          (older cd's, all Win versions)
      
      replacing ''d:'' with the CD drive's letter.
    2. If XCAP software is provided on diskette, then insert XCAP diskette #1 into the diskette drive. Indicate that Windows is to use:
          a:\drivers\win95    (for Win 95/98)
          a:\drivers\winNT    (for Win NT)
          a:\drivers\win2K    (for Win 2000)
      or
          a:\                 (older diskettes, all Win versions)
      
      replacing ''a:'' with the diskette drive's letter.
  5. Install XCAP software by following the instructions in the XCAP Software Installation chapter in this manual.
  6. Operate XCAP by following the instructions in in the XCAP Software Guide chapter in this manual.
  7. Check for display of the video source on the VGA monitor by clicking on the Capture and then the Snap menu in the View window or by using the shortcut menu.
  8. Note that for line scan cameras, either an external vertical drive signal or the ''Internal'' vertical drive selection must be used.
  9. If it is not possible to display an image from the video source, check for the presence of vertical drive by clicking on ''PIXCI,'' ''PIXCI Status,'' and ''PIXCI-Unit x Status'' (where x is the number of the board being used). The number reported in the ''Vertical Sync Count'' box should be increasing if vertical drive is being received from the camera. If it is not increasing, check the connections and power to the camera. If that fails, refer to the ''In Case of Trouble'' chapter in this manual.
  10. If installation has been successful, remove power from the computer.
  11. Replace the PC's cover (if one is used).
  12. End of installation procedure.

The size and the number of images that can be stored in DRAM on the motherboard is a function of the amount of DRAM that is not needed by the operating system. Windows 98 requires approximately 20 megabytes. XCAP reserves 4 MB of memory for image buffers. If more memory is required for image sequences, the ''Driver Assistant'' in the ''PIXCI Open/Close'' menu should be used to set the reserved memory size.

The PIXCI imaging board can capture and store full resolution images to DRAM on a burst mode PCI motherboard provided that other devices do not compete for PCI bus bandwidth. The data transfer capabilities of the motherboard may limit the size of the image that the PIXCI imaging board can transfer to memory on the motherboard. Some PCI motherboards do not support burst mode on the PCI bus. Some PCI motherboards limit bursts to four 32 bit transfers. Some PCI motherboards must have their configuration EEPROM set to enable PCI bus burst mode. PCI bus transfers from other devices will compete for data transfer time with images to be transferred from the PIXCI imaging board to memory on the motherboard. ISA bus transfers will also compete for data transfer time with images to be transferred from the PIXCI imaging board to memory on the motherboard. The updating of clocks and other background tasks may interfere with the capture of images. These tasks should be disabled if error messages indicate that video transfers have been interrupted.

1.2. Compatible Motherboards - Partial List

The following configurations have been tested with video sources with 100 MB per second burst modes. Contact EPIX, Inc. or an EPIX, Inc. distributor for pricing on any of the motherboards listed below.

Motherboards with a 100 MHz CPU bus are recommended. For fast display updates, EPIX recommends motherboards with an Advanced Graphics Port (AGP) and an AGP VGA. An AGP VGA can provide at least twice the video update rate that a PCI VGA can provide. EPIX can provide complete, tested computer systems with a PIXCI and all required software installed as well as tested AGP VGA boards and motherboards.

Manufacturer Model Chipset Clock & CPU

Intel SE440BX Intel 440BX 667 MHz Pentium II w/AGP

Intel NE440BX Intel 440BX 350 MHz Pentium II w/AGP

Intel AL440LX Intel 440LX 266 MHz Pentium II w/AGP

Intel PD440FX Intel 440FX 233 MHz Pentium II

Intel TC430HX Intel 430HX 200 MHz Pentium MMX

QDI Titanium II B Intel 430TX 200 MHz Pentium MMX

QDI Titanium II B Intel 430TX 233 MHz AMD K6

1.3. Non-Compatible Motherboards - Partial List

The following configuration(s) have been tested with the Hitachi KP-F110 camera and intermittently do not keep up with a transfer rate sufficient to prevent buffer overflow, which means lost data. There are many other PCI bus motherboards that will NOT operate successfully. Use one of the motherboards from the list above or purchase one from EPIX, Inc.

Manufacturer Model Chipset Clock & CPU

Intel VS440FX Intel 440FX 200 MHz Pentium Pro

1.4. VGA Boards


2. Connectors

The PIXCI D imaging board has a 68 pin connector which is accessible thru the bracket that mounts the board to the computer chassis. Single ended cables are available for connecting to a camera or other source of digital video. A wire list for the single ended cable is shown below.

2.1. PIXCI D 68 Pin Connector and Single Ended Cable Signal List Part 1

PAIR Interface Signal Interface
No. 68 pin Name Signal
and MALE Type
COLOR Pin No.

34:Orange/Violet 1 GND GND

34:Violet/Orange 35 GND GND

17:Tan/Gray 2 MSBA+ RS422 Input

17:Gray/Tan 36 MSBA- RS422 Input

18:Brown/Pink 3 MSBA-1+ RS422 Input

18:Pink/Brown 37 MSBA-1- RS422 Input

33:Orange/Blue 4 MSBA-2+ RS422 Input

33:Blue/Orange 38 MSBA-2- RS422 Input

19:Brown/Orange 5 MSBA-3+ RS422 Input

19:Orange/Brown 39 MSBA-3- RS422 Input

16:Tan/Violet 6 MSBA-4+ RS422 Input

16:Violet/Tan 40 MSBA-4- RS422 Input

6:White/Green 7 MSBA-5+ RS422 Input

6:Green/White 41 MSBA-5- RS422 Input

7:White/Blue 8 MSBA-6+ RS422 Input

7:Blue/White 42 MSBA-6- RS422 Input

32:Orange/Green 9 MSBA-7+ RS422 Input

32:Green/Orange 43 MSBA-7- RS422 Input

20:Brown/Yellow 10 MSBB+ RS422 Input

20:Yellow/Brown 44 MSBB- RS422 Input

1:White/Tan 11 MSBB-1+ RS422 Input

1:Tan/White 45 MSBB-1- RS422 Input

15:Tan/Blue 12 GND GND

15:Blue/Tan 46 GND GND

8:White/Violet 13 MSBB-2+ RS422 Input

8:Violet/White 47 MSBB-2- RS422 Input

31:Orange/Yellow 14 MSBB-3+ RS422 Input

31:Yellow/Orange 48 MSBB-3- RS422 Input

21:Brown/Green 15 MSBB-4+ RS422 Input

21:Green/Brown 49 MSBB-4- RS422 Input

5:White/Yellow 16 MSBB-5+ RS422 Input

5:Yellow/White 50 MSBB-5- RS422 Input

2:White/Brown 17 XXX NC

2:Brown/White 51 XXX NC

2.2. PIXCI D 68 Pin Connector and Single Ended Cable Signal List Part 2

PAIR Interface Signal Interface
No. 68 pin Name Signal
and MALE Type
COLOR Pin No.

14:Tan/Green 18 XXX NC

14:Green/Tan 52 XXX NC

9:White/Gray 19 MSBB-6+ RS422 Input

9:Gray/White 53 MSBB-6- RS422 Input

30:Pink/Gray 20 MSBB-7+ RS422 Input

30:Gray/Pink 54 MSBB-7- RS422 Input

22:Brown/Blue 21 MSBA-8+ RS422 Input

22:Blue/Brown 55 MSBA-8- RS422 Input

4:White/Orange 22 SCOUT+ RS422 Input

4:Orange/White 56 SCOUT- RS422 Input

3:White/Pink 23 SCIN+ RS422 Output

3:Pink/White 57 SCIN- RS422 Output

13:Tan/Yellow 24 FLD+ RS422 Input

13:Yellow/Tan 58 FLD- RS422 Input

10:Tan/Brown 25 FENA+ RS422 Input

10:Brown/Tan 59 FENA- RS422 Input

29:Pink/Violet 26 LENA+ RS422 Input

29:Violet/Pink 60 LENA- RS422 Input

23:Brown/Violet 27 TRG+ RS422 Input

23:Violet/Brown 61 TRG- RS422 Input

12:Tan/Orange 28 STR+ RS422 Output

12:Orange/Tan 62 STR- RS422 Output

11:Tan/Pink 29 PCLK+ RS422 Input

11:Pink/Tan 63 PCLK- RS422 Input

28:Pink/Blue 30 EXP+ RS422 Output

28:Blue/Pink 64 EXP- RS422 Output

24:Brown/Gray 31 MSBA-9+ RS422 Input

24:Gray/Brown 65 MSBA-9- RS422 Input

27:Pink/Green 32 MSBB-8+ RS422 Input

27:Green/Pink 66 MSBB-8- RS422 Input

26:Pink/Yellow 33 MSBB-9+ RS422 Input

26:Yellow/Pink 67 MSBB-9- RS422 Input

25:Pink/Orange 34 GND GND

25:Orange/Pink 68 GND GND

SHIELD 68 GND

    NOTES:
  1. Use cable: 34 pair, MADISON 28 AWG 105 Ohm SCSI-P Cable Type CL2/FT1. Length: 2 meters.

    CONNECTOR:
  1. 68 pin cable receptacle: HONDA PCS-XE68MA and Cover

2.3. PIXCI D 10 Pin Header Signal List

Signal IN/ Pin Pin IN/ Signal
Name OUT Number Number OUT Name

Ground 1 2 Option +5 VDC

External I 3 4 I External
Trigger Trigger
In In

Frame- I 5 6 I Frame+
Differential Differential
FEN- FEN+

Strobe- O 7 8 O Strobe+
Differential Differential
STR- STR+

Reserved - 9 10 - Reserved

See the Trigger and Camera Integration Register Programming section of this manual in the Camera Control Register chapter for more information on these signals.

Pin 1 is connected to Ground.

Pin 2 is optional +5 volts to the PCI bus. Pin 2 was changed to an option to prevent destruction of components when the 10 pin header is installed incorrectly.

Pins 3 & 4 are the differential inputs for the trigger signal. These inputs are connected to pin 61 and 27 of J2, the 68 pin connector.

Pins 5 & 6 are the differential inputs for the framer enable (vertical) signal. These inputs are connected to pin 59 and 25 of J2, the 68 pin connector.

A 10 pin header and cable to 9 pin D-Subminiature connector is available to connect external signals to the PIXCI D thru a second slot with a bracket mounting the D-Subminiature connector.


3. Software Installation

XCAP-Plus, XCAP-Std, or XCAP-Lite, are easy to install, by following the instructions below.

While XCAP is easy to install, like most manufacturers of PC software, we recommend as a precaution that a hard disk backup be performed before installing XCAP.

3.1. For Windows 95 - Windows 98

  1. Install Files:
    1. If XCAP is provided on diskette(s):
      1. Insert XCAP diskette #1 into the A: or B: drive.
      2. Execute the SETUP program, from a command prompt, or via the Windows ''Start'', ''Run'':
            > A:SETUP
        or
            > B:SETUP
        
      3. Follow the installation program's directions, such as to select an installation directory, and insert additional diskettes (depending upon version) as instructed.
    2. If XCAP is provided on a compact disk (CD):
      1. If your PC is set to allow automatic execution of loaded CDs, the CD's interactive index program will be executed automatically. Otherwise, execute the index program, from a command prompt, or via the Windows ''Start'', ''Run'':
            > Z:SETUP       (replace Z with drive letter for your CD)
        
      2. Select ''Setup PIXCI(R) Imaging Software'' and ''XCAP Imaging Application''. Click ''OK''.
      3. Follow the installation program's directions, such as to select an installation directory.
    3. If XCAP is provided via the internet:
      1. Download:
            ftp.epixinc.com/software/XCAPWI.EXE
        
        from the EPIX, Inc. ftp site.
      2. Execute the downloaded program, from a command prompt, or via the Windows ''Start'', ''Run'':
            > XCAPWI.EXE
        
      3. Follow the installation program's directions, such as to select an installation directory.
      4. Delete the downloaded .EXE file from your PC's hard drive.
    4. The installation procedure creates a new program group, containing XCAP and several .TXT files. The .TXT files contain these installation instructions, a list of distributed files, corrections or additions to this manual, or other up-to-date information. One file, PCITIPS.TXT, contains the PC Configuration Tips, which provides tips for resolving hardware and software conflicts.
  2. Create Shortcut - Drag & Drop (optional):
    1. From the program group created by the installation program, click and drag the icon for XCAP over to the desktop and drop.
  3. Create Shortcut - Manual (optional):
    1. Right click on the Desktop.[1]
    2. Select ''New''.
    3. Select ''Shortcut''.
    4. Set:
          Command Line:   InstallDir \ XCAPW95
          Name:           XCAP
      
      replacing ''InstallDir'' with the name of the installation directory chosen above. Select ''OK''.
  4. Install Authorization Key (for XCAP-Plus and XCAP-Std):
    1. XCAP-Plus and XCAP-Std, but not XCAP-Lite, are provided with an authorization key; about the size and shape of a printer cable's connector (5.5×4.5×1.6 cm), but having 25 pin connectors at both ends and no cable attached. If provided, connect the authorization key to printer port 1, 2, or 3. If a printer cable was attached to the printer port, reconnect the printer cable to the back of the authorization key. The authorization key will not affect normal printer operation.

      Do not connect the authorization key to a 25 pin serial (RS-232) port, or to any other interface which happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!

      The authorization key must remain attached to the printer port while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus or XCAP-Std will behave similar to the XCAP-Lite version; selected image processing and analysis tools will not be operational.

  5. Install PIXCI® Imaging Board Driver:
    1. If the PIXCI® imaging board's driver wasn't loaded when the PC was powered up (as described under Hardware Installation), instruct Windows to load the appropriate driver: Click ''Start'', ''Control Panel'', ''System'', ''Device Manager'', and ''Other Devices''. Select ''PCI MultiMedia Video Device'' (which appears if a PIXCI® board driver was never installed), or ''PIXCI(R) Video Capture Board'' (which appears if a PIXCI® board driver was previously installed). Click ''Driver'', ''Change Driver'', and ''Other''. Select ''PCI MultiMedia Video Device'' or ''PIXCI(R) Video Capture Board''. Click ''Have Disk'', select DRIVERS\WIN95 within the chosen installation directory, such as C:\XCAP\DRIVERS\WIN95, and click ''OK''.

      Note that the ''quick reboot'' offered by the (some versions of the) Device Manager does not properly install EPIXXC32.VXD; a full shutdown and reboot is required. The shutdown and reboot can be delayed until after the installation is completed.

  6. Set Frame Buffer Memory Size (optional):
    1. By default, 4 megabytes of frame buffer memory is allocated.
    2. Under Windows 95/98, frame buffer memory must be allocated during Windows' initialization, as specified in the Windows' SYSTEM.INI file. If additional frame buffer memory is desired, then at the end of the Windows' SYSTEM.INI file, add a section:
          [EPIX_XC]
          PIXCI=-IM <memorysize>
      
      replacing the ''<memorysize>'' with the desired memory size in Kbytes. Windows must be rebooted for the new specification to take effect.

      Windows 95/98 limits the maximum amount of allocatable frame buffer memory, dependent upon what other devices are installed, the total PC memory size, and other factors.

      Less than the requested amount of frame buffer memory may be allocated. If no memory could be allocated, the PIXCI® imaging board will not be usable; reporting ''Can't allocate frame buffer memory''. Otherwise, within XCAP, the amount of frame buffer memory can be checked under PIXCI®, PIXCI® Open/Close.

  7. Configure S/VGA:
    1. A ''High Color (16 bit or 65536 Color)'', ''True Color (24 bit or 16777216 Color)'', or ''True Color (32 bit)'' setting for the display adapter (S/VGA) is required for proper display of images and overlay graphics. The ''True Color (24 bit or 16777216 Color)'' or ''True Color (32 bit)'' is suggested for higher quality, and quicker, display of images and overlay graphics. This may be checked and/or modified via Windows ''Start'', ''Control Panel'', ''Display'', ''Settings''.
    2. In Windows 95, under ''Control Panel'', ''Display'', ''Plus!'', the ''Show window contents while dragging'' must be disabled (this feature is not present in older versions of Windows 95). Or in Windows 98, under ''Control Panel'', ''Display'', ''Effects'', the ''Show window contents while dragging'' must be disabled.
    3. After changing the settings a full shutdown and CTRL+ALT+DEL reboot should be used. The quick restart offered by older versions of Windows, and the dynamic VGA reconfiguration performed by newer versions of Windows, may not re-initialize all devices properly.
  8. Reboot Windows.
  9. XCAP is now ready to run, clicking ''Start'', ''Programs'', ''XCAP Imaging'', and finally ''XCAP for Win 95/98''.

3.2. Win 95 - Win 98 - Esoterica

3.2.1. Windows 95/98 - Manual Installation

Use of EPIXXC32.INF, above, provides automatic installation of EPIXXC32.VXD in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. The EPIXXC32.VXD must be copied to the Windows SYSTEM directory, typically:
        C:\WINDOWS\SYSTEM
    
  2. Using the Registry Editor (REGEDIT) provided with Windows, create an entry such as:
        HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\Class\Unknown\0000
    
    replacing the \0000, if such an entry already exists, with the next available sequential number. This entry must contain:
        DevLoader=      "epixxc32.vxd"
        DriverDesc=     "PIXCI(R) PCI Video Capture Board"   (optional)
        InfSection=     "Unknown"
        StaticVxD=      "epixxc32.vxd"
    
  3. Using the Registry Editor, edit the existing entry for PIXCI® SV2 or PIXCI® SV3:
    (Win 95)    HKEY_LOCAL_MACHINE\Enum\PCI\VEN_8086&DEV_1223\BUS_**&DEV_**&FUNC_**
    (Win 98)    HKEY_LOCAL_MACHINE\Enum\PCI\VEN_8086&DEV_1223&SUBSYS_00000000&REV_**\BUS_**&DEV_**&FUNC_**
    
    or the existing entry for PIXCI® SV4:
    (Win 95)    HKEY_LOCAL_MACHINE\Enum\PCI\VEN_109E&DEV_0350\BUS_**&DEV_**&FUNC_**
    (Win 98)    HKEY_LOCAL_MACHINE\Enum\PCI\VEN_109E&DEV_0350&SUBSYS_00000000&REV_**\BUS_**&DEV_**&FUNC_**
    
    or the existing entry for PIXCI® D, PIXCI® D24, or PIXCI® D32:
    (Win 95)    HKEY_LOCAL_MACHINE\Enum\PCI\VEN_10E8&DEV_80D6\BUS_**&DEV_**&FUNC_**
    (Win 98)    HKEY_LOCAL_MACHINE\Enum\PCI\VEN_10E8&DEV_80D6&SUBSYS_00000000&REV_**\BUS_**&DEV_**&FUNC_**
    
    or the existing entry for PIXCI® A:
    (Win 95)    HKEY_LOCAL_MACHINE\Enum\PCI\VEN_10E8&DEV_82B1\BUS_**&DEV_**&FUNC_**
    (Win 98)    HKEY_LOCAL_MACHINE\Enum\PCI\VEN_10E8&DEV_82B1&SUBSYS_00000000&REV_**\BUS_**&DEV_**&FUNC_**
    
    where the **'s may be any digits (assigned and created by Windows after detection of the PIXCI® imaging board). This entry must contain:
        Class=          "Unknown"
        ConfigFlags=    00 00 00 00
        DeviceDesc=     "PIXCI(R) PCI Video Capture Board"   (optional)
        Driver=         "Unknown\0000"                       (substitute 0000)
        Mfg=            "EPIX, Inc."                          (optional)
    
    where the ''0000'' is replaced by the sequential number used in the previous step.
  4. Reboot Windows.

3.2.2. Windows 95/98 - Forcible Frame Buffer Memory Allocation

As described above, frame buffer memory allocated by EPIXXC32.VXD during Windows startup is limited to a small percentage of total PC memory.

A larger frame buffer memory can often be obtained by reserving memory before Windows starts:

  1. In C:\CONFIG.SYS[2], add a line:
        DEVICE=C:\XCAP\DRIVERS\WIN95\EPIXXC.SYS -IM <framebuffermemorysize>
    
    after DEVICE=HIMEM.SYS, replacing ''<framebuffermemorysize>'' with the desired frame buffer memory size, in Kbytes. Alternately, the second form reserves ''<reservememorysize>'' Kbytes, for Windows and allocates (almost) all of the remaining memory for use as frame buffer memory.
  2. Edit the Windows' SYSTEM.INI file, add a section:
        [EPIX_XC]
        PIXCI=-IM 0
    
    so that EPIXXC32.VXD doesn't reserve and waste additional frame buffer memory.
  3. Reboot Windows.

This technique allows most of the PC's memory to be reserved as frame buffer memory (e.g. typically all but 8 or 16 megabytes, as required by Windows). However, the memory is unavailable to Windows, even when the PIXCI® imaging board's driver is not open.

If the specified amount of frame buffer memory could not be allocated, EPIXXC.SYS will attempt to allocate smaller amounts. If no memory can be allocated EPIXXC.SYS, will display an error message during Windows startup, and XCAP will not run, stating ''Can't allocate frame buffer memory''.

3.2.3. Windows 95/98 - Authorization Key - Manual Installation

Use of the procedures above provides automatic installation of the authorization key's driver, needed under Windows 95/98, for XCAP-Plus and XCAP-Std (but not needed for XCAP-Lite). The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. The file HARDLOCK.VXD must be copied to the Windows SYSTEM directory, typically:
        C:\WINDOWS\SYSTEM
    
    or placed in the same directory as XCAP, typically:
        C:\XCAP
    
Normally, all LPT ports are scanned for the authorization key. Should other hardware use, or overlap, one of the LPT I/O port addresses, the search may be restricted to specific I/O ports. In AUTOEXEC.BAT, specifying:
    SET HL_SEARCH=378p
    SET HL_SEARCH=278p,378p
forces only the I/O port addresses listed (in hexadecimal) to be searched. Note that setting HL_SEARCH from a DOS box has no effect, as the setting is not ''carried back'' from DOS into the Win 95/98 environment.

3.3. For Windows NT

XCAP requires Win NT Version 4 with Service Pack 3 or later. You must be logged on an Administrator, or have equivalent privileges, to complete the installation procedure.

  1. Install Files:
    1. If XCAP is provided on diskette(s):
      1. Insert XCAP diskette #1 into the A: or B: drive.
      2. Execute the SETUP program, from a command prompt, or via the Windows ''Start'', ''Run'':
            > A:SETUP
        or
            > B:SETUP
        
      3. Follow the installation program's directions, such as to select an installation directory, and insert additional diskettes (depending upon version) as instructed.
    2. If XCAP is provided on a compact disk (CD):
      1. If your PC is set to allow automatic execution of loaded CDs, the CD's interactive index program will be executed automatically. Otherwise, execute the index program, from a command prompt, or via the Windows ''Start'', ''Run'':
            > Z:SETUP       (replace Z with drive letter for your CD)
        
      2. Select ''Setup PIXCI(R) Imaging Software'' and ''XCAP Imaging Application''. Click ''OK''.
      3. Follow the installation program's directions, such as to select an installation directory.
    3. If XCAP is provided via the internet:
      1. Download:
            ftp.epixinc.com/software/XCAPWI.EXE
        
        from the EPIX, Inc. ftp site.
      2. Execute the downloaded program, from a command prompt, or via the Windows ''Start'', ''Run'':
            > XCAPWI.EXE
        
      3. Follow the installation program's directions, such as to select an installation directory.
      4. Delete the downloaded .EXE file from your PC's hard drive.
    4. The installation procedure creates a new program group, containing XCAP and several .TXT files. The .TXT files contain these installation instructions, a list of distributed files, corrections or additions to this manual, or other up-to-date information. One file, PCITIPS.TXT, contains the PC Configuration Tips, which provides tips for resolving hardware and software conflicts.
  2. Create Shortcut - Drag & Drop (optional):
    1. From the program group created by the installation program, click and drag the icon for XCAP over to the desktop and drop.
  3. Create Shortcut - Manual (optional):
    1. Right click on the Desktop.[3]
    2. Select ''New''.
    3. Select ''Shortcut''.
    4. Set:
          Command Line:   InstallDir \ XCAPWNT
          Name:           XCAP
      
      replacing ''InstallDir'' with the name of the installation directory chosen above. Select ''OK''.
  4. Install Authorization Key (for XCAP-Plus and XCAP-Std):
    1. XCAP-Plus and XCAP-Std, but not XCAP-Lite, are provided with an authorization key; about the size and shape of a printer cable's connector (5.5×4.5×1.6 cm), but having 25 pin connectors at both ends and no cable attached. If provided, connect the authorization key to printer port 1, 2, or 3. If a printer cable was attached to the printer port, reconnect the printer cable to the back of the authorization key. The authorization key will not affect normal printer operation.

      Do not connect the authorization key to a 25 pin serial (RS-232) port, or to any other interface which happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!

      The authorization key must remain attached to the printer port while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus or XCAP-Std will behave similar to the XCAP-Lite version; selected image processing and analysis tools will not be operational.

    2. Run the authorization key utility program provided with XCAP by ''Start'', ''Run'':
          > C:\XCAP \ HLDINST -install
      
    3. Or, in command prompt mode, switch to the chosen installation directory:
          > CHDIR C:\XCAP
      
      and execute:
           HLDINST  -install
      
      to run the authorization key utility program.
  5. Install PIXCI® Imaging Board Driver:
    1. If the PIXCI® imaging board's driver wasn't loaded when the PC was powered up (as described under Hardware Installation), instruct Windows to load the appropriate driver: Click ''Start'', ''Programs'', and ''Windows NT Explorer''. Within the chosen installation directory, such as C:\XCAP, find and highlight file DRIVERS\WINNT\EPIXXCNT.INF. From the menu bar, select ''File'' and ''Install''.
  6. Configure S/VGA:
    1. A ''High Color (16 bit or 65536 Color)'', ''True Color (24 bit or 16777216 Color)'', or ''True Color (32 bit)'' setting for the display adapter (S/VGA) is required for proper display of images and overlay graphics. The ''True Color (24 bit or 16777216 Color)'' or ''True Color (32 bit)'' is suggested for higher quality, and quicker, display of images and overlay graphics. This may be checked and/or modified via Windows ''Start'', ''Control Panel'', ''Display'', ''Settings''.
    2. In Windows 95, under ''Control Panel'', ''Display'', ''Plus!'', the ''Show window contents while dragging'' must be disabled (this feature is not present in older versions of Windows 95). Or in Windows 98, under ''Control Panel'', ''Display'', ''Effects'', the ''Show window contents while dragging'' must be disabled.
    3. After changing the settings a full shutdown and CTRL+ALT+DEL reboot should be used. The quick restart offered by older versions of Windows, and the dynamic VGA reconfiguration performed by newer versions of Windows, may not re-initialize all devices properly.
  7. Reboot Windows.
  8. XCAP is now ready to run, clicking ''Start'', ''Programs'', ''XCAP Imaging'', and finally ''XCAP for Win NT''.

3.4. Win NT Esoterica

3.4.1. Windows NT - Manual Installation

Use of EPIXXCNT.INF, above, provides automatic installation of EPIXXCNT.SYS in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. The EPIXXCNT.SYS must be copied to the Windows SYSTEM32\DRIVERS directory, typically:
        C:\WINNT\SYSTEM32\DRIVERS
    
  2. Using the Registry Editor (REGEDIT) provided with Windows, create an entry such as:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCNT
    
    This entry must contain:
        ErrorControl  =  0x00000001
        Group         =  "Extended base"
        Start         =  0x00000001
        Type          =  0x00000001
    
    and may, as described below, also contain:
        PIXCI         =  "-IM <memorysize>"
    
    Create an entry such as:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCNT
    
    This entry must contain:
        EventMessageFile = "%SystemRoot%\System32\IoLogMsg.dll"
        TypesSupported   = 0x00000007
    
  3. Shut down and restart Windows.

3.4.2. Windows NT - Frame Buffer Memory Allocation

Under Windows NT, frame buffer memory must be allocated during Windows' initialization.

The requested frame buffer memory size must be specified in the Registry entry described above, using an entry named ''PIXCI'', such as:

    PIXCI         =  "-IM <memorysize>"
replacing the ''<memorysize>'' with the desired memory size in Kbytes. If no frame buffer memory size is specified, a default size of 4 megabytes is used. Windows must be rebooted for the new specification to take effect.

Windows NT limits the maximum amount of allocatable frame buffer memory, dependent upon what other devices are installed, the total PC memory size, and other factors. Using the Control Panel's Device Manager to select Boot or System priority startup for EPIXXCNT.SYS allows more frame buffer memory to be allocated than selection of Automatic startup.

Less than the requested amount of frame buffer memory may be allocated. If no memory could be allocated, XCAP will not run, stating ''Can't allocate frame buffer memory''. Otherwise, within XCAP, the number of available frame buffers can be checked under PIXCI®, PIXCI® Video Setup, Resolution. As the frame buffer memory is allocated once during Windows initialization; the contents of frame buffers are retained as XCAP is closed and restarted, but lost if Windows is restarted.

3.4.3. Windows NT - Forcible Frame Buffer Memory Allocation

As described above, frame buffer memory allocated by EPIXXCNT.SYS during Windows startup may be limited to a small percentage of total PC memory.

A larger frame buffer memory can be obtained by limiting the amount of memory recognized by Windows NT, and then instructing EPIXXCNT.SYS to explicitly use a section of memory without allocating it from Windows NT:

  1. Edit C:\BOOT.INI, restricting Win NT to use no more than a set amount of memory: by copying an existing configuration line, adding /MAXMEM=XX (where XX is in Mbytes) and changing the prompt name, such as changing:
        [operating systems]
        multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows NT V 4.00"
    
    to
        [operating systems]
        multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows NT V 4.00 [NT=64M PIXCI=256M]"  /MAXMEM=64
        multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows NT V 4.00"
    
    Do not copy this new line exactly as is; the first portion of the line must be copied from an existing configuration line in your C:\BOOT.INI file. The text between quotes appears as a boot selection prompt, use of ''[NT=64M PIXCI=256M]'' is a suggested reminder, but not required. Keeping the original configuration line, as a boot selection option, is highly recommended as a backup.
  2. Edit the registry entry for EPIXXCNT.SYS:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCNT
    
    On the ''PIXCI'' field add:
        -IA <image_memory_adrs_in_kbyte>
        -IM <size_of_image_memory_in_kbyte>
        -MB 8192
    
    In practice, all three fields are on the same line. Be certain that the -IA address is equal to (or above) the specified /MAXMEM limit; INCLUDING exact base2 to base10 conversions! (i.e. for /MAXMEM=64, the smallest legal value of -IA is 65536, not 64000!). Likewise, be certain that the -IA plus -IM values do not exceed the amount of memory available!
  3. Reboot, using the newly added boot selection.

For example, for a PC with 1 gigabyte of memory, allocating 256 Mbyte for Windows and the remainder for frame buffer memory, use:

    /MAXMEM=256
in C:\BOOT.INI, and use:
    PIXCI = -IA 262144 -IM 786432 -MB 8192
in the registry entry. Note that 262144 is 256×1024, and 786432 is (1024-245)×1024.

Note that if this memory allocation method is used, program access to image data may be is slower. Thus, the video display rate (and image processing) may be slower, but the video capture rate (such as sequence capture) is not adversely affected. This method of memory allocation is primarily used for video rate acquisition of long sequences, followed by off-line analysis or saving of the sequence.

3.4.4. Windows NT - Authorization Key - Manual Installation

Use of HLDINST.EXE, above, provides automatic installation of the authorization key's driver, needed under Windows NT, for XCAP-Plus and XCAP-Std (but not needed for XCAP-Lite). The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. The file HARDLOCK.SYS must be copied to the Windows SYSTEM32\DRIVERS directory, typically:
        C:\WINNT\SYSTEM32\DRIVERS
    
  2. The file HLVDD.DLL must copied to the Windows SYSTEM directory, typically:
        C:\WINNT\SYSTEM
    
    or placed in the same directory as XCAP, typically:
        C:\XCAP
    
  3. Using the Registry Editor (REGEDIT) provided with Windows, create an entry such as:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock
    
    This key must contain values:
        ErrorControl  =  0x00000001
        Group         =  "Extended Base"
        Start         =  0x00000002
        Type          =  0x00000001
    
    or, if using REGEDT32, the values should appear as:
        ErrorControl:REG_DWORD:0x1
        Group:REG_SZ:ExtendedBase
        Start:REG_DWORD:0x2
        Type:REG_DWORD:0x1
    
  4. Shut down and restart Windows for the new registry entries to take effect.
  5. If the authorization key is connected to a non-standard printer port, an additional entry may be required:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock\Parameters
    
    which contains a value:
        IoPortAddress0  = 0x????            (for REGEDIT)
        IoPortAddress0:REG_DWORD:0x????     (for REGEDT32)
    
    where the ''????'' is replaced with the parallel port's I/O address in hexadecimal. As before, Windows must be shut down and restarted.

3.5. For Windows 2000

  1. Install Files:
    1. If XCAP is provided on diskette(s):
      1. Insert XCAP diskette #1 into the A: or B: drive.
      2. Execute the SETUP program, from a command prompt, or via the Windows ''Start'', ''Run'':
            > A:SETUP
        or
            > B:SETUP
        
      3. Follow the installation program's directions, such as to select an installation directory, and insert additional diskettes (depending upon version) as instructed.
    2. If XCAP is provided on a compact disk (CD):
      1. If your PC is set to allow automatic execution of loaded CDs, the CD's interactive index program will be executed automatically. Otherwise, execute the index program, from a command prompt, or via the Windows ''Start'', ''Run'':
            > Z:SETUP       (replace Z with drive letter for your CD)
        
      2. Select ''Setup PIXCI(R) Imaging Software'' and ''XCAP Imaging Application''. Click ''OK''.
      3. Follow the installation program's directions, such as to select an installation directory.
    3. If XCAP is provided via the internet:
      1. Download:
            ftp.epixinc.com/software/XCAPWI.EXE
        
        from the EPIX, Inc. ftp site.
      2. Execute the downloaded program, from a command prompt, or via the Windows ''Start'', ''Run'':
            > XCAPWI.EXE
        
      3. Follow the installation program's directions, such as to select an installation directory.
      4. Delete the downloaded .EXE file from your PC's hard drive.
    4. The installation procedure creates a new program group, containing XCAP and several .TXT files. The .TXT files contain these installation instructions, a list of distributed files, corrections or additions to this manual, or other up-to-date information. One file, PCITIPS.TXT, contains the PC Configuration Tips, which provides tips for resolving hardware and software conflicts.
  2. Create Shortcut - Drag & Drop (optional):
    1. From the program group created by the installation program, click and drag the icon for XCAP over to the desktop and drop.
  3. Create Shortcut - Manual (optional):
    1. Right click on the Desktop.[4]
    2. Select ''New''.
    3. Select ''Shortcut''.
    4. Set:
          Command Line:   InstallDir \ XCAPW2K
          Name:           XCAP
      
      replacing ''InstallDir'' with the name of the installation directory chosen above. Select ''OK''.
  4. Install Authorization Key (for XCAP-Plus and XCAP-Std):
    1. XCAP-Plus and XCAP-Std, but not XCAP-Lite, are provided with an authorization key; about the size and shape of a printer cable's connector (5.5×4.5×1.6 cm), but having 25 pin connectors at both ends and no cable attached. If provided, connect the authorization key to printer port 1, 2, or 3. If a printer cable was attached to the printer port, reconnect the printer cable to the back of the authorization key. The authorization key will not affect normal printer operation.

      Do not connect the authorization key to a 25 pin serial (RS-232) port, or to any other interface which happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!

      The authorization key must remain attached to the printer port while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus or XCAP-Std will behave similar to the XCAP-Lite version; selected image processing and analysis tools will not be operational.

    2. Run the authorization key utility program provided with XCAP by ''Start'', ''Run'':
          > C:\XCAP \ HLDINST -install
      
    3. Or, in command prompt mode, switch to the chosen installation directory:
          > CHDIR C:\XCAP
      
      and execute:
           HLDINST  -install
      
      to run the authorization key utility program.
  5. Install PIXCI® Imaging Board Driver:
    1. If the PIXCI® imaging board's driver wasn't loaded when the PC was powered up (as described under Hardware Installation), instruct Windows to load the appropriate driver: Click ''Start'', ''Programs'', and ''Windows NT Explorer''. Within the chosen installation directory, such as C:\XCAP, find and highlight file DRIVERS\WIN2K\EPIXXCNT.INF. From the menu bar, select ''File'' and ''Install''.
  6. Configure S/VGA:
    1. A ''High Color (16 bit or 65536 Color)'', ''True Color (24 bit or 16777216 Color)'', or ''True Color (32 bit)'' setting for the display adapter (S/VGA) is required for proper display of images and overlay graphics. The ''True Color (24 bit or 16777216 Color)'' or ''True Color (32 bit)'' is suggested for higher quality, and quicker, display of images and overlay graphics. This may be checked and/or modified via Windows ''Start'', ''Control Panel'', ''Display'', ''Settings''.
    2. In Windows 95, under ''Control Panel'', ''Display'', ''Plus!'', the ''Show window contents while dragging'' must be disabled (this feature is not present in older versions of Windows 95). Or in Windows 98, under ''Control Panel'', ''Display'', ''Effects'', the ''Show window contents while dragging'' must be disabled.
    3. After changing the settings a full shutdown and CTRL+ALT+DEL reboot should be used. The quick restart offered by older versions of Windows, and the dynamic VGA reconfiguration performed by newer versions of Windows, may not re-initialize all devices properly.
  7. Reboot Windows.
  8. XCAP is now ready to run, clicking ''Start'', ''Programs'', ''XCAP Imaging'', and finally ''XCAP for Win 2000''.

3.6. Win 2000 Esoterica

3.6.1. Windows 2000 - Manual Installation

Use of EPIXXCNT.INF, above, provides automatic installation of EPIXXCNT.SYS in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. The EPIXXCNT.SYS must be copied to the Windows SYSTEM32\DRIVERS directory, typically:
        C:\WINNT\SYSTEM32\DRIVERS
    
  2. Using the Registry Editor (REGEDIT) provided with Windows, create an entry such as:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCNT
    
    This entry must contain:
        ErrorControl  =  0x00000001
        Group         =  "Extended base"
        Start         =  0x00000001
        Type          =  0x00000001
    
    and may, as described below, also contain:
        PIXCI         =  "-IM <memorysize>"
    
    Create an entry such as:
    HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCNT
    
    This entry must contain:
        EventMessageFile = "%SystemRoot%\System32\IoLogMsg.dll"
        TypesSupported   = 0x00000007
    
  3. Shut down and restart Windows.

3.6.2. Windows 2000 - Frame Buffer Memory Allocation

Under Windows 2000, frame buffer memory must be allocated during Windows' initialization.

The requested frame buffer memory size must be specified in the Registry entry described above, using an entry named ''PIXCI'', such as:

    PIXCI         =  "-IM <memorysize>"
replacing the ''<memorysize>'' with the desired memory size in Kbytes. If no frame buffer memory size is specified, a default size of 4 megabytes is used. Windows must be rebooted for the new specification to take effect.

Windows 2000 limits the maximum amount of allocatable frame buffer memory, dependent upon what other devices are installed, the total PC memory size, and other factors.

Less than the requested amount of frame buffer memory may be allocated. If no memory could be allocated, XCAP will not run, stating ''Can't allocate frame buffer memory''. Otherwise, within XCAP, the number of available frame buffers can be checked under PIXCI®, PIXCI® Video Setup, Resolution. As the frame buffer memory is allocated once during Windows initialization; the contents of frame buffers are retained as XCAP is closed and restarted, but lost if Windows is restarted.

3.6.3. Windows 2000 - Forcible Frame Buffer Memory Allocation

As described above, frame buffer memory allocated by EPIXXCNT.SYS during Windows startup may be limited to a small percentage of total PC memory.

A larger frame buffer memory can be obtained by limiting the amount of memory recognized by Windows 2000, and then instructing EPIXXCNT.SYS to explicitly use a section of memory without allocating it from Windows 2000:

  1. Edit C:\BOOT.INI, restricting Win 2000 to use no more than a set amount of memory: by copying an existing configuration line, adding /MAXMEM=XX (where XX is in Mbytes) and changing the prompt name, such as changing:
        [operating systems]
        multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows 2000"
    
    to
        [operating systems]
        multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows 2000 [NT=64M PIXCI=256M]"  /MAXMEM=64
        multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows 2000"
    
    Do not copy this new line exactly as is; the first portion of the line must be copied from an existing configuration line in your C:\BOOT.INI file. The text between quotes appears as a boot selection prompt, use of ''[NT=64M PIXCI=256M]'' is a suggested reminder, but not required. Keeping the original configuration line, as a boot selection option, is highly recommended as a backup.
  2. Edit the registry entry for EPIXXCNT.SYS:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCNT
    
    On the ''PIXCI'' field add:
        -IA <image_memory_adrs_in_kbyte>
        -IM <size_of_image_memory_in_kbyte>
        -MB 8192
    
    In practice, all three fields are on the same line. Be certain that the -IA address is equal to (or above) the specified /MAXMEM limit; INCLUDING exact base2 to base10 conversions! (i.e. for /MAXMEM=64, the smallest legal value of -IA is 65536, not 64000!). Likewise, be certain that the -IA plus -IM values do not exceed the amount of memory available!
  3. Reboot, using the newly added boot selection.

For example, for a PC with 1 gigabyte of memory, allocating 256 Mbyte for Windows and the remainder for frame buffer memory, use:

    /MAXMEM=256
in C:\BOOT.INI, and use:
    PIXCI = -IA 262144 -IM 786432 -MB 8192
in the registry entry. Note that 262144 is 256×1024, and 786432 is (1024-245)×1024.

Note that if this memory allocation method is used, program access to image data may be is slower. Thus, the video display rate (and image processing) may be slower, but the video capture rate (such as sequence capture) is not adversely affected. This method of memory allocation is primarily used for video rate acquisition of long sequences, followed by off-line analysis or saving of the sequence.

3.6.4. Windows 2000 - Authorization Key - Manual Installation

Use of HLDINST.EXE, above, provides automatic installation of the authorization key's driver, needed under Windows 2000, for XCAP-Plus and XCAP-Std (but not needed for XCAP-Lite). The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. The file HARDLOCK.SYS must be copied to the Windows SYSTEM32\DRIVERS directory, typically:
        C:\WINNT\SYSTEM32\DRIVERS
    
  2. Using the Registry Editor (REGEDIT) provided with Windows, create an entry such as:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock
    
    This key must contain values:
        ErrorControl  =  0x00000001
        Group         =  "Extended Base"
        Start         =  0x00000002
        Type          =  0x00000001
    
    or, if using REGEDT32, the values should appear as:
        ErrorControl:REG_DWORD:0x1
        Group:REG_SZ:ExtendedBase
        Start:REG_DWORD:0x2
        Type:REG_DWORD:0x1
    
  3. Shut down and restart Windows for the new registry entries to take effect.
  4. If the authorization key is connected to a non-standard printer port, an additional entry may be required:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock\Parameters
    
    which contains a value:
        IoPortAddress0  = 0x????            (for REGEDIT)
        IoPortAddress0:REG_DWORD:0x????     (for REGEDT32)
    
    where the ''????'' is replaced with the parallel port's I/O address in hexadecimal. As before, Windows must be shut down and restarted.

4. Getting Started

This chapter will guide the user through the initial steps common to most applications using the PIXCI imaging board: capturing, viewing, examining, and saving images. This guide isn't intended to discuss every feature of every window, just the most important features to ''get up and running''.

By following the previous instructions, at this point:

  1. The PIXCI imaging board has been installed.
  2. The camera has been connected to the PIXCI imaging board.
  3. The XCAP software has been installed.
  4. For XCAP-Plus or XCAP-Std, but not XCAP-Lite, the authorization key has been installed on the printer port.
  5. The PIXCI driver for Windows 95/98, Windows NT, or Windows 2000 has been installed.
  6. The S/VGA has been set for 16 bits (minimum required), or 24 or 32 bits (preferred), per pixel.
  7. The PC has been rebooted (Ctrl+Alt+Del) so that the installed driver and the modified S/VGA settings (if any) have taken effect.

The following instructions are intended to be used while operating the PC; pictures of the S/VGA are intentionally not shown, in favor of focusing the reader's attention on the real S/VGA screen.

4.1. Start XCAP

Start XCAP by clicking:

    Start (on the Windows Taskbar)
    XCAP Imaging
and then clicking:
    XCAP for Win 95/98
    XCAP for Win NT
or  XCAP for Win 2000
as appropriate.

The XCAP Main Window now appears.

4.2. Open PIXCI Imaging Board

In the XCAP Main Window, click:

    PIXCI
    PIXCI Open/Close
A dialog box appears.

Clicking:

    Open
opens the PIXCI imaging board for use, removes the Open/Close dialog, creates a PIXCI Image Viewer window showing the first PIXCI frame buffer, depending on imaging board model and camera used, may create an Adjust dialog with commonly used camera and video capture adjustments, and creates a Shortcuts Toolbar for accessing the most commonly needed features.

The following windows are now active:

  1. The Main Window, which has options for reconfiguring the PIXCI imaging board, and features unrelated to the PIXCI imaging board, such as loading images into image buffers unrelated to video capture hardware.
  2. The PIXCI® Image Viewer window, from which the PIXCI® frame buffers are captured, viewed, examined, processed, measured, and saved.
  3. The PIXCI® Shortcut Toolbar, with shortcuts for the most commonly needed features relating to the PIXCI® imaging board and its frame buffers.
  4. Optionally, an Adjust dialog, with commonly used camera and video capture adjustments.

If XCAP has already been installed, it may have been configured with one or more variations. One variation eliminates the Main Window, automatically opening and displaying the PIXCI® Image Viewer. Another variation allows the Shortcuts and/or Adjust features to be attached to the The PIXCI® Image Viewer window, rather than detached into their own windows. A third variation selects whether the Shortcuts and/or Adjust features appear automatically, or only when

    Capture
    Adjustments
or
    Capture
    Shortcuts
are clicked. These variations allow custom configuration of XCAP, but don't affect the functionality of the Shortcuts or Adjustments features.

4.3. PIXCI® D, D24, D32 Video Configuration

The PIXCI® D, D24, and D32 imaging boards are customized for a specific camera. XCAP identifies the specific PIXCI® D, D24, or D32 imaging board, and defaults to capturing full video resolution from the specific camera.

4.3.1. Video Resolution

Reducing the video resolution (the number of pixels captured per line and column) allows capturing more video frames in a given size of frame buffer memory.

From the Main Window, click:

    PIXCI®
    PIXCI® Video Setup
    Resolution
Modify:
    Data Pixels per Line
    Data Lines per Field

Frame Buffer: 2 Fields (i.e. interlace) Frame Buffer: 1 Field
as per your application's needs. (Some multi-tap cameras, or cameras with Bayer pattern pixels may not operate correctly if the resolution is modified incorrectly). or The:
    Image Buffers in Memory
shows the number of frame buffers available with the current selections. Click:
    OK

4.3.2. Saving the Video Configuration

The selections under the Main Window:

    PIXCI® Video Setup
and under the PIXCI® Image Viewer:
    Adjustments
are automatically saved when the PIXCI® imaging board is closed, and/or XCAP is exited. When the PIXCI® imaging board is next opened (from the XCAP Main Window clicking):
    PIXCI
    PIXCI Open/Close
    Camera & Format
You may choose:
    Open w. last used Video Setup
to use the previous video setup, or choose:
    Open w. default Video Setup
to start afresh with the default video format and resolution.

4.4. Capturing Images

Once the PIXCI® imaging board is opened for use, images may be captured from the PIXCI® Image Viewer, clicking:

    Capture
    Snap
or
    Capture
    Live
The Snap captures a single image into the current frame buffer, while Live continuously captures images into the current frame buffer, continuously updating the image shown on the S/VGA.

The Live mode may be used to adjust the camera's focus, aperture, and position. The Live mode may be halted by clicking:

    Capture
    UnLive
A Live followed immediately by Unlive has the same effect as Snap.

If the current video resolution and frame buffer memory size allows more than one frame buffer, clicking:

    Capture
    Adjustments
provides the:
    Current Frame Buffer:   0
or sometimes shortened to:
    Current Buffer:   0
which may be incremented or decremented at any time, whether in Live or UnLive mode. The dialog reached by clicking:
    Capture
    Adjustments
has convenient buttons which duplicate the Snap, Live, and UnLive features.

As three of the most commonly used operations, the Snap, Live, and UnLive are also available in the Shortcuts Toolbar, in the top row, at the fifth and sixth from the left. The Shortcuts also allow changing the current frame buffer; in the top row, the four icons at the left switch to the first frame buffer, the next frame buffer (e.g. current buffer +1), the previous frame buffer (e.g. current buffer -1), and the last frame buffer, respectively.

4.5. Examining Images

4.5.1. Altering How the Image is Displayed

The PIXCI Image Viewer can be moved and resized, using standard Windows techniques (drag the window's title bar, drag the window's corner, etc). By default, the captured image is displayed with resizing, so that the entire image fits within the Image Viewer.

For many engineering applications, examination of individual pixel values is critically important. Resizing the image may ''hide'' defective pixels; resizing an image with interlace jitter may turn odd/even line striping into bars of striping.

To view the exact pixels, from the PIXCI® Image Viewer, click:

    View
    Display
    Resize: None (1 to 1)
Each image pixel is now displayed as exactly one S/VGA pixel. Of course, depending upon the image resolution, S/VGA resolution, and window size, the entire image may not fit. If the image doesn't fit, then (a) Scroll bars appear, allowing the viewed portion of the image to be panned and scrolled throughout the entire image, and (b) Moving the mouse with right button held over the displayed image causes panning or scrolling (if there is more image to be seen in the direction the mouse is moving).

Note that when:

    Resize: None (1 to 1)
is selected, the displayed image's aspect ratio may not appear correct; the aspect ratio can't be corrected without some form of resizing or resampling!

4.5.2. Zoom

To magnify the image, from the PIXCI® Image Viewer, click:

    View
    Zoom, Pan, Scroll
    Zoom On
The magnification factor can be adjusted with:
    Zoom Ratio
When magnified, only a portion of the image is visible. As described above, the viewed portion may be panned and scrolled through the entire image with the scroll bars, or by moving the mouse over the image with right button held.

4.5.3. Numeric Pixel Values

To examine numeric values of pixels as a table, from the PIXCI® Image Viewer, click:

    Examine
    Pixel Peek
A table of pixel values for a portion of the image appears, showing pixel values in the neighborhood of the displayed X and Y coordinates. The portion of the image numerically displayed can be moved by using the scroll bars, or by entering new X and Y coordinates.

The portion of the image which is numerically displayed can also be moved interactively by clicking:

    Coord<=>Cursor
A cursor now appears over the image window (the Pixel Peek window may have to be moved to the side so that both the pixel peek window and the image viewer window can be seen); clicking the mouse on the image viewer window moves the cursor to that position, and repositions the numerically displayed portion of the image to be centered at that position.

To examine pixel values as a two dimensional graph, click:

    Examine
    Pixel Plot
and
    Controls
    Where
and Plot Row
or  Plot Column
A graph of pixel values for a line (column) of the image appears, showing pixel values along the line (column) at the displayed Y (X) coordinate. The line (column) of the image which is shown can be moved interactively by clicking:
    Coord<=>Cursor
A cursor now appears over the image window; clicking the mouse on the image window moves the cursor to that position, and repositions the displayed line (column) to that Y (X) coordinate.

4.6. Saving Images

To save an image, from the PIXCI Image Viewer, click:

    File
    Save Image
Choose a file format, such as:
    TIFF
    JPEG/JFIF
    BMP
    PCX
    Targa (TGA)
    X/Y Binary
    X/Y ASCII
TIFF is an industry standard, and the most commonly used image file format; TIFF is suggested for saving and reloading an image into XCAP, and suggested for exporting images to other programs which support TIFF. The JPGE/JFIF is also a commonly used image file format and provides high, but lossy, compression. The BMP, PCX, and TGA formats are useful when exporting an image into other programs that don't support TIFF; but these file formats support only 8 bits per pixel component (such as 8 bit monochrome or 24 bit RGB). The X/Y Binary and X/Y ASCII export raw pixels, left to right, top to bottom, with no excess information such as dimensions, bit depth, date, format, etc; these are useful for exporting images to a spreadsheet (X/Y ASCII), or to your own program that can assume the image's dimensions and can simply read a 2-D array of values.

After selecting a file format, enter a file name:

    File Name:  xx.tif
and click
    OK
to save the image. Or, use the:
    Browse
button to access the standard Windows File Dialog, click
    Accept
to accept the filename selected by browsing, and click
    OK
to save the image.

5. XCAP Software Guide

XCAP is a family of sophisticated, interactive, imaging programs specifically designed to support the PIXCI series of imaging boards, but also able to process and analyze images from other imaging sources. Several versions of XCAP are available: XCAP-Std, XCAP-Plus, XCAP-Lite, and XCAP-Demo. All versions share the same user interface and menu structure, but selected features in XCAP-Std, XCAP-Lite, and XCAP-Demo are not operational. XCAP is distributed on CD, diskette(s), or downloadable from the EPIX, Inc. website. After installation, a 12 character identification code[5] is entered to configure XCAP as either XCAP-Std, XCAP-Plus,[6], or XCAP-Lite; or, lacking a valid code, configured as XCAP-Demo to browse, but not use, XCAP's features.

XCAP-Std is an interactive, imaging program designed for scientific, industrial, and machine vision applications. XCAP-Std supports the PIXCI imaging board, providing video format and resolution configuration; continuous (live), video rate sequence, and triggered capture; and single or sequence, zoomed or resized, display. The image frame buffers of PIXCI imaging boards can be loaded, examined, processed, analyzed, measured, printed, annotated, and saved.

XCAP-Std also allows loading and analyzing a pre-existing image or image sequence with size, pixel depth, and color space independent of the PIXCI imaging board's configuration; XCAP-Std can be used with pre-existing images even when the PIXCI imaging board is not present. XCAP-Std can also acquire images from TWAIN compliant devices.

XCAP-Plus provides extra, advanced, features in addition to all of the capabilities of the XCAP-Std, such as support for specialized, optional, hardware.

XCAP-Lite is a basic version of XCAP-Std. XCAP-Lite provides similar image acquisition and PIXCI imaging board control capabilities, video format and resolution configuration; continuous (live), video rate sequence, and triggered capture; and single or sequence, zoomed or resized, display. XCAP-Lite also provides some of the image loading, examining, printing, and saving features, but minimal processing, measurement, analysis, and scripting features are functional. XCAP-Lite can also be used with pre-existing images, but only while the PIXCI imaging board is present and opened for use.

XCAP-Demo allows browsing through the dozens of processing, measurement, analysis, and graphics features provided in XCAP-Plus, XCAP-Std, or XCAP-Lite. Images can't be loaded from, or saved to, files. Nor can the PIXCI imaging board be operated with the XCAP-Demo version.

As XCAP-Plus, XCAP-Std, and XCAP-Lite share many common features, this manual typically refers to all versions as XCAP, except where explicitly differentiated.

The XCAP programs are organized into two major types of windows, the Image Viewer Window and the Main Window.

For each image, or sequence of images, an Image Viewer Window shows that image, or a selected image of that sequence, and via its menu bar allows viewing, examining, processing, analyzing, or drawing upon that image (sequence). The Image Viewer Window associated with the PIXCI imaging board's frame buffers also provides features for capturing new images. There can be multiple Image Viewer Windows for the same image (sequence), allowing, for example, viewing the image both zoomed and unzoomed, or simultaneous viewing of different images of a sequence.

The Main Window allows creating new image (sequences), and thus new Image Viewer Windows, either by loading a new image from file, explicit specification of the new image's dimensions, or by opening the PIXCI imaging board for use. Video setup for the PIXCI imaging board, such as modifying the video resolution or color space, are also in the Main Window; these features destroy and re-create the PIXCI imaging board's Image Viewer Window. The Main Window also provides features not directly associated with an image (sequence), such as scripts, RS-232 device control, and features to customize XCAP.

5.1. The Main Window

The XCAP main window provides a menu bar with File, Images, Scripts, Utility, PIXCI®, and Help features.

5.1.1. Main Window - File

The main window's File allows loading of pre-existing images into new image buffers, displaying attributes about pre-existing images, and acquiring images from TWAIN compliant devices.

The Load New Image and Load New Image Sequence creates a new image buffer (sequence) with dimensions, pixel depth, and color space matching a specified TIFF, BMP, or multimedia format file(s), and loads the image(s) from the file(s). This feature, and the image buffer (sequence) created, is unrelated to the PIXCI imaging board's frame buffers. After creation and loading, the new image (sequence) is displayed, processed, and analyzed in The Image Viewer Window, described below. The XCAP-Lite version does not provide the Load New Image Sequence feature.

The Image File Info displays information about a specified TIFF or BMP format file without loading the image. The information displayed includes the image's dimensions, pixel depth, color space, palette option, and other file format specific information.

The TWAIN Select Source and TWAIN New Acquire allow using XCAP as a TWAIN Application, acquiring images from TWAIN compliant imaging devices (TWAIN Sources). The TWAIN Select Source allows selecting which TWAIN Source is to be used, and the TWAIN New Acquire allows acquiring one image from the TWAIN Source. The XCAP-Lite version does not support being used as a TWAIN Application.

The Window List displays a list of active windows belonging to XCAP; selecting a window causes that window to appear, if previously hidden, and/or to appear over other windows (subject to the priority of selected windows to always appear ''on top'').

5.1.2. Main Window - Images

The main window's Images allows creating new image buffers and activating any existing image windows that may not be on-screen.

The New Image creates a new image buffer, or sequence of image buffers, with specified dimensions, pixel depth, color space, and palette. This feature, and the image buffer created, is unrelated to the PIXCI imaging board's frame buffers. After creation, the new image is displayed in an The Image Viewer Window, as described below.

Underneath New Image are listed all existing image windows, whether for PIXCI imaging board frame buffers, or for independent image buffers. (The image window for PIXCI imaging board frame buffers appears only after the PIXCI imaging board has been opened for use, see below). An image window which has been closed and thereby off-screen can be reactivated by clicking the image window's name.

5.1.3. Main Window - Scripts

The main window's Scripts provides features for recording and playing scripts. A script recording contains most of the user's interactions with the windows of XCAP; playing the script duplicates the original actions.

Some user actions are not recorded. Using the mouse to drag the cursor or other graphic across an image is not recorded as these actions are highly dependent upon image content (such as the typical scenario of dragging the cursor until it is positioned next to an artifact in a captured image), would likely be inappropriate to other captured images, and would consume a significant amount of disk space. Instead, after positioning the cursor interactively the user can record the final position by clicking the appropriate numeric cursor coordinates. Features activated with keys, or clicking icons are not currently recorded; such features can also activated by other means, which are recorded.

A recorded script is in a human readable form and can be altered with any common editor capable of handling ASCII text, allowing scripts to be modified or combined. A selected script may be executed automatically after XCAP starts, this feature is set in Utility, Program Setup, Startup Script.

The Load Tool Bar provides one or more user-defined tool bars of shortcuts, each shortcut represented by an icon which, when clicked, executes a user-specified script. Each shortcut may also specify an optional keyboard key which, when pressed, also executes the user-specified script.

The Script Remote Control allows using XCAP as a hidden, off-screen, ''black box''; any end-user application that can manipulate text files, can also remotely control XCAP.

The XCAP-Lite version does not support recording scripts, creating user-defined tool bars, or the remote control feature. The XCAP-Lite version can play scripts previously created with XCAP.

5.1.4. Main Window - Utility

The main window's Utility provides an assortment of features which are of secondary importance; features which allow fine tuning of XCAP, or features needed in relatively few circumstances.

The Black Board allows customizing XCAP, creating non-procedural programs, and collecting data. The black board allows inter-connecting the numeric and text field of other windows; computed results, such as center-of-mass, may be written onto the black board - parameters for other features, such as the coordinates of a displayed grid, may be extracted from the black board - combining these automatically repositions the grid as the center of mass is recomputed! Other features allow computed values (similar to a spreadsheet), ''push''ing buttons, timed updates, creating a report to file or an RS-232 port, collecting data, and graphing the black board's contents. The XCAP-Lite version allows use of the Black Board for computing values (similar to a spreadsheet), but does not allow inter-connections with other features or creating reports or graphs.

A Message Log window lists warnings and errors that arise from performing various operations. By default, the message log window appears automatically when a message is added, and disappears a few seconds later. Auto appearance, auto hide, and audible clicks can be disabled (from the message log window's menu bar). The menu-bar's Message Log allows explicit activation of the message log window.

The Program Setup shows information about the installed XCAP components, such as their revision level, and sets various configuration options. For versions of XCAP which require an authorization key, it also shows the ID of the key required by the instant copy of XCAP.

The Program Setup allows specifying the name of a script to be executed when XCAP starts, whether warning dialog's (if any) are to be shown, whether previously saved settings are to be loaded, and other similar initial or terminal conditions.

The Program Setup also enables user-defined translation of XCAP labels and messages for use in non-English speaking countries. The XCAP-Lite version does not support creating user-defined translated labels and messages, but may use translated labels and messages previously created with XCAP.

The Windows Info displays information about the current Windows environment, such as memory usage and the S/VGA display adapter's features, as reported by Windows. The Java Info displays information about the status of Java, under which XCAP runs. Both of these features are primarily of use in resolving questions submitted to EPIX, Inc. Technical Support.

The Window Style allows setting some characteristics of XCAP windows, such as color or character size and font. Some characteristics of window style are instead controlled by the Windows Control Panel.

The Audio Clip allows recording and playing short audio ''clips''.

The RS-232 Control allows controlling devices connected via the RS-232 port. The RS-232 Control is designed specifically for device control, including options to communicate with byte values, rather than as a common ''terminal emulator''.

The I/O Port Peek & Poke allows controlling arbitrary devices accessible via I/O port peeks and pokes. This feature must be used with caution; peeking or poking arbitrary ports will cause computer malfunction! This feature is not available under Windows NT.

The Screen Capture allows capturing the current S/VGA screen graphics, saving the graphics to a file, or printing the graphics. The Screen Capture also allows capturing numeric and textual parameters into a text file, suitable for loading into a spreadsheet or other programs. The XCAP-Lite version does not support screen capture.

5.1.5. Main Window - PIXCI®

The main window's PIXCI® allows initiating access to the PIXCI imaging board and provides configuration options. Actual operation of the PIXCI imaging board is performed through the PIXCI image viewer window's menu-bar.

The PIXCI® Open/Close allows opening access to, or closing access to, the PIXCI imaging board. Once open, the model (and submodel, as appropriate) of the PIXCI imaging board is available via the Board Info button. After opening, the contents of the PIXCI image board's frame buffer(s) are displayed in The Image Viewer Window, and a tool bar of PIXCI® Image Viewer - Capture - Shortcuts is shown, as described below.

The PIXCI® Video Setup allows configuring the video format, video resolution and other, model specific, video characteristics. For example, for PIXCI SV2, SV3, and SV4 models, the PIXCI® Video Setup allows selecting NTSC, RS-170, S-VIDEO, CCIR, or PAL, allows selecting the video window size and capture resolution, and selecting other video acquisition characteristics. For other models, such as the PIXCI® D, fewer options may be provided, as the PIXCI® D models are camera specific.

The current video setup is automatically saved when access to the PIXCI imaging board is closed, and reloaded when the PIXCI image board is later opened. The PIXCI® Save Video Setup and PIXCI® Load Video Setup may be used to explicitly save or reload the current video setup, such as to choose amongst several favorite setups, or to export the current video setup to the XCIP program or the XCOBJ library.

The PIXCI® Status shows the PIXCI imaging board's current status, such as the state of the TTL trigger input(s) and output(s), the number of elapsed video fields, the board's model and submodel, and configured image memory size.

The PIXCI® Connections provides, as appropriate for the specific model of PIXCI imaging board, a map of the board's connections, connectors, option jumpers, and adjustments.

The PIXCI® Camera Info provides a list of cameras and video formats supported by XCAP and various PIXCI® imaging boards. The PIXCI® Camera Info also allows viewing a non-operational Capture - Adjustments dialog (i.e. the ''Control Panel'', which provides integrated control of both imaging board and any supported camera.

The PIXCI® TWAIN Sourcery allows using XCAP, in conjunction with the PIXCI® TWAIN driver, as a component of a ''smart'' TWAIN Source, allowing other applications to capture images from the PIXCI® imaging board, while XCAP provides imaging board, camera controls, and, optionally, image preprocessing. (The XCAP-Lite version does not provide image preprocessing). See the PIXCI® TWAIN driver documentation for additional details. The PIXCI® TWAIN Sourcery should not be confused with TWAIN New Acquire; the former allows XCAP to provide image data to other, TWAIN compliant applications; the latter allows XCAP to accept image data from other TWAIN compliant sources. The TWAIN New Acquire should never be used to attempt to acquire image data from the PIXCI® TWAIN Sourcery!

The PIXCI® Image-Pro Sourcery allows using XCAP, in conjunction with the PIXCI® Image-Pro driver, as a component of a ''smart'' video source, allowing Image-Pro to capture images from the PIXCI® imaging board, while XCAP provides imaging board, camera controls, and, optionally, image preprocessing.

5.2. The Image Viewer Window

Each image buffer (sequence), or frame buffer (sequence), is displayed in an image viewer window, which is the focus of activity for examining, processing, or analyzing that image buffer (sequence). The image viewer window provides a menu bar with File, View, Examine, Modify, Measure, Draw, AOI, and Help features. The image viewer window associated with the PIXCI imaging board's frame buffer(s) also provides a Capture feature.

5.2.1. Image Viewer - File

The image viewer window's File allows saving, loading, or printing the image, shows information about the image's dimensions, pixel depth and color space, and allows closing the image viewer window.

The Load Image and Save Image allow saving or loading the image in a variety of file formats. The Load Image, unlike the Load New Image described above, loads an image file into the current image buffer, resizing and/or color converting to fit the image buffer's existing dimensions, pixel depth, and color space.

For image viewer windows associated with an image buffer sequence, the Save Image Sequence and Load Image Sequence allow saving or loading multiple images of the sequence as a numbered sequence of image files, or as a single TIFF or AVI format image file with multiple images. The XCAP-Lite version does not support loading or saving of image buffer sequences in a single operation; however multiple uses of Load Image or Save Image can load or save each image buffer of a sequence.

The E-Mail Image allows directly e-mail'ing the image, in a variety of file formats, from within XCAP. The XCAP-Lite version does not support the E-Mail Image feature.

The Print, Windows and Print, PXIPL allow printing the image; the former printing via Windows and supporting a wide variety of printers, the latter printing via the PXIPL library and supporting only the most popular printers, but providing precise control of print options. The XCAP-Lite version does not allow printing via the PXIPL library.

The Attributes shows the image's (or image sequence's) dimensions, pixel depth, and color space.

The Duplicate Image allows creating a new image buffer, and copying the image, in one step. It optionally allows co