PHOTONIS Nocturn User Reference Manual

Digital Low-Light CMOS Camera
User Reference Guide
NOCTURN Digital Low Light CMOS Camera
PHOTONIS USA, Inc. 6170 Research Road | Suite 208 Frisco, TX USA 75033 T: +1 (469) 713-6108 F: +1 (469) 713-2880 www.photonis.com
PHOTONIS | 2
Revision Number
Revision Date
Description
A
November 17, 2012
Creation of document
B
April 22, 2013
Updated to reflect v1.0.0 Firmware/Software Updates and v1.0.x Windows Evaluation GUI
C
May 23, 2013
Updated integration time equation
D
May 24, 2013
Add specific mode set up
NOCTURN Digital Low-Light CMOS Camera, XL Module User Reference Guide
© 2013 PHOTONIS USA Pennsylvania, Inc. All Rights Reserved.
This document may not be reproduced, in whole or in part, without the prior written consent of PHOTONIS USA Pennsylvania, Inc. The information furnished in this document is believed to be correct at the time of publication, but is not guaranteed and is subject to change without prior notice. No liability is assumed by PHOTONIS for its use. No claims or warranties are made as to the application of PHOTONIS products. Customers should verify they have the correct documentation before use.
Any questions regarding the use of the referenced product should be referred to: Sales: Phone: +1 (770) 998-1975, Email: l.nowell@usa.photonis.com
Technical Support: Phone: +1 (972) 987-1464, Email: m.conti@usa.photonis.com
Revision History
Document Number: NVT 200-LC-0103
Revision: D
NVT 200-LC-0103
Revision: D
Page 2 of 43
3 | Table of Contents NOCTURN XL Camera
Table of Contents
1. INTRODUCTION ............................................................................................................. 6
2. CONFIGURATION ........................................................................................................... 6
3. SPECIFICATIONS ........................................................................................................... 8
Figure 3 Typical Quantum Efficiency Curve ..................................................................... 9
4. UNPACKING ................................................................................................................... 9
5. GETTING STARTED: INITIAL SETUP AND OPERATION ............................................ 11
USB DRIVER INSTALLATION (WINDOWS)................................................................................11
INITIAL POWER-UP .........................................................................................................................12
6. CAMERA CONTROLS ................................................................................................... 14
BASIC COMMUNICATION SETTINGS .........................................................................................14
PROTOCOL .......................................................................................................................................14
TOP LEVEL CONSOLE COMMANDS ..........................................................................................15
BAUDRATE COMMANDS ...............................................................................................................16
ANALOG VIDEO COMMANDS ......................................................................................................16
CAMERA LINK VIDEO COMMANDS ............................................................................................16
TEMPERATURE DISPLAY COMMANDS ....................................................................................17
FILE TRANSFER COMMANDS......................................................................................................17
VIDEO PIPELINE COMMANDS .....................................................................................................17
AGC COMMANDS ............................................................................................................................18
NUC COMMANDS ............................................................................................................................20
CMOS SENSOR COMMANDS .......................................................................................................21
7. GRAPHICAL USER INTERFACE .................................................................................. 26
INSTALLATION .................................................................................................................................26
GUI ENVIRONMENT ........................................................................................................................29
8. MAINTENANCE ............................................................................................................. 40
9. STORAGE ..................................................................................................................... 41
10. QUALITY ....................................................................................................................... 42
ACCEPTANCE TEST PROTOCOL ...............................................................................................42
WARRANTY .......................................................................................................................................42
NVT 200-LC-0103 Revision: D Page 3 of 43
PHOTONIS | 4
List of Tables
Table 1 NOCTURN XL Input Power Specifications ................................................................................. 7
Table 2 NOCTURN XL Specifications ...................................................................................................... 8
Table 3 Unpacking Instructions for the NOCTURN XL Camera .............................................................. 9
Table 4 USB Driver Installation ............................................................................................................... 12
Table 5 Frame Grabber Configuration Details ......................................................................................... 13
Table 6 Top Level Console Commands.................................................................................................... 15
Table 7 Baudrate Commands .................................................................................................................... 16
Table 8 Analog Video Commands ............................................................................................................ 16
Table 9 Camera Link Video Commands .................................................................................................. 16
Table 10 Temperature Display Commands .............................................................................................. 17
Table 11 FIle Transfer Commands ........................................................................................................... 17
Table 12 Video Pipeline Commands ........................................................................................................ 17
Table 13 AGC Commands ........................................................................................................................ 18
Table 14 NUC Commands ........................................................................................................................ 21
Table 15 CMOS Sensor Commands ......................................................................................................... 21
Table 16 CMOS Sensor Registers ............................................................................................................ 22
Table 17 Installation of the NOCTURN XL Windows Evaluation GUI .................................................. 27
List of Figures
Figure 1 Front View of the NOCTURN XL Camera ................................................................................. 6
Figure 2 Back Side View of the NOCTURN XL Camera .......................................................................... 7
........................................................................................................ Figure 3 Typical Quantum Efficiency Curve
..................................................................................................................................................................... 9
Figure 4 Hardware Connection Between the NOCTURN and PC ........................................................... 13
Figure 5 LED on the Back of the NOCTURN XL Turns Green when USB Power is Applied ............... 14
Figure 6 Layout of the NOCTURN XL Evaluation GUI ......................................................................... 30
Figure 7 External Strobe Setup Window .................................................................................................. 31
Figure 8 Evaluation GUI Splash Screen ................................................................................................... 33
Figure 9 Camera Version Information Window ....................................................................................... 33
Figure 10 GUI Settings Tab ...................................................................................................................... 34
Figure 11 GUI Main Controls Tab............................................................................................................ 35
Figure 12 NOCTURN Digital Zoom Pan Axes ........................................................................................ 36
Figure 13 GUI AGC Controls Tab............................................................................................................ 37
Figure 14 GUI Contrast Controls Tab ...................................................................................................... 38
Figure 15 Histogram Region of Interest Setup ......................................................................................... 39
NVT 200-LC-0103
Revision: D
Page 4 of 43
5 | User Reference Guide NOCTURN XL Camera
SAFETY SUMMARY
WARNING and CAUTION statements have been strategically placed throughout the text prior to operating or maintenance procedures, practices, or conditions considered essential to the protection of personnel (WARNING) or equipment and property (CAUTION). NOTES emphasize necessary and important data. CAUTIONS and NOTES appear in the text as applicable. Definitions for WARNINGS, CAUTIONS and NOTES are as follows:
WARNING
A warning indicates an operation, condition, or statement, etc., which, if not strictly observed, could result in injury to or death of personnel.
CAUTION
A caution indicates an operation, maintenance procedure, or condition, etc., which, if not strictly observed, could result in damage to, or destruction of, equipment or loss of hardware performance or function.
NOTE
A note indicates an essential operating or maintenance procedure, condition or statement, or explanatory text.
NVT 200-LC-0103 Revision: D Page 5 of 43
PHOTONIS | 6
1. INTRODUCTION
The NOCTURN XL (see Figure 1) is a rugged low light camera module that features high-definition resolution, high sensitivity and high dynamic range with low power consumption. Powered by PHOTONIS’ 1 inch optical format 1280×1024 pixel (SXGA) Lynx CMOS sensor, the NOCTURN provides real-time imaging capabilities (from daylight to one quarter moon scene illumination) in the visible and near infrared spectrum. Its small size, weight and power (SWaP) make this camera module ideal for integration into aerial, mobile and hand-held surveillance systems.
With its 9.7µm×9.7µm pixel pitch and 4e- median read noise, the NOCTURN provides unsurpassed signal to noise at low light with video rates up to 100 frames per second. Leveraging PHOTONIS expertise in night vision imaging, the NOCTURN electronics incorporates a multitude of functions to enhance the low light level performance. This camera features automatic gain control (AGC), automatic exposure control (AEC), high dynamic range (HDR), non-uniformity correction (NUC) and advanced image enhancement, allowing the NOCTURN to provide continuous situational awareness without compromising mobility and SWaP. The “XL” version of the NOCTURN has both a CameraLink® compatible 10-bit digital video output as well as PAL/NTSC analog video output.
Figure 1 Front View of the NOCTURN XL Camera
This user reference guide provides a detailed overview of the interfaces, functionality and operation of the NOCTURN camera. Please contact PHOTONIS technical support if you require additional information or details that are not covered in this guide.
2. CONFIGURATION
The “XL” model indicates that the NOCTURN camera has an integrated interface board that can be used to output digital video over a Camera Link® compatible interface as well as NTSC/PAL composite video. The back panel of this NOCTURN configuration is shown in Figure 2.
NVT 200-LC-0103
Revision: D
Page 6 of 43
7 | User Reference Guide NOCTURN XL Camera
Parameter
Description
Min
Typ
Max
Units
Vin
Input Voltage
5.0 15 V Icc
Input Current1
3502
415
mA
1 2
Figure 2 Back Side View of the NOCTURN XL Camera
The user can turn on independently the CameraLink® compatible digital and analog video output via the serial command over the USB interface. Additionally, the NOCTURN XL is delivered with a tripod mount adapter that can be easily bolted on to any side of the camera chassis. For full pin-out of the NOCTURN XL camera please refer to the NOCTURN XL Electro-Mechanical ICD.
The NOCTURN XL can be powered either via the USB interface from a personal computer (cable not provided) or through the J301 external power and IO connector (see Table 1 for power input specification). The NOCTURN XL Electro-Mechanical ICD provides both the pin-out of and mating connector part number for J301.
Table 1 NOCTURN XL Input Power Specifications
Measured with Vin at +5.0 VDC
In 60Hz mode and excludes analog video output power
NVT 200-LC-0103 Revision: D Page 7 of 43
Parameter
Specification
Sensor Resolution
1280 × 1024 Pixels
Sensor Pixel Pitch
9.7 µm × 9.7 µm
Sensor Well Capacity
> 25000 e-
Sensor Dynamic Range
> 60 dB (> 72 dB by using the HDR3 mode)
Sensor Read Noise
< 4 e- med. (at 60Hz frame rate)
Sensor Quantum Efficiency
> 50% at 600nm (see Figure 3)
Frame Rate
50, 60 or 100Hz with full field resolution4 (user adjustable)
Sensor Image Lag
< 0.1 %
Sensor Shutter Mode
Rolling
Lens Mount
CS
Dimensions (Width × Height × Depth5)
34.1 mm × 36.6 mm × 37.4 mm
Weight
85 grams
Digital Video Output
10/8 bit CameraLink® Compatible
Analog Video Output
NTSC/PAL (user configurable)
Communications
Serial via CameraLink® Interface or USB interface
Image Correction
Bad pixel replacement and 2 points non uniformity correction
Synchronization
Analog output strobe reference
Camera/Imaging Start Up Time
< 5 seconds
Gain Control
Automatic (AGC) or manual
Digital Zoom
Up to 4 X6
Contrast Enhancement
Contrast stretching and histogram equalization
Operating Temperature
-40° to +60° C
Storage Temperature
-50° to +80° C
Input Voltage
USB powered or external +5 to +15 VDC
Power (Typical)7
60/50Hz Mode: < 1.8 W; 100Hz Mode: < 2.25W
3 4 5 6 7
3. SPECIFICATIONS
Detailed specifications of the NOCTURN XL camera are given in Table 2.
Table 2 NOCTURN XL Specifications
PHOTONIS | 8
HDR : High Dynamic Range
Lower frame rate can be achieved by increasing integration time
Excludes connectors protruding from main NOCTURN XL housing
Digital zoom is only enabled in 50, 60 and 30Hz modes
Digital video output only without advanced image processing
NVT 200-LC-0103
Revision: D
Page 8 of 43
9 | User Reference Guide NOCTURN XL Camera
Description
Image
Inspect shipping container and notify PHOTONIS personnel of any damage that may have occurred during shipping.
4. Figure 3 Typical Quantum Efficiency CurveUNPACKING
WARNING
Before getting started it should be noted that the NOCTURN XL cameras contains electrostatic sensitive parts and assemblies and should be handled within protected areas and in accordance with industry standard electrostatic discharge (ESD) protective handling procedures. Under no circumstances, should the camera be disassembled unless directed to do so by PHOTONIS personnel. Disassembly of the camera and damage to the anti-tamper sticker on the side of the camera will void in full the warranty.
This section provides the necessary steps to properly unpack the NOCTURN XL camera product.
Table 3 Unpacking Instructions for the NOCTURN XL Camera
NVT 200-LC-0103 Revision: D Page 9 of 43
PHOTONIS | 10
Description
Image
Record the camera serial number located on the side of the shipping container for your records. This number is also engraved on the bottom of the camera. You will need that number to be able to receive technical support for your product.
Open shipping container by breaking the PHOTONIS seal and lifting the cardboard lid.
Remove the antistatic bag containing the camera module from the suspended clear plastic clamshell.
Remove the companion CD ROM located underneath the clear plastic clamshell.
NVT 200-LC-0103
Revision: D
Page 10 of 43
11 | User Reference Guide NOCTURN XL Camera
Description
Image
Unseal antistatic bag and remove camera module using proper ESD procedures.
Inspect camera module for proper configuration and potential shipping damage. Immediately report any problem to PHOTONIS personnel.
5. GETTING STARTED: INITIAL SETUP AND OPERATION
Once the camera is unpacked, please install the USB drivers for your target operating system located on the Silicon Labs website. If using a Windows 7 compatible PC, it is recommended to load the “Win 7 Evaluation GUI”. The GUI can be downloaded at www.nocturncamera.com. In the event that the camera must be controlled on another operating system, a “terminal emulation software should be used to send serial commands to the camera.
CAUTION
Before proceeding with the initial power-up of the Camera, be sure the Nocturn XL USB driver (if applicable), provided at www.nocturncamera.com or on the Silicon Labs website, is installed on the PC
USB DRIVER INSTALLATION (WINDOWS)
NVT 200-LC-0103 Revision: D Page 11 of 43
Description
Image
Download the latest CP210x USB to UART Bridge VCP drivers (v6.6.1 or newer is recommended) from the Silicon Labs website:
http://www.silabs.com/products/mcu/Pages/USBto UARTBridgeVCPDrivers.aspx
Unzip the downloaded driver file: CP210x_VCP_Windows.Zip Double click the installer (please note that you need administrator privilege to install the drivers):
CP210xVCPInstaller_x64 (for 64b OS systems)  CP210xVCPInstaller_x86 (for 32b OS systems)
On the installer Welcome screen click the Next button.
On the License Agreement screen, select “I accept this
agreement” and then click the Next Button.
Wait for the installation to complete. Once it is finish you will see the following screen. Just click Finish to complete the installation.
Table 4 USB Driver Installation
PHOTONIS | 12
INITIAL POWER-UP
Connect an SDR CameraLink® compatible cable between the S501 connector on the
NOCTURN XL and a PC frame grabber. Alternatively, an SMA to BNC connector adapter can be connected between the J601 NOCTURN XL connector and NTSC/PAL analog monitor (please note that by default the analog video output on the NOCTURN XL camera is turned off and will need to be enabled by the user either via the evaluation GUI or via serial command over the USB interface) as shown in Figure 4.
NVT 200-LC-0103
Revision: D
Page 12 of 43
13 | User Reference Guide NOCTURN XL Camera
Parameter
Value
Unit
Pixel Clock per Tap (with 30/50/60fps operation mode)
48
MHz
Pixel Clock per Tap (with 100fps operation mode)
72
MHz
Number of Taps
2 Interlaced Vertically
NA
Grayscale Resolution
10
bits
Data Width pre Valid
8
pixels
Data Height pre Valid
1
line
Data Width Valid
1280
pixels
Data Height Valid
1024
pixels
Data Width post Valid
0
pixels
Data Height post Valid
0
pixels
Hardware Configuration with
USB Power and Camera Link®
Digital Video
Camera Link®
USB Communication
& Power
Figure 4 Hardware Connection Between the NOCTURN and PC
Setup your CameraLink® frame grabber configuration file to match the parameters shown in
Table 5.
Table 5 Frame Grabber Configuration Details
Connect a micro-USB cable (not supplied with the camera) between the J304 connector on the
NOCTURN XL camera and the host PC with the installed USB drivers. The status LED on the back of the NOCTURN XL should turn green (see Figure 5).
NVT 200-LC-0103 Revision: D Page 13 of 43
PHOTONIS | 14
Figure 5 LED on the Back of the NOCTURN XL Turns Green when USB Power is Applied
Turn on the frame grabber image acquisition software to display the digital video output from the
camera (the camera will output video as soon as power is applied over the USB interface).
6. CAMERA CONTROLS
The NOCTURN XL is controlled by a serial communication protocol that can be addressed either over the USB or the Camera Link ® compatible link.
BASIC COMMUNICATION SETTINGS
The serial communication should be set with the following configuration:
Number of bits: 8 Baud rate: 115200 bps Parity: none Number of stop bits: 1 bit Flow control: none.
NOTE
The user can change the default baud rate to value other
than 115200bps by using the “baudrate” command
followed by a “save flash” command.
PROTOCOL
The protocol to communicate the NOCTURN XL console is based on ASCII printable messages. A carriage return must be sent following a command. A “>” will appear at the console when the camera is
ready to accept messages. The camera will answer “OK” to all user command that are accepted and “Error: <error message>” when an error occurs.
A standard message to the camera should have the following architecture: Command <Optional Payload> <CR>.
NVT 200-LC-0103
Revision: D
Page 14 of 43
15 | User Reference Guide NOCTURN XL Camera
Command
Optional Payload
Description
help
Displays the console help menu
? Displays the console help menu
baudrate
Sets and reads the serial port baudrate
log Prints system boot log on the console
status
Reprints sign-on information on the console
av Prints analog video (av) menu on the console
cl
Prints CameraLink® (cl) menu on the console
temp
Prints temperature display menu on the console
update
user factory help
Updates user flash Updates factory flash Prints the update help menu on the console
version
Prints version firmware/software
xfer
Prints file transfer commands on the console
xmdm
Prints file transfer commands on the console
vid Prints video pipeline control menu
TOP LEVEL CONSOLE COMMANDS
Table 6 Top Level Console Commands
NVT 200-LC-0103 Revision: D
Page 15 of 43
Command
Optional Payload
Description
baudrate
Displays the current console baud rate and help for this command
baudrate
921600 460800 230400 115200 57600 38400 28800 19200 9600
Sets the console baudrate to the payload value. A carriage return must be sent to the camera within 20 sec of this command using the new baudrate to acknowledge the change.
To save the new baudrate as power on default, “save flash
<cr>” must be entered at the console.
Command
Optional Payload
Description
av gamma
x.xxx
Sets the gamma value for the analog video output channel
av power
0 1 Turns off the analog video output channel Turns on the analog video output channel
av set
NTSC PAL
Sets the analog video output to NTSC format Sets the analog video output to PAL format
av tp
0 1 2
Turns off the analog video test pattern Turns on the analog video channel test pattern Turns on the internal analog video chip test pattern
Command
Optional Payload
Description
cl gamma
x.xxx
Sets the gamma value for the digital video output channel
av power
0 1 Turns off the digital video output channel Turns on the digital video output channel
BAUDRATE COMMANDS
Table 7 Baudrate Commands
ANALOG VIDEO COMMANDS
PHOTONIS | 16
Table 8 Analog Video Commands
CAMERA LINK VIDEO COMMANDS
Table 9 Camera Link Video Commands
NVT 200-LC-0103
Revision: D
Page 16 of 43
17 | User Reference Guide NOCTURN XL Camera
Command
Optional Payload
Description
temp rd
xx
Reads temperature sensor register xx (0 is currently the default on the NOCTURN camera)
temp wr
xx dd
Writes the temperature register xx with value dd
Command
Optional Payload
Description
receive
[filename]
Xmodem/Ymodem receive file from PC. [filename] is the flash filename to write.
send
-x [filename]
-y [filename]
Sends [filename] using Xmodem1k protocol Sends [filename] using Ymodem1k protocol [filename] is the flash filename to send
Command
Optional Payload
Description
video agc
0 1 Automatic gain and exposure control disabled Automatic gain and exposure control enabled
Use agc status to see agc loop variables
video bpp
0 1 Sets the digital video output to 10bits per pixel Sets the digital video output to 8bits per pixel
video contrast
0 1 2 3 4
No contrast enhancement Histogram stretching contrast enhancement Histogram equalization contrast enhancement Limited/adaptive equalization contrast enhancement Unrounded histogram equalization contrast enhancement
video hconalways
0 1 Do not applycontrast enhancement every histogram update Service contrast enhancement every histogram update
video mf
0 1 2
Median filter turned off Median filter turned on Median filter turns on automatic in AGC loop
video sf
0 1 Disable the convolution filter Enables the convolution filter
video vflip
0 1 Image output in default vertical orientation Image output vertically inverted from default orientation
video zoom
x.x
Set the digital video zoom to x.x (1.0 to 4.0)
video framerate
0
Sets the camera video main frame rate to 60Hz
TEMPERATURE DISPLAY COMMANDS
Table 10 Temperature Display Commands
FILE TRANSFER COMMANDS
Table 11 FIle Transfer Commands
VIDEO PIPELINE COMMANDS
Table 12 Video Pipeline Commands
NVT 200-LC-0103 Revision: D Page 17 of 43
PHOTONIS | 18
Command
Optional Payload
Description
1 2 3
Sets the camera video main frame rate to 100Hz Sets the camera video main frame rate to 50Hz Sets the camera video main frame rate to 30Hz
video hist enable
0 1 Disables histogram hardware Enables histogram hardware
video hist limits
[height] [width]
Set histogram image limits
video hist print
Print histogram information on the console
video hist roi
[left][right][top][bot]
Sets the region of interest for the histogram
video hist status
Displays on the console the histogram settings and current metrics
video pan
[x] [y]
Pan the center image while in zoom to the XY coordinate (positive coordinate is down/right of center with standard imaging lens)
video shname
[filename]
Loads convolution filter with the flash name [filename].
Convolution filter is then enabled/disabled using the “video sf”
command
video tp
0 1 Video test pattern generator set to OFF Video test pattern generator set to ON
video trig polarity
0 1 External strobe trigger polarity set to active high External strobe trigger polarity set to active low
video trig delay
XX
Sets delay in micro seconds between start of new frame to the strobe output. Valid value range from 0 to 16000000.
video trig width
xx
Sets strobe output pulse width. Valid value range from 0 to
16000000.
Video trig enable
0 1 Disables the external strobe output Enables the external strobe output
Command
Optional Payload
Description
agcupdinterva
xx
Number of histogram readings needed before updating the gain and exposure parameters
saturationlev
xx
Sets the digital value at which a pixel is considered saturated
bdeltalimlo
xx
Sets the minimum brightness delta between the high and low limit of the cumulative histogram in conjunction with the
“saturationlev” to determine if the sensor output is saturated
when operating in low light mode
bdeltalim
xx
Sets the minimum brightness delta between the high and low limits of the cumulative histogram in conjunction with the
“saturationlev” to determine if the sensor output is saturated
AGC COMMANDS
A full list of the AGC related control parameters used with the NOCTURN XL can be displayed on the console by sending “agc status <cr>” at the console terminal. Each command in Table 13 should be preceded by “agc” before being sent to the camera
Table 13 AGC Commands
NVT 200-LC-0103
Revision: D
Page 18 of 43
19 | User Reference Guide NOCTURN XL Camera
Command
Optional Payload
Description
under normal operation
bhidnlimlo
xx
If the “bhipcagc” is lower than this digital output value, and the integration time equal or greater to “mg0max”, the AGC will switch the gain and NUC tables to operate in high gain
bhidnlim
xx
Reduces exposure or gain if “bhipcagc” is greater than this digital output value
bhipcagc
xx
Mean brightness high percentage of the cumulative histogram to remap the AGC algorithm that tries to maintain to “bhitgt” digital value
blopacagc
xx
Mean brightness low percentage of the cumulative histogram to remap the AGC algorithm that tries to maintain to 0 digital value
bhipccontrast
xx
Percentage of the cumulative histogram at which the histogram stretching maps to 1023 digital value output
blopccontrast
xx
Percentage of the cumulative histogram at which the histogram stretching maps to 0 digital value output
bhitgt
xx
Target brightness that AGC tries to maintain “bhipcagc”
bhiuplimlo
xx
If the “bhipcagc” is greater than this digital output value and
the integration time equal or smaller than “mg0max”, the AGC
will switch the gain and NUC tables to operate in medium gain
bhiuplim
xx
increase exposure or gain if “bhipcagc” is lower than this digital output value
count
xx
Number of histogram to average to calculate AGC statistics
hggain
[0-7]
Gain value used for the “High Gain” setting
hgmin
xx
Minimum integration time (in lines) of the “High Gain” setting
hgmax
xx
Maximum integration time (in lines) of the “High Gain” setting
hgtransdn
xx
Integration time (in lines) to set the sensor to when
transitioning from the “High Gain” to the “Medium Gain”
Setting
hgtransup
xx
Integration time (in lines) to set the sensor to when
transitioning from the “Medium Gain” to the “HighGain”
Setting
int_g
xx
Maximum reduction in percentage of the sensor exposure when the digital output is saturated
intgtime
xx
Set camera integration time (in lines) to x if the AGC is disabled
intglolim
xx
Maximum attenuation of the sensor exposure in percentage during an AGC update
intghilim
xx
Maximum gain of the sensor exposure in percentage during an AGC update
intgr8b4agc
[0|1]
Sets the AGC averaging statistics to open before (1) or during (0) an AGC update loop
lggain
[0-7]
Gain values used for the “Low Gain” setting
lgmin
xx
Minimum integration time (in lines) of the “Low Gain” setting
lgmax
xx
Maximum integration time (in lines) of the “Low Gain” setting
lgtransdn
xx
Integration time (in lines) to set the sensor to when
transitioning from the “Medium Gain” to the “Low Gain”
NVT 200-LC-0103
Revision: D Page 19 of 43
PHOTONIS | 20
Command
Optional Payload
Description
Setting
lgtransup
xx
Integration time (in lines) to set the sensor to when
transitioning from the “Low Gain” to the “Medium Gain”
Setting
m0gain
xx
Gain value used for the “Medium Gain” setting
m0gmin
xx
Minimum integration time (in lines) of the “Medium Gain”
setting
m0gmax
xx
Maximum integration time (in lines) of the “Medium Gain”
setting
m0gtransdn
xx
Integration time (in lines) to set the sensor to when
transitioning from the “High Gain” to the “Medium Gain”
Setting
m0gtransup
xx
Integration time (in lines) to set the sensor to when
transitioning from the “Medium Gain” to the “High Gain”
Setting
mingain
[0-7]
Adjusts the sensor minimum gain value
maxgain
[0-7]
Adjusts the sensor maximum gain value
gain
xx
Sets the camera gain to x if the AGC is diabled
mfongain
xx
Gain value to use to automatically turn on the median filter (video mf must be set to 2). This setting is used in conjunction with mfonexp.
mfoffgain
xx
Gain value to use to automatically turn off the median filter (video mf setting in the Video Pipeline menu must be set to
2). This setting is used in conjunction with mfoffexp.
mfonexp
xx
Exposure (in lines) to use to automatically turn on the median filter (video mf setting in the Video Pipeline menu must be set to 2). This setting is used in conjunction with mfongain.
mfoffexp
xx
Exposure (in lines) to use to automatically turn off the median filter (video mf in the Video Pipeline menu must be set to 2). This setting is used in conjunction with mfoffgain.
minbins
xx
Minimum number of bins used to stretch the image if contrast stretching is enabled.
NUC COMMANDS
A full list of the NUC (non-uniformity correction) related commands can be displayed on the console by sending “nuc <cr>” at the console terminal. Each command in Table 14 should be preceded by “nuc” before being sent to the camera. The NUC can be simply enables/disabled by entering the following commands at the console terminal:
Enable non-uniformity correction
o Send:
nuc on <cr>
o Receive:
gain and offset nuc tables enabled OK >
NVT 200-LC-0103
Revision: D
Page 20 of 43
21 | User Reference Guide NOCTURN XL Camera
Command
Optional Payload
Description
gain
on off
Enables the non-uniformity gain correction Disables the non-uniformity gain correction
offset
on off
Enables the non-uniformity offset correction Disables the non-uniformity offset correction
global gain
Displays the global gain for the non-uniformity correction on the console
global gain
xxx
Sets global gain for the non-uniformity correction to xxx
global offset
Displays the global offset for the non-uniformity correction on the console
global offset
xxx
Sets global offset for the non-uniformity correction to xxx
load gain
[filename]
Loads gain file [filename] into bufferset
load offset
[filename]
Loads offset file [filename] into bufferset
status
Displays current status of the non-uniformity correction on the console
use bufferset
Displays the current buffer set in use
use bufferset
xx
Sets bufferset number to xx to use for gain and offset tables
Command
Optional Payload
Description
cs lnf
0 2 4 8
Disables the line noise filter Sets the line noise filter to use 2 columns Sets the line noise filter to use 4 columns Sets the line noise filter to use 8 columns
Disable non-uniformity correction
o Send:
nuc off <cr>
o Receive:
nuc tables disabled global gain is disabled global offset is disabled OK >
Table 14 NUC Commands
CMOS SENSOR COMMANDS
CAUTION
Adjusting the default CMOS settings could affect the low
light level performance of the camera and the default non-
uniformity correction tables.
Table 15 CMOS Sensor Commands
NVT 200-LC-0103
Revision: D Page 21 of 43
Command
Optional Payload
Description
16
Sets the line noise filter to use 16 columns
cs vbo
[0-255]
Sets the video black offset when the line noise filter is enabled
cs active
0 1 Clears the sensor active signal to the CMOS image sensor Sets the sensor active signal to the CMOS image sensor
cs dumptbl
Displays camera sensor register default table data in console (store in camera)
cs dump
Displays current sensor register settings read from sensor on the console
cs rd
xx
Reads camera sensor register address xx and displays value on the console
cs wr
xx dd
Writes camera sensor register address xx with value dd
cs save
user
Saves current sensor register settings as power on default (the gain and exposure settings will be ignored and the values entered in under the agc setup table will be used)
Name
Address
Size
Description
SENSOR_ACTIVE
0 1 Disable/Enable continuous grabbing of images; external SENSOR_ACTIVE pulses are ignored
60FPS
1 1 Use 2 or 4 output channels, resulting in 60fps or 100 fps operation
ADDR_Y
2-3
11
The start address of the readout window. Valid range for this register is 0 to 1044-SIZE_Y.
SIZE_Y
4-5
11
The number of rows in the readout window. Valid range for this register is 1 to 1044
NROF_SLOPES
6 2 The number of slopes is 1, 2 or 3. ‘0’ is an invalid setting for this register.
INTE_FIRST
7-9
24
The number of slots light integrates on the pixels for the first slope of the response curve.
The default value yields the maximum integration time available while maintaining the desired maximum frame rates of 60fps and 100fps. A longer integration time will decrease the frame rate.
‘0’ is an invalid setting for this register.
INTE_SECOND
10-12
24
The number of slots light integrates on the pixels for the second slope of the response curve.
By default, the second slope is not used, so the default value is 0.
INTE_THIRD
13-15
24
The number of slots light integrates on the pixels for the
A list of all possible registers for the “cs wr” and “cs rd” is given in Table 16.
PHOTONIS | 22
Table 16 CMOS Sensor Registers
NVT 200-LC-0103
Revision: D
Page 22 of 43
23 | User Reference Guide NOCTURN XL Camera
Name
Address
Size
Description
third slope of the response curve. By default, the third slope is not used, so the default value is
0.
ADC_CALIB_MODE
16 2 Set the ADC calibration mode: 0  No calibration 1  Calibration during overhead row 2  Calibration at start of each (conversion) row (60 fps mode only!) 3  Calibration during overhead row and at start of each (conversion) row (60 fps mode only!)
COL_CALIB_MODE
16 1 Set the column amplifier calibration mode: 0  No calibration 1  Calibration at start of each row
CLOCK_SELECTION
17 2 Select the (input) high speed clock: 0  LVDS input clock 1  Analog PLL 2 & 3 Digital PLL
SELECT_PULSED
18 1 Change the behavior of the row select: 0  Select constant high during sampling 1  Select is low during transfer
CLK_ADC_CONT
18 1 Set the behavior of the ADC clock 0 ADC clock stops between reset and signal conversion 1  ADC clock continues to toggle between reset and signal conversion
COL_EB
18 1 Controls behavior of electrical black columns 0  All columns normal 1  First 20 columns (in non-flipped readout) are black, rest are normal
DB_TEST_IMAGE
18 1 Disable/Enable digital test image output
DB_OVF_DISABLE
18 1 Change the handling of large conversion results 0 Output is clipped at ‘1111111111’ 1  Output overflows and outputs lowest 10 bits
DB_LOAD_FALLING
18 1 Change the clock edge that is used to sample the digital data when going from parallel to serial data
FLIP
19 2 0  Read out left bottom to right top 1  Read out right bottom to left top 2  Read out left top to right bottom 3  Read out right top to left bottom
OFFSET_60FPS
20-21
10
Offset in 60 fps mode.
OFFSET_100FPS
22-23
10
Offset in 100 fps mode.
TRAINING_WORD
24-25
10
Set the training word that is sent on the data channels when the sensor is idle
TMUX1
26 4 Select output signal on digital multiplexer 1: 0  clk_pix 1  slot_adc 2  fval
NVT 200-LC-0103 Revision: D Page 23 of 43
PHOTONIS | 24
Name
Address
Size
Description
3  dval 4  sync_x_even 5  sync_x_odd 6  line_0_sample 7  line_0_adc 8  line_0_read 9  adc_ramp_r 10  adc_ramp_s 11  adc_vtzero 12  col_init 13  col_init_off 14  pix_select 15  pix_transfer
TMUX2
27 4 Select output signal on digital multiplexer 2: 0  clk_adc_gated 1  slot_pix 2  lval 3  bypass_even 4  sensor_idle 5  reset_first 6  reset_second 7  reset_third 8  row_clk_y 9  row_sync_y_read 10  row_sync_y_inte0 11  row_sync_y_inte1 12  row_sync_y_inte2 13  write 14  read 15  col_vtzero
DPLL_MULT
30 8 Digital PLL multiplication factor (252 = x10)
DPLL_EN
31 1 Disable/Enable digital PLL
DPLL_DIVMODE
31 1 Internal selection of feedback mechanism in digital PLL
DPLL_F_RANGE
31 2 Select output frequency range of digital PLL
APLL_MULT
32 5 Analog PLL multiplication factor = APLL_MULT + 1
TMUXA
33 4 Select output signal on analog multiplexer: 0  ground 1  CMDN_LVDS_REC 2 CMDN_2X 3  REF144 4  REF270 5  VDCPC_ADC 6  VCLAMP_ADC 7  VBGAP_BIAS 8  VTSIG 9  VTREF 10  VREF 11  VRAMP
NVT 200-LC-0103
Revision: D
Page 24 of 43
25 | User Reference Guide NOCTURN XL Camera
Name
Address
Size
Description
12  DPLL_LOCKED 13  DPLL_UNDERFLOW 14  DPLL_OVERFLOW 15  VRAMP
CLKMATCH
34 8 Set compensation for channel-to-channel skew: 0  no compensation 254  maximum compensation Note: ‘255’ is an invalid setting
PGA_GAIN
35 3 Set the analog gain in the column amplifier: 0  0.8 1  1.2 2  1.6 3  2.0 4  2.4 5 3.6 6  4.8 7  6.0
ADC_GAIN
36 6 Set the gain in the ADC
CHANNEL_EN
37 7 Disable/Enable output, clock and control channels: Bit[0]-Bit[3] Data channels Bit[4] Clock channel Bit[5] Control channel Bit[6] LVDS clock receiver
I_COLPC
38 4 Column load precharge current
I_COL
38 4 Column load current
I_COLAMP
39 4 Column amplifier current
I_ADC
39 4 ADC comparator current
I_COMPINV
40 4 ADC output invertor current limit
I_ADCPC
40 4 ADC precharge voltage buffer current
I_LVDS_REC
41 4 LVDS receiver current
I_LVDS_DRIV
41 4 LVDS driver current
V_ADCPC
42 7 ADC precharge voltage
V_ADCCLAMP
43 7 ADC clamp voltage
RST_LOW
44 7 Pixel reset low voltage
VTX_LOW0
45 7 Sets the saturation/anti-blooming level for the integration after slope 3.
VTX_LOW1
46 7 Sets the reset level for the third slope. Change this register to control the position of the knee point between slope 2 and slope 3. Sets the saturation/anti-blooming level in case of dual slope operation.
VTX_LOW2
47 7 Sets the reset level for the second slope. Change this register to control the position of the knee point between slope 1 and slope 2. Sets the saturation/anti-blooming level in case of single slope operation.
V_VRAMP2
48 7 Starting voltage of 2nd ramp in AD conversion
V_VRAMP1
49 7 Starting voltage of 1st ramp in AD conversion
V_VREF
50 7 Reference voltage for the column amplifier
V_TREF
51 7 Reference voltage for the reset conversion in
NVT 200-LC-0103 Revision: D Page 25 of 43
PHOTONIS | 26
Name
Address
Size
Description
test_mode
V_TSIG
52 7 Reference voltage for the signal conversion in test_mode
V_TEST_HIGH
53 6 Highest voltage adjustment of V_TREF and V_TSIG
V_TEST_LOW
54 6 Lowest voltage adjustment for V_TREF and V_TSIG
V_BLSUN
55 7 Voltage setting for clipping of reset in black sun protection
TEMP
62-63
16
Temperature sensor (readout only!)
7. GRAPHICAL USER INTERFACE
Windows 7 is expressly provided for evaluation purposes only. This software, including any and all derivative and/or modified works, is proprietary and wholly owned by PHOTONIS USA and subject to intellectual property protection. PHOTONIS USA assumes no responsibility whatsoever for the use of the GUI software and makes no guarantees or warranties, expressed or implied, about its quality, reliability, compatibility, or any other characteristics. It is expressly agreed and understood that no promises, guarantees, or warranties of any kind has been made. By installing and/or using the GUI software, the end user agrees to abide by the terms of this document and acknowledges receipt of notice that any redistribution, dissemination, or modification of the GUI software, in whole or in part, is strictly prohibited.
CAUTION
INSTALLATION
Recommended minimum computer configuration for the
NOCTURN XL Evaluation GUI:
Window 7 SPI (32/64bits)
i5 or i7 processor
4GB RAM memory
256Mbytes dedicated memory on graphic card
350MB of free hard drive space to install the software
NVT 200-LC-0103
Revision: D
Page 26 of 43
27 | User Reference Guide NOCTURN XL Camera
Description
Image
Download the the “Win 7 Evaluation GUI” installer from the NOCTURN camera website:
www.nocturncamera.com
The GUI is built using National Instruments’ LabVIEW
and requires the installation of the LabVIEW run time engine as well as National Instruments VISA drivers.
Double click on the installer and wait for the installer to finish with its initialization.
At the destination directory installation screen, click the
“Next” button.
On the “Start Installation” screen, click the “Next” button
to begin installing the software.
Table 17 Installation of the NOCTURN XL Windows Evaluation GUI
NVT 200-LC-0103 Revision: D Page 27 of 43
PHOTONIS | 28
Description
Image
Wait for the installation of the GUI to complete.
At the “Installation Complete” screen, click the “Finish”
button to exit the installer. Connect the camera to the USB port on the host PC.
Launch the evaluation GUI: go to “Start” and under “All
Programs” find the “PHOTONIS USA” directory and
click on the NOCTURN XL icon.
The software will start and the splash screen will appear showing the GUI version information and revision date.
NVT 200-LC-0103
Revision: D
Page 28 of 43
29 | User Reference Guide NOCTURN XL Camera
Description
Image
When turning on the Evaluation GUI for the first time,
an error message will be displayed: “Invalid Port
Configuration!” The error is returned because the camera did not respond to a status request message
on the default communication port. Click the “OK”
button on the message window.
Determine the camera COM port by looking in Windows device manager. The NOCTURN COM port
number can be seen under the “Ports (COM & LPT)” and will be labeled “Silicon Labs CP210x USB to UART
Bridge (COM XX)”.
On the “Settings” tab of the GUI enter the “COM XX” value found in device manager in the “Communication Port” control. Make sure that the “Baud Rate” control is
set to 115200 and click the red button indicator next to
the “Communication Port Open” control. The red
indicator should turn blue. At this point, communication with the camera should be
enabled and active. The COM port value will be saved as the default the next time the GUI is turned on.
GUI ENVIRONMENT
The NOCTURN XL evaluation GUI is meant to provide a simple user interface to control some of the main features of the NOCTURN XL camera. Functions that are not implemented in the GUI can be accessed by user using any terminal emulation software. The main GUI screen is divided into four sections (see Figure 6).
SECTION 1 : MENU BAR
File Menu
File: Exit- Closes the COM port to the camera and exits the GUI
Setup Menu
Setup: Serial Port: Open- Opens the COM port to the camera  Setup: Serial Port: Close- Closes the COM port to the camera
NVT 200-LC-0103 Revision: D Page 29 of 43
PHOTONIS | 30
Section 1
Section 2
Section 3
Section 4
Setup: Synchronize Sensors Register- Synchronizes the sensor registers between the
camera and the GUI. This option works only when the GUI is operated in “Engineering Mode”. The GUI will automatically do this operation at power up if the camera is powered on and the COM port has been previously setup.
Setup: Synchronize Camera Settings- Synchronizes the GUI control values with the camera.
The GUI will automatically do this operation at power up if the camera is powered on and the COM port has been previously setup.
Figure 6 Layout of the NOCTURN XL Evaluation GUI
Setup: Synchronize AGC Settings- Synchronizes the GUI AGC control values with the
camera. The GUI will automatically do this operation at power up if the camera is powered on and the COM port has been previously setup.
Setup: External Strobe- This options will open the external strobe (camera frame trigger
output) control window (see Figure 7). In that window the “Strobe” button control
enables/disables the external strobe output. The “Strobe Active Polarity” button switches the
NVT 200-LC-0103
Revision: D
Page 30 of 43
31 | User Reference Guide NOCTURN XL Camera
polarity of the strobe signal between high and low. The “Strobe Pulse Width” represent the
duration that the active signal is active (in micro seconds) during each frame. Finally, the
“Strobe Pulse Delay” is a user adjustable delay in micro seconds between the actual the sensor
frame start and asserting the strobe signal. To return to the main GUI screen, the “CLOSE
WINDOW” button needs to be pushed.
Setup: Restore Default Camera Settings- This option will execute a script to restore the
camera to the manufacturer’s default settings.
Setup: Restore Default Sensor Settings- This option will reload default settings to the image
sensors. It is important to note that restoring default settings may adversely affect the performance of the camera if some settings or the non-uniformity correction tables have been modified by the user.
Setup: Engineering Mode- This mode enables certain options for PHOTONIS technical
personnel to provide advanced support in the event that the camera is not working properly. This option is password protected and should only be used if directed to do so by PHOTONIS personnel.
Transfer Menu
Transfer: Send File- Option used to upload files to the camera such as convolution filters.
Please refer to the user guide for proper usage.
Transfer: X Receive File- Option used to download files from the camera using X Modem
protocol. Please refer to the user guide for proper usage.
Transfer: Y Receive File- Option used to download files from the camera using Y Modem
protocol. Please refer to the user guide for proper usage.
Transfer: Load NUC Tables 50/60fps- Use this option to upload Non Uniformity Correction
(NUC) correction tables for the 50/60fps camera configuration. When this option is selected a
NVT 200-LC-0103 Revision: D Page 31 of 43
Figure 7 External Strobe Setup Window
PHOTONIS | 32
pop window will appear to select the directory where the NUC tables are located. Please refer to the NOCTURN XL user guide for the default naming convention and format of these tables.
Transfer Load NUC Tables 100fps- Use this option to upload NUC correction tables for the
100fps camera configuration. When this option is selected a pop window will appear to select the directory where the NUC tables are located. Please refer to the NOCTURN XL user guide for the default naming convention and format of these tables.
Transfer: Update- This menu command is used to perform firmware/software updates for the
NOCTURN camera. After this menu option is selected a pop out window will appear for the user to select the desired update file (file extension with *.uscr). Please refer to the NOCTURN XL user guide for further details.
Transfer: Execute Script- This command is meant to execute a series of command in a
scripted fashion to update the camera configuration.
Help Menu
Help: About This Software- Displays the log-on splash screen (see Figure 8). Click the “Exit”
button to return to the main GUI screen
Help: Camera Version Info- Returns the camera software and firmware version information
(see Figure 9). Please have this information available when contacting PHOTONIS for technical support
Help: Help Manual- Opens a copy of this user manual in your default web browser.  Help: Website- Opens the NOCTURN camera website in your default web browser where you
can download updates for your NOCTURN camera.
SECTION 2: MAIN CONTROL TABS
The main control tab section allows users to navigate between the main functionality of the GUI.
Settings
This tab allows the user to set the communication interface and baud rate to the camera as well as
saving both the camera configuration and sensor configuration (for the ‘Fine Frequency Adjustment”
control, etc…). Additionally, this tab allows the user to select the camera operating frame rate and pixel bit depth. Further details on these functions are provided in the following sections.
Main Controls
Displays the main interface controls to the camera to turn on and off the video output, adjust the exposure time, perform digital zoom. Further details on these functions are provided in the following sections.
AGC Controls
Displays some of the Automatic Gain Control (AGC) controls for the camera, the user should refer to the NOCTURN XL user guide for a detailed explanation of the AGC algorithm and associated controls.
NVT 200-LC-0103
Revision: D
Page 32 of 43
33 | User Reference Guide NOCTURN XL Camera
Figure 8 Evaluation GUI Splash Screen
Figure 9 Camera Version Information Window
Contrast Controls
Displays the controls for the camera contrast enhancements, convolution filters and region of interest for the histogram. Please refer to the NOCTURN XL user guide for detailed explanation of these controls.
NVT 200-LC-0103 Revision: D Page 33 of 43
PHOTONIS | 34
SECTION 3 : CONTROLS TAB Settings
Communication Port- COM port used to communicate with the NOCTURN XL camera.  Baud Rate- Communication baud rate that camera is set to. By default this should be set to
115200.
Communication Port Open- Opens (blue) and closes (red) the COM port to the camera. It is
important to note that the event that the camera USB interface is disconnected and then
reconnected while the GUI is still running that the “Communication Port Open control” should be
switched back closed and reopened to re-establish communication with the camera.
Save Camera Configuration- Saves current state of the camera as power on default.  Save Sensor Configuration- Saves current state of the CMOS sensor as power on default.  Fine Frequency Adjustment- Adjusts the output frequency of the video output in 1/100Hz
steps. This feature is helpful when trying to fine tune output frequency of the sensor and camera to match a desired value.
Sensor Frequency- Switches the camera between preset frame rates: 60, 100, 50 and 30fps.
Please note that once the Sensor Frequency has been changed it is recommended to restart the camera.
Video Bit Depth- Switches the digital video bit depth between 10 and 8 bits per pixel.
Figure 10 GUI Settings Tab
NVT 200-LC-0103
Revision: D
Page 34 of 43
35 | User Reference Guide NOCTURN XL Camera
Main Controls
Digital Video Gamma- Adjusts the Gamma on the digital CameraLink® compatible video output
channel.
CL Power- Turns ON/OFF the Camera Link® Compatible video output  Analog Video Gamma- Adjusts the Gamma on the analog video output channel.  AV Format- Allows the user to select between the NTSC or PAL analog video format.  AV Power- Turns ON/OFF the analog video output.
Digital Zoom- Enables the user to adjust the camera digital zoom from 1X up to 4X. The digital
zoom feature only operates in the 30, 50 and 60fps modes.
Pan x Coordinate- Enables the user to pan the image on the X or horizontal axis when in zoom
mode (see Figure 12).
Pan y Coordinate- Enables the user to pan the image on the Y or vertical axis when in zoom
mode (see Figure 12).
Integration time- Allows the user to re-adjust the exposure time in the amount of lines of the
sensor. This setting is only valid when the “Automatic Gain and Exposure Control” is disabled. The integration time in units of time can be calculated using the following relationship in the 30, 50 and 60fps modes:
󰇛󰇜 
NVT 200-LC-0103 Revision: D Page 35 of 43
Figure 11 GUI Main Controls Tab
󰇛󰇜
  󰇛󰇜
