Active silicon Phoenix User manual

Artisan Technology Group is your source for quality

new and certied-used/pre-owned equipment

• FAST SHIPPING AND

DELIVERY

• TENS OF THOUSANDS OF

IN-STOCK ITEMS

• EQUIPMENT DEMOS

• HUNDREDS OF

MANUFACTURERS

SUPPORTED

• LEASING/MONTHLY

RENTALS

• ITAR CERTIFIED

SECURE ASSET SOLUTIONS

SERVICE CENTER REPAIRS

Experienced engineers and technicians on staff

at our full-service, in-house repair center

WE BUY USED EQUIPMENT

Sell your excess, underutilized, and idle used equipment

We also offer credit for buy-backs and trade-ins

www.artisantg.com/WeBuyEquipment

REMOTE INSPECTION

Remotely inspect equipment before purchasing with

our interactive website at www.instraview.com

LOOKING FOR MORE INFORMATION?

Visit us on the web at www.artisantg.com for more

information on price quotations, drivers, technical

specications, manuals, and documentation

View

Instra

PHOENIX

USER MANUAL

Active Silicon

v1.6 14-Sep-2010

Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Revision History

Version Comments

v1.0 14-Oct-2005 First Release.

v1.1 25-Oct-2005 Updated the Acquisition Trigger Control section.

v1.2 28-Mar-2007 Added PCI Express boards. Added block diagrams to Camera Control section.

v1.3 2-May-2008 Added PoCL LED section.

v1.4 16-Jul-2008 Updated some example code.

v1.5 05-Jan-2010 Updated Phoenix board overview. New US address.

v1.6 14-Sep-2010 New US address.

Disclaimer

While every precaution has been taken in the preparation of this manual, Active Silicon assumes no responsibility

for errors or omissions. Active Silicon reserves the right to change the specification of the product described within

this manual and the manual itself at any time without notice and without obligation of Active Silicon to notify any

person of such revisions or changes.

reproduced, transmitted, transcribed, stored in any electronic medium or machine readable form, or translated into

any language or computer language without the prior written consent of Active Silicon.

Trademarks

All trademarks and registered trademarks are the property of their respective owners.

Part Information

Part Number: PHX-MAN-USER

Version v1.6 14-Sep-2010

Contact Details

Web

Sales

Support

www.activesilicon.com

[email protected]

Europe:

Active Silicon Limited

Pinewood Mews, Bond Close, Iver,

Bucks, SL0 0NA, UK.

Tel: +44 (0)1753 650600

Fax: +44 (0)1753 651661

North America:

Active Silicon, Inc.

479 Jumpers Hole Road, Suite 301

Severna Park, MD 21146, USA

Tel +1 410-696-7642

Fax +1 410-696-7643

v1.6 14-Sep-2010

Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Phoenix User Manual Introduction v

Table of Contents

Introduction................................................................................................................................................................... 1

Scope......................................................................................................................................................................... 1

Document Structure .................................................................................................................................................. 1

Documentation Overview ............................................................................................................................................. 2

GETTING STARTED .............................................................................................................................................. 2

FRAME GRABBER DATASHEETS ...................................................................................................................... 2

HARDWARE MANUALS....................................................................................................................................... 3

SOFTWARE MANUALS ........................................................................................................................................ 3

Phoenix Board Overview .............................................................................................................................................. 4

VARIANTS AND FORM FACTORS...................................................................................................................... 4

FEATURE LIST ....................................................................................................................................................... 4

THE THREE LEDs (1, 2, 3) ..................................................................................................................................... 5

THE PoCL LEDs (4, 5)............................................................................................................................................. 5

BLOCK DIAGRAM ................................................................................................................................................. 6

SDK Overview............................................................................................................................................................ 10

SDK Examples............................................................................................................................................................ 11

INITIALISING THE PHOENIX BOARD ............................................................................................................. 11

PCI BANDWIDTH MEASUREMENT ................................................................................................................. 11

SINGLE ACQUISITION WITH FILE SAVE ....................................................................................................... 11

LIVE ACQUISITION............................................................................................................................................. 11

BUFFER CONTROL.............................................................................................................................................. 12

IMAGE CONVERSION......................................................................................................................................... 12

SERIAL I/O ............................................................................................................................................................ 12

LUT CONTROL ..................................................................................................................................................... 12

TRIGGER CONTROL............................................................................................................................................ 12

MISCELLANEOUS ............................................................................................................................................... 12

