GIGE VISION & CAMERA LINK SWIR CAMERAS

Goldeye G/CL
Features Reference
V1.7.2FW 04.04.77cd2f3e

Allied Vision Technologies GmbH // Taschenweg 2a, 07646 Stadtroda, Germany2023-Jan-26

This reference at a glanceThis reference at a glance
Overview
Read this reference carefully
Read this reference to fully understand your camera’s features.
This features reference describes features to control Allied Vision Goldeye IR andscientific cameras:• Goldeye G (all Cool, stabilized, and TECless models)• Goldeye CL (all Cool, stabilized, and TECless models).

i

Further information and feedback••

For more information on Goldeye G/CL cameras, including theGoldeye Camera Link Register Controls Reference, seewww.alliedvision.com/en/support/technical-documentation/
goldeye-gcl-documentation.
For feedback or technical questions, please visit
www.alliedvision.com/en/support.

Availability of features and values
Functionalities described in this document may not be supported by every
Goldeye G/CL model. Values may differ between models as well.

Vimba and third party software
Vimba is the Allied Vision Software Development Kit (SDK) for camera control andimage acquisition, including drivers and other useful data.
Because Vimba SDK is based on the GenICam standard, GenICam-based third-party
software automatically connects with Vimba's transport layers. Additionally,
Vimba includes the Cognex Adapter for VisionPro.

i

Download Vimba from:www.alliedvision.com/en/support/software-downloads

Goldeye G/CL Features Reference V1.7.2

2

Contents

Contents
This reference at a glance .......................................................................... 2

Overview ........................................................................................................ 2
Vimba and third party software .................................................................... 2

Contact us ................................................................................................ 12
Document history and conventions ........................................................ 13

Document history ........................................................................................ 14
Conventions used in this reference ............................................................ 16
Symbols and notes ...................................................................................................17
Order and description scheme ..................................................................................17

Copyright and trademarks .......................................................................... 18

Image data flow and features order ........................................................ 19

Image data flow ........................................................................................... 20
Value changes by feature interdependencies ............................................ 21
Effects for the interdependent features ...................................................................21

Feature description .................................................................................. 22
AcquisitionControl ....................................................................................... 23
AcquisitionAbort ................................................................................................................... 23
AcquisitionAutoStartMode ................................................................................................... 23
AcquisitionFrameCount ........................................................................................................ 24
AcquisitionFrameRate .......................................................................................................... 24
AcquisitionFrameRateLimit .................................................................................................. 25
AcquisitionMode ................................................................................................................... 26
AcquisitionStart .................................................................................................................... 27
AcquisitionStop ..................................................................................................................... 27

AutoModeParameters (subcategory) ........................................................................28

AutoModeOutliersBright ...................................................................................................... 28
AutoModeOutliersDark ........................................................................................................ 29
AutoModeRegionDimOutside ............................................................................................... 29
AutoModeRegionHeight ....................................................................................................... 30
AutoModeRegionOffsetX ...................................................................................................... 30
AutoModeRegionOffsetY ...................................................................................................... 31
AutoModeRegionWidth ........................................................................................................ 31

ContrastAutoControl (subcategory) ..........................................................................32

ContrastAuto ........................................................................................................................ 32

Goldeye G/CL Features Reference V1.7.2

3

Contents

ContrastAutoIntensityMax ................................................................................................... 33
ContrastAutoIntensityMin .................................................................................................... 33
ContrastUserInputMax ......................................................................................................... 34
ContrastUserInputMin .......................................................................................................... 34

ExposureAutoControl (subcategory) .........................................................................35

ExposureAuto ........................................................................................................................ 35
ExposureAutoAdjustTol ........................................................................................................ 36
ExposureAutoAlg .................................................................................................................. 36
ExposureAutoMax ................................................................................................................ 37
ExposureAutoMin ................................................................................................................. 37
ExposureAutoRate ................................................................................................................ 38
ExposureAutoTarget ............................................................................................................. 38

AcquisitionControl (continued) .................................................................... 39
ExposureMode ...................................................................................................................... 39
ExposureRangeMode ........................................................................................................... 39
ExposureTime ....................................................................................................................... 40
IntegrationMode .................................................................................................................. 40
RecorderPreEventCount ....................................................................................................... 41
TriggerActivation .................................................................................................................. 42
TriggerDelay ......................................................................................................................... 42
TriggerMode ......................................................................................................................... 43
TriggerOverlap ...................................................................................................................... 43
TriggerSelector ..................................................................................................................... 44
TriggerSoftware .................................................................................................................... 44
TriggerSource ....................................................................................................................... 45

AnalogControl .............................................................................................. 46
BlackLevel ............................................................................................................................. 46
Gain ...................................................................................................................................... 47
SensorGain ............................................................................................................................ 47

BufferHandlingControl ................................................................................ 48
StreamAnnounceBufferMinimum ........................................................................................ 48
StreamAnnounceBufferCount .............................................................................................. 49
StreamBufferHandlingMode ................................................................................................ 49

ChunkDataControl ....................................................................................... 50
ChunkModeActive ................................................................................................................ 50
NonImagePayloadSize .......................................................................................................... 51

DeviceControl .............................................................................................. 52
BandwidthControlMode ....................................................................................................... 52
DeviceBaudRateSwitchConfirmTimeout .............................................................................. 53
DeviceClockFrequency .......................................................................................................... 53
DeviceClockSelector .............................................................................................................. 54
DeviceFamilyName ............................................................................................................... 54
DeviceFanMode .................................................................................................................... 55
DeviceFanRpm ...................................................................................................................... 55

Goldeye G/CL Features Reference V1.7.2

4

Contents

DeviceFanSelector ................................................................................................................ 56
DeviceFirmwareVersion ........................................................................................................ 56
DeviceLinkHeartbeatTimeout ............................................................................................... 57
DeviceLinkSelector ................................................................................................................ 57
DeviceLinkThroughputLimit .................................................................................................. 58
DeviceLinkThroughputLimitMode ........................................................................................ 59
DeviceManufacturerInfo ...................................................................................................... 59
DeviceModelName ............................................................................................................... 60
DeviceRelativeHumidity ........................................................................................................ 60
DeviceRelativeHumiditySelector ........................................................................................... 61
DeviceReset .......................................................................................................................... 61
DeviceSFNCVersionMajor ..................................................................................................... 61
DeviceSFNCVersionMinor ..................................................................................................... 62
DeviceSFNCVersionSubMinor ............................................................................................... 62
DeviceScanType .................................................................................................................... 62
DeviceSerialNumber ............................................................................................................. 63
DeviceSerialPortBaudRate .................................................................................................... 63
DeviceSerialPortSelector ...................................................................................................... 64
DeviceStreamChannelPacketSize ......................................................................................... 64
DeviceStreamChannelSelector ............................................................................................. 65
DeviceTemperature .............................................................................................................. 65
DeviceTemperatureSelector ................................................................................................. 66
DeviceTLType ........................................................................................................................ 66
DeviceType ............................................................................................................................ 67
DeviceUserID ........................................................................................................................ 67
DeviceVendorName .............................................................................................................. 67

SensorBoardSettings (subcategory) ..........................................................................68

FpaTCDS ................................................................................................................................ 68
TIDC_Mode ........................................................................................................................... 69

DeviceControl (continued) ........................................................................... 70
SensorCoolingPower ............................................................................................................. 70
SensorTemperatureControlMode ......................................................................................... 71
SensorTemperatureControlState .......................................................................................... 72
SensorTemperatureSetpointActivate ................................................................................... 72
SensorTemperatureSetpointActive ....................................................................................... 73
SensorTemperatureSetpointMode ....................................................................................... 74
SensorTemperatureSetpointSelector ................................................................................... 75
SensorTemperatureSetpointValue ....................................................................................... 75
SensorTemperatureTargetSetpoint ...................................................................................... 76
TimestampLatch ................................................................................................................... 76
TimestampReset ................................................................................................................... 77
TimestampLatchValue .......................................................................................................... 77

DigitalIOControl ........................................................................................... 78
LineIn ..........................................................................................................................78
LineInGlitchFilter ................................................................................................................... 78
LineInLevels ........................................................................................................................... 79

Goldeye G/CL Features Reference V1.7.2

5

Contents

LineInSelector ....................................................................................................................... 80

LineOut .......................................................................................................................81

LineOutLevels ........................................................................................................................ 81
LineOutPolarity ..................................................................................................................... 82
LineOutSelector .................................................................................................................... 82
LineOutSource ...................................................................................................................... 83

Strobe .........................................................................................................................84

StrobeDelay .......................................................................................................................... 84
StrobeDuration ..................................................................................................................... 85
StrobeDurationMode ............................................................................................................ 85
StrobeSource ......................................................................................................................... 86

EventControl ................................................................................................ 87
EventData (subcategory) ...........................................................................................87
EventAcquisitionEndFrameID ............................................................................................... 87
EventAcquisitionEndTimestamp ........................................................................................... 88
EventAcquisitionRecordTriggerFrameID .............................................................................. 88
EventAcquisitionRecordTriggerTimestamp .......................................................................... 88
EventAcquisitionStartFrameID ............................................................................................. 89
EventAcquisitionStartTimestamp ......................................................................................... 89
EventErrorFrameID ............................................................................................................... 89
EventErrorTimestamp ........................................................................................................... 90
EventExposureEndFrameID .............................................................................................. 90
EventExposureEndTimestamp .......................................................................................... 90
EventFrameTriggerFrameID ................................................................................................. 91
EventFrameTriggerTimestamp ............................................................................................. 91
EventFrameTriggerReadyFrameID ....................................................................................... 91
EventFrameTriggerReadyTimestamp ................................................................................... 92
EventLine1FallingEdgeFrameID ............................................................................................ 92
EventLine1FallingEdgeTimestamp ....................................................................................... 92
EventLine1RisingEdgeFrameID ............................................................................................. 93
EventLine1RisingEdgeTimestamp ........................................................................................ 93
EventLine2FallingEdgeFrameID ............................................................................................ 93
EventLine2FallingEdgeTimestamp ....................................................................................... 94
EventLine2RisingEdgeFrameID ............................................................................................. 94
EventLine2RisingEdgeTimestamp ........................................................................................ 94
EventOverflowFrameID ........................................................................................................ 95
EventOverflowTimestamp .................................................................................................... 95
EventSensorTemperatureControlStateFrameID ................................................................. 95
EventSensorTemperatureControlStateTimestamp ............................................................ 96
EventSensorTemperatureSetpointFrameID ........................................................................ 96
EventSensorTemperatureSetpointTimestamp ..................................................................... 96

EventID (subcategory) .............................................................................................97

EventAcquisitionStart .......................................................................................................... 98
EventAcquisitionEnd ........................................................................................................... 98
EventFrameTrigger .............................................................................................................. 99
EventExposureEnd .............................................................................................................. 99
EventAcquisitionRecordTrigger ........................................................................................ 100

Goldeye G/CL Features Reference V1.7.2

6

Contents

EventCC1RisingEdge .......................................................................................................... 100
EventCC1FallingEdge ......................................................................................................... 101
EventCC2RisingEdge .......................................................................................................... 101
EventCC2FallingEdge ......................................................................................................... 101
EventCC3RisingEdge .......................................................................................................... 102
EventCC3FallingEdge ......................................................................................................... 102
EventCC4RisingEdge .......................................................................................................... 102
EventCC4FallingEdge ......................................................................................................... 103
EventLine1RisingEdge ........................................................................................................ 103
EventLine1FallingEdge ....................................................................................................... 104
EventLine2RisingEdge ....................................................................................................... 104
EventLine2FallingEdge ....................................................................................................... 105
EventFrameTriggerReady .................................................................................................. 105
EventSensorTemperatureSetpoint .................................................................................... 106
EventSensorTemperatureControlState ............................................................................. 106
EventOverflow .................................................................................................................... 107
EventError ........................................................................................................................... 107

EventControl (continued) .......................................................................... 108
EventNotification ................................................................................................................ 108
EventSelector ...................................................................................................................... 109
EventsEnable1 .................................................................................................................... 110

FileAccessControl ....................................................................................... 112
FileAccessBuffer .................................................................................................................. 112
FileAccessLength ................................................................................................................. 112
FileAccessOffset .................................................................................................................. 113
FileAttribute ........................................................................................................................ 113
FileAttributeBuffer .............................................................................................................. 114
FileDescription .................................................................................................................... 114
FileDescriptionBuffer .......................................................................................................... 115
FileOpenAttribute ............................................................................................................... 115
FileOpenMode .................................................................................................................... 116
FileOperationExecute ......................................................................................................... 116
FileOperationResult ............................................................................................................ 116
FileOperationSelector ......................................................................................................... 117
FileOperationStatus ............................................................................................................ 118
FileSelector ......................................................................................................................... 119
FileSize ................................................................................................................................ 119
FileStatus ............................................................................................................................ 120
FileType ............................................................................................................................... 120
FileTypeBuffer ..................................................................................................................... 121

GigE ........................................................................................................... 122
Configuration ...........................................................................................................122
GevIPConfigurationMode ................................................................................................... 122

Current .....................................................................................................................123

GevCurrentDefaultGateway ............................................................................................... 123

Goldeye G/CL Features Reference V1.7.2

7

Contents

GevCurrentIPAddress .......................................................................................................... 123
GevCurrentSubnetMask ..................................................................................................... 123

GVCP ........................................................................................................................124

GVCPCmdRetries ................................................................................................................ 124
GVCPCmdTimeout .............................................................................................................. 125
GevHeartbeatInterval ......................................................................................................... 125
GevSCPSPacketSize ............................................................................................................. 126

Persistent .................................................................................................................127

GevPersistentDefaultGateway ........................................................................................... 127
GevPersistentIPAddress ...................................................................................................... 127
GevPersistentSubnetMask .................................................................................................. 127

ImageCorrectionControl ............................................................................ 128
BackgroundCorrection (subcategory) .....................................................................128
BCDatasetMeanValue ........................................................................................................ 128
BCDatasetOffsetValue ........................................................................................................ 129
BCDatasetROIHeight .......................................................................................................... 129
BCDatasetROIOffsetX ......................................................................................................... 130
BCDatasetROIOffsetY ......................................................................................................... 130
BCDatasetROIWidth ........................................................................................................... 131
BCIntegrationAbort ............................................................................................................ 131
BCIntegrationFrameCount ................................................................................................. 132
BCIntegrationMode ............................................................................................................ 132
BCIntegrationStart .............................................................................................................. 133
BCMode .............................................................................................................................. 134
BCState ............................................................................................................................... 134

DefectPixelCorrection (subcategory) .......................................................................135

DPCDatasetActivate ........................................................................................................... 135
DPCDatasetActive ............................................................................................................... 136
DPCDatasetActiveDescription ............................................................................................ 136
DPCDatasetDescription ...................................................................................................... 137
DPCDatasetSelector ............................................................................................................ 137
DPCMode ............................................................................................................................ 138

NonUniformityCorrection (subcategory) .................................................................139

NUCDatasetActivate ........................................................................................................... 139
NUCDatasetActive .............................................................................................................. 140
NUCDatasetActiveDescription ............................................................................................ 140
NUCDatasetActiveExposureTime ....................................................................................... 141
NUCDatasetActiveGain ...................................................................................................... 141
NUCDatasetActiveTemperature ......................................................................................... 142
NUCDatasetAuto ................................................................................................................ 143
NUCDatasetDescription ...................................................................................................... 143
NUCDatasetExposureTime ................................................................................................. 144
NUCDatasetGain ................................................................................................................ 144
NUCDatasetNodeSelector .................................................................................................. 145
NUCDatasetNodeValue ...................................................................................................... 145
NUCDatasetSelector ........................................................................................................... 146

Goldeye G/CL Features Reference V1.7.2

8

Contents

NUCDatasetTemperature ................................................................................................... 146
NUCMode ........................................................................................................................... 147

ImageFormatControl ................................................................................. 148
BinningHorizontal ............................................................................................................... 148
BinningHorizontalMode ..................................................................................................... 149
BinningVertical ................................................................................................................... 150
BinningVerticalMode .......................................................................................................... 151
DecimationHorizontal ........................................................................................................ 152
DecimationVertical ............................................................................................................. 153
Height ................................................................................................................................. 154
HeightMax .......................................................................................................................... 154
ImageSize ............................................................................................................................ 155

MultipleRegions (subcategory) ................................................................................156

MultipleRegionsEnable ....................................................................................................... 156
SubRegionMode ................................................................................................................. 157
SubRegionHeight ................................................................................................................ 157
SubRegionOffsetY ............................................................................................................... 158
SubRegionSelector .............................................................................................................. 158
SubRegionStatus ................................................................................................................. 159

ImageFormatControl (continued) ............................................................. 160
OffsetX ................................................................................................................................ 160
OffsetY ................................................................................................................................ 161
PixelFormat ......................................................................................................................... 162
SensorBits ........................................................................................................................... 163
SensorHeight ...................................................................................................................... 163
SensorOffsetX ..................................................................................................................... 164
SensorOffsetY ..................................................................................................................... 164
SensorType .......................................................................................................................... 165
SensorWidth ....................................................................................................................... 165
TestPatternGeneratorSelector ........................................................................................... 166
TestPattern ......................................................................................................................... 167
TestPatternSpecificParameter1 ......................................................................................... 168
Width .................................................................................................................................. 168
WidthMax ........................................................................................................................... 169

Info ............................................................................................................. 170
GevDeviceMACAddress ...................................................................................................... 170
BasePartNumber ............................................................................................................... 170
BootLoaderVersionBuild ..................................................................................................... 170
BootLoaderVersionMajor ................................................................................................... 171
BootLoaderVersionMinor ................................................................................................... 171
DevicePartNumber ............................................................................................................. 171
FirmwareVersionBuild ........................................................................................................ 171
FirmwareVersionMajor ...................................................................................................... 172
FirmwareVersionMinor ...................................................................................................... 172
UniqueID ............................................................................................................................ 172
VariantPartNumber ............................................................................................................ 172

Goldeye G/CL Features Reference V1.7.2

9

Contents

LUTControl ................................................................................................. 173
LUTBitDepthIn .................................................................................................................... 173
LUTBitDepthOut ................................................................................................................. 173
LUTDatasetActive ............................................................................................................... 174
LUTDatasetLoad ................................................................................................................. 174
LUTDatasetSave ................................................................................................................. 175
LUTDatasetSelector ............................................................................................................ 175
LUTEnable ........................................................................................................................... 176
LUTIndex ............................................................................................................................. 176
LUTSelector ......................................................................................................................... 177
LUTValue ............................................................................................................................. 177
LUTValueAll ........................................................................................................................ 178

Stream ....................................................................................................... 179
Info (subcategory) ....................................................................................................179
GVSPFilterVersion ............................................................................................................... 179

Multicast (subcategory) ...........................................................................................180

MulticastEnable .................................................................................................................. 180
MulticastIPAddress ............................................................................................................. 181

Settings (subcategory) .............................................................................................182

GVSPAdjustPacketSize ........................................................................................................ 182
GVSPBurstSize ..................................................................................................................... 182
GVSPDriverSelector ............................................................................................................ 183
GVSPHostReceiveBuffers .................................................................................................... 183
GVSPMaxLookBack ............................................................................................................. 184
GVSPMaxRequests ............................................................................................................. 184
GVSPMaxWaitSize .............................................................................................................. 185
GVSPMissingSize ................................................................................................................. 185
GVSPPacketSize .................................................................................................................. 186
GVSPTiltingSize ................................................................................................................... 186
GVSPTimeout ...................................................................................................................... 187

Statistics (subcategory) ...........................................................................................188

StatFrameRate .................................................................................................................... 188
StatFrameDelivered ............................................................................................................ 189
StatFrameDropped ............................................................................................................. 189
StatFrameRescued .............................................................................................................. 190
StatFrameShoved ............................................................................................................... 190
StatFrameUnderrun ............................................................................................................ 191
StatLocalRate ...................................................................................................................... 191
StatPacketErrors ................................................................................................................. 192
StatPacketMissed ............................................................................................................... 192
StatPacketReceived ............................................................................................................ 193
StatPacketRequested .......................................................................................................... 193
StatPacketResent ................................................................................................................ 194
StatTimeElapsed ................................................................................................................. 194

StreamInformation .................................................................................... 195

Goldeye G/CL Features Reference V1.7.2

10

Contents

StreamID ............................................................................................................................. 195
StreamType ......................................................................................................................... 195

TransportLayerControl .............................................................................. 196
CameraLink (subcategory) .......................................................................................196
CLConfiguration .................................................................................................................. 196
ClClockFrequency ................................................................................................................ 197
ClLValToFValDelay .............................................................................................................. 197
ClLValToLValDelay .............................................................................................................. 198
ClMinFValToFValDelay ....................................................................................................... 199
ClMinFValToLValDelay ....................................................................................................... 200
DeviceTapGeometry ........................................................................................................... 200

GigEVision (subcategory) .........................................................................................201

GevCurrentIPConfigurationDHCP ....................................................................................... 201
GevCurrentIPConfigurationLLA .......................................................................................... 202
GevCurrentIPConfigurationPersistentIP ............................................................................. 202
GevInterfaceSelector .......................................................................................................... 203
GevMACAddress ................................................................................................................. 203

TransportLayerControl (continued) ........................................................... 204
PayloadSize ......................................................................................................................... 204

StreamHold (subcategory) .......................................................................................205

StreamHoldCapacity ........................................................................................................... 205
StreamHoldEnable .............................................................................................................. 206

UserSetControl .......................................................................................... 207
Features that can be saved in user sets ..................................................................207
UserSetDefaultSelector ...................................................................................................... 207
UserSetLoad ........................................................................................................................ 208
UserSetSave ........................................................................................................................ 208
UserSetSelector .................................................................................................................. 208

Index ....................................................................................................... 209

Goldeye G/CL Features Reference V1.7.2

11

Contact usContact us
Website, email
Generalwww.alliedvision.com/en/contact
info@alliedvision.com
Distribution partners
www.alliedvision.com/en/avt-locations/avt-distributors
Supportwww.alliedvision.com/en/support
www.alliedvision.com/en/about-us/contact-us/technical-support-repair-/-rma

Offices
Europe, Middle East, and Africa(Headquarters)
Allied Vision Technologies GmbH
Taschenweg 2a
07646 Stadtroda, Germany
T// +49 36428 677-0 (Reception)
T// +49 36428 677-230 (Sales)F// +49 36428 677-28
Asia-PacificNorth, Central, and South America

China

CanadaAllied Vision Technologies(Shanghai) Co., Ltd.
2-2109 Hongwell Int. Plaza
1602# ZhongShanXi Road
Shanghai 200235, China
T// +86 21 64861133

Allied Vision Technologies Canada Inc.
300 – 4621 Canada Way
Burnaby, BC V5G 4X8, Canada
T// +1 604 875 8855

Singapore
Allied Vision Technologies Asia Pte. Ltd
82 Playfair Rd, #07-01 D'Lithium
Singapore 368001
T// +65 6634 9027

Goldeye G/CL Features Reference V1.7.2

USA
Allied Vision Technologies, Inc.
102 Pickering Way - Suite 502
Exton, PA 19341, USA
Toll-free// +1-877-USA-1394
T// +1 978 225 2030

12Document history and conventions

This chapter includes:
Document history ................................................................ 14
Conventions used in this reference ..................................... 16
Copyright and trademarks ................................................... 18

Goldeye G/CL Features Reference V1.6.0

13Document history and conventions

Document history
Version

Date

RemarksV1.7.22023-Jan-26

Firmware version: 04.04.77cd2f3e•••V1.7.12022-Oct-04

Firmware version: 03.06.49d19afc••
V1.7.02022-Mar-08•
2021-Nov-25

Applied changes in Feature description on page 22:- Added new values for PixelFormat.
- Updated MultipleRegions features.
Applied editorial changes.

Firmware version: 02.26.38494•

