Roper Photometric User manual

Brand: Roper

Model: Photometric

Category: Food warmers

Type: User manual

57-039-001 Rev C1

3440 East Britannia Drive

Tucson, Arizona 85706

Tel: 520.889.9933

Fax: 520.295.0299

permission of Roper Scientific, Inc.

Printed in the United States of America.

Photometrics and Roper Scientific are trademarks and Metachrome, PVCAM, and PXL are registered

trademarks of Roper Scientific, Inc.

The information in this publication is believed to be accurate as of the publication release date. However,

Roper Scientific, Inc. does not assume any responsibility for any consequences including any damages

resulting from the use thereof. The information contained herein is subject to change without notice. Revision

of this publication may be issued to incorporate such change.

LIMITED WARRANTY — Roper Scientific Analytical Instrumentation

Roper Scientific, Inc. makes the following limited warranties. These limited warranties extend to the original

purchaser only and no other purchaser or transferee.

Limited One (1) Year Warranty

Roper Scientific warrants this product against defects in materials or workmanship for a period 1 year after

the date of original invoice. During this period, Roper Scientific will repair a defective product or part,

without charge to you. You must deliver the entire product to the Roper Scientific factory or, at our option, a

factory authorized service center. You are responsible for all transportation and insurance charges to return

the product to the service center, and Roper Scientific will be responsible for all transportation charges and

insurance to return the product to you. International customers should contact your local manufacturer's

representative/distributor for repair information and assistance or visit our technical support page at

www.roperscientific.com.

Shutter Warranty

Roper Scientific warrants the standard, factory-installed shutter of all our products that incorporate an

integrated shutter for a period of twelve (12) months. This warranty applies to the standard shutter installed

in the camera system at the time of manufacture. Non-standard shutters, SPR (special product request) shutters,

and third-party shutter drive equipment carry no warranty expressed or implied. Roper Scientific will supply, at no

cost to the customer, up to one (1) replacement shutter during the warranty period. Roper Scientific will, at

Roper Scientific's option, either ship a ready-to-install shutter to the customer site for installation by the

customer according to the instructions in the product User Manual or arrange with the customer to return the

camera system (or portion of the camera system) to the factory (or factory authorized service center) for

shutter replacement by a factory-authorized agent. Responsibility for transportation and insurance charges is

described above.

Sealed Chamber Integrity Warranty

Roper Scientific warrants the sealed chamber integrity of all our products for a period of twenty-four (24)

months. Open chamber products carry no warranty to the CCD imaging device expressed or implied.

Vacuum Integrity Warranty

Roper Scientific warrants the vacuum integrity of all our products for a period of twenty-four (24) months

during which we guarantee the detector head will maintain the factory-set operating temperature without the

requirement for customer pumping.

Image Intensifier Detector Warranty

All image intensifiers by nature are susceptible to Phosphor and/or Photocathode burn (physical) damage

when exposed to high intensity light. Roper Scientific warrants, with the exception of an image intensifier that

is found to have a Phosphor and/or Photocathode burn damage (which carries no warranty expressed or

implied), all image-intensified products for a period of 1 year after the date of the original invoice. See the

Limited One (1) year warranty terms and conditions above.

X-Ray Detector Warranty

Roper Scientific warrants, with the exception of the CCD imaging device and fiber optic assembly damaged

due to x-ray (which carry no warranty expressed or implied), all x-ray products for a period of 1 year after the

date of the original invoice. See the Limited One (1) year warranty terms and conditions above.

Software Warranty

Roper Scientific warrants all Roper Scientific manufactured software discs are free from defects in materials

and workmanship under normal use for a period of one (1) year from date of original invoice. Roper Scientific

does not warrant that the function of the software will meet your requirements or that operation will be

uninterrupted or error free. You assume responsibility for selecting the software to achieve your intended

results and for the use and results obtained from the software. In addition, during the 12-month limited

ii Advanced Camera Operation Manual

warranty the original purchaser is also entitled to receive free version upgrades. Version upgrades supplied

free of charge will be in the form of a download from the Internet. Those customers who do not have access to

the Internet may obtain the version upgrades on a CD-ROM from our factory for an incidental shipping and

handling charge. See Item 12 in the "Your Responsibility" section of this warranty for more information.

Owner's Manual and Troubleshooting

You should read the owner’s manual thoroughly before operating this product. In the unlikely event that you

should encounter operation difficulties, the owner’s manual should be consulted before calling the factory for

support. If you have consulted the owner's manual and the problem still persists, please contact the appropriate

factory for support. See Item 12 in the "Your Responsibility" section of this warranty for more information.

Your Responsibility

The above warranties are subject to the following conditions:

1. You must retain your bill of sale (invoice) or provide other proof of purchase.

2. You must notify the factory service center within the first thirty (30) days after you have taken

delivery of a defective product or part. With the exception of customers who claim a “technical issue”

with the operation of the product or part, all invoices must be paid in accordance with the terms of

