USER'S MANUAL

PIXCI® CL3D
Revision 2.3

24 January 2007

For use with:
PIXCI® CL3SD Rev. 2.0



Copyright © 2007 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: 14-Jul-2008

Table of Contents


 

 

 

1. Installation

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

The PIXCI® CL3SD 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.

We recommend installing XCAP prior to installing the PIXCI imaging board. Please refer to the Software Installation chapter for the XCAP installation directions, then follow the board installation instructions below.

Note that Windows 95, 98, or ME are NOT SUPPORTED.

  1. Turn off the power and remove the cover from the PC into which the PIXCI imaging board is to be installed.

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

  3. Use of a static free area and a wrist strap connected to the PC or to the static free area is required 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 static charge that may have been created while transporting the board to the PC.

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

  5. Replace the screw to secure the PIXCI imaging board in the slot.

  6. Remove the power from all equipment to be connected.

  7. Connect the cable(s) between the PIXCI CL3SD, camera, and power supply. Two identical Camera Link cables are used to connect data and control between the A504K camera and PIXCI CL3SD board. Note that the orientation of the cable ends between the camera and the board are such that the cable connecting to the top connector on the camera goes to the lower connector on the board. The rule is that the cables cross. Incorrectly connecting the cables will result in errors. The thumb screws on the connectors must be used to provide a proper electrical connection between the cable and the connector.

  8. Power up the camera, PC, and monitor(s).

  9. Operate XCAP by following the instructions in the Software Installation and Getting Started chapters in this manual.

  10. Check for display of video on the graphical display system by clicking on the Capture and then the Snap menu in the View window or by using the shortcut menu.

  11. If there is no video displayed, make sure that the camera communications are enabled in the Camera Adjust Menu, and make sure the camera is in the free run mode of operation. If the Video count reported in the View Menu 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.

 

1.1. Motherboards

Most motherboards manufactured since 2001 should be compatible with the PIXCI CL3SD. EPIX, Inc. can supply a tested system with PIXCI CL3SD, camera, cables, camera power supply, and computer.

 

1.2. Graphics Display System

An AGP based graphics display adapter is recommended.


 

 

 

2. Connectors

The PIXCI CL3SD imaging board has two 26 pin 3M MDR connectors for data and control between the A504k or A504kc camera. These two connectors are accessible thru the bracket that mounts the board to the computer chassis. Revision 2.0 of the board has an additional 6 pin LEMO connector thru the top of the bracket for trigger input and trigger output.

Two identical Camera Link cables are used to connect data and control between the A504K camera and PIXCI CL3SD board. Note that the orientation of the cable ends between the camera and the board are such that the cable connecting to the top connector on the camera goes to the lower connector on the board. Incorrectly connecting the cables will result in errors. The thumbscrews on the connectors must be used to provide a proper mechanical and electrical connection between the cable and the connector.

 

2.1. PIXCI CL3SD Bracket Connectors

Connector P5 is the round connector nearest the top of the bracket on the Revision 2.0 PCB. Connector P2 is the upper 26 pin MDR connector which connects to the lower connector on the A504K camera. Connector P1 is the lower 26 pin MDR connector which connects to the upper connector on the A504K camera. Note that the cables must have the thumb screws securely fastened for proper signal connection.

Note that the two 26 pin MDR cables are ``switched'' in their camera to board location with the top connector on the A504K going to the lower connector on CL3SD.

 

2.2. PIXCI CL3SD 10 Pin Header P3 Signal List

Two 10 pin headers are provided for connecting external and internal signals to the PIXCI CL3SD. The description for Header P3 follows.

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

Ground 1 2 +5 VDC (0.75 Amp max)

Trigger In + I 3 4 I Trigger In -

Not Used NC 5 6 NC Not Used

CC4P- O 7 8 O CC4P+

Not Used I/O 9 10 I/O Not Used

The Trigger input can be used by software to start an image sequence capture and may also be used to generate the exposure signal to the camera with software controlled timing. The Trigger input receiver uses LVDS (Low Voltage Differential Signal) voltage levels and is terminated in 100 ohms between pin 3 and pin 4.

CC4 is used to provide a copy of the Trigger for multiple board synchronization. The driver output uses LVDS voltage levels.

Header P3 is for signals external to the computer case or internal to the computer case. External signals can be connected with a cable to 9 pin D-Subminiature connector thru a second slot with a bracket to mount the D-Subminiature connector. A differential to TTL conversion module and 2 meter cable are available for connecting a TTL trigger to the PIXCI CL3SD.

A 6 position LEMO EGG.0B.306.CLL connector, P5, which is mounted at the top of the PCI bracket, has the same signals as P3 for connecting trigger inputs and outputs. All connections are common to header P3.

Pin 1 is ground.

Pin 2 is +5 volts thru a 0.75 ampere thermally triggered resettable fuse.

Pin 3, Trigger In P, is a positive LVDS differential trigger input, which is also connected to pin 3 of P3.

Pin 4, Trigger In M, is a negative LVDS differential trigger input, which is also connected to pin 4 of P3.

Pin 5, CC4P, trigger output, is a copy of the negative differential trigger input for multiple board trigger.

Pin 6, CC4M, trigger output, is a copy of the positive differential trigger input for multiple board trigger.

The CC4P and CC4M output signals are copies of the Trigger In+ and Trigger In- signals for daisy chaining the trigger input from board to board.

 

2.3. PIXCI CL3SD 10 Pin Header P4 Signal List


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

Ground 1 2 +5 VDC (0.75 Amp max)

OUT1 Out 3 4 Ground

OUT2 Out 5 6 Ground

IN1 In 7 8 Ground

IN2 In 9 10 Ground

Header P4 is for TTL input and output signals internal to the computer case.

Pin 1 of P4 is in the upper left position.

Pin 1 is ground.

Pin 2 is +5 volts thru a 0.75 ampere thermal fuse.

Pin 3, OUT1, is a general purpose TTL output.

Pin 5, OUT2, is a general purpose TTL output.

Pin 7, IN1, is a general purpose TTL input.

Pin 9, IN2, is a general purpose TTL input.

Any other connectors on the PIXCI CL3SD are for test purposes only.

 

2.4. PIXCI CL3SD Memory Sockets


Memory sockets are populated in pairs starting with SOCK0 and SOCK4 which, together, provide 1 gigabyte of memory. The next two sockets to be populated are SOCK1 and SOCK5. Micron 512 megabyte registered, synchronous, dynamic memory modules are used. The board and PC must have power removed before removal or installation of memory and the installation must carried out with static elimination procedures.



 

 

 

3. Software Installation

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

While XCAP is easy to install, like most manufacturers of computer software, we recommend the precaution of performing a hard disk backup before installing XCAP.

 

3.1. For Windows NT