V1.6.0Updated the title image.
Applied changes in Feature description on page 22:- Added FpaTCDS.
- Added new values for DPCMode.
- Added support for Goldeye G/CL-008 and G/CL-008 XSWIR for
MultipleRegions features.
- Added support for Goldeye all G/CL-008 and all G/CL-034
models for TestPattern features.
- Updated descriptions for TestPattern features.
Applied editorial changes.

Applied changes in Feature description on page 22:- Added ExposureRangeMode.
- Added MultipleRegions features.
- Added TestPattern features.
Applied editorial changes.

Firmware version: 02.24.37527
•
•

•
•
•

Added Image data flow and controls order on page 12.
Applied changes in Feature description on page 22:- Added Average option to BinningHorizontalMode andBinningVerticalMode.
- Added BlackLevel (G/CL-030 TEC1 and G/CL-130 TEC1) withdefault value = 0.
Note: This feature was originally released for G-030 TEC1 andG-130 TEC1 with FW version 02.22.35663, with default = 240.
The feature was omitted in V1.5.0 and V1.5.1 of this reference
because users could not access the feature.
- Added Decimation (all models).
- Added support for SensorTemperatureTargetSetpoint(G/CL-030 TEC1 and G/CL-130 TEC1).
Removed descriptions for Camera Link registers and published in the
Alvium Camera Link Register Controls Reference.
Partly reorganized contents.
Applied editorial changes.

Goldeye G/CL Features Reference V1.7.2

14

Document history and conventions

Version

Date

RemarksV1.5.12021-Sep-16

Corrected information on updated default values forV1.5.02021-Jul-12

Firmware version: 02.22.35663

IntegrationMode.

•

•
•
•

Applied changes in Feature description on page 22:- Added UserWholeImage and UserModeAutoRegion options toContrastAuto.
- Added ContrastUserInputMax, ContrastUserInputMin, andGain (G-030 TEC1 and G-130 TEC1).
Corrected the register address for RegNUCDatasetExposureTime in
Camera Link registers on page 26.
Stopped updating register descriptions in Camera Link registers on
page 26.
Applied editorial changes.

V1.4.1

2019-Sep-05

Editorial changes to improve usability.

V1.4.02019-Jul-09•••

V1.3.1

2019-Mar-20

Added registers ClMinFValToLValDelay, ClLValToLValDelay,
ClLValToFValDelay, and ClMinFValToFValDelay in Camera Link
registers on page 26.

V1.3.02018-May-08

Firmware version: 02.18.20213••

V1.2.02017-Jun-14

Added a Category descriptor to each feature.
Removed an error in the TIDC description.
Applied editorial changes.

Added, moved and renamed features and registers to implement
sensor heating in both parts of the reference.
Applied editorial changes: minor restructuring and corrections.

Firmware version: 02.14.19002
Changes in GenICam part:••V1.1.02016-Jun-30

Firmware version: 02.12.17558•••

V1.0.02016-Feb-29

Added, moved and renamed features to implement AutoContrast.
Added TID correction.
Added features and registers for automatic exposure.
Added features and registers for timing control.
Applied numerous small changes.

Firmware version: 02.10.16613
New document release status

Goldeye G/CL Features Reference V1.7.2

15

Document history and conventions

Conventions used in this reference
To give this features reference an easily understandable layout and to emphasize
important information, the following typographical styles and symbols are used:

StylesThis features reference uses specific text formatting to help the reader find his way
around. The following table gives an explanation of the formatting used.
Style (example)

Function

EmphasisSome important parts or items of the text are emphasized
to make them more visible.

Features names

Features names are displayed as mono-spaced text.

Features options Options for features that are selectable by the user are

displayed as mono-spaced italicized text.

Commands andinputsText or command to type in by the user, selected menu
options, or other selectable options.

Source code

Code words of programs and code examples, used inrunning text. Mainly designated for use in software
documentation.

User Interface
elements

Text that is displayed, or output, by the system for the user,
like parts of the GUI, dialog boxes, buttons, menus,
important information, or windows titles.

Weblinks andReference

References to other documents or webpages, like
weblinks, hypertext links, emails, but also cross references,that include a link the user can follow by clicking.

Table 1: Markup conventions used in this features reference .

Access mode
Abbreviation

Meaning

R/W

Feature is read or write.

R/(W)Feature is readable, and it may be read or write
depending on the user privilege level.

R/C

Feature is read-only and constant.

R

Feature is read-only and may change.

W

Feature is write-only.

Table 2: Abbreviations used in this features reference

Goldeye G/CL Features Reference V1.7.2

16

Document history and conventions

Symbols and notes
This symbol highlights a practical tip that helps to better understand the camera‘sfunctionalities, and to make better use of it.
Safety-related instructions to avoid malfunctions
This symbol indicates important or specific instructions or procedures that are
related to product safety. You need to follow these instructions to avoid
malfunctions.

iThis symbol highlights URLs for further information.

Order and description scheme
This features reference describes categories and feature, as seen from Vimba
Viewer, in alphabetical order.
The features in this reference are described according to this formatting scheme.

Category
First-level item, always starting a new page. Short description, including individual
characteristics, and showing the feature type as (Category).

Subcategory
Short description, including individual characteristics, and showing the feature
type as (Subcategory or 2nd subcategory). The level is stated as:• (Subcategory) after the category name: 1set level subcategory• (2nd subcategory) after the category name: 2nd level

Feature[Selector]
Short description of feature, including individual characteristics and possible
values, and showing the full category path.

Goldeye G/CL Features Reference V1.7.2

17Document history and conventions

Selectors
Some features have multiple instances. For these features, Selector features define
which instance of the feature is accessed.
Example: the LineOutPolarity feature, used to set the output signal polarity, canbe applied to all output lines of the camera. The line is selected by the
LineOutSelector feature.
The headline for the feature description is
LineOutPolarity[LineOutSelector], according to the C programming
language convention for arrays: a pair of brackets follows the feature name, like in
SelectedFeature[Selector].

Invalidators
Some features have opposing functions. For example, TestImage generates areference image to adjust the imaging system, while DefectPixelCorrection
compensates for pixel errors on the individual image sensor. Therefore, when
TestImage is enabled, DefectPixelCorrection must be disabled. Featuredescriptions provide an additional row for opposing features, called Affectedfeatures.

Possible values
The following example table shows how parameter values for features are stated inthis document.
ValuesDescription

Sensorboard

Feature value as displayed in Vimba Viewer

Camera dependent

Values vary between different camera models.

(Height)

Corresponding value for the Height feature(Bit 31)

Bit value

Copyright and trademarks
All text, pictures, and graphics are protected by copyright and other laws
protecting intellectual property. All content is subject to change without notice.
All trademarks, logos, and brands cited in this document are property and/or
copyright material of their respective owners. Use of these trademarks, logos, andbrands does not imply endorsement.
Copyright © 2023 Allied Vision GmbH. All rights reserved.

Goldeye G/CL Features Reference V1.7.2

18

Image data flow and features orderThis chapter includes:
Image data flow.................................................................... 20
Value changes by feature interdependencies ..................... 21

Goldeye G/CL Features Reference V1.7.2

19

Image data flow and features order

Image data flow
To develop your application effectively, note the order in which the features areprocessed in Goldeye G/CL cameras.
In the Goldeye G/CL User Guide, the image data flow describes the sequence ofimage processing steps inside the camera. The shown functionalities represent
features or feature groups.
Note that, depending on firmware version, not all of the modules and features
shown in Figure 1 are available.

^ĞŶƐŽƌ
SeŶƐŽrfroŶteŶd

AnalogAnalogHorizoŶtaldecimaƟŽŶ2BůĂĐŬlevel2
AnalogAnalogn-bit3

AnalogVerƟcĂůdecimaƟŽŶ2

ADC
n-bit3

AnalogNŽŶƵŶiformity
correcƟŽŶ;NUC)

HorizoŶtalROI

GĂŝŶ2SeŶƐŽrgĂŝŶ1VerƟcalROI
AnalogBackŐƌŽƵŶĚcorrecƟŽŶ
n-bit3

ɇ +n-bit3

DefectpixĞůcorrecƟŽŶ;WC)

n-bit3

CorreĐƟŽŶdatĂmemoryCorrecƟoŶdatapipeliŶeHorizoŶtalbŝŶŶŝŶŐ
n-bit3AƵtocoŶƚƌaƐt

VerƟcalBiŶŶiŶŐ
n-bit3n-bit3LooŬƵƉtable
;>UT)
12

n-bit312GigEiŶterface

Framememory
n-bit3orCameraLiŶŬiŶterface

1

All Goldeye G/CL models, except for G/CL-030 and G/CL-130

2 Goldeye G/CL-030 and G/CL-130 only
3 Model dependent: See ADC bit depths in the Specifications chapter.

Figure 1: Goldeye G/CL image data flow
This behavior includes other features as well as described in Value changes byfeature interdependencies on page 21.

Goldeye G/CL Features Reference V1.7.2

20

Image data flow and features order

Value changes by feature interdependencies
The conversion between time and clock cycles affects control values. Features for
pixel format, bandwidth, ROI, exposure time, and triggering are related to eachother. Changing values for one feature can change values for another feature. For
example, frame rates can be reduced when PixelFormat is changed subsequently.
Figure 2 shows the interdependencies.

Set First

PixelFormat
DeviceLinkThrougputLimit
BlackLevelПŝŶŶŝŶŐ^ĞƫŶŐƐ
ĞĐŝŵĂƟŽŶ SeƫngsROI Seƫngs

Set Last

ExposureTime
AcquisiƟonFrameRate

May interact

1 Goldeye G/CL-030 TEC1 and G/CL-130 TEC1 only

Figure 2: Interdependencies between features

Effects for the interdependent features
Changing one control's value affects other control's values, such as:
Height value is changed.
If:
Then: Other values may be affected, such as for AcquisitionFrameRate andExposureTime.
We recommend you to consider:• The more features you adjust, the more current values deviate from previously
set values.
• The same effects that apply to ExposureTime, also apply to AutoExposure.
• To avoid readjustments, apply settings in the order shown in Figure 2.

Goldeye G/CL Features Reference V1.7.2

21

Feature description

This chapter describes the standard and advanced camerafeatures, as seen from Vimba Viewer, for all Goldeye G/CL
models, according to the GenICam SFNC (Standard Feature
Naming Convention), listed by categories:
AcquisitionControl ................................................................ 23
AnalogControl ....................................................................... 46
BufferHandlingControl .......................................................... 48
ChunkDataControl................................................................. 50
DeviceControl........................................................................ 52
DigitalIOControl..................................................................... 78
EventControl.......................................................................... 87
FileAccessControl ................................................................ 112
GigE ..................................................................................... 122
ImageCorrectionControl ..................................................... 128
ImageFormatControl........................................................... 148
Info ...................................................................................... 170
LUTControl........................................................................... 173
Stream ................................................................................. 179
StreamInformation.............................................................. 195
TransportLayerControl ........................................................ 196
UserSetControl.................................................................... 207

Goldeye G/CL Features Reference V1.7.2

22

Feature description

AcquisitionControl
This category includes all features related to image acquisition, including thetrigger and exposure control. It describes the basic model for acquisition and thetypical behavior of the device.
Display nameAcquisitionControl

Origin of feature

CameraFeature type

(Category)

AcquisitionAbort
Software command to stop camera from receiving frame triggers and to abort thecurrent acquisition immediately. A partially transferred image will be completed.
Display nameAcquisitionAbort

Origin of feature

CameraFeature typeCommandAffected features

AcquisitionStart
AcquisitionStop

Category/AcquisitionControl

AcquisitionAutoStartMode
Determines the behavior of the camera after startup.
Display nameAcquisitionAutoStartMode

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl

ValuesDescriptionOn

The camera will acquire images immediately after startup

OffThe camera will not start to acquire images until
AcquisitionStart (default).

Goldeye G/CL Features Reference V1.7.2

23

Feature description

AcquisitionFrameCount
Defines the number of frames to capture in a limited sequence of images. Used
with AcquisitionMode = MultiFrame and AcquisitionMode = Recorder. In
Recorder mode, AcquisitionFrameCount must not exceed
StreamHoldCapacity.
Display nameAcquisitionFrameCount

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

FramesAffected features(None)

Category/AcquisitionControl

ValuesDescription

1

Minimum (default)

65,535

Maximum

AcquisitionFrameRate
If TriggerMode[FrameStart] = Off or TriggerSource = FixedRate, thisfeature specifies the frame rate. Depending on the exposure duration, the camera
may not achieve the frame rate set here.
Display nameAcquisitionFrameRate

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Frames per second

Affected features

ExposureTime

Category/AcquisitionControl

ValuesDescription

Camera dependent

All values

Goldeye G/CL Features Reference V1.7.2

AcquisitionFrameRateLimit

24

Feature description

AcquisitionFrameRateLimit
The maximum frame rate possible for the current exposure duration and image
format.
Display nameAcquisitionFrameRateLimit

Origin of feature

CameraFeature type

Float

AccessR

Unit

Frames per second

Affected features

AcquisitionFrameRate
ExposureTime

Category/AcquisitionControl

ValuesDescription

Camera dependent

All values

Goldeye G/CL Features Reference V1.7.2

25

Feature description

AcquisitionMode
Determines the behavior of the camera when acquisition start is triggered.
Display nameAcquisitionMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl

ValuesDescription

Continuous

After an acquisition start event, the camera willcontinuously acquire images until acquisition stop is
triggered (default).
See TriggerSelector and TriggerSource for more
information.

SingleFrame

The camera will only acquire one single image. Further
trigger events will be ignored until acquisition is stopped
and restarted.

MultiFrame

The camera will acquire the number of images specified
by AcquisitionFrameCount. Further trigger events willbe ignored until acquisition is stopped and restarted.

RecorderThe camera will continuously record images into thecamera’s on-board memory, but will not send them to thehost until an AcquisitionRecord trigger signal isreceived. Further AcquisitionRecord trigger events willbe ignored until acquisition is stopped and restarted.
Combined with RecorderPreEventCount, this feature isuseful for returning any number of frames before a trigger
event.
When AcquisitionRecord trigger is received, the image
currently imaging or acquiring will complete as normal,
and then at least one more image will be taken. The
memory is a circular buffer that starts rewriting images
once it is full. Its size is determined byAcquisitionFrameCount.

Goldeye G/CL Features Reference V1.7.2

26

Feature description

AcquisitionStart
Software command to start camera receiving frame triggers. Valid when
TriggerMode[AcquisitionStart] = Off.
Display nameAcquisitionStart

Origin of feature

CameraFeature typeCommandAffected features

AcquisitionStop
AcquisitionAbort

Category/AcquisitionControl

AcquisitionStop
Software command to stop camera receiving frame triggers. Valid when
TriggerMode[AcquisitionStop] = Off.
Display nameAcquisitionStop

Origin of feature

CameraFeature typeCommandAffected features

AcquisitionStart
AcquisitionAbort

Category/AcquisitionControl

Goldeye G/CL Features Reference V1.7.2

27

Feature description

AutoModeParameters (subcategory)This subcategory holds the parameter features for auto exposure and auto
contrast.
Display nameAutoModeParameters

Origin of feature

CameraFeature type

(Subcategory)Category/AcquisitionControl

AutoModeOutliersBright
Number of upper outliers to discard before calculating exposure adjustments.
Specified in steps of 0.01 percent of the number pixels in the image.
Display nameAutoModeOutliersBright

Origin of feature

CameraFeature type

Float

Access

R/W

Unit

Percent

Affected features(None)

Category/AcquisitionControl/AutoModeParameters

ValuesDescription0

Minimum (default = no exclusion of bright pixels.)

10

Maximum

0.01

Interval

Goldeye G/CL Features Reference V1.7.2

28

Feature description

AutoModeOutliersDark
Number of lower outliers to discard before calculating exposure adjustments.
Specified in steps of 0.01 percent of the number pixels in the image.
Display nameAutoModeOutliersDark

Origin of feature

CameraFeature type

Float

Access

R/W

Unit

Percent

Affected features(None)

Category/AcquisitionControl/AutoModeParameters

ValuesDescription0

Minimum (default = no exclusion of dark pixels.)

10

Maximum

0.01

Interval

AutoModeRegionDimOutside
Dimming the image outside the AutoRegion to make it visible.
Display nameAutoModeRegionDimOutside

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl/AutoModeParameters

ValuesDescription

On

Region of the image outside the AutoRegion is notdimmed.

Off

Region of the image outside the AutoRegion is dimmed(default).

Goldeye G/CL Features Reference V1.7.2

29

Feature description

AutoModeRegionHeight
Height of the auto mode region used in auto features such as auto exposure andauto contrast, relative to the current image region.
Display nameAutoModeRegionHeight

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features(None)

Category/AcquisitionControl/AutoModeParameters

ValuesDescription

1

Minimum (default = equals sensor height)

Camera dependent

Maximum (default = equals sensor height)

AutoModeRegionOffsetX
Horizontal offset of the auto mode region used in auto features such as auto
exposure and auto contrast, relative to the current image region and counted fromits left border.
Display nameAutoModeRegionOffsetX

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features(None)

Category/AcquisitionControl/AutoModeParameters

ValuesDescription0

Minimum (default)

Camera dependent

Maximum (equals sensor width)

Goldeye G/CL Features Reference V1.7.2

30

Feature description

AutoModeRegionOffsetY
Vertical offset of the auto mode region used in auto features such as auto exposureand auto contrast, relative to the current image region and counted from its top
border.
Display nameAutoModeRegionOffsetY

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features(None)

Category/AcquisitionControl/AutoModeParameters

ValuesDescription0

Minimum (default)

Camera dependent

Maximum (equals sensor height)

AutoModeRegionWidth
Width of the auto mode region used in auto features such as auto exposure andauto contrast, relative to the current image region.
Display nameAutoModeRegionWidth

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features(None)

Category/AcquisitionControl/AutoModeParameters

ValuesDescription

1

Minimum

Camera dependent

Maximum (default = sensor width)

Goldeye G/CL Features Reference V1.7.2

31

Feature description

ContrastAutoControl (subcategory)This subcategory holds the features to control the automatic contrast.
Display nameContrastAutoControl

Origin of feature

CameraFeature type

(Subcategory)Category/AcquisitionControl

ContrastAuto
Options to set contrast automatically or manually.
Display nameContrastAuto

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl

ValuesDescription

Off

ContrastAuto is switched off (default).

WholeImage

Automatic contrast is calculated for the whole image.

AutoModeRegion

Automatic contrast is calculated for the defined region.

UserWholeImage

Contrast is set by the user for the whole image.

UserModeAutoRegion

Contrast is set by the user for the defined region.

Notes
•
•

To define minimum and maximum values for UserWholeImage andUserModeAutoRegion, use ContrastUserInputMin andContrastUserInputMax.
Minimum and maximum values for WholeImage and AutoModeRegion arecalculated automatically.

Goldeye G/CL Features Reference V1.7.2

32

Feature description

ContrastAutoIntensityMax
Maximum output intensity level.
Display nameContrastAutoIntensityMax

Origin of feature

CameraFeature type

Integer

AccessR/W

UnitCountsAffected features(None)

Category/AcquisitionControl/ContrastAutoControl

ValuesDescription0

Minimum

255

Maximum and default value for Mono8

4,095

Maximum and default value for Mono12 or
Mono12Packed

16,383

Maximum and default value for Mono14

ContrastAutoIntensityMin
Minimum output intensity level.
Display nameContrastAutoIntensityMin

Origin of feature

CameraFeature type

Integer

AccessR/W

UnitCountsAffected features(None)

Category/AcquisitionControl/ContrastAutoControl

ValuesDescription0

Minimum and default value

255

Maximum value for Mono8

4,095

Maximum value for Mono12 or Mono12Packed

16,383

Maximum value for Mono14

Goldeye G/CL Features Reference V1.7.2

33

Feature description

ContrastUserInputMax
Maximum input intensity level that are mapped to ContrastAutoIntensityMax,
if ContrastAuto is set to UserWholeImage or UserAutoRegion.
Display nameContrastUserInputMax

Origin of feature

CameraFeature type

Integer

AccessR/W

UnitCountsAffected features(None)

Category/AcquisitionControl/ContratAutoControl

ValuesDescription0

Minimum

255

Maximum and default value for Mono8

4,095

Maximum and default value for Mono12 or
Mono12Packed

16,383

Maximum and default value for Mono14

ContrastUserInputMin
Minimum input intensity level that are mapped to ContrastAutoIntensityMin, if
ContrastAuto is set to UserWholeImage or UserAutoRegion.
Display nameContrastUserInputMin

Origin of feature

CameraFeature type

Integer

AccessR/W

UnitCountsAffected features(None)

Category/AcquisitionControl/ContratAutoControl

ValuesDescription0

Minimum and default value

255

Maximum value for Mono8

4,095

Maximum value for Mono12 or Mono12Packed

16,383

Maximum value for Mono14

Goldeye G/CL Features Reference V1.7.2

34

Feature description

ExposureAutoControl (subcategory)This subcategory holds the features to control the automatic exposure.
Display name

ExposureAutoControl

Origin of feature

CameraFeature type

(Subcategory)Category/AcquisitionControl

ExposureAuto
Automatic exposure mode.
Display name

ExposureAuto

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl/ExposureAutoControl

ValuesDescription

Off

Automatic mode is off (default).

Once

Automatic exposure occurs until the target value of theselected auto control algorithm is achieved, then
ExposureAuto returns to Off.

Continuous

Automatic exposure always runs.

Other

The duration of an external trigger pulse directly controls
the duration of the exposure.

Goldeye G/CL Features Reference V1.7.2

35

Feature description

ExposureAutoAdjustTol
Tolerance, allowed from the ideal target value. Within the given tolerance theautomatic exposure does not run.
This prevents needless small adjustments from occurring in each image, when theimage content changes relatively slowly from frame to frame.
Display name

ExposureAutoAdjustTol

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Percent

Affected features(None)

Category/AcquisitionControl/ExposureAutoControl

ValuesDescription0

Minimum

5

Default

50

Maximum

ExposureAutoAlg
Algorithm used for calculating the automatic exposure.
Display name

ExposureAutoAdjustTol

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl/ExposureAutoControl

ValuesDescription

Mean

Target a particular mean value of all measured pixels
within the AutoModeRegion area. The target value itself is
set by ExposureAutoTarget.

FitRange

Adjust the maximum pixel value within the
AutoModeRegion area to fit the sensor dynamic range.

Goldeye G/CL Features Reference V1.7.2

36

Feature description

ExposureAutoMax
Maximum automatic exposure value.
Display name

ExposureAutoMax

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

Microseconds

Affected features(None)

Category/AcquisitionControl/ExposureAutoControl

ValuesDescription

Camera dependent

Minimum

50,0000

Default

Camera dependent

Maximum

ExposureAutoMin
Minimum automatic exposure value.
Display name

ExposureAutoMin

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

Microseconds

Affected features(None)

Category/AcquisitionControl/ExposureAutoControl

ValuesDescription

Camera dependent

All values

Goldeye G/CL Features Reference V1.7.2

37

Feature description

ExposureAutoRate
Rate of automatic exposure adjustments.
Use this feature to slow down the automatic exposure adjustments.
Display name

ExposureAutoRate

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Percent

Affected features(None)

Category/AcquisitionControl/ExposureAutoControl

ValuesDescription

1

Minimum (slowest)

100

Maximum (Fastest, default)

ExposureAutoTarget
Only valid if ExposureAutoAlg is Mean.
This is the target image mean value. Higher values result in brighter images.
Display name

ExposureAutoTarget

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Percent

Affected features(None)

Category/AcquisitionControl/ExposureAutoControl

ValuesDescription

10

Minimum

50

Default

90

Maximum

Goldeye G/CL Features Reference V1.7.2

38

Feature description