sale. Failure to pay invoices when due may result in the interruption of your one (1) year limited

warranty and/or any other warranty expressed or implied.

3. All warranty service must be made by the factory or, at our option, an authorized service center.

4. Before products or parts can be returned for service the customer must contact the factory and receive

a return authorization number (RMA). Products or parts returned for service without a return

authorization will be sent back freight collect.

5. These warranties are effective only if purchased from the factory or one of our authorized

manufacturer's representatives or distributors.

6. Unless specified as part of the original purchase agreement, Roper Scientific is not responsible for

installation, setup, or disassembly at the customer’s location.

7. Warranties extend only to defects in materials or workmanship as limited above and do not extend to

any product or parts which have been lost or discarded by you; to damage to products or parts caused

by misuse in violation of instructions furnished by us; or to units which have had serial numbers

removed, altered, defaced, or rendered illegible.

8. At your option after the warranty period has expired, you may contact the factory for repair

information and extended warranty plans.

9. Physically damaged units or units that have been modified by a customer are not acceptable for repair

in or out of warranty and will be returned as received.

10. All warranties implied by state law or international laws, including the implied warranties of

merchantability and fitness for a particular purpose, are expressly limited to the duration of the

limited warranties set forth above. With the exception of any warranties implied by state law or

international laws, as hereby limited, the forgoing warranty is exclusive and in lieu of all other

warranties, guarantees, agreements, and similar obligations of manufacturer or seller with respect to

the repair or replacement of any parts. In no event shall Roper Scientific liability exceed the cost of the

repair or replacement of the defective product or part.

11. This warranty gives you specific legal rights and you may also have other rights that may vary from

state to state and internationally from country to country. Some states and countries do not allow

limitations on how long an implied warranty lasts, when an action may be brought, or the exclusion

or limitation of incidental or consequential damages, so the above provisions may not apply to you.

12. When contacting us for technical support or service assistance, please refer to the factory of purchase,

contact your manufacturer's representative or reseller, or visit our technical support page at

www.roperscientific.com.

iii

Table of Contents

Chapter 1. Introduction

Description.................................................................................................................................1

Software......................................................................................................................................2

Roper Scientific Customer Service..........................................................................................2

Chapter 2. ICL

Introduction ...............................................................................................................................3

Rules of Syntax ..........................................................................................................................3

Whitespace.................................................................................................................................3

Parameters / Arguments .........................................................................................................3

Single Parameter Functions..............................................................................................4

Multiple Parameter Functions..........................................................................................4

Verbs ...........................................................................................................................................4

Verbs as Subroutines .........................................................................................................5

Begin and End ....................................................................................................................5

Looping Verbs ....................................................................................................................5

Shift Verbs...........................................................................................................................5

Display Verbs .....................................................................................................................6

Syntax Summary .......................................................................................................................6

Script....................................................................................................................................6

Whitespace..........................................................................................................................6

Function Syntax..................................................................................................................6

Readout / Display .............................................................................................................6

Function Definitions .................................................................................................................7

Example Scripts.......................................................................................................................13

Open the Shutter ..............................................................................................................13

Single Image .....................................................................................................................13

TDI (Time Delay Integration) Panorama......................................................................14

Ratio Imaging: 2-Frame Ratio ........................................................................................15

Ratio Imaging: Multi-Frame Ratio.................................................................................16

3-Color Sequence .............................................................................................................17

Intermittent Exposure .....................................................................................................18

High-Speed Spectroscopy...............................................................................................19

Error Codes..............................................................................................................................20

Man Pages ................................................................................................................................21

pl_exp_display_script(101).............................................................................................21

pl_exp_init_script(101)....................................................................................................22

pl_exp_listerr_script(101) ...............................................................................................23

pl_exp_setup_script(101) ................................................................................................24

pl_exp_start_script(101)..................................................................................................25

pl_exp_uninit_script(101) ...............................................................................................26

Decoding ..................................................................................................................................27

Decoding the ICL.............................................................................................................27

Image Display...................................................................................................................27

iv Advanced Camera Operation Manual

Chapter 3. Advanced CCD Theory

Introduction .............................................................................................................................29

Theory of Operation ...............................................................................................................29

Potential Wells..................................................................................................................29

Charge Transfer................................................................................................................30

Classical CCD Implementations ....................................................................................31

CCD Readout...........................................................................................................................32

Subarrays ..........................................................................................................................33

Binning ..............................................................................................................................33

Time Delay Integration ...................................................................................................34

CCD Architectures..................................................................................................................35

Full Frame .........................................................................................................................35

Frame Transfer .................................................................................................................35

Interline Transfer .............................................................................................................36

CCD Camera Implementations.............................................................................................37

Resolution .........................................................................................................................37

Sensitivity..........................................................................................................................37

Spectral Response ............................................................................................................38

Fiberoptics.........................................................................................................................39

Sources of Noise......................................................................................................................39

Photon Noise ....................................................................................................................39