Phoenix Board Control................................................................................................................................................ 13

CONFIGURING PHOENIX................................................................................................................................... 13

Camera handle..................................................................................................................................................... 13

Phoenix Configuration File ................................................................................................................................. 13

Configuration Options......................................................................................................................................... 13

Error Handler ...................................................................................................................................................... 14

Examples............................................................................................................................................................. 14

CAMERA TAP CONFIGURATION ..................................................................................................................... 15

Single tap............................................................................................................................................................. 15

v1.6 14-Sep-2010

Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Phoenix User Manual Introduction vi

Dual horizontal taps.............................................................................................................................................15

Dual horizontal and dual vertical taps .................................................................................................................16

SDK Concepts .............................................................................................................................................................17

USING THE PHX_CACHE_FLUSH PARAMETER............................................................................................17

PHOENIX ERROR HANDLING ...........................................................................................................................17

Error Status Codes...............................................................................................................................................17

Error Information.................................................................................................................................................19

Error Handler Function........................................................................................................................................19

Decoding Error Codes .........................................................................................................................................19

I/O PORT ACCESS ................................................................................................................................................20

Absolute / Relative I/O Port Access ....................................................................................................................20

etPhxIoMethod for I/O Port Access ....................................................................................................................20

Examples .............................................................................................................................................................21

HOW TO USE THE DISPLAY LIBRARY............................................................................................................21

Speed and data rate issues ...................................................................................................................................21

Double Buffering.................................................................................................................................................22

Display buffer destinations..................................................................................................................................22

PHX_EVENTCOUNT / PHX_EVENTCOUNT_AT_GATE ................................................................................23

HOW TO CREATE A SMALLER EXECUTABLE BY LINKING FIRMWARE OBJECT FILES ....................23

Phoenix Firmware Object Files ...........................................................................................................................23

Extract the Firmware Object File(s) ....................................................................................................................24

Link the Application to the Required Firmware Object File(s)...........................................................................24

Camera Control ...........................................................................................................................................................26

EXPOSURE CONTROL.........................................................................................................................................26

Exposure Control Output Signals ........................................................................................................................26

Exposure Control Methods..................................................................................................................................27

Exposure Control Output Block Diagram ...........................................................................................................27

Exposure Control Internal Timers .......................................................................................................................28

Initiating an Exposure..........................................................................................................................................28

Exposure Trigger Block Diagram........................................................................................................................29

ACQUISITION TRIGGER CONTROL .................................................................................................................30

External Trigger Source.......................................................................................................................................30

Acquisition Trigger Block Diagram ....................................................................................................................31

Internal Control ...................................................................................................................................................31

LINE SCAN CONTROL ........................................................................................................................................32

Acquisition Control .....................................................................................................................................................33

USING A CALLBACK ..........................................................................................................................................33

Implementation ....................................................................................................................................................33

v1.6 14-Sep-2010

Artisan Technology Group - Quality Instrumentation ... Guaranteed | (888) 88-SOURCE | www.artisantg.com

Phoenix User Manual Introduction vii

Example .............................................................................................................................................................. 34

SEQUENCE CONTROL........................................................................................................................................ 35

Examples............................................................................................................................................................. 36

HOW PHOENIX USES MEMORY BUFFERS..................................................................................................... 37

Internal Memory.................................................................................................................................................. 37

Retrieving the Buffer Details .............................................................................................................................. 37

Virtual Memory................................................................................................................................................... 37

Physical Memory ................................................................................................................................................ 38

IMAGE CORRUPTION (FIFO OVERFLOW)...................................................................................................... 39

Image Slip ........................................................................................................................................................... 39

Severe Image Corruption .................................................................................................................................... 40

Image Control ............................................................................................................................................................. 42

IMAGE DATA CONTROL.................................................................................................................................... 42

Camera image data .............................................................................................................................................. 42

Destination buffer ............................................................................................................................................... 43

LOOK-UP TABLE CONTROL ............................................................................................................................. 44

LUT identifiers.................................................................................................................................................... 44

LUT settings........................................................................................................................................................ 44

User allocated LUT data ..................................................................................................................................... 45

Setting the Brightness of an Internal LUT .......................................................................................................... 45

Using a Custom LUT .......................................................................................................................................... 45

DISPLAYING IMAGES WITH GREATER THAN 8-BIT DATA....................................................................... 46

SAVING IMAGES WITH GREATER THAN 8-BIT DATA................................................................................ 46

v1.6 14-Sep-2010