AcquisitionControl (continued)
The feature descriptions for the ExposureAutoControl subcategory have ended
on the previous page. The following features continue the AcquisitionControl
category, without a subcategory.

ExposureMode
Method of control for exposure duration.
Display name

ExposureMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl

Possible value

Description

Timed

Exposure duration is set by ExposureTime (default).

ExposureRangeMode
Selects between different ranges for exposure time.
Notes• The exposure time is locked when the camera is streaming in UltraShortmode.
• ExposureAutoControl is not supported if UltraShort mode is active.
Display name

Exposure Range Mode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

ExposureTime, ExposureAutoControl

Category/AcquisitionControl

ValuesDescription

NormalNormal exposure time range (camera dependent), default

UltraShort1

Allows to select exposure times in the range from 3 µs to
7 µs.

1

The UltraShort mode is available only for Goldeye G/CL-030 TEC1 andGoldeye G/CL 130 TEC1 cameras.

Goldeye G/CL Features Reference V1.7.2

39

Feature description

ExposureTime
The sensor integration time.
Display name

ExposureTime

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Microseconds

Affected features

AcquisitionFrameRate
AcquisitionFrameRateLimit

Category/AcquisitionControl

ValuesDescription

Camera dependent

All values

IntegrationMode
The sensor integration mode.
Display name

IntegrationMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AcquisitionFrameRateLimit
AcquisitionFrameRate
ExposureTime

Category/AcquisitionControl

ValuesDescription

IntegrateThenRead

The integration is not allowed to overlap with thereadout.

IntegrateWhileRead

The integration is allowed to overlap with thereadout.

Note: Default values are model dependent.

Goldeye G/CL Features Reference V1.7.2

40

Feature description

RecorderPreEventCount
Only valid if AcquisitionMode = Recorder.
The number of frames returned before the AcquisitionRecord trigger event,with AcquisitionFrameCount minus RecorderPreEventCount frames being
returned after the AcquisitionRecord trigger event.
RecorderPreEventCount must be less than or equal to
AcquisitionFrameCount.

At least one image must be captured after the AcquisitionRecord trigger event, i.e.,
you cannot set RecorderPreEventCount = 1, and AcquisitionFrameCount = 1.

Display nameRecorderPreEventCount

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR/W

Unit

FramesAffected features(None)

Category/AcquisitionControl

ValuesDescription0

Minimum (default)

65,535

Maximum

Goldeye G/CL Features Reference V1.7.2

41

Feature description

TriggerActivation[TriggerSelector]
Type of activation for hardware triggers. This controls edge and level, and polarity
sensitivities.
Display name

TriggerActivation

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl

ValuesDescription

RisingEdge

Rising edge trigger (default)

FallingEdge

Falling edge trigger

AnyEdgeRising or falling edge

LevelHigh

Active high signal

LevelLow

Active low signal

TriggerDelay[TriggerSelector]
Start-of-image can be delayed to begin at a time after a trigger event is received by
the camera. This feature is valid only when TriggerSource is set to external
trigger, for example, Line1 or Line2. This feature is commonly used to synchronize
with a strobe lighting source, which will inherently have some fixed setup time.
Display name

TriggerDelay

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Microseconds

Affected features(None)

Category/AcquisitionControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

42

Feature description

TriggerMode[TriggerSelector]
Enables or disables trigger set in TriggerSelector.
Display name

TriggerMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl

Possible

Description

Off

Trigger disabled.

On

Trigger enabled (default).

If TriggerMode[FrameStart] = Off, images are triggered in FixedRate at
AcquisitionFrameRate.

TriggerOverlap[TriggerSelector]
Permitted window of trigger activation, relative to previous frame. Does not workwith software triggering. Only usable for external triggering.
Display name

TriggerOverlap

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/AcquisitionControl

ValuesDescriptionOff

Any external trigger received before a highFrameTriggerReady signal is ignored (default).

PreviousFrame

Any external trigger received before FrameTriggerReadyis latched and used to trigger the next frame

Goldeye G/CL Features Reference V1.7.2

43

Feature description

TriggerSelector
This feature can be considered to be an index for the following list of affectedfeatures. It selects, which instance of each affected feature is addressed whenaccessing them.
•
•
•
•
•
•

TriggerMode
TriggerSoftware
TriggerSource
TriggerActivation
TriggerOverlap
TriggerDelay

Display name

TriggerSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

TriggerMode, TriggerSoftware,
TriggerSource, TriggerActivation,
TriggerOverlap,TriggerDelay,Category/AcquisitionControl

ValuesDescription

FrameStart

The trigger that starts an image when acquisition isrunning default.

AcquisitionStart

The trigger that starts the acquisition process

AcquisitionEnd

The trigger that ends the acquisition process

AcquisitionRecord(Available only for GigE Vision models.)
The trigger that initiates the sending of
AcquisitionFrameCount number of recorded images
from the camera on-board memory to the host.

TriggerSoftware[TriggerSelector]
Triggers an image. Valid if TriggerSource = Software.
Display name

TriggerSoftware

Origin of feature

CameraFeature typeCommandAffected features(None)

Category/AcquisitionControl

Goldeye G/CL Features Reference V1.7.2

44

Feature description

TriggerSource[TriggerSelector]
Determines how an image frame is initiated within an acquisition stream.
An acquisition stream must be started in order to trigger or receive individual
frames. For Freerun and FixedRate the first frame is synchronized to
AcquisitionStart trigger.
Display name

TriggerSource

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features(None)

Category/AcquisitionControl

ValuesDescription

FreerunCamera runs at maximum supported frame ratedepending on the exposure time and ROI size (default)

Line1

External trigger Line1

Line2

External trigger Line2

FixedRate

Camera self-triggers at a fixed frame rate defined byAcquisitionFrameRate

Software

Software initiates image capture

CC1(Camera Link models only)
External trigger signal CC1 from frame grabber

CC2(Camera Link models only)
External trigger signal CC2 from frame grabber

CC3(Camera Link models only)
External trigger signal CC3 from frame grabber

CC4(Camera Link models only)
External trigger signal CC4 from frame grabberGoldeye G/CL Features Reference V1.7.2

45

Feature description

AnalogControl
Features in this category describe how to control the sensor's analog features.
Display name

AnalogControl

Origin of feature

CameraFeature type

(Category)BlackLevel
Controls the analog black level as an absolute physical value. The feature
represents a DC offset applied to the video signal.
Display nameBlackLevel

Origin of feature

CameraAvailability

G/CL-030 TEC1 and G/CL-130 TEC1

Feature type

Integer

AccessR/W

Category/AnalogControl

ValuesDescription0

Minimum (default)

255

Maximum for Mono8

4,095

Maximum for Mono12 and Mono12p

1

Increment

Goldeye G/CL Features Reference V1.7.2

46

Feature description

Gain
Sets the analog gain level of the sensor.
Display name

Gain

Origin of feature

CameraAvailability

G/CL-030 TEC1 and G/CL-130 TEC1
For other models, see SensorGain.

Feature type

Float

Access

R/W

Unit

dB

Category/AnalogControl

ValuesDescription

0.0

Minimum gain level: 0 dB.

18.0

Maximum gain level: 18 dB.

SensorGain
Sets the FPA gain level.
Display nameSensorGain

Origin of feature

CameraAvailability

All models, except for G/CL-030 TEC1 and G/CL-130 TEC1,For G/CL-030 TEC1 and G/CL-130 TEC1, see Gain.

Feature type

Enumeration

AccessR/W

Affected features(None)

Category/AnalogControl

ValuesDescription

Gain0

Sets FPA gain to the lowest level (default)

Gain1

Sets FPA gain to the first higher level (if available; higher
than Gain0)

Gain2

Sets FPA gain to the second higher level (if available;higher than Gain1)

Goldeye G/CL Features Reference V1.7.2

47

Feature description

BufferHandlingControl
Features in this category control the buffer of the image stream.
Display name

BufferHandlingControl

Origin of feature

CameraFeature type

(Category)StreamAnnounceBufferMinimum
Minimal number of buffers to announce to enable selected acquisition mode.
Display nameStreamAnnounceBufferMinimum

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Vimba

V1.3 or later

Category/BufferHandlingControl

ValuesDescription

Camera dependent

All values

Goldeye G/CL Features Reference V1.7.2

48

Feature description

StreamAnnounceBufferCount
Number of announced (known) buffers on this stream.
Display nameStreamAnnounceBufferCount

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Vimba

V1.3 or later

Category/BufferHandlingControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

StreamBufferHandlingMode
Available buffer handling modes of this stream.
Display nameStreamBufferHandlingMode

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Enumeration

AccessR/W

Affected features

StreamAcquisitionModeSelector

Vimba

V1.3 or later

Category/BufferHandlingControl

ValuesDescription

Default

Default

Goldeye G/CL Features Reference V1.7.2

49

Feature description

ChunkDataControl
Chunks are tagged blocks of data. The tags allow a chunk parser to dissect the data
payload into its elements and to identify the content.
All features related to chunk data control are supported by GigE models only.
Display name

ChunkDataControl

Origin of feature

CameraFeature type

(Category)

ChunkModeActive
Enables camera to send GigE Vision Standard Protocol chunk data with an image.
ChunkModeActive is read-only during acquisition. The following table presents
currently implemented chunk data.
ChunkModeActive provide only the read permission during acquisition.

Display name

ChunkModeActive

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

BooleanAccessR/W

Affected features

NonImagePayloadSize
PayloadSize

Category/ChunkDataControl

ValuesDescription

True

The camera streams frames consisting of chunks, where
also the image is a chunk.

False

The camera streams frames where the payload consists of
the image only (default).

If

Then

ChunkModeActive = False

NonImagePayloadSize = 0

ChunkModeActive = True

NonImagePayloadSize = 48

Goldeye G/CL Features Reference V1.7.2

50

Feature description

Bytes

Description(Bytes 01 to 04)

Acquisition count(Bytes 05 to 08)

Reserved. 0(Bytes 09 to 12)

Exposure value in µs.

(Bytes 13 to 16)

Reserved. 0(Bytes 17 to 18)

Line in levels. A bit field. Bit 0 is Line in 0, bit 1 isLine in 1, and so on.
A bit value of 1 = level high, and a bit value of 0 = level low.

(Bytes 19 to 20)

Line out levels. A bit field. Bit 0 is Line out 0, bit 1 isLine out 1, and so on.
A bit value of 1 = level high, and a bit value of 0 = level low.

(Bytes 21 to 24)

Reserved. 0(Bytes 25 to 28)

Reserved. 0(Bytes 29 to 32)

Reserved. 0(Bytes 33 to 36)

Reserved. 0(Bytes 37 to 40)

Reserved. 0(Bytes 41 to 44)

Chunk ID. 1000

(Bytes 45 to 48)

Chunk length.

NonImagePayloadSize
Maximum size of chunk data, not including the image chunk, in the image block
payload.
Display name

NonImagePayloadSize

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

Access

R

Unit

Bytes

Affected features(None)

Category/ChunkDataControl

If

Then

ChunkModeActive = False

NonImagePayloadSize = 0

ChunkModeActive = True

NonImagePayloadSize = 48

Goldeye G/CL Features Reference V1.7.2

51

Feature description

DeviceControl
Device control features provide general information, control and state of thedevice (camera) and its sensor.
Display name

DeviceControl

Origin of feature

CameraFeature type

(Category)

BandwidthControlMode
Selects the desired mode of bandwidth control.
Bandwidth allocation can be controlled by DeviceLinkThroughputLimit or byregister SCPD0.
SCPD related warning
If you are not familiar with SCPD0 and how this driver uses this register, leave thisset to DeviceLinkThroughputLimit.
Display nameBandwidthControlMode

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Enumeration

AccessR/W

Affected features(None)

Category/DeviceControl

ValuesDescription

DeviceLinkThroughputLimit See the DeviceLinkThroughputLimit feature

for more information (default).

SCPD

Stream channel packet delay expressed intimestamp counter units. This mode may be
used to limit the rate of data from the camera
to the host. It works by inserting a delay
between successive stream channel packets,
e.g. the longer the delay, the slower the data
rate. This mode is NOT recommended.

Both

Implements a combination of control modes.
This mode is NOT recommended.

Goldeye G/CL Features Reference V1.7.2

52

Feature description

DeviceBaudRateSwitchConfirmTimeout
Timeout for a confirmation write while switching the data transmission rate to a
new value. The device falls back to the previous transmission rate, if the change is
not confirmed within the time set here.
Applies to the GenCP control link on Camera Link devices. If set to 0xFFFFFFFF, theconfirmation write requirement is disabled.
Display name

DeviceBaudRateSwitchConfirmTimeout

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

Milliseconds

Affected features(None)

Category/DeviceControl

ValuesDescription

Camera dependent

Minimum

250

Default

Camera dependent

Maximum

DeviceClockFrequency[DeviceClockSelector]
Returns the frequency of the clock selected by DeviceClockSelector.
Display name

DeviceClockFrequency

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Float

AccessR/C

Unit

Microseconds

Affected features(None)

Category/DeviceControl

Goldeye G/CL Features Reference V1.7.2

53

Feature description

DeviceClockSelector
Returns the device clock the frequency of which is returned by
DeviceClockFrequency.
Display name

DeviceClockSelector

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Enumeration

Access

R/C

Affected features(None)

Category/DeviceControl

ValuesDescription

CameraLink

Default

DeviceFamilyName
Identifier of the product family of the device.
Display name

DeviceFamilyName

Origin of feature

CameraFeature type

StringAccess

R/C

Affected features(None)

Category/DeviceControl

Goldeye G/CL Features Reference V1.7.2

54

Feature description

DeviceFanMode[DeviceFanSelector]
Enables or disables the fan.
Display name

DeviceFanMode

Origin of feature

CameraAvailability

Cool models only

Feature type

Enumeration

AccessR/W

Affected features(None)

Category/DeviceControl

ValuesDescription

On

Turns the device fan on (default).

Off

Turns the device fan off.

DeviceFanRpm[DeviceFanSelector]
Current rotation speed of the fan.
Display name

DeviceFanRpm

Origin of feature

CameraAvailability

Cool models only

Feature type

Integer

Access

R

Unit

min-1

Affected features(None)

Category/DeviceControl

ValuesDescription0

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

55

Feature description

DeviceFanSelector
Selects the fan to be controlled by DeviceFanMode and DeviceFanRpm.
Display name

DeviceFanSelector

Origin of feature

CameraAvailability

Cool models only

Feature type

Enumeration

AccessR/W

Affected features(None)

Category/DeviceControl

ValuesDescription

Main

Selects the main fan.

DeviceFirmwareVersion
Firmware version of this Allied Vision GigE camera.
Display name

DeviceFirmwareVersion

Origin of feature

CameraFeature type

StringAccess

R/C

Affected features(None)

Category/DeviceControl

Goldeye G/CL Features Reference V1.7.2

56

Feature description

DeviceLinkHeartbeatTimeout[DeviceLinkSelector]
Controls the current heartbeat timeout of the link selected by
DeviceLinkSelector.
Display name

DeviceLinkHeartbeatTimeout

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Microseconds

Affected features(None)

Category/DeviceControl

ValuesDescription

500,000

Minimum

3,000,000

Default

Camera dependent

Maximum

1,000

Increment

DeviceLinkSelector
Selects which link of the device to control.
Display name

DeviceLinkSelector

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/DeviceControl

ValuesDescription0

Minimum

0

Maximum

Goldeye G/CL Features Reference V1.7.2

57

Feature description

DeviceLinkThroughputLimit
Throttles the data rate of the camera. This is particularly useful for slowing thecamera down so that it can operate over slower links such as Fast Ethernet (100speed), or wireless networks. It is also an important feature for multi-camera
situations. When multiple cameras are connected to a single Gigabit Ethernet port
(usually through a switch), DeviceLinkThroughputLimit for each camera needs
to be set to a value so that the sum of all camera’s DeviceLinkThroughputLimitparameter does not exceed the data rate of the GigE port. Taking care that thiscondition is fulfilled will ensure that multiple camera setups work without packet
collisions, i.e. data loss.
To calculate the required minimum DeviceLinkThroughputLimit setting for acamera in any image mode, use the following formula:
DeviceLinkThroughputLimit = Height × Width × FrameRate × Bytes per Pixel
115,000,000 is the typical maximum data rate for a GigE port. Beyond this setting,some network cards will drop packets.
If you are seeing occasional frames or packets reported as StatFrameDropped or
StatPacketMissed you will likely need to decrease this parameter.

Display name

DeviceLinkThroughputLimit

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR/W

Unit

Bytes per second

Affected features

AcquisitionFrameRateLimit
AcquisitionFrameRate
ExposureTime

Category/DeviceControl

ValuesDescription

1,000,000

Minimum

115,000,000

Note: when setting this value, omit the commas. Digitgrouping is displayed only for documentation purposes.
(Default)

124,000,000

Maximum

Goldeye G/CL Features Reference V1.7.2

58

Feature description

DeviceLinkThroughputLimitModeControls if the DeviceLinkThroughputLimit is active. When disabled, lower level
Transport Layer specific features are expected to control the throughput. Whenenabled, DeviceLinkThroughputLimit controls the overall throughput.
Display name

DeviceLinkThroughputLimitMode

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

BooleanAccessR/W

Affected features

StreamFrameRateConstrain
AcquisitionFrameRateLimit
AcquisitionFrameRate
ExposureTime

Category/DeviceControl

ValuesDescription

On

Camera automatically limits frame rate to bandwidth,
determined by DeviceLinkThroughputLimit, to prevent
camera buffer overflows and dropped frames (default).

Off

Frame rate is not limited to bandwidth but by sensor
readout time. Latter case is useful for AcquisitionMode =Recorder or StreamHoldEnable = On modes, as thesemodes are not bandwidth limited.

DeviceManufacturerInfo
Part code and flags of this Allied Vision camera.
Example entry: Goldeye G-008|4068080|
Display name

DeviceManufacturerInfo

Origin of feature

CameraFeature type

StringAccessR

Affected features(None)

Category/DeviceControl

Goldeye G/CL Features Reference V1.7.2

59

Feature description

DeviceModelName
Camera family and model name, such as Goldeye G-032. Software should use theDevicePartNumber to distinguish between models.
Display name

DeviceModelName

Origin of feature

CameraFeature type

StringAccess

R/C

Affected features(None)

Category/DeviceControl

ValuesDescription(Goldeye cameras)

Family name, model name, and number of the camera

DeviceRelativeHumidity[DeviceRelativeHumiditySelector]
Relative humidity, in percent, measured at the location selected in
DeviceRelativeHumiditySelector.
Display name

DeviceRelativeHumidity

Origin of feature

CameraFeature type

Float

AccessR

Unit

Percent

Affected features(None)

Category/DeviceControl

ValuesDescription0

Minimum

100

Maximum

Goldeye G/CL Features Reference V1.7.2

60

Feature description

DeviceRelativeHumiditySelector
Selects the location for measuring relative humidity.
Display name

DeviceRelativeHumiditySelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

DeviceRelativeHumidity

Category/DeviceControl

ValuesDescription

Sensorboard

Location of measuring device

DeviceReset
Resets the device to its power up state.
After reset, the device must be rediscovered.
Display name

DeviceReset

Origin of feature

CameraFeature typeCommandAccessW

Affected features(None)

Category/DeviceControl

DeviceSFNCVersionMajor
Major part of the SFNC version number (part before the decimal).
Display name

DeviceSFNCVersionMajor

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/DeviceControl

Goldeye G/CL Features Reference V1.7.2

61

Feature description

DeviceSFNCVersionMinor
Minor part of the SFNC version number (part after the decimal).
Display name

DeviceSFNCVersionMinor

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/DeviceControl

DeviceSFNCVersionSubMinor
Subordinate part of the firmware Minor number (part after the minor).
Display name

DeviceSFNCVersionSubMinor

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/DeviceControl

DeviceScanType
Scan type of the camera.
Display name

DeviceScanType

Origin of feature

CameraFeature type

Enumeration

Access

R/C

Affected features(None)

Category/DeviceControl

ValuesDescription

AreascanDefault

Goldeye G/CL Features Reference V1.7.2

62

Feature description

DeviceSerialNumber
Serial number of the camera.
Display name

DeviceSerialNumber

Origin of feature

CameraFeature type

StringAccess

R/C

Affected features(None)

Category/DeviceControl

DeviceSerialPortBaudRate[DeviceSerialPortSelector]
Controls the data transmission rate used by the selected serial port. Note thatexactly one bit must be set.
Display name

DeviceSerialPortBaudRate

Origin of feature

CameraFeature type

Enumeration

AccessR/(W)Affected features(None)

Category/DeviceControl

ValuesDescription

Baud9600

Serial port runs at 9600 bits/second (default)

Baud19200

Serial port runs at 19200 bits/second

Baud38400

Serial port runs at 38400 bits/second

Baud57600

Serial port runs at 57600 bits/second

Baud115200

Serial port runs at 115200 bits/second

Baud230400

Serial port runs at 230400 bits/second

Baud460800

Serial port runs at 460800 bits/second

Baud921600

Serial port runs at 921600 bits/second

Baud931600

Serial port runs at 931600 bits/second

Goldeye G/CL Features Reference V1.7.2

63

Feature description

DeviceSerialPortSelector
Selects which serial port of the device to control.
Display name

DeviceSerialPortSelector

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Enumeration

AccessR/W

Affected features

DeviceSerialPortBaudrate

Category/DeviceControl

ValuesDescription

CameraLink

Default

DeviceStreamChannelPacketSize[DeviceStreamChannelSelector]
Specifies the stream packet size to send on the selected channel for the camera or
specifies the maximum packet size supported by the receiver.
Display name

DeviceStreamChannelPacketSize

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR/W

Affected features

DeviceLinkThroughputLimit
AcquisitionFrameRateLimit
AcquisitionFrameRate
ExposureTime
GevSCPSPacketSize
StreamHoldCapacity
GVSPPacketSize

Category/DeviceControl

ValuesDescription

500

Minimum

1,500

Default

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

64Feature description

DeviceStreamChannelSelector
Selects the stream channel to control.
Display name

DeviceStreamChannelSelector

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/DeviceControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

DeviceTemperature[DeviceTemperatureSelector]
Device temperature, measured at the location selected by
DeviceTemperatureSelector.
Display name

DeviceTemperature

Origin of feature

CameraFeature type

Float

AccessR

Unit

Degree Celsius (°C)

Affected features(None)

Category/DeviceControl

ValuesDescription

Camera dependent

Range

Goldeye G/CL Features Reference V1.7.2

65

Feature description

DeviceTemperatureSelector
Selects one of the build-in temperature sensors within the camera.
Display name

DeviceTemperatureSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

DeviceTemperature

Category/DeviceControl

ValuesDescription

SensorTemperature sensor beside the camera sensor (default).

Sensorboard

Temperature sensor on the sensor board.

Mainboard

Temperature sensor on the main board.

DeviceTLType
Defines the transport layer type.
Display name

DeviceTLType

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features(None)

Category/DeviceControl

ValuesDescription

GigEVision

Default for GigE Vision models

CameraLink

Default for Camera Link models

Goldeye G/CL Features Reference V1.7.2

66

Feature description

DeviceType
Type of the camera.
Display name

DeviceType

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features(None)

Category/DeviceControl

ValuesDescription

Transmitter

Default

DeviceUserID
Used for example in multiple-camera setups for providing meaningful labels to
individual cameras.
Display name

DeviceUserID

Origin of feature

CameraFeature type

StringAccessR/W

Affected features(None)

Category/DeviceControl

DeviceVendorName
Manufacturer‘s name.
Display name

DeviceVendorName

Origin of feature

CameraFeature type

StringAccess

R/C

Affected features(None)

Category/DeviceControl

ValuesDescription

Allied Vision

Default

Goldeye G/CL Features Reference V1.7.2

67

Feature description

SensorBoardSettings (subcategory)This subcategory holds settings special to the sensor board.
Display nameSensorBoardSettings