Preamplifier Noise...........................................................................................................39

Dark Current Noise .........................................................................................................40

Tradeoffs ...........................................................................................................................40

Additional Reading.................................................................................................................41

Index........................................................................................................43

Chapter 1.

Introduction

Description

The Advanced Camera Operation Manual includes:

• Imager Control Language (ICL)— Rules of syntax, ASCI II command

set, and example scripts

• Advanced CCD Theory — Background theory for advanced ICL users

Most Roper Scientific cameras use an application programming interface

called PVCAM

(Programmable Virtual Camera Access Method). PVCAM is a

custom, ANSI C library of camera control and data acquisition functions. Full-

function imaging packages access PVCAM. These full-function packages offer

the camera control adequate for most users.

ICL is a PVCAM option library that allows users to write low-level, ASCI II

command scripts for specialized applications. The scripts, which can be written

in any text editor, are then loaded through an ICL-compatible, full–function

imaging package, into the ICL option library, then through PVCAM to the

camera interface.

ICL Script

Custom Software

Application

PVCAM

ICL

Full-Function Imaging

Package (ICL-Compatible)

Camera Interface

2 Advanced Camera Operation Manual

Software

To run ICL scripts, you must be running a full-function imaging package that is

ICL compatible. You must also have installed the ICL and PVCAM files that are

appropriate for your camera and interface.

PVCAM and ICL files are located on the Host Connectivity Kit (HCK) diskette.

Installation instructions for these files are covered in your camera system’s

Software Guide.

Roper Scientific

Customer Service

If you have any questions regarding your camera system, contact Roper Scientific

Customer Service. When you call Roper Scientific, please have your Roper Scientific

job number or equipment serial numbers available.

•

Phone: 520.889.9933 between 8:00 a.m. and 5 p.m. MST

•

Fax: 520.295.0299

•

E-mail: [email protected]

•

Mail: Roper Scientific

3440 East Britannia Drive

Tucson, Arizona 85706

In Europe, you can reach Customer Service at:

BENELUX

•

Phone: 31.347.324989

•

Fax: 31.347.324979

•

E-mail: [email protected]

•

Mail: Roper Scientific, BV

Ir. D.S. Tuijnmanweg 10

4131 PN VIANEN, Netherlands

FRANCE

•

Phone: 33.160.86.03.65

•

Fax: 33.160.86.07.09

•

E-mail: [email protected]

•

Mail: Roper Scientific, SARL

Z.I. Petite Montagne Sud

4, rue de l'Oisans - C.E. 1702

91017 Evry Cedex, France

GERMANY

•

Phone: 49.89.660.779.3

•

Fax: 49.89.660.779.50

•

E-mail: [email protected]

•

Mail: Roper Scientific, GmbH

Rosenheimer Landstr. 87

D-85521 Ottobrunn, Germany

•

In Japan, you can reach Customer Service at:

•

Phone: 81.43.274.8022

•

Fax: 81.43.274.8023

•

E-mail: [email protected]

•

Mail: Nipon Roper, K.K.

D-10E 1-3 Nakase,

Mihama-ku, Chiba-shi

Japan 261-8501

General product information and answers to some customer service questions

can be found on our website: http://www.roperscientific.com

Chapter 2.

ICL

Introduction

ICL scripts can be written in any text editor. Save the script as a text file, then

download through an ICL-compatible imaging package.

This chapter includes:

• Script syntax

• Function descriptions

• Example scripts

Rules of Syntax

The basic rules of syntax are:

• Carriage returns, line feeds, form feeds, tabs, spaces, and comments are

treated as generic whitespace used to separate language elements. This

convention increases compatibility between operating systems and

helps with editors that have different end-of-line conditions and tab

expansions.

• There is no main program, subroutines, jumps, calls, conditional

statements, or branching.

• Braces are not allowed.

• All numeric values must be typed exactly. Numeric and parenthetical

expressions are illegal.

Whitespace

Whitespace includes a single occurrence or any combination of the following:

space, carriage return, line feed, form feed, tab, and unnested comment

(characters). Whitespace is not required. Once the /* characters are seen, you

may insert any desired comments until the closing */ appears. However, you

cannot nest comments. The first */ ends the comment. A second /* used before

the ending */has no effect, while an additional */ will generate an error.

Parameters /

Arguments

Approximately half of the script functions have no parameters. The function

must be followed by opening and closing parentheses with no parameters inside

the parentheses. Whitespace inside the parentheses is acceptable. Any of the

following examples are legal:

loop_end( );

loop_end( /* comments count as whitespace */ );

loop_end(

);

Parameters must be positive integers of normal numeric digits (0...9). None of

the following symbols are acceptable:

+ - * / . , ^ % ( )

4 Advanced Camera Operation Manual

Single Parameter

Functions

Some functions require a single parameter. Fractional/decimal and negative

values are not allowed. Numeric expressions generate an error. Whitespace can

be included anywhere inside the parentheses.

The following parameters are legal:

loop_begin( 50 );

loop_begin( 50 / *exposure count*/ );

loop_begin( 50

);

The following parameters are illegal:

loop_begin ( 50 ); whitespace before parentheses

loop_begin( 50, ); contains a comma

loop_begin( 50 0 ); two numeric entries, only one allowed

loop_begin( -50 ); minus sign is illegal

loop_begin( (5*10)); numeric expressions not allowed

Multiple Parameter

Functions

A few functions require multiple parameters. There are no variable argument

lists, so each parameter is always required. The parameters must be separated

by commas. Insert whitespace as desired.

The following examples are legal:

pixel_readout(0, 100, 1, 50, 2 );

pixel_readout( 0, 100, 1, 50, 2 );

pixel_readout(

100,

50,

2);

/****MAIN FUNCTION****/

/* serial offset of “0” */

/* serial size, value:100 */

/* serial binning */

/* parallel size */

/*par bin*/.

Verbs

A verb describes which function is performed next. Verb names are a mixture of

lowercase text and underscore characters. All verbs are followed by parentheses,

even if the verb does not require parameters. There is no whitespace between

the verb name and the opening parenthesis. List parameters inside the

parentheses and separate the parameters with commas. Whitespace is allowed

in the parameter list, but is not required. After the closing parenthesis, add a

semicolon. See sample below:

verb1();

verb2

(parameter, parameter, parameter);

verb3

(parameter);

verb4

(parameter);

(whitespace) verb5()

;

You can use several verbs on a single line, one verb per line, several lines of

whitespace, or any combination of the above.

Chapter 2. ICL 5

Verbs as Subroutines

You can think of verbs as camera functions or subroutines. A single-verb

instruction such as

flash()

clear_until_trig()

can be expanded into a

sequence of camera-specific instructions. Most verbs are directions for the

camera to perform the function immediately using the current settings.

Begin and End

There are two commands required for every script, if either command is

missing, the program sets an error code.

script_begin();

script_end(contin_clear);

script_begin

specifies the start of the program. Anything appearing before

script_begin

is considered whitespace and is ignored by the script processor.

Therefore you can insert comments at the head of a script without using

comment delimiters.

script_end

specifies that the script is finished, transmit to the camera. If

script_end

appears, the script processor will not continue to the null-

terminating character at the end of the input string.

Looping Verbs

Use the following verbs for looping:

loop_begin(loop_count);

loop_end();

All instructions occurring between these two verbs are executed

loop_count

times. The mechanism that performs this communication is camera specific. On

most systems, built-in commands are used to perform looping. However, on

some systems, the instructions inside the loop may be duplicated

loop_count

times. You can nest loops, up to 16 deep. For every

loop_begin

function, there

must be one

loop_end

instruction. If you create a different number of

loop_begin

and

loop_end

, it generates an error, and the script fails.

Shift Verbs

A shift verb tells the camera to immediately shift one or more lines in the

parallel register using the currently selected shifting mode.

shift_mode

verb changes the current state of the camera and specifies the

clocking method used during exposure (MPP or normal). The new state is

implemented the next time that the shift verb is executed.

shift_mode_is();

shift_mode_is_alt();

shift_mode_ism();

shift_mode_ism_alt();

shift_mode_s();

shift_mode_s_alt();

shift_mode_sm();

shift_mode_sm_alt();

Note that script_begin initializes the shift mode to shift_mode_is.

6 Advanced Camera Operation Manual

Display Verbs

The

pixel_display

verb is not sent to the camera and does not affect data

collection. However, once the data has been collected, the application examines

the script, the

pixel_display

verbs, and any loop commands. From this

information, the application determines how to display the images. (Note that

the

pixel_display

function may appear inside loops, outside loops, or both.)

If you use

pixel_readout

anywhere in the script, you must also use

pixel_display

. (If the script does not include

pixel_readout

pixel_display

must not appear.)

Syntax Summary

The following is a summary of ICL script syntax:

Script

Every script must start with

script_begin

and end with

script_end

. Match

each

loop_begin

with a

loop_end

Opening comments.

These don’t need to be inside comment marks.

script_begin( );

verb( );verb(

param,param

);

loop_begin(

loop_count

);

verb(

param

);

loop_end( );

pixel_readout(

param,param,param,param,param

);

pixel_display(

param,param

);

script_end(

param

);

Whitespace

Whitespace is never required.When whitespace is allowed,the following are

allowed:

character: space ^I ^J ^L ^M /*…*/(non-nested

comments)

ASCII name: space HT LF FF CR

dec. value: 32 9 10 12 13 47,42 … 42,47

C generation: “ ” \t \n \f \r “/*” … “*/”

Function Syntax

verb();

verb_name(

param, param, param

); whitespace verb(

param

);

verb(

param

);

• Verb names (functions) are always lowercase. Some functions contain

underscores.

• Every verb must be followed by parentheses and terminated by a semicolon.

• The number of parameters is fixed for each verb.