XCAP requires Windows NT Version 4 with Service Pack 3 or later. You must be logged on as 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. The default installation directory is C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP.

    2. If XCAP is provided on a compact disk (CD):

      1. If your computer 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. The default installation directory is C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP.

    3. If XCAP is provided via the internet:

      1. Download:
        ftp.epixinc.com/software/xcap_v30/XCAPWIN32.EXE (for 32 bit Windows)
        
        from the EPIX, Inc. ftp site.

      2. Execute the downloaded program, from a command prompt, or via the Windows ''Start'', ''Run'':
        > XCAPWIN32.EXE     (for 32 bit Windows)
        > XCAPWIN64.EXE     (for 64 bit Windows)
        

      3. Follow the installation program's directions, such as to select an installation directory. The default installation directory is C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP.

      4. Delete the downloaded .EXE file from your computer'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. The PCITIPS.TXT file provides the PC Configuration Tips, with 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 \ XCAPWXX
          Name:           XCAP
      
      replacing ''InstallDir'' with the name of the installation directory chosen above. Select ''OK''.

  4. Install Authorization Key (for XCAP-Plus, XCAP-Std, and XCAP-Ltd):

    1. XCAP-Plus, XCAP-Std, and XCAP-Ltd, but not XCAP-Lite, are provided with either a printer port authorization key or a USB authorization key.

      The printer port authorization key is approximately 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 any printer port. 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 printer port authorization key to a 25-pin serial (RS-232) port, or to any other interface that happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!

      The USB port authorization key is approximately the size of a small finger (6.0×1.6×0.8 cm), having a USB standard 4-pin connector at one end. If provided, connect the authorization key to a USB port. Operating system support for USB devices is required; XCAP does not add USB support to the operating system.

      The authorization key must remain attached, to the printer port or USB port as appropriate, while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus, XCAP-Std or XCAP-Ltd, 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\HARDLOCK\HLDINST -install
      

    3. Or, in command prompt mode, switch to the chosen installation directory:
          > CHDIR C:\XCAP\HARDLOCK
      
      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 was not loaded when the computer 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 or C:\Program Files\EPIX\XCAP\XCAP, find and highlight file Drivers\WinNT\EPIXXCWT.INF (or EPIXXCNT.INF for version 2.0 and earlier). From the menu bar, select ''File'' and ''Install''.

  6. Configure Graphics Display (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 graphics display (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'', ''Settings'', ''Control Panel'', ''Display'', ''Settings''.

    2. Under ''Start'', ''Settings'', ''Control Panel'', ''Display'', ''Effects'', the ''Show window contents while dragging'' must be disabled.

  7. Reboot Windows.

  8. XCAP is now ready to run, by clicking the optional shortcut, or by clicking ''Start'', ''Programs'', ''XCAP Imaging'', and finally ''XCAP for Windows''.

 

3.2. Windows NT Esoterica

3.2.1. Windows NT - Manual Installation

Use of EPIXXCWT.INF (or EPIXXCNT.INF for version 2.0 and earlier), above, provides automatic installation of EPIXXCWT.SYS (or EPIXXCNT.SYS for version 2.0 and earlier) in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. The EPIXXCWT.SYS (or EPIXXCNT.SYS for version 2.0 and earlier) 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\EPIXXCWT  (version 2.1+)
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCNT  (version 2.0-)
    
    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\EPIXXCWT  (version 2.1+)
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCNT  (version 2.0-)
    
    This entry must contain:
        EventMessageFile = "%SystemRoot%\System32\IoLogMsg.dll"
        TypesSupported   = 0x00000007
    

  3. Shut down and restart Windows.

3.2.2. Windows NT - Status Buffer Memory Allocation

Under Windows NT, memory to maintain status on each frame buffer must be allocated during Windows' initialization.

The requested 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 memory size is specified, a default size of 32768 kBytes is used. Windows must be rebooted for the new specification to take effect.

For the PIXCI® CL3SD, which has on-board frame buffer memory, memory reserved by this parameter is needed only for support of time stamping of captured frames, such as optionally used by XCAP's Capture - Video to Frame Buffers. Currently, 64 bytes are needed for each frame buffer's status.

For systems which also use other PIXCI® imaging boards, the allocated memory is used for frame buffers; requesting a small amount of memory may limit the resolution which can be captured by other PIXCI® imaging boards.

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

3.2.3. Windows NT - Authorization Key - Manual Installation

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

  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 within the XCAP installation directory, typically:
        C:\XCAP\PROGRAM
    
    or
        C:\Program Files\EPIX\XCAP\XCAP\PROGRAM
    

  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.3. 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. The default installation directory is C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP.

    2. If XCAP is provided on a compact disk (CD):

      1. If your computer 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. The default installation directory is C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP.

    3. If XCAP is provided via the internet:

      1. Download:
        ftp.epixinc.com/software/xcap_v30/XCAPWIN32.EXE (for 32 bit Windows)
        
        from the EPIX, Inc. ftp site.

      2. Execute the downloaded program, from a command prompt, or via the Windows ''Start'', ''Run'':
        > XCAPWIN32.EXE     (for 32 bit Windows)
        > XCAPWIN64.EXE     (for 64 bit Windows)
        

      3. Follow the installation program's directions, such as to select an installation directory. The default installation directory is C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP.

      4. Delete the downloaded .EXE file from your computer'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. The PCITIPS.TXT file provides the PC Configuration Tips, with 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.[2]

    2. Select ''New''.

    3. Select ''Shortcut''.

    4. Set:
          Command Line:   InstallDir \ XCAPWXX
          Name:           XCAP
      
      replacing ''InstallDir'' with the name of the installation directory chosen above. Select ''OK''.

  4. Install Authorization Key (for XCAP-Plus, XCAP-Std, and XCAP-Ltd):

    1. XCAP-Plus, XCAP-Std, and XCAP-Ltd, but not XCAP-Lite, are provided with either a printer port authorization key or a USB authorization key.

      The printer port authorization key is approximately 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 any printer port. 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 printer port authorization key to a 25-pin serial (RS-232) port, or to any other interface that happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!

      The USB port authorization key is approximately the size of a small finger (6.0×1.6×0.8 cm), having a USB standard 4-pin connector at one end. If provided, connect the authorization key to a USB port. Operating system support for USB devices is required; XCAP does not add USB support to the operating system.

      The authorization key must remain attached, to the printer port or USB port as appropriate, while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus, XCAP-Std or XCAP-Ltd, 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\HARDLOCK\HLDINST -install
      

    3. Or, in command prompt mode, switch to the chosen installation directory:
          > CHDIR C:\XCAP\HARDLOCK
      
      and execute:
           HLDINST  -install
      
      to run the authorization key utility program.

  5. Install PIXCI® Imaging Board Driver:

    1. Under Windows 2000, the Windows' Device Manager must be used for initial installation of the PIXCI® driver.

      If the PIXCI® imaging board was not previously installed, the first time Windows starts after installation of the PIXCI® imaging board, Windows will notice the new device and inquire.

      The first time Windows 2000 starts after installation of the PIXCI® imaging board, a pop-up window with the message "Multimedia Video Controller" will flash. A window stating ''Welcome to the Found New Hardware Wizard'' appears; click ''Next'', select ''Search for the best driver for your device'', click ''Next'', check box ''Specify a location'', enter path Drivers\Win2K within the chosen installation directory, typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next''. A window reports that a driver was found, namely ...\Drivers\Win2K\EPIXXCW2.INF; click ''Next''. A window reports that Microsoft's ''Digital Signature was not found''; click ''Yes''. A window states ''Completing the Found New Hardware Wizard'' and ''This device is not configured correctly. (Code 1)'' (this error indicates that the newly installed driver will be functional only after a reboot); click ''Finish'' and restart Windows.

      If the PIXCI® imaging board was already installed, and ''Cancel'' was clicked when Windows started and announced the presence of a new ''Multimedia Video Controller'', then instruct Windows to load the appropriate driver. Click ''Start'', ''Settings'', ''Control Panel'', ''System'' (if ''System'' is not listed, click on ''View all Control Panel options''), ''Device Manager'', and under ''Other Devices'' or ''Imaging Devices'' double-click ''PCI MultiMedia Video Device'' or ''PIXCI(R) Video Capture Board''. Click ''Properties'', ''Driver'', ''Change Driver'' or ''Update Driver''. A window stating ''Welcome'' appears; click ''Next''. A window stating ''This wizard searches for updated drivers for: PCI MultiMedia Video Device'' or ''This wizard searches for updated drivers for: PIXCI(R) Video Capture Board'' appears; select ''Search for a suitable driver for my device (recommended)'', click ''Next'', select ''Specify a Location'', enter path Drivers\Win2K within the chosen installation directory, typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next'', ''Next''. A window reports that Microsoft's: ''Digital Signature was not found''; click ''Yes''. A window reports ''This device is not configured correctly. (Code 1)'' (this error indicates that the newly installed driver will be functional only after a reboot); click ''Finish'' and restart Windows.

  6. Configure Graphics Display (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 graphics display (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'', ''Settings'', ''Control Panel'', ''Display'', ''Settings''.

    2. Under ''Start'', ''Settings'', ''Control Panel'', ''Display'', ''Effects'', the ''Show window contents while dragging'' must be disabled.

  7. Reboot Windows.

  8. XCAP is now ready to run, by clicking the optional shortcut, or by clicking ''Start'', ''Programs'', ''XCAP Imaging'', and finally ''XCAP for Windows''.

 

3.4. Windows 2000 Esoterica

3.4.1. Windows 2000 - Manual Installation

Use of EPIXXCW2.INF (or EPIXXCNT.INF for version 2.0 and earlier), above, provides automatic installation of EPIXXCW2.SYS (or EPIXXCNT.SYS for version 2.0 and earlier) in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. The EPIXXCW2.SYS (or EPIXXCNT.SYS for version 2.0 and earlier) 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\EPIXXCW2  (version 2.1+)
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCNT  (version 2.0-)
    
    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\EPIXXCW2  (version 2.1+)
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCNT  (version 2.0-)
    
    This entry must contain:
        EventMessageFile = "%SystemRoot%\System32\IoLogMsg.dll"
        TypesSupported   = 0x00000007
    

  3. Shut down and restart Windows.

Under Windows 2000, the Windows NT driver EPIXXCWT.SYS can be, and was previously, used instead of EPIXXCW2.SYS. In contrast to EPIXXCWT.SYS, the EPIXXCW2.SYS is Plug & Play compatible.

3.4.2. Windows 2000 - Status Buffer Memory Allocation

Under Windows 2000 memory to maintain status on each frame buffer must be allocated during Windows' initialization.

The requested 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 memory size is specified, a default size of 32768 kBytes is used. Windows must be rebooted for the new specification to take effect.

For the PIXCI® CL3SD, which has on-board frame buffer memory, memory reserved by this parameter is needed only for support of time stamping of captured frames, such as optionally used by XCAP's Capture - Video to Frame Buffers. Currently, 64 bytes are needed for each frame buffer's status.

For systems which also use other PIXCI® imaging boards, the allocated memory is used for frame buffers; requesting a small amount of memory may limit the resolution which can be captured by other PIXCI® imaging boards.

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

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

  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.

 

3.5. For Windows XP, XP(x64)

  1. Install Files:
      .so ../softinst/insw48fi.man

  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 \ XCAPWXX
          Name:           XCAP
      
      replacing ''InstallDir'' with the name of the installation directory chosen above. Select ''OK''.

  4. Install Authorization Key (for XCAP-Plus, XCAP-Std, and XCAP-Ltd):

    1. XCAP-Plus, XCAP-Std, and XCAP-Ltd, but not XCAP-Lite, are provided with either a printer port authorization key or a USB authorization key.

      The printer port authorization key is approximately 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 any printer port. 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 printer port authorization key to a 25-pin serial (RS-232) port, or to any other interface that happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!

      The USB port authorization key is approximately the size of a small finger (6.0×1.6×0.8 cm), having a USB standard 4-pin connector at one end. If provided, connect the authorization key to a USB port. Operating system support for USB devices is required; XCAP does not add USB support to the operating system.

      The authorization key must remain attached, to the printer port or USB port as appropriate, while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus, XCAP-Std or XCAP-Ltd, 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\HARDLOCK\HLDINST -install
      

    3. Or, in command prompt mode, switch to the chosen installation directory:
          > CHDIR C:\XCAP\HARDLOCK
      
      and execute:
           HLDINST  -install
      
      to run the authorization key utility program.

  5. Install PIXCI® Imaging Board Driver:

    1. Under Windows XP or XP(x64), the Windows' Device Manager must be used for initial installation of the PIXCI® driver.

      If the PIXCI® imaging board was not previously installed, the first time Windows starts after installation of the PIXCI® imaging board, Windows will notice the new device and inquire.

      The first time Windows XP or XP(x64) starts after installation of the PIXCI® imaging board, a pop-up window with the message ''Multimedia Video Controller'' will flash. A window stating ''Welcome to the Found New Hardware Wizard'' appears; select ''Install from a list or a specific location. (Advanced)'', click ''Next'', select ''Search for the best driver in these locations'', uncheck box ''Search removable storage media'', check box ''Include this location in the search'', enter path Drivers\WinXP for Windows XP, or Drivers\WinXP64 for Windows XP(x64), within the chosen installation directory typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next''. A window reports that a driver was found, namely ...\Drivers\WinXP\EPIXXCW2.INF, Or ...\Drivers\WinXP64\EPIXXCW6.INF for Windows XP(x64), click ''Next''. A window states ''The software that you are installing for ... has not passed compatibility testing''; click ''Continue Anyway''. A window states ''Completing the Found New Hardware Wizard'' and ''The hardware you installed will not work until you restart your computer''; click ''Finish'' and restart Windows.

      If the PIXCI® imaging board was already installed, and ''Cancel'' was clicked when Windows started and announced the presence of a new ''Multimedia Video Controller'', then instruct Windows to load the appropriate driver. Click ''Start'', ''Control Panel'', ''Performance and Maintenance'', ''System'', ''Hardware'', ''Device Manager'', and under ''Other Devices'' or ''Imaging Devices'' double-click ''PCI MultiMedia Video Device'' or ''PIXCI(R) Video Capture Board'' (the latter appears if a PIXCI® imaging board driver was previously installed). Click ''Properties'', ''Driver'', ''Change Driver'' or ''Update Driver''. A ''Welcome'' window appears; select ''Install from a list or a specific location. (Advanced)'', click ''Next'', select ''Search for the best driver in these locations'', uncheck ''Search removable storage media'', check ''Include this location in the search'', enter path Drivers\WinXP for Windows XP, or Drivers\WinXP64 for Windows XP(x64), within the chosen installation directory typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next'', ''Next''. A window reports ''The software that you are installing for ... has not passed compatibility testing''; click ''Continue Anyway''. A window reports ''The hardware you installed will not work until you restart your computer''; click ''Finish'' and restart Windows.

  6. Configure Graphics Display (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 graphics display (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'', ''Settings'', ''Control Panel'', ''Display'', ''Settings''.

    2. Under ''Start Button'', ''Setting'', ''Control Panel'', ''Display'', ''Appearance'', ''Effects'', the ''Use the following transition effect for menus and toolbars:'', ''Show shadows under menus'', and ''Show window contents while dragging'' should all be disabled for maximum video performance.

  7. Reboot Windows.

  8. XCAP is now ready to run, by clicking the optional shortcut, or by clicking ''Start'', ''Programs'', ''XCAP Imaging'', and finally ''XCAP for Windows''.

 

3.6. Windows XP, XP(x64) Esoterica

3.6.1. Windows XP, XP(x64) - Manual Installation

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

  1. The EPIXXCW2.SYS for Windows XP or EPIXXCW6.SYS for Windows XP(x64) must be copied to the Windows SYSTEM32\DRIVERS directory, typically:
        C:\WINDOWS\SYSTEM32\DRIVERS
    

  2. Using the Registry Editor (REGEDIT) provided with Windows, create an entry such as:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW2
    
    for Windows XP or
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW6
    
    for Windows XP(x64). 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\EPIXXCW2
    
    for Windows XP or
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCW6
    
    for Windows XP(x64). This entry must contain:
        EventMessageFile = "%SystemRoot%\System32\IoLogMsg.dll"
        TypesSupported   = 0x00000007
    

  3. Shut down and restart Windows.

3.6.2. Windows XP, XP(x64) - Status Buffer Memory Allocation

Under Windows XP and XP(x64), memory to maintain status on each frame buffer must be allocated during Windows' initialization.

The requested 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 memory size is specified, a default size of 32768 kBytes is used. Windows must be rebooted for the new specification to take effect.

For the PIXCI® CL3SD, which has on-board frame buffer memory, memory reserved by this parameter is needed only for support of time stamping of captured frames, such as optionally used by XCAP's Capture - Video to Frame Buffers. Currently, 64 bytes are needed for each frame buffer's status.

For systems which also use other PIXCI® imaging boards, the allocated memory is used for frame buffers; requesting a small amount of memory may limit the resolution which can be captured by other PIXCI® imaging boards.

Windows XP and XP(x64), limits the maximum amount of allocatable memory, dependent upon what other devices are installed, the total computer memory size, and other factors.

3.6.3. Windows XP, XP(x64) - Authorization Key - Manual Installation

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

  1. The file HARDLOCK.SYS must be copied to the Windows SYSTEM32\DRIVERS directory, typically:
        C:\WINDOWS\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.

 

3.7. For Windows Vista, Vista(x64)

  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. The default installation directory is C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP.

    2. If XCAP is provided on a compact disk (CD):

      1. If your computer 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. The default installation directory is C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP.

    3. If XCAP is provided via the internet:

      1. Download:
        ftp.epixinc.com/software/xcap_v30/XCAPWIN32.EXE (for 32 bit Windows)
        
        from the EPIX, Inc. ftp site.

      2. Execute the downloaded program, from a command prompt, or via the Windows ''Start'', ''Run'':
        > XCAPWIN32.EXE     (for 32 bit Windows)
        > XCAPWIN64.EXE     (for 64 bit Windows)
        

      3. Follow the installation program's directions, such as to select an installation directory. The default installation directory is C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP.

      4. Delete the downloaded .EXE file from your computer'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. The PCITIPS.TXT file provides the PC Configuration Tips, with 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 \ XCAPWXX
          Name:           XCAP
      
      replacing ''InstallDir'' with the name of the installation directory chosen above. Select ''OK''.

  4. Install Authorization Key (for XCAP-Plus, XCAP-Std, and XCAP-Ltd):

    1. XCAP-Plus, XCAP-Std, and XCAP-Ltd, but not XCAP-Lite, are provided with either a printer port authorization key or a USB authorization key.

      The printer port authorization key is approximately 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 any printer port. 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 printer port authorization key to a 25-pin serial (RS-232) port, or to any other interface that happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!

      The USB port authorization key is approximately the size of a small finger (6.0×1.6×0.8 cm), having a USB standard 4-pin connector at one end. If provided, connect the authorization key to a USB port. Operating system support for USB devices is required; XCAP does not add USB support to the operating system.

      The authorization key must remain attached, to the printer port or USB port as appropriate, while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus, XCAP-Std or XCAP-Ltd, 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\HARDLOCK\HLDINST -install
      

    3. Or, in command prompt mode, switch to the chosen installation directory:
          > CHDIR C:\XCAP\HARDLOCK
      
      and execute:
           HLDINST  -install
      
      to run the authorization key utility program.

  5. Install PIXCI® Imaging Board Driver:

    1. Under Windows Vista or Vista(x64), the Windows' Device Manager must be used for initial installation of the PIXCI® driver, and your user account must have administrative privileges.

      If the PIXCI® imaging board was not previously installed, the first time Windows starts after installation of the PIXCI® imaging board, Windows will notice the new device and inquire.

      The first time Windows Vista or Vista(x64) starts after installation of the PIXCI® imaging board, a window titled ''Found New Hardware'' appears. Select ''Locate and install driver software (recommended)'', click ''Continue'', select ''I don't have the disk. Show me other options'', select ''Browse my computer for driver (advanced)'', enter path Drivers\WinVS for Windows Vista, or Drivers\WinVS64 for Windows Vista(x64), within the chosen installation directory typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next''. A window asks ''Would you like to install this device software?''; click ''Install''. A window reports ''The software for this device has been successfully installed'' and ''The hardware you installed will not work until you restart your computer''; click ''Finish'' and restart Windows.

      If the PIXCI® imaging board was already installed, and ''Ask me again later'' or ''Don't show this message again for this device'' was clicked when Windows started and announced the presence of a new ''Multimedia Video Controller'', then instruct Windows to load the appropriate driver. Click ''Start'', ''Control Panel'', ''System and Maintenance''. Select ''Device Manager'' and under ''Other Devices'' or ''Imaging Devices'' double-click ''PCI MultiMedia Video Device'' or ''Coprocessor'' or ''PIXCI(R) Video Capture Board'' (the former two may appear if a PIXCI® driver was never installed, otherwise the latter appears). A ''Properties'' window appears; click ''Driver'' (tab), and ''Update Driver''. An ''Update Driver Software'' window appears; select ''Browse my computer for driver (advanced)'', enter path Drivers\WinVS for Windows Vista, or Drivers\WinVS64 for Windows Vista(x64), within the chosen installation directory typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next''. A window asks ''Would you like to install this device software?''; click ''Install''. A window reports ''The software for this device has been successfully installed'' and ''The hardware you installed will not work until you restart your computer''; click ''Finish'' and restart Windows.

  6. Configure Graphics Display (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 graphics display (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'', ''Settings'', ''Control Panel'', ''Display'', ''Settings''.

    2. Under ''Start Button'', ''Setting'', ''Control Panel'', ''Display'', ''Appearance'', ''Effects'', the ''Use the following transition effect for menus and toolbars:'', ''Show shadows under menus'', and ''Show window contents while dragging'' should all be disabled for maximum video performance.

  7. Reboot Windows.

  8. XCAP is now ready to run, by clicking the optional shortcut, or by clicking ''Start'', ''Programs'', ''XCAP Imaging'', and finally ''XCAP for Windows''.

    The Driver Assistant feature within XCAP simplifies configuration of the PIXCI® imaging board's driver. Under Windows Vista and Vista(x64), such a feature must have administrator privileges. To run XCAP once with administrator privilege, right click on its shortcut or on the ''XCAP for Windows'' and select ''Run as administrator''. To always run XCAP with administrator privilege, right click on its shortcut or on the ''XCAP for Windows'' and select ''Properties'', ''Shortcut'', ''Run as administrator'', and ''OK''.

 

3.8. Windows Vista, Vista(x64) Esoterica

3.8.1. Windows Vista, Vista(x64) - Manual Installation

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

  1. The EPIXXCW2.SYS for Windows Vista or EPIXXCW6.SYS for Windows Vista(x64) SYSTEM32\DRIVERS directory, typically:
        C:\WINDOWS\SYSTEM32\DRIVERS
    

  2. Using the Registry Editor (REGEDIT) provided with Windows, create an entry such as:
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW2
    
    for Windows Vista or
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW6
    
    for Windows Vista(x64). 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\EPIXXCW2
    
    for Windows Vista or
        HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCW6
    
    for Windows Vista(x64). This entry must contain:
        EventMessageFile = "%SystemRoot%\System32\IoLogMsg.dll"
        TypesSupported   = 0x00000007
    

  3. Shut down and restart Windows.

3.8.2. Windows Vista, Vista(x64) - Status Buffer Memory Allocation

Under Windows Vista and Vista(x64), memory to maintain status on each frame buffer must be allocated during Windows' initialization.

The requested 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 memory size is specified, a default size of 32768 kBytes is used. Windows must be rebooted for the new specification to take effect.

For the PIXCI® CL3SD, which has on-board frame buffer memory, memory reserved by this parameter is needed only for support of time stamping of captured frames, such as optionally used by XCAP's Capture - Video to Frame Buffers. Currently, 64 bytes are needed for each frame buffer's status.

For systems which also use other PIXCI® imaging boards, the allocated memory is used for frame buffers; requesting a small amount of memory may limit the resolution which can be captured by other PIXCI® imaging boards.

Windows Vista and Vista(x64), limits the maximum amount of allocatable memory, dependent upon what other devices are installed, the total computer memory size, and other factors.

3.8.3. Windows Vista, Vista(x64) - Authorization Key - Manual Installation

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

  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.

 

3.9. For Linux

XCAP requires Linux Kernel Version 2.4.8 or later. You must have super user privileges to complete the installation procedure.

  1. Install Files:

    1. If XCAP is provided on a compact disk (CD):

      1. Assuming the CD has already been mounted, execute:
        /mnt/cdrom/XCAP/xcaplnx_i386.bin     (for 32 bit Linux)
        /mnt/cdrom/XCAP/xcaplnx_x86_64.bin   (for 64 bit Linux)
        
        Some systems mount the CD under /media instead of /mnt.

      2. Follow the installation program's directions, such as to select an installation directory. The default installation directory is /usr/local/xcap.

    2. If XCAP is provided via the internet:

      1. Download:
        ftp.epixinc.com/software/xcap_v30/xcaplnx_i386.bin    (for 32 bit Linux)
        ftp.epixinc.com/software/xcap_v30/xcaplnx_x86_64.bin  (for 64 bit Linux)
        
        from the EPIX, Inc. ftp site.

      2. Execute the downloaded program[5] from a shell prompt.

      3. Follow the installation program's directions, such as to select an installation directory. The default installation directory is /usr/local/xcap.

      4. Delete the downloaded .bin file from your computer's hard drive.

    3. The installation procedure creates a ''stub'' to start XCAP in one of the /usr/local/bin, /usr/bin, or /bin directories, which should already be in the user's execution ''PATH''. Several .txt files are installed under help in the installation directory containing these installation instructions, a list of distributed files, corrections or additions to this manual, or other up-to-date information. The pcitips.txt file provides the PC Configuration Tips, with tips for resolving hardware and software conflicts.

  2. Create Shortcut - Manual (optional):

    1. The procedure to create a ''launcher'' or ''shortcut'' on the desktop depends upon which of the many rapidly evolving versions and distributions of Linux is used, each with several choices for desktop managers. Consult your Linux documentation for specific procedures.

    2. The shortcut should execute xcaplnx in the XCAP installation directory, such as:
          /usr/local/xcap/xcaplnx
      
      assuming use of the default installation directory, and may use:
          /usr/local/xcap/program/xcap20.png
      
      as an icon.

    3. For shared, common XCAP settings and configuration, and shared default storage of images, scripts and other data,[6] the shortcut should set the current working directory to the XCAP installation directory.

      Alternately, XCAP will maintain individual settings and configuration, and individual default storage of images, scripts and other data, within the current working directory.

  3. Install Authorization Key (for XCAP-Plus, XCAP-Std, and XCAP-Ltd):

    1. XCAP-Plus, XCAP-Std, and XCAP-Ltd, but not XCAP-Lite, are provided with either a printer port authorization key or a USB authorization key.

      The printer port authorization key is approximately 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 any printer port. 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 printer port authorization key to a 25-pin serial (RS-232) port, or to any other interface that happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!

      The USB port authorization key is approximately the size of a small finger (6.0×1.6×0.8 cm), having a USB standard 4-pin connector at one end. If provided, connect the authorization key to a USB port. Operating system support for USB devices is required; XCAP does not add USB support to the operating system.

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

    2. The Driver Assistant within XCAP, provides interactive installation of the authorization key's driver(s).

  4. Install PIXCI® Imaging Board Driver:

    1. The Driver Assistant within XCAP, provides interactive installation of the PIXCI® driver.

  5. Configure Graphics Display (S/VGA):

    1. Configuring the graphics display (S/VGA) to TrueColor or DirectColor modes (using XWindows terminology), or to 24 or 32 bit modes (using S/VGA terminology) is suggested for higher quality, and quicker display of images and overlay graphics.

      Within XCAP, the current graphics display (S/VGA) configuration can be checked under Utility, Linux Info, X11.

  6. XCAP is now ready to run, by executing ''xcap'', or by clicking the optional shortcut.

 

3.10. Linux Esoterica

3.10.1. Linux 2.4.x - Manual Installation

Use of the Driver Assistant within XCAP provides interactive installation of the pixci_i386.o driver in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. Run
        insmod -o pixci [ --force ] pixci_i386.o [ "PIXCIPARM=<driver_config_parameters>" ]
    
    using --force if trying to install the driver under a different kernel than it was intended, and using PIXCIPARM= to specify any optional Driver Configuration Parameters described below. For example,
        insmod -o pixci [ --force ] pixci_i386.o "PIXCIPARM=-IM 8192"
    

  2. Run
        cat /proc/devices
    
    and note the major device number which is assigned to the pixci block device. Run
        rm -f /dev/pixci
        mknod /dev/pixci c <major_device_number> 0
        chmod 666 /dev/pixci
    
    If embedding these commands into a shell script:
        rm -f /dev/pixci
        mknod /dev/pixci c $(awk "\\$2==\"PIXCI(R)\" {print \\$1}" /proc/devices) 0
        chmod 666 /dev/pixci
    

  3. For PIXCI® SV2, SV3, SV4, SV5, SV5A, and SV5B imaging boards, drivers other than those provided by EPIX, Inc. may have been installed during Linux's configuration. See http://will.freehosting.net/bttv-HOWTO.html, section 5.1 for information on removing the drivers. In brief, use
        lsmod
    
    for a list of currently installed modules and remove any named videodev, i2c, i2c-char, tuner, msp3400, bt878, or bttv by using rmmod.

3.10.2. Linux 2.6.x - Manual Installation

Use of the Driver Assistant within XCAP provides interactive installation of the pixci_i386.ko 32 bit driver or the pixci_x86_64.ko 64 bit driver in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.

  1. Run
        insmod pixci_i386.ko [ "PIXCIPARM=<driver_config_parameters>" ]
    
    or
    insmod pixci_x86_64.ko [ "PIXCIPARM=<driver_config_parameters>" ]
    
    using PIXCIPARM= to specify any optional Driver Configuration Parameters described below. For example,
        insmod pixci_i386.ko "PIXCIPARM=-IM 8192 -DM 1"
    
    or
    insmod pixci_x86_64.ko "PIXCIPARM=-IM 8192 -DM 1"
    
    Some versions of insmod under 2.6 kernels do not accept quoted spaces in the Driver Configuration Parameters; an underscore (i.e. ''_'') may be used instead of each space. For example,
        insmod pixci_i386.ko PIXCIPARM=-IM_8192_-DM_1
    

  2. Run
        cat /proc/devices
    
    and note the major device number which is assigned to the pixci block device. Run
        rm -f /dev/pixci
        mknod /dev/pixci c <major_device_number> 0
        chmod 666 /dev/pixci
    
    If embedding these commands into a shell script:
        rm -f /dev/pixci
        mknod /dev/pixci c $(awk "\\$2==\"PIXCI(R)\" {print \\$1}" /proc/devices) 0
        chmod 666 /dev/pixci
    

  3. For PIXCI® SV2, SV3, SV4, SV5, SV5A, and SV5B imaging boards, drivers other than those provided by EPIX, Inc. may have been installed during Linux's configuration. See http://will.freehosting.net/bttv-HOWTO.html, section 5.1 for information on removing the drivers. In brief, use
        lsmod
    
    for a list of currently installed modules and remove any named videodev, i2c, i2c-char, tuner, msp3400, bt878, or bttv by using rmmod.

3.10.3. Linux 2.4.x, 2.6.x - Status Buffer Memory Allocation

Under Linux, memory to maintain status on each frame buffer must be allocated during Linux' initialization.

The requested frame buffer memory size must be specified in the Driver Configuration Parameters, described above, using parameter

    "-IM <memorysize>"
replacing the ''<memorysize>'' with the desired memory size in kBytes. If no frame buffer memory size is specified, a default size of 4096 kBytes is used.

For the PIXCI® CL3SD, which has on-board frame buffer memory, memory reserved by this parameter is needed only for support of time stamping of captured frames, such as optionally used by by XCAP's Capture - Video to Frame Buffers. Currently, 64 bytes are needed for each frame buffer's status.

For systems which also use other PIXCI® imaging boards, the allocated memory is used for frame buffers; requesting a small amount of memory may limit the resolution which can be captured by other PIXCI® imaging boards.

Linux limits the maximum amount of allocatable memory, dependent upon what other devices are installed, the total computer memory size, and other factors.

3.10.4. Linux 2.4.x, 2.6.x - Authorization Key - Manual Installation

Use of the Driver Assistant within XCAP, provides interactive installation of the authorization key's driver(s). For manual installation, correcting problems, or integration with an OEM's procedures, installation instructions are provided in text file hardlock/INSTALL within the XCAP installation directory.

 

3.11. PIXCI® Driver Esoterica

The various Driver Configuration Parameters for all operating systems are summarized below. Included are options for use under DOS; while XCAP does not run under DOS, XCAP is used as a support tool for programming the PIXCI® imaging board under DOS.

The Driver Configuration Parameter string may contain any of the following parameters, separated by spaces, in any order. Each parameter's flag is followed by a number, whose value is interpreted as hexadecimal if preceded by ''0x'' or ''0X'', octal if preceded by ''0o'' or ''0O'', binary if preceded by ''0b'' or ''0B'', and is otherwise interpreted as decimal.


-BH n
If ≠0, the amount of memory space, in kByte, directly below the 4 GByte address which overlaps other hardware resources such as BIOS, memory mapped I/O, PCI configuration space, etc. and is unavailable to either the operating system or for use as frame buffers.[7] The usable frame buffer memory is therefore reduced by the amount by which the -IA address up to the -IA address plus -IM size overlap the 4 GByte address minus -BH size up to the 4 GByte address. Only used with forceful image frame buffer allocation, under Windows NT, 2000, XP, XP(x64), Vista, Vista(x64), Linux 32 Bit, and Linux 64 Bit. Default: 0.
-DM n
A bit map selecting which of the PIXCI® imaging boards present should be used. The i'th bit of the bit-map selects the i'th board found, sequentially, on the PCI bus. The relationship between bit i and the order of motherboard slots is motherboard, BIOS, and OS dependent and can not be specified or queried via XCAP.

For example, 0x01 selects the first board, 0x04 selects the third board, and 0b1001 selects the first and fourth board. For the PIXCI® E1DB, E4DB, and EL1DB imaging boards which contain multiple, independent functional units within a single physical board, each functional unit is handled as an independent imaging board except that the second half of the PIXCI® E1DB, E4DB, or EL1DB imaging board can not be opened without the first half also opened; 0b1101 selects the first half of the first physical PIXCI® E1DB, E4DB, or EL1DB imaging board and both halves of the second physical PIXCI® E1DB, E4DB, or EL1DB. Default: 1.

-IA n
If ≠0, the physical address of memory, in kByte, at which image frame buffers are assumed to start. Only used with forceful image frame buffer allocation, under Windows 95, 98, ME, NT, 2000, XP, XP(x64), Vista, Vista(x64), Linux 32 Bit, and Linux 64 Bit. Default: 0.
-IM n
Requested size, in kByte, to be reserved for the entire image frame buffer memory. Default: 32768 kByte under Windows NT, 2000, XP, and Vista, 32768 kByte under Windows XP(x64), Vista(x64), and Linux 64 Bit, 4096 kByte for others.

For the PIXCI® CL3SD which has on-board frame buffer memory, memory reserved by this parameter is needed only for support of recording frame buffer status. Currently, 64 bytes are needed for each frame buffer's status. Default: 4096 kByte.

-I2C n
Bit rate of the I2C or other two wire serial bus used within some PIXCI® imaging boards. Specifies an upper bound for the bit rate; actual bit rate is dependent on PC characteristics and is typically slower. Value of 0 selects predefined, board-dependent, default values.

Particularly useful for use with SILICON VIDEO® 2112(C), 1310(C), 1281(C), 9M001(C), 9T001, and 642(C) cameras; these SILICON VIDEO® camera heads use a I2C or similar two wire serial bus to control camera head features.

Does not affect the serial baud rate of Camera Link compatible imaging boards.

Default: 0.

-LX n
If bit 0x20 is set, a high resolution kernel timer (''do_gettimeofday'') is used for time stamping video events instead of ''jiffies'' and ''HZ''; however, the high resolution timer incurs additional overhead. Only used with Linux 32 Bit and Linux 64 Bit.

If bit 0x80 is set, frame buffer memory below 4 GByte is requested; this allows use of 32 bit PCI cards on 64 bit systems with more than 4 GByte of memory. Option is quietly ignored for kernels that don't support the necessary feature(s).

Other bits to be described. Default: 0.

-MB n
If ≠0, the image frame buffer memory, of size specified by ''-IM'', is split into partitions of this size, in kByte. Depending on operating system and ''-IA'' parameters, this may imply that each partition is individually allocated, so that a larger, total amount of memory can be allocated. Or that the contiguous memory is treated as individual partitions for the sake of the operating system and processor's virtual memory management, which could not otherwise ''map'' the entire frame buffer memory at once. In either case, (a) A single frame buffer can't extend across partitions, (b) The partition size should be a multiple of the frame buffer size so as to maximize the number of buffers and minimize wasted space, and (c) A maximum of 256 partitions is supported. Default: 0.
-MH n
If ≠0, the amount of lower memory, in kByte, to pass over before allocating the requested image frame buffer memory. This may be necessary for use with some graphics display (S/VGA) or network interface cards which, a) May be allocating memory later than the PIXCI driver, and b) May require memory with lower addresses. Only used with non-forceful image frame buffer allocation, under Windows NT, 2000, XP, XP(x64), Vista, and Vista(x64). Default: 0 kByte under Windows NT, 2000, XP, and Vista; 512 kByte under Windows XP(x64) and Vista(x64).
-MO n
To be described. Default: 0.
-MU n
If bit 0x01 is not set, the frame buffer memory is not mapped directly into the application's address space. If bit 0x02 is set, the frame buffer memory is not permanently mapped into the driver's address space. These options minimize use of the operating systems memory management resources, but may increase overhead in accessing frame buffer memory. These options are typically required when using very large amounts of frame buffer memory (typically, more than 1 or 2 GByte under Windows NT, 2000, XP, Windows NT, 2000, XP, XP(x64), Vista, and Vista(x64) or more than a few hundred MByte under Windows 95/98/ME), but are not currently supported for all Video Format Configurations.

If bit 0x04 is not set, the frame buffer memory is not cleared after allocation, minimizing delay, particularly when using several GBytes of frame buffer memory.

Default: 1.

-PO n
If ≠0, the polling period, in µseconds, for driver features that are not driven by an interrupt. Ignored under Tenberry DOS4GW DOS extender. Default: 5000 µseconds.
-QP n
If ≠0, an assigned auxiliary interrupt number (not IRQ number!) within Tenberry's range of auto pass-up interrupts: 0x08 to 0x2E. Only used with the Tenberry DOS4GW DOS extender. Default: 0.
-QS n
If ≠0, allow sharing the imaging boards' assigned hardware interrupt with other devices. Ignored under Tenberry DOS4GW DOS extender and Linux. Default: 1.
-QU n
If ≠0, utilize the imaging boards' hardware interrupts. For PIXCI® A, CL1, CL2, CL3SD, D, D24, D32, D2X, D3X, E1, E1DB, E4, E4DB, EC1, EL1, EL1DB, SI, SI4, SV4, SV5, SV5A, and SV5B imaging boards, the interrupt may be disabled if the polling period (-PO) is small relative to a field's period. For PIXCI® SV2 and SV3, disabling the interrupt will adversely affect all capture modes other than snap. For PIXCI® D, D24, D32, the interrupt may be disabled only if the interrupt is not shared. For all PIXCI® imaging boards operated under Tenberry DOS4GW DOS extender, use of hardware interrupts is required. Disabling use of interrupts is intended primarily for diagnosing interrupt conflicts, and is not recommended. Default: 1.
-SM n
Total amount of memory, in kByte, on the computer system. This parameter and value is currently ignored by the PIXCI® driver, but used by XCAP's Driver Assistant in conjunction with -IM and -IA to note the ''context'' under which the -IM and -IA values were set.

Default: 0.

-XM n
If ≠0, reserve the proportionate share of image frame buffer memory for imaging boards not opened by the first application, for use with other imaging boards opened later. If 0, all image frame buffer memory is shared amongst the imaging boards opened by the first application. Affects PIXCI® imaging boards other than CL3SD, which has on-board frame buffer memory. Default: 1.
-SV5 n
Setting bit 0x02 enables compatibility with 430FX PCI controllers. Setting bit 0x04 enables compatibility with VIA/SIS PCI controllers. Only used with PIXCI® SV5. Default: 0.
-WT n
If bits 0x05 are set to 0x01 or to 0x05, alternate methods of Windows NT resource allocation are used, avoiding problems seen on some motherboards where the same resources are assigned to multiple imaging boards. Only used with Windows NT.

If bit 0x20 is set, a high resolution kernel timer is used for time stamping video events. Windows documentation states that use of this timer incurs additional overhead. Only used with Window NT, 2000, XP, XP(x64), Vista, and Vista(x64).

If bit 0x80 is set, frame buffer memory below 4 GByte is requested; this allows use of 32 bit PCI cards on 64 bit systems with more than 4 GByte of memory.

Other bits to be described. Default: 0x20.

-XU n
If ≠0, allow other applications to share use of imaging boards previously opened for use by the first application. Supported under Windows NT, 2000, XP, XP(x64), Vista, and Vista(x64): Default: 1. Under other systems: Default: 0.

 

 

 

4. Getting Started with XCAP

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 is not intended to discuss every feature of every window in XCAP, only the most important features to ''get up and running''.

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, XCAP-Std, or XCAP-Ltd, but not XCAP-Lite, the authorization key has been installed on the printer port, or a USB port.

  5. Under Windows, the graphics display (S/VGA) has been set for 16 bits (minimum required), or 24 or 32 bits (preferred), per pixel. Under Linux, the graphics display has been set to DirectColor or TrueColor.

  6. The PIXCI® driver for current version of Windows or Linux has been installed.

  7. The PC has been rebooted (Ctrl+Alt+Del) so that the installed driver and the modified graphics display (S/VGA) settings (if any) have taken effect.

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

 

4.1. Start XCAP

Under Windows, start XCAP by clicking:

    Start (on the Windows Taskbar)
    XCAP Imaging
and then clicking:
    XCAP for Windows
Under Linux, start XCAP by executing:
    xcap

The XCAP Main Window now appears.

 

4.2. Open PIXCI® Imaging Board

In the XCAP Main Window, click:

    PIXCI®
    PIXCI® Open/Close
A pop-up window appears.

Clicking:

    Open
opens the PIXCI® imaging board for use, removes the Open/Close pop-up window, creates a PIXCI® Image Viewer window showing the first PIXCI® frame buffer, creates an Adjust window with commonly used camera specific 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 independent of 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, with a status bar below the image where cursor coordinates and other information is displayed.

  3. The PIXCI® Shortcut Toolbar, with shortcuts for the most commonly needed features relating to the PIXCI® imaging board and its frame buffers.

  4. An Adjust window, with commonly used camera specific and video capture adjustments.

If XCAP has already been installed, it may have been configured with one or more variations, such as, (a) Eliminate the Main Window, automatically opening and displaying the PIXCI® Image Viewer, (b) Configure the Shortcuts and/or Adjust features to be attached to The PIXCI® Image Viewer window, rather than detached into their own windows, (c) Select whether the Shortcuts and/or Adjust features appear automatically, or only when

    Capture
    Adjustments
or
    Capture
    Shortcuts
are clicked, or (d) Remove the status bar, increasing the screen area available for image display. These variations allow custom configuration of XCAP, but do not affect the functionality of the Shortcuts or Adjustments features.

 

4.3. PIXCI® CL3SD Video Configuration

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

 

4.4. Capturing Images

Once the PIXCI® imaging board is opened for use, images may be captured from the PIXCI® Image Viewer, by 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 graphics display (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
which may be incremented or decremented at any time, whether in Live or UnLive mode. The window reached by clicking:
    Capture
    Adjustments
has convenient buttons that 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 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 (Image Pixel = Display Pixel)
Each image pixel is now displayed as exactly one graphics display (S/VGA) pixel. Of course, depending upon the image resolution, graphics display (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 (Image Pixel = Display Pixel)
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 selected line (column) of the image 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. PIXCI® CL3SD & Basler A500k Video & Camera Adjustments

XCAP provides two styles of camera and camera adjustments. The simpler style provides fewer, selected, integrated controls that is sufficient for many common applications. The advanced style provides all camera and PIXCI® CL3SD controls, but assumes more familiarity with the camera and PIXCI® CL3SD specifications and features.

4.6.1. PIXCI® CL3SD & Basler A500k Simple Video & Camera Adjustments


The Preview/Live button allows activating live video for focusing and exposure adjustments, or freezing live video capture, and duplicate the Live, and UnLive in the Shortcuts Toolbar.

The Exposure and Frame Rate allow adjusting the camera's exposure and frame rate; A faster Frame Rate and thus a shorter frame period automatically reduces the Exposure, as needed, to be no larger than the frame period. A slower Frame Rate and thus a longer frame period automatically adjusts the Exposure to the maximum permissible only if Max Exposure per Frame Rate is checked; some applications prefer the longest possible exposure for a given frame rate to increase sensitivity, other applications select a shorter exposure to help ''freeze'' motion.

The Dig(ital) Gain allows increasing the camera gain by multiplying each pixel's value by one, two, four, or eight. The Offset allows adjusting the camera's offset, or black level, so that black areas don't appear as grey; it is often needed in conjunction with Dig(ital) Gain.

The Set Video AOI button allows reducing the video resolution (the number of pixels captured per line and column) and allows capturing more video frames in a given size of frame buffer memory. Reducing the resolution also allows higher frame rates. After clicking Set Video AOI, draw the new desired area to be captured by right clicking and dragging over the displayed image. Click:

    OK
to accept the new capture resolution. Note: Changing the capture resolution will destroy any images previously captured in the frame buffers!

The Max Video AOI button restores the video resolution to the camera's maximum.

For color cameras, the White Balance button adjusts the white balance correction; the camera should be pointed at a white target before the button is clicked. Use of quality, non-reflective, non-fluorescent, white target is suggested, rather than a white piece of paper.

The Clear Buffers button sets all frame buffers to white.

The Trigger Mode allows selecting the desired sequence capture mode. In Free Run, sequence capture starts when the Record button is clicked. In Continuous Run, sequence capture starts when the Record button is clicked and runs continuously until the Cancel button (square icon) is clicked.

In Ext. Start Event, sequence capture is armed when the Record button is clicked and is started by the next trigger. The Delayed Trigger allows delaying the start of sequence capture after application of the trigger.

In Ext. Stop Event, sequence capture is armed when the Record button is clicked and is stopped by the next trigger. The Pretrigger allows delaying the termination of sequence capture after application of the trigger. A Pretrigger of 50% results in half of the captured images predating the trigger and half postdating the trigger.

In Ext. Image Trigger sequence capture is armed when the Record button is clicked and each image of the sequence captured upon application of the trigger.

All sequence capture modes can be prematurely terminated by the Cancel button (square icon).

After sequence capture, the Play button (right-arrow icon) allows playi