PHOTONIS | 36
Pan +x
Pan +y
4x Zoom
Pan x = 0
Pan y =0
4x Zoom
Pan x = -220
Pan y = -40
Gain- Allows the user to switch between “Low Gain” (corresponds to a sensor analog gain
setting of 1.2x) and “High Gain” (sensor analog gain setting of 6x). These gain values can be changed by editing the AGC options via the camera console interface.
Noise Filter- Image mean filter. Filter can either set to “ON”, “OFF” or “AUTO”. In the latter, the
the noise filter turns on automatically based on the AGC exposure setting at low light.
Automatic Gain and Exposure Control- Enables/Disables the automatic exposure and gain
control of the camera.
Vertical Image Flip- Flips the image display along the vertical axis.  Non Uniformity Correction- Enables and disables the camera non uniformity correction tables.  Sensor Initialization- Cycles the CMOS video input interface and reloads the CMOS image
sensor power on default register settings.
Figure 12 NOCTURN Digital Zoom Pan Axes
AGC Controls
Cumulative Histogram %- Represents the upper and lower limit used in the cumulative
histogram to recalculate the AGC exposure and gain values.
Minimum Signal Swing (DN)- Minimum number of digital bins used in conjunction with the
“Saturation Level” control to determine if the sensor image is saturated.
NVT 200-LC-0103
Revision: D
Page 36 of 43
37 | User Reference Guide NOCTURN XL Camera
Frames to Avg.- Number of frames averaged to compute AGC statistics and update both the
exposure and gain settings of the sensor.
Saturation Level- Bin number (on 10 bit scale) used to determine if a pixel is saturated.  AEC Gain- Maximum exposure increase (in percentage) from the current value when updating
the sensor exposure setting.
AEC Attenuation- Maximum exposure decrease (in percentage) from the current value when
updating the sensor exposure setting.
Update Interval- Determines how often the AGC settings are updated based on the number of
time a new image histogram is calculated.
Min. Brightness- Minimum acceptable value of the “Cumulative Histogram” max percentage. If
the “Cumulative Histogram” max percentage value is lower than the “Min. Brightness” the AGC
algorithm will update the sensor exposure and gain accordingly.
Target Brightness- Target value for the “Cumulative Histogram” max percentage used to
calculate sensor exposure and gain settings when the “Cumulative Histogram” max percentage
value is either below the “Min. Brightness” or above the “Max Brightness” values.
Max. Brightness- Maximum acceptable value of the “Cumulative Histogram” max percentage.
If the “Cumulative Histogram” max percentage value is higher than the “Max. Brightness” the
AGC algorithm will update the sensor exposure and gain accordingly.
Low Gain Min. Int.- Minimum integration time value (in number of lines) used by the AGC to
recalculate new exposure setting in the low gain mode.
NVT 200-LC-0103 Revision: D Page 37 of 43
Figure 13 GUI AGC Controls Tab
PHOTONIS | 38
Low Gain Max. Int.- Maximum integration time value (in number of lines) used by the AGC to
recalculate new exposure setting in the low gain mode. If the new calculated exposure is greater than that number, the AGC algorithm will increase the gain of the sensor.
Low Gain Trans. Int.- Default exposure time (in number of lines) that the sensor is set to when
the AGC adjust the gain between the high and low setting.
High Gain Min. Int.- Minimum integration time value (in number of lines) used by the AGC to
recalculate new exposure setting in the high gain mode. If the new calculated exposure is smaller than that number, the AGC algorithm will decrease the gain of the sensor. High Gain Max Int. control on the AGC allow minimum frame rate set up : a value of 1066 corresponds to 60fps, 2132 to 30fps, 4264 to 15fps, …
Low Gain Max. Int.- Maximum integration time value (in number of lines) used by the AGC to
recalculate new exposure setting in the high gain mode.
Low Gain Trans. Int.- Default exposure time (in number of lines) that the sensor is set to when
the AGC adjust the gain between the low and high setting.
Contrast Controls
Cumulative Histogram %- Represents the upper and lower limit used in the cumulative
histogram to recalculate the upper and lower boundaries of the histogram stretching.
Contrast Mode-
o NONE- Disables contrast enhancement. o STRETCHING- Stretches the contrast such that the 0 value of the digital output
corresponds to the lower limit of the cumulative histogram bin number and the 1023
Figure 14 GUI Contrast Controls Tab
NVT 200-LC-0103
Revision: D
Page 38 of 43
39 | User Reference Guide NOCTURN XL Camera
Top
Bottom
Left
value of the digital output corresponds to the upper limit of the cumulative histogram bin number.
o EQUALIZATION- Performs standard histogram equalization. o LIMITED EQUAL.- Performs an a global adaptive contrast enhancement.
Min. Bin- Represents the minimum number of bins to use in the histogram stretching.  Convolution Filter-
o ON/OFF- Enables/Disables the convolution filter. o FILTER Selection Drop box- Switches between several pre-loaded convolution filters.
Histogram ROI- Selects the region of interest (ROI) utilized to calculate the histogram for the
AGC and the contrast enhancement (see Figure 15).
Figure 15 Histogram Region of Interest Setup
Set up according to conditions
On the standard NOCTURN XL, we usually do not preset different mode settings since the camera in this configuration is used for a variety of industrial application where the AGC and Gain parameters are adjusted to customer specific lighting and applications. For most of the product that we are putting for man portable applications (using the NOCTURN XS) we
usually have three modes pre-configured: day, automatic and night.
In the day mode
AGC = OFF (main camera tab of the GUI)
NVT 200-LC-0103 Revision: D Page 39 of 43
PHOTONIS | 40
PGA gain = 0 (under CIS Main tab of the GUI)
Integration time = 1 (main camera tab of the GUI). This for most daytime type conditions.
For the automatic mode
AGC = ON as your camera is setup.
ROI = approach or general guideline? (depending on optics and applications)
Pixel Saturation level = same (depending on optics and applications)
For the night mode
AGC = OFF
PGA Gain = 7
Integration time = 1066, 2132, 4264 (as low as 15fps. For the latter, the target frame rate =
1066* camera_frame_rate (50/60)/integration time. Example; for 15fps and camera is set for 60Hz operation, one should set the integration time to 4264 lines (under the main camera tab in the GUI).
SECTION 4: INFORMATION SECTION
This section of this GUI provides some basic information about the GUI. The “Communication Error” will
turn red whenever a command has not been accepted by the camera and the information button will display the GUI splash screen with the GUI revision number.
8. MAINTENANCE
This section covers basic maintenance that should be performed periodically by the end user. Please note that all servicing of the NOCTURN XL camera should be referred to PHOTONIS USA.
Recommended periodic inspection and cleaning It is recommend the camera be inspected and cleaned every time a lens change is performed.
WARNING
Opening the camera body, damage to the anti-tamper sticker or otherwise altering the device in ways not specifically recommended in this section may void the warranty. Any actions not specifically recommended should be discussed with PHOTONIS Technical Support.
1. Visually inspect the external surfaces of the camera and connectors for damage, bent pins and ensure they are clean and free of debris.
CAUTION
The NOCTURN XL camera must be handled carefully at all
times to prevent damage.
NVT 200-LC-0103
Revision: D
Page 40 of 43
41 | User Reference Guide NOCTURN XL Camera
2. Clean the external body of the camera, including connectors, with a dry, lint free cloth and soft brush if necessary to remove dirt, dust and debris. For caked on dirt, the cleaning cloth may be moistened with a small amount of water or Methanol.
CAUTION
To avoid damage to the camera hardware, do not immerse the camera in any type of liquid, and do not pour any liquid
on, or in the camera.
3. Inspect and clean the objective lens per the manufacturer’s instructions.
CAUTION
Be careful not to touch the glass surfaces. If you get
fingerprints or contamination on the glass surfaces, use
lens paper or lint free cotton-tipped applicators to clean the
glass. If moisture is needed, dampen the lens paper or
cotton-tipped applicator with clean isopropyl alcohol.
4. Visually inspect the sensor, visible through the CS mount, for dust, debris, and residue (e.g., fingerprints, smears, etc.)
5. Clean the sensor glass and board with low pressure, dry, compressed air or nitrogen if necessary.
6. If there are fingerprints, smears, or other oily residue, the sensor glass may be cleaned with a lint free cotton-tipped applicator moistened with a small amount of isopropyl alcohol. Allow the sensor to air dry.
7. After the sensor glass is dry, visually verify no residue remains.
8. Replace the clean objective lens.
9. STORAGE
In preparation for storage, it is recommended that all cables and connectors be removed from the camera.
1. If operating, shut down and power off the camera.
2. Disconnect all cables
3. Visually inspect the external surfaces of the camera and connectors for damage, bent pins and ensure they are clean and free of debris.
4. Clean the external body of the camera, including connectors, with a dry, lint free cloth and soft brush if necessary to remove dirt, dust and debris. For caked on dirt, the cleaning cloth may be moistened with a small amount of water or Methanol. Do not immerse the camera in any type of liquid.
NVT 200-LC-0103 Revision: D Page 41 of 43
PHOTONIS | 42
CAUTION
To avoid damage to the camera hardware, do not immerse the camera in any type of liquid, and do not pour any liquid
on, or in the camera.
5. Prior to long term storage, remove any objective lens and clean according to manufacturer’s instructions.
6. It is recommended that lenses be cleaned and wrapped in lens paper or a dry lint free cloth for storage.
7. After removal of the objective lens, check the sensor and board, visible through the CS mount, for dust or debris.
8. If necessary, clean the sensor and board with low pressure, dry, compressed air or nitrogen. If there are fingerprints or other oily residue evident on the sensor glass, the sensor glass may be cleaned with a lint free cotton-tipped applicator and Methanol.
9. If the sensor is cleaned using isopropyl alcohol, allow the sensor to air dry.
10. Once the sensor is fully dry, install the protective cap received with the camera over the CS mount.
11. Place the camera in a protective ESD bag and package.
12. For long term storage, a humidity and temperature controlled environment is recommended, however, the ambient temperature in the storage area should not exceed the range of -50°C to +80°C.
10. QUALITY
ACCEPTANCE TEST PROTOCOL
Prior to shipment to customers, all NOCTURN XL cameras are tested according to PHOTONIS Acceptance Test Protocol (ATP). The ATP verifies that the camera units meet the operating, functionality and imaging characteristics specified by PHOTONIS. Every unit is shipped with a test sheet displaying these characteristics against the NOCTURN XL specifications.
WARRANTY
Unless otherwise agreed, the Seller shall at its option repair or replace or refund the price paid for, those Nocturn XL Cameras which are proved to the Seller's reasonable satisfaction not to conform to the published specifications at the time of receipt by the Buyer or to have failed for any reason of faulty design, material or workmanship for a period of twelve (12) months following the date of delivery. Such warranty does not apply: (i) if the product has been modified or altered in any way by parties other than PHOTONIS, (ii) iif the product has been exposed to unusual or excessive environmental, mechanical, electrical, or thermal stress during the course of installation or use, or (iii) if the absolute maximum ratings are exceeded for any reason including, but not limited to, equipment design and improper device installation or application, or (iv) if product malfunction is the result of misuse, abuse, improper installation or application, alteration, accident, or negligence in use, storage, transportation or handling, or if the original identification markings on the product have been removed, defaced or altered.
In order to permit PHOTONIS to properly administer this warranty, Buyer shall (i) notify PHOTONIS promptly in writing of any claims, and (ii) provide PHOTONIS with the opportunity to inspect and test
NVT 200-LC-0103
Revision: D
Page 42 of 43
43 | User Reference Guide NOCTURN XL Camera
the product claimed to be defective. Such inspection may be on Buyer's premises and/or PHOTONIS may request the return of the product at Buyer's expense. However, PHOTONIS shall not be responsible for packing, inspection, or labor costs in connection with the return of product. In order to avoid administrative difficulties that result from unauthorized returns, Buyer shall request a formal Return Authorization from PHOTONIS before returning product for any reason.
Any product replaced shall belong to PHOTONIS and any repaired or replacement products shall be guaranteed for the unexpired portion of the 12 month warranty period.
The liability of PHOTONIS hereunder or otherwise is solely and exclusively limited to replacement, repair or credit of the purchase price, as PHOTONIS may elect, for any product which is returned by Buyer during the applicable warranty period, or services for which timely notice of defect has been given by Buyer, and which are found by PUPI to be subject to adjustment under this warranty. IN NO EVENT SHALL PHOTONIS BE LIABLE FOR SPECIAL, INDIRECT, INCIDENTAL OR CONSEQUENTIAL DAMAGES, LOSS OF ANTICIPATED PROFIT OR OTHER ECONOMIC LOSS OR FOR ANY DAMAGES ARISING IN TORT WHETHER BY REASON OF STRICT LIABILITY, NEGLIGENCE OR OTHERWISE.
PHOTONIS’ warranty as herein set forth shall not be enlarged, diminished or affected by, and no obligation or liability shall arise or grow out of, PHOTONIS’ rendering of technical advice, facilities or services in connection with Buyer's order or the products furnished hereunder.
The foregoing warranty extends to Buyer of PHOTONIS and not to purchasers or users of such Buyer's products, except that if Buyer is an authorized distributor of PHOTONIS, the foregoing warranty (and no other), subject to the terms and conditions thereof, may be extended to purchasers from such distributor of the products covered hereby. PHOTONIS MAKES NO OTHER OR FURTHER WARRANTY, INCLUDING ANY WARRANTY OF FITNESS FOR A PARTICULAR PURPOSE OR WARRANTY OF MERCHANTABILITY. All warranties, conditions and other terms implied by stature or common law are, to the fullest extent permitted, excluded.
NVT 200-LC-0103 Revision: D Page 43 of 43
Loading...