• Parameters must be hard-coded, numeric values, containing only the

characters [0…9].

• Parameters must be separated by commas.

• Whitespace may be inserted between parenthesis, commas, parameters, or

verbs, but not between verbs and opening parenthesis.

Readout / Display

Neither

pixel_readout

nor

pixel_display

is mandatory, but if one appears,

they must both appear. The total number of pixels collected must match the total

number of pixels displayed.

Chapter 2. ICL 7

Function Definitions

clear_parallel(

clear_count

);

clear the entire parallel register, clear_count times

clear_serial(

clear_count

);

clear the serial register, clear_count times

clear_until_trig();

waits for a trigger, clearing meanwhile

expose(

exp_time

);

a timed delay, while light falls on the CCD

expose_until_trig();

allow light to fall on the CCD until a trigger pulse

expose_while_trig(

clear_first

);

bulbmode expose while you hold the button

flash(

flash_time

);

activate the flash circuit for flash_time ms

loop_begin(

loop_count

);

loop control, start a loop, do it for loop_count cycles

loop_end();

loop control, bottom end of a loop

pixel_display(

x,y

);

instruction to application: display this size image

pixel_readout(

s_offset, s_size, s_bin,

p_size, p_bin

);

READ DATA FROM THE CCD

this is the only way to output image pixels

script_begin();

this must be the first verb in a script

script_end(

contin_clear

);

this must be the last verb in a script

if contin_clear is non-zero, the CCD is left in

continuous clear mode.

shift(

number_of_lines

);

shift the parallel register several lines, using a mode

shift_image_to_storage( );

redundant, but useful for frame transfer CCDs

shift_mode_is( );

parallel shift mode: image and storage (normal)

shift_mode_is_alt( );

parallel shift mode: image and storage (alternate)

shift_mode_ism( );

parallel shift mode: image and storage (MPP)

shift_mode_ism_alt( );

parallel shift mode: image and storage (MPP alt.)

shift_mode_s( );

parallel shift mode: storage array (normal)

shift_mode_s_alt( );

parallel shift mode: storage array (alternate)

shift_mode_sm( );

parallel shift mode: storage array MPP)

shift_mode_sm_alt( );

parallel shift mode: storage array (MPP alternate)

shutter_close( );

close the camera shutter

shutter_open( );

open the camera shutter

clear_parallel

(clear_count)

This function clears the parallel register (the entire CCD: the premask area, active area, and postmask area)

clear_count

times where

clear_count

must be greater than zero. The function puts the CCD into an image

and storage shifting mode, then shifts the entire parallel register into the serial register, thus clearing the CCD

of all charge. This process can also be accomplished by using other functions, such as using a number of shift

commands with the proper shift mode, but this function is easier to use. Although the serial register runs

continuously during the clearing, there are some circumstances where the serial register may still contain

charge. (This condition requires additional clearing with the

clear_serial

command.) Note that this

command leaves the parallel shifting mode set to

shift_mode_is

clear_count

must be between 1 and

65,535, inclusive.

clear_serial

(clear_count);

This function clears the serial register (the prescan area, active area, and postscan area)

clear_count

times.

The function runs the serial register, dumping any charge into the output node where the charge is transferred

into the power supply.

clear_count

must be between 1 and 65,535, inclusive.

8 Advanced Camera Operation Manual

clear_until_trig( );

This function causes the CCD to enter clearing mode and continues clearing indefinitely until a trigger arrives.

Both the parallel and serial registers are continuously clearing (moving charge toward and into the serial

delay is the time to shift 1 parallel row) and then stops clearing. Execution immediately continues with the

next script instruction. For more information concerning the pinouts and electrical specifications of the trigger

port, refer to your camera’s User Manual. (Please note that the current parallel shift is completed before the

camera begins integrating.)

expose

(exp_time);

The CCD exposes for

exp_time

milliseconds. This command usually appears immediately after

shutter_open

clear_parallel

, or

clear_until_trig

. Note that exposing is not equivalent to merely

waiting for the duration of the exposure time. During an exposure, voltage is applied to the CCD in a gridlike

pattern, to produce potential wells (pixels) and to keep the charge from drifting into adjacent cells. On some

CCDs, this voltage may be applied in either normal or MPP mode. The mode actually used for the exposure

reflects the most recently set parallel shifting mode (whether that mode was set to normal or MPP).

exp_time

may be set to zero, although this instruction becomes a “no operation” under those conditions. The

exp_time

variable maintains full precision up to a value of 65,535 milliseconds. After that point, the program creates

longer times through an internal loop counter that provides more precise timing than the scripting

loop_begin

command. Due to this mechanism, some values may be rounded off to a nearby value (for

example, prime numbers greater than 65,535 won’t be exactly represented). The maximum exposure length is

2^32 milliseconds (about 49 days). For more information on using exposure in conjunction with frame

transfer, consult your camera’s User Manual.

expose_until_trig( );