Origin of feature

CameraFeature type

(Subcategory)Category/DeviceControl

FpaTCDS
Adjusts the amount of time from the end of the integrator reset until the firstsample in CDS mode.
Note: FpaTCDS is available only for all Goldeye G/CL-034 models.
Category path
The path for FpaTCDS is /DeviceControl/SensorBoardSettings/FocalPlaneArray/
FpaControlRegisters/FpaTCDS.
Display name

FpaTCDS

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/DeviceControl/SensorBoardSettings/FocalPlaneArray/
FpaControlRegisters

ValuesDescription0

Minimum value

15

Maximum value

Goldeye G/CL Features Reference V1.7.2

68

Feature description

TIDC_Mode
Trigger-induced distortion correction mode.
Category path
The path for TIDC_Mode is /DeviceControl/SensorBoardSettings/
TriggerInducedDistortionCorrection/TIDC_Mode.
Display name

TIDC_Mode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/DeviceControl/SensorBoardSettings/
TriggerInducedDistortionCorrection

ValuesDescription

Off

No correction is applied.

LineGlitchOnly

Reduces the effect of the horizontal line.

BrightnessStep

Levels the brightness above and below the horizontal
line.

BothDistortions

Applies corrections for both distortions (default).

Goldeye G/CL Features Reference V1.7.2

69

Feature description

DeviceControl (continued)
The feature descriptions for the SensorBoardSettings/
TriggerInducedDistortionCorrection subcategory have ended on theprevious page. The following features continue the DeviceControl category,without a subcategory.

SensorCoolingPower
Current TEC device power consumption. Negative values indicate that the sensor isheated by the TEC.
Display nameSensorCoolingPower

Origin of feature

CameraFeature type

Float

AccessR

Unit

Milliwatts

Affected features(None)

Category/DeviceControl

ValuesDescription

Camera dependent

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

70

Feature description

SensorTemperatureControlMode
Defines the control mode for the Peltier element of the sensor. If set toTemperatureControl, sensor temperature is stabilized to the given set of
setpoints.
Display nameSensorTemperatureControlMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

SensorTemperatureTargetSetpoint,
SensorTemperatureSetpointActive

Category/DeviceControl

ValuesDescription

Off

No sensor temperature control

TemperatureControl

Regulates the sensor temperature by cooling(not heating), aiming to stabilize it at
SensorTemperatureSetpointValue of theactivated SensorTemperatureSetpointActive(default).

TemperatureControlTarget (Only G/CL-008 models)Regulates the sensor temperature by heating
and cooling, aiming to stabilize it at
SensorTemperatureSetpointValue of theactivated
SensorTemperatureSetpointActive.
Activates the feature
SensorTemperatureTargetSetpoint that sets
the active
SensorTemperatureSetpointActive.

Goldeye G/CL Features Reference V1.7.2

71

Feature description

SensorTemperatureControlState
Status of the sensor temperature control, which is indicated by the temperature
status LED.
Display nameSensorTemperatureControlState

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features(None)

Category/DeviceControl

ValuesDescription

Off

Sensor temperature control is off.

Deviated

Sensor temperature deviates from the setpoint value.

StableSensor temperature is stable at the setpoint.

LowerLimit

Cooling regulator is working at its lower limit.

UpperLimit

Cooling regulator is working at its upper limit.

Alert

Camera temperature has reached an overheat protection
threshold temperature, the cooling and the sensor are
powered off to protect the camera and let it cool down.

SensorTemperatureSetpointActivate[SensorTemperatureSetpointSelector]
Activates the currently selected setpoint, which is represented by
SensorTemperatureSetpointSelector.
Display nameSensorTemperatureSetpointActivate

Origin of feature

CameraFeature typeCommandAffected features(None)

Category/DeviceControl

Goldeye G/CL Features Reference V1.7.2

72

Feature description

SensorTemperatureSetpointActive[SensorTemperatureSetpointSelector]
Displays the active setpoint.
Display nameSensorTemperatureSetpointActive

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features(None)

Category/DeviceControl

ValuesDescription

1

Displays the lowest defined temperature setpoint for all
Goldeye cameras.

2

Displays the second defined temperature setpoint for all
Goldeye cameras.

3

Displays the third defined temperature setpoint for all
Goldeye cameras (highest for Goldeye G-032 Cool).

4(Not available for Goldeye G-032 Cool)
Displays the highest possible definable temperature
setpoint.

Goldeye G/CL Features Reference V1.7.2

73

Feature description

SensorTemperatureSetpointMode[SensorTemperatureSetpointSelector]
Controls the setpoint mode for the TEC. Allows to set either the manual or
automatic selection of setpoints.
Activates the currently selected SensorTemperatureSetpoint.
Display nameSensorTemperatureSetpointMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/DeviceControl

ValuesDescription

ManualSelect the setpoint manually. The active setpoint ispresented by SensorTemperatureSetpointActive andit can be changed by the following ways:• SensorTemperatureSetpointSelector andSensorTemperatureSetpointActivate insuccession• SensorTemperatureTargetSetpoint inTemperatureControlTarget mode

Auto

The setpoint is selected automatically (default).

Goldeye G/CL Features Reference V1.7.2

74

Feature description

SensorTemperatureSetpointSelector
Selects the setpoint to be activated.
Only valid if SensorTemperatureSetpointMode is set to Manual.
Display nameSensorTemperatureSetpointSelector

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

SensorTemperatureSetpointValue

Category/DeviceControl

ValuesDescription

1

Lowest defined temperature setpoint for all Goldeye
cameras (default for Goldeye G-032 Cool).

2Second defined temperature setpoint for all Goldeye
cameras (default for G/CL-008, G/CL-032, G/CL-033).

3

Third defined temperature setpoint for all Goldeye
cameras (highest for Goldeye G-032 Cool).

4(Not available for Goldeye G-032 Cool)
Highest possible definable temperature setpoint.

SensorTemperatureSetpointValue[SensorTemperatureSetpointSelector]
The setpoint temperature, corresponding to the setpoint selected in
SensorTemperatureSetpointSelector.
Refer to the Goldeye G/CL Technical Manual to see which temperature is preassigned to each setpoint.
Display nameSensorTemperatureSetpointValue

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Degree Celsius (°C)

Affected features(None)

Category/DeviceControl

Goldeye G/CL Features Reference V1.7.2

75

Feature description

SensorTemperatureTargetSetpoint
The setpoint that the camera tries to keep, using cooling and heating capabilities, if
SensorTemperatureControlMode is set to TemperatureControlTarget.
The selected setpoint is automatically activated.
Decrementing to setpoints lower than TargetSetpoint by SetpointMode Auto isdisabled.
Display nameSensorTemperatureTargetSetpoint

Origin of feature

CameraAvailability

G/CL-008 TEC1, G/CL-008 Cool TEC1, G/CL-030TEC1,
G/CL-130TEC1

Feature type

Integer

AccessR/W

Affected features

SensorTemperatureSetpointActive

Category/DeviceControl

ValuesDescription

1

Lowest defined temperature setpoint for all Goldeye
cameras.

2

Second defined temperature setpoint for all Goldeye
cameras (default).

3

Third defined temperature setpoint for all Goldeye
cameras.

4

Highest possible definable temperature setpoint.

TimestampLatch
Captures timestamp and stores it in TimestampLatchValue.
Display nameTimestampLatch

Origin of feature

CameraAvailability

GigE Vision models only

Feature typeCommandAffected features

GevTimestampControlLatch
GevTimestampControlResetTimestampReset

Category/DeviceControl

Goldeye G/CL Features Reference V1.7.2

76

Feature description

TimestampReset
Resets the camera’s timestamp to 0.
Display nameTimestampReset

Origin of feature

CameraAvailability

GigE Vision models only

Feature typeCommandAffected features(None)

Category/DeviceControl

TimestampLatchValue
Value of Timestamp, when latched by TimestampLatch.
Display nameTimestampLatchvalue

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Camera clock ticks

Affected features

GevTimestampValue

Category/DeviceControl

Goldeye G/CL Features Reference V1.7.2

77

Feature description

DigitalIOControl
This category contains the digital I/O control features.
Display name

DigitalIOControl

Origin of feature

CameraFeature type

(Category)

LineInThis category contains the digital input control features.
Display name

LineInOrigin of feature

CameraFeature type

(Category)Category/DigitalIOControl

LineInGlitchFilter[LineInSelector]
This feature is used to suppress glitches on the LineIn input line that is selectedby LineInSelector. The value defines the maximum width of a glitch that can besuppressed.
Setting LineInGlitchFilter value causes a latency of FrameTrigger by the sameamount.

Display name

LineInGlitchFilter

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

Nanoseconds

Affected features(None)

Category/DigitalIOControl/LineIn

ValuesDescription0

Minimum (default = disabled)

50,000Maximum

Goldeye G/CL Features Reference V1.7.2

78

Feature description

LineInLevels
A register that represents the current state of the available input lines. For
example, when this value returns 2 (0010), LineIn2 is high and all other Line input
signals are low.
Display name

LineInLevels

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/DigitalIOControl/LineIn

ValuesDescription(Bit 31)

Status of LineIn1(Bit 29)

Status of LineIn2(Bit 27)(Camera Link models only) Status of CC1(Bit 26)(Camera Link models only) Status of CC2(Bit 25)(Camera Link models only) Status of CC3(Bit 24)(Camera Link models only) Status of CC4Goldeye G/CL Features Reference V1.7.2

79

Feature description

LineInSelector
Select which LineIn to control with LineInGlitchFilter.
Display name

LineInSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

LineInGlitchFilter

Category/DigitalIOControl/LineIn

ValuesDescription

LineIn1

LineInGlitchFilter controls LineIn1 (default).

LineIn2

LineInGlitchFilter controls LineIn2.

CC1(Camera Link models only)
LineInGlitchFilter controls CC1.

CC2

(Camera Link models only)
LineInGlitchFilter controls CC2.

CC3

(Camera Link models only)
LineInGlitchFilter controls CC3.

CC4

(Camera Link models only)
LineInGlitchFilter controls CC4.

Goldeye G/CL Features Reference V1.7.2

80

Feature description

LineOut
This category contains the digital output control features. Digital outputs are used
for synchronization purposes with other cameras and devices or as general
purpose outputs.
Display name

LineOut

Origin of feature

CameraFeature type

(Category)Category/DigitalIOControl

LineOutLevels
Each bit in this feature represents the state of the related digital output line when
it is configured to operate in GPO mode.
LineOutPolarity can invert the LineOutLevels.

Display name

LineOutLevels

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/DigitalIOControl/LineOut

ValuesDescription

0

LineOut1 low, LineOut2 low, LineOut3 low

1

LineOut1 high, LineOut2 low, LineOut3 low

2

LineOut1 low, LineOut2 high, LineOut3 low

3LineOut1 high, LineOut2 high, LineOut3 low

4

LineOut1 low, LineOut2 low, LineOut3 high5

LineOut1 high, LineOut2 low, LineOut3 high6

LineOut1 low, LineOut2 high, LineOut3 high7

LineOut1 high, LineOut2 high, LineOut3 highGoldeye G/CL Features Reference V1.7.2

81

Feature description

LineOutPolarity[LineOutSelector]
Polarity applied to the LineOut specified by LineOutSelector.
LineOutPolarity also affects the related digital output line when it is configured

to GPO mode.

Display name

LineOutPolarity

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/DigitalIOControl/LineOut

ValuesDescription

NormalNormal polarity (default)

InvertPolarity is inverted.

LineOutSelector
Selects the LineOut to control using the LineOutSource and LineOutPolarity
features.
Display name

LineOutSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

LineOutSource
LineOutPolarity

Category/DigitalIOControl/LineOut

ValuesDescription

LineOut1

Set to control LineOut1 (default).

LineOut2

Set to control LineOut2

LineOut3

Set to control LineOut3

Goldeye G/CL Features Reference V1.7.2

82

Feature description

LineOutSource[LineOutSelector]
Signal source of the LineOut line specified by LineOutSelector.
For detailed information see the camera waveform diagrams provided in theGoldeye G/CL Technical Manual.

Display name

LineOutSource

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

FrameTriggerReady

Category/DigitalIOControl/LineOut

ValuesDescription

GPO

General purpose output

AcquisitionTriggerReady Active once the camera has been recognized by

the host computer and is ready to startacquisition

FrameTriggerReady

Active when the camera is in a state that will
accept the next frame trigger

Exposing

Active for the duration of sensor exposure(default)

FrameReadout

Active during frame readout, i.e. the transferringof image data from the CCD to camera memory

Imaging

Active when the camera is exposing or readingout frame data

Acquiring

Active when acquisition start has been initiated

LineIn1

Active when there is an external trigger at Line1

LineIn2

Active when there is an external trigger at Line2

Strobe1

The output signal is controlled according toStrobe1 settings

CC1(Camera Link models only)
Active when there is an external trigger at CC1.

CC2

(Camera Link models only)
Active when there is an external trigger at CC2.

CC3

(Camera Link models only)
Active when there is an external trigger at CC3.

CC4

(Camera Link models only)
Active when there is an external trigger at CC4.

Goldeye G/CL Features Reference V1.7.2

83

Feature description

StrobeStrobe is an internal signal generator for on-camera clocking functions. Valid when
any of the LineOutSource is set to Strobe1. Strobe allows to change the delay
and duration of a source signal, which can be useful e. g. when trying tosynchronize a camera exposure to an external signal.
Display name

StrobeOrigin of feature

CameraFeature type

(Category)Category/DigitalIOControl

StrobeDelay
Delay from strobe trigger to strobe output.
Display name

StrobeDelay

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

Microseconds

Affected features(None)

Category/DigitalIOControl/Strobe

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

84

Feature description

StrobeDuration
Duration of strobe signal.
Display name

StrobeDuration

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

Microseconds

Affected features(None)

Category/DigitalIOControl/Strobe

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

StrobeDurationMode
Mode of the strobe timing unit.
Display name

StrobeDurationMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/DigitalIOControl/Strobe

ValuesDescription

SourceStrobe duration is the same as source duration (default)

Controlled

Strobe duration is set by StrobeDuration

Goldeye G/CL Features Reference V1.7.2

85

Feature description

StrobeSource
Associates the start of strobe signal with one of the signals defined as values in thefollowing table.
For detailed information see the camera waveform diagrams provided in theGoldeye G/CL Technical Manual.

Display name

StrobeSource

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/DigitalIOControl/Strobe

ValuesDescription

AcquisitionTriggerReady Active once the camera has been recognized by

the host computer and is ready to startacquisition

FrameTriggerReady

Active when the camera is in a state that will
accept the next frame trigger

FrameTrigger

Active when an image has been initiated to start.
This is the logic trigger signal inside of thecamera. It is initiated by an external trigger orsoftware trigger (default)

Exposing

Active for the duration of sensor exposure

FrameReadout

Active for the duration of frame readout, i.e. thetransferring of image data from the CCD tocamera memory

Acquiring

Active during the acquisition stream

LineIn1

Active when there is an external trigger at line1

LineIn2

Active when there is an external trigger at line2

CC1(Camera Link models only)
Active when there is an external trigger on CC1

CC2(Camera Link models only)
Active when there is an external trigger on CC2

CC3(Camera Link models only)
Active when there is an external trigger on CC3

CC4(Camera Link models only)
Active when there is an external trigger on CC4.

Goldeye G/CL Features Reference V1.7.2

86Feature description

EventControl
This category describes how to control the generation of Events to the hostapplication. An Event is a message that is sent to the host application to notify it of
the occurrence of an internal event.
Display name

EventControl

Origin of feature

CameraFeature type

(Category)

EventData (subcategory)This subcategory holds the frame ID and camera time stamp of all the events
supported by the camera. All time stamps are given in nanoseconds since device
start.
Display name

EventData

Origin of feature

CameraFeature type

(Subcategory)Category/EventControl

EventAcquisitionEndFrameID
ID of last frame before acquisition end.
Display name

EventAcquisitionEndFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

87

Feature description

EventAcquisitionEndTimestamp
Camera time stamp when acquisition end occurred.
Display name

EventAcquisitionEndTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventAcquisitionRecordTriggerFrameID
ID of frame when acquisition record trigger was activated.
Display name

EventAcquisitionRecordTriggerFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

EventAcquisitionRecordTriggerTimestamp
Camera time stamp when acquisition record trigger was activated.
Display name

EventAcquisitionRecordTriggerTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

88Feature description

EventAcquisitionStartFrameID
ID of first frame after acquisition start.
Display name

EventAcquisitionStartFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

EventAcquisitionStartTimestamp
Camera time stamp when acquisition start occurred.
Display name

EventAcquisitionStartTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventErrorFrameID
ID of frame when an error occurred.
Display name

EventErrorFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

89

Feature description

EventErrorTimestamp
Camera time stamp when an error occurred.
Display name

EventErrorTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventExposureEndFrameID
Display name

EventExposureEndFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventExposureEndTimestamp
Display name

EventExposureEndTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

90

Feature description

EventFrameTriggerFrameID
Display name

EventFrameTriggerFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventFrameTriggerTimestamp
Display name

EventFrameTriggerTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventFrameTriggerReadyFrameID
Display name

EventFrameTriggerReadyFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

91

Feature description

EventFrameTriggerReadyTimestamp
Display name

EventFrameTriggerReadyTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventLine1FallingEdgeFrameID
Display name

EventLine1FallingEdgeFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

EventLine1FallingEdgeTimestamp
Display name

EventLine1FallingEdgeTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

92

Feature description

EventLine1RisingEdgeFrameID
Display name

EventLine1RisingEdgeFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

EventLine1RisingEdgeTimestamp
Display name

EventLine1RisingEdgeTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventLine2FallingEdgeFrameID
Display name

EventLine2FallingEdgeFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

93

Feature description

EventLine2FallingEdgeTimestamp
Display name

EventLine2FallingEdgeTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventLine2RisingEdgeFrameID
Display name

EventLine2RisingEdgeFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

EventLine2RisingEdgeTimestamp
Display name

EventLine2RisingEdgeTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

94

Feature description

EventOverflowFrameID
Display name

EventOverflowFrameID

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

EventOverflowTimestamp
Display name

EventOverflowTimestamp

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventSensorTemperatureControlStateFrameID
Display name

EventSensorTemperatureControlStateFrameID

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

95

Feature description

EventSensorTemperatureControlStateTimestamp
Display name

EventSensorTemperatureControlStateTimestamp

Origin of feature

CameraFeature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

EventSensorTemperatureSetpointFrameID
Display name

EventSensorTemperatureControlStateFrameID

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/EventControl/EventData

EventSensorTemperatureSetpointTimestamp
Event is generated by a change in temperature setpoint.
Display name

EventSensorTemperatureControlStateTimestamp

Origin of feature

CameraFeature type

Integer

AccessR

Unit

Nanoseconds since device start

Affected features(None)

Category/EventControl/EventData

Goldeye G/CL Features Reference V1.7.2

96

Feature description

EventID (subcategory)
Display name

EventID

Origin of feature

CameraFeature type

(Subcategory)Category/EventControl

If you use the message channel for event notification, you are always subscribed to
EventOverflow and EventError events.

There is no mechanism to detect the loss of events during transportation.
If misconfigured, cameras may produce lots of events—more than a computer canhandle.
Event name
EventAcquisitionStart
EventAcquisitionEnd
EventFrameTrigger
EventExposeEnd
EventAcquisitionRecordTrigger
EventLineIn1RisingEdge
EventLineIn1FallingEdge
EventLineIn2RisingEdge
EventLineIn2FallingEdge
EventFrameTriggerReady
EventCC1RisingEdge
EventCC1FallingEdge
EventCC2RisingEdge
EventCC2FallingEdge
EventCC3RisingEdge
EventCC3FallingEdge
EventCC4RisingEdge
EventCC4FallingEdge
EventSensorTemperatureSetpoint
EventSensorTemperatureControlState
EventOverflow
EventError

Goldeye G/CL Features Reference V1.7.2

GigE Event ID
40000
40001
40002
40003
40004
40010
40011
40012
40013
40016
(Not available)(Not available)(Not available)(Not available)(Not available)(Not available)(Not available)(Not available)
40027
40028
65534
65535

CL Event ID
0x8000 (32768)
0x8001 (32769)(Not available)(Not available)(Not available)
0x800A (32778)
0x800B (32779)
0x800C (32780)
0x800D (32781)(Not available)
0x8012 (32786)
0x8013 (32787)
0x8014 (32788)
0x8015 (32789)
0x8016 (32790)
0x8017 (32791)
0x8018 (32792)
0x8019 (32793)
0x8020 (32800)
0x8021 (32801)
0x8FFF (36863)
0x0000 (0)97Feature description

EventAcquisitionStart
Display name

EventAcquisitionStart

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R/C

Affected features

EventAcquisitionStartTimestamp
EventAcquisitionStartFrameID

Category/EventControl/EventID

ValuesDescription

40,000(GigE Vision models only) ID value of event.

0x8000 (32768)(Camera Link models only) ID value of event.

EventAcquisitionEnd
Display name

EventAcquisitionEnd

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R/C

Affected features

EventAcquisitionEndTimestamp
EventAcquisitionEndFrameID

Category/EventControl/EventID

ValuesDescription

40,001(GigE Vision models only) ID value of event.

