1.1 Features ............................................................................................................................................................. 5
2.1 Camera Characterization.................................................................................................................................... 7
3.2 Input/output Connectors and LED ................................................................................................................... 12
3.2.1 Power Connector ...................................................................................................................................... 13
3.2.2 Status LED Behaviour ................................................................................................................................ 14
4.1 CE Conformity .................................................................................................................................................. 15
5.1 Out of the box .................................................................................................................................................. 16
5.2 Setting up in the system ................................................................................................................................... 16
6 CAMERA SOFTWARE INTERFACE 17
6.1 Control and Interface ....................................................................................................................................... 17
6.2 Serial Protocol and Command Format ............................................................................................................. 18
7.1 Device Control .................................................................................................................................................. 19
7.2 Image Format ................................................................................................................................................... 22
7.2.1 HDR mode (Only available on “BHx” Models)........................................................................................... 26
7.3 Acquisition Control ........................................................................................................................................... 32
7.4 Gain and Offset ................................................................................................................................................ 37
7.5.3 Manual Flat Field Correction ..................................................................................................................... 45
7.5.4 FFC User Bank Management ..................................................................................................................... 46
7.7 Statistics and Line Profile ................................................................................................................................. 50
7.9 Image Control ................................................................................................................................................... 53
C.2 Example with Ratio 2 and 10bits output .......................................................................................................... 61
C.3 HDR With LUT 10bits => 8bits .......................................................................................................................... 62
C.4 Example of difference between “AB” and “C” Line : ....................................................................................... 62
Appendix D. CameraLink Data Cables 63
D.1 Choosing the Cable .......................................................................................................................................... 63
D.2 Choosing the Data Rate ................................................................................................................................... 64
Radiometric Performance at Maximum Pixel Rate and minimum camera gain
Bit depth
8, 10 and 12
Bits
Response (broadband)
450
LSB/(nJ/cm²)
Full Well Capacity
27300
(in 2S or 4S mode and MultiGain at 1/2)
electrons
Response non linearity
0,3
%
PRNU HF Max
3
%
Dynamic range (1S / 2S / 4S mode)
67,6 / 70,7 / 68,7
dB
1 CAMERA OVERVIEW
1.1 Features
Cmos Sensor 4x 8192 Pixels, 5 x 5µm
Multi-Line structure and Multi-Definition using Binning :
8192 pixels, 5x5µm in 1, 2 up to 4 lines summation
4096 pixels, 10x10µm in 1 or 2 lines summation
2048 pixels, 20x20µm
Interface : CameraLink®
BA0/BH0 version : Base or Medium, 85MHz down to 60MHz
BA1/BH1 version : Base, Medium, Full or Deca, 85MHz down to 60MHz
Line Rate : Up to 100000 l/s
Data Rate : Up to 850 MB/s
Bit Depth : 8, 10 and 12bits
Flat Field Correction
Look up Table
Low Power Consumption : < 7,5W
Compliant with Standard Lenses of the Market (F, T2, M42 Mounts)
Full Exposure Control, even in 4S “TDE” mode
“BHx” Models with HDR Mode (High Dynamic Range)
Centered Region of Interest in 5x5µm mode down to 4096 pixels.
1.2 Key Specifications
Note : All values in LSB are given in 12 bits format
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |6
Functionality (Programmable via Control Interface)
Sensor modes :
Multi-definition,
Multi-sensitivity
8k Pixels 5µ m : Multi-Lines 1, 2 or 4
4k Pixels 10µm : Binning 1 or 2 Lines
2k Pixels 20µm : Binning 4x4, 1 line
Analog Gain
Up to 12 (x4)
dB
Offset
-4096 to +4096
LSB
Trigger Mode
Timed (Free run) and triggered (Ext Trig, Ext ITC) modes
Mechanical and Electrical Interface
Size (w x h x l)
125 x 60 x 35
mm
Weight
360
g
Lens Mount
F-Mount, T2 and M42x1
-
Sensor alignment ( see chapter 2.1 )
±100
µm
Sensor flatness
50
µm
Power supply
Single 12 DC to 24 DC
V
Power dissipation - CameraLink
< 7,5
W
General Features
Operating temperature
0 to 55 (front face) or 70 (Internal)
°C
Storage temperature
-40 to 70
°C
Regulatory
CE, FCC and RoHS compliant
Part Number
Sensor
Outputs
Max Line Rate
Details
EV71YC4MCL8005-BA0
4x Lines, 8k 5x5µm
2x Lines, 4k 10x10µm
4x85MHz or 2x85MHz
40 KHz
80 KHz
-
EV71YC4MCL8005-BA1
4x Lines, 8k 5x5µm
2x Lines, 4k 10x10µm
Up to 10x85MHz
100 KHz
-
EV71YC4MCL8005-BH0
4x Lines, 8k 5x5µm
2x Lines, 4k 10x10µm
4x85MHz or 2x85MHz
40 KHz
80 KHz
New Sensor & HDR Function
EV71YC4MCL8005-BH1
4x Lines, 8k 5x5µm
2x Lines, 4k 10x10µm
Up to 10x85MHz
100 KHz
New Sensor & HDR Function
EV71YC2MCL8005-BA0
2x Lines, 8k 5x5µm
2x Lines, 4k 10x10µm
4x85MHz or 2x85MHz
40 KHz
80 KHz
New Sensor. 2 Lines only
EV71YC2MCL8005-BA1
2x Lines, 8k 5x5µm
2x Lines, 4k 10x10µm
Up to 10x85MHz
100 KHz
New Sensor. 2 Lines only
1.3 Description
e2v’s next generation of line scan cameras are setting new, high standards for line rate and image quality. Thanks
to e2v’s recently developed multi-line CMOS technology, the camera provides an unmatched 100,000 lines/s and
combines high response with an extremely low noise level; this delivers high signal to noise ratio even when short
integration times are required or when illumination is limited. The 5μm pixel size is arranged in four active lines,
ensuring optimal spatial resolution in both scanning and sensor directions with standard F-mount lenses. Vertical
and horizontal binning functions allow the camera to be operated in a 8,192 pixels, 5µm x 5µm pixel pitch, up to 4
active CMOS lines mode or 4,096 pixels, 10µm x 10 µm pixel pitch, 2 active CMOS lines mode depending on the
user settings. This versatile feature sets new standard for next generation machine vision systems
1.4 Typical Applications
Raw material surface inspection
Parcel and postal sorting
High resolution document scanning
1.5 Models
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |7
Unit
Mode 1S
(0dB
Mode 2S (0dB)
Mode 4S (0dB)
Mode 1SB
(0dB)
Mode 2SB
(0dB)
Mode 4SB
(**)
(0dB)
Typ.
Max
Typ.
Max
Typ.
Max
Typ.
Max
Typ.
Max
Typ.
Max
Dark Noise RMS
LSB
1,7
2,2
2,4
3,1 3 4 3 4 3 4 3 4
Dynamic Range
-
2394:1
-
3412:1
(*)
-
2730:1
(*)
-
2730:1
-
2730:1 -
2730:1
-
Readout Noise
e-
5,7 - 8 - 10 - 10 - 10 - 10
-
Full Well Capacity
e-
13650
-
27300
-
27300
-
27300
-
27300
-
27300
-
SNR
dB
40 - 43
(*)
-
43
(*)
-
43
(*)
-
43
(*)
- 43
(*)
-
Peak Response
(660nm)
LSB/
(nJ/cm2)
137 - 274 - 547
-
550
-
1100 - 2200
-
Non Linearity
%
0,3 - 0,3 - 0,3 - 0,3 - 0,3 - 0,3
-
Without Flat Field Correction :
FPN rms
LSB
0,4
1,5
0,7
1,5
0,8
1,5
0,8
1,5
0,8
1,5
0,8
1,5
FPN pk-pk
LSB
3,2
15 5 15
5,6
15
5,6
15
5,6
15
5,6
15
PRNU hf (3/4 Sat)
%
0,13
0,25
0,1
0,25
0,1
0,25
0,1
0,25
0,1
0,25
0,1
0,25
PRNU pk-pk (3/4 Sat)
% 1 3
0,8 3 0,8 3 0,8 3 0,8 3 0,8
3
2 CAMERA PERFORMANCES
2.1 Camera Characterization
Test conditions :
Figures in LSB are for a 12bits format.
Measured at exposure time = 50µs and line period = 50µs in Ext Trig Mode (Max Exposure Time)
Maximum data rate
Stabilized temperature 30/40/55 °C (Room/Front Face/Internal)
SNR Calculated at 75% Vsat with minimum Gain.
(*) In mode 2S/4S, only with the use of the Multi-Line Gain
(**) Mode 4S not available for EV71YC2MCL8005-BAx
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |8
a b c
d
a b c d a b c
d
C
A
C
Mode 1S = B
Mode 2S = B+C (FPGA)
Mode 4S = (A.B)+(C.D)
Note : (A.B) = summation in the
sensor (not available for
EV71YC2MCL8005-BAx)
8K Pixels Output
a b c d a b c
d
A
A
B
Mode 1SB = A
Mode 2SB = (A+B)
4k Pixels Output
ADC Column
ADC Column
Memory Node
Pixel Line A
Pixel Line B
Pixel Line C
Pixel Line D
Memory Node
a b c
d A Mode 4SB = A
2k Pixels Output
2.2 Image Sensor
The Eliixa+ 8k sensor is composed of two
pairs of sensitive lines. Each pair of lines use
the same Analog to Digital Column converter
(ADC Column). An appropriate (embedded)
Time delay in the exposure between each
line allows combining two successive
exposures in order to double the sensitivity
of a single line.
This Time Delay Exposure is used only in the
4S multi-line modes (4 Lines) and also in the
three binning modes, as described below.
The 8192 Pixels of the whole sensor are
divided in 2 blocks of 4096 pixels.
2.3 Sensor modes
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |9
0
100
200
300
400
500
600
400450500550600650700750800850900950100010501100
LSB12bits/(nJ/cm2))
nm
Response in 8k Pixels 5µm
4S2S1S
0%
10%
20%
30%
40%
50%
60%
70%
80%
3604605606607608609601060
Quantum Efficiency
2.4 Response & QE curves
2.4.1 Quantum Efficiency
2.4.2 Spectral Responses
Single Modes : 1S, 2S, 4S
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |10
0
100
200
300
400
500
600
700
800
900
1000
1100
1200
400450500550600650700750800850900950100010501100
LSB12bits/(nJ/cm2))
nm
Response in 4k Pixels 10µm
1SB2SB
0
200
400
600
800
1000
1200
1400
1600
1800
2000
2200
2400
400450500550600650700750800850900950100010501100
LSB12bits/(nJ/cm2))
nm
Response in 2k Pixels 20µm
4SB
Binning Modes : 1SB, 2SB
Binning 4x4 Mode
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |11
The Step file is available on the
www.e2v.com/cameras
X
Y
Z
3 CAMERA HARDWARE INTERFACE
3.1 Mechanical Drawings
web :
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |12
Sensor alignment
Z = -10.3 mm
±100µm
X = 9.5 mm
±100 µm
Y = 62.5mm
±100 µm
Flatness
50 µm
Rotation (X,Y plan)
±0,15°
Tilt (versus lens mounting plane)
50µm
USB Connector
Power Connector :
Multi-Colored LED
CameraLink
Connector CL2
CameraLink
Connector CL1
3.2 Input/output Connectors and LED
For Firmware
upgrade
12-24V DC
for Status and
diagnostic
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |13
Signal
Pin
Signal
Pin
PWR
1
GND 4 PWR
2
GND 5 PWR
3
GND
6
Power supply from 12 to 24v
Power 7,5W max with an typical inrush current peak of 1A during
power up
Camera supply
(Line Period Minimum)
Supply 12V
Supply 24V
I(mA)
P(W)
I(mA)
P(W)
Full 8Taps
605
7.26
303
7.272
Deca 10Taps
613
7.356
308
7.392
Base 2Taps
589
7.068
298
7.152
Medium 4Taps
598
7.176
302
7.248
3.2.1 Power Connector
Camera connector type: Hirose HR10A-7R-6PB (male)
Cable connector type: Hirose HR10A-7P-6S (female)
Typical current/Power during the grab (possible variation : +/- 5%)
Power Time : Max 40s (Green Light)
Inrush Current Peak Current Establishment time and level
24V
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |14
Colour and state
Meaning
Green
and continuous
OK
Green
and blinking slowly
Waiting for Ext Trig (Trig1 and/or Trig2)
Red
and continuous
Camera out of order : Internal firmware error
Adjacent Channels
Pixels per Channel
Versions Bx0/Bx1
Base : 2 Channels 8/10/12bits
2 x 85MHz (80/75/70/65/60MHz)
2 x 4096
Medium : 4 Channels 8/10/12bits
4 x 85MHz (80/75/70/65/60MHz)
4 x 2048
Version Bx1 (only)
Full : 8 Channels 8bits
8 x 85MHz (80/75/70/65/60MHz)
8 x 1024
Deca : 10 Channels 8bits
10 x 85MHz (80/75/70/65/60MHz)
10 x 819
12V
3.2.2 Status LED Behaviour
After less than 2 seconds of power establishment, the LED first lights up in ORANGE. Then after a Maximum of 40
seconds, the LED must turn in a following colour :
3.2.3 CameraLink Output Configuration
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |15
4 STANDARD CONFORMITY
The ELIIXA+ cameras have been tested using the following equipment:
A shielded power supply cable
A Camera Link data transfer cable ref. MVC-1-1-5-2M from CEI (Component Express, Inc.)
e2v recommends using the same configuration to ensure the compliance with the following standards.
4.1 CE Conformity
The ELIIXA+ cameras comply with the requirements of the EMC (European) directive
2004/108/EC (EN50081-2, EN 61000-6-2).
4.2 FCC Conformity
The ELIIXA+ cameras further comply with Part 15 of the FCC rules, which states that: Operation is subject to the
following two conditions:
This device may not cause harmful interference, and
This device must accept any interference received, including interference that may cause undesired operation
This equipment has been tested and found to comply with the limits for Class A digital device, pursuant to part 15
of the FCC rules. These limits are designed to provide reasonable protection against harmful interference when the
equipment is operated in a commercial environment. This equipment generates, uses and can radiate radio
frequency energy and, if not installed and used in accordance with the
instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a
residential area is likely to cause harmful interference in which case the user will be required to correct the
interference at his own expense.
Warning: Changes or modifications to this unit not expressly approved by the party responsible for compliance
could void the user's authority to operate this equipment.
4.3 RoHs Conformity
ELIIXA+ cameras comply with the requirements of the RoHS directive 2011/65/EU.
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |16
There is no CDROM delivered with the Camera : Both User Manual (this document) and
CommCam control software have to be downloaded from the web site : This ensure you to
have an up-to-date version.
Main Camera page : www.e2v.com/cameras
On the appropriate Camera Page (ELIIXA+ 8k/4k) you’ll find a download link
The first version of CommCam compliant is indicated in the last Chapter
CommCam download requires a login/password :
Login : commcam
Password : chartreuse
w
f
FOV
L
=
FOV
Focal Plan
Sensor Plan
f
L
w
s
Web
Direction
First
Pixel
Readout
Direction
5 GETTING STARTED
5.1 Out of the box
The contains of the Camera box is the following :
One Camera ELIIXA+
Power connector (
Hirose HR10A-7P-6S -female)
5.2 Setting up in the system
The Compliant Lenses Mounts are detailed in Appendix D
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |17
6 CAMERA SOFTWARE INTERFACE
6.1 Control and Interface
As all the e2v Cameras, the ELIIXA+ CL is delivered with the friendly interface control software COMMCAM.UCL
(as “Ultimate Camera Link”) which is based on the GenICam standard
COMMCAM recognizes and detects automatically all the UCL Cameras connected on any transport layers (Camera
Link or COM ports) of your system.
Once connected to the Camera you have an easy access to all its features. The visibility of these features can be
associated to three types of users: Beginner, Expert or Guru. Then you can make life easy for simple users.
Minimum version of CommCam is 2.1.4 in order to recognize the ELIIXA+ 8k/4k Camera (both versions)
The Versions “BHx” require a CommCam version 2.5.1 and further.
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |18
The camera return code has to be received before sending a new command. Some
commands are longer than the others : Waiting for the return code ensure a good treatment
of all the commands without saturating the buffer of the camera
Returned code
meaning
>0
(or “>OK”) : All right, the command will be implemented
>3
Error Bad CRC (for write command only)
>16
Invalid Command ID (Command not recognized or doesn't exist)
>33
Invalid Access (the receipt of the last command has failed).
>34
Parameter out of range (the parameter of the last command sent is out of range).
>35
Access Failure (bad communication between two internal devices).
6.2 Serial Protocol and Command Format
The Camera Link interface provides two LVDS signal pairs for communication between the camera and
the frame grabber. This is an asynchronous serial communication based on RS-232 protocol.
The serial line configuration is:
Full duplex/without handshaking
9600 bauds (default), 8-bit data, no parity bit, 1 stop bit. The baud rate can be set up to 115200
6.2.1 Syntax
Internal camera configurations are activated by write or readout commands.
The command syntax for write operation is:
w <command_name> <command_parameters><CR>
The command syntax for readout operation is:
r <command_name><CR>
6.2.2 Command Processing
Each command received by the camera is processed:
The setting is implemented (if valid)
The camera returns “>”<return code><CR>
The camera return code has to be received before sending a new command.
The Camera Returned Codes are :
6.2.3 GenICam ready
The CameraLink Standard is not yet compliant with GenICam Standard, but as much as possible, each command
of the ELIIXA+ will have its correspondence with the Standard Feature Naming Convention of the GenIcam
Standard.
This correspondence is given in parenthesis for each feature/command as the following example :
Vendor name (
DeviceVendorName
) : “e2v”
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |19
7 Camera Commands
7.1 Device Control
These values allow identifying the Camera. They can be accessed in CommCam software in the “Info” section
All these values are fixed in factory and can’t be changed (shaded) except the Camera User ID which can be fixed
by the Customer :
Vendor name (DeviceVendorName) : “e2v”
Read function : “r vdnm”;
Returned by the camera : “e2v”, string of 32 bytes (including “/0”)
Can not be written
Model Name (DeviceModelName) : Internal name for GenICam :
Read function : “r mdnm”;
Returned by the camera : String of 32 bytes (including “/0”) :
Can not be written
Device Manufacturer Info (DeviceManufacturerInfo) : Get Camera ID
Read function : “r idnb”;
Returned by the camera : String of 128 bytes (including “/0”)
Can not be written
Device Version (DeviceVersion) : Get Camera Hardware version
Read function : “r dhwv”;
Returned by the camera : String of 32 bytes (including “/0”)
Can not be written
Device Firmware Version (DeviceFirmwareVersion): Get camera synthetic firmware
Read function : “r dfwv”;
Returned by the camera : String of 16 bytes (including “/0”)
Can not be written
Device SFNC Version : 1.5.0
These Parameters (Major, Minor, Sub Minor) are only virtual ones in order to give the SFNC compliance of
the Camera.
Device ID (DeviceID) : Camera Factory identifier ID
Read function : “r deid”;
Returned by the camera : String of 128 bytes (including “/0”)
Write function : “w deid <idstr>”
Device User ID (DeviceUserID) : Camera user identifier ID
Read function : “r cust”;
Returned by the camera : String of 128 bytes (including “/0”)
Write function : “w cust <idstr>”
Electronic board ID (ElectronicBoardID) : Get PcB Board ID
Read function : “r boid”;
Returned by the camera : String of 32 bytes (including “/0”)
Can not be written
Device Temperature Selector (DeviceTemperatureSelector) : MainBoard
Can not be written
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |20
A standby mode, what for ?
The Standby mode stops all
activity on the sensor level. The
power dissipation drops down to
about 6W. During the standby
mode, the grab is stopped
Once the Standby mode turned
off, the Camera recovers in less
than 1ms to send images again
from the sensor.
Internal Temperature
25
30
35
40
45
50
55
60
65
70
75
0571020304050607080
90
100
110
120
130
140
Time (mn)
°C
Standby Off
Standby On
Device Temperature (DeviceTemperature) : Get Main Board Temperature
Read function : “r temp”;
Return by the camera : Temperature in Q10.2 format (8 bits signed + 2 bits below comma). Value is
between -512 to 511 in °C.
Device Serial Port Selection : Indicates the Serial Port on which the Camera is connected.
Device Serial Port Baud Rate (ComBaudRate): Set the Camera BaudRate
Read function : “r baud”;
Returned by the camera : Value of the Baud Rate
Write function : “w baud” <index> with the index as follows :
1 : 9600 Bauds (default value at power up)
2 : 19200Bauds
6 : 57600Bauds
12 : 115200Bauds
Standby Mode (Standby) : Activation of the Standby mode of the Camera
Write function : “w stby <val>”; <val> is 0 or 1.
Camera status : Get the Camera status register (32bits Integer)
Read function : “r stat”;
Returned by the camera : 32bits integer :
Bit 0 : (StatusWaitForTrigger) : True if no trig received from more than 1sec
Bit 1 : (StatusTriggerTooFast) : Missing triggers. Trig signal too fast
Bit 2 : (StatusSensorConnection) : True is the Sensor pattern is checked as failed.
Bit 3, 4, 5, 6, 7 : Reserved
Bit 8 : (StatusWarningOverflow) : True is an overflow occurs during FFC or Tap balance processing.
Bit 9 : (StatusWarningUnderflow) : True is an underflow occurs during FFC or Tap balance
processing
Bits 10 : Reserved
Bits 11 : Scrolling Direction : 0 = Forward, 1 = Reverse. Updated only by external CC3 (CameraLink)
Bits, 12, 13, 14, 15 : Reserved
Bit 16 : (StatusErrorHardware) : True if hardware error detected
Bits 17 to 31 : Reserved
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |21
Feature
CL Command
Description
DeviceVendorName
r vdnm
Get camera vendor name as a string (32 bytes long including ‘\0’)
DeviceModelName
r mdnm
Get camera model name as a string (32 bytes long including ‘\0’)
DeviceFirmwareVersion
r dfwv
Get camera synthetic firmware version (PKG version) as a string
(32bytes long including ‘\0’)
DeviceVersion
r dhwv
Get camera version as a string (hardware version) (32 bytes long
including ‘\0’)
DeviceManufacturerInfo
r idnb
Get camera ID as a string (48 bytes long including ‘\0’)
DeviceUserID
r cust
Get device user identifier as a string (16 bytes long including '\0')
w cust <idstr>
Set camera identifier to <idstr>
DeviceID
r deid
Read Serial Nb
ElectronicBoardID
r boid
Read Electronic Board ID
DeviceSFNCVersionMajor
Xml Virtual
DeviceSFNCVersionMinor
Xml Virtual
DeviceSFNCVersionSubMinor
Xml Virtual
DeviceTemperature
r temp
Read Mainboard internal temperature (format signed Q10.2 =
signed 8 bits, plus 2 bits below comma. Value from -512 to +511)
in °C
DeviceTemperatureSelector
Xml Virtual
Standby
r stby
Read Standby state (CMOS sensor)
w stby 0
Disable standby mode (“False”)
w stby 1
Enable standby mode (“True”), no more video available but save
power and temperature
STATUS REGISTER
r stat
Get camera status (see below for details)
StatusWaitForTrigger
Bit 0: true if camera waits for a trigger during more than 1s
Satus trigger too fast
Bit 1: true if camera trigger is too fast
StatusWarningOverflow
Bit 8: true if a an overflow occurs during FFC calibration or Tap
balance (available only for integrator/user mode)
StatusWarningUnderflow
Bit 9: true if a an underflow occurs during FFC calibration or Tap
balance (available only for integrator/user mode)
Cc3 Scrolling direction
Bit 11: 0 : forward, 1: reverse
StatusErrorHardware
Bit 16 : true if hardware error detected
Feature
Commands
Description
ComBaudRate
r baud
Get current baud rate (This feature is not saved in camera)
w baud 1
Set baud rate to “9600Bds”
w baud 2
Set baud rate to “19200Bds”
w baud 6
Set baud rate to “57600Bds”
w baud 12
Set baud rate to “115200Bds”
7.1.1 Command Tables
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |22
Modes
Connector CL1
Connector CL2
Mode value
Base 2 Channels 8 Bits
2 x 8 bits
-
5
Base 2 Channels 10bits
2 x 10 bits
6
Base 2 Channels 12 Bits
2x 12 bits
-
7
Medium 4 Channels 8bits
4 x 8 bits
0
Medium 4 Channels 10 bits
4 x 10 bits
4
Medium 4 Channels 12bits
4 x 12 bits
1
Full 8 Channels 8bits (Bx1 Version Only)
8 x 8 bits
2
Full+ 10 Channels 8bits (Bx1 Version Only)
10 x 8 bits
3
Structure of the Camera Link Channels for interfacing
Base Mode : 2 Channels Separate, outputted from Left to Right.
2x4096 pixels each Channel (No Binning)
2x2048 pixels in Binning Mode 1SB or 2SB,
2x1024 pixels in Binning mode 4SB.
Ch 1
Ch 2
Output direction
7.2 Image Format
Sensor Width (SensorWidth) : Get the physical width of the Sensor. This value is available in the
CommCam “Image Format Control” section :
Read function : “r snsw”;
Return by the sensor : Integer 8192.
Can not be written;
Sensor Height (SensorHeight) : Get the physical height of the Sensor. This value is available in the
CommCam “Image Format Control” section :
No Access. Virtual command in xml”; Value always = 1
Width Max (WidthMax) : Get the Maximum Width of the Sensor. This value is available in the CommCam
“Image Format Control” section :
No Access. The value is mapped on “SensorWidth”
Height Max (HeigthMax) : Get the Maximum height of the Sensor. This value is available in the CommCam
“Image Format Control” section :
No Access. Virtual command in xml”; Value always = 1
Output mode (OutputMode) : Set the CameraLink Output mode (refer also to Chap 3. : CameraLink Output
Configuration). This command is available in the CommCam “Image Format Control” section :
Read function : “r mode”;
Returned by the camera : Output mode from 0 to 3 (see table below).
Write function : “w mode” <value> :
detailed in the table below :
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |23
Medium Mode : 4 Taps Separate, outputted from Left to Right
4x2048 pixels each Channel (No Binning)
4x1024 pixels in Binning Mode 1SB or 2SB,
4x512 pixels in Binning mode 4SB.
FULL Mode : 8 Taps Separate, outputted from Left to Right. Available only on Bx1
versions.
8x1024 pixels each Channel (No Binning)
8x512 pixels in Binning Mode 1SB or 2SB,
8x256 pixels in Binning mode 4SB.
FULL+ (Deca) Mode : 10 Taps Separate, outputted from Left to Right. Available only on
Bx1 versions.
10x819 pixels each Channel (No Binning)
10x409 pixels in Binning Mode 1SB or 2SB,
10x204 pixels in Binning mode 4SB.
Data Output Frequency Reduction
The Purpose of this feature is to optimize (increase) the Length of the Cable when highest
Line Rate is not required. Each decreasing of the Data Frequency will increase the
minimum Line Period possible, this depending also on the Binning mode (number of pixels
outputted from 8192 to 2048
Ch 1
Ch 2
Ch 3
Ch 4
Ch 1
Ch 2
Ch 3
Ch 4
Ch 5
Ch 6
Ch 7
Ch 8
Ch 1
Ch 2
Ch 3
Ch 4
Ch 5
Ch 6
Ch 7
Ch 8
Ch 9
Ch 10
Output direction
Output direction
Output direction
Output Frequency (OutputFrequency) : Set the CameraLink Data Output Frequency. This value is available
In 2S Mode, the summation
of the two lines is done in
the FPGA : B+C
In 4S Mode, the summation
of the two double lines is
done in the FPGA :
(AB )+ (BC)
This mode works in “Time delay exposure” for the summation of each double line in the
sensor.
Binning modes
The two binning modes 1SB and 2SB give an output of 4k pixels 10x10µm.
As for the 2SB mode, the sensor manages the delay between the two exposures necessary
for a “good match” acquisition.
The 4SB is a binning 4x4 with an output of 2K pixels 20x20µm
Rectangular Pixels : Sensor Delay Top/Bottom
In addition to these Sensor modes, the Delay between the Top and The Bottom of the
Sensor (when both are used : Modes 2S, 4S, 2SB) can be disabled in order to get Rectangular
Pixels with the following equivalence :
2S (x2 5x5µm) => x1 Pixel 5x10µm
4S (x4 5x5µm) => x2 Pixels 5x10µm
2SB (x2 10x10µm) => x1 Pixel 10x20µm
ADC
ADC
Memory Node
Pixel Line A
Pixel Line B
Pixel Line C
Pixel Line D
Memory Node
Web Direction
2S
1S
4S
Exposure
delays
FPGA
Memory Node
Memory Node
Web Direction
Exposure
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |25
Sensor Mode (SensorMode) : Defines the number of Line used on the Sensor. This command is available
in the CommCam “Image Format Control” section :
Read function : “r smod”;
Returned by the camera : Integer from 0 to 5
Write function : “w smod” <value> :
“0” : “1S” mode or Single Line.
“1” : “2S” mode or Dual Lines.
“2” : “4S” mode or Four Lines (Not available for EV71YC2MCL8005-BAx models)
“3” : “1SB” mode : Binning mode (2x2) which outputs on line of 4k pixels in 10µmx10µm.
“4” : “2SB” mode : Binning mode 2 x (2x2) which outputs the summation of 2 lines of 4k pixels in
10µmx10µm.
“5” : “4SB” mode : Binning mode (4x4) which outputs 1 line of 2k pixels in 20µmx20µm.
“6” : HDR mode : Set the Camera in HDR mode. See below for explanation
Sensor Delay Top/Bottom (DisableDelay) : Disables the delay between Top and Bottom Lines of the
Sensor to get rectangular Pixels. This command is available in the CommCam “Image Format Control”
section :
Read function : “r ddtp”;
Returned by the camera : Integer from 0 or 1 (Enabled or disabled)
Write function : “w ddtp” <value> :
ROI Width (ROIWidth) : Set the Region of Interest in 5x5µm. This value is available in the CommCam
“Image Format Control” section :
Read function : “r roiw”;
Return by the Camera : the current ROI
Write Function : “w roiw <value>” : Set the ROI from 8192 (No ROI) down to 4096 (ROI Max)
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |26
Line A
Line B
Line C
Line D
These 2 Lines work in TDI mode
This Line works alone in Controlled exposure Mode
This Line is not used
7.2.1 HDR mode (Only available on “BHx” Models)
The High Dynamic Range Mode is using the top and bottom couple of lines of the sensor in a different way in
order to get 2 different exposures that can be combined to give a High Dynamic range result :
and Full Exposure Time
There are three different possible outputs
when the HDR mode is set :
Single Line Bottom only : Line “C” only is outputted to check the High Levels
Single Line Top only : Line “A+B” is outputted to check the Low Levels
Single Line HDR : The Camera outputs the HDR Line reconstructed from “A+B” and “C” Lines in the camera in
the “HDR” bloc.
The Exposition of the “C” Line is automatically controlled by setting the HDR Ratio :
Ratio 1 : Equivalent to x2 ratio between Top and Bottom or 1 bit in the Dynamic
Ratio 2 : Equivalent to x4 ratio between Top and Bottom or 2 bit in the Dynamic
Ratio 4 : Equivalent to x8 ratio between Top and Bottom or 3 bit in the Dynamic
Ratio 8 : Equivalent to x16 ratio between Top and Bottom or 4 bit in the Dynamic
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |27
How to Set the HDR Mode
Set The Sensor Mode in “HDR”
Set The HDR Mode in “Single Line HDR” to Output an HDR Line
Select the Ratio of exposure required between the low and the high level Lines.
Set the Camera Synchronization Mode in Full Exposure Mode Preset : The choice of the
exposure of the single Line is made in Automatic by selecting the Ratio between High
and Low Level Lines.
More details are given in Appendix C
The following HDR Parameters are available only if the Sensor Mode is set to “HDR” :
HDR Mode (HDRMode) : Set the HDR Mode Output. This command is available in the CommCam “Image
Format Control” section :
Read function : “r hdrm”;
Returned by the camera : Integer from 0 to 2
Write function : “w hdrm” <value> :
“0” : Output Single Line Bottom Only.
“1” : Output Single Line Top Only
“2” : Output HDR Line
HDR Ratio (HDRRatio) : Set the HDR Ratio. This command is available in the CommCam “Image Format
Control” section :
Read function : “r hdrr”;
Returned by the camera : Integer from 0 to 3
Write function : “w hdrr” <value> :
“0” : Ratio 1 or x2 between LSB and MSB
“1” : Ratio 2 or x4 between LSB and MSB
“2” : Ratio 4 or x8 between LSB and MSB
“3” : Ratio 8 or x16 between LSB and MSB
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |28
Why Using a Multi-Line Gain of x0,5 ?
When the Light source is enough to use the “1S” mode of the Sensor (one single line), the
best is to use 2 lines (“2S” mode) and then to divide the result by two by using the Multi-
Line Gain set at “x0,5” :
In this case, the Full Well capacity is multiplied by x2 (two output registers are used) but the
noise divided by √2 therefore the SNR is improved by a factor of √2.
ADC
Memory
Memory Node
Web Direction
2S
1S
Exposure
ADC
Multi-Line Gain (MultiLineGain) : Enables the MultiLine Gain of x0,5 . This value is available in the
CommCam “Image Format Control” section :
Read function : “r mlig”;
Return by the sensor : “0” if disabled (Gain x1 by default); “1” if Gain x0,5 activated.
Write Function : “w mlig <value>”
“0” : Default Gain x1 is active.
“1” : Gain x0,5 is enabled (only when the 2S mode of the sensor is enabled)
Reverse Reading (X) (ReverseReading) : Allows to output the line in the Reverse-X direction. This value is
available in the CommCam “Image Format Control” section :
Read function : “r revr”;
Scan Direction (ScanDirection) : Set the scan direction for the sensor. This value is available in the
Return by the Camera : 0 or 1 (enabled/disabled)
Write function : “w revr <value>”;
“0” : Disabled.
“1” : Enables the reverse reading out (see below for “normal” direction)
CommCam “Image Format Control” section :
Read function : “r scdi”;
Return by the Camera : 0, 1 or 2 (Forward/reverse/external)
Write function : “w scdi <value>”;
“0” : Forward.
“1” : Reverse
“2” : Externally controlled (by CC3 of the
CameraLink Sync signals)
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |29
Web
Direction
First
Readout
Direction
Forward/reverse information has to be set correctly as soon as the Mode “2S”, “4S” or 2SB of the sensor are set :
In these modes, the sensor/Camera need to know what is the real order of the lines for the exposure delays.
The Forward direction is defined as detailed beside
:
Note : The minimum delay for the Camera to take
in account a change in the ScanDirection value is :
Using CC3 signal : 100ms.
Using serial command
(*)
After reception of the Command on the camera side
(*)
: 120ms
If the Camera is in 4S Sensor mode, after changing
of the scanning direction, the 5 first following
triggers will be ignored in order to reinitialize the
“Full Exposure Control” mode. Then the 3 following
lines acquired will be more or less black because in
4S, 4 lines are required for a complete exposure.
In 2S or 2SB Sensor modes, no Trigger will be lost
after the change of scanning direction but the first
line acquired will be more or less black as in 2S, 2
lines are required for a complete exposure.
In 1S, 1SB or 4SB modes, nothing is lost an all lines received after the delay are correct.
This positioning takes also in account that the mode “Reverse X” is “Off” (Normal readout direction)
Test Image Selector (TestImageSelector) : Defines if the data comes from the Sensor or the FPGA (test
Pattern). This command is available in the CommCam “Image Format” section :
Read function : “r srce”;
Returned by the camera : “0” if Source from the Sensor and “1 to 5” if test pattern active
Write function : “w srce” <value> :
“0” : To switch to CCD sensor image
“1” : Grey Horizontal Ramp (Fixed) : See AppendixA
“2” : White Pattern (Uniform white image : 255 in 8Bits or 4095 in 12bits)
“3” : Grey Pattern (Uniform middle Grey : 128 in 8bits or 2048 in 12 bits)
“4” : Black Pattern (Uniform black : 0 in both 8 and 12 bits)
“5” : Grey vertical Ramp (moving)
The test pattern is generated in the FPGA : It’s used to point out any interface problem with the Frame Grabber.
When any of the Test pattern is enabled, the whole processing chain of the FPGA is disabled.
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |30
Feature
Command
Description
SensorWidth
r snsw
Get sensor physical width.
SensorHeight
Xml virtual
WidthMax
Map on
SensorWidth HeightMax
Xml virtual
Height
Xml virtual Width
Xml virtual
Depends on (OuputRegion, OuputRegionWidth) and SensorWidth
SensorMode
r smod
Get sensor mode
w smod 0
Set sensor mode to DualLine “1S
w smod 1
Set sensor mode to MultiLine “2S
w smod 2
Set sensor mode to QuadriLine “4S” (*)
w smod 3
Set sensor mode to MonoLine “1SB
w smod 4
Set sensor mode to DualLine “2SB” (*)
w smod 5
Set sensor mode to DualLine “4SB” (*)
w smod 6
Set the HDR mode (*)(**)
HDRMode
r hdrm
Read the HDR Mode output configuration (when HDR is On)
w hdrm 0
Set the HDR Output on Bottom Line only (when HDR is On)
w hdrm 1
Set the HDR Output on Top Line only (when HDR is On)
w hdrm 2
Set the HDR Output on Single HDR Line (when HDR is On)
HDR Ratio
r hdrr
Read the HDR Ratio (when HDR is On)
w hdrr 0
Set the HDR Ratio to 1 or x2 (when HDR is On)
w hdrr 1
Set the HDR Ratio to 2 or x4 (when HDR is On)
w hdrr 2
Set the HDR Ratio to 4 or x8 (when HDR is On)
w hdrr 3
Set the HDR Ratio to 8 or x16 (when HDR is On)
Full Exposure Control Mode
r stbm
Get Full Exposure Control Mode (*)
w stbm 0
Mode 4S/2S with all lines (*)
w stbm 1
Mode 4S/2S without incorrect lines (*)
w stbm 2
Mode 4S only (*)
MultiLineGain
r mlig
Get MultiLine gain
w mlig 0
Set MultiLine gain to “x1”
w mlig 1
Set MultiLine gain to “x1/2” (not available if SensorMode = 0 or =
5 (“1S”/”4S” modes)
ScanDirection
r scdi
Get scan direction
w scdi 0
Set scan direction to “forward”
w scdi 1
Set scan direction to “reverse”
w scdi 2
Set scan direction to “Externally controlled direction via CC3
Camera Link (CC3=0 forward, CC3=1 reverse)”
ReverseReading
r revr
Get reverse reading value
w revr 0
Set reverse reading to “disable”
w revr 1
Set reverse reading to “enable”
OutputMode
r mode
Get output mode (CameraLink configuration and CMOS sensor
resolution)
w mode 0
Set output mode to “Medium4Outputs8bits”
w mode 1
Set output mode to “Medium4Outputs12bits”
w mode 2
Set output mode to “Full8Outputs8bits”
w mode 3
Set output mode to “FullPlus10Outputs8bits”
7.2.2 Command Table
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |31
Feature
Command
Description
OutputFrequency
r clfq
Get Camera Link frequency
w clfq 0
Set Camera Link frequency to 85MHz
w clfq 1
Set Camera Link frequency to 60MHz (available only for 8k sensor)
w clfq 2
Set Camera Link frequency to 65MHz (available only for 8k sensor)
w clfq 3
Set Camera Link frequency to 70MHz (available only for 8k sensor)
w clfq 4
Set Camera Link frequency to 75MHz (available only for 8k sensor)
w clfq 5
Set Camera Link frequency to 80MHz (available only for 8k sensor)
TestImageSelector
r srce
Get test (output FPGA) image pattern
w srce 0
Set test (output FPGA) image pattern to “Off”, processing chaine
activated
w srce 1
Set test (output FPGA) image pattern to “GreyHorizontalRamp”,
processing chaine desactivated
w srce 2
Set test (output FPGA) image pattern to “White pattern”,
processing chaine desactivated
w srce 3
Set test (output FPGA) image pattern to “gray pattern”, processing
chaine desactivated
w srce 4
Set test (output FPGA) image pattern to “Black pattern”,
processing chaine desactivated
w srce 5
Set test (output FPGA) image pattern to
“GreyVerticalRampMoving”, processing chaine desactivated
Output Centered ROI
r roiw
Return current ROI between 4096 to 8192
w roiw <val>
Set new ROI Value between 4096 to 8192 (No ROI)
DisableDelay
r ddtp
Read the Sensor Top/Bottom Delay status
w ddtp 0
Enable Top/Bottom delay
w ddtp 1
Disable Top/Bottom delay on Sensor for Rectangular Pixels
(*) Not available for 2-Lines Models : EV71YC2MCL8005-BAx
(**) Only available for “BHx” Models
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |32
The Timing diagrams associated to each Synchronization mode and the Timing values
associated are detailed in the APPENDIX B of this document.
Due to the limitation of the timing pixel inside the sensor, the Exposure time has to be set by
taking in account the limitation detailed in the APPENDIX B of this document.
The Minimum exposure time which can be set is 1,5µs
7.3 Acquisition Control
This section deals with all the Exposure, Line period and synchronisation modes
Synchronisation Mode (TriggerPreset) : Timed or Triggered, it defines how the grabbing is synchronized.
This command is available in the CommCam “Acquisition Control” section :
Read function : “r sync”;
Returned by the camera :
“0” : Internal Line Trigger with Exposure time Internally Controlled (Free Run). Not available when
Sensor mode is set in “4S” (whatever the firmware version)
“1” : External Trigger with Exposure Time Internally Controlled. Available also when Sensor mode
is set in “4S”.
“2” : External Trigger with maximum Exposure time
“3” : One External with Exposure Time Externally Controlled. The same Trigger signal defines the
line period and its low level defines the exposure time. Available also when Sensor mode is set in
“4S”
“4” : Two External Triggers with Exposure Time Externally Controlled : CC2 defines the start of
the exposure (and also the start Line) and CC1 defines the Stop of the exposure. Not available
when Sensor mode is set in “4S”
“5” : Internal Line Trigger with maximum Exposure Time
Write function : “w sync” <value>
Exposure time (ExposureTime): Defines the exposure time when set in the Camera. This command is
available in the CommCam “Acquisition Control” section :
Read function : “r tint”;
Returned by the camera : Integer from 15 to 65535 (=1,5µs to 6553,5µs by step o 0,1µs)
Write function : “w tint” <value> ;
This value of exposure time is taken in account only when the synchronisation mode is “free run” (0) or “Ext Trig
with Exposure time set” (1). Otherwise it’s ignored.
Line Period (LinePeriod) : Defines the Line Period of the Camera in Timed mode. This command is
available in the CommCam “Acquisition Control” section :
Read function : “r tper”;
Returned by the camera : Integer from 1 to 65536 (=0,1µs to 6553,6µs by step o 100ns)
Write function : “w tper” <value> ;
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |33
The Tables of the minimum Line Period (Max Line Rate) versus the Data rate and the output
mode chosen are given in Appendix C of this document.
Trigger too Slow
By default, the trigger is considered too slow after 1000ms of missing Incoming Trigger.
This limit can be tuned now by the User. This tuning is particularly important when the
camera is in 4S with the Exposure control active and the Control Exposure mode set in “4S Only” : In this mode the incoming Line Period is delayed from one line to be reproduced in
the camera after an exact measurement of the Line Period. If the trigger stops for a period
of time below the limit, this will considered as a “long time Line” and not a stop : Then the
next line will be delayed from the same value with the risk to loose new incoming triggers.
The Trigger too Slow limit has to be set at a value which is considered in the Application as
the minimum value for a real stop in the incoming trigger.
The line period is active only in Free Run modes. It’s also disabled if in this mode, the Integration time is set higher
than the Line Period.
Trigger Too Slow : Defines the Time limit (in ms) for the Camera to consider that the Incoming trigger is
too slow. This command is available in the CommCam “Acquisition Control” section :
Read function : “r tgts”;
Returned by the camera : Integer from 1 to 5368 (1 to 5368 milliseconds by step of 1ms)
Write function : “w tgts” <value> ;
Full Exposure Control Mode : set the behaviour of the Full Exposure Control Mode when active . This
value is available in the CommCam “Image Format Control” section :
Read function : “r stbm”;
Return by the Camera : Integer from 0 to 2
Write Function : “w stbm <value>”
“0” : Mode 4S/2S With all Lines at the Switch
“1” :Mode 4S/2S Without incorrect Lines at the Switch
“2” : 4S Only
This parameter is not available if the Sensor Mode is not 4S.
In addition, it has no effect if the Synchronization mode is not in Exposure Controlled (in 4S)
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |34
The Full Exposure Control
In 4S Sensor Mode, the Sensor is working as a double TDI (Time Integration Delay) : The two Top
Pixels and the two bottom Pixels are working together in TDI with a delay between their exposure
and outputting by the same Memory node and ADC. The summation of the pixels is done in the
“charge domain” before the Digital Conversion.
In TDI, control of the exposure is not possible: Only the full Exposure during the Line Period is
possible. In order to allow the User to control the exposure in this 4S Sensor mode (Synchronization
Modes 1 and 3, described in the Acquisition control chapter), The ELIIXA+ Camera implement a “Full
Exposure Control Mode” :
When the User selects a synchronization mode which requires the control of the exposure, the
camera enters a specific mode:
The Line Period (measured) is Tper, its minimum value is TPer
mini
(10µs on this camera) and the
exposure time set by the User is Prog_Tint.
stb
(max. x4)
mini
, Prog_Tint) + 10µs
The Sensor works in Full Exposure during the whole Line Period (LP) and the gain applied on the
output is variable (max x 4), set by User = G
stb
The Output is multiplied by the following Gain = G
stb
x Prog_Tint / Tper
mini
, Prog_Tint) + 10µs
Switch Point
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |35
Full Exposure Control Mode
appear (either too dark or too bright). You can remove these lines by using the following parameter:
decreases as the Line Period increases. This mode is the best one if the Line period varies but doesn’t
increase that much after the switch point (4 x Max (TPer
mini
, Prog_Tint) + 10µs)
sent, even the double dark or double white at the transition (depending on the direction of the
transition).
double dark or double white lines at the transition (depending on the direction of the transition) are
removed (not sent) : Two lines triggered will miss in the LVAL signal.
Gain for the “Full Exposure Control Mode”
G
stb
: The User Can set this Gain with a value up to x4 (Gain Section). The value recommended is
the one which allows to cover the variation of the line period : 10% of variation requires a Gain at
least of x1.2 (+/- 10%).
By default this value is set at x4.
Feature
Commands
Description
LinePeriod
r tper
Get current line period
w tper <val>
Set line period, from from 1 (0,1µs) to 65535 (6553,5µs), step 1
(0,1µs)
LinePeriodMin
r tpmi
Get current line period min (0..65535 step 0,1µs)
AcquisitionLineRate
Xml Virtual
= 1 / LinePeriod in Hertz
ExposureTime
r tint
Get exposure time
w tint <val>
Set exposure time, from 1 (0,1µs) to 65535 (6553,5µs), step 1
(0,1µs)
TriggerPreset
r sync
Get trigger preset mode
w sync 0
Set trigger preset mode to Free run timed mode, with exposure
time and line period programmable
w sync 1
Set trigger preset mode to Triggered mode with exposure time
settings
w sync 2
Set trigger preset mode to Triggered mode with maximum
exposure time
w sync 3
Set trigger preset mode to Triggered mode with exposure time
controlled by one signal
w sync 4
Set trigger preset mode to Triggered mode with exposure time
controlled by two signals
w sync 5
Set trigger preset mode to Free run mode, with max exposure
Gain Full Exposure Control (G
): Set the Gain for the Control of Full Exposure Mode . This value is
stb
available in the CommCam “Gain & Offset” section :
Read function : “r stbg”;
Return by the sensor : value of the Gain between 0 and 49151
Write Function : “w stbg <value>”
<value> = Gain between 0 and 49151 (Gain = 1 + <value>/16384)
7.3.1 Command Table
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |36
Feature
Commands
Description
time and programmable line period
Trigger too Slow
r tgts
Get Trigger too slow in milliseconds
w tgts <val>
Set Trigger too slow from 1ms to 5368ms, step 1ms
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |37
Analog Gain in the ADC
The only analog Gain available in the ELIIXA+ is located at the sensor level, in the ADC
converter.
This “Preamp Gain” is in fact a variation of the ramp of the comparator of the ADC.
Then 3 Values are available : x1, x2 and x4. A gain x1 in a 12 bits conversion is equivalent
to x4 in 10 bits.
OUT
Pixel
X
Preamp
X
ROI
Gain
+
X
FFC
X
FFC
+
X
LUT or
X
Quarter (Tap)
Action on whole line
Action per Sensor’s Quarter
X
Amp
Gain
x1
x2
x4
LSB
FWC
Comparator Ramps
Clamp (Black
Ref)
1024
electrons
4096
x1
x2
x4
7.4 Gain and Offset
Gain
Action per pixel
Offset Gain
Adjust
Gains
Contrast Exp.
Offset Gain
at different Gains
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |38
The Contrast Expansion (both Digital Gain & Offset) will be automatically disabled if the LUT
is enabled.
Preamp Gain : (Gain with GainSelector= AnalogAll)
Set the Pre-amplification Gain. This command is available in the CommCam “Gain & Offset” section.
Read function : “r pamp”;
Returned by the camera : Integer corresponding to one of the 3 different step values :
0 : x1 (0dB)
1 : x2 (6dB)
2 : x4 (12dB)
Write function : “w pamp” <int> ;
Gain: (Gain with GainSelector= GainAll)
Set the Amplification Gain. This command is available in the CommCam “Gain & Offset” section :
Read function : “r gain”;
Returned by the camera : Value from 0 to 6193 corresponding to a Gain range of 0dB to +8dB
calculated as following : Gain(dB) = 20.log(1+ Gain/4096).
Write function : “w gain” <int> ;
Tap Gain (Gain with GainSelector=TapX) :
Read function : “r fga<tap>”; <tap> is 1 or 2
Returns the Gain value for the tap. Ex : “r fga1” returns Gain value Tap1.
Write function : “w fga<tap> <value>”
<tap> : 1 or 2
<value> : from -128 to +127 by step of 1 (0,0021dB each step)
Digital Gain (Gain with GainSelector=DigitalAll) : Set the global Digital Gain. This command is available in
the CommCam “Gain & Offset” section :
Read function : “r gdig”;
Returned by the camera : Integer value from 0 to 255. The corresponding Gain is calculated as
20log(1+val/64) in dB
Write function : “w gdig” <int> ;
Digital Offset (BlackLevelRaw with BlackLevelSelector=All) : Set the global Digital Offset. This command is
available in the CommCam “Gain & Offset” section :
Read function : “r offs”;
Returned by the camera : Value from –4096 to +4095 in LSB
Write function : “w offs” <int> ;
Tap Balance Gains Enable Switch (TapBalanceGainEnable) :
Read function : “r fgae”;
Returns the Gain value for the tap. Ex : “r fga1” returns Gain value Tap1.
Write function : “w fgae <val>” with <val> : 0 or 1
0 : Disables the Tap Balance Gains
1 : Enables the Tap Balance Gains
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |39
ROI Gain : How does it works
The ROI Gain feature comes in addition with the FFC (it’s applied and calculated after).
The maximum complementary Gain ix x2.
It can be applied in 2 commands :
First, set the ROI Gain value
Second, set the ROI (Region of Interest).
This second command applies the Gain on the ROI in memory and this is immediately
activated.
Here is an example to apply a complementary gain of x1,5 (512) between the pixels #3051
(0x0BEB) and #4102 (0x1006), pixels included. The two commands are :
Result with FFC activated :
Result with FFC not activated :
Pixels
FFC
ROI gain
FFC
x1.5
3051
4102
Pixels
ROI gain
x1.5
3051
4102
ROI Gain () : Set the Gain for the ROI Gain feature.
Read function : Not readable (one shot function)
Write function : “w roig” <value> ; Value from 0 to 2047 (U1.9) corresponding to a Gain range
from x1 to x1,999 and calculated as following : (1+ Gain/1024).
ROI Set () : Set the ROI and apply the Gain for ROI Gain Feature.
Read function : Not readable (one shot function)
Write function : “w rois <val>” with <val> : Hexadecimal combination of Start and Stop
address for the ROI (both on 16bits) : 0xStartAdr0xStopAdr
Start address : from 0 to 8190 (0x000 to 0x1FFE)
Stop address : from 1 to 8191 (0x001 to 0x1FFF)
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |40
Feature
Commands
Description
GainAbs
GainSelector= AnalogAll
r pamp
Get the current pre-amp gain
w pamp <val>
Set pre amplifier gain to: 0 (-12dB), 1 (-6dB), 2 (0dB) (analog gain)
Change balances and compensation
GainAbs
GainSelector= gainAll
r gain
Get current digital gain
w gain <val>
Set gain from 0dB(0) to +8 dB (6193)
Gain Abs
GainSelector=DigitalAll
r gdig
Get contrast expansion digital gain
w gdig <val>
Set contrast expansion digital gain from 0 (0 dB) to 255 (+14 dB),
step 1 (TBD dB)
BlackLevelRaw
BlackLevelSelector=All
r offs
Get common black level.
w offs <val>
Set common black from -4096 to 4095, step 1
Gain Abs
GainSelector=QuarterGain<j>
r fga<j> <val>
Get tap<j (1 to 4)> digital gain. Dynamically updated on AnalogAll
gain changes
w fga<j> <val>
Set tap<j(1 to 4)> digital gain from -128 to 127 by step 1
(0.0021dB). Dynamically updated on AnalogAll gain changes
Quarter Gain enable
w fgae 1
Enable the QuarterGain<j>
w fgae 0
Disable the QuarterGain<j>
Full Exposure Control Gain
r stbg
Get Full Exposure Control Gain
w stbg <val>
Set Adjust Full Exposure Control 0 to 49151 : (1 + <val>/16384)
7.4.1 Command Table
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |41
How is performed the Flat Field Correction ?
What is the Flat Field correction (FFC) ?
The Flat Field Correction is a digital correction on each pixel which allows :
To correct the Pixel PRNU (Pixel Response Non Uniformity) and DSNU (Dark Signal Non
Uniformity)
To Correct the shading due to the lens
To correct the Light source non uniformity
Before After
How is calculated / Applied the FFC ?
The FFC is a digital correction on the pixel level for both Gain and Offset.
An Offset on 10 bits (Signed Int S9.1). They cover a dynamic of 256LSB in 12bits with a
resolution of 1/2 LSB 12bits. Offet : the MSB is the sign, the rest of 9bits is from 0 .. 256
with precision of 1/2
A Gain on 12 bits (Unsigned Int U2.12) with a max gain value of x5
(*)
The calculation of the new pixel value is : P’ = ( P + Off).(1 + Gain/1024
(*)
). Gain : 0 to 4095
The FFC processing can be completed with an automatic adjustment to a global target. This
function is designed as “FFC Adjust”. This adjustment to a User target is done by an internal
hidden gain which is re-calculated each time the FFC is processed while the FFC adjust
function is enabled.
The FFC is always processed with the max pixel value of the line as reference. If enabled, the
FFC adjust module (located at the output of the FFC module) calculates the adjustment gain
to reach the target defined by the User.
When the FFC result is saved in memory, the adjust gain and target are saved in the same
time in order to associate this gain value with the FFC result.
7.5 Flat Field Correction
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |42
How to perform the Flat Field Correction ?
FPN/DSNU Calibration
Cover the lens
Launch the FPN Calibration : Grab and calculation is performed in few seconds
PRNU Calibration
The User must propose a white/gray uniform target to the Camera (not a fixed
paper) or you can set the Low Pass Filter to remove unwanted defect from the
target.
The Gain/Light conditions must give a non saturated image in any Line.
The Camera must be set in the final conditions of Light/ Gain and in the final
position in the System.
I f required, set a user target for the FFC adjust and enable it.
White uniform (moving) target. Use The FFC Low Band Filter if the Target can’t
move. This will remove the defects of the target itself
Launch the FFC
Enable the FFC
You can save the FFC result (both FPN+PRNU in the same time) in one of the 8 x FFC
User Banks.
The user target and Gain are saved with the associated FFC in the same memory.
Advices
The ELIIXA+ Cameras have 8 x FFC Banks to save 8 x different FFC calibrations. You can use
this feature if your system needs some different conditions of lightning and/or Gain because
of the inspection of different objects : You can perform one FFC to be associated with one
condition of Gain/setting of the Camera ( 4 Max) and recall one of the four global settings
(Camera Configuration + FFC + Line Quarters Balance) when required.
Pixels
3020
User Target value
Standard FFC computed on the
Adjustment gain
max of the line
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |43
FFC Adjust : A good usage.
When there are several Cameras to set up in a system on a single line, the most difficult is
to have a uniform lightning whole along the line.
If each Camera performs its own Flat field correction, relative to the max of each pixel line,
the result will be a succession of Camera lines at different levels.
=> The FFC Adjust function allows to set the same target value for all the Cameras in the
system and then to get a perfect uniform line whole along the system with a precision of 1
LSB to the Target.
The Maximum correction is x2 the highest value of the line.
7.5.1 Activation and Auto-Adjust
FFC Activation (FFCEnable) : Enable/disable the Flat Field Correction. This command is available in the
CommCam “Flat Field Correction” section :
Read function : “r ffcp” : Returns the FFC Status (0 if disabled, 1 if enabled)
Write function :
“w ffcp 1” : Enable the FFC.
“w ffcp 0” : Disabled the FFC
FFC Adjust Function : This Feature is available in the CommCam “Flat Field Correction/ Automatic
Calibration” section :
o Gains adjust (FFCAdjust): Enable/Disable the function
Read function : “r ffad”. Returns the status of the function (0 if disabled)
Write function :
“w ffad 0” : Disable the FFC Adjust function.
“w ffad 1” : Enable the FFC Adjust function.
o Auto Adjust Target Level (FFCAutoTargetLevel): set the value for the User Target.
Read function : “r tfad”. Returns the Target value (from 0 to 4095)
Write function : “w tfad <value>” : Set the Target Value (in 12bits)
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |44
Some Warnings can be issued from the PRNU/FPN Calibration Process as “pixel Overflow” of
“Pixel Underflow” because some pixels have been detected as too high or too low in the
source image to be corrected efficiently.
The Calculation result will be proposed anyway as it’s just a warning message.
The Status Register is the changed and displayed in CommCam “Status” section :
Register status is detailed chap §6.3.3.
7.5.2 Automatic Calibration
FFC Low Band Filter (FFCAutoTargetLevel): set the value for the User Target.
Read function : “r lffw”. Returns the Filter Interval size (from 0 to 255)
Write function : “w lffw <value>” : Set the Interval size for the filter (0 / 1 … 255)
0 : Disables the FFC Low Band Filter
1 to 255 : Set the interval size (+/- the value around the pixel) for the Low Band filter
When you can’t provide a moving Target to the Camera during the PRNU Calibration you can setup the FFC Low
Band Filter in order to remove the defect from the Target before calculating the FFC parameters. The Value set in
the FFC filter defined the size of the interval around each pixel : The Filter will replace each pixel value by the
average on the interval.
FPN/DSNU Calibration :
oFPN Calibration Control (FPNCalibrationCtrl) : Launch or abort of the FPN process for the Offsets
calculation. These commands are available in the CommCam “Flat Field Correction / Automatic
Calibration ” section :
Read function : “r calo” : Returns the FPN Calculation Process Status (0 if finished, 1 if
processing)
Write function :
“w calo 1” : Launch the FPN Calibration Process.
“w calo 0” : Abort the FPN Calibration Process.
o FPN Coefficient Reset (FPNReset) : Reset the FPN (Offsets) coefficient in Memory. This command is
available in the CommCam “Flat Field Correction / Manual Calibration ” section :
Write function : “w rsto 0” : Reset (set to 0) the FPN coefficients in memory. This doesn’t
affect the FFC User Memory Bank but only the active coefficients in Memory.
PRNU Calibration :
oPRNU Calibration Control (FFCCalibrationCtrl) : Launch or abort of the PRNU process for the
Gains calculation. This command is available in the CommCam “Flat Field Correction / Automatic
Calibration ” section :
Read function : “r calg” : Returns the PRNU Calculation Process Status (0 if finished, 1 if
processing)
Write function :
“w calg 1” : Launch the PRNU Calibration Process.
“w calg 0” : Abort the PRNU Calibration Process.
o PRNU coefficient Reset (PRNUReset) : Reset the PRNU (Gains) coefficient in Memory. This
command is available in the CommCam “Flat Field Correction / Manual Calibration ” section :
Write function : “w rstg 0” : Reset (set to “x1”) the PRNU coefficients in memory. This doesn’t
affect the FFC User Memory Bank but only the active coefficients in Memory.
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |45
It is recommended to setup the baud rate at the maximum value possible (115000 for
example) otherwise the transfer can take a long time.
7.5.3 Manual Flat Field Correction
The FFC Coefficients can also be processed outside of the Camera or changed manually by accessing directly their
values in the Camera : This is the “Manual” FFC.
In CommCam, the User can access to a specific interface by clicking on “click for extended control” in both
“Manual FFC calibration” and “Manual FPN calibration sections” :
This will allow the user to upload/download out/in the Camera the FFC coefficients in/from a binary or text file
that can be processed externally.
FPN coefficients modification : Direct access to the FPN coefficients for reading or writing.
The FPN coefficients are read packets of x128 coefficients :
Read function : “r ffco <addr>” : Read 128 consecutive FPN user coefficients starting from <addr>
address. Returned value is in hexadecimal, without space between values (one unsigned short per
coefficient).
Write function :” w ffco <addr><val> : Write 128 consecutive FPN user coefficients starting from
the <addr> address. <val> is the concatenation of individual FPN values, without space between
the values (one unsigned short per coefficient).
PRNU coefficients modification : Direct access to the PRNU coefficients for reading or writing.
The PRNU coefficients are read packets of x128 coefficients :
Read function : “r ffcg <addr>” : Read 128 consecutive PRNU user coefficients starting from
<addr> address. Returned value is in hexadecimal, without space between values (one unsigned short per coefficient).
Write function :” w ffcg <addr><val> : Write 128 consecutive PRNU user coefficients starting from
the <addr> address. <val> is the concatenation of individual PRNU values, without space between
the values (one unsigned short per coefficient).
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |46
FFC User Bank Usage
At the power up :
- Last User Bank used is loaded in RAM
Reset a User bank :
- Reset the RAM (FPN/PRNU individually)
Feature
Commands
Description
FFCEnable
r ffcp
Get Flat Field Correction processing status
w ffcp 0
Disable Flat Field Correction (“False”)
w ffcp 1
Enable Flat Field Correction (“True”)
FPNReset
w rsto 0
Reset FPN coefficients
PRNUReset
w rstg 0
Reset PRNU coefficients
No direct feature
r ffco <addr>
Read 128 Fpn coefficients starting from address <addr>. Return
value is in hexadecimal, without space between values (one
unsigned short per coef).
Format: S9.1 => -256..+255.5 step 1/2
w ffco <addr>
<val>
Write 128 Fpn coefficients (straight to FPGA) starting from
address <addr>. <val> is the concatenation of individual Fpnvalue,
without space between values.
User banks
User4
Ram Memory
Save
Load
Reset FPN
Reset PRNU
7.5.4 FFC User Bank Management
The new-processed FFC values can be saved or restored in/from 8 x User banks.
Both Gains and Offsets in the same time but also the FFC Adjust User target and associated gain.
These functions are available in the Flat Field correction/Save & Restore FFC section :
Restore FFC from Bank (RestoreFFCFromBank) : Restore the FFC from a Bank in the current FFC.
Read function : “r rffc” : Get the current FFC Bank used
Returned by the camera : 0 for Factory bank or 1 to 8 for User banks
Write function : “w rffc <val>” : Bank <val> 1 to 8 for User banks
Note : Factory means neutral FFC (no correction).
Save FFC in User Bank (SaveFFCToBank) : Save current FFC in User Bank
Can not de read
Write function : “w sffc <val>” : User bank <val> if from 1 to 8.
7.5.5 Command Tables
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |47
Feature
Commands
Description
No direct feature
r ffcg <addr>
Read 128 Prnu coefficients (straight from FPGA) starting from
address <addr>. Return value is in hexadecimal, without space
between values. (one unsigned short per coef)
U2.12 (1+coeff/1024) => x1..x4.999877 step 1/1024
w ffcg <addr>
<val>
Write 128 Prnu coefficients (straight to FPGA) starting from
address <addr>. <val> is the concatenation of individual
PRNUvalue, without space between values.
FFCCalibrationCtrl
r calg
Get the PRNU calibration status
w calg 0
Abort PRNU calibration by setting it to “Off” (no effect if already
stopped)
w calg 1
Launch PRNU calibration by setting it to “Once” (no effect if
already launched)
PrnuCalibrationCtrl
r calo
Get the fpn calibration status
w calo 0
Abort fpn calibration by setting it to “Off” (no effect if already
stopped)
w calo 1
Launch fpn calibration by setting it to “Once” (no effect if already
launched)
FFCAdjust
r ffad
Get ffc adjust state
w ffad 0
Disable ffc adjust
w ffad 1
Enable ffc adjust
FFCAutoTargetLevel
r tfad
Get the FFC target adjust level
W tfad <val>
Set FFC target adjust level, from 0 to 4095, step 1
LowFrequencyFilterWidth
r lffw
Configure windows (width) around the pixel (+/- val) for the
average filter
0 : filter is disable
1-255 : nb pixels around the pixel to filter. Interval : [-nb to
+nb]
w lffw <val>
Feature
Commands
Description
RestoreFFCFromBank
r rffc
Get the current FFC bank (save or restore)
w rffc <val>
Restore current FFC (including FPN and FFCGain) from FFC bank
number <val>, from 1 to 8; <val> comes from UserFFCSelector
(XML feature).
SaveFFCToBank
w sffc <val>
Save current FFC (including FPN and FFCGain) to FFC bank number
<val>, from 1 to 8; <val> comes from FFCSelector (XML feature).
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |48
7.6 Look Up Table
The User can define an upload a LUT in the Camera that can be used at the end of the processing.
The LUT is defined as a correspondence between each of the 4096 gray levels (in 12 bits) with another outputted
value. For example, a “negative” or “reverse” LUT is the following equivalence :
Real value Output value
0 4095
1 4094
2 4093
…
Then the size of each value is 12bits but the exchanges with the Application/PC are done on 16 bits :
For 4096 gray levels (from 0 to 4095) the total file size for a LUT is 8Ko.
If this LUT is enables, the “Contrast Expansion” feature (digital Gain and Offset) will be disabled
LUT Enable (LUTEnable) : Enable the LUT and sizable the Digital Gain / Offset
This function is available in the LUT section :.
Read function : “r lute” : Get the LUT status
Returned by the camera : 0 is LUT disabled, 1 if enabled
Write function : “w lute <val>” : <val> is 0 for disable, 1 for enable
Upload / Download the LUT coefficients : Direct access to the LUT coefficients for reading or writing.
In CommCam, the User can access to a specific interface by clicking on “click for extended control” in
the LUT section :
Read function : “r lutc <addr>” : Read 128 LUT coefficients starting from address <addr> from 0 to
4095-128. Returned value is the concatenation in hexadecimal of individual LUT values, without
space between values. (one unsigned short per coefficient)
Write function :” w lutc <addr><val> : Write 128 LUT coefficients starting from address <addr>
form 0 to 4095-128. <val> is the concatenation in hexadecimal of individual LUT values, without
space between values. (one unsigned short per coefficient)
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |49
LUT User Bank Usage
At the power up :
- Last User Bank used is loaded in RAM
Feature
Commands
Description
LUTEnable
r lute
Get LUT status
w lute 0
Disable LUT (“False”)
w lute 1
Enable LUT (“True”)
No direct feature
r lutc <addr>
Read 128 LUT coefficients starting from address <addr> from 0 to
4095-128. Return value is in hexadecimal, without space between
values. (one unsigned char per coef)
w lutc <addr>
<val>
Write 128 LUT coefficients starting from address <addr> from 0 to
4095-128. <val> is the concatenation of individual LUTvalue,
without space between values.
Feature
Commands
Description
RestoreLUTFromBank
r rlut
Get the current LUT bank (saved or restore)
w rlut <val>
Restore current LUT from LUT bank number <val>, from 1 to 4;
<val> comes from LUTSetSelector.
SaveLUTToBank
w slut <val>
Save current LUT to LUT FFC bank number <val>, from 1 to 4;
<val> comes from LUTSetSelector.
User banks
Ram Memory
Save
Load
Upload/load from/to a Txt file
Save & Restore LUT in User Banks : The LUT loaded in RAM memory can be saved or restored in/from
4 User banks.
These functions are available in the LUT/Save & Restore LUT Settings section :
oRestore LUT from Bank (RestoreLUTFromBank) : Restore the LUT from a User Bank in the current
RAM Memory.
Read function : “r rlut” : Get the current LUT Bank used
Returned by the camera : 1 to 4 for User banks
Write function : “w rlut <val>” : Bank <val> 1 to 4 for User banks
o Save LUT in User Bank (SaveLUTToBank) : Save current LUT in User Bank
Can not de read
Write function : “w slut <val>” : User bank <val> if from 1 to 4.
The bank number <val> is given in (LUTSetSelector)
7.6.1 Command Tables
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |50
After performing a line profile measurement, all the values computed which are described
below are not refreshed automatically in CommCam : You have to right-click on each value
and ask for an individual refresh.
7.7 Statistics and Line Profile
This function allows the User to get some statistics on a pre-defined ROI. On request, the Camera acquires and
then calculates some key values as the min, the max, the average or the standard deviation in this Region of
Interest.
The grab and calculation command and also the collection of the results is not performed in real time as it is done
through the serial connection.
This function and the results are available in CommCam in the “Line Profile Average” Section :
Line Profile average measurement (LineAverageProfile) : Control the grab and computation of the
statistics.
Read function : “r pixs” : Get the status of the calculation
Returned by the camera : 0 : finished, 1: running
Write function :
“w pixs 1” : Start the accumulation and then the computing
“w pixs 0” : Abort the computing.
The Calculated values are detailed as following :
oPixel average Value (PixelROIMean) : Average gray level value calculated on whole Region of
interest
Read function : “r pavr” : Get the average value
Returned by the camera : Unsigned format value : U12.4
oPixel Standard deviation (PixelROIStandardDeviation) : standard deviation of all the pixel gray
level values of Region of interest
Read function : “r pstd” : Get the standard deviation
Returned by the camera : Unsigned format value : U12.4
o Pixel Min value (PixelROIMin) : Minimum gray level pixel value on the whole region of interest.
Read function : “r pmin” : Get the Minimum value
Returned by the camera : Unsigned format value : U12.4
o Pixel Max Value (PixelROIMax) : Maximum gray level pixel value on the whole region of interest
Read function : “r pmax” : Get the maximum value
Returned by the camera : Unsigned format value : U12.4
Pixel access Line number (PixelAccessLineNumer) : Set the number of lines to accumulate.
Read function : “r pixl” : Get the number of line
Returned by the camera : 1, 256, 512 or 1024
Write function : “w pixl <val>” : Set the number of lines. <val> is 1, 256, 512 or 1024.
Pixel ROI Start (PixelRoiStart) : Set the Region of Interest start position.
Read function : “r prod” : Get the starting pixel
Returned by the camera : value between 0 and 16383
Write function : “w prod <val>” : Set the starting pixel. <val> is between 0 and 16383
Pixel ROI Width (PixelRoiWidth) : Set the Width of the Region of Interest.
Read function : “r prow” : Get the width in pixel
Returned by the camera : value between 1 and 16384
Write function : “w prow <val>” : Set the ROI width in pixels. <val> is between 1 and 16384
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |51
Feature
Commands
Description
LineAverageProfile
r pixs
Get the line Line Average Profile status
- 1 : running
- 0 : finished
w pixs 0
Abort the Line Average Profile
w pixs 1
Run the Line Average Profile
PixelAccessLineNumer
r pixl
Get the number of line for average
w pixl <val>
Set the number of line to accumulate
- <val> : 1,256,512,1024
No direct feature
r pixv <addr>
Read 128 pixel values starting from address <addr>, from
SensorWidth-128-1. Return value is in hexadecimal, without
space between values. (one unsigned short per coef)
PixelRoiStart
r prod
Get Roi start
w prod <val>
Set Roi start for pixel statistic computing (0 to SensorWidth -1-
1)
PixelRoiWidth
r prow
Get Roi width
W prow <val>
Set Roi width for pixel statistic computing (1 to SensorWidth)
PixelROIMean
r pavr
Get ROI Mean (format U12.4)
PixelROIStandardDeviation
r pstd
Get ROI Stand deviation (format U12.4)
PixelROIMin
r pmin
Get ROI Min (format U12.4)
PixelROIMax
r pmax
Get ROI Max (format U12.4)
7.7.1 Command Table
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |52
Feature
Commands
Description
PrivilegeLevel
r lock
Get camera running privilege level
0 = Privilege Factory
1 = Privilege Advanced User
2 = Privilege User
ChangePrivilegeLevel
w lock 1
Lock camera privilege to “Advanced User”
w lock 2
Lock camera privilege to “User”
w lock <val>
Unlock camera privilege depending on <val> (min=256;
max=232-1)
7.8 Privilege Level
There are 3 privilege levels for the camera :
Factory (0) : Reserved for the Factory
Integrator (1) : Reserved for system integrators
User (2) : For all Users.
The Cameras are delivered in Integrator mode. They can be locked in User mode and a specific password is
required to switch back the Camera in Integrator mode. This password can be generated with a specific tool
available from the hotline (hotline-cam@e2v.com)
This function is available in the Privilege section :
Privilege level Management (PrivilegeLevel) : Get the current Camera privilege level..
Read function : “r lock” : Get the current privilege
Returned by the camera : 0 to 2
Write function : “w lock <val>” : <val> is as follow
2 : Lock the Camera in Integrator or “privilege User”
<computed value> : Unlock the Camera back in Integrator mode
7.8.1 Command Table
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |53
Feature
Commands
Description
Save Image
w recl <val>
Record current Image :
0 : Abort recording
1 : record active image
Play Image
r play <val>
Read output status :
0 : Camera output live image
1 : Camera output recorded image
w play <val>
Camera Output selection :
0 : Output live image
1 : Output recorded image
7.9 Image Control
Save Image (SaveImageControl) : control the recording of the image in the camera
This command is available in the CommCam “Image Control” section :
Read function (ASCII): “r recl”;
Returned by the camera :
“0” : No Record in Progress
“1” : Record in Progress
Write function (ASCII): “w recl” <value> :
“0” : Stop Recording
“1” : Start Recording
Play Image (PlayImageControl) : control the Replay of the image in the camera
This command is available in the CommCam “Image Control” section :
Read function (ASCII): “r play”;
Returned by the camera :
“0” : Camera display the “Live Image”
“1” : Camera display recorded Image
Write function (ASCII): “w play” <value> :
“0” : Start Playing Live Image
“1” : Start Playing Recorded Image
7.9.1 Command table
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |54
The integrator bank (User Set5) can be written only if the Camera is set in integrator mode
(Privilege level = 1). This integrator bank can be used as a « Factory default » by a system
integrator.
Configuration Bank Usage
At the power up : Last User Bank used is loaded in RAM
“Integrator” Bank (5) can be locked by switching the Camera in “User” mode (cf : Privilege feature). Then it can’t
be saved any more without switching back the Camera in “Integrator” Mode.
Feature
Commands
Description
UserSetLoad
r rcfg
Get the current user configuration bank (saved or restored)
w rcfg <val>
Restore current UserSet from UserSet bank number <val>, from 0
to 5; <val> comes from UserSetSelector.
UserSetSave
w scfg <val>
Save current UserSet to UserSet bank number <val>, from 1 to 5;
<val> comes from UserSetSelector. 0 cannot be saved. 5
(Integrator) can’t be saved in User mode
UserSetControl
Xml virtual
Ram Memory
Save
Load
Factory
Integrator
User1
User2
User3
User4
User
Load
Save
7.10 Save & Restore Settings
The settings (or Main configuration) of the Camera can be saved in 4 different User banks and one Integrator
bank. This setting includes also the FFC and LUT enable
This function is available in the Save & Restore Settings section :
Load settings from Bank : Allows to restore the Camera settings.
Read function : “r rcfg” : Get the current Tap Bank in use
Write function : “w rcfg <val>” : Load settings from bank <val> (0: Factory , 1 to 4 for Users, 5 for
Integrator)
Save settings to Bank : Allows to save the Camera settings in User or Integrator Bank
Write function : “w scfg <val>” : Save the current settings in the User bank <val> (1 to 4 for User,
5 for Integrator)
7.10.1 Command Table
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |55
APPENDIX
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |56
Appendix A. Test Patterns
A.1 Test Pattern 1: Vertical wave
The Test pattern 1 is a vertical moving wave : each new line will increment of 1 gray level in regards with the
previous one.
In 12 bits the level reaches 4095 before switching down to 0
In 10 bits the level reaches 1023 before switching down to 0
In 8 bits the level reaches 255 before switching down to 0
A.2 Test Pattern 2: Fixed Horizontal Ramps
A.1.2 8192 Pixels in 8 bits format
Starting at 0, an increment of 1 LSB is made every 16 pixels. When it reaches 255, turns back to 0 and starts again.
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |57
A.2.2 4096 Pixels in 8 bits format
Starting at 32, an increment of 1 LSB is made every 16 pixels.
When reaches 63, jump to 96 then carry on increasing
When reaches 127, jump to 160 then carry on increasing.
When reaches 191, jump to 224 then carry on increasing.
When it reaches 255, turns back to 32 and starts again.
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |58
A.3.2 2048 Pixels in 8 bits format
Starting at 48, an increment of 1 LSB is made every 16 pixels.
When reaches 63, jump to 112 then carry on increasing
When reaches 127, jump to 176 then carry on increasing.
When reaches 191, jump to 240 then carry on increasing.
When it reaches 255, turns back to 48 and starts again.
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |59
Digital Conversion
T
pix
Line Trigger
Td
T
per
Tint
real
Exposure Time
Programmed
ITC Trigger
CC1
T
int
(Exposure Time)
Tx
Exposure Time
Internal
Exposure Time
Programmed
Line Triggers
Th
Tht
Synchro
Mode
Sync = 0
Sync = 1
Sync = 3
Sync = 4
In the
No Exposure start before this point
T
intProg
Appendix B. Timing Diagrams
B.1 Synchronization Modes with Variable Exposure Time
CC1 or Internal
CC1
CC2
Camera /
sensor
T
: Timing Pixel. During this uncompressible period, the pixel and its black reference are read out to the Digital
pix
converter. During the first half of this timing pixel (read out of the black reference), we can consider that the
exposure is still active.
Digital Conversion : During the conversion, the analog Gain is applied by the gradient of the counting ramp (see
next chapter : Gain & Offset). The conversion time depends on the pixel format :
8 or 10 bits : 6µs
12 bits : 24µs
This conversion is done in masked time, eventually during the next exposure period.
T
: Delay between the Start exposure required and the real start of the exposure.
d
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |60
If T
per
is the Line Period (internal or external coming from the Trigger line), in order to respect this
line Period, the Exposure Time as to be set by respecting : T
int
+ T
pix
<= T
per
Then, the real exposure time is : Tint
real
= T
int
+ Tx - Td.
In the same way, The high level period of the Trig signal in sync=3 mode, Tht >= T
pix
For a Line Period of
LinePer
, the maximum exposure time possible without reduction of line rate
is : Tint
max
= T
per-Tpix
(T
pix
is defined above) but the effective Exposure Time will be about Tint
real
=
T
int
+
T
x
.
- Td.
Label
Min
Unit
T
pix
5
µs
T
x
3,1
µs
Th
0,120
µs
Tht
T
pix
µsec
Td
1.1
µs
2,5µ
Tint
prog
1,5µ
Tint
real
Tper
min
5µs
10µs
7µs
Line Trigger
Td
T
per = Tint
Th
Digital Conversion
T
pix
Tint
real
Tx
Exposure Time
Internal
Synchro
Mode
Sync = 2
Sync = 5
In the
Digital Conversion
T
pix
Tx
B.2 Synchronisation Modes with Maximum Exposure Time
CC1 or Internal
In these modes, the rising edge of the Trigger (internal or External) starts the readout process (T
previous integration. The Real exposure time (Tint
) is finally equal to the Line Period (T
real
from (Tx + Td ) from the rising edge of the incoming Line Trigger.
B.3 Timing Values
) of the
pix
) even if it’s delayed
per
Camera /
sensor
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |61
Line C (8bit)
Lines AB (8bit)
HDR bloc
HDR Output
( 12 bit)
x
16
(12bit)
16
(12bit)
HDR bloc calculation :
Else HDR=LIgnes AB/(2*N).
Processing :
Offset
(12bit)
CL
interface
(8, 10, 12bit)
Camera output
If 8bits output , only the 8MSB of the
x
Camera output
illumination
Saturation Lines AB
Saturation Line C
1023
255
Lines AB used
Line C used
with ratio=2, the saturation is extended by a factor x4
Appendix C. HDR Mode
C.1 HDR Block
With the HDR Single Line Mode, the “HDR” is calculated in the camera as following :
FFC,
Gain
If Lignes AB=saturation then
HDR =Ligne C
12 bits are sent.
If 10bits output , only the 10MSB of
the 12bits are sent.
If 12bits output , the 12 bits are sent.
HDR bloc calculation :
If the double Line “AB” is saturating, the information is taken from the single line “C” (Low levels)
If the double Line “AB” is non saturating, the value taken is issued from these line but divided by 2*N : N is the
ratio set in automatic Exposure mode.
In this case, the maximum dynamic possible is 12 bits : The MSB are taken from the 8bits MSB of the Lines “AB” and divided
by 16 max
C.2 Example with Ratio 2 and 10bits output
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |62
The LUT could be used to compress the HDR output in 8bit.
Camera output
illumination
Saturation Lines AB
Saturation Line C
1023
255
Lines AB used
Line C used
Camera 10b output without LUT
Camera 8b output with 10b8b LUT
Line C
Lines AB
Ratio 4 or x8 between LSB and MSB :
Line C integrates 25µs
C.3 HDR With LUT 10bits => 8bits
C.4 Example of difference between “AB” and “C” Line :
In 32bits : Must be located in : program files\CamerLink\serial and location added to PATH variable
In 64bits : Must be located in : program files\CamerLink\serial or
For 32bits version : Must be located in : program files(x86)\CamerLink\serial
In 32bits : in the directory defined by the Register Key :
CLSERIALPATH (REG_SZ) in HKEY_LOCAL_MACHINE\software\cameralink
The directory should be program files\CamerLink\serial or any other specified
In 64bits, for a 64bits version : in the directory defined by the Register Key : CLSERIALPATH (REG_SZ) in
HKEY_LOCAL_MACHINE\software\cameralink
The directory should be program files\CamerLink\serial or any other specified
In Windows 64bits, for a 32bits version : in the directory defined by the Register Key : CLSERIALPATH
(REG_SZ) in HKEY_LOCAL_MACHINE\Wow6432Node\software\cameralink
The directory should be program files(x86)\CamerLink\serial or any other specified
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |69
Defect
Detail
Solutions
CommCam Can’t find the Camera :
After launching CommCam, the Icon of
the Camera is not visible.
The Camera is not powered up or
the boot sequence is not finished.
The CameraLink cable is not
connected or connected on the
bad connector.
Check if the CameraLink libraries
(clallserial.dll and clserXXX.dll) are
in the same directory (either
system32 or program
files/cameralink/serial)
The Frame Grabber is compliant
with CameraLink standard 1.1
> Contact the hotline :
hotline-cam@e2v.com
An e2v Camera is detected but not
identified :
A “question Mark” icon appears in place
of the one of the AVIIVA2
The version of CommCam used is too
old : You have to use the version
1.2.x and after.
Impossible to connect to the identified
Camera :
The message “Impossible to open
device” is displayed
There is a possible mismatch
between the major version of xml
file used by CommCam and the
firmware version of the Camera
Possible Hardware error or
Camera disconnected after being
listed.
> Contact the hotline :
hotline-cam@e2v.com
Error messages is displayed just
after/before the connection :
There is a possible mismatch
between the minor version of xml
file used by CommCam and the
firmware version of the Camera
Default values of the Camera out
of range
> Contact the hotline :
hotline-cam@e2v.com
USER MANUAL ELIIXA+8K/4K CLMONO –REV I–06/2017
P A G E |70
Manual
Revision
Comments / Details
Firmware version
1st CommCam
compliant
Version
Rev A
First release (Base Mode and Quarter Balance not available)
Version BA0
Version BA1
1.0.0B
1.0.1A
2.1.4
Rev B
- Base mode
- Tap Gains Balance
Version BA0
Version BA1
1.0.1
1.0.3A
2.1.5
Rev C
- ROI Gain and New FFC
- Correction of the STB Full Exposure Control Mode
Version BA0
Version BA1
1.0.2
1.0.4A
2.1.7
Rev D
Characterization and improvement of the Forward / Reverse
feature
Version BA0
Version BA1
1.0.3
1.0.6
2.1.7
Rev E
FFC Low Band Filter and 8 FFC Memories
Version BA0
Version BA1
1.3.0
1.3.0
2.3.3
Rev F
New Template for the Document
3 Different STB Modes : 4S Only and 2S Switch w/o Bad lines
Trigger too slow limit parameter
New Models with High Dynamic Range Mode (“BHx”)
Version BA0
Version BA1
Version BH0 Version BH1
1.4.2
1.4.2
1.1.0
1.1.0
2.5.1
Rev G
Record/Play Image
2.6.0
Rev H
Variable Gain for Full Exposure control in 4S mode
Record/replay image function
Centered Region Interest for 8µ 5m sensor modes
New part with 2 Lines only (EV71YC2MCL8005-BA0/1)