This function begins exposing immediately and continues exposing until a trigger signal arrives. The script

then continues with the next instruction. During the exposure, this applies voltage patterns to the CCD in

either normal or MPP modes (see

expose

). As with the regular

expose

function, this neither opens or closes

the shutter. For more information concerning the pinouts and electrical specifications of the trigger port, refer

to your camera’s User Manual.

expose_while_trig

(clear_first);

This function initiates a scripted version of the high-level bulb-mode exposure. If

clear_first

is 1, this

initially enters a continuous clearing mode, exactly like

clear_until_trig

. If

clear_first

is 0, the CCD

exposes while it waits for the trigger. In either case, once the trigger arrives, the CCD switches into an

exposing mode (either normal or MPP, see

expose

for more information), and continues exposing while the

trigger signal is present. As soon as the trigger ends, the exposure stops, and the script proceeds with the next

instruction. Note that this instruction is not redundant. You can’t use

expose_until_trig

in conjunction

with other instructions (such as

clear_until_trig

) to duplicate the function of this trigger, because a

trigger signal stops the exposure with

expose_until_trig

, while that same trigger signal starts (and

maintains)

expose_while_trig

. For more information concerning the pinouts and electrical specifications of

the trigger port, refer to your camera’s User Manual. clear_first must be either 0 or 1.

flash

(flash_time);

This function activates the flash circuit (a set of pins on the trigger port of many PVCAM cameras) and

continues applying power for

flash_time

milliseconds. In some cases, this may be used to activate devices

connected to the camera, such as an illuminator or filter wheel (although the flash signal differs from camera

to camera and is often not a TTL-compatible signal). For more information concerning the pinouts and

electrical specifications of the trigger port, refer to your camera’s User Manual.

flash_time

must be between 1

and 65,535, inclusive.

Chapter 2. ICL 9

loop_begin

(loop_count);

This function allows looping within a script. A

loop_count

specifies the number of times to perform the loop.

All instructions between the

loop_begin

and matching

loop_en

d commands are executed exactly

loop_count

times. Loops may be nested up to 16 deep. Note that indentation of a script’s source code may

improve readability, but it does not alter the loop nesting in any way.

loop_count

must be between 1 and

65,535, inclusive.

loop_end( );

This function defines the end-of-loop, and allows looping within a script. This command must be matched

with a

loop_beg

in command (the

loop_begin

command must appear first). Loops can be nested.

pixel_display

(x,y);

This function indicates that camera output is decoded for display on a monitor. The application software takes

the next (

x*y

) pixels from the output data stream and displays them as a single rectangular image, x pixels

wide by y pixels tall. Cross-checking done during script setup ensures that the total number of pixels

displayed matches the total number of pixels collected (assuming that data collection is completed without

errors). In other words, the total number of pixels read from the camera (using

pixel_readout

) equals the

total number of pixels displayed (using

pixel_display

). Depending on the experiment design and the exact

script used, the individual

pixel_readout

and

pixel_display

instructions may or may not be closely

matched. However, if the script contains any

pixel_readout

instructions (i.e., if one or more pixels are

readout from the camera), it must also contain at least one

pixel_display

instruction. Both x and y must be

between 1 and 65,535, inclusive.

pixel_readout(s_offset, s_size, s_bin, p_size, p_bin);

This function causes a block of pixels (region) to be first read out into the serial register, then transferred into

the output converter and digitizer. The region must be immediately adjacent to the serial register when this

instruction is given (the parallel offset must be zero, so you have to use the shift command to move the

desired region to the edge of the parallel register).

Serial Register

Parallel Register

s_size

p_size

(0,0)

s_offset

For each row of the block, the first

s_offset

pixels are skipped. The next

s_size

pixels (after the skipped

pixels) are digitized using a binning of

s_bin

. Each subsequent row is then digitized in the same fashion for a

total of

p_size

rows. Finally, if

p_bin

is greater than 1, parallel binning is also performed.

All parallel shifting is performed using the current parallel shifting mode. In some cases, the resulting readout

makes no sense (for example, if a custom backward shift is used).

If any of the sizes are an uneven multiple of binning, a smaller size that exactly fits the binning is used. If the

size is smaller than the binning (size 4, binning 5) a fatal error is produced.

10 Advanced Camera Operation Manual

You can use this function to stack several regions, one after the other, in the parallel direction. However, you

cannot stack more than one region at a time in the serial direction.

s_offset

may be zero. All other

parameters must be between 1 and 65,535, inclusive.

s_size

and

p_size

must be at least as large as their

corresponding

s_bin

and

p_bin

. Finally,

s_offset

and

s_size

must be no larger than the CCD serial size.

script_begin( );

This must be the first instruction in the script. It signals that the script is starting now. Any text that occurs

before this instruction is ignored. This allows you to put in an initial comment block that can be used to

explain the purpose and operation of script programs. This instruction automatically puts the CCD into

shift_mode_is

script_end(

contin_clear

);