0x8001 (32769)(Camera Link models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

98

Feature description

EventFrameTrigger
Display name

EventFrameTrigger

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

Access

R/C

Affected features

EventFrameTriggerTimestamp
EventFrameTriggerFrameID

Category/EventControl/EventID

ValuesDescription

40,002(GigE Vision models only) ID value of event.

EventExposureEnd
Display name

EventExposureEnd

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

Access

R/C

Affected features

EventExposureEndTimestamp
EventExposureEndFrameID

Category/EventControl/EventID

ValuesDescription

40,003(GigE Vision models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

99

Feature description

EventAcquisitionRecordTrigger
Display name

EventAcquisitionRecordTrigger

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

Access

R/C

Affected features

EventAcquisitionRecordTriggerTimestamp
EventAcquisitionRecordTriggerFrameID

Category/EventControl/EventID

ValuesDescription

40,004(GigE Vision models only) ID value of event.

EventCC1RisingEdge
Display name

EventCC1RisingEdge

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

0x8012 (32786)(Camera Link models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

100Feature description

EventCC1FallingEdge
Display name

EventCC1FallingEdge

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

0x8013 (32787)(Camera Link models only) ID value of event.

EventCC2RisingEdge
Display name

EventCC2RisingEdge

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

0x8014 (32788)(Camera Link models only) ID value of event.

EventCC2FallingEdge
Display name

EventCC2FallingEdge

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

0x8015 (32789)(Camera Link models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

101

Feature description

EventCC3RisingEdge
Display name

EventCC3RisingEdge

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

0x8016 (32790)(Camera Link models only) ID value of event.

EventCC3FallingEdge
Display name

EventCC3FallingEdge

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

0x8017 (32791)(Camera Link models only) ID value of event.

EventCC4RisingEdge
Display name

EventCC4RisingEdge

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

0x8019 (32792)(Camera Link models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

102

Feature description

EventCC4FallingEdge
Display name

EventCC4FallingEdge

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

0x8018 (32793)(Camera Link models only) ID value of event.

EventLine1RisingEdge
Display name

EventLine1RisingEdge

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R/C

Affected features

EventLine1RisingEdgeTimestamp
EventLine1RisingEdgeFrameID

Category/EventControl/EventID

ValuesDescription

40,010(GigE Vision models only) ID value of event.

0x800A (32778)(Camera Link models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

103

Feature description

EventLine1FallingEdge
Display name

EventLine1FallingEdge

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R/C

Affected features

EventLine1FallingEdgeTimestamp
EventLine1FallingEdgeFrameID

Category/EventControl/EventID

ValuesDescription

40,011(GigE Vision models only) ID value of event.

0x800B (32779)(Camera Link models only) ID value of event.

EventLine2RisingEdge
Display name

EventLine2RisingEdge

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R/C

Affected features

EventLine2RisingEdgeTimestamp,
EventLine2RisingEdgeFrameID

Category/EventControl/EventID

ValuesDescription

40,012(GigE Vision models only) ID value of event.

0x800C (32780)(Camera Link models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

104Feature description

EventLine2FallingEdge
Display name

EventLine2FallingEdge

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Affected features

EventLine2FallingEdgeTimestamp
EventLine2FallingEdgeFrameID

Category/EventControl/EventID

ValuesDescription

40,013(GigE Vision models only) ID value of event.

0x800D (32781)(Camera Link models only) ID value of event.

EventFrameTriggerReady
Display name

EventFrameTriggerReady

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

Access

R/C

Affected features

EventFrameTriggerReadyTimestamp
EventFrameTriggerReadyFrameID

Category/EventControl/EventID

ValuesDescription

40,016(GigE Vision models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

105

Feature description

EventSensorTemperatureSetpoint
Display name

EventSensorTemperatureControlState

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

40,027(GigE Vision models only) ID value of event.

0x8020 (32800)(Camera Link models only) ID value of event.

EventSensorTemperatureControlState
Display name

EventSensorTemperatureControlState

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R/C

Affected features(None)

Category/EventControl/EventID

ValuesDescription

40,028(GigE Vision models only) ID value of event.

0x8021 (32801)(Camera Link models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

106

Feature description

EventOverflow
The overflow event occurs if one or more notification events are lost on thecamera. If you use the message channel for event notification, you are always
subscribed to this event.
Display name

EventOverflow

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R/C

Affected features

EventOverflowTimestamp
EventOverflowFrameID

Category/EventControl/EventID

ValuesDescription

65,534(GigE Vision models only) ID value of event.

0x8FFF (36863)(Camera Link models only) ID value of event.

EventError
The error event occurs if there is a problem on the camera; this event should bereported to technical support. If you use the message channel for event
notification, you are always subscribed to this event.
Display name

EventError

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R/C

Affected features

EventErrorTimestamp
EventErrorFrameID

Category/EventControl/EventID

ValuesDescription

65,535(GigE Vision models only) ID value of event.

0x0000 (0)(Camera Link models only) ID value of event.

Goldeye G/CL Features Reference V1.7.2

107

Feature description

EventControl (continued)
The feature descriptions for the EventID subcategory have ended on the previous
page. The following features continue the EventControl category, without asubcategory.

EventNotification[EventSelector]
Control event notification on the GigE Vision message channel.
Display name

EventNotification

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Enumeration

AccessR/W

Affected features

EventsEnable1

Category/EventControl

ValuesDescription

Off

Disables event notification (default).

On

Activates event notification.

Goldeye G/CL Features Reference V1.7.2

108

Feature description

EventSelector
Selects a specific event to be enabled or disabled using EventNotification.
Display name

EventSelector

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Enumeration

AccessR/W

Affected features

EventNotification
EventsEnable1

Category/EventControl

ValuesDescription

AcquisitionStart

GigE Vision and Camera Link
(default)

AcquisitionEnd

GigE Vision and Camera Link

FrameTrigger

GigE Vision models only

ExposureEnd

GigE Vision models only

AcquisitionRecordTrigger

GigE Vision models only

Line1RisingEdge

GigE Vision and Camera Link

Line1FallingEdge

GigE Vision and Camera Link

Line2RisingEdge

GigE Vision and Camera Link

Line2FallingEdge

GigE Vision and Camera Link

EventCC1RisingEdge

Camera Link models only

EventCC1FallingEdge

Camera Link models only

EventCC2RisingEdge

Camera Link models only

EventCC2FallingEdge

Camera Link models only

EventCC3RisingEdge

Camera Link models only

EventCC3FallingEdge

Camera Link models only

EventCC4RisingEdge

Camera Link models only

EventCC4FallingEdge

Camera Link models only

EventSensorTemperatureSetpoint

Camera Link models only

EventSensorTemperatureControlState

Camera Link models only

FrameTriggerReady

GigE Vision models only

Goldeye G/CL Features Reference V1.7.2

109

Feature description

EventsEnable1[EventSelector]
Bit field of all events.
This is an alternative of setting each event individually using the
EventNotification and EventSelector method.
Display name

EventsEnable1

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

AccessR/W

Affected features

EventNotification

Category/EventControl

GigE Event ID

Bit Pos.

Description

40000

0

EventAcquisitionStart

40001

1

EventAcquisitionStop

40002

2

EventFrameTrigger

40003

3

EventExposeEnd

40004

4

EventRecorderTrigger

40010

10

EventLineIn1RisingEdge

40011

11

EventLineIn1FallingEdge

40012

12

EventLineIn2RisingEdge

40013

13

EventLineIn2FallingEdge

40018

18

EventFrameTrigReady

40027

27

EventSensorTemperatureSetpoint

40028

28

EventSensorTemperatureControlState

CL Event ID

Bit Pos.

Description

0x8000 (32768)

0

EventAcquisitionStart

0x8001 (32769)

1

EventAcquisitionStop

0x800A (32778)

10

EventLineIn1RisingEdge

0x800B (32779)

11

EventLineIn1FallingEdge

0x800C (32780)

12

EventLineIn2RisingEdge

0x800D (32781)

13

EventLineIn2FallingEdge

0x8012 (32786)

18

EventCC1RisingEdge

0x8013 (32787)

19

EventCC1FallingEdge

Table 3: EventsEnable1 CL event descriptions (sheet 1 of 2)Goldeye G/CL Features Reference V1.7.2

110Feature description

CL Event ID

Bit Pos.

Description

0x8014 (32788)

20

EventCC2RisingEdge

0x8015 (32789)

21

EventCC2FallingEdge

0x8016 (32790)

22

EventCC3RisingEdge

0x8017 (32791)

23

EventCC3FallingEdge

0x8018 (32792)

24

EventCC4RisingEdge

0x8019 (32793)

25

EventCC4FallingEdge

0x8027 (32807)

27

EventSensorTemperatureSetpoint

0x8028 (32808)

28

EventSensorTemperatureControlState

Table 3: EventsEnable1 CL event descriptions (sheet 2 of 2)Goldeye G/CL Features Reference V1.7.2

111

Feature description

FileAccessControl
Contains the features related to generic file access of a device.
Display name

FileAccessControl

Origin of feature

CameraFeature type

(Category)

FileAccessBuffer
Defines the intermediate access buffer that allows the exchange of data between
the camera file storage and the application.
Display name

FileAccessBuffer

Origin of feature

CameraFeature type

RegisterAccessR/W

Affected features(None)

Category/FileAccessControl

FileAccessLength
Controls the length of mapping between the camera file storage and theFileAccessBuffer.
Display name

FileAccessLength

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Bytes

Affected features(None)

Category/FileAccessControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

112

Feature description

FileAccessOffset
Controls the offset of mapping between the camera file storage and theFileAccessBuffer.
Display name

FileAccessOffset

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Bytes

Affected features(None)

Category/FileAccessControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

FileAttribute[FileSelector][FileOperationSelector]
Attribute of the currently selected file.
Display name

FileAttribute

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/FileAccessControl

Bits

Description

Bit 0 to 1

These two bits are used to encode the privilege level for afile. It defines the owner of the file:
0 = [Default] User owns the file. User can overwrite anddelete the file
1 = For factory personnel use only
2, 3 = Reserved

Bit 2 to 31

Reserved, always 0Goldeye G/CL Features Reference V1.7.2

113

Feature description

FileAttributeBuffer[FileSelector][FileOperationSelector]
Contains the attribute that will be used for newly created files or if the attribute ofan existing file is changed.
Display name

FileAttributeBuffer

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/FileAccessControl

Bits

Description

Bit 0 to 1

These two bits are used to encode the privilege level for afile. It defines the owner of the file:
0 = [Default] User owns the file. User can overwrite anddelete the file
1 = For factory personnel use only
2, 3 = Reserved

Bit 2 to 31

Reserved, always 0

FileDescription[FileSelector][FileOperationSelector]
Description string for currently selected file. A maximum of 32 characters isallowed, including the trailing null character.
Display name

FileDescription

Origin of feature

CameraFeature type

StringAccessR

Affected features(None)

Category/FileAccessControl

Goldeye G/CL Features Reference V1.7.2

114

Feature description

FileDescriptionBuffer[FileSelector][FileOperationSelector]
Contains the description that will be used for newly created files or if thedescription of an existing file is changed. A maximum of 32 characters is allowed,
including the trailing null character.
Display name

FileDescriptionBuffer

Origin of feature

CameraFeature type

StringAccessR/W

Affected features(None)

Category/FileAccessControl

FileOpenAttribute[FileSelector][FileOperationSelector]
Selects the attributes for a file that is opened in the device.
Display name

FileOpenAttribute

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/FileAccessControl

ValuesDescription

Overwrite

If file is open in write mode, content of the file isoverwritten (default).

AppendIf file is open in write mode, new data is appended at theend of the existing content.

Goldeye G/CL Features Reference V1.7.2

115

Feature description

FileOpenMode[FileSelector][FileOperationSelector]
Selects the access mode in which a file is opened in the device.
Display name

FileOpenMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/FileAccessControl

ValuesDescription

Read

Selects read-only open mode (default)

Write

Selects write-only open mode

FileOperationExecute[FileSelector][FileOperationSelector]
Executes the operation selected by FileOperationSelector on the selected file.
Display name

FileOperationExecute

Origin of feature

CameraFeature typeCommandAffected features(None)

Category/FileAccessControl

FileOperationResult[FileSelector][FileOperationSelector]
Represents the result of the file operation. For read or write operations, thenumber of successfully read or written bytes is returned.
Display name

FileOperationResult

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Bytes

Affected features(None)

Category/FileAccessControl

Goldeye G/CL Features Reference V1.7.2

116

Feature description

FileOperationSelector[FileSelector]
Selects the target operation for the selected file in the device. This operation is
executed when the FileOperationExecute feature is called.
Display name

FileOperationSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/FileAccessControl

ValuesDescription

Open

Opens the file selected by FileSelector in the device
with an access mode selected in FileOpenMode (default).

Close

Closes the file selected by FileSelector in the device.

Read

Reads FileAccessLength bytes from the file selected by
FileSelector. The file must have been opened forreading before this operation can be executed. The data isread from the file position defined by FileAccessOffset
and it is stored in the FileAccessBuffer.

Write

Writes FileAccessLength bytes from theFileAccessBuffer to the file selected by FileSelector.
The file must have been opened for writing before thisoperation can be executed. The data is written to the fileposition defined by FileAccessOffset.

DeleteDeletes the file selected by FileSelector in the device.
Note: Deleting a device file does not remove theassociated FileSelector entry to allow future operationon this file.

WriteType

Changes the type of the file selected by FileSelector to
the type defined by FileTypeBuffer.

WriteAttribute

Changes the attribute of the file selected by
FileSelector to the attribute defined by
FileAttributeBuffer.

WriteDescription

Goldeye G/CL Features Reference V1.7.2

Changes the description of the file selected by
FileSelector to the type defined by
FileDescriptionBuffer.

117

Feature description

FileOperationStatus[FileSelector][FileOperationSelector]
Returns the status of file operation execution.
Display name

FileOperationStatus

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features(None)

Category/FileAccessControl

ValuesDescription

Success

File operation successful (default)

FailureFile operation failed

Goldeye G/CL Features Reference V1.7.2

118

Feature description

FileSelector
Selects the target file in the device. The entries of this enumeration define thenames of all files in the device that can be accessed via the file access. For
example:• UserData: first user data set.
• UserData2: second user data set.
Display name

FileSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/FileAccessControl

ValuesDescription

FirmwareInstalled firmware (default).

UserData to
UserData4

Four user data sets.

DPC_000

One data set for defect pixel correction.

NUC_000 to
NUC_055

56 data sets for non-uniformity correction.

NUC_User_000 to
NUC_User_007

Eight data sets for non-uniformity correction, for uploadby the user.

LUT_000 to
LUT_003

Four look-up table data sets.

LUT_User_000 to
LUT_User_003

Four look-up table data sets, for upload by the user.

FileSize[FileSelector]
Represents the size of the selected file in bytes.
Display name

FileSize

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/FileAccessControl

Goldeye G/CL Features Reference V1.7.2

119Feature description

FileStatus[FileSelector]
Represents the status of the file.
Display name

FileStatus

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features(None)

Category/FileAccessControl

ValuesDescription

ClosedFile is currently closed (default).

Open

File is currently open.

FileType[FileSelector]
Represents the type of the file currently selected by the user.
Display name

FileType

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/FileAccessControl

Goldeye G/CL Features Reference V1.7.2

120

Feature description

FileTypeBuffer[FileSelector]
Contains the type that will be used for newly created files or if the type of an
existing file is to be changed.
Display name

FileTypeBuffer

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/FileAccessControl

ValuesDescription

0x1000Non-uniformity correction data

0x2000

Defect pixel correction data

Goldeye G/CL Features Reference V1.7.2

121

Feature description

GigE
This category describes the GigE Vision specific transport layer features.
Display name

GigE

Origin of feature

CameraFeature type

(Category)Configuration
Category for GigE configuration.
Display name

Configuration

Origin of feature

CameraFeature type

(Category)Category/GigE

GevIPConfigurationMode
Current IP configuration mode.
Display name

IPConfigurationMode

Origin of feature

Transport layer

Feature type

Enumeration

AccessR/W

Affected features(None)

Category/GigE/Configuration

ValuesDescription

LLA

Link Local Address IP configuration mode (default).

DHCP

DHCP IP configuration mode.

Persistent

Persistent IP configuration mode.

Goldeye G/CL Features Reference V1.7.2

122

Feature description

Current
Category for current GigE settings.
Display nameCurrent

Origin of feature

CameraFeature type

(Category)Category/GigE

GevCurrentDefaultGateway
IP address of the default gateway of the device.
Display nameCurrentDefaultGateway

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/GigE/Current

GevCurrentIPAddress
Current IP address of the device.
Display nameCurrentIPAddress

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/GigE/Current

GevCurrentSubnetMask
Current subnet mask of the device.
Display nameCurrentSubnetMask

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/GigE/Current

Goldeye G/CL Features Reference V1.7.2

123Feature description

GVCP
Allied Vision GigE SWIR cameras have a sophisticated real time resend mechanismthat ensures a high degree of data integrity.
The category GVCP (GigE Vision Control Protocol) holds the features related tothat.
Display name

GVCP

Origin of feature

CameraFeature type

(Category)Category/GigE

GVCPCmdRetries
Controls the maximum number of resend requests that the host will attempt whentrying to recover a lost packet.
Display nameCommandRetries

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features(None)

Category/GigE/GVCP

ValuesDescription

1

Minimum

5

Default

9

Maximum

Goldeye G/CL Features Reference V1.7.2

124

Feature description

GVCPCmdTimeout
Timeout waiting for an answer from the device.
Display nameCommandTimeout

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Unit

Milliseconds

Affected features(None)

Category/GigE/GVCP

ValuesDescription

100

Minimum

250

Default

1,000

Maximum

GevHeartbeatInterval
The driver sends heartbeat packets to the camera every GevHeartbeatInterval
milliseconds. If the camera fails to respond to the heartbeat request, a retry is sent
GVCPCmdTimeout milliseconds later. After GVCPCmdRetries retries with noresponse, a camera unplugged event is returned by the driver.
This parameter can be increased significantly to bypass problems when debugging
applications.

Display nameHeartbeatInterval

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Unit

Milliseconds

Affected features(None)

Vimba

V1.3 or later

Category/GigE/GVCP

ValuesDescription

200

Minimum

1,450

Maximum (default)

Goldeye G/CL Features Reference V1.7.2

125

Feature description

GevSCPSPacketSize
This parameter determines the Ethernet packet size. Generally, this number should
be set to as large as the network card (or other involved active networking
components) will allow. If this number is reduced, then CPU loading will increase.
These large packet sizes (>1500) are called jumbo packets or jumbo frames in
Ethernet terminology.
If your Gigabit Ethernet network card does not support jumbo packets or frames ofat least 8228 bytes (the camera default on power up), then you will need to reduce
GevSCPSPacketSize parameter of the camera to match the maximum jumbopacket size supported by your Gigabit Ethernet interface.
A GevSCPSPacketSize of 1500 is a safe setting which all GigE Ethernet network
cards support.
If you are seeing all black images, or all frames reported as StatFrameDropped andzero images reported as StatFrameDelivered, you will likely need to decrease thisparameter.
Display name

GevSCPSPacketSize

Origin of feature

Transport layer

Feature type

Integer

Access

R/W

Unit

Bytes

Affected features(None)

Category/GigE/GVCP

ValuesDescription

500

Minimum

1,500

Default

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

126

Feature description

PersistentThis category holds the features that have persistent (non-changing) values.
Display name

Persistent

Origin of feature

CameraFeature type

(Category)Category/GigE

GevPersistentDefaultGateway
Persistent default gateway of the device.
Display name

PersistentDefaultGateway

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/GigE/Persistent

GevPersistentIPAddress
Persistent IP address of the device.
Display name

PersistentIPAddress

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/GigE/Persistent

GevPersistentSubnetMask
Persistent subnet mask of the device.
Display name

PersistentSubnetMask

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/GigE/PersistentGoldeye G/CL Features Reference V1.7.2

127

Feature description

ImageCorrectionControl
Image corrections for SWIR sensors.
The corrections applied to the image are of special relevance within the Goldeye
camera. They are applied by the following modules.
• Background correction (BC)• Non-uniformity correction (NUC)• Defect pixel correction (DPC)
The corrections need special correction data that must be provided prior tooperating the image processing chain.
Display nameImageCorrectionControl

Origin of feature

CameraFeature type

(Category)

BackgroundCorrection (subcategory)This subcategory handles all features necessary to apply the backgroundcorrection (BC). Refer to the Goldeye G/CL Technical Manual for a description of
how the background correction is applied.
Display name

BackgroundCorrection

Origin of feature

CameraFeature type

(Subcategory)Category/ImageCorrectionControl

BCDatasetMeanValue
Provides mean value of the correction image.
Copy the value to BCDatasetOffsetValue to get the same brightness level behind
the active background correction as the uncorrected image has.
Display name

BCDatasetMeanValue

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

Goldeye G/CL Features Reference V1.7.2

128

Feature description

BCDatasetOffsetValue
Specifies the output offset of the corrected image.
The scale is always based on the maximum pixel depth the camera supports,
independent of the active output pixel format.
Display name

BCDatasetOffsetValue

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

ValuesDescription-32,768

Minimum

0Default

32,768Maximum

BCDatasetROIHeight
Provides the height of the integrated correction image. The background correction
stays active as long as the current active image region fully fits into the ROI of thecorrection image.
See BCState feature for current state of the background correction processing.
Display name

BCDatasetROIHeight

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

ValuesDescription(Height)

Minimum(Sensor height)

Maximum (default)

Goldeye G/CL Features Reference V1.7.2

129Feature description

BCDatasetROIOffsetX
Provides the horizontal offset of the integrated correction image. The backgroundcorrection stays active as long as the current active image region fully fits into the
ROI of the correction image.
See BCState feature for current state of the background correction processing.
Display name

BCDatasetROIOffsetX

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

ValuesDescription0

Minimum (default, same as OffsetX feature)

Camera dependent

Maximum (Same as OffsetX feature)

BCDatasetROIOffsetY
Provides the vertical offset of the integrated correction image. The backgroundcorrection stays active as long as the current active image region fully fits into the
ROI of the correction image.
See BCState feature for current state of the background correction processing.
Display name

BCDatasetROIOffsetY

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

ValuesDescription0

Minimum (default, same as OffsetY feature)

Camera dependent

Maximum (Same as OffsetY feature)

Goldeye G/CL Features Reference V1.7.2

130Feature description

BCDatasetROIWidth
Provides the width of the integrated correction image. The background correction
stays active as long as the current active image region fully fits into the ROI of thecorrection image.
See BCState feature for current state of the background correction processing.
Display name

BCDatasetROIWidth

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

ValuesDescription

Camera dependent

Minimum (Same as Width feature)(Sensor width)

Default

Camera dependent

Maximum (Same as Width feature)

BCIntegrationAbort
Aborts a running integration as soon as possible. The correction buffer will be
invalid if lesser number of frames have been integrated than requested.
Display name

BCIntegrationAbort

Origin of feature

CameraFeature typeCommandAccess(R)/W

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

Goldeye G/CL Features Reference V1.7.2

131

Feature description

BCIntegrationFrameCount
Number of frames to integrate after BCIntegrationStart command. Integrating
more images improves the correction quality because influence of dynamic noiseon the correction image is reduced.
BCIntegrationFrameCount is always rounded off to the next power of two.
Display name

BCIntegrationFrameCount

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

ValuesDescription

1

Correction image consists of one frame only.

2

Two frames will be integrated for correction image.

4

Four frames will be integrated for correction image(default).

BCIntegrationModeControls how a background correction image will be acquired upon
BCIntegrationStart command.
Use BCIntegrationStart to start the FrameBuffer writing, set
BCIntegrationMode = Integrate to stop it.
Display name

BCIntegrationMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

ValuesDescription

Integrate

After submission of BCIntegrationStart a correction
image will be acquired that is the mean of
BCIntegrationFrameCount images.

FrameBufferStore every frame to the correction memory and use thepreviously stored image for correction. If BCMode = On, thiscan be used to get a dynamic frame-to-frame difference ofthe live image.

Note: Default values are model dependent.

Goldeye G/CL Features Reference V1.7.2

132

Feature description

BCIntegrationStart
Starts the integration of BCIntegrationFrameCount frames, depending on
BCIntegrationMode. This command does not control the triggering of images forthe integration, it only enables the integration process.
Use BCIntegrationStart to start the FrameBuffer writing, set
BCIntegrationMode = Integrate to stop it.
Background correction will wait after BCIntegrationStart, until
BCIntegrationFrameCount frames have been produced by the camera. Frame
triggering is not in the background correction domain. This is controlled byfeatures such as ExposureTime, AcquisitionStart, AcquisitionStop,
TriggerSource, TriggerSelector, or AcquisitionFrameRate.
If the camera does not output images for some reason, background correction
integration will stall until AcquisitionStart is executed and frame triggering isallowed by the trigger setup.
For optimal correction results:
1. Configure the settings you intend to use for your application.
2. Integrate a fresh background correction image without light (dark image) using
these settings.
3. Finally, apply the background correction.
Display name

BCIntegrationStart

Origin of feature

CameraFeature typeCommandAccess(R)/W

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

Goldeye G/CL Features Reference V1.7.2

133

Feature description

BCModeControls the operating mode of the background correction. Different modes may
be available, depending on the previously integrated corrected data.
Display name

BCModeOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

ValuesDescription

Off

Background correction is off (default).

On

If the current correction image is valid (see BCState), it issubtracted from the live image and the
BCDatasetOffsetValue is added.

OffsetOnly

BCDatasetOffsetValue is added to the live image.

ReferenceImage

If the current correction image id valid (see BCState), it isoutput instead of the live image.

BCStateShows the current state of the background correction processing. If the state is Ok,
then the BC is operating normally as configured with BCMode, otherwise the ROI
settings might be out of range, a new integration might be needed or is still inprogress.
Display name

BCStateOrigin of feature

CameraFeature type

Enumeration

AccessR

Affected features(None)

Category/ImageCorrectionControl/BackgroundCorrection

ValuesDescription

Ok

Background correction is operating normally as configured
with BCMode.

DatasetInvalid

A new integration might be needed or is still in progress.

ROIOutOfBounds

ROI settings might be out of the valid range of theintegrated correction image.

Goldeye G/CL Features Reference V1.7.2

134

Feature description

DefectPixelCorrection (subcategory)This subcategory handles all features necessary to apply the defect pixel correction(DPC). Refer to the Goldeye G/CL Technical Manual for a description of how thedefect pixel correction is applied.
Notes• Decimation and features to control NUC or DPC are mutually exclusive. Usingdecimation disables NUC and DPC, and vice versa.
• Multiple regions and features to control NUC or DPC are mutually exclusive.
Using multiple regions disables NUC and DPC, and vice versa.
Display nameAutoModeParameters

Origin of feature

CameraFeature type

(Subcategory)Category/ImageCorrectionControl

DPCDatasetActivate[DPCDatasetSelector]
Activates the data set that is currently indexed by DPCDatasetSelector.
Display name

DPCDatasetActivate

Origin of feature

CameraFeature typeCommandAccessR/W

Affected features(None)

Category/ImageCorrectionControl/DefectPixelCorrection

Goldeye G/CL Features Reference V1.7.2

135

Feature description

DPCDatasetActive[DPCDatasetSelector]
The index of the active data set, starting at 0. The maximum possible value of
DPCDatasetActive depends on the number of valid data sets in the camera. The
mapping of an index value to a specific correction data file may vary from camera
to camera or after correction data modifications.
Use the DPCDatasetSelector and corresponding features to retrieve more
information about the data sets.
Display name

DPCDatasetActive

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/ImageCorrectionControl/DefectPixelCorrection

ValuesDescription0

Minimum

Camera dependent

Maximum

DPCDatasetActiveDescription[DPCDatasetSelector]
Gives a short descriptive label to the data set that is currently indexed by
DPCDatasetActive.
Display name

DPCDatasetActiveDescription

Origin of feature

CameraFeature type

StringAccessR

Affected features(None)

Category/ImageCorrectionControl/DefectPixelCorrection

Goldeye G/CL Features Reference V1.7.2

136

Feature description

DPCDatasetDescription[DPCDatasetSelector]
Gives a short descriptive label to the data set that is currently indexed by
DPCDatasetSelector.
Display name

DPCDatasetDescription

Origin of feature

CameraFeature type

StringAccessR

Affected features(None)

Category/ImageCorrectionControl/DefectPixelCorrection

DPCDatasetSelector
Selects a data set for access. The maximum possible value of
DPCDatasetSelector depends on the number of valid data sets in the camera.
The mapping of an index value to a specific correction data file may vary fromcamera to camera or after correction data modifications.
The selector only operates as index to data set information and does not change
any camera setting. Use DPCDatasetActivate to activate the currently indexed
data set.
Display name

DPCDatasetSelector

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/ImageCorrectionControl/DefectPixelCorrection

ValuesDescription0

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

137

Feature description

DPCModeControls the operation mode of the defect pixel correction.
Note: DPCMode is available only for all Goldeye G/CL-008 and G/CL-034 models.
Display name

DPCModeOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/ImageCorrectionControl/DefectPixelCorrection

ValuesDescription

On

Enables defect pixel correction (default).

Off

Disables defect pixel correction.

ShowDefectsOnly

Defect pixels are displayed on a black backgroundimage.

ShowDefectsAndImage Defect pixels are displayed as overlay on the stream.

Goldeye G/CL Features Reference V1.7.2

138

Feature description

NonUniformityCorrection (subcategory)
Every pixel of an InGaAs sensor possesses its individual amount of dark signal andan individual sensitivity for light. Thus, while exposing, each sensor creates a
specific, non-uniform underlying pattern. This pattern can be compensated withhelp of the non-uniformity correction.
This subcategory contains features that allow to control the non-uniformity
correction. Refer to the Goldeye G/CL Technical Manual for a description of how
the non-uniformity correction is applied.
Notes• Decimation and features to control NUC or DPC are mutually exclusive. Usingdecimation disables NUC and DPC, and vice versa.
• Multiple regions and features to control NUC or DPC are mutually exclusive.
Using multiple regions disables NUC and DPC, and vice versa.
Display name

NonUniformityCorrection

Origin of feature

CameraFeature type

(Subcategory)Category/ImageCorrectionControl

NUCDatasetActivate[NUCDatasetSelector]
Activates the data set that is currently indexed by the NUCDatasetSelector.
Display name

NUCDatasetActivate

Origin of feature

CameraFeature typeCommandAccess(R)/W

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

Goldeye G/CL Features Reference V1.7.2

139

Feature description

NUCDatasetActive[NUCDatasetSelector]
The index of the active data set, starting at 0. The maximum possible value
depends on the number of valid data sets in the camera. The mapping of an index
value to a specific correction data file may vary from camera to camera or after
correction data modifications. Use the NUCDatasetSelector and corresponding
features to retrieve more information about the data sets.
If NUCDatasetAuto is set to Off, the data set currently applied can be changed bywriting a data set index to NUCDatasetSelector and executing the
NUCDatasetActivate command.
If NUCDatasetAuto is set to Once or Continuous, the index may change as a resultof the automatic data set selection.
Display name

NUCDatasetActive

Origin of feature

CameraFeature type

Integer

AccessR/(W)Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

ValuesDescription0

Minimum(Number of valid data sets)

Maximum

NUCDatasetActiveDescription[NUCDatasetSelector]
Gives a short descriptive label to the data set that is currently indexed by
NUCDatasetActive. For example: Gain 0, 15.000 °C, 1000 µs.
This text is intended for informational purposes in the user interface display only!
For the actual values refer to NUCDatasetActiveExposureTime,
NUCDatasetActiveGain, and NUCDatasetActiveTemperature
Display name

NUCDatasetActiveDescription

Origin of feature

CameraFeature type

StringAccessR

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

Goldeye G/CL Features Reference V1.7.2

140

Feature description

NUCDatasetActiveExposureTime[NUCDatasetSelector]
Shows exposure time at acquisition of the data set that is currently indexed by
NUCDatasetActive. The data set should be selected so that the actual exposure
time setting corresponds to the reference value.
The number of distinct reference values is limited by available correction data,
depending on the camera model.

Display name

NUCDatasetActiveExposureTime

Origin of feature

CameraFeature type

Float

AccessR

Unit

Microseconds

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

NUCDatasetActiveGain[NUCDatasetSelector]
Sensor gain setting at acquisition of the data set that is currently indexed by
NUCDatasetActive. The data set should be selected so that the actual sensor gain
setting corresponds to the reference value.
Depending on the camera model, different values may occur.
The number of distinct reference values is limited by available correction data,
depending on the camera model.

Display name

NUCDatasetActiveGain

Origin of feature

CameraFeature type

Float

AccessR

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

ValuesDescription

0

SensorGain = Gain01

SensorGain = Gain1

2

SensorGain = Gain2

Goldeye G/CL Features Reference V1.7.2

141

Feature description

NUCDatasetActiveTemperature[NUCDatasetSelector]
Shows sensor temperature, at acquisition of the data set that is currently indexed
by NUCDatasetActive. The data set should be selected so that the actual sensor
temperature is close to the reference temperature.
The number of distinct reference values is limited by available correction data,
depending on the camera model.

Display name

NUCDatasetActiveTemperature

Origin of feature

CameraFeature type

Float

AccessR

Unit

Degree Celsius (°C)

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

ValuesDescription-100

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

142

Feature description

NUCDatasetAuto
Controls the automatic data set selection of the non-uniformity correction.
Automatic data set selection does not work if the exposure time is controlled by an
external signal applied to a camera input.
Display name

NUCDatasetAuto

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

ValuesDescription

Off

The automatic mode is off (default).

Once

Activates the selection only for the next image output,
then falls back to Off.

Continuous

The camera will select the best correction data set forevery frame, according to current analog gain setting,sensor temperature and exposure time.
Note in Continuous mode the data set may toggle too
frequently. If this happens, try executing the Once setting
occasionally.
This toggle effect can be caused by external trigger signal,or an inappropriate temperature setpoint of the sensor.

NUCDatasetDescription[NUCDatasetNodeSelector]
Gives a short descriptive label to the data set that is currently indexed by the
NUCDatasetSelector.
Display name

NUCDatasetDescription

Origin of feature

CameraFeature type

StringAccessR

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

Goldeye G/CL Features Reference V1.7.2

143

Feature description

NUCDatasetExposureTime[NUCDatasetNodeSelector]
Shows the exposure time at acquisition of the data set indexed by
NUCDatasetSelector. The data set should be selected so that the actual exposure
time setting corresponds to the reference value. Depending on camera model
different values may occur.
Display name

NUCDatasetExposureTime

Origin of feature

CameraFeature type

Float

AccessR

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

NUCDatasetGain[NUCDatasetNodeSelector]
SensorGain setting at acquisition of the data set indexed by
NUCDatasetSelector. The data set should be selected so that the actual sensor
gain setting corresponds to the reference value.
The number of distinct reference values is limited by available correction data,
depending on the camera model.

Display name

NUCDatasetGain

Origin of feature

CameraFeature type

Float

AccessR

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

ValuesDescription

0

SensorGain = Gain0 (default)

1

SensorGain = Gain1

2

SensorGain = Gain2

Goldeye G/CL Features Reference V1.7.2

144

Feature description

NUCDatasetNodeSelector
Selects a data point of a data set for access to its properties, starting at 0. The
maximum possible value depends on the number of valid data points in the dataset.
The selector only operates as index to node information in the data set indexed by
NUCDatasetSelector. It does not change any camera setting.
Display name

NUCDatasetNodeSelector

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

ValuesDescription0

Minimum(Number of valid
data points)

Maximum

NUCDatasetNodeValue[NUCDatasetNodeSelecto]
The set value of the selected data point that is currently indexed by the
NUCDatasetSelector and the NUCDatasetNodeSelector.
Setpoint defines a mean value which the corrected image will have if the input
image has a mean value of the corresponding correction data image.
Display name

NUCDatasetNodeValue

Origin of feature

CameraFeature type

Float

AccessR

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

Goldeye G/CL Features Reference V1.7.2

145

Feature description

NUCDatasetSelector
Selects a data set for access to its properties and activation. The maximum possible
value depends on the number of valid data sets in the camera.
The selector only operates as index to data set information and does not change
any camera setting. Use NUCDatasetActivate to activate the currently indexed
data set.
The mapping of an index value to a specific correction data file may vary fromcamera to camera or after correction data modifications.
Display name

NUCDatasetSelector

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

ValuesDescription0

Minimum(Number of valid data sets)

Maximum

NUCDatasetTemperature[NUCDatasetSelector]
Sensor temperature at acquisition of the data set indexed by
NUCDatasetSelector. The data set should be selected so that the actual sensor
temperature is close to the reference temperature.
The number of distinct reference values is limited by available correction data,
depending on the camera model.

Display name

NUCDatasetTemperature

Origin of feature

CameraFeature type

Float

AccessR

Unit

Degree Celsius (°C)

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

Goldeye G/CL Features Reference V1.7.2

146

Feature description

NUCModeControls the operating mode of the non-uniformity correction. Depending on thefactory-provided correction data, different modes may be available.
Display name

NUCModeOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/ImageCorrectionControl/NonUniformityCorrection

ValuesDescription

Off

Non-uniformity correction is off

OnePoint

Only one reference point is used for correction

TwoPoint

Two reference points are used for correction (default)

ThreePoint

Three reference points are used for correction

Goldeye G/CL Features Reference V1.7.2

147

Feature description

ImageFormatControl
This category describes how to influence and determine the image size andresolution. It assumes that the device generates a single rectangular image andallows for only one ROI (ROI). The necessary additional information on theseproperties is provided as well.
Binning is the summing of charge or gray value of adjacent pixels on the sensor. This
generates a lower resolution image, but also causes an increase of the camera
sensitivity, which will grow proportionally to the number of binned pixels.
Display nameImageFormatControl

Origin of feature

CameraFeature type

(Category)

BinningHorizontal
The horizontal binning factor.
Changing this value may affect the effective ROI size and position.
Horizontal and vertical binning can be adjusted separately.
Note: BinningHorizontal and DecimationHorizontal are mutually exclusive:• If you enable BinningHorizontal, DecimationHorizontal is disabled.
• After enabling BinningHorizontal, you must not change Width or OffsetX.
See Image data flow and features order on page 19.
Display nameBinningHorizontal

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

PayloadSize, WidthMax, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize, Width, BCState, OffsetX,
Height, OffsetY

Category/ImageFormatControl

ValuesDescription

1

No horizontal binning (default).

2

Horizontal binning of two pixels.

4

Horizontal binning of four pixels.

8

Horizontal binning of eight pixels.

Goldeye G/CL Features Reference V1.7.2

148

Feature description

BinningHorizontalMode
Determines whether the result of binned pixels is summed up.

Changing BinningHorizontalMode also changes BinningVerticalMode.
Display nameBinningHorizontalMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/ImageFormatControl

ValuesDescription

Average

Binning is accomplished by averaging the charge or grayvalue of adjacent pixels on the sensor. This increases SNR
by SQRT (number of binned pixels).

Sum

Binning is accomplished by summing the charge, meaning
the gray value, of adjacent pixels on the sensor (default).

Goldeye G/CL Features Reference V1.7.2

149

Feature description

BinningVertical
The vertical binning factor.
Changing this value may affect the effective vertical ROI size and position.
The values for horizontal and vertical binning can be adjusted separately.
Note: BinningVertival and DecimationVertical are mutually exclusive:• If you enable BinningVertical, DecimationVertical is disabled.
• After enabling BinningVertical, you must not change Hight or OffsetY.
See Image data flow and features order on page 19.
Display nameBinningVertical

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

PayloadSize, HeightMax, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize, Height, BCState, OffsetY

Category/ImageFormatControl

ValuesDescription

1

No vertical binning (default)

2

Vertical binning of two pixels

4

Vertical binning of four pixels

8

Vertical binning of eight pixels

Goldeye G/CL Features Reference V1.7.2

150

Feature description

BinningVerticalMode
Determines whether the result of binned pixels is summed up.
Changing BinningVerticalMode also changes BinningHorizontalMode.
Display nameBinningVerticalMode

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/ImageFormatControl

ValuesDescription

Average

Binning is accomplished by averaging the charge or grayvalue of adjacent pixels on the sensor. This increases SNR
by SQRT (number of binned pixels).

Sum

Binning is accomplished by summing the charge, meaning
the gray value, of adjacent pixels on sensor (default).

Goldeye G/CL Features Reference V1.7.2

151

Feature description

DecimationHorizontal
Decimation (or sub-sampling) is the process of skipping neighboring pixels during
sensor readout. Decimation is used primarily to reduce the number of pixels andthus the amount of data while retaining the original image area angle and image
brightness.
DecimationHorizontal controls the horizontal sub-sampling of the image.

Note: DecimationHorizontal and BinningHorizontal are mutually exclusive:• If you enable DecimationHorizontal, BinningHorizontal is disabled.
• After enabling DecimationHorizontal, you must not change Width orOffsetX.
• Decimation and features to control NUC or DPC are mutually exclusive. Usingdecimation disables NUC and DPC, and vice versa.
See Image data flow and features order on page 19.
Display name

DecimationHorizontal

Origin of feature

CameraAvailability

G/CL-030 TEC1 and G/CL-130 TEC1

Feature type

Integer

AccessR/W

Affected features

PayloadSize, WidthMax, ImageSize,
AcquisitionFrameRateLimit,
AcquisitionFrameRate, ExposureTime,StreamHoldCapacity, NonImagePayloadSize,
Width, BCState, OffsetXCategory/ImageFormatControl

ValuesDescription

1

Off

2

2 times reduction factor

Goldeye G/CL Features Reference V1.7.2

152

Feature description

DecimationVertical
Decimation (or sub-sampling) is the process of skipping neighboring pixels during
sensor readout. Decimation is used primarily to reduce the number of pixels andthus the amount of data while retaining the original image area angle and image
brightness.
DecimationVertical controls the vertical sub-sampling of the image.

Note: DecimationVertical and BinningVertical are mutually exclusive:• If you enable DecimationVertical, BinningVertical is disabled.
• After enabling DecimationVertical, you must not change Height orOffsetY.
• Decimation and features to control NUC or DPC are mutually exclusive. Usingdecimation disables NUC and DPC, and vice versa.
See Image data flow and features order on page 19.
Display name

DecimationVertical

Origin of feature

CameraAvailability

G/CL-030 TEC1 and G/CL-130 TEC1

Feature type

Integer

AccessR/W

Affected features

PayloadSize, HeightMax, ImageSize,
AcquisitionFrameRateLimit,
AcquisitionFrameRate, ExposureTime,StreamHoldCapacity, NonImagePayloadSize,
Height, BCState, OffsetY

Category/ImageFormatControl

ValuesDescription

1

Off

2

2 times reduction factor

Goldeye G/CL Features Reference V1.7.2

153

Feature description

HeightHeight of the image.
Display name

HeightOrigin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features

BCState, PayloadSize, OffsetY, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize

Category/ImageFormatControl

ValuesDescription

Camera dependent

Minimum(Sensor height)

Default

Camera dependent

Maximum

HeightMax
Maximum image height for the current image mode.
Vertical binning will change this mode.
Display name

HeightMax

Origin of feature

CameraFeature type

Integer

AccessR

Unit

PixelsAffected features

PayloadSize, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize, Height, BCState, OffsetY

Category/ImageFormatControl

Goldeye G/CL Features Reference V1.7.2

154

Feature description

ImageSize
Size of images, for the current format and size.
Display nameImageSize

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Bytes

Affected features(None)

Category/ImageFormatControl

Goldeye G/CL Features Reference V1.7.2

155

Feature description

MultipleRegions (subcategory)This subcategory holds the features to configure and control the multiple regionsof the camera.
Notes• Multiple regions are available only for all Goldeye G/CL-008 models, on
G/CL-030 TEC1, all G/CL-034 models, and G/CL-130 TEC1.
• Features in the NonUniformityCorrection and DefectPixelCorrection
subcatogries are not supported when MultipleRegionsEnable is set True.
• Enabling NonUniformityCorrection and DefectPixelCorrection features
disables MultipleRegions features and vice versa.

iDisplay nameMultipleRegions

Origin of feature

CameraFeature type

(Subcategory)Category/ImageFormatControl

See the Multiple Regions of Interest for Goldeye G/CL application note atwww.alliedvision.com/en/support/technical-documentation/
goldeye-gcl-documentation for details.

MultipleRegionsEnable
Selects between single region and multiple regions mode. The number ofsubregions to be configured depends on the camera model.
Note: The height and Y-offset for each active subregion can be configured
individually, but the horizontal dimensions are commonly set by Width andOffsetX for all subregions.
Display nameMultipleRegionsEnable

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Height, OffsetY

Category/ImageFormatControl/MultipleRegions

ValuesDescription

False

Single region mode is enabled, subregions mode isdisabled (default). Height and OffsetY can be used as
usual.

True

Subregions mode is enabled. Height and OffsetY
features are locked and are automatically aligned with thevalues set for subregions.

Goldeye G/CL Features Reference V1.7.2

156

Feature description

SubRegionMode[SubRegionSelector]
Enables or disables the selected subregion.
Display name

SubRegionMode

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Height, OffsetY, SubRegionStatus

Category/ImageFormatControl/MultipleRegions

ValuesDescriptionOn

The selected subregion is enabled.

OffThe selected subregion is disabled.

SubRegionHeight[SubRegionSelector]
Height of the selected subregion.
Goldeye G/CL-030 and G/CL-130: If values are entered that are not dividable by 8,
SubRegionHeight is increased automatically to the next higher available value. For
example, if 9 is entered, the value is increased to 16.
All Goldeye G/CL-008 models, G/CL-034 and G/CL-034 XSWIR models: The totalsum of all active SubRegionsHeights must be >= 4.
Display name

SubRegionHeight

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features

Height, SubRegionStatus

Category/ImageFormatControl/MultipleRegions

Values1

Description

8;1

Minimum(Height max)

Maximum, depending on the height of other subregions

8;1

Increment

1 G/CL-030, G/CL-130 ; all G/CL-008 models, G/CL-034, G/CL-034 XSWIRGoldeye G/CL Features Reference V1.7.2

157

Feature description

SubRegionOffsetY[SubRegionSelector]
Y-offset of the selected subregion.
Notes for Goldeye G/CL-030 and G/CL-130: If values are entered that are notdividable by 8, SubRegionOffsetY is increased automatically to the next higher
available value. For example, if 9 is entered, the value is increased to 16.
Display name

SubRegionOffsetY

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features

OffsetY, SubRegionStatus

Category/ImageFormatControl/MultipleRegions

Values1

Description

8;1

Minimum(Height max)

Maximum, depending on the height of other subregions

8;1

Increment

1 G/CL-030, G/CL-130 ; all G/CL-008 models, G/CL-034, G/CL-034 XSWIRSubRegionSelector
Selects the subregion in a range from 0 to n, where 0 is the index of the first
subregion and n is the index of the last one.
Display name

SubRegionSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

SubRegionHeight, SubRegionMode, SubRegionOffsetY,
SubRegionStatus

Category/ImageFormatControl/MultipleRegions

Values1

Description

0;0Minimum

7 ; 31

Maximum

1 G/CL-030, G/CL-130 ; all G/CL-008 models, G/CL-034, G/CL-034 XSWIRGoldeye G/CL Features Reference V1.7.2

158

Feature description

SubRegionStatus[SubRegionSelector]
Displays the status of the selected subregion.
Note: The SubRegionStatus is updated only if MultipleRegionsEnable is Trueand the corresponding SubRegionMode is set to On.
Display name

SubRegionStatus

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features(None)

Category/ImageFormatControl/MultipleRegions

ValuesDescription

Disabled

The selected subregion is disabled.

Valid

The selected subregion is enabled and has a valid
configuration.

OverlapError1

The selected subregion is enabled but has an invalid
configuration.

1

Note: Invalid subregions are excluded automatically from the resulting frame.

Goldeye G/CL Features Reference V1.7.2

159

Feature description

ImageFormatControl (continued)
The feature descriptions for the MultipleRegions subcategory have ended on theprevious page. The following features continue the ImageFormatControl
category, without a subcategory.

OffsetX
Starting column of the readout region (relative to the first column of the sensor) in
pixels.
Display nameOffsetX

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features

BCState, PayloadSize, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize

Category/ImageFormatControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

2

Interval

Goldeye G/CL Features Reference V1.7.2

160

Feature description

OffsetY
Starting row of the readout region (relative to the first row of the sensor) in pixels.
Display nameOffsetY

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features

BCState, PayloadSize, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize

Category/ImageFormatControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

161

Feature description

PixelFormat
There are various pixel data formats that GigE cameras can output. Not all cameras
support every mode (see the Goldeye G/CL Technical Manuals for details).
Display name

PixelFormat

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

PayloadSize, WidthMax, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize, Width, BCState, OffsetX,
HeightMax, Height, OffsetY, BinningHorizontal,
BinningVertical

Category/ImageFormatControl

ValuesDescription

Mono8

Bit depth: 8.
One pixel of image data requires 1 byte. Monochrome.

Mono10

Bit depth: 10.
One pixel of image data requires 2 bytes, LSB aligned.
Monochrome.

Mono10p

Note this value is available only for GigE models.
Bit depth: 10.
One pixel of image data requires 3 bytes, LSB aligned.
Monochrome.

Mono10Packed

Note this value is available only for GigE models.
Bit depth: 10.
2 pixels of image data require 3 bytes. Monochrome.
Doesn’t support odd Widths.

Mono12Bit depth: 12.
One pixel of image data requires 2 bytes, LSB aligned.
Monochrome.

Mono12p

Note this value is available only for GigE models.
Bit depth: 12.
One pixel of image data requires 3 bytes, LSB aligned.
Monochrome.

Mono12Packed

Note this value is available only for GigE models.
Bit depth: 12.
2 pixels of image data require 3 bytes. Monochrome.
Doesn’t support odd Widths.

Mono14Bit depth: 14.
One pixel of image data requires 2 bytes, LSB aligned.
Monochrome.

Goldeye G/CL Features Reference V1.7.2

162

Feature description

SensorBits
Maximum bit depth of the sensor.
Display nameSensorBits

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/ImageFormatControl

ValuesDescription0

Minimum

Camera dependent

Maximum

SensorHeight
The total number of pixel rows on the sensor.
Display nameSensorHeight

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features

SensorOffsetY, Height, BCState, PayloadSize,
OffsetY, ImageSize, AcquisitionFrameRateLimit,
AcquisitionFrameRate, ExposureTime,StreamHoldCapacity, NonImagePayloadSize,
HeightMax, AutoModeRegionOffsetY,
AutoModeRegionHeight

Category/ImageFormatControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

163

Feature description

SensorOffsetXAbsolute starting column of the readout region relative to the first column of thesensor, in pixels.
Display nameSensorOffsetX

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/ImageFormatControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

SensorOffsetY
Absolute starting row of the readout region relative to the first row of the sensor,
in pixels.
Display nameSensorOffsetY

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/ImageFormatControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

164Feature description

SensorType
Type of image sensor.
Display nameSensorType

Origin of feature

CameraFeature type

Enumeration

Access

R/C

Affected features(None)

Category/ImageFormatControl

ValuesDescription

Mono(Default and only possible value.)SensorWidth
The total number of pixel columns on the sensor.
Display nameSensorWidth

Origin of feature

CameraFeature type

Integer

AccessR/C

Unit

PixelsAffected features

SensorOffsetX, WidthMax, PayloadSize, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize, Width, BCState, OffsetX,
Height, OffsetY, AutoModeRegionOffsetX,
AutoModeRegionWidth

Category/ImageFormatControl

ValuesDescription0

Minimum (default)

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

165

Feature description

TestPatternGeneratorSelector
Selects the test pattern generator to control TestPattern.
Note: TestPattern features are available only for Goldeye G/CL-030 TEC1 andGoldeye G/CL-130 TEC1.
Display name

TestPatternGeneratorSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/ImageFormatControl

ValuesDescription

Sensor

The sensor is selected to generate the test image.

Goldeye G/CL Features Reference V1.7.2

166

Feature description

TestPattern[TestPatternGeneratorSelector]
Selects the type of test pattern to be generated by the camera.
Notes• TestPattern features are available only for all Goldeye G/CL-008,
Goldeye G/CL-030 TEC1, all Goldeye G/CL-034, and Goldeye G/CL-130 TEC1.
• TestPattern settings cannot be stored in user sets. After a power cycle,
TestPattern features are disabled by default.
• After activating a test pattern, do not use BlackLevel, Decimation, Gain,
PixelFormat, or ImageCorrection features. Otherwise, the test pattern is
distorted and cannot be used for calibration.
Display name
Origin of feature
Feature type
AccessAffected features
Category
ValuesOff

GreyHorizontalRamp

VerticalGoldeye G/CL Features Reference V1.7.2

TestPattern
CameraEnumeration
R/W(None)/ImageFormatControl
Description
The test pattern generator is disabled (default).
The image is acquired by the sensor.
The test pattern generator is enabled.
The image is filled horizontally with values increasingfrom dark to bright continually. When maximum
brightness is reached, the pattern continues from dark
to bright again.
G/CL-030/130: With Mono12 and Mono12packed as
pixel formats, the maximum value available forbrightness is limited by SensorWidth. With Mono8,
the value is increased by 1 every 4 pixels.
All G/CL-008, all G/CL-034: The start of the pattern iscontrolled by TestPatternSpecificParameter1.
The test pattern generator is enabled.
G/CL-030/130: The image is filled with the sequential
pattern of 1 pixel wide stripes.
• Pattern for Mono12: 0xFFE; 0x555; 0xAAA; 0x001• Pattern for Mono8: 0xFF; 0x55; 0xAA; 0x00
(the sensor is operating in 10-bit mode).
G/CL-008, G/CL-034: The pattern is controlled by
TestPatternSpecificParameter1 that changes thebrightness and increment of the vertical stripes.

167

Feature description

TestPatternSpecificParameter1[TestPatternGeneratorSelector]
Sets the minimum brightness value of the test pattern.
Note: This feature is available only for all Goldeye G/CL-008 and all
Goldeye G/CL-034.
Display name

TestPatternGeneratorSelector

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/ImageFormatControl

ValuesDescription

1

Minimum value, the gray horizontal ramp starts with theminimum brightness value.
For a brighter ramp, select higher values.

Pixel format
dependent

Maximum value

Width
Width of the image.
Display name

Width

Origin of feature

CameraFeature type

Integer

AccessR

Unit

PixelsAffected features

BCState, PayloadSize, OffsetX, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize

Category/ImageFormatControl

ValuesDescription

8

Minimum(Sensor width)

Maximum (default)

Goldeye G/CL Features Reference V1.7.2

168Feature description

WidthMax
Maximum image width for the current image mode. Horizontal binning, forexample, will change this value.
Display nameWidthMax

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

PayloadSize, ImageSize,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, StreamHoldCapacity,
NonImagePayloadSize, Width, BCState, OffsetXCategory/ImageFormatControl

ValuesDescription0

Minimum(Sensor width)

Maximum (default)

Goldeye G/CL Features Reference V1.7.2

169

Feature description

Info
Numerical information that uniquely identifies the device.
Display name

Info

Origin of feature

CameraFeature type

(Category)

GevDeviceMACAddress
48-bit MAC address of the GVCP interface of the selected remote device.
Display name

DeviceMACAddress

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

Affected features(None)

Category/Info

BasePartNumber
Display name

BasePartNumber

Origin of feature

Transport layer

Feature type

Integer

Affected features(None)

Category/Info

BootLoaderVersionBuild
Build information of the boot loader.
Display name

BootLoaderVersionBuild

Origin of feature

Transport layer

Feature type

Integer

Affected features(None)

Category/InfoGoldeye G/CL Features Reference V1.7.2

170

Feature description

BootLoaderVersionMajor
Major part of the Boot loader version number (part before the decimal)
Display name

BootLoaderVersionMajor

Origin of feature

Transport layer

Feature type

Integer

Affected features(None)

Category/Info

BootLoaderVersionMinor
Minor part of boot loader version number (part after the decimal).
Display name

BootLoaderVersionMinor

Origin of feature

Transport layer

Feature type

Integer

Affected features(None)

Category/Info

DevicePartNumber
Manufacturer‘s part number.
Display name

DevicePartNumber

Origin of feature

CameraFeature type

StringAccessR

Affected features(None)

Category/Info

FirmwareVersionBuild
Firmware Build information.
Display nameFirmwareVerBuild

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/InfoGoldeye G/CL Features Reference V1.7.2

171

Feature description

FirmwareVersionMajor
Major part of the firmware version number (part before the decimal).
Display nameFirmwareVerMajor

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/Info

FirmwareVersionMinor
Minor part of firmware version number (part after the decimal).
Display nameFirmwareVerMinor

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/Info

UniqueID
Display name

UniqueID

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/Info

VariantPartNumber
Display name

VariantPartNumber

Origin of feature

CameraFeature type

Integer

Access

R/C

Affected features(None)

Category/InfoGoldeye G/CL Features Reference V1.7.2

172

Feature description

LUTControl
This category handles all features necessary to apply the look-up table (LUT). Referto the Goldeye G/CL Technical Manual for a description of how the look-up table isapplied.
Display name

LUTControl

Origin of feature

CameraFeature type

(Category)

LUTBitDepthIn
Bit depth of the input value of the LUT block.
Display name

LUTBitDepthIn

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/LUTControl

LUTBitDepthOut
Bit depth of the output value of the LUT block.
Display name

LUTBitDepthOut

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/LUTControl

Goldeye G/CL Features Reference V1.7.2

173

Feature description

LUTDatasetActive[LUTDatasetSelector]
The LUTDatasetSelector value of the last loaded data set. If the user set is saved,
this value will define which LUT to load at start-up.
Invalidate by LUTSelector.
Display name

LUTDatasetActive

Origin of feature

CameraFeature type

Integer

AccessR

Affected features(None)

Category/LUTControl

ValuesDescription0

Minimum (default)(Sensor width)

Maximum

LUTDatasetLoad[LUTDatasetSelector]
Loads a LUT data set from file into the volatile memory of the LUT module. The file
to be loaded is defined by LUTDatasetSelector.
Display name

LUTDatasetLoad

Origin of feature

CameraAccessW

Feature typeCommandAffected features(None)

Category/LUTControl

Goldeye G/CL Features Reference V1.7.2

174

Feature description

LUTDatasetSave[LUTDatasetSelector]
Stores the current LUT data set from the volatile memory of the camera to a file.
The LUTDatasetSelector defines the file where the LUT data is saved. Note thatsome data sets are factory defined and cannot be overwritten.
Display name

LUTDatasetSave

Origin of feature

CameraAccessW

Feature typeCommandAffected features(None)

Category/LUTControl

LUTDatasetSelector
The data set selector corresponds to the LUT file selectors. It connects the LUT
data set to the corresponding LUT file selectors, accessible via the FileAccess
category features.
The LUTDatasetSelector may point to an empty file selector. If the first file holds
no data, and LUTDatasetSelector0 is used to try loading the file, an error occurs.
Invalidate by LUTSelector.
Display name

LUTDatasetSelector

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/LUTControl

ValuesDescription

0

Points to LUT_000 (default)

1

Points to LUT_001

2

Points to LUT_002

3

Points to LUT_003

4

Points to LUT_User_000

5

Points to LUT_User_001

6

Points to LUT_User_002

7

Points to LUT_User_003

Goldeye G/CL Features Reference V1.7.2

175Feature description

LUTEnable[LUTSelector]
Activates or deactivates the LUT selected by LUTSelector.
Invalidate by LUTSelector.
Display name

LUTEnable

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features(None)

Category/LUTControl

ValuesDescription

False

Disable the Look-up-table (default).

True

Enable the Look-up-table.

LUTIndex[LUTSelector]
Controls the index (offset) to access a single table entry in the selected LUT via the
LUTValue feature.
Invalidate by LUTSelector.
Display name

LUTIndexOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/LUTControl

ValuesDescription0

Minimum (default)(2LUTBitDepthOut-1)

Maximum

Goldeye G/CL Features Reference V1.7.2

176

Feature description

LUTSelector
Selects the LUT instance to control. The number of available LUT instances arecamera specific.
Display name

LUTSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/LUTControl

ValuesDescription

Luminance

Default

LUTValue[LUTSelector]
Returns or sets the value of the table entry at index in the look-up table at entry
LUTIndex.
Invalidated by LUTSelector and LUTIndex.
Display name

LUTValue

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features(None)

Category/LUTControl

ValuesDescription0

Minimum(2LUTBitDepthOut-1)

Maximum

Goldeye G/CL Features Reference V1.7.2

177

Feature description

LUTValueAll[LUTSelector]
Allows access to the complete table which is currently selected by LUTSelector.
This register should be treated as byte array. The size per entry is 2 bytes, which
store a 16 bit unsigned integer.
The byte order is low significant byte first (little-endian), number of entries
available in this field is 2LUTBitDepthIn -1.
Returns or sets the values of the complete LUT.
Invalidated by LUTSelector.
Display name

LUTValueAllOrigin of feature

CameraFeature type

RegisterAccessR/W

Affected features(None)

Category/LUTControl

ValuesDescription0

Minimum(2LUTBitDepthOut-1)

Maximum

Goldeye G/CL Features Reference V1.7.2

178

Feature description

StreamThis category handles features about the data stream.
Display nameStreamOrigin of feature

CameraFeature type

(Category)

Info (subcategory)This subcategory provides general stream related information.
Display name

Info

Origin of feature

CameraFeature type

(Subcategory)Category/StreamGVSPFilterVersion
Version of the GVSP Filter driver.
Display name

GVSPFilterVersion

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

StringAccess

R/C

Affected features(None)

Category/Stream/InfoGoldeye G/CL Features Reference V1.7.2

179

Feature description

Multicast (subcategory)Multicast mode allows the camera to send image data to all hosts on the same
subnet as the camera. The host computer (or Vimba Viewer application instance)that first enables Multicast mode is the master and controls all camera
parameters. All other hosts or instances are the monitors and can view image data
only.

Most GigE switches support a maximum packet size of 1500 in Multicast mode.

When using clients with Linux, you have to configure the IP subsystem to process

Multicast IP traffic.

Display nameMulticastOrigin of feature

CameraAvailability

GigE Vision models only

Feature type

(Subcategory)Category/StreamMulticastEnable
Enables Multicast mode. In Multicast mode all computers on the same subnet
as the camera can receive image data from the camera MulticastIPAddress.
Display nameMulticastEnable

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

BooleanAccessR/W

Affected features(None)

Category/Stream/Multicast

ValuesDescription

True

Enables Multicast.

False

Disables Multicast. (default)

Goldeye G/CL Features Reference V1.7.2

180

Feature description

MulticastIPAddress
Sets the multicast IP address.
Display nameMulticastIPAddress

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

Access

R/C

Affected features(None)

Category/Stream/Multicast

Goldeye G/CL Features Reference V1.7.2

181

Feature description

Settings (subcategory)This subcategory defines the settings of the GVSP (GigE Vision Streaming Protocol).
Display nameAutoModeParameters

Origin of feature

CameraFeature type

(Subcategory)Category/StreamGVSPAdjustPacketSize
Requests the packet size used to be adjusted automatically.
Display name

GVSPAdjustPacketSize

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature typeCommandAffected features(None)

Category/Stream/Settings

GVSPBurstSize
Maximum number of GVSP packets to be processed in one burst.
Display nameGVSPBurstSize

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR/W

Unit

GVSP Packets

Affected features(None)

Category/Stream/Settings

ValuesDescription

1

Minimum

32

Default

256

Maximum

Goldeye G/CL Features Reference V1.7.2

182

Feature description

GVSPDriverSelector
Streaming driver to be used.
Display nameGVSPDriverSelector

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Enumeration

AccessR/W

Affected features(None)

Category/Stream/Settings

ValuesDescription

Filter

Selects the filter drivers stream engine (default).

SocketSelects the transport layers stream engine.

GVSPHostReceiveBuffers
Number of buffers to be used by the network socket. Only applicable when notusing the Filter Driver.
Display name

GVSPHostReceiveBuffers

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR/W

Affected features(None)

Category/Stream/Settings

ValuesDescription

256

Minimum

512

Default

2,048

Maximum

Goldeye G/CL Features Reference V1.7.2

183

Feature description

GVSPMaxLookBack
Size of the look back window, in packets, when determining if a stream packet ismissing. When a stream packet arrives out of order, the driver skips back
GVSPMaxLookBack packets to see if the packets previous to this point have all
arrived. If not, a resend is issued. A lower value allows the driver less time toassemble out-of-order packets; a larger value allows the driver more time. If thevalue is set too low, the driver will issue unnecessary resends. If the value is set toohigh and a packet truly is missing, the driver will issue a resend but the camera may
no longer have the required packet in its resend buffer and the packet will be
dropped. The ideal value is system dependent.
Display name

GVSPMaxLookBack

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR/W

Affected features(None)

Category/Stream/Settings

ValuesDescription

1

Minimum

30

Default

1,024

Maximum

GVSPMaxRequests
The maximum number of resend requests that the host will attempt before
marking a packet dropped.
Display name

GVSPMaxRequests

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR/W

Affected features(None)

Category/Stream/Settings

ValuesDescription

1

Minimum

3

Default

512

Maximum

Goldeye G/CL Features Reference V1.7.2

184

Feature description

GVSPMaxWaitSize
Maximum number of received GVSP packets following a resend request to wait
before requesting again.
Display name

GVSPMaxWaitSize

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR/W

Affected features(None)

Category/Stream/Settings

ValuesDescription

8

Minimum

100

Default

1,024

Maximum

GVSPMissingSize
Maximum number of simultaneous missing GVSP packets before dropping theframe.
Display name

GVSPMissingSize

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR/W

Affected features(None)

Category/Stream/Settings

ValuesDescription0

Minimum (=Off)

256

Default

1,024

Maximum

Goldeye G/CL Features Reference V1.7.2

185

Feature description

GVSPPacketSize
GVSP Packet size.
Display name

GVSPPacketSize

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

Access

R/W

Unit

Bytes

Affected features

DeviceStreamChannelPacketSize,
StreamHoldCapacity, DeviceLinkThroughputLimit,
AcquisitionFrameRateLimit, AcquisitionFrameRate,
ExposureTime, GevSCPSPacketSize

Category/Stream/Settings

ValuesDescription

Camera dependent

All values

GVSPTiltingSize
Maximum number GVSP packets received from a following frame before dropping
the frame.
Display nameGVSPTiltingSize

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR/W

Affected features(None)

Category/Stream/Settings

ValuesDescription0

Minimum (=Off)

100

Default

1,024

Maximum

Goldeye G/CL Features Reference V1.7.2

186

Feature description

GVSPTimeout
End of stream timeout. If no stream packet received before GVSPTimeout, hostrequests resend, up to GVSPMaxRequests times. If still no packet received fromcamera, packet is marked as dropped.
Display nameGVSPTimeout

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR/W

Unit

Milliseconds (1-3 s)

Affected features(None)

Category/Stream/Settings

ValuesDescription

10

Minimum

70

Default

5,000

Maximum

Goldeye G/CL Features Reference V1.7.2

187

Feature description

Statistics (subcategory)
The packet counts in this category cover the image transport. Packets used forcamera control or event data are not counted. All counters are reset at
AcquisitionStart.
Display name

Statistics

Origin of feature

CameraFeature type

(Subcategory)Category/Stream

StatFrameRate
Rate at which the device is acquiring frames, derived from the frame timestamps.
Display name

StatFrameRate

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Float

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

188

Feature description

StatFrameDelivered
Number of error-free frames captured since the start of imaging.
Display name

StatFramesDelivered

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

StatFrameDropped
Number of incomplete frames received by the host due to missing packets (notincluding shoved frames).
Display name

StatFramesDropped

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

189

Feature description

StatFrameRescued
Number of frames that initially had missing packets but were successfullycompleted after packet resend.
Display name

StatFramesRescued

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

StatFrameShoved
Number of frames dropped because the transfer of a following frame wascompleted earlier.
Display name

StatFramesShoved

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

190

Feature description

StatFrameUnderrun
Number of frames missed due to the non-availability of a user supplied buffer.
Display name

StatFramesUnderrun

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

StatLocalRate
Inverse of time interval between the last two frames (faulty or not) received by thehost. No averaging is performed.
In case of error-free frame reception, StatLocalRate is similar to StatFrameRate,
except that the host clock is used instead of frame timestamps for measuring thetime interval between frames.
Otherwise, StatLocalRate and StatFrameRate may differ significantly.
Display name

StatLocalRate

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Float

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

191

Feature description

StatPacketErrors
Number of improperly formed packets. If this number is non-zero, it suggests a
possible cable or camera hardware failure.
Display name

StatPacketsErrors

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

StatPacketMissed
Number of packets missed since the start of imaging.
If everything is configured correctly, this number should remain zero, or at least very
low compared to StatPacketReceived.

Display name

StatPacketsMissed

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

192

Feature description

StatPacketReceived
Number of error-free packets received by the driver since the start of imaging, thisnumber should grow steadily during continuous acquisition.
Display name

StatPacketsReceived

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

StatPacketRequested
Number of missing packets that were requested to be resent from the device.
If everything is configured correctly, this number should remain zero, or at least very
low compared to StatPacketReceived.

Display name

StatPacketsRequested

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

193

Feature description

StatPacketResent
Number of packets resent by the camera since the start of imaging.
Display name

StatPacketsResent

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Integer

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

StatTimeElapsed
Elapsed time (in seconds) since the streaming was started.
Display nameStatTimeElapsed

Origin of feature

Transport layer

Availability

GigE Vision models only

Feature type

Float

AccessR

Affected features(None)

Category/Stream/Statistics

ValuesDescription0

Minimum

Camera dependent

Maximum

Goldeye G/CL Features Reference V1.7.2

194Feature description

StreamInformation
Display nameStreamInformation

Origin of feature

CameraFeature type

(Category)StreamID
Device’s unique ID for the stream.
Display nameStreamID

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features(None)

Vimba

V1.3 or later

Category/StreamInformation

StreamType
Identifies the transport layer technology of the stream.
Display nameStreamType

Origin of feature

Transport layer

Feature type

Enumeration

AccessR

Unit(None)

Vimba

V1.3 or later

Category/StreamInformation

Goldeye G/CL Features Reference V1.7.2

195Feature description

TransportLayerControl
This category contains the features related to transport layer control.
Display name

TransportLayerControl

Origin of feature

CameraFeature type

(Category)

CameraLink (subcategory)
Note the features within this subcategory apply to Camera Link cameras only.
Display name

CameraLink

Origin of feature

CameraFeature type

(Subcategory)Category/TransportLayerControl

CLConfiguration
Describes the configuration used by the camera.
Display name

CLConfiguration

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Enumeration

AccessR

Affected features(None)

Category/TransportLayerControl/CameraLink

ValuesDescription

BaseStandard base configuration described by the Camera Link
standard.

Goldeye G/CL Features Reference V1.7.2

196

Feature description

ClClockFrequency
Allows to change the clock frequency of the camera link backend.
Higher values allow higher bandwidths, lower values reduce bit error problems
with longer cables.
Display name

CLClockFrequency

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

AccessR/W

Affected features

AcquisitionFrameRate, AcquisitionFrameRateLimit,
DeviceClockFrequency

Category/TransportLayerControl/CameraLink

ValuesDescription

25,000,000
40,000,000

Clock frequencies available on CL-008.

25,000,000
40,000,000
25,000,000
55,000,000
85,000,000

Clock frequencies available on CL-032.
Clock frequencies available on CL-033.

ClLValToFValDelay
Defines the gap between the falling edges of the last lines’ LVAL signal and the
FVAL signal.
Display name

ClLvalToFvalDelay

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/W

Unit

Camera Link clock cycles

Affected features

AcquisitionFrameRate, AcquisitionFrameRateLimit

Category/TransportLayerControl/CameraLink

ValuesDescription0

Minimum

32

Default

1,024

Maximum

Goldeye G/CL Features Reference V1.7.2

197

Feature description

ClLValToLValDelay
Defines the width of the line gap.
Influence of the line gap adjustment
This value may have a significant impact on the maximum possible frame rate.
Reducing this value may increase the frame rate, but reducing it too much may
cause the camera to mask out pixels using the DVAL signal and to sporadicallyextend the line gap to a value beyond the value set here. Possible consequences are
an irregular line gap timing and an increasing delay between the recorded scene
and the received images.
Furthermore, the camera may drop frames internally. This occurs when the camera
cannot provide the data in a pace fast enough to meet the timing set by the
ClLValToLValDelay parameter. However, if the frame grabber evaluates the same
DVAL signal, the received images will still be valid.
Decreasing this value might be useful when using small ROI's to maximize the frame
rate. If unsure, it is recommended to keep this parameter’s default setting.
The values greater than or equal to the default value can be considered to be safe.
Display name

ClLvalToLvalDelay

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/W

Unit

Camera Link clock cycles

Affected features

AcquisitionFrameRate, AcquisitionFrameRateLimit

Category/TransportLayerControl/CameraLink

ValuesDescription

1

Minimum

32

Default for CL-008 and CL-032

64

Default for CL-033

1,024

Maximum

Goldeye G/CL Features Reference V1.7.2

198

Feature description

ClMinFValToFValDelay
Defines the minimum gap from one falling edge to the next rising edge of the FVAL
signal.
Depending on the camera's operation mode, the real gap between two FVAL
signals may be bigger than the value set here. This parameter just defines theminimum allowed value.
Display name

ClMinFvalToFvalDelay

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/W

Unit

Camera Link clock cycles

Affected features

AcquisitionFrameRate, AcquisitionFrameRateLimit

Category/TransportLayerControl/CameraLink

ValuesDescription

1

Minimum

32

Default

1,024

Maximum

Goldeye G/CL Features Reference V1.7.2

199

Feature description

ClMinFValToLValDelay
Defines the minimum gap between the rising edges of the FVAL and the first lines
LVAL signal.
The length of this gap is defined by either (3 * Width + 32) or the value of
ClMinFValToLValDelay, whichever is the greater.
The real delay may be higher than the value specified here.
Display name

ClMinFvalToLvalDelay

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Integer

Access

R/W

Unit

Camera Link clock cycles

Affected features

AcquisitionFrameRate, AcquisitionFrameRateLimit,
ExposureTime

Category/TransportLayerControl/CameraLink

ValuesDescription0

Minimum

32

Default

1,023

Maximum

DeviceTapGeometry
Describes the geometrical properties characterizing the taps of a camera aspresented at the output of the device
Display name

DeviceTapGeometry

Origin of feature

CameraAvailability

Camera Link models only

Feature type

Enumeration

AccessR/(W)Category/TransportLayerControl/CameraLink

ValuesDescription

Geometry_1X_1Y

1-tap configuration(default, with pixel formats Mono8, Mono12 andMono14)

Geometry_1X2_1Y

2-tap configuration(with pixel formats Mono8 and Mono12 only)

Goldeye G/CL Features Reference V1.7.2

200

Feature description

GigEVision (subcategory)This subcategory contains the features pertaining to the GigE Vision transport layerof the device.
Display name

GigEVision

Origin of feature

CameraFeature type

(Subcategory)Category/TransportLayerControl

GevCurrentIPConfigurationDHCP
Controls whether the DHCP IP configuration scheme is activated on the given
logical link.
Display name

GevCurrentIPConfigurationDHCP

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

BooleanAccessR/W

Affected features(None)

Category/TransportLayerControl/GigEVision

ValuesDescription

True

Activate the DHCP IP configuration scheme (default).

False

Deactivate the DHCP IP configuration scheme.

Goldeye G/CL Features Reference V1.7.2

201

Feature description

GevCurrentIPConfigurationLLA
Controls whether the Link Local Address IP configuration scheme is activated on
the given logical link.
Currently as per the GigE Vision specification, LLA cannot be disabled.

Display name

GevCurrentIPConfigurationLLA

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

BooleanAccessR/W

Affected features(None)

Category/TransportLayerControl/GigEVision

ValuesDescription

True

Activate the Link Local Address IP configuration scheme(default).

False

Deactivate the Link Local Address IP configuration
scheme.

GevCurrentIPConfigurationPersistentIP
Controls whether the Persistent IP configuration scheme is activated on the given
logical link.
Display name

GevCurrentIPConfigurationPersistentIP

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

BooleanAccessR/W

Affected features(None)

Category/TransportLayerControl/GigEVision

ValuesDescription

True

Activate the Persistent IP configuration scheme.

False

Deactivate the Persistent IP configuration scheme(default).

Goldeye G/CL Features Reference V1.7.2

202

Feature description

GevInterfaceSelector
Selects which logical link to control.
Display nameGevInterfaceSelector

Origin of feature

CameraAvailability

GigE Vision models only

Feature type

Integer

AccessR/W

Affected features(None)

Category/TransportLayerControl/GigEVision

GevMACAddress[GevInterfaceSelector]
MAC address of the link specified by GevInterfaceSelector.
Display nameGevMACAddress

Origin of feature

CameraFeature type

Integer

Availability

GigE Vision models only

AccessR

Affected features(None)

Category/TransportLayerControl/GigEVision

Goldeye G/CL Features Reference V1.7.2

203

Feature description

TransportLayerControl (continued)
The feature descriptions for the GigEVision subcategory have ended on theprevious page. The following features continue the TransportLayerControl
category, without a subcategory.

PayloadSize
Total size of payload in bytes.
Display name

PayloadSize

Origin of feature

CameraAvailability

Both Camera Link and GigE Vision models

Feature type

Integer

Access

R

Unit

Bytes

Affected features(None)

Category/TransportLayerControl

ValuesDescription0

Minimum

Camera dependent

Maximum

If

Then

ChunkModeActive = True

PayloadSize = ImageSize +NonImagePayloadSize + 8

ChunkModeActive = False

PayloadSize = ImageSize

Goldeye G/CL Features Reference V1.7.2

204Feature description

StreamHold (subcategory)
Normally, the camera sends data to the host computer immediately after
completion of exposure. Enabling StreamHold delays the transmission of data,
storing it in on-camera memory, until StreamHold is disabled.
This feature can be useful to prevent GigE network flooding in situations where alarge number of cameras connected to a single host computer are capturing asingle event. Using the StreamHold function, each camera will hold the event
image data until the host computer disables StreamHold for each camera in turn.
Display nameStreamHold

Origin of feature

CameraFeature type

(Subcategory)Category/TransportLayerControl

StreamHoldCapacity
The maximum number of images (for the current size and format) that can be
stored on the camera when StreamHold is enabled. Used in AcquisitionMode =Recorder, or StreamHoldEnable = On. This value is different for each camera
depending on the camera internal memory size and the image size.
Display nameStreamHoldCapacity

Origin of feature

CameraFeature type

Integer

AccessR

Unit

FramesAffected features(None)

Category/TransportLayerControl/StreamHold

Goldeye G/CL Features Reference V1.7.2

205

Feature description

StreamHoldEnable
Control on-camera image storage; this feature is like a “pause” button for theimage stream.
Display nameStreamHoldEnable

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/TransportLayerControl/StreamHold

ValuesDescription

On

Images remain stored on the camera, and are nottransmitted to the host.

Off

The image stream resumes, and any stored images aresent to the host (default).

Goldeye G/CL Features Reference V1.7.2

206

Feature description

UserSetControl
The User Set Control describes the features for global control of the device
settings. It contains the features to save and load the user device settings.
Display nameUserSetControl

Origin of feature

CameraFeature type

(Category)Features that can be saved in user sets
Generally, all features can be saved in user sets, except for:• Selectors• Commands• Read-only features• Transport layer features (Origin of feature = Transport layer)•

TestPattern

UserSetDefaultSelector
Selects the individual user set to be loaded on power-up or reset.
Display nameUserSetDefaultSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features(None)

Category/UserSetControl

ValuesDescription

Default

Selects the default user set (default).

UserSet1

Selects user set 1.

UserSet2

Selects user set 2.

UserSet3

Selects user set 3.

UserSet4

Selects user set 4.

Goldeye G/CL Features Reference V1.7.2

207

Feature description

UserSetLoad[UserSetSelector]
Loads camera parameters from the user set specified by UserSetSelector andactivates them.
Display nameUserSetLoad

Origin of feature

CameraFeature typeCommandAccessR

Affected features

See Features that can be saved in user sets on page 207.

Category/UserSetControl

UserSetSave[UserSetSelector]
Saves camera parameters to the user set specified by UserSetSelector. The
Default setting cannot be overwritten.
Display nameUserSetSave

Origin of feature

CameraFeature typeCommandAccessW

Affected features

See Features that can be saved in user sets on page 207.

Category/UserSetControl

UserSetSelector
Selects a user set, for loading or saving camera parameters.
Display nameUserSetSelector

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

See Features that can be saved in user sets on page 207.

Category/UserSetControl

ValuesDescription

Default

Selects the default user set (default).

Goldeye G/CL Features Reference V1.7.2

208Index

Index
A
Acquiring
LineOutSource ....................................... 83
StrobeSource ........................................ 86
AcquisitionAbort ......................................... 23
AcquisitionAutoStartMode .......................... 23
AcquisitionControl (category) ....................... 23
AcquisitionFrameCount ............................... 24
AcquisitionFrameRate ................................. 24
AcquisitionFrameRateLimit .......................... 25
AcquisitionMode ......................................... 26
AcquisitionStart ........................................... 27
AcquisitionStop ........................................... 27
AcquisitionTriggerReady
LineOutSource ....................................... 83
StrobeSource ........................................ 86
Allied Vision contact .................................... 12
AnalogControl (category) ............................. 46
AutoModeOutliersBright ............................. 28
AutoModeOutliersDark ................................ 29
AutoModeRegion (subcategory) ................... 28
AutoModeRegionDimOutside ...................... 29
AutoModeRegionHeight .............................. 30
AutoModeRegionOffsetX ............................. 30
AutoModeRegionOffsetY ............................. 31
AutoModeRegionWidth ............................... 31

B
BackgroundCorrection (subcategory) .........128
BandwidthControlMode .............................. 52
BasePartNumber .......................................170
BCDatasetMeanValue ................................128
BCDatasetOffsetValue ................................129
BCDatasetROIHeight ..................................129
BCDatasetROIOffsetX .................................130
BCDatasetROIOffsetY .................................130
BCDatasetROIWidth ..................................131
BCIntegrationAbort ...................................131
BCIntegrationFrameCount .........................132
BCIntegrationMode ...................................132
BCIntegrationStart .....................................133

Goldeye G/CL Features Reference V1.7.2

BCMode ....................................................134
BCState .....................................................134
BinningHorizontal ......................................148
BinningHorizontalMode .............................149
BinningVertical ..........................................150
BinningVerticalMode .................................151
BlackLevel ...................................................46
BootLoaderVersionBuild ............................170
BootLoaderVersionMajor ...........................171
BootLoaderVersionMinor ...........................171
BufferHandlingControl (category) .................48

C
CameraLinkFeatures (subcategory) .............196
CC1
LineInSelector ........................................80
LineOutSource .......................................83
StrobeSource .........................................86
TriggerSource ........................................45
CC2
LineInSelector ........................................80
LineOutSource .......................................83
StrobeSource .........................................86
TriggerSource ........................................45
CC3
LineInSelector ........................................80
LineOutSource .......................................83
StrobeSource .........................................86
TriggerSource ........................................45
CC4
LineInSelector ........................................80
LineOutSource .......................................83
StrobeSource .........................................86
TriggerSource ........................................45
ChunkDataControl (category) .......................50
ChunkModeActive .......................................50
ClClockFrequency ......................................197
CLConfiguration .........................................196
ClLValToFValDelay ......................................197
ClLValToLValDelay .......................................198
ClMinFValToFValDelay ................................199
ClMinFValToLValDelay ................................200
Configuration (subcategory) .......................122
ContrastAuto ...............................................32
ContrastAutoControl (subcategory) ..............32
ContrastAutoIntensityMax ...........................33

209

IndexContrastAutoIntensityMin ............................ 33
ContrastUserInputMax ................................ 34
ContrastUserInputMin ................................. 34
Current (subcategory) ................................123

D
DecimationHorizontal ................................152
DecimationVertical ....................................153
DefectPixelCorrection (subcategory) ...........135
DeviceBaudRateSwitchConfirmTimeout ....... 53
DeviceClockFrequency ................................. 53
DeviceClockSelector .................................... 54
DeviceControl (category) ............................. 52
DeviceFamilyName ...................................... 54
DeviceFanMode .......................................... 55
DeviceFanRpm ............................................ 55
DeviceFanSelector ....................................... 56
DeviceFirmwareVersion ............................... 56
DeviceFirmwareVersionSelector ................... 57
DeviceLinkHeartbeatTimeout ....................... 57
DeviceLinkSelector ...................................... 57
DeviceLinkThroughputLimit ......................... 58
DeviceLinkThroughputLimitMode ................ 59
DeviceManufacturerInfo .............................. 59
DeviceModelName ...................................... 60
DevicePartNumber ....................................171
DeviceRelativeHumidity ............................... 60
DeviceRelativeHumiditySelector ................... 61
DeviceReset ................................................ 61
DeviceScanType .......................................... 62
DeviceSerialNumber .................................... 63
DeviceSerialPortBaudRate ........................... 63
DeviceSerialPortSelector .............................. 64
DeviceSFNCVersionMajor ............................ 61
DeviceSFNCVersionMinor ............................ 62
DeviceSFNCVersionSubMinor ....................... 62
DeviceStreamChannelPacketSize .................. 64
DeviceStreamChannelSelector ..................... 65
DeviceTapGeometry ..................................200
DeviceTemperature ..................................... 65
DeviceTemperatureSelector ......................... 66
DeviceTLType .............................................. 66
DeviceType ................................................. 67
DeviceUserID .............................................. 67
DeviceVendorName ..................................... 67

Goldeye G/CL Features Reference V1.7.2

DigitalIOControl (category) ...........................78
Document history ........................................14
DPCDatasetActivate ...................................135
DPCDatasetActive ......................................136
DPCDatasetActiveDescription .....................136
DPCDatasetDescription ..............................137
DPCDatasetSelector ...................................137
DPCMode .................................................138

E
EventAcquisitionEnd ....................................98
EventAcquisitionEndFrameID .......................87
EventAcquisitionEndTimestamp ...................88
EventAcquisitionRecordTrigger ...................100
EventAcquisitionRecordTriggerFrameID ........88
EventAcquisitionRecordTriggerTimestamp ....88
EventAcquisitionStart ..................................98
EventAcquisitionStartFrameID ......................89
EventAcquisitionStartTimestamp ..................89
EventCC1FallingEdge .................................101
EventCC1RisingEdge ..................................100
EventCC2FallingEdge .................................101
EventCC2RisingEdge ..................................101
EventCC3FallingEdge .................................102
EventCC3RisingEdge ..................................102
EventCC4FallingEdge .................................103
EventCC4RisingEdge ..................................102
EventControl (category) ...............................87
EventData (subcategory) ..............................87
EventError .................................................107
EventErrorFrameID ......................................89
EventErrorTimestamp ..................................90
EventExposureEnd .......................................99
EventExposureEndFrameID ..........................90
EventExposureEndTimestamp ......................90
EventFrameTrigger ......................................99
EventFrameTriggerFrameID ..........................91
EventFrameTriggerReady ...........................105
EventFrameTriggerReadyFrameID .................91
EventFrameTriggerReadyTimestamp .............92
EventFrameTriggerTimestamp ......................91
EventID (subcategory) ..................................97
EventLine1FallingEdge ...............................104
EventLine1FallingEdgeFrameID .....................92
EventLine1FallingEdgeTimestamp .................92210

IndexEventLine1RisingEdge ................................103
EventLine1RisingEdgeFrameID ..................... 93
EventLine1RisingEdgeTimestamp ................. 93
EventLine2FallingEdge ...............................105
EventLine2FallingEdgeFrameID .................... 93
EventLine2FallingEdgeTimestamp ................ 94
EventLine2RisingEdge ................................104
EventLine2RisingEdgeFrameID ..................... 94
EventLine2RisingEdgeTimestamp ................. 94
EventNotification ......................................108
EventOverflow ..........................................107
EventOverflowFrameID ................................ 95
EventOverflowTimestamp ............................ 95
EventSelector ............................................109
EventsEnable1 ...........................................110
EventSensorTemperatureControlState ........106
EventSensorTemperatureControlStateFrameID 95
EventSensorTemperatureControlStateTimestamp

96

EventSensorTemperatureSetpoint ..............106
EventSensorTemperatureSetpointFrameID ... 96
Exposing
LineOutSource ....................................... 83
StrobeSource ........................................ 86
ExposureAuto ............................................. 35
ExposureAutoAdjustTol ................................ 36
ExposureAutoAlg ......................................... 36
ExposureAutoControl (subcategory) ............. 35
ExposureAutoMax ....................................... 37
ExposureAutoMin ....................................... 37
ExposureAutoRate ....................................... 38
ExposureAutoTarget .................................... 38
ExposureMode ............................................ 39
ExposureRangeMode .................................. 39
ExposureTime ............................................. 40F
FileAccessBuffer ........................................112
FileAccessControl (category) ......................112
FileAccessLength .......................................112
FileAccessOffset ........................................113
FileAttribute ..............................................113
FileAttributeBuffer .....................................114
FileDescription ..........................................114
FileDescriptionBuffer .................................115

Goldeye G/CL Features Reference V1.7.2

FileOpenAttribute ......................................115
FileOpenMode ..........................................116
FileOperationExecute .................................116
FileOperationResult ...................................116
FileOperationSelector ................................117
FileOperationStatus ...................................118
FileSelector ...............................................119
FileSize ......................................................119
FileStatus ..................................................120
FileType ....................................................120
FileTypeBuffer ...........................................121
FirmwareVerBuild ......................................171
FirmwareVerMajor ....................................172
FirmwareVerMinor ....................................172
FixedRate
TriggerSource ........................................45
FpaTCDS .....................................................68
FrameReadout
LineOutSource .......................................83
StrobeSource .........................................86
FrameTrigger
StrobeSource .........................................86
FrameTriggerReady
LineOutSource .......................................83
StrobeSource .........................................86
FreerunTriggerSource ........................................45

G
Gain ............................................................47
GevCurrentDefaultGateway .......................123
GevCurrentIPAddress .................................123
GevCurrentIPConfigurationDHCP ................201
GevCurrentIPConfigurationLLA ...................202
GevCurrentIPConfigurationPersistentIP .......202
GevCurrentSubnetMask .............................123
GevDeviceMACAddress ..............................170
GevHeartbeatInterval ................................125
GevInterfaceSelector .................................203
GevIPConfigurationMode ...........................122
GevMACAddress ........................................203
GevPersistentDefaultGateway ....................127
GevPersistentIPAddress ..............................127
GevPersistentSubnetMask .........................127
GevSCPSPacketSize ....................................126
GigE (category) ..........................................122

211

IndexGigEVision (subcategory) ...........................201
GPO
LineOutSource ....................................... 83
GVCP (subcategory) ...................................124
GVCPCmdRetries .......................................124
GVCPCmdTimeout .....................................125
GVSPAdjustPacketSize ................................182
GVSPBurstSize ...........................................182
GVSPDriverSelector ...................................183
GVSPFilterVersion ......................................179
GVSPHostReceiveBuffers ...........................183
GVSPMaxLookBack ....................................184
GVSPMaxRequests ....................................184
GVSPMaxWaitSize .....................................185
GVSPMissingSize .......................................185
GVSPPacketSize .........................................186
GVSPTiltingSize .........................................186
GVSPTimeout ............................................187

H
Height ......................................................154
HeightMax ................................................154

I
Image data flow .......................................... 20
ImageCorrectionControl (category) ............128
ImageFormatControl (category) .................148
ImageSize .................................................155
Imaging
LineOutSource ....................................... 83
Info (category) ...........................................170
Info, Stream (subcategory) .........................179
IntegrationMode ......................................... 40

L
Line1
TriggerSource ........................................ 45
LineIn (subcategory) .................................... 78
LineIn1
LineInSelector ....................................... 80
LineOutSource ....................................... 83
StrobeSource ........................................ 86
LineIn2
LineInSelector ....................................... 80
LineOutSource ....................................... 83
StrobeSource ........................................ 86

Goldeye G/CL Features Reference V1.7.2

LineInGlitchFilter .........................................78
LineInLevels ................................................79
LineInSelector .............................................80
LineOut (subcategory) .................................81
LineOut1
LineOutSelector .....................................82
LineOut2
LineOutSelector .....................................82
LineOut3
LineOutSelector .....................................82
LineOutLevels ..............................................81
LineOutPolarity ...........................................82
LineOutSelector ...........................................82
LineOutSource .............................................83
LUTBitDepthIn ...........................................173
LUTBitDepthOut ........................................173
LUTControl (category) ................................173
LUTDataSetActive ......................................174
LUTDatasetLoad ........................................174
LUTDatasetSave .........................................175
LUTDatasetSelector ...................................175
LUTEnable .................................................176
LUTIndex ...................................................176
LUTSelector ...............................................177
LUTValue ...................................................177
LUTValueAll ...............................................178

M
Multicast (subcategory) .............................180
MulticastEnable ........................................180
MulticastIPAddress ....................................181
MultipleRegions (subcategory) ...................156
MultipleRegionsEnable ..............................156
MultipleRegionsMode ...............................157

N
NonImagePayloadSize ..................................51
NonUniformityCorrection (subcategory) .....139
NUCDatasetActivate ..................................139
NUCDatasetActive .....................................140
NUCDatasetActiveDescription ....................140
NUCDatasetActiveExposureTime ................141
NUCDatasetActiveGain ..............................141
NUCDatasetActiveTemperature ..................142
NUCDatasetAuto .......................................143212

Index

NUCDatasetDescription .............................143
NUCDatasetExposureTime .........................144
NUCDatasetGain .......................................144
NUCDatasetNodeSelector ..........................145
NUCDatasetNodeValue ..............................145
NUCDatasetSelector ..................................146
NUCDatasetTemperature ...........................146
NUCMode .................................................147

O
OffsetX .....................................................160
OffsetY ......................................................161

P
PayloadSize ...............................................204
Persistent (subcategory) ............................127
PixelFormat ...............................................162

R
RecorderPreEventCount .............................. 41

S
SensorBits .................................................163
SensorBoardSettings (subcategory) .............. 78
SensorCoolingPower ................................... 70
SensorGain ................................................. 47
SensorHeight ............................................163
SensorOffsetX ...........................................164
SensorOffsetY ...........................................164
SensorTemperatureControlMode ................. 71
SensorTemperatureControlState .................. 72
SensorTemperatureSetpointActivate ............ 72
SensorTemperatureSetpointActive ............... 73
SensorTemperatureSetpointMode ............... 74
SensorTemperatureSetpointSelector ............ 75
SensorTemperatureSetpointValue ................ 75
SensorTemperatureTargetSetpoint ............... 76
SensorType ...............................................165
SensorWidth .............................................165
Settings (subcategory) ...............................182
Software
TriggerSource ........................................ 45
StatFrameDelivered ...................................189
StatFrameDropped ....................................189
StatFrameRate ..........................................188

Goldeye G/CL Features Reference V1.7.2

StatFrameRescued .....................................190
StatFrameShoved ......................................190
StatFrameUnderrun ...................................191
Statistics (subcategory) ..............................188
StatLocalRate ............................................191
StatPacketErrors ........................................192
StatPacketMissed ......................................192
StatPacketReceived ....................................193
StatPacketRequested .................................193
StatPacketResent .......................................194
StatTimeElapsed ........................................194
Stream (category) ......................................179
StreamAnnounceBufferCount ......................49
StreamAnnounceBufferMinimum .................48
StreamBufferHandlingMode ........................49
StreamHold (subcategory) .........................205
StreamHoldCapacity ..................................205
StreamHoldEnable .....................................206
StreamID ...................................................195
StreamInformation (category) ....................195
StreamType ...............................................195
Strobe (CL subcategory) ...............................84
Strobe1
LineOutSource .......................................83
StrobeDelay ................................................84
StrobeDuration ............................................85
StrobeDurationMode ...................................85
StrobeSource ..............................................86
SubRegionHeight .......................................157
SubRegionOffsetY ......................................158
SubRegionSelector .....................................158
SubRegionStatus ........................................159
support .......................................................12T
TestPattern ................................................167
TestPatternGeneratorSelector ....................166
TestPatternSpecificParameter1 ...................168
TIDC_Mode .................................................69
TimestampLatch ..........................................76
TimestampLatchValue ..................................77
TimestampReset ..........................................77
TransportLayerControl (category) ...............196
TriggerActivation .........................................42
TriggerDelay ................................................42213

Index

TriggerMode ............................................... 43
TriggerOverlap ............................................ 43
TriggerSelector ............................................ 44
TriggerSoftware ........................................... 44
TriggerSource .............................................. 45

U
UniqueID ..................................................172
UserSetControl (category) ..........................207
UserSetDefaultSelector ..............................207
UserSetLoad .............................................208
UserSetSave ..............................................208
UserSetSelector ........................................208

V
VariantPartNumber ...................................172

W
Width .......................................................168
WidthMax .................................................169

Goldeye G/CL Features Reference V1.7.2

214