This must be the last instruction in a script. It signals to the compiler that the script program is now finished.

Any text that occurs after this instruction is ignored. If the parameter

contin_clear

is 1, the camera remains

in continuous clear mode. This indefinitely cycles the CCD in a shift-and-eliminate-charge loop, similar to the

clear_until_trig

instruction. Since this actively cycles power through the CCD, it also generates heat

within the CCD. This may be a problem in some cases, particularly if the camera is run near the low-

temperature limit. Continuous clearing occurs until a new script or exposure is started, an abort is sent, or

until the camera hardware is reset or turned off. Other commands to the camera (such as altering the speed

setting) also cancel continuous clearing.

contin_clear

must be either 0 or 1.

shift(

number_of_lines

);

This function shifts the

number_of_lines

rows of data, in the parallel direction, using the current shift mode.

Depending on the shift mode in use, this may or may not shift the entire parallel register (it may shift only the

storage array), shift the rows either forward or backward (depending on the setting of the ALT shift modes),

or use MPP mode for the clocking. The serial register is cleared during the shift operation, so any charge

dumped into the serial register is eliminated. The two most common cases are described below:

shift_mode_is

shift_mode_ism

: In these two modes, the entire parallel register is being moved.

Issuing the instructions

shift(3);

moves the entire parallel register 3 rows closer to the serial register.

The far end of the parallel register is filled with zeros (no charge). The three rows closest to the serial

shift_mode_s

shift_mode_sm

: These two modes can only be performed on frame-transfer devices.

Issuing the instruction

shift(3);

moves the storage array three rows closer to the serial register. The far

end of the storage array is filled with zero (no charge). The image array is completely unaffected (it is

often left exposing). The three rows closest to the serial register are dumped into the serial register and

cleared.

Please note that the

alternate

shift modes are usually loaded at the factory with settings that are identical to

the normal modes. You can request custom settings that allow backward shifting, shift image only, etc.

Also note that shifting is not useful for outputting pixels. It is useful only for moving a region into position for

readout. Readout must be done through the

pixel_readout

command.

number_of_lines

must be between

1 and 65,535, inclusive.

shift_image_to_storage( );

This function can only be used on frame-transfer devices. It shifts the CCD’s image array into the storage

array, and any data currently in the storage area is lost. (It is shifted into the serial register, and the serial

of the

shift

instruction and various shifting modes, this function does the operation more efficiently with a

single instruction. Please note that using this command leaves the parallel shifting mode set to

shift_mode_s

Chapter 2. ICL 11

shift_mode_is( );

Shift Image and Storage. This is a parallel shifting mode that shifts the entire parallel register. This mode can

be used on all CCDs and uses the normal clocking method that is equivalent to MPP off. The exception is for

CCDs that require MPP clocking, and, in this case, MPP on is used.

shift_mode_is_alt( );

Shift Image and Storage, Alternate. This is a parallel shifting mode that shifts the entire parallel register. This

mode can be used on all CCDs and uses the normal clocking method that is equivalent to MPP off. The

exception is for CCDs that require MPP clocking, in this case, MPP on is used. In addition to the MPP style of

shifting, this function uses an alternate shifting mode (see shift). Unless an alternate shifting was loaded at

the factory, this mode is loaded with a default value identical to

shift_mode_is

shift_mode_ism( );

Shift Image and Storage, MPP. This is a parallel shifting mode that shifts the entire parallel register. This mode

can only be used on CCDs that support MPP clocking. If this mode is used on a non-MPP CCD, the script

compiler generates an error and fails.

shift_mode_ism_alt( );

Shift Image and Storage, MPP, Alternate. This is a parallel shifting mode that shifts the entire parallel register.

This mode can only be used on CCDs that support MPP clocking. If this mode is used on a non-MPP CCD, the

script compiler generates an error and fails. In addition to using MPP clocking, this function uses an alternate

shifting mode (see shift). Unless an alternate shifting was loaded at the factory, this mode is loaded with a

default value identical to

shift_mode_ism

shift_mode_s( );

Shift Storage. This parallel shifting mode shifts only the storage array on a frame-transfer CCD. This mode can

only be used on frame-transfer CCDs. If this mode is used on a non-frame-transfer CCD, the script compiler

generates an error and fails. This function uses the normal clocking method that is usually equivalent to MPP

off. For CCDs that require MPP clocking, the clocking method is MPP on.

shift_mode_s_alt( );

Shift Storage Alternate. This parallel shifting mode shifts only the storage array on a frame-transfer CCD. This

mode can only be used on frame-transfer CCDs. If this mode is used on a non-frame-transfer CCD, the script

compiler generates an error and fails. This clocking is equivalent to MPP off except for CCDs that require MPP

clocking. In this case, the clocking would be equivalent to MPP on. In addition to the MPP style of shifting,

this function uses an alternate shifting mode (see shift). Unless an alternate shifting was loaded at the

factory, this mode is loaded with a default value identical to

shift_mode_s

shift_mode_sm( );

Shift Storage, MPP. This parallel shifting mode shifts only the storage array on a frame-transfer CCD. This

mode can be used on CCDs that support both MPP clocking and frame transfer. If this mode is used on a non-

MPP or non-frame-transfer CCD, the script compiler generates an error and fails.

shift_mode_sm_alt( );

Shift Storage, MPP, Alternate. This parallel shifting mode shifts only the storage array on a frame-transfer

CCD. This mode can be used only on CCDs that support both MPP clocking and frame transfer. If this mode is

used on a non-MPP or non-frame-transfer CCD, the script compiler generates an error and fails. In addition to

the MPP style of shifting, this function uses an alternate shifting mode (see

shift

). Unless an alternate

shifting was loaded at the factory, this mode is loaded with a default value identical to

shift_mode_sm

shutter_close( );

This function closes the shutter. Once the

shutter_close_delay

time has passed, this function continues on to

the next script instruction. Since there is no default shutter position, and if the shutter position is important to the

current script, set the shutter open or closed at the start of the script program. Note that none of the other script

instructions (except for

shutter_open

, of course) alters the shutter state. Specifically, none of the

expose

12 Advanced Camera Operation Manual

commands affect the shutter. For more information concerning the pinouts and electrical specifications of the

trigger port, and how they relate to the shutter commands, refer to your camera’s User Manual.

shutter_open( );

This function opens the camera shutter. Once the

shutter_open_delay

time has passed, this function

continues on to the next script instruction. See

shutter_cl

ose for more information. For more information

concerning the pinouts and electrical specifications of the trigger port, and how they relate to the shutter

commands, refer to your camera’s User Manual.

Chapter 2. ICL 13

Example Scripts

The eight example scripts in this section illustrate the rules and principles of ICL. These scripts use every ICL

function with the exception of shift_mode_sm() and the _alt modes. Electronic copies of the example scripts

are in the ICL Example file on your HCK diskette.

• Open the Shutter

• Single Image

• Time Delayed Integration Panorama

• Ratio Imaging: 2-Frame Ratio

• Ratio Imaging: Multi-Frame Ratio

• 3-Color Sequence

• Intermittent Exposure

• High-Speed Spectroscopy

Open the Shutter

This script opens the camera shutter and leaves it open.

script_begin();

shutter_open();

script_end(0);

Single Image

This script is intended for use on a Kodak 1400 CCD (serial size 1317, parallel size 1035). The script takes one

full-frame image and exits.

script_begin();

shutter_close(); /* good precaution—who knows what state it's in */

clear_parallel(2); /* clear out any residual charge */

clear_serial(2); /* might as well clear this out, too */

shutter_open(); /* START TAKING THE IMAGE... */

expose(200); /* expose for 200 milliseconds */

shutter_close(); /*...DONE TAKING THE IMAGE */

pixel_readout(0,1317,1,1035,1); /* readout the entire CCD */

pixel_display(1317,1035); /* display the entire CCD */

script_end(1); /* leave the CCD in continuous clear mode */

14 Advanced Camera Operation Manual

TDI (Time Delay Integration) Panorama

This script is written for use with a Kodak 1400 CCD (serial size 1317,parallel size 1035). The camera is

attached to a telescope pointing straight up. The camera's external trigger port is connected to a synchronized

time source that provides a pulse every few seconds. The pulse timing is closely coordinated with the image

size, so the rotation of the earth moves the image on the CCD by exactly one parallel row width (6.8 microns)

for each pulse. Therefore, for every pulse, one row is readout, and the other rows are shifted over, following

the moving image. This script uses the setup to collect a single panoramic image 10,000 rows wide (reading 1

row at a time, 8965 times, and finishing with a final clean up readout of 1035 rows).

The CCD reaches a steady state exposure duration during the middle of the panorama, but the beginning and

ending few lines are exposed for less time. (Exposure time is progressively less for the first and last 1035 rows

of the panorama.) The result is that the front and back ends of the panorama gradually ramp up and down in

brightness.

script_begin();

shift_mode_is(); /* redundant, since script_begin sets this anyway*/

shutter_open(); /* light is now falling on the CCD */

clear_parallel(5); /* make sure this CCD is cleared out */

clear_until_trig(); /* clear until acquire regular pulses */

loop_begin(8965); /* 10,000 (full panorama) - 1035 (clean-up size) */

expose_until_trig(); /* readout each time trigger pulse received */

pixel_readout(0,1317,1,1,1); /* read exactly 1 row, shift the rest over */

loop_end();

pixel_readout(0,1317,1,1035,1);/*clean up: read the entire CCD */

pixel_display(1317,10000); /* display this as one huge panoramic image */

shutter_close();

script_end(0);

Page is loading ...

Roper Photometric User manual

Brand: Roper

Model: Photometric

Category: Food warmers

Type: User manual

Download PDF

report

Roper Photometric User manual

Roper Photometric User manual

Related papers

Other documents