MIPI CSI-2, GIGE VISION, AND USB3 VISION CAMERAS

AlviumFeatures Reference
V2.9.1
FW 00.12.00.00611a22

Allied Vision Technologies GmbH // Taschenweg 2a, 07646 Stadtroda / Germany2023-Jun-16

This document at a glanceThis document at a glance
Read this document carefully
Learn to avoid damage to your camera and use it in the most safe and efficient way.

Features with Vimba X

Categories and features in this reference are organized as in the Vimba X Viewer.
Order and visibility can be different on third party viewers.

Previous Vimba Viewer only displayed some transport layer features. With Vimba
X Viewer, all transport layer features are displayed. In the viewer's feature tree,
the features are categorized by the corresponding GenTL module. The node
Camera contains all camera features, while the nodes Transport Layer, Interface,
Local Device, and Stream 0 contain the transport layer features.

Finding features
Camera firmware features can be found in the Camera GenTL Module of Vimba X
Viewer. Transport layer features can be found in the other GenTL Modules. (These
groups can differ when third party transport layers are used.) In this document, theincluded categories and features are listed in alphabetical order.
We recommend you to check Show Descriptions in Vimba X Viewer as shown in
Figure 1. The All tab is selected to show the feature tree. You can search forfeatures using the search bar in Vimba X Viewer. You can easily search for featuresin this document using the Index on page 289.

GenTL Module
Category
FeatureDescription

Figure 1: Features listed in the All tab of Vimba X Viewer

Alvium Features Reference V2.9.1

2

This document at a glance

Differences in features and values

Features described in this document may not be supported by every Alvium
model. Value ranges may differ between models as well.
GenICam for CSI-2 Access is supported for Alvium 1800 C models, please see theAlvium CSI-2 Cameras User Guide for details.
ActionControl features are supported only by Alvium GigE cameras.

MultipleRegionControl features are supported only by Alvium GigE and USB
cameras with Sony IMX global shutter sensors.
SequencerControl features are supported only by Alvium GigE and USB cameras
with Sony IMX global shutter sensors.
TransferControl features for image acquisition in burst mode are supported only

by Alvium GigE cameras. Support for the other Alvium series is technically
impossible.

What else do you need?

This is a selection of helpful links:

Download or topic

Link

Alvium camera documentation andapplication notes

www.alliedvision.com/en/support/technical-documentation

Vimba X SDK for Windows, Linux, andLinux/ARM, including Vimba X Viewer,
Firmware Updater, and Driver Installer
for Windows

www.alliedvision.com/en/products/software/vimba-x-sdk

Firmware downloads

www.alliedvision.com/en/support/firmware-downloads

Technical support

www.alliedvision.com/en/support
Table 1: Helpful links

Alvium Features Reference V2.9.1

3

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

Alvium Features Reference V2.9.1

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

4

Contents

Contents
This document at a glance ......................................................................... 2
Features with Vimba X ...........................................................................................................2
Finding features .................................................................................................................................... 2

Differences in features and values ........................................................................................3
What else do you need? ........................................................................................................3

Contact us .................................................................................................. 4
Document history and conventions ........................................................ 18
Document history .................................................................................................................19
Conventions used in this document ....................................................................................24
Styles ................................................................................................................................................... 24
Symbols and notes .............................................................................................................................. 25
Access .................................................................................................................................................. 25
Standards referred to in this document ............................................................................................. 25
Acronyms and terms ........................................................................................................................... 26
Description scheme ............................................................................................................................ 26
Features availability ............................................................................................................................ 27

Copyright and trademarks ...................................................................................................28

Notes on feature description ................................................................... 30
Image data flow ....................................................................................................................31
Feature interdependencies ..................................................................................................32
Regions of interest and auto mode regions .......................................................................33
Basic rules ............................................................................................................................................ 33
ROI and auto mode region effects ...................................................................................................... 34

Feature descriptions: Transport Layer .................................................... 35
ActionControl ........................................................................................................................36
ActionCommand .................................................................................................................................. 36
ActionDeviceKey .................................................................................................................................. 36
ActionGroupKey ................................................................................................................................... 37
ActionGroupMask ............................................................................................................................... 37
ActionScheduledTime .......................................................................................................................... 38
ActionScheduledTimeEnable ............................................................................................................... 38
GevActionDestinationIPAddress ......................................................................................................... 39

Alvium Features Reference V2.9.1

5

Contents

SystemInformation ...............................................................................................................40
GenTLSFNCVersionMajor .................................................................................................................... 40
GenTLSFNCVersionMinor .................................................................................................................... 41
GenTLSFNCVersionSubMinor .............................................................................................................. 41
GenTLVersionMajor ............................................................................................................................. 42
GenTLVersionMinor ............................................................................................................................. 42
GevVersionMajorNumber ................................................................................................................... 43
GevVersionMinorNumber ................................................................................................................... 43
TLDisplayName .................................................................................................................................... 44
TLID ...................................................................................................................................................... 44
TLModelName ..................................................................................................................................... 45
TLPath .................................................................................................................................................. 45
TLType ................................................................................................................................................. 46
TLVendorName .................................................................................................................................... 46
TLVersion ............................................................................................................................................. 47

CameraAddressForcing ........................................................................................................48
GevDeviceForceGateway .................................................................................................................... 48
GevDeviceForceIP ................................................................................................................................ 48
GevDeviceForceIPAddress ................................................................................................................... 49
GevDeviceForceMACAddress .............................................................................................................. 49
GevDeviceForceSubnetMask ............................................................................................................... 50

InterfaceEnumeration ..........................................................................................................51
InterfaceCount ..................................................................................................................................... 51
InterfaceDisplayName ......................................................................................................................... 51
InterfaceID ........................................................................................................................................... 52
GevInterfaceIPAddress ........................................................................................................................ 52
GevInterfaceIPSubnetMask ................................................................................................................. 53
GevInterfaceMACAddress ................................................................................................................... 53
InterfaceSelector ................................................................................................................................. 54
InterfaceUpdateList ............................................................................................................................. 54

Feature descriptions: Interface ............................................................... 55
ActionControl ........................................................................................................................56
ActionCommand .................................................................................................................................. 56
ActionDeviceKey .................................................................................................................................. 56
ActionGroupKey ................................................................................................................................... 57
ActionGroupMask ............................................................................................................................... 57
ActionScheduledTime .......................................................................................................................... 58
ActionScheduledTimeEnable ............................................................................................................... 58
GevActionDestinationIPAddress ......................................................................................................... 59

DeviceEnumeration ..............................................................................................................60

Alvium Features Reference V2.9.1

6

Contents

DeviceAccessStatus ............................................................................................................................. 60
DeviceCount ........................................................................................................................................ 61
DeviceDisplayName ............................................................................................................................. 61
DeviceDriverPath ................................................................................................................................. 62
DeviceID ............................................................................................................................................... 62
DeviceLocation .................................................................................................................................... 63
DeviceModelName .............................................................................................................................. 63
DeviceSelector ..................................................................................................................................... 64
DeviceType .......................................................................................................................................... 64
DeviceUpdateList ................................................................................................................................. 65
DeviceVendorName ............................................................................................................................. 65

Gev ..................................................................................................................................66
GevDeviceForceGateway .................................................................................................................... 66
GevDeviceForceIP ................................................................................................................................ 67
GevDeviceForceIPAddress ................................................................................................................... 67
GevDeviceForceSubnetMask ............................................................................................................... 68
GevDeviceIPAddress ............................................................................................................................ 68
GevDeviceMACAddress ....................................................................................................................... 69
GevDeviceSubnetMask ........................................................................................................................ 69
GevInterfaceIPAddress ........................................................................................................................ 70
GevInterfaceMACAddress ................................................................................................................... 70
GevInterfaceSubnetMask .................................................................................................................... 71

Settings .................................................................................................................................72
DevicesDiscoveryBroadcastMode ....................................................................................................... 72
DevicesDiscoveryMode ....................................................................................................................... 73
InterfaceBeatRate ............................................................................................................................... 73
InterfaceHailPace ............................................................................................................................... 74
InterfacePingPace .............................................................................................................................. 74

InterfaceInformation ............................................................................................................75
InterfaceDisplayName ......................................................................................................................... 75
InterfaceID ........................................................................................................................................... 75
InterfaceType ...................................................................................................................................... 76

Feature descriptions: Local Device .......................................................... 77
DeviceInformation ................................................................................................................78
DeviceDisplayName ............................................................................................................................. 78

Gev ..................................................................................................................................79
DeviceEndianessMechanism ............................................................................................................... 79
GevDeviceGateway ............................................................................................................................. 80
GevDeviceIPAddress ............................................................................................................................ 80

Alvium Features Reference V2.9.1

7

Contents

GevDeviceMACAddress ....................................................................................................................... 81
GevDeviceSubnetMask ........................................................................................................................ 81

DeviceInformation (category continued) .............................................................................82
DeviceID ............................................................................................................................................... 82
DeviceLocation .................................................................................................................................... 82
DeviceModelName .............................................................................................................................. 83
DeviceType .......................................................................................................................................... 83
DeviceVendorName ............................................................................................................................. 84
DriverPath ........................................................................................................................................... 84

GigE ......................................................................................................................................85
GVCP ................................................................................................................................85
GVCPCmdRetries ................................................................................................................................. 86
GVCPCmdTimeout ............................................................................................................................... 86
GevHeartbeatInterval ......................................................................................................................... 87
GevHeartbeatTimeout ........................................................................................................................ 87

StreamEnumeration .............................................................................................................88
StreamCount ....................................................................................................................................... 88
StreamID .............................................................................................................................................. 89
StreamSelector .................................................................................................................................... 89

Feature descriptions: Camera ................................................................. 90
AcquisitionControl ................................................................................................................91
AcquisitionFrameCount ....................................................................................................................... 91
AcquisitionFrameRate ......................................................................................................................... 92
AcquisitionFrameRateEnable .............................................................................................................. 92
AcquisitionFrameRateMode ............................................................................................................... 93
AcquisitionMode ................................................................................................................................. 94
AcquisitionStart ................................................................................................................................... 94
AcquisitionStatus ................................................................................................................................. 95
AcquisitionStatusSelector .................................................................................................................... 95
AcquisitionStop .................................................................................................................................... 96
ExposureActiveMode ........................................................................................................................... 96
ExposureAuto ...................................................................................................................................... 97
ExposureMode ..................................................................................................................................... 98
ExposureMode - Using TriggerWidth ................................................................................................. 99
ExposureTime .................................................................................................................................... 100
TriggerActivation ............................................................................................................................... 100
TriggerDelay ...................................................................................................................................... 101
TriggerMode ...................................................................................................................................... 102
TriggerSelector .................................................................................................................................. 103

Alvium Features Reference V2.9.1

8

Contents

TriggerSoftware ................................................................................................................................ 104
TriggerSource .................................................................................................................................... 105

ActionControl ......................................................................................................................106
ActionDeviceKey ................................................................................................................................ 106
ActionGroupKey ................................................................................................................................. 107
ActionGroupMask ............................................................................................................................. 108
ActionQueueSize ................................................................................................................................ 109
ActionSelector ................................................................................................................................... 110

AnalogControl .....................................................................................................................111
BalanceRatio ..................................................................................................................................... 111
BalanceRatioSelector ........................................................................................................................ 112
BalanceWhiteAuto ............................................................................................................................ 112
BlackLevel .......................................................................................................................................... 113
BlackLevelSelector ............................................................................................................................. 113
Gain ................................................................................................................................................... 114
GainAuto ........................................................................................................................................... 114
GainSelector ...................................................................................................................................... 115
Gamma .............................................................................................................................................. 115

AutoModeControl ...............................................................................................................116
AutoModeRegionHeight .................................................................................................................... 116
AutoModeRegionOffsetX .................................................................................................................. 116
AutoModeRegionOffsetY ................................................................................................................... 117
AutoModeRegionSelector ................................................................................................................. 117
AutoModeRegionWidth .................................................................................................................... 118
BalanceWhiteAutoRate ..................................................................................................................... 118
BalanceWhiteAutoTolerance ............................................................................................................ 119
ExposureAutoMax ............................................................................................................................. 119
ExposureAutoMin .............................................................................................................................. 120
GainAutoMax .................................................................................................................................... 120
GainAutoMin ..................................................................................................................................... 120
IntensityAutoPrecedence .................................................................................................................. 121
IntensityControllerAlgorithm ............................................................................................................ 121
IntensityControllerOutliersBright ...................................................................................................... 122
IntensityControllerOutliersDark ........................................................................................................ 122
IntensityControllerRate ..................................................................................................................... 123
IntensityControllerRegion ................................................................................................................. 123
IntensityControllerSelector ................................................................................................................ 124
IntensityControllerTarget .................................................................................................................. 124
IntensityControllerTolerance ............................................................................................................. 125

ColorTransformationControl ..............................................................................................126
ColorTransformationEnable .............................................................................................................. 126

Alvium Features Reference V2.9.1

9

Contents

ColorTransformationValue ................................................................................................................ 127
ColorTransformationValueSelector ................................................................................................... 128
Hue .................................................................................................................................................... 129
Saturation .......................................................................................................................................... 130

CorrectionControl ...............................................................................................................131
CorrectionMode ................................................................................................................................ 131
CorrectionSelector ............................................................................................................................. 132
CorrectionSet ..................................................................................................................................... 132
CorrectionSetDefault ......................................................................................................................... 133

CorrectionInfo (subcategory) ........................................................................................134
CorrectionDataSize ............................................................................................................................ 134
CorrectionEntryType .......................................................................................................................... 134

CounterAndTimerControl ...................................................................................................135
CounterDuration ............................................................................................................................... 135
CounterEventActivation .................................................................................................................... 136
CounterEventSource .......................................................................................................................... 137
CounterReset ..................................................................................................................................... 138
CounterResetActivation .................................................................................................................... 138
CounterResetSource .......................................................................................................................... 139
CounterSelector ................................................................................................................................. 140
CounterStatus .................................................................................................................................... 140
CounterTriggerActivation .................................................................................................................. 141
CounterTriggerSource ....................................................................................................................... 142
CounterValue ..................................................................................................................................... 143
CounterValueAtReset ........................................................................................................................ 143
TimerDelay ........................................................................................................................................ 144
TimerDuration ................................................................................................................................... 145
TimerReset ......................................................................................................................................... 145
TimerSelector .................................................................................................................................... 146
TimerStatus ....................................................................................................................................... 146
TimerTriggerActivation ..................................................................................................................... 147
TimerTriggerSource ........................................................................................................................... 148

DeviceControl .....................................................................................................................149
DeviceFamilyName ............................................................................................................................ 149
DeviceFirmwareID ............................................................................................................................. 149
DeviceFirmwareIDSelector ................................................................................................................ 150
DeviceFirmwareVersion .................................................................................................................... 150
DeviceFirmwareVersionSelector ....................................................................................................... 151
DeviceGenCPVersionMajor ............................................................................................................... 151
DeviceGenCPVersionMinor ............................................................................................................... 152
DeviceIndicatorLuminance ................................................................................................................ 152

Alvium Features Reference V2.9.1

10

Contents

DeviceIndicatorMode ........................................................................................................................ 153
DeviceLinkCommandTimeout ........................................................................................................... 153
DeviceLinkSpeed ................................................................................................................................ 154
DeviceLinkThroughputLimit .............................................................................................................. 155
DeviceLinkThroughputLimitMode ..................................................................................................... 156
DeviceManufacturerInfo ................................................................................................................... 156
DeviceModelName ............................................................................................................................ 157
DevicePowerSavingMode .................................................................................................................. 157
DeviceReset ....................................................................................................................................... 158
DeviceSFNCVersionMajor .................................................................................................................. 158
DeviceSFNCVersionMinor .................................................................................................................. 158
DeviceSFNCVersionSubMinor ............................................................................................................ 159
DeviceScanType ................................................................................................................................. 159
DeviceSerialNumber .......................................................................................................................... 160
DeviceStreamChannelPacketSize ...................................................................................................... 160
DeviceTemperature ........................................................................................................................... 161
DeviceTemperatureSelector .............................................................................................................. 161
DeviceTLVersionMajor ...................................................................................................................... 162
DeviceTLVersionMinor ...................................................................................................................... 162
DeviceUserID ..................................................................................................................................... 163
DeviceVendorName ........................................................................................................................... 163
DeviceVersion .................................................................................................................................... 163
TimestampLatch ................................................................................................................................ 164
TimestampLatchValue ...................................................................................................................... 164
TimestampReset ................................................................................................................................ 165

DigitalIOControl ..................................................................................................................166
LineDebounceDuration ...................................................................................................................... 166
LineDebounceMode .......................................................................................................................... 167
LineInverter ....................................................................................................................................... 167
LineMode ........................................................................................................................................... 168
LineSelector ....................................................................................................................................... 168
LineSource ......................................................................................................................................... 169
LineStatus .......................................................................................................................................... 170
LineStatusAll ...................................................................................................................................... 170
SerialHubEnable ................................................................................................................................ 171

SerialHub (subcategory) ................................................................................................172
SerialBaudRate .................................................................................................................................. 172
SerialParityBit .................................................................................................................................... 173
SerialRxData ...................................................................................................................................... 173
SerialRxSize ........................................................................................................................................ 174
SerialRxWaiting ................................................................................................................................. 174

Alvium Features Reference V2.9.1

11

Contents

SerialStopBits ..................................................................................................................................... 175
SerialTxData ...................................................................................................................................... 175
SerialTxLock ....................................................................................................................................... 176
SerialTxRemaining ............................................................................................................................. 177
SerialTxSize ........................................................................................................................................ 177

FileAccessControl ...............................................................................................................178
FileAccessBuffer ................................................................................................................................ 178
FileAccessLength ............................................................................................................................... 178
FileAccessOffset ................................................................................................................................. 179
FileOpenMode ................................................................................................................................... 179
FileOperationExecute ........................................................................................................................ 180
FileOperationResult ........................................................................................................................... 180
FileOperationSelector ........................................................................................................................ 181
FileOperationStatus ........................................................................................................................... 182
FileProcessStatus ............................................................................................................................... 182
FileSelector ........................................................................................................................................ 183
FileSize ............................................................................................................................................... 184
FileStatus ........................................................................................................................................... 184

ImageFormatControl ..........................................................................................................185
BinningHorizontal .............................................................................................................................. 185
BinningHorizontalMode .................................................................................................................... 186
BinningSelector .................................................................................................................................. 187
BinningVertical .................................................................................................................................. 188
BinningVerticalMode ......................................................................................................................... 189
Height ................................................................................................................................................ 189
HeightMax ......................................................................................................................................... 190
OffsetX ............................................................................................................................................... 190
OffsetY ............................................................................................................................................... 191
PixelFormat ....................................................................................................................................... 191
PixelSize ............................................................................................................................................. 192
ReverseX ............................................................................................................................................ 192
ReverseY ............................................................................................................................................ 193
SensorBitDepth .................................................................................................................................. 194
SensorHeight ..................................................................................................................................... 195
SensorWidth ...................................................................................................................................... 195

MultipleRegionControl (subcategory) ...........................................................................196
First overview .................................................................................................................................... 196
Features available with multiple regions ................................................................................... 196
Features disabled by multiple regions ....................................................................................... 196
Multiple region arrangement ........................................................................................................... 197
Free mode ................................................................................................................................... 197
Tile mode .................................................................................................................................... 197

Alvium Features Reference V2.9.1

12

Contents

Horizontal mode ......................................................................................................................... 197
Vertical mode .............................................................................................................................. 198
Rules for region ID numbers ....................................................................................................... 198
Region arrangement modes data at a glance ............................................................................ 199
Values for width, height, and offsets ................................................................................................ 200
Single ROI and AutoModeControl ..................................................................................................... 200
Single ROI .................................................................................................................................... 200
Auto mode regions ..................................................................................................................... 200
MultipleRegionArrangement ............................................................................................................ 201
MultipleRegionEnable ....................................................................................................................... 202
SubRegionHeight ............................................................................................................................... 203
SubRegionMode ................................................................................................................................ 203
SubRegionOffsetX .............................................................................................................................. 204
SubRegionOffsetY .............................................................................................................................. 205
SubRegionSelector ............................................................................................................................. 206
SubRegionWidth ................................................................................................................................ 207

ImageFormatControl (category continued) .......................................................................208
ShutterMode ..................................................................................................................................... 208
Width ................................................................................................................................................. 209
WidthMax .......................................................................................................................................... 209

ImageProcessingControl ....................................................................................................210
AdaptiveNoiseSupressionFactor ....................................................................................................... 210
ColorInterpolation ............................................................................................................................. 211

ContrastControl (subcategory) .....................................................................................212
ContrastBrightLimit ........................................................................................................................... 212
ContrastDarkLimit ............................................................................................................................. 213
ContrastEnable .................................................................................................................................. 213
ContrastShape ................................................................................................................................... 214

ImageProcessingControl (category continued) ..................................................................216
ConvolutionMode .............................................................................................................................. 216
CustomConvolutionValue .................................................................................................................. 217
CustomConvolutionValueSelector ..................................................................................................... 218
Sharpness .......................................................................................................................................... 219

LUTControl ..........................................................................................................................220
LUTEnable .......................................................................................................................................... 220
LUTIndex ............................................................................................................................................ 221
LUTSelector ....................................................................................................................................... 221
LUTValue ........................................................................................................................................... 222
LUTValueAll ....................................................................................................................................... 222

PtpControl ...........................................................................................................................223
PtpClockAccuracy .............................................................................................................................. 223

Alvium Features Reference V2.9.1

13

Contents

PtpClockID ......................................................................................................................................... 224
PtpDataSetLatch ............................................................................................................................... 224
PtpEnable .......................................................................................................................................... 225
PtpGrandmasterClockID .................................................................................................................... 225
PtpOffsetFromMaster ....................................................................................................................... 226
PtpOperationMode ........................................................................................................................... 226
PtpParentClockID .............................................................................................................................. 227
PtpServoStatus .................................................................................................................................. 228
PtpStatus ........................................................................................................................................... 229

SequencerControl ...............................................................................................................230
Functional overview .......................................................................................................................... 230
Configuring the feature adjustments in a set ............................................................................ 230
Configuring the triggering between sets .................................................................................... 230
Controlling triggers to activate sets ........................................................................................... 230
Pseudo code example ....................................................................................................................... 231
SequencerConfigurationMode .......................................................................................................... 232
SequencerFeatureEnable .................................................................................................................. 232
SequencerFeatureSelector ................................................................................................................ 233
SequencerMode ................................................................................................................................ 233
SequencerSetActive ........................................................................................................................... 234
SequencerSetLoad ............................................................................................................................. 234
SequencerSetSave ............................................................................................................................. 235
SequencerSetSelector ........................................................................................................................ 235
SequencerSetStart ............................................................................................................................. 236

SequencerPathControl (subcategory) ...........................................................................237
SequencerPathSelector ..................................................................................................................... 237
SequencerSetNext ............................................................................................................................. 238
SequencerTriggerActivation .............................................................................................................. 238
SequencerTriggerSource ................................................................................................................... 239

SoftwareSignalControl ........................................................................................................241
SoftwareSignalPulse .......................................................................................................................... 241
SoftwareSignalSelector ..................................................................................................................... 242

TestControl .........................................................................................................................243
TestPendingAck ................................................................................................................................. 243

TransferControl ..................................................................................................................244
TransferControlMode ........................................................................................................................ 244
TransferQueueCurrentBlockCount .................................................................................................... 245
TransferQueueMaxBlockCount ......................................................................................................... 245
TransferSelector ................................................................................................................................ 246

TransportLayerControl .......................................................................................................247

Alvium Features Reference V2.9.1

14

Contents

GigEVision .....................................................................................................................247
GevCurrentDefaultGateway .............................................................................................................. 247
GevCurrentIPAddress ........................................................................................................................ 248
Priorities for assigning IP addresses ................................................................................................. 248
GevCurrentIPConfigurationDHCP ...................................................................................................... 249
GevCurrentIPConfigurationLLA ......................................................................................................... 250
GevCurrentIPConfigurationPersistentIP ............................................................................................ 251
GevCurrentSubnetMask .................................................................................................................... 252
GevIPConfigurationStatus ................................................................................................................. 252
GevMACAddress ................................................................................................................................ 253
GevPersistentDefaultGateway .......................................................................................................... 253
GevPersistentIPAddress ..................................................................................................................... 253
GevPersistentSubnetMask ................................................................................................................ 254
GevSCPSPacketSize ............................................................................................................................ 254

TransportLayerControlControl (category continued) ........................................................255
PayloadSize ........................................................................................................................................ 255

Info (subcategory) .........................................................................................................256
CSI2ClockFrequency .......................................................................................................................... 256
CSI2DriverInterfaceVersion ............................................................................................................... 256
CSI2LaneCount .................................................................................................................................. 257
LibcsiVersion ...................................................................................................................................... 257
CSI2DriverVersion .............................................................................................................................. 257
PacketCount ...................................................................................................................................... 258
PacketSize .......................................................................................................................................... 258

UserSetControl ...................................................................................................................259
UserSetDefault .................................................................................................................................. 259
UserSetLoad ...................................................................................................................................... 260
UserSetSave ....................................................................................................................................... 260
UserSetSelector ................................................................................................................................. 261

Feature descriptions: Stream 0 ............................................................. 262
BufferHandlingControl .......................................................................................................263
MaxDriverBuffersCount ..................................................................................................................... 263
StreamAnnounceBufferMinimum ..................................................................................................... 264
StreamAnnouncedBufferCount ......................................................................................................... 264
StreamBufferHandlingMode ............................................................................................................. 265

Stream ................................................................................................................................266
Info (subcategory) .........................................................................................................266
GVSPFilterCompatibility .................................................................................................................... 267
GVSPFilterVersion .............................................................................................................................. 267

Alvium Features Reference V2.9.1

15

Contents

Multicast (subcategory) ................................................................................................268
MulticastEnable ................................................................................................................................ 268
MulticastIPAddress ........................................................................................................................... 269

Settings (subcategory) ..................................................................................................270
GVSPAdjustPacketSize ....................................................................................................................... 270
GVSPBurstSize ................................................................................................................................... 271
GVSPDriverSelector ........................................................................................................................... 271
GVSPHostReceiveBufferSize .............................................................................................................. 272
GVSPMaxLookBack ........................................................................................................................... 272
GVSPMaxRequests ............................................................................................................................ 273
GVSPMaxWaitSize ............................................................................................................................. 273
GVSPMissingSize ............................................................................................................................... 274
GVSPPacketSize ................................................................................................................................. 274
GVSPTiltingSize .................................................................................................................................. 275
GVSPTimeout ..................................................................................................................................... 275

Statistics (subcategory) .................................................................................................276
StatFrameDelivered ........................................................................................................................... 276
StatFrameDropped ............................................................................................................................ 277
StatFrameRate .................................................................................................................................. 277
StatFrameRescued ............................................................................................................................ 278
StatFrameShoved .............................................................................................................................. 278
StatFrameUnderrun .......................................................................................................................... 279
StatLocalRate .................................................................................................................................... 279
StatPacketErrors ................................................................................................................................ 280
StatPacketMissed .............................................................................................................................. 280
StatPacketReceived ........................................................................................................................... 281
StatPacketRequested ........................................................................................................................ 281
StatPacketResent .............................................................................................................................. 282
StatPacketUnavailable ...................................................................................................................... 282
StatTimeElapsed ................................................................................................................................ 283

StreamInformation .............................................................................................................284
StreamID ............................................................................................................................................ 284
StreamIsGrabbing ............................................................................................................................. 284
StreamType ....................................................................................................................................... 285

Statistics (subcategory) .................................................................................................286
StatFrameRate .................................................................................................................................. 286
StatFrameCRCError ........................................................................................................................... 287
StatFrameDelivered ........................................................................................................................... 287
StatFrameIncomplete ........................................................................................................................ 288
StatFrameUnderrun .......................................................................................................................... 288

Alvium Features Reference V2.9.1

16

Contents

Index ....................................................................................................... 289

Alvium Features Reference V2.9.1

17Document history and conventions

This chapter includes:
Document history ................................................................. 19
Conventions used in this document ..................................... 25
Copyright and trademarks .................................................... 29

Alvium Features Reference V2.9.1

18Document history and conventions

Document history
Version Date
V2.9.12023-Jun-16

Document updates• Updated graphic in Image data flow on page 31.
• Added GigE support for TestPendingAck in
TestControl on page 243.

V2.9.0Firmware version: 00.12.00.00611a22

2023-Jun-07

•
•

•

•
•

Updated version for supported GigE Vision
Standard from 1.2 to 2.2.
Removed entry for document V2.7.1 in this listthat stated the support of TestPattern. This
information was wrong and still is. Therefore, thisdocument never included descriptions for thisfeature.
Adjusted document structure to match Vimba X
Viewer. This includes:- Added information related to What else do
you need? on page 3.
- Added Feature descriptions: Transport Layeron page 35.
- Added Feature descriptions: Interface on page55.
- Added Feature descriptions: Local Device on
page 77.
- Renamed previous “Feature descriptions” toFeature descriptions: Camera on page 90.
- Added Feature descriptions: Stream 0 on page262.
- Moved categories from previous “Featuredescriptions” to new “Feature descriptions...”chapters.
Note: You can find categories and features inContents on page 5 and PDF bookmarks, or in
Index on page 289.
- Removed contents about Config mode for IP
settings.
- Updated diagrams in Notes on featuredescription on page 30 for multiple regions.
Updated information in Differences in featuresand values on page 3.
Updated origin of feature for selected features in
Feature descriptions: Camera on page 90.

Continued on next page.
Table 2: Document history (Sheet 1 of 6)

Alvium Features Reference V2.9.1

19Document history and conventions

Version Date
V2.9.02023-May-24

Document updates
Continued from previous page.
•

V2.8.1V2.8.02022-Nov-14
2022-Oct-27

Removed unit from CounterDuration inCounterAndTimerControl on page 135.
• Changed interface support for
LineDebounceDuration and LineDebounceModein DigitalIOControl on page 166.
• Added SerialTxLock to SerialHub (subcategory)on page 172.
• Added Sensor option to BinningSelector in
ImageFormatControl on page 185.
• Added MultipleRegionControl (subcategory) on
page 196.
• Added LUTValueAll in LUTControl on page 220.
• Removed LUTEnable from affected features andaligned the corresponding lists between
SequencerSelector and SequencerSetLoad in
SequencerControl on page 230.
• Removed plural S for StatFrame... and
StatPacket... features in Stream on page 266 andStreamInformation on page 284.
• Applied editorial changes.
Updated the title image.
Firmware version: 00.11.00.9cf0c21e• Updated standard references in Standards
referred to in this document on page 26.
• Updated Pseudo code example on page 167 forSequencerControl.
• Updated options for TriggerSource inAcquisitionControl on page 28, forTimerTriggerSource inCounterAndTimerControl on page 75, for
LineSource in DigitalIOControl on page 106, andfor SequencerTriggerSource inSequencerControl on page 166.
• Added features support for ActionControl on page
43 by Alvium G1 cameras.
• Added options for DeviceTemperatureSelector
in DeviceControl on page 89.
• Added Line Debounce features in DigitalIOControl
on page 106.
Continued on next page.

Table 2: Document history (Sheet 2 of 6)

Alvium Features Reference V2.9.1

20Document history and conventions

Version Date
V2.8.02022-Oct-27

Document updates
Continued from previous page.
••V2.7.22022-Jul-20

V2.7.12022-Jul-15

Removed ChunkDataControl category.
Added Counter features toCounterAndTimerControl on page 75.
• Updated options for SoftwareSignalSelector on
page 178.
• Added TransferControl on page 202 for burst
image aquisition.
• Applied editorial changes.
• Added notes that ActionControl features are
not working properly on Alvium G1 cameras yet.
Firmware versions• Alvium CSI-2, G5, USB: 00.10.6c9062b1• Alvium G1: 00.10.00.2cf3b22e
Applied changes• Added options for TriggerSource inAcquisitionControl on page 28.
• Added feature support for Alvium G5 in:- ActionControl on page 43- GVCP (subcategory) on page 128- PtpControl on page 159.
• Added feature support for Alvium USB cameras in
ChunkDataControl.
• Added options for TimerTriggerSource inCounterAndTimerControl on page 75.
• Added support for all Alvium cameras andreorganized features in SerialHub (subcategory) on
page 112.
• Added options to FileSelector in
FileAccessControl on page 117.
• Added TestPattern in ImageFormatControl on
page 134.
• Added features in SequencerControl on page 166.
• Added features in SoftwareSignalControl on page177.
• Removed ColorTransformationSelector from
ColorTransformationControl on page 66.
Applied editorial changes.

Table 2: Document history (Sheet 3 of 6)

Alvium Features Reference V2.9.1

21

Document history and conventions

Version Date
V2.7.02022-Jun-09

V2.6.12022-Mar-28

V2.6.02022-Mar-21

Document updates
Firmware versions• Alvium CSI-2, G5,USB: 00.08.00.6727174b• Alvium 1500 C-050, C-120, C-210, C -500, and1800 C-500: 00.08.01.13f227a4• Alvium G1: 00.09.00.45ce470f
Applied changes• Added support for Alvium G1 and G5 models.
• Added features in ActionControl on page 43.
(Currently available for Alvium G1 only)• Added features in SerialHub (subcategory) on
page 112. (Currently available for Alvium G1 only)• Added features in GVCP (subcategory) on page128. (Currently available for Alvium G1 only)• Added features in PtpControl on page 159.
(Currently available for Alvium G1 only)• Updated diagrams in AcquisitionControl on page
28 for GigE cameras.
• Applied editorial changes.
Added Timer0Active and Timer1Active options for
LineSource.
Firmware version: 00.08.00.6727174b• Added support for selected Alvium 1800 C
models.
• Updated diagrams in AcquisitionControl on page
28 for convolution filters.
• Added the CounterAndTimerControl category.
• Added AcquitisitonFrameRateMode,
ExposureActiveMode and SensorBitDepth.
• Added features to control convolution filters in the
ImageProcessingControl category.
• Added individual options UserSet1 to UserSet4
and descriptions to the UserSetControl
category.
• Added features that are specific to MPI CSI-2,
including the subcategories
StreamInformation/Statistics andTransportLayerControl/Info.
• Applied editorial changes.

Table 2: Document history (Sheet 4 of 6)

Alvium Features Reference V2.9.1

22Document history and conventions

Version Date
V2.5.02021-Dec-07

V2.4.12021-Sep-22

V2.4.02021-Aug-04

V2.3.0.

2021-Apr-07

Document updates
Firmware version: 00.07.00.81db3896• Updated diagrams in AcquisitionControl on page
28 for new LUT and Sharpness features.
• Added descriptions for Sharpness,
TriggerDelay, and LUT features.
• Removed descriptions forContrastConfigurationMode.
• Added information on using ExposureMode.
• Removed FitRange option from
IntensityControllerAlgorithm.
Firmware version: 00.06.00.35992• Updated Figure 2: Image data flow for Alvium
cameras on page 31.
• Added feature descriptions for
BinningHorizontal, BinningHorizontalMode,
BinningSelector, BinningVertical,
BinningVerticalMode, andDevicePowerSavingMode.
• Applied editorial changes.
Firmware version: 00.04.00.34658• Added feature descriptions for
DeviceLinkCommandTimeout,
DeviceTLVersionMajor,
DeviceTLVersionMinor, TimestampLatch,
TimestampLatchValue, TimestampReset.

V2.2.02020-Nov-13

V2.1.22020-Jun-05

V2.1.1V2.1.02020-Mar-12
2020-Feb-13• Applied editorial changes.
Firmware version: 00.03.00.31919• Added descriptions in AcquisitionControl on page28.
• Added User option to CorrectionSet andCorrectionSetDefault for defect pixel
correction.
• Applied editorial changes.
Corrected naming for the
IntensityAutoPrecedence feature.
Removed notes for features previously enabled.
• Added contents for maximum values for contrast
features.
• Added ShutterMode to the feature descriptions.

Table 2: Document history (Sheet 5 of 6)

Alvium Features Reference V2.9.1

23

Document history and conventions

Version Date
V2.0.02020-Jan-07

V1.0.3
V1.0.2
V1.0.1V1.0.02019-Sep-05
2019-Jul-08
2019-Jul-05
2019-Jul-01

Document updates
Firmware version: 00.01.02.28100• Added descriptions for Contrast, Gamma, Hue,
Saturation features, and ExposureActive
option for TriggerSelector.
• Reorganized feature categories.
• Added information on related selectors.
• Reorganized introduction chapters.
• Corrected typographical errors.
Applied editorial changes.
Applied editorial changes.
Applied editorial changes.
Associated firmware version: 00.01.00.26405
Release version

Table 2: Document history (Sheet 6 of 6)

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

StylesStyle (example)

Function

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

Features names

Features names are displayed as monospaced text.

Features options

Features options and values that are selectable by the user are displayed as
monospaced italicized text.

Non-standard
features options

Marked with superscript (1) are features that complement the features definedin the SFNC.

InputCommand

Text or command to type in by the user, selected menu options, or otherselectable options.

SourceCode

Code words, such as for programs, used in running text. Mainly designated foruse in software documentation.

UIElement

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.

WebReference

References to other documents or webpages, like weblinks, hypertext links, oremails.
Table 3: Markup conventions used in this reference

Alvium Features Reference V2.9.1

24

Document history and conventions

Symbols and notes
Practical tip
Additional information helps to understand or ease handling the camera.

i

Additional information
Web address or reference to an external source with more information is shown.
Avoiding malfunctions
Precautions are described.

AccessAcronym
R/W
R/(W)
R/C
R
ROI
W

MeaningFeature is read/write.
Feature is readable, and it may be read/write, depending
upon the user privilege level.
Feature is read-only and constant.
Feature is read-only and may change.
Region of interest
Feature is write-only.

Table 4: Abbreviations used in this referenceStandards referred to in this document
The document describes in alphabetical order the basic and advanced camera
controls for Allied Vision Alvium cameras as seen from Vimba Viewer.
These features comply with the following standards:• GigE Vision Standard Version 2.2• USB3 Vision Standard Version 1.1• GenICam Standard Document Version 2.1.1• GenICam Standard Features Naming Convention (SFNC) Version 2.7• GenICam Pixel Format Naming Convention (PFNC) Version 2.2• GenICam Transport Layer Standard Features Naming Convention(GenTL SFNC)- CSI-2: Version 1.2.0- GigE: Version 1.1.1- USB: Version 1.0.0• GenICam Generic Control Protocol (GenCP) Version 1.3

Alvium Features Reference V2.9.1

25

Document history and conventionsi

Downloads of applied common standards
For SFNC, GenTL SFNC, and GenCP, see www.genicam.org
For USB3 Vision and PFNC, see www.visiononline.org
Allied Vision custom features
Some features in this document are adapted SFNC features. Some features arecustom features adding new functions to the features range defined by the SFNC.
See Acronyms and terms on page 27.

Acronyms and terms
Abbreviation/term
CustomGenTL SFNCGenTL SFNC
adaptedGEVSFNC
SFNC adapted
U3V

Meaning
Non-SFNC features that are adding to new functions to
the existing SFNC feature definitions
GenICam Transport Layer Standard Features Naming
Convention
Features that deviate from the GenTL SFNC definition
GigE Vision Standard
GenICam Standard Features Naming Convention
Features that deviate from the SFNC definition
USB3 Vision Standard

Table 5: Standards used in this reference

Description scheme
This document is organized from GenTL Modules down to categories and features,in alphabetical order. For the structure in Vimba X Viewer, see Finding features on
page 2.
The features in this reference are described according to the following formatting
scheme.

Category nameFirst-level item, always starting a new page. Short description of category, including
individual characteristics, and showing the Feature type as (Category).

Subcategory
Second-level item. Short description of subcategory, including individual
characteristics, and showing the Feature type as (Category).

Alvium Features Reference V2.9.1

26

Document history and conventions

Feature[Selector]
Second-level or third-level item. Short description of feature, including individual
characteristics and possible values, and showing the full Category path.

Features availability
Some features are available for one camera interface only. Other features differ
between camera interfaces. AcquisitionFrameCount is supported for all
interfaces. If a feature is supported for some interfaces only, the Interface support
is stated.

AcquisitionFrameCount
Controls the number of frames to acquire in MultiFrame acquisition mode.
Interface support
Display nameStandard
Origin of feature
Feature type
AccessUnit
Affected features
CategoryAll
Acquisition Frame Count
SFNC
CameraInteger
R/W(number)
Not applicable/AcquisitionControl

Selectors
Some features have multiple instances. For these features, Selector features define
which instance of the feature is accessed.
Example: the LineInverter feature, used to invert internal signal polarity, can beapplied to all input and output lines of the camera. The line is selected by the
LineSelector feature.
The headline for the feature description is LineInverter[LineSelector],
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, Sharpness enhances edge
contrast while Blur reduces edge contrast. Therefore, when Sharpness isenabled, Blur is automatically disabled. Feature descriptions provide an additionalrow for opposing features, called Affected features.

Alvium Features Reference V2.9.1

27

Document history and conventions

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 Technologies GmbH. All rights reserved.

Alvium Features Reference V2.9.1

28

Notes on feature description

This chapter includes:
Image data flow..................................................................... 31
Feature interdependencies................................................... 32
Regions of interest and auto mode regions ......................... 33

Alvium Features Reference V2.9.1

30

Notes on feature description

Image data flow

To develop your application effectively, note the order in which the features areprocessed in Alvium cameras.
In the Alvium user guides, the image data flow describes the sequence of image
processing steps inside the camera. The shown functionalities represent features
or feature groups.

SensorSensor binning
H/V1

Sensor frontend
AnalogRegion of interest(ROI)

Reverse Y
AnalogAnalogSingle
ROI

ADC

FPNC4
n-bit3

White balance6

n-bit3n-bit3

Reverse X
n-bit3De-Bayering6
Y,U,V7

12

Hue6
R,G,B6

n-bit3

ConvoluƟoŶĮůter
R,G,B6

R,G,B612

5x5

Color transform
matrix6

AnalogDigital verƟcal
Binning
n-bit3n-bit3Black level
Analog2

3 Look up tables(LUTs)

Gamma

Contrast
n-bit3

Multiple
ROI

Digital horizontal
binning

DPC5
n-bit3

Gain
AnalogAdaptive
noise filter

Customconvolution

Sharpness/
Blur

SaturaƟŽŶ6
R,G,B6

R,G,B6

Pixel formaƩer

CSI-2 Interface
CSI-2

GenICam for CSI-2

USB

GenICam for USB

GigE

GigE Vision
streaming engine

USB bƵīer

USB 3.0 interface

1000BASE-T
interface
MAC (Media
Access Control)

Frame memory8

1 Selected monochrome models only: See your Alvium camera’s user guide.
2 Selected models only: See your Alvium camera’s user guide.
3 Model dependent: See ADC bit depths stated in your Alvium camera’s user guide.
4 Factory preset for FPNC = Fixed Pattern Noise Correction. For model availability, see yourAlvium camera’s user guide.
Factory preset for DPC = Defect pixel correction
6 Color models only
7 For monochrome models: Y only
8 Referred to as Image buffer in the feature descriptions.
5

Figure 2: Image data flow for Alvium cameras

Alvium Features Reference V2.9.1

31

Notes on feature description

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 3 shows the interdependencies.
Set First

PixelFormat
SensorBitDepth

USB and GigE
DeviceLinkThroughputLimit
BlackLevel
ZeverseX/Y
Binning Seƫngs
^ŝŶŐůĞͬDƵůƟƉůĞZOI Seƫngs

Set Last

ExposureTime
AcquisiƟonFrameZate

May interact

Figure 3: Interdependencies between features

Alvium Features Reference V2.9.1

32

Notes on feature description

Regions of interest and auto mode regions
Multiple regions
See descriptions in MultipleRegionControl (subcategory) on page 196.
Generally, auto mode regions are areas or regions on the image, where
measurements are done to be used by various auto-features, for example
measurement of the intensity for auto-exposure control.
The features used to define area of regions of interest (ROIs) and auto mode
regions are displayed in Figure 4.

AutoModeRegionOīsetY

AutoModeRegionHeight

Sensor height (Feature ImageFormatControl / Height)

Sensor width (Feature ImageFormatControl / Width)

AutoModeRegionOīsetX

Sensor area

AutoModeRegion

AutoModeRegionWidth

Figure 4: auto mode region and ROI measurement features
It is possible to have multiple auto mode regions. Also, multiple sensor-ROIs aresupported that are called DisplayROI in this document. A DisplayROI covers thearea that is being transmitted by the camera subsystem.
The interaction of auto mode regions and ROIs would allow for a huge variety ofpossibilities. However, the actual interaction is limited to a few useful possibilities
that practically make sense.

Basic rules••

Auto mode regions must be explicitly enabled by a feature.
One auto mode region inside a ROI is permitted. This provides a fixed
correlation between ROI and auto mode region.

Alvium Features Reference V2.9.1

33

Notes on feature description

•
•
•
•

Auto mode region and ROI coordinates are absolute to the sensor area. If the
ROI position is changed, the position of the auto mode region is maintained.
The auto mode region represents the content changed by shifting the ROI.
The auto mode region must be inside the respective ROI.
If auto mode regions are enabled, the position and size are set to the same
position and size of the respective ROI. This means that disabling and reenabling the auto mode regions resets their positions and sizes.
If ROI is changed, auto mode region may need to be adjusted. To do so, set theposition before you set the size.
Therefore, as long as the origin of the auto mode region remains inside the
ROI, the position and size of the auto mode region can be maintained.
To ensure no part of the auto mode region is outside the ROI, the size of the
auto mode region is adjusted until the minimum allowed size is reached.
Only then the position may be altered.

ROI and auto mode region effects
Auto mode region is always treated as a subset of ROI. The following scenarios
show the interaction between ROI and auto mode region and gives
recommendations where auto mode region settings can be improved. Vice versa,
you can adjust settings for ROI to match an existing auto mode region.
A

B

Full sensor area

Full sensor area
ROI

C
Full sensor area
ROI

ROI

Auto mode
regionAuto mode
regionAuto mode
regionFigure 5: ROI and auto mode region effects
A. Scenario: User input creates an auto mode region included by a larger ROI.
Result: Camera logic applies no changes to the selected auto mode region.
The complete auto mode region is effective.
B. Scenario: User input creates a common area between ROI and auto mode
region is only small.
Result: Camera logic reduces the effective auto mode region to the common
area between auto mode region and ROI.
Recommendation: Relocate and resize auto mode region to become a subset
of or to match ROI.
C. Scenario: User input creates ROI and auto mode region that have no common
area.
Result: Camera logic reduces the effective auto mode region to 0.
Recommendation: Relocate and resize auto mode region to become a subset
or to match ROI.

Alvium Features Reference V2.9.1

34

Feature descriptions: Transport Layer

This chapter includes:
ActionControl ........................................................................ 36
SystemInformation................................................................ 40
CameraAddressForcing ......................................................... 48
InterfaceEnumeration ........................................................... 51

Alvium Features Reference V2.9.1

35

Feature descriptions: Transport Layer

ActionControl
The features in this category can be used to send (scheduled) action commands to
GigE cameras.
Interface support

GigE

Display name

Action Control

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)

ActionCommandSends an action command.
Interface support

GigE

Display name

Action Command

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature typeCommandAccessW

Affected features

Not applicable

Category/ActionControl

ActionDeviceKeyControlss the device key for an action command to be sent.
Note: This parameter must have the same value for all devices in a group.
Interface support

GigE

Display name

Action Device Key

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

36

Feature descriptions: Transport Layer

ActionGroupKey
Controls the group key for an action command to be sent.
Note: This parameter must have the same value for all devices in a group.
Interface support

GigE

Display name

Action Group KeyStandard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

4294967295

Maximum value

ActionGroupMask
Controls the group mask for an action command to be sent.
Note: This parameter must have the same value for all devices in a group.
Interface support

GigE

Display name

Action Group Mask

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

37

Feature descriptions: Transport Layer

ActionScheduledTime
Controls the time in a time-enabled action command.
Interface support

GigE

Display name

Action Scheduled Time

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

ActionScheduledTimeEnable
Enables or disables time-enabled action commands.
Interface support

GigE

Display name

Action Scheduled Time Enable

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

BooleanAccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription

True

Scheduled action command are enabled.

False

Scheduled action commands are disabled (default).

Alvium Features Reference V2.9.1

38

Feature descriptions: Transport Layer

GevActionDestinationIPAddress
Controls the IP address for an action command to be sent.
Interface support

GigE

Display nameGev Action Destination IP Address

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

39

Feature descriptions: Transport Layer

SystemInformation
The features in this category can be used to display versions of the used GenTL and
GenTL SFNC, and to identify the GenTL Producer.
Interface support

All

Display name

System Information

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)

GenTLSFNCVersionMajor
Displays the major version number of the GenTL Standard Features Naming
Convention that was used to create the GenTL Producer's XML.
Interface support

USB

Display name

Gen TL SFNC Version Major

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/SystemInformation

ValuesDescription-9223372036854775808

Minimum value

9223372036854775807

Maximum value

Alvium Features Reference V2.9.1

40

Feature descriptions: Transport Layer

GenTLSFNCVersionMinor
Displays the minor version number of the GenTL Standard Features Naming
Convention that was used to create the GenTL Producer's XML.
Interface support

USB

Display name

Gen TL SFNC Version Minor

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/SystemInformation

ValuesDescription-9223372036854775808

Minimum value

9223372036854775807

Maximum value

GenTLSFNCVersionSubMinor
Displays the sub minor version number of the GenTL Standard Features Naming
Convention that was used to create the GenTL Producer's XML.
Interface support

USB

Display name

Gen TL SFNC Version Sub Minor

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/SystemInformation

ValuesDescription-9223372036854775808

Minimum value

9223372036854775807

Maximum value

Alvium Features Reference V2.9.1

41

Feature descriptions: Transport Layer

GenTLVersionMajor
Displays the major version number of the GenTL specification the GenTL Producer
implementation complies with.
Interface support

All

Display name

Gen TL Version Major

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/SystemInformation

ValuesDescription0

Minimum value

4294967295

Maximum value

GenTLVersionMinor
Displays the minor version number of the GenTL specification the GenTL Producer
implementation complies with.
Interface support

All

Display name

Gen TL Version Minor

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/SystemInformation

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

42

Feature descriptions: Transport Layer

GevVersionMajorNumber
Displays the major version number of the GigE Vision specification the GenTL
Producer implementation complies to.
Interface support

GigE

Display nameGev Version Major Number

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/SystemInformation

ValuesDescription-9223372036854775808

Minimum value

9223372036854775807

Maximum value

GevVersionMinorNumber
Displays the minor version number of the GigE Vision specification the GenTL
Producer implementation complies to.
Interface support

GigE

Display nameGev Version Minor Number

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/SystemInformation

ValuesDescription-9223372036854775808

Minimum value

9223372036854775807

Maximum value

Alvium Features Reference V2.9.1

43

Feature descriptions: Transport Layer

TLDisplayName
Displays the user readable name of the GenTL Producer.
This features corresponds to the TL_INFO_DISPLAYNAME command of TLGetInfo
function.
Interface support

All

Display name

TL Display Name

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/SystemInformation

TLID
Displays the Unique identifier of the GenTL Producer like a GUID.
This feature corresponds to the TL_INFO_ID command of TLGetInfo function.
Interface support

All

Display name

TL ID

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/SystemInformation

Alvium Features Reference V2.9.1

44

Feature descriptions: Transport Layer

TLModelName
Displays the name of the GenTL Producer to distinguish different kinds of GenTL
Producer implementations from one vendor.
This feature corresponds to the TL_INFO_MODEL command of TLGetInfo function.
Interface support

All

Display name

TL Model Name

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/SystemInformation

TLPathDisplays the full path to the GenTL Producer driver including name and extension.
This feature corresponds to the TL_INFO_PATHNAME command of TLGetInfo
function.
Interface support

All

Display nameTL PathStandard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/SystemInformation

Alvium Features Reference V2.9.1

45

Feature descriptions: Transport Layer

TLTypeDisplays the transport layer type of the GenTL Producer implementation.
Corresponds to the TL_INFO_TLTYPE command of TLGetInfo function.
Interface support

All

Display nameTL TypeStandard

Gen TL SFNC adapted

Origin of feature

Transport layer

Feature type

StringAccessEnumeration

Affected features

Not applicable

Category/SystemInformation

ValuesDescription

CustomMIPI CSI-2

GigEVision

GigE Vision

USB3Vision

USB3 Vision

TLVendorName
Displays the name of the GenTL Producer vendor.
This feature corresponds to the TL_INFO_VENDOR command of TLGetInfo
function.
Interface support

All

Display name

TL Vendor Name

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/SystemInformation

Alvium Features Reference V2.9.1

46

Feature descriptions: Transport Layer

TLVersion
Displays the vendor specific version string.
This feature corresponds to the TL_INFO_VERSION command of TLGetInfo
function.
Interface support

All

Display name

TL Version

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/SystemInformation

Alvium Features Reference V2.9.1

47

Feature descriptions: Transport Layer

CameraAddressForcing
This category contains system features to force access for cameras that areotherwise not detected.
Interface support

GigE

Display name

Camera Address Forcing

Standard

CustomOrigin of feature

Transport layer

Feature type

(Category)

GevDeviceForceGateway
Controls the gateway of the GEV camera to be forced.
Interface support

GigE

Display nameGev Device Force Gateway

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/CameraAddressForcing

ValuesDescription0

Minimum value

4294967295

Maximum value

GevDeviceForceIP
Sends the force address command on all interfaces.
Interface support

GigE

Display nameGev Device Force IP

Standard

CustomOrigin of feature

Transport layer

Feature typeCommandAccessW

Affected features

Not applicable

Category/CameraAddressForcing

Alvium Features Reference V2.9.1

48

Feature descriptions: Transport Layer

GevDeviceForceIPAddress
Controls the IP address of the GEV camera to be forced.
Interface support

GigE

Display nameGev Device Force IP Address

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/CameraAddressForcing

ValuesDescription0

Minimum value

4294967295

Maximum value

GevDeviceForceMACAddress
Controls the 48-Bit MAC address of the GEV camera to force the IP setup.
Interface support

GigE

Display nameGev Device Force MAC Address

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/CameraAddressForcing

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

Alvium Features Reference V2.9.1

49

Feature descriptions: Transport Layer

GevDeviceForceSubnetMask
Controls the subnet mask of the GEV camera to be forced.
Interface support

GigE

Display nameGev Device Force Subnet Mask

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/CameraAddressForcing

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

50

Feature descriptions: Transport Layer

InterfaceEnumeration
The features in this category can be used for interface enumeration of the systemmodule.
Interface support

All

Display nameInterface Enumeration

Standard

CustomOrigin of feature

Transport layer

Feature type

(Category)InterfaceCount
Displays the number of interfaces on the corresponding GenTL Producer.
Interface support

All

Display nameInterface Count

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/InterfaceEnumeration

InterfaceDisplayName[InterfaceSelector]
Displays the user readable name of the selected interface.
Interface support

All

Display nameInterface Display Name

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/InterfaceEnumeration

Alvium Features Reference V2.9.1

51

Feature descriptions: Transport Layer

InterfaceID[InterfaceSelector]
Displays the GenTL Producer wide unique identifier of the selected interface.
Interface support

All

Display nameInterface ID

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/InterfaceEnumeration

GevInterfaceIPAddress[InterfaceSelector]
Displays the IP address of the interface.
Interface support

GigE

Display nameInterface IP Address

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/InterfaceEnumeration

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

52

Feature descriptions: Transport Layer

GevInterfaceIPSubnetMask[InterfaceSelector]
Displays the subnet mask of the interface.
Interface support

GigE

Display nameInterface IP Subnet Mask

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/InterfaceEnumeration

ValuesDescription0

Minimum value

4294967295

Maximum value

GevInterfaceMACAddress[InterfaceSelector]
Displays the 48-Bit MAC of the interface.
Interface support

GigE

Display nameInterface IP Subnet Mask

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/InterfaceEnumeration

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

Alvium Features Reference V2.9.1

53

Feature descriptions: Transport Layer

InterfaceSelector
Selects the GenTL Producer interface.
Interface support

All

Display nameInterface Selector

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/InterfaceEnumeration

ValuesDescription≥0

Value range

InterfaceUpdateList
Updates the interface list on this GenTL Producer.
Interface support

All

Display nameInterface Update List

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature typeCommandAccessR

Affected features

Not applicable

Category/InterfaceEnumeration

Alvium Features Reference V2.9.1

54

Feature descriptions: Interface

This chapter includes:
ActionControl ........................................................................ 56
DeviceEnumeration............................................................... 60
Settings.................................................................................. 72
InterfaceInformation............................................................. 75

Alvium Features Reference V2.9.1

55

Feature descriptions: Interface

ActionControl
This category contains all Action Control features of the Interface module.
Interface support

GigE

Display name

Action Control

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)

ActionCommand
Creates an action command.
Interface support

GigE

Display name

Action Command

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature typeCommandAccessW

Affected features

Not applicable

Category/ActionControl

ActionDeviceKey
Creates the Action Command Device Key to use in the action command.
Note: This parameter must have the same value for all devices in a group.
Interface support

GigE

Display name

Action Device Key

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category

ActionControl

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

56

Feature descriptions: Interface

ActionGroupKey
Creates the Action Command Group Key to use in the action command.
Note: This parameter must have the same value for all devices in a group.
Interface support

GigE

Display name

Action Group KeyStandard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

4294967295

Maximum value

ActionGroupMask
Creates the Action Command Group Mask to use in the action command.
Note: This parameter must have the same value for all devices in a group.
Interface support

GigE

Display name

Action Group Mask

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

57

Feature descriptions: Interface

ActionScheduledTime
Controls the time for a time-enabled action command.
Interface support

GigE

Display name

Action Scheduled Time

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

ActionScheduledTimeEnable
Enables or disables time-enabled action commands.
Interface support

GigE

Display name

Action Scheduled Time Enable

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

Alvium Features Reference V2.9.1

58

Feature descriptions: Interface

GevActionDestinationIPAddress
Controls the destination IP address for the action command.
Note: This can be any valid destination address (including broadcast addresses forthis interface).
Interface support

GigE

Display nameGev Action Destination IP Address

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

59

Feature descriptions: Interface

DeviceEnumeration
This category contains all Device Enumeration features of the Interface module.
Interface support

All

Display name

Device Enumeration

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)

DeviceAccessStatus
Displays the device's access status at the moment of the last execution of
DeviceUpdateList.
Interface support

All

Display name

Device Access Status

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Enumeration

AccessR

Affected features

Not applicable

Category/DeviceEnumeration

ValuesDescription

Unknown

Producer is unknown.

ReadWrite

Full access

ReadOnly

Read-only accessNo accessNo connection available

Busy

The device has been opened by another entity already.

OpenReadWrite

The device has been opened in Read/Write mode by this
GenTL host.

OpenreadOnly

The device has been opened in Read only mode by this
GenTL host.

Alvium Features Reference V2.9.1

60

Feature descriptions: Interface

DeviceCount
Displays the number of found devices
Interface support

All

Display name

Device Count

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceEnumeration

ValuesDescription0

Minimum value

4294967295

Maximum value

DeviceDisplayName[DeviceSelector]
Displays the user readable name of the selected device.
Interface support

All

Display name

Device Display Name

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceEnumeration

Alvium Features Reference V2.9.1

61

Feature descriptions: Interface

DeviceDriverPath[DeviceSelector]
Displays the system driver path that can be used for opening the selected device.
Interface support

USB

Display name

Device Driver Path

Standard

CustomOrigin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceEnumeration

DeviceID[DeviceSelector]
Displays the interface wide unique identifier of the selected device.
Interface support

All

Display name

Device ID

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceEnumeration

Alvium Features Reference V2.9.1

62

Feature descriptions: Interface

DeviceLocation[DeviceSelector]
Displays the location path of the device in the tree of the corresponding interface
that can be used for opening the selected device.
Interface support

USB

Display name

Device Location

Standard

CustomOrigin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceEnumeration

DeviceModelName[DeviceSelector]
Displays the name of the selected device model.
This feature corresponds to DeviceModelName of the remote device.
Interface support

All

Display name

Device Model Name

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceEnumeration

Alvium Features Reference V2.9.1

63

Feature descriptions: Interface

DeviceSelector
Selects the device to be displayed.
Interface support

All

Display name

Device Selector

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Enumeration

AccessR

Affected features

Not applicable

Category/DeviceEnumeration

ValuesDescription≥0

Value range

DeviceType[DeviceSelector]
Displays the transport layer technology of the selected device.
Interface support

All

Display name

Device TypeStandard

Gen TL SFNC adapted

Origin of feature

Transport layer

Feature type

Enumeration

AccessR

Affected features

Not applicable

Category/DeviceEnumeration

ValuesDescription

CustomMIPI CSI-2

GigEVision

GigE Vision

USB3

USB3 Vision

Alvium Features Reference V2.9.1

64Feature descriptions: Interface

DeviceUpdateList
Updates the transport layer’s device list.
Interface support

All

Display name

Device Update List

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature typeCommandAccessR

Affected features

Not applicable

Category/DeviceEnumeration

DeviceVendorName[DeviceSelector]
Displays the vendor’s name for the selected device.
This feature corresponds to the DeviceVendorName of the remote device.
Interface support

All

Display name

Device Vendor Name

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceEnumeration

Alvium Features Reference V2.9.1

65

Feature descriptions: Interface

Gev

Note: Features in this subcategory are available for Alvium GigE cameras only.
This category contains GigE related features for Device Enumeration.
Interface support

GigE

Display name

GVCP

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Subcategory)Category/DeviceEnumeration

GevDeviceForceGateway
Controls the gateway of the GEV camera to be forced.
Interface support

GigE

Display nameGev Device Force Gateway

Standard

GenTL SFNC

Origin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/DeviceEnumeration/Gev

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

66

Feature descriptions: Interface

GevDeviceForceIP
Sends the force address command on all interfaces.
Interface support

GigE

Display nameGev Device Force IP

Standard

GenTL SFNC

Origin of feature

Transport Layer

Feature typeCommandAccessW

Affected features

Not applicable

Category/DeviceEnumeration/Gev

GevDeviceForceIPAddress
Controls the IP address of the GEV camera to be forced.
Interface support

GigE

Display nameGev Device Force IP Address

Standard

GenTL SFNC

Origin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/DeviceEnumeration/Gev

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

67

Feature descriptions: Interface

GevDeviceForceSubnetMask
Controls the subnet mask of the GEV camera to be forced.
Interface support

GigE

Display nameGev Device Force Subnet Mask

Standard

GenTL SFNC

Origin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/DeviceEnumeration/Gev

ValuesDescription0

Minimum

4294967295

Maximum

GevDeviceIPAddress[DeviceSelector]
Displays the current IP address of the selected remote device.
Interface support

GigE

Display name

Device IP Address

Standard

GenTL SFNC

Origin of feature

Transport Layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceEnumeration/Gev

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

68

Feature descriptions: Interface

GevDeviceMACAddress[DeviceSelector]
Displays the current 48-Bit MAC address of the selected remote device.
Interface support

GigE

Display name

Device MAC Address

Standard

GenTL SFNC

Origin of feature

Transport Layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceEnumeration/Gev

ValuesDescription0

Minimum

9223372036854775807

Maximum

GevDeviceSubnetMask[DeviceSelector]
Displays the current IP address of the selected remote device.
Interface support

GigE

Display name

Device Subnet Mask

Standard

GenTL SFNC

Origin of feature

Transport Layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceEnumeration/Gev

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

69

Feature descriptions: Interface

GevInterfaceIPAddress[DeviceSelector]
Displays the IP address of the selected subnet of the interface.
Interface support

GigE

Display nameInterface IP Address

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceEnumeration/Gev

ValuesDescription0

Minimum

4294967295

Maximum

GevInterfaceMACAddress
Displays the current 48-Bit MAC address of the interface.
Interface support

GigE

Display nameInterface MAC Address

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceEnumeration/Gev

ValuesDescription0

Minimum

9223372036854775807

Maximum

Alvium Features Reference V2.9.1

70Feature descriptions: Interface

GevInterfaceSubnetMask[DeviceSelector]
Displays the current IP address of the selected subnet of the interface.
Interface support

GigE

Display nameInterface Subnet Mask

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceEnumeration/Gev

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

71

Feature descriptions: Interface

Settings
The features in this category can be used to specify settings for GigE Device
Discovery.
Interface support

GigE

Display name

Settings

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)

DevicesDiscoveryBroadcastMode
Selects the area where the interface (= the host) sends DHCP discover messages.
Interface support

GigE

Display nameDiscovery Broadcast Mode

Standard

CustomOrigin of feature

Transport layer

Feature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/Settings

ValuesDescription

Local

The interface sends the discovery broadcast to the local
broadcast IP address 255.255.255.255 (default).

Subnet

The interface sends the discovery broadcast to a subnet
broadcast IP address, such as 192.168.1.255.

Alvium Features Reference V2.9.1

72

Feature descriptions: Interface

DevicesDiscoveryModeControls how the interface discovers connected devices, using GigE Vision discovermessages.
Interface support

GigE

Display name

Devices Discovery Mode

Standard

CustomOrigin of feature

Transport layer

Feature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/Settings

ValuesDescription

Auto

The interface sends the GigE Vision discover message in afrequency [ms]:InterfaceBeatRate × InterfaceHailPace(Default)

Once

The interface sends the GigE Vision discover message once
during the startup of the transport layer.

Off

The interface does not send GigE Vision discover messages.

InterfaceBeatRate
Controls the frequency for the interface to send DHCP discover messages.
Interface support

GigE

Display nameInterface Beat Rate

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Unit

ms (milliseconds)

Affected features

Not applicable

Category/Settings

ValuesDescription

10

Minimum value

500

Default value

10000

Maximum value

Alvium Features Reference V2.9.1

73

Feature descriptions: Interface

InterfaceHailPace
Controls the frequency for the interface to “hail” (page) devices.
Interface support

GigE

Display nameInterface Hail Pace

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/Settings

ValuesDescription

1

Value of InterfaceBeatRate

4

Default value

10

10 × value of InterfaceBeatRate

InterfacePingPace
Controls the frequency for the interface to ping devices.
Interface support

GigE

Display nameInterface Ping Pace

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/Settings

ValuesDescription

1

Value of InterfaceBeatRate

2

Default value

10

10 × value of InterfaceBeatRate

Alvium Features Reference V2.9.1

74

Feature descriptions: Interface

InterfaceInformation
This category contains all Interface Information features of the Interface module.
Interface support

All

Display nameInterface Information

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)InterfaceDisplayName[InterfaceSelector]
Displays the user readable name of the selected interface.
This feature corresponds to the INTERFACE_INFO_DISPLAYNAME command of
IFGetInfo function.
Interface support

All

Display nameInterface Display Name

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/InterfaceInformation

InterfaceID[InterfaceSelector]
Displays the GenTL Producer wide unique identifier of the selected interface.
This feature corresponds to the INTERFACE_INFO_ID command of IFGetInfo
function.
Interface support

All

Display nameInterface ID

Standard

Gen TL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/InterfaceInformation

Alvium Features Reference V2.9.1

75

Feature descriptions: Interface

InterfaceType
Displays the transport layer type of the interface.
This feature corresponds to the INTERFACE_INFO_TLTYPE command of IFGetInfo
function.
Interface support

All

Display nameInterface TypeStandard

Gen TL SFNC adapted

Origin of feature

Transport layer

Feature type

Enumeration

AccessR

Affected features

Not applicable

Category/InterfaceInformation

ValuesDescription

CustumMIPI CSI-2

GigEVision

GigE Vision

USB3

USB3 Vision

Alvium Features Reference V2.9.1

76

Feature descriptions: Local Device

This chapter includes:
DeviceInformation ................................................................ 78
GigE ....................................................................................... 85
StreamEnumeration.............................................................. 88

Alvium Features Reference V2.9.1

77

Feature descriptions: Local Device

DeviceInformation
Features in this category provide basic information about the Device module andits identity.
Interface support

All

Display name

Device Information

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)

DeviceDisplayName
Displays the user readable name of the camera.
This feature corresponds to the DEVICE_INFO_DISPLAYNAME command of
DevGetInfo function.
Interface support

All

Display name

Device Display Name

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceInformation

Alvium Features Reference V2.9.1

78

Feature descriptions: Local Device

Gev

Note: Features in this subcategory are available for Alvium GigE cameras only.
The features in this subcategory can be used to control IP settings, thecommunication between the host and the camera, and the transfer of data
packets.
Interface support

GigE

Display name

GigE

Standard

GenTL SFNC

Origin of feature

Transport Layer

Feature type

(Category)Category/DeviceInformation

DeviceEndianessMechanism
Displays the Endianess mode.
Interface support

GigE

Display name

Device Endianess Mechanism

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Enumeration

AccessR

Affected features

Not applicable

Category/DeviceInformation/Gev

ValuesDescription

LegacyDevice endianess is handled according to GenICam Schema
1.0 (default).

Standard

Device endianess is handled according to GenICam Schema
1.1 and later.

Alvium Features Reference V2.9.1

79Feature descriptions: Local Device

GevDeviceGateway
Displays the current gateway of the GVCP interface of the selected remote device(camera).
Interface support

GigE

Display name

Device Gateway

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceInformation/Gev

ValuesDescription0

Minimum value

4294967295

Maximum value

GevDeviceIPAddress
Displays the current IP address of the GVCP interface of the remote device(camera).
Interface support

GigE

Display name

Device IP Address

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceInformation/Gev

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

80

Feature descriptions: Local Device

GevDeviceMACAddress
Displays the current 48-Bit MAC address of the GVCP interface of the remotedevice (camera).
Interface support

GigE

Display name

Device MAC Address

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceInformation/Gev

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

GevDeviceSubnetMask
Displays the current subnet of the GVCP interface of the remote device (camera).
Interface support

GigE

Display name

Device Subnet Mask

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceInformation/Gev

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

81Feature descriptions: Local Device

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

DeviceID
Displays the interface-wide unique identifier of this device.
This feature corresponds to the DEVICE_INFO_ID command of DevGetInfo
function.
Interface support

All

Display name

Device ID

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceInformation

DeviceLocation
Displays the location path of the device in the tree of the corresponding interface
that can also be used for opening the device (camera).
Interface support

USB

Display name

Device Location

Standard

CustomOrigin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceInformation

Alvium Features Reference V2.9.1

82

Feature descriptions: Local Device

DeviceModelName
Displays the name of the camera model.
Corresponds to the DEVICE_INFO_MODEL command of DevGetInfo function.
Interface support

All

Display name

Device Model Name

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceInformation

DeviceType
Displays the transport layer type of the camera.
Interface support

All

Display name

Device TypeStandard

GenTL SFNC adapted

Origin of feature

Transport layer

Feature type

Enumeration

AccessR

Affected features

Not applicable

Category/DeviceInformation

ValuesDescription

CustomMIPI CSI-2

GigEVision

GigE Vision

USB3

USB3 Vision

Alvium Features Reference V2.9.1

83

Feature descriptions: Local Device

DeviceVendorName
Displays the name of the camera vendor.
This feature corresponds to the DEVICE_INFO_VENDOR command of DevGetInfo
function.
Interface support

All

Display name

Device Vendor Name

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceInformation

DriverPath
Displays the system driver path that can also be used for opening the camera.
Interface support

USB

Display name

Driver Path

Standard

CustomOrigin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/DeviceInformation

Alvium Features Reference V2.9.1

84

Feature descriptions: Local Device

GigE
Note: Features in this category are available for Alvium GigE cameras only.
The features in this category can be used to control IP settings, the communication
between the host and the camera, and the transfer of data packets.

GVCP

Interface support

GigE

Display name

GigE

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)

Note: Features in this subcategory are available for Alvium GigE cameras only.
The features in this subcategory can be used to control command traffic andtimings between the host and the camera.
Interface support

GigE

Display name

GVCP

Standard

CustomOrigin of feature

Transport layer

Feature type

(Subcategory)Category/GigE

Alvium Features Reference V2.9.1

85

Feature descriptions: Local Device

GVCPCmdRetries
Controls the number of times a particular command to the camera is resent when
no answer is being received.
Interface support

GigE

Display nameCommand Retries

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

GevHeartbeatTimeout, GevHeartbeatInterval,
GVCPHBInterval

Category/GigE/GVCP

ValuesDescription

1

Minimum

9

Maximum

GVCPCmdTimeout
Controls the period of time for the host to wait for an answer from the camera.
Interface support

GigE

Display nameCommand Timeout

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Unit

ms (milliseconds)

Affected features

GevHeartbeatTimeout, GevHeartbeatInterval,
GVCPHBInterval

Category/GigE/GVCP

ValuesDescription

100

Minimum

10000

Maximum

Alvium Features Reference V2.9.1

86Feature descriptions: Local Device

GevHeartbeatInterval
Controls the period of time after which a heartbeat is sent by the host.
Interface support

GigE

Display nameHeartbeat IntervalStandard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Unit

ms (milliseconds)

Affected features

GVCPHBInterval

Category/GigE/GVCP

ValuesDescription

200

Minimum

200

Maximum

GevHeartbeatTimeout
Controls the period of time after which the camera rejects control by the host if noheartbeat activity is registered.
Interface support

GigE

Display nameHeartbeat Timeout

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Unit

ms (milliseconds)

Affected features

GevHeartbeatInterval, GVCPHBInterval

Category/GigE/GVCP

ValuesDescription

25100

Minimum

100000Maximum

Alvium Features Reference V2.9.1

87

Feature descriptions: Local Device

StreamEnumeration
This category contains all Stream Enumeration features of the Device module.
Interface support

All

Display nameStream Enumeration

Standard

GenTL SFNC

Origin of feature

CameraFeature type

(Category)StreamCount
Displays the number of available streams.
Interface support

All

Display nameStream Count

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/StreamEnumeration

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

88Feature descriptions: Local Device

StreamID[StreamSelector]
Displays the unique ID for the stream of the selected device (camera), for instancea GUID.
Interface support

All

Display nameStream ID

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/StreamEnumeration

StreamSelector
Selects the stream channel.
Interface support

All

Display nameStream Selector

Standard

CustomOrigin of feature

Transport layer

Feature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/InterfaceEnumeration

ValuesDescription≥0

Value range

Alvium Features Reference V2.9.1

89Feature descriptions: Camera

This chapter includes:
AcquisitionControl ................................................................ 91
ActionControl ...................................................................... 106
AnalogControl ..................................................................... 111
AutoModeControl ............................................................... 116
ColorTransformationControl ............................................... 126
CorrectionControl ............................................................... 131
CounterAndTimerControl ................................................... 135
DeviceControl...................................................................... 149
DigitalIOControl................................................................... 166
FileAccessControl ................................................................ 178
ImageFormatControl........................................................... 185
ImageProcessingControl ..................................................... 210
LUTControl........................................................................... 220
PtpControl ........................................................................... 223
SequencerControl ............................................................... 230
SoftwareSignalControl ........................................................ 241
TestControl .......................................................................... 243
TransferControl ................................................................... 244
TransportLayerControl ........................................................ 247
UserSetControl.................................................................... 259

Alvium Features Reference V2.9.1

90

Feature descriptions: Camera

AcquisitionControl
The features in this category can be used to control acquisition, frame rate, andexposure time, and to enable triggering the camera and connected devices, suchas strobe lights.
Interface support

All

Display nameAcquisition Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

AcquisitionFrameCount
Controls the number of frames to acquire in MultiFrame acquisition mode.
Interface support

All

Display nameAcquisition Frame Count

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit(number)

Affected features

Not applicable

Category/AcquisitionControl

Alvium Features Reference V2.9.1

91

Feature descriptions: Camera

AcquisitionFrameRate
Controls the acquisition rate at which the frames are captured.
Notes• If AcquisitionFrameRateEnable is false, AcquisitionFrameRate is readonly.
• If values for exposure time or ROI are changed after AcquisitionFrameRate
has been set, the value may be adjusted. See Feature interdependencies on
page 32. In this case the value for AcquisitionFrameRate must be readjusted by the user.
Interface support

All

Display nameAcquisition Frame Rate

Standard

SFNC

Origin of feature

CameraFeature type

Float

Access

R/W

Unit

Hertz

Affected features

ExposureTime

Category/AcquisitionControl

AcquisitionFrameRateEnable
Enables or disables AcquisitionFrameRate.
Note: Otherwise, the frame rate is implicitly controlled by the combination ofother features like ExposureTime.
Interface support

All

Display nameAcquisition Frame Rate Enable

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

AcquisitionFrameRate

Category/AcquisitionControl

ValuesDescription

True

AcquisitionFrameRate feature is writable and used tocontrol the acquisition rate.
False

AcquisitionFrameRate is implicitly controlled by the
combination of other features like ExposureTime.

Automatically, the maximum available frame rate is used.

Alvium Features Reference V2.9.1

92

Feature descriptions: Camera

AcquisitionFrameRateMode
Selects the priority between AcquisitionFrameRate and ExposureTime.
Interface support

All

Display nameAcquisition Frame Rate Mode

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not affected

Category/AcquisitionControl

ValuesDescription

Basic

ExposureTime has the priority overAcquisitionFrameRate. If ExposureTime gets longer than
the inverse of AcquisitionFrameRate, the resulting

acquisition frame rate is reduced accordingly.

Alvium Features Reference V2.9.1

93

Feature descriptions: Camera

AcquisitionMode
Selects the acquisition mode of the camera. The feature defines mainly the
number of frames to capture during an acquisition and the way the acquisition
stops.
Interface support

All

Display nameAcquisition Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

LineMode, TriggerSource, LineInverter, LineSource

Category/AcquisitionControl

ValuesDescription

Continuous

After an AcquisitionStart event: Selects continuous
image acquisition until acquisition stop is triggered.

MultiFrame

A number of images is acquired that is specified byAcquisitionFrameCount. Further trigger events will beignored until acquisition is stopped and restarted.
In case of MultiFrame, acquisition can be stopped using
AcquisitionStop command before it reaches the numberof frames specified in AcquisitionFrameCount. So, theAcquisitionStop trigger event will not be ignored.

SingleFrame

Single images are acquired. Further trigger events will beignored until acquisition is stopped and restarted.

AcquisitionStart
Starts the acquisition of the camera.
Note: The number of frames captured is specified by AcquisitionMode.
Interface support

All

Display nameAcquisition Start

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

Not applicable

Category/AcquisitionControl

Alvium Features Reference V2.9.1

94

Feature descriptions: Camera

AcquisitionStatus[AcquisitionStatusSelector]
Displays the state of the internal acquisition signal selected using
AcquisitionStatusSelector.
Interface support

All

Display nameAcquisition Status

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR

Affected features

Not applicable

Category/AcquisitionControl

ValuesDescription

False

The camera is performing the selected action.

True

The camera is performing the selected action.

AcquisitionStatusSelector
Selects the internal acquisition signal to read using AcquisitionStatus.
Interface support

All

Display nameAcquisition Status Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AcquisitionStatus

Category/AcquisitionControl

ValuesDescription

Acquisition
Active

The camera acquires one or many frames.

Acquisition
Transfer

The camera transfers one or many frames to the host.

Alvium Features Reference V2.9.1

95

Feature descriptions: Camera

AcquisitionStop
Stops the acquisition of the camera at the end of the current frame.
Note: This feature is mainly used when AcquisitionMode is Continuous, but it
can be used in any acquisition mode.
Interface support

All

Display nameAcquisition Stop

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

Not applicable

Category/AcquisitionControl

ExposureActiveMode
Selects the mode for the ExposureActive signal. You can use this feature forsynchronizing strobe lights to compensate for the rolling shutter effect.
Note: Global shutter cameras support only FlashWindow, other cameras support
FirstLine and FlashWindow.
Interface support

All

Display name

Exposure Active Mode

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

LineInverter, LineMode, LineSelector,
LineSource, LineStatus, LineStatusAll,
TimerDelay, TimerDuration, TimerReset,
TimerSelector, TimerStatus,
TimerTriggerActivation, TimerTriggerSource,
TriggerSelector

Category/AcquisitionControl

ValuesDescription

FirstLine

Sets the ExposureActive signal to high when the first line
is exposing.

FlashWindow

Sets the ExposureActive signal to high when all lines are
exposing simultaneously.

Alvium Features Reference V2.9.1

96Feature descriptions: Camera

ExposureAuto
Selects the auto exposure mode.
Note: The output of the auto exposure function affects the whole image.
Interface support

All

Display name

Exposure Auto

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AcquisitionControl

ValuesDescription

Continuous

The exposure time varies continuously according to thescene illumination.

Off

Automatic mode is disabled.

Once

Automatic exposure is applied once until the target value ofthe selected auto control algorithm is achieved, then thevalue returns to Off.

Alvium Features Reference V2.9.1

97

Feature descriptions: Camera

ExposureMode
Selects the operation mode of the exposure (or shutter).
Notes:• A delay may occur between the trigger signal and the start of the exposure. For
the delay with rolling shutter sensor cameras, see your Alvium camera’s user
guide.
• For TriggerWidth and TriggerControlled, the resulting exposure time isextended, because of an exposure offset after the trigger pulse.
Interface support

All

Display name

Exposure Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AcquisitionControl

Value

Description

Timed

The exposure time is set by ExposureTime or
ExposureAuto.

TriggerControlled2

One or more trigger signals control the exposure time
independently from the current frame triggers.

TriggerWidth1,2

The width of the current frame trigger signal(s) pulse
controls the exposure time.

1

Controlling the exposure time using TriggerWidth: We recommend you tofollow the workflow shown in ExposureMode - Using TriggerWidth on page 99.

2

Global shutter sensor cameras only.

Alvium Features Reference V2.9.1

98

Feature descriptions: Camera

ExposureMode - Using TriggerWidth
Follow the workflow shown in Figure 6 to use TriggerWidth.

DigitalIOControl:
LineSelector=
LineX

X = selected line

DigitalIOControl:
LineMode=
Input

AcquisitionControl:
TriggerSelector=
FrameStart

AcquisitionControl:
TriggerActivation=
LevelHigh or LevelLow

AcquisitionControl:
TriggerSource=
LineX

X = selected line

AcquisitionControl:
TriggerMode=
On

Figure 6: Workflow for using TriggerWidth

Alvium Features Reference V2.9.1

99

Feature descriptions: Camera

ExposureTime
Selects the exposure time when ExposureMode is Timed and ExposureAuto isOff. This controls the duration where the photosensitive cells are exposed to light.
Interface support

All

Display name

Exposure Time

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Microseconds

Affected features

ExposureAutoMin, ExposureAutoMax,
AcquisitionFrameRate

Category/AcquisitionControl

TriggerActivation[TriggerSelector]
Selects the electrical signal level of the trigger.
Interface support

All

Display name

Trigger Activation

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AcquisitionControl

ValuesDescription

AnyEdge

The encoder on the falling or rising edge of the signal is reset.

FallingEdge

The encoder on the falling edge of the signal is reset.

LevelHighThe encoder at a high signal level is reset.

LevelLow

The encoder at a low signal level is reset.

RisingEdge

The encoder on the rising edge of the signal is reset.

Alvium Features Reference V2.9.1

100Feature descriptions: Camera

TriggerDelay[TriggerSelector]
Controls the period of time before the camera corresponds after receiving a trigger
signal.
Notes:• Available only when TriggeSelector is set to FrameStart or
AcquisitionStart.
• The value for TriggerDelay adds to the sensor related delay between trigger
and exposure start. The sensor related delay depends on such as data rate andsensor characteristics.
Interface support

All

Display name

Trigger Delay

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Microseconds

Affected features

Not applicable

Category/AcquisitionControl

ValuesDescription0

Minimum

20748634.2705

Maximum

Alvium Features Reference V2.9.1

101

Feature descriptions: Camera

TriggerMode[TriggerSelector]
Enables or disables the selected trigger.
Interface support

All

Display name

Trigger Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

LineMode, TriggerSource, LineInverter, LineSource

Category/AcquisitionControl

ValuesDescription

Off

Triggering is disabled.

On

Triggering is enabled

Alvium Features Reference V2.9.1

102

Feature descriptions: Camera

TriggerSelector
Selects the type of trigger to configure.
Interface support

All

Display name

Trigger Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

TriggerMode, LineMode, TriggerSoftware,
LineInverter, LineSource, TriggerSource,
TriggerActivation

Category/AcquisitionControl

ValuesDescription

Acquisition
ActiveThe selected trigger controls the duration of the acquisitionof a single frame or many frames. The acquisition is
activated when the trigger signal becomes active andterminated when it goes back to the inactive state.

AcquisitionEnd

The trigger terminates the acquisition process.

Acquisition
Start

The selected trigger starts the acquisition process.

ExposureActive* The selected trigger controls the duration of exposure of asingle frame (when acquisition is running).

ExposureStart*

The selected trigger starts the exposure of a single frame(when acquisition is running).

ExposureEnd*

The selected trigger ends the exposure of a single frame(when acquisition is running).

FrameStart

The selected trigger starts the capture of a single frame(when acquisition is running).

*Not supported by cameras using rolling shutter sensors.

Alvium Features Reference V2.9.1

103

Feature descriptions: Camera

TriggerSoftware[TriggerSelector]
Generates an internal trigger. TriggerSource must be set to Software.
Interface support

All

Display name

Trigger SoftwareStandard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

Not applicable

Category/AcquisitionControl

Alvium Features Reference V2.9.1

104

Feature descriptions: Camera

TriggerSource[TriggerSelector]
Selects the internal signal or physical input line to use as the trigger source.
Note: The selected trigger must have its TriggerMode set to On.
Interface support
Display nameStandard
Origin of feature
Feature type
AccessAffected features
Category
ValuesAll
Trigger Source
SFNC
CameraEnumeration
R/W
Not applicable/AcquisitionControl

1

Action0

Description
Action0 command is used to signal triggers.

Action11

Action1 command is used to signal triggers.

Counter0Active

Line22

Counter0Active is used to signal triggers.
Counter1Active is used to signal triggers.
Counter2Active is used to signal triggers.
Counter3Active is used to signal triggers.
Physical Line0 is used to signal triggers.
Physical Line1 is used to signal triggers.
Physical Line2 is used to signal triggers.

Line32

Physical Line3 is used to signal triggers.

Off

Triggering is disabled.
Software is used to signal triggers.
SoftwareSignal0 is used to signal triggers.
SoftwareSignal1 is used to signal triggers.
Timer0Active is used to signal triggers.
Timer1Active is used to signal triggers.

Counter1Active
Counter2Active
Counter3Active
Line0
Line1

Software
SoftwareSignal0
SoftwareSignal1
Timer0Active
Timer1Active

1 Currently, available with Alvium G1/G5 cameras only.
2

Available with Alvium G1/G5 and Alvium USB cameras. Alvium CSI-2 cameras
support Line0 and Line1 only.

Alvium Features Reference V2.9.1

105

Feature descriptions: Camera

ActionControl
Note: Features in this category are available for Alvium GigE cameras only.
Support for the other Alvium series is intended for a future firmware release.
The features in this category can be used by external devices to trigger actions
within the camera by software commands. This includes ToE (Trigger over
Ethernet) where the GigE interface is used for triggering instead of the I/Os.
See SoftwareSignalControl on page 241 for the interaction with features in thiscategory.
Interface support

GigE

Display name

Action Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

ActionDeviceKeyControls the device key that allows the device to check the validity of actioncommands.
Notes:• ActionDeviceKey has the unconventional access mode "write only" to makesure that the primary application alone has control over it.
• The device internal assertion of an action signal is only authorized if the
ActionDeviceKey and the action device key value in the protocol message are
equal.
Interface support

GigE

Display name

Action Device Key

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessW

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum

4294967295

Maximum (32 Bits)

Alvium Features Reference V2.9.1

106

Feature descriptions: Camera

ActionGroupKey[ActionSelector]
Controls the key that the device will use to validate the action on reception of theaction protocol message.
The device asserts the selected Action signal only if:• The camera’s ActionDeviceKey is equal to the action device key in the action
protocol message.
• The bitwise AND operation of the action group mask in the action protocol
message against the selected ActionGroupMask is non-zero.
• The camera’s ActionGroupKey is equal to the action group key in the action
protocol message.
Interface support

GigE

Display name

Action Group KeyStandard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

107

Feature descriptions: Camera

ActionGroupMask[ActionSelector]
Controls the mask that the device will use to validate the action on reception of theaction protocol message.
The device asserts the selected Action signal only if:• The camera’s ActionDeviceKey is equal to the action device key in the action
protocol message.
• The bitwise AND operation of the action group mask in the action protocol
message against the selected ActionGroupMask is non-zero.
• The camera’s ActionGroupKey is equal to the action group key in the action
protocol message.
Interface support

GigE

Display name

Action Group Mask

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

108

Feature descriptions: Camera

ActionQueueSize[ActionSelector]
Displays the size of the scheduled action commands queue. This number
represents the maximum number of scheduled action commands that can bepending at a given point in time.
Interface support

GigE

Display name

Action Queue Size

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/ActionControl

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

109

Feature descriptions: Camera

ActionSelector
Selects to which Action Signal further Action settings apply.
Interface support

GigE

Display name

Action Selector

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

ActionGroupKey, ActionGroupMask, ActionQueueSize

Category/ActionControl

ValuesDescription0

Minimum

1

Maximum

Alvium Features Reference V2.9.1

110Feature descriptions: Camera

AnalogControl
The features in this category can be used to control the intensity levels for Date of
document release and color imaging.
Interface support

All

Display name

Analog Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

BalanceRatio[BalanceRatioSelector]
Controls the ratio of the selected color component to the green color component.
This feature is used for white balance.
Interface support

All

Display name

Balance Ratio

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR/W

Affected features

Not applicable

Category/AnalogControl

ValuesDescription0

Minimum

8

Maximum

0.001

Increment

Alvium Features Reference V2.9.1

111

Feature descriptions: Camera

BalanceRatioSelector
Selects the balance ratio to control.
Interface support

All

Display name

Balance Ratio Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

BalanceRatio

Category/AnalogControl

ValuesDescriptionRed

The red channel is adjusted.

Blue

The blue channel is adjusted.

BalanceWhiteAuto
Selects the auto white balance mode.
Interface support

All

Display name

Balance White Auto

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

BalanceWhiteAutoRate, BalanceWhiteAutoTolerance

Category/AnalogControl

ValuesDescription

Continuous

Auto white balance is applied continuously.

Once

Auto white balance is applied once. After adjustments havebeen done, auto white balance is disabled.

Off

Auto white balance is disabled.

Alvium Features Reference V2.9.1

112

Feature descriptions: Camera

BlackLevel[BlackLevelSelector]
Controls the analog black level as an absolute physical value. The feature
represents a DC offset applied to the video signal.
Interface support

All

Display nameBlack Level

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR/W

Affected features

Not applicable

Category/AnalogControl

ValuesDescription

1

Increment

BlackLevelSelector
Selects the black level to be controlled by the various black level features.
Interface support

All

Display nameBlack Level Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

BlackLevel

Category/AnalogControl

Value

DescriptionAll

All black levels are controlled.

Alvium Features Reference V2.9.1

113

Feature descriptions: Camera

Gain[GainSelector]
Controls the selected gain as an absolute physical value. This is an amplification
factor applied to the video signal.
Interface support

All

Display name

Gain

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Decibels [dB]

Affected features

GainAutoMin, GainAutoMax

Category/AnalogControl

ValuesDescription

0.1

Increment

GainAuto[GainSelector]
Selects the auto gain mode.
Note: The output of the auto gain function affects the whole image.
Interface support

All

Display nameGain Auto

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AnalogControl

ValuesDescription

Continuous

Gain is continuously adjusted to keep the value set for
IntensityControllerTarget. This is triggered by such aschanges in illumination or in object brightness.

Once

Auto gain is being applied once. After adjustments havebeen done, gain is disabled.

Off

Auto gain is disabled.

Alvium Features Reference V2.9.1

114

Feature descriptions: Camera

GainSelector
Selects the gain to be controlled by the various gain features.
Interface support

All

Display nameGain Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Gain, GainAuto, GainAutoMax

Category/AnalogControl

Value

DescriptionAll

All gains are controlled.

Gamma
Controls the gamma correction of pixel intensity.
Interface support

All

Display name

Gamma

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR/W

Affected features

Not applicable

Category/AnalogControl

ValuesDescription

0.4

Minimum

2.4

Maximum

0.5

Increment

Alvium Features Reference V2.9.1

115

Feature descriptions: Camera

AutoModeControl
The features in this category enable auto functions for white balance, gain, andexposure time.
Interface support

All

Display nameAuto Mode Control

Standard

CustomOrigin of feature

CameraFeature type

(Category)

AutoModeRegionHeight[AutoModeRegionSelector]
Controls the height of the region used to measure values for all auto functions.
Interface support

All

Display nameAuto Mode Region HeightStandard

CustomOrigin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

AutoModeRegionOffsetY

Category/AutoModeControl

AutoModeRegionOffsetX[AutoModeRegionSelector]
Controls the horizontal position of the window used to measure the actual value
for the auto function.
Interface support

All

Display nameAuto Mode Region OffsetX

Standard

CustomOrigin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

AutoModeRegionWidth

Category/AutoModeControl

Alvium Features Reference V2.9.1

116

Feature descriptions: Camera

AutoModeRegionOffsetY[AutoModeRegionSelector]
Controls the vertical position of the window used to measure the actual value forthe auto function.
Interface support

All

Display nameAuto Mode Region OffsetYStandard

CustomOrigin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

AutoModeRegionHeight

Category/AutoModeControl

AutoModeRegionSelector
Selects the auto mode region to configure.
Interface support

All

Display nameAuto Mode Region Selector

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AutoModeRegionWidth, AutoModeRegionOffsetX,
AutoModeRegionHeight, AutoModeRegionOffsetY

Category/AutoModeControl

Value

Description

AutoModeRegion1 Auto Mode Region 1 is configured.

Alvium Features Reference V2.9.1

117

Feature descriptions: Camera

AutoModeRegionWidth[AutoModeRegionSelector]
Controls the width of the window used to measure the actual value for the autofunction.
Interface support

All

Display nameAuto Mode Region Width

Standard

CustomOrigin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

AutoModeRegionOffsetXCategory/AutoModeControl

BalanceWhiteAutoRate
Controls the frequency of white balance adjustments.
Interface support

All

Display name

Balance White Auto Rate

Standard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

BalanceWhiteAutoTolerance

Category/AutoModeControl

ValuesDescription

1

Minimum

100

Maximum

1

Increment

Alvium Features Reference V2.9.1

118

Feature descriptions: Camera

BalanceWhiteAutoTolerance
Controls the deviation of the current white balance value from the ideal value atwhich the white balance is adjusted.
Interface support

All

Display name

Balance White Auto ToleranceStandard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

BalanceWhiteAutoRate

Category/AutoModeControl

ValuesDescription0

Minimum

50

Maximum

1

Increment

ExposureAutoMax
Controls the maximum value for auto exposure.
Note: The output of the auto exposure function affects the whole image.
Interface support

All

Display name

Exposure Auto Max

Standard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

ExposureAutoMin

Category/AutoModeControl

Alvium Features Reference V2.9.1

119Feature descriptions: Camera

ExposureAutoMin
Controls the minimum value for auto exposure.
Note: The output of the auto exposure function affects the whole image.
Interface support

All

Display name

Exposure Auto MinStandard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

ExposureAutoMax

Category/AutoModeControl

GainAutoMax
Controls the maximum value for auto gain.
Note: The output of the auto gain function affects the whole image.
Interface support

All

Display nameGain Auto Max

Standard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

GainAutoMin

Category/AutoModeControl

GainAutoMin
Controls the minimum value for auto gain.
Note: The output of the auto gain function affects the whole image.
Interface support

All

Display nameGain Auto MinStandard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

GainAutoMax

Category/AutoModeControl

Alvium Features Reference V2.9.1

120

Feature descriptions: Camera

IntensityAutoPrecedence
Selects the precedence of intensity controller.
Interface support

All

Display name

Intensity Auto PrecedenceStandard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AutoModeControl

ValuesDescription

MinimizeBlur

Orders the control loops so that image blur is minimized:
gain first, exposure time second. Long exposure times are
avoided if possible.

MinimizeNoise

Orders the control loops so that noise is minimized:
exposure time first, gain second. Gain increases are avoided
if possible.

IntensityControllerAlgorithm[IntensityControllerSelector]
Selects the algorithm determining how the histogram is used to determine thecurrent intensity value.
Note: The outliers are disregarded.
Interface support

All

Display name

Intensity Controller Algorithm

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AutoModeControl

ValuesDescription

Mean

After comparing the arithmetic mean of the current image’s
histogram to ExposureAutoTarget, the exposure time forthe next image is adjusted to meet this target. Bright areas
are allowed to saturate.

Alvium Features Reference V2.9.1

121

Feature descriptions: Camera

IntensityControllerOutliersBright[IntensityControllerSelector]
Controls the number of pixels from the top of the distribution to be ignored.
Interface support

All

Display name#

Intensity Controller Outliers BrightStandard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

Not applicable

Category/AutoModeControl

ValuesDescription0

Minimum

10

Maximum

0.01

Increment

IntensityControllerOutliersDark
IntensityControllerSelector]
Controls the number of pixels from the bottom of the distribution to be ignored.
Interface support

All

Display name

Intensity Controller Outliers Dark

Standard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

Not applicable

Category/AutoModeControl

ValuesDescription0

Minimum

10

Maximum

0.01

Increment

Alvium Features Reference V2.9.1

122

Feature descriptions: Camera

IntensityControllerRate
Controls the rate at which the controller should compute an intensity value.
Note: This value also defines the period at which the associated auto functions
change their control value.
Interface support

All

Display name

Intensity Controller Rate

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/AutoModeControl

ValuesDescription

1

Minimum

100

Maximum

IntensityControllerRegion
Selects the subregion of the image that the intensity controller operates on.
Interface support

All

Display name

Intensity Controller Region

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AutoModeControl

ValuesDescription

AutoModeRegion1 The intensity controller controls Auto Mode Region 1.
FullImage

Alvium Features Reference V2.9.1

The intensity controller controls the full sensor area.

123Feature descriptions: Camera

IntensityControllerSelector
Selects the intensity controller to configure.
Interface support

All

Display name

Intensity Controller Selector

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

IntensityControllerOutliersDark,
IntensityControllerOutliersBright,
IntensityControllerTolerance,
IntensityControllerAlgorithm

Category/AutoModeControl

Value

Description

Intensity
Controller1

Intensity Controller 1 is selected to be configured.

IntensityControllerTarget
Controls the target intensity value for auto intensity control as deviation from themean value in [percent]. The default value for all auto features is 50.
Interface support

All

Display name

Intensity Controller Target

Standard

CustomOrigin of feature

CameraFeature type

Float

Access

R/W

Unit

Percent [%]Affected features

Not applicable

Category/AutoModeControl

ValuesDescription

10

Minimum

89.9

Maximum

0.0001

Increment

50

Default

Alvium Features Reference V2.9.1

124

Feature descriptions: Camera

IntensityControllerTolerance
Controls the deviation of the current value from the target value at which thefeature is inactive.
Interface support

All

Display name

Intensity Controller ToleranceStandard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/AutoModeControl

ValuesDescription0

Minimum

50

Maximum

1

Increment

Alvium Features Reference V2.9.1

125Feature descriptions: Camera

ColorTransformationControl
The features in this category can be used to control the interpolation of the RGB
channels for the color image output, and simple access to hue and saturation.
Interface support

All

Display name

Color Transformation Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)This section describes features related to color transformations in color cameras.
The following features are only valid if using on-camera interpolated pixel formats.
The color transformation is a linear operation taking as input the triplet Rin, Gin, Bin
for an RGB color pixel. This triplet is multiplied by a 3×3 matrix. This colortransformation allows to change the coefficients of the 3×3 matrix.
R out

R in
Gain00 Gain01 Gain02
G out = Gain10 Gain11 Gain12 x G in
Gain20 Gain21 Gain22 B
B out
in

ColorTransformationEnable[ColorTransformationSelector]
Enables or disables the selected color transformation module.
Interface support

All

Display name

Color Transformation Enable

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

ColorTransformationValue

Category/ColorTransformationControl

ValuesDescription

True

The selected color transformation module is enabled.

False

The selected color transformation module is disabled.

Alvium Features Reference V2.9.1

126

Feature descriptions: Camera

ColorTransformationValue[ColorTransformationSelector][ColorTransformationValue-Selector]
Selects the gain factor or offset for the selected color transformation.
Interface support

All

Display name

Color Transformation Value

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR/W

Affected features

Not applicable

Category/ColorTransformationControl

ValuesDescription-4

Minimum+4

Maximum

1

Default

Alvium Features Reference V2.9.1

127

Feature descriptions: Camera

ColorTransformationValueSelector[ColorTransformationSelector]
Selects the gain factor or offset of the Transformation matrix for the selected Color
Transformation module.
Interface support

All

Display name

Color Transformation Value Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

ColorTransformationValue

Category/ColorTransformationControl

For values described in the following table, see ColorTransformationControl on
page 126 for the color transformation matrix.
ValuesDescription

Gain00Gain 00 for the red contribution to the red pixel(multiplicative factor) is selected.

Gain01Gain 01 for the green contribution to the red pixel(multiplicative factor) is selected.

Gain02Gain 02 for the red contribution to the red pixel(multiplicative factor) is selected.

Gain10Gain 10 for the red contribution to the green pixel(multiplicative factor) is selected.

Gain11Gain 11 for the green contribution to the green pixel(multiplicative factor) is selected.

Gain12Gain 12 for the blue contribution to the green pixel(multiplicative factor) is selected.

Gain20Gain 20 for the red contribution to the blue pixel(multiplicative factor) is selected.

Gain21Gain 21 for the green contribution to the blue pixel(multiplicative factor) is selected.

Gain22Gain 22 for the blue contribution to the blue pixel(multiplicative factor) is selected.

Alvium Features Reference V2.9.1

128Feature descriptions: Camera

Hue
Controls the color tone correction by rotating the chrominance field clockwise withvalues > 0 and counter clockwise with values < 0 in degrees [°].
Interface support

All

Display nameHue

Standard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Unit

Degrees [°]Affected features

PixelFormat, DeviceLinkThroughputLimit,
ExposureAutoMin, ExposureAutoMax, ExposureTime,
AcquisitionFrameRate, Width, OffsetX,
AutoModeRegionWidth, AutoModeRegionOffsetX,
AutoModeRegionHeight, AutoModeRegionOffsetY,
PayloadSize, WidthMax, Height, OffsetY, HeightMax,
PixelSize, ContrastEnable, ContrastDarkLimit,
ContrastBrightLimit, BlackLevel, Saturation,
ColorTransformationEnable,
ColorTransformationValue

Category/ColorTransformationControl

ValuesDescription-40

Minimum (40 degrees)+40

Maximum (40 degrees)0Default

Alvium Features Reference V2.9.1

129Feature descriptions: Camera

Saturation
Controls the amplification of the chrominance signal in the color space.
Interface support

All

Display nameSaturation

Standard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

Not applicable

Category/ColorTransformationControl

ValuesDescription0

Minimum+2

Maximum

1

Default

Alvium Features Reference V2.9.1

130Feature descriptions: Camera

CorrectionControl
The features in this category can be used to control DPC (Defect pixel correction)
and FPNC (Fixed pattern noise correction) for image correction.
Interface support

All

Display name

Correction Control

Standard

CustomOrigin of feature

CameraFeature type

(Category)

CorrectionMode
Enables or disables correction features.
Interface support

All

Display name

Correction Mode

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/CorrectionControl

ValuesDescription

Off

Correction features are disabled.

On

Correction features are enabled.

Alvium Features Reference V2.9.1

131

Feature descriptions: Camera

CorrectionSelector
Selects the type of correction to configure.
Interface support

All

Display name

Correction Selector

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

CorrectionMode, CorrectionSet,
CorrectionSetDefault, CorrectionDataSize,
CorrectionEntryType

Category/CorrectionControl

ValuesDescription

DefectPixel
Correction*

Defect pixel correction (DPC) is selected.

FixedPattern
NoiseCorrection*

Fixed pattern noise correction (FPNC) is selected.

*Availability is camera model dependent.

CorrectionSet[CorrectionSelector]
Selects the currently enabled correction settings.
Interface support

All

Display name

Correction Set

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/(W)Affected features

Not applicable

Category/CorrectionControl

ValuesDescription

PresetFactory settings are enabled (default).

User*

User settings are enabled.

*Available only if a user correction set has been written to the camera memory.

Alvium Features Reference V2.9.1

132

Feature descriptions: Camera

CorrectionSetDefault[CorrectionSelector]
Selects the correction set used when the camera is reset.
Interface support

All

Display name

Correction Set Default

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/CorrectionControl

ValuesDescription

PresetFactory settings are used after camera reset.

User*

User settings are used after camera reset.

*Available only if a user correction set has been written to the camera memory.

Alvium Features Reference V2.9.1

133

Feature descriptions: Camera

CorrectionInfo (subcategory)
The features in this subcategory can be used to display the correction typecurrently used.
Interface support

All

Display name

Correction Info

Standard

CustomOrigin of feature

CameraFeature type

Subcategory

Category/CorrectionControl

CorrectionDataSize[CorrectionSelector]
Displays the current size of the correction data that is stored inside the camera.
Interface support

All

Display name

Correction Data Size

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/CorrectionControl/CorrectionInfo

CorrectionEntryType
Displays the entry type (correction type specific variant).
Interface support

All

Display name

Correction Entry TypeStandard

CustomOrigin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/CorrectionControl/CorrectionInfo

Alvium Features Reference V2.9.1

134

Feature descriptions: Camera

CounterAndTimerControl
The features in this category can be used to control counters and timers to enableadvanced triggering. For example, you can synchronize the timing for image
acquisition with strobe lights, using these features.
Interface support

All

Display nameCounter And Timer Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

CounterDuration[CounterSelector]
Controls the period of time until a CounterEnd event is generated, theCounterActive signal becomes inactive, and the counter is stopped.
Notes:• The counter is stopped until a new trigger occurs.
• The counter can be reset by CounterReset.
Interface support

All

Display nameCounter Duration

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/CounterAndTimerControl

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

135

Feature descriptions: Camera

CounterEventActivation[CounterSelector]
Selects the edge type of the electrical signal related to the event defined byCounterEventSource to increment the counter.
Note: The electrical signal level of the trigger to activate the counter is selected byCounterTriggerActivation.

Interface support

All

Display nameCounter Event Activation

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AcquisitionControl

ValuesDescription

AnyEdge

The encoder on the falling or rising edge of the signal is reset.

FallingEdge

The encoder on the falling edge of the signal is reset.

RisingEdge

The encoder on the rising edge of the signal is reset.

Alvium Features Reference V2.9.1

136

Feature descriptions: Camera

CounterEventSource[CounterSelector]
Selects the event to increment the counter.
Note: Use CounterEventActivation to define which electrical state of the signal
you want to be used.
Interface support

All

Display nameCounter Event Source

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description

AcquisitionActive

The AcquisitionActive signal increments the counter.

Action0

The Action0 signal increments the counter.

Action1

The Action1 signal increments the counter.

Counter0Active

The Counter0Active signal increments the counter.

Counter1Active

The Counter1Active signal increments the counter.

Counter2Active

The Counter2Active signal increments the counter.

Counter3Active

The Counter3Active signal increments the counter.

ExposureActive

The ExposureActive signal increments the counter.

Line0

A trigger signal on Line0 increments the counter.

Line1

A trigger signal on Line1 increments the counter.

Line2

A trigger signal on Line2 increments the counter.

Line3

A trigger signal on Line3 increments the counter.

OffThe feature is disabled.

SoftwareSignal0

The SoftwareSignal0 signal increments the counter.

SoftwareSignal1

The SoftwareSignal1 signal increments the counter.

Timer0Active

The Timer0Active signal increments the counter.

Timer1Active

The Timer1Active signal increments the counter.

Alvium Features Reference V2.9.1

137

Feature descriptions: Camera

CounterReset[CounterSelector]
Resets and restarts the selected counter.
Note: The counter is incremented immediately after the reset unless a counter
trigger is active.
Interface support

All

Display nameCounter Reset

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

CounterDuration, CounterStatus,
CounterTriggerActivation, CounterTriggerSource,CounterValue

Category/CounterAndTimerControl

CounterResetActivation[CounterSelector]
Selects the electrical signal level of the trigger to reset the counter.
Interface support

All

Display nameCounter Reset Activation

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AcquisitionControl

ValuesDescription

AnyEdge

The encoder on the falling or rising edge of the signal is reset.

FallingEdge

The encoder on the falling edge of the signal is reset.

LevelHighThe encoder at a high signal level is reset.

LevelLow

The encoder at a low signal level is reset.

RisingEdge

The encoder on the rising edge of the signal is reset.

Alvium Features Reference V2.9.1

138

Feature descriptions: Camera

CounterResetSource[CounterSelector]
Selects the event to reset the counter.
Interface support

All

Display nameCounter Reset Source

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description

AcquisitionActive

The AcquisitionActive signal resets the counter.

Counter0Active

The Counter0Active signal resets the counter.

Counter1Active

The Counter1Active signal resets the counter.

Counter2Active

The Counter2Active signal resets the counter.

Counter3Active

The Counter3Active signal resets the counter.

ExposureActive

The ExposureActive signal resets the counter.

Line0

A trigger signal on Line0 resets the counter.

Line1

A trigger signal on Line1 resets the counter.

Line2

A trigger signal on Line2 resets the counter.

Line3

A trigger signal on Line3 resets the counter.

OffThe feature is disabled.

SoftwareSignal0

The SoftwareSignal0 signal resets the counter.

SoftwareSignal1

The SoftwareSignal1 signal resets the counter.

Timer0Active

The Timer0Active signal resets the counter.

Timer1Active

The Timer1Active signal resets the counter.

Alvium Features Reference V2.9.1

139

Feature descriptions: Camera

CounterSelector
Selects the counter to configure.
Interface support

All

Display nameCounter Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description

Counter0Counter0Active is selected.

Counter1

Counter1Active is selected.

Counter2

Counter2Active is selected.

Counter3Counter3Active is selected.

CounterStatus[CounterSelector]
Displays the current status of the counter.
Interface support

All

Display nameCounter Status

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description

CounterActive

The counter is counting for the period of time specified
by CounterDuration.

CounterCompleted

The counter has reached the CounterDuration value.

CounterOverflow

The counter has reached its maximum possible count.

CounterTriggerWait The counter is waiting for a start trigger.
Idle

Alvium Features Reference V2.9.1

The counter is inactive.

140

Feature descriptions: Camera

CounterTriggerActivation[CounterSelector]
Selects the electrical signal level of the trigger to activate the counter.
Interface support

All

Display nameCounter Trigger Activation

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description

AnyEdge

The encoder on the falling or rising edge of the signal isreset.

FallingEdge

The encoder on the falling edge of the signal is reset.

LevelHighThe encoder at a high signal level is reset.

LevelLow

The encoder at a low signal level is reset.

RisingEdge

The encoder on the rising edge of the signal is reset.

Alvium Features Reference V2.9.1

141

Feature descriptions: Camera

CounterTriggerSource[CounterSelector]
Selects the event to trigger the counter.
Interface support

All

Display nameCounter Trigger Source

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description

AcquisitionActive

The AcquisitionActive signal starts the counter.

Counter0Active

The Counter0Active signal starts the counter.

Counter1Active

The Counter1Active signal starts the counter.

Counter2Active

The Counter2Active signal starts the counter.

Counter3Active

The Counter3Active signal starts the counter.

ExposureActive

The ExposureActive signal starts the counter.

Line0

A trigger signal on Line0 starts the counter.

Line1

A trigger signal on Line1 starts the counter.

Line2

A trigger signal on Line2 starts the counter.

Line3

A trigger signal on Line3 starts the counter.

OffThe feature is disabled.

SoftwareSignal0

The SoftwareSignal0 signal starts the counter.

SoftwareSignal1

The SoftwareSignal1 signal starts the counter.

Timer0Active

The Timer0Active signal starts the counter.

Timer1Active

The Timer1Active signal starts the counter.

Alvium Features Reference V2.9.1

142

Feature descriptions: Camera

CounterValue[CounterSelector]
Controls the current value of the selected counter.
Note: Writing to CounterValue is typically used to set the start value.
Interface support

All

Display nameCounter Value

Standard

SFNC (adapted)

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description0

Minimum value

4294967295

Maximum valueCounterValueAtReset[CounterSelector]
Displays the latest value of the selected counter before it was reset by a trigger orby an explicit CounterReset command.
Interface support

All

Display nameCounter Value At Reset

Standard

SFNC (adapted)

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

143

Feature descriptions: Camera

TimerDelay[TimerSelector]
Controls the duration of the delay at the reception of a trigger before starting thetimer.
Interface support

All

Display nameTimer Delay

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Microseconds

Affected features

Not applicable

Category/CounterAndTimerControl

ValuesDescription0

Minimum

429496729.5

Maximum

Alvium Features Reference V2.9.1

144

Feature descriptions: Camera

TimerDuration[TimerSelector]
Controls the duration of the timer pulse.
When the timer reaches the TimerDuration value:• For TimerStatus, the value is changed from TimerActive toTimerCompleted.
• The timer stops counting until the camera receives a new trigger, or until thetimer is explicitly reset with TimerReset.
Interface support

All

Display nameTimer Duration

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR/W

Unit

Microseconds

Affected features

Not applicable

Category/CounterAndTimerControl

ValuesDescription0

Minimum

429496729.5

Maximum

TimerReset[TimerSelector]
The selected timer is reset by software and restarted.
Note: The timer starts immediately after the reset unless a timer trigger is active.
Interface support

All

Display nameTimer Reset

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

TimerDelay, TimerDuration, TimerStatus,
TimerSelector, TimerTriggerActivation,
TimerTriggerSource

Category/CounterAndTimerControl

Alvium Features Reference V2.9.1

145

Feature descriptions: Camera

TimerSelector
Selects the timer to be configured.
Interface support

All

Display nameTimer Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

TimerDelay, TimerDuration, TimerReset, TimerStatus,
TimerTriggerActivation, TimerTriggerSource

Category/CounterAndTimerControl

Value

Description

Timer0Timer0 is selected.

Timer1

Timer1 is selected.

TimerStatus[TimerSelector]
Displays the current status of the selected timer.
Interface support

All

Display nameTimer Status

Standard

SFNC (adapted)

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description

TimerActive

The timer is active.

TimerCompleted

The timer has completed.

TimerDelay

The timer is delayed by the period of time set forTimerDelay.

TimerTriggerWait The timer is waiting for a trigger.

Alvium Features Reference V2.9.1

146

Feature descriptions: Camera

TimerTriggerActivation[TimerSelector]
Selects the electrical signal level of the trigger to activate the timer.
Interface support

All

Display nameTimer Trigger Activation

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description

AnyEdge

The timer is triggered by a signal on any edge.

FallingEdge

The timer is triggered by a signal on the falling edge.

LevelHighThe timer is triggered when signal level turns to high.

LevelLow

The timer is triggered when signal level turns to low.

RisingEdge

The timer is triggered by a signal on the rising edge.

Alvium Features Reference V2.9.1

147

Feature descriptions: Camera

TimerTriggerSource[TimerSelector]
Selects the electrical signal level of the trigger to start the selected timer.
Interface support

All

Display nameTimer Trigger Source

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/CounterAndTimerControl

Value

Description

AcquisitionActive The timer is triggered when the acquisition starts.
Action01

The timer is triggered by the Action0 command.

Action11

The timer is triggered by the Action1 command.

Counter0Active

The timer is triggered when Counter0 is active

Counter1Active

The timer is triggered when Counter1 is active

Counter2Active

The timer is triggered when Counter2 is active

ExposureActive2

The timer is triggered when the exposure starts.

Line0

The timer is triggered by a signal on input line 0.

Line1

The timer is triggered by a signal on input line 1.

Line23

The timer is triggered by a signal on input line 2.

Line33

The timer is triggered by a signal on input line 3.

Off

The timer is disabled or stopped (default).

SoftwareSignal0

The timer is triggered by SoftwareSignal0.

SoftwareSignal1

The timer is triggered by SoftwareSignal1.

Timer0Active

The timer is triggered when Timer0 is active

Timer1Active

The timer is triggered when Timer1 is active

1

Currently, available with Alvium G1/G5 cameras only.

2 Available for cameras with global shutter sensors and with rolling shutter senors

if TriggerMode is enabled or if AcquisitionMode is set to Continuous.

3

Available with Alvium G1/G5 and Alvium USB cameras. Alvium CSI-2 cameras
support Line0 and Line1 only.

Alvium Features Reference V2.9.1

148

Feature descriptions: Camera

DeviceControl
The features in this category can be used to display, such as the camera
temperature and name, firmware version, transport layer, or applied standard
versions for GenCP and SFNC.
Other features enable monitoring the link speed, controlling the bandwidth, andresetting the camera. Timestamp features are essential for counters and timers.
Interface support

All (most features)

Display name

Device Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

DeviceFamilyName
Displays the identifier of the product family of the camera.
Interface support

All

Display name

Device Family Name

Standard

SFNC

Origin of feature

CameraFeature type

StringAccessR

Affected features

Not applicable

Category/DeviceControl

DeviceFirmwareID[DeviceFirmwareIDSelector]
Displays one or a list of firmware IDs of the camera.
Interface support

All

Display name

Device Firmware ID

Standard

CustomOrigin of feature

CameraFeature type

StringAccessR

Affected features

Not applicable

Category/DeviceControl

Alvium Features Reference V2.9.1

149

Feature descriptions: Camera

DeviceFirmwareIDSelector
Selects the DeviceFirmwareID to be read after restarting the camera.
Interface support

All

Display name

Device Firmware ID Selector

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

DeviceFirmwareID

Category/DeviceControl

ValuesDescription

Current

The current firmware ID is selected to be read after the next
camera restart.

Supported

Another than the current firmware ID is selected to be read
after the next camera restart.

DeviceFirmwareVersion[DeviceFirmwareVersionSelector]
Displays the version of the firmware in the camera.
Interface support

All

Display name

Device Firmware Version

Standard

SFNC

Origin of feature

CameraFeature type

StringAccessR

Affected features

Not applicable

Category/DeviceControl/DeviceControl

Alvium Features Reference V2.9.1

150

Feature descriptions: Camera

DeviceFirmwareVersionSelector
Selects the DeviceFirmwareVersion to be read after restarting the camera.
Interface support

All

Display name

Device Firmware Version Selector

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

DeviceFirmwareVersion

Category/DeviceControl

ValuesDescription

Current

The current firmware version is selected to be read after the
next camera restart.

Programmed

Another than the current firmware version is selected to beread after the next camera restart.

DeviceGenCPVersionMajor
Displays the major version of the GenCP supported by the camera.
Interface support

CSI-2, USB

Display name

Device GenCP Version Major

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

DeviceGenCPVersionMinor

Category/DeviceControl

Alvium Features Reference V2.9.1

151

Feature descriptions: Camera

DeviceGenCPVersionMinor
Displays the minor version of the GenCP supported by the camera.
Interface support

CSI-2, USB

Display name

Device GenCP Version Minor

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

DeviceGenCPVersionMajor

Category/DeviceControl

DeviceIndicatorLuminanceControls the luminance of the indicators (such as LEDs) showing the status of thecamera.
Interface support

All

Display name

Device Indicator LuminanceStandard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/DeviceControl

ValuesDescription0

Minimum

10

Maximum

Alvium Features Reference V2.9.1

152

Feature descriptions: Camera

DeviceIndicatorMode
Selects the behavior of the indicators (such as LEDs) showing the status of thecamera.
Interface support

All

Display name

Device Indicator Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/DeviceControl

ValuesDescription

Active

The indicator is enabled.

ErrorStatus

The indicator signals an error status.

Inactive

The indicator is disabled.

DeviceLinkCommandTimeout
Displays the command timeout of the specified link.
Interface support

All

Display name

Device Link Command Timeout

Standard

SFNC

Origin of feature

CameraFeature type

Float

AccessR

Unit

Microseconds

Affected features

Not applicable

Category/DeviceControl

ValuesDescription0

Minimum

1,000,000,000

Maximum

Alvium Features Reference V2.9.1

153

Feature descriptions: Camera

DeviceLinkSpeed
Displays the speed of transmission negotiated and represents the total speed of all
the connections of the specified link.
Interface support

All

Display name

Device Link Speed

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Unit

Bytes per second

Affected features

Not applicable

Category/DeviceControl

Alvium Features Reference V2.9.1

154

Feature descriptions: Camera

DeviceLinkThroughputLimit
Controls the maximum bandwidth of the data streamed out by the camera on theselected link. Delays are uniformly inserted between transport layer packets
reducing the peak bandwidth.
Notes:• Use this feature to adjust camera data output to the performance of your hostsystem to avoid lost frames. Additionally, you may reduce the frame rate to
reduce bandwidth.
• Maximum values can be reduced by the bandwidth of the host system.
Interface support

GigE, USB

Display name

Device Link Throughput Limit

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR/W

Unit

Bytes per second

Affected features

ExposureTimeMax, ExposureTimeMin, ExposureAutoMin,
ExposureAutoMax, ExposureTime,
AcquisitionFrameRate

Category/DeviceControl

Values Alvium G1

Description

Camera model dependent

Minimum

125000000

Maximum

Values Alvium G5

Description

Camera model dependent

Minimum

625000000

Maximum

Values Alvium 1800 U

Description

Camera model dependent

Minimum

200000000

Default

450000000

Maximum

Alvium Features Reference V2.9.1

155

Feature descriptions: Camera

DeviceLinkThroughputLimitMode
Enable or disables DeviceLinkThroughputLimit.
When this feature is disabled, low-level transport layer (TL) specific features are
expected to control the throughput.
When this feature is enabled, DeviceLinkThroughputLimit controls the overallthroughput.
Interface support

GigE, USB

Display name

Device Link Throughput Limit Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

ExposureTimeMax, ExposureTimeMin, ExposureAutoMin,
ExposureAutoMax, ExposureTime,
AcquisitionFrameRate

Category/DeviceControl

ValuesDescription

Off

DeviceLinkThroughputLimit is disabled (GigE default).

On

DeviceLinkThroughputLimit is enabled (USB default).

DeviceManufacturerInfo
Displays the manufacturer information about the camera.
Interface support

All

Display name

Device Manufacturer Info

Standard

SFNC

Origin of feature

CameraFeature type

StringAccessR

Affected features

Not applicable

Category/DeviceControl

Alvium Features Reference V2.9.1

156

Feature descriptions: Camera

DeviceModelName
Displays the model name of the camera.
Interface support

All

Display name

Device Model Name

Standard

SFNC

Origin of feature

CameraFeature type

StringAccessR

Affected features

Not applicable

Category/DeviceControl

DevicePowerSavingMode
Selects between standard power use and various power saving modes.
Interface support

USB

Display name

Device Power Saving Mode

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/DeviceControl

ValuesDescription

Disabled

The camera uses standard power (default).

SuspendMode

The camera is enabled to go into USB U3 power saving
mode.1

1

To apply the selected power saving mode, the host must send a
DevicePowerSave command or a respective backend command to the camera.

Alvium Features Reference V2.9.1

157

Feature descriptions: Camera

DeviceReset
Resets the camera to its power up state.
Note: After reset, the camera must be rediscovered.
Interface support

All

Display name

Device Reset

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

Not applicable

Category/DeviceControl

DeviceSFNCVersionMajor
Displays the major version of the SFNC that was used to create the camera`s
GenICam XML.
Interface support

All

Display name

Device SFNC Version Major

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceControl

DeviceSFNCVersionMinor
Displays the minor version of the SFNC that was used to create the camera’s
GenICam XML.
Interface support

All

Display name

Device SFNC Version Minor

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceControl

Alvium Features Reference V2.9.1

158

Feature descriptions: Camera

DeviceSFNCVersionSubMinor
Displays the sub minor version of the SFNC that was used to create the camera’s
GenICam XML.
Interface support

All

Display name

Device SFNC Version Sub Minor

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceControl

DeviceScanType
Displays the scan type of the image sensor.
Interface support

All

Display name

Device Scan TypeStandard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/DeviceControl

ValuesDescription

Areascan2D area readout is selected.

Alvium Features Reference V2.9.1

159

Feature descriptions: Camera

DeviceSerialNumber
Displays the camera’s serial number.
Displays the unique identifier of the camera.
Interface support

All

Display name

Device Serial Number

Standard

SFNC

Origin of feature

CameraFeature type

StringAccessR

Affected features

Not applicable

Category/DeviceControl

DeviceStreamChannelPacketSize
Displays the stream packet size achieved on the selected channel for thetransmitter or the maximum packet size supported by the receiver.
Interface support

GigE

Display name

Device Stream Channel Packet Size

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Bytes

Affected features

Not applicable

Category/DeviceControl

Value

Description0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

160

Feature descriptions: Camera

DeviceTemperature[DeviceTemperatureSelector]
Displays the camera temperature in degrees Celsius [°C], measured at the location
selected by DeviceTemperatureSelector.
Interface support

All

Display name

Device TemperatureStandard

SFNC

Origin of feature

CameraFeature type

Float

AccessR

Unit

Degrees Celsius

Affected features

Not applicable

Category/DeviceControl

DeviceTemperatureSelector
Selects the location in the camera, where the temperature is to be measured.
Interface support

All

Display name

Device Temperature Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

DeviceTemperature

Category/DeviceControl

Value

Description

Mainboard

The mainboard temperature is measured.

FpgaCore1

The FPGA (companion board) temperature is measured.

PhyCore1

The physical interface temperature is measured.

1 Alvium G5 only.

Alvium Features Reference V2.9.1

161

Feature descriptions: Camera

DeviceTLVersionMajor
Displays the major version of the camera’s transport layer.
Interface support

All

Display name

Device Transport Layer Version Major

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceControl

Value

Description0

Minimum

4294967295

Maximum

DeviceTLVersionMinor
Displays the minor version of the camera transport layer.
Interface support

All

Display name

Device Transport Layer Version Minor

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceControl

Value

Description0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

162

Feature descriptions: Camera

DeviceUserID
Controls the user-programmable camera identifier.
Note: Maximum 63 characters are allowed.
Interface support

All

Display name

Device User ID

Standard

SFNC

Origin of feature

CameraFeature type

StringAccessR/W

Affected features

Not applicable

Category/DeviceControl

DeviceVendorName
Displays the name of the camera manufacturer.
Interface support

All

Display name

Device Vendor Name

Standard

SFNC

Origin of feature

CameraFeature type

StringAccessR

Affected features

Not applicable

Category/DeviceControl

DeviceVersion
Displays the camera’s product code.
Interface support

All

Display name

Device Version

Standard

SFNC

Origin of feature

CameraFeature type

StringAccessR

Affected features

Not applicable

Category/DeviceControl

Alvium Features Reference V2.9.1

163

Feature descriptions: Camera

TimestampLatch
Latches the current timestamp counter into TimestampLatchValue.
Interface support

All

Display name

Time Stamp Latch

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

TimestampLatchValue

Category/DeviceControl

TimestampLatchValue
Displays the latched value of the timestamp counter.
Interface support

All

Display nameTimestamp Latch Value

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/DeviceControl

Value

Description0

Minimum

9223372036854775807

Maximum

Alvium Features Reference V2.9.1

164

Feature descriptions: Camera

TimestampReset
Resets the current value of the timestamp counter.
Note: After executing this command, the timestamp counter restarts
automatically.
Interface support

All

Display nameTimestamp Reset

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

TimestampLatchValue

Category/DeviceControl

Alvium Features Reference V2.9.1

165

Feature descriptions: Camera

DigitalIOControl
The features in this category can be used to control the physical input and output
lines of the camera.
Interface support

All

Display name

Digital IO Control Info

Standard

SFNC adapted

Origin of feature

CameraFeature type

(Category)

LineDebounceDuration
Controls the time constant for LineDebounceMode.
Interface support

GigE, USB

Display nameLine Debounce Duration

Standard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Unit

Microseconds

Affected features

Not applicable

Category/DigitalIOControl

ValuesDescription

0.0193236715

Minimum

39.5748792271

Maximum

Alvium Features Reference V2.9.1

166

Feature descriptions: Camera

LineDebounceModeControls the Line Debouncing feature for a particular input line.
Interface support

GigE, USB

Display nameLine Debounce Mode

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

LineDebounceDuration

Category/DigitalIOControl

ValuesDescription

Delay

LineDebounceDuration controls how long the signal levelmust be sustained for before it is accepted.

Off

The feature is disabled (default).

Stall

LineDebounceDuration controls the intensity duration
after the falling edge of the signal.

LineInverter[LineSelector]
Enables or disables the inversion of the signal of the selected input or output line.
Interface support

All

Display nameLine Inverter

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Not applicable

Category/DigitalIOControl

ValuesDescription

False

Signal of the input or output line is not inverted.

True

Signal of the input or output line is inverted.

Alvium Features Reference V2.9.1

167

Feature descriptions: Camera

LineMode[LineSelector]
Selects the physical line to be used to input or output a signal.
Interface support

All

Display nameLine Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

TriggerSource, LineInverter, LineSource

Category/DigitalIOControl

ValuesDescription

Input

The physical line is used for signal input.

Output

The physical line is used for signal output.

LineSelector
Selects the physical line (or pin) of the external camera connector or the virtualline of the transport layer to configure.
Interface support

All

Display nameLine Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

LineMode, LineSource, LineInverter, LineStatus,
LineStatusAll

Category/DigitalIOControl

ValuesDescription

Line0Line 0 is selected for configuration.

Line1

Line 1 is selected for configuration.

Line2

Line 2 is selected for configuration.

Line3Line 3 is selected for configuration.

Alvium Features Reference V2.9.1

168Feature descriptions: Camera

LineSource[LineSelector]
Sets the output signal for the selected line.
Note: LineMode must be set to Output.
Interface support
Display nameStandard
Origin of feature
Feature type
AccessAffected features
CategoryAllLine Source
SFNC
CameraEnumeration
R/W
Not applicable/DigitalIOControl

ValuesDescription
AcquisitionActive The AcquisitionActive signal is output.
The Action0 command is output.
Action01
Action11Counter0Active...
Counter3Active
ExposureActive2
FrameTrigger
Wait
Line0Signal...

Line3Signal3
PpsSignal

Off
Stream0Transfer
ActiveTimer0Active
Timer1Active

The Action1 command is output.
The Counter0Active signal is output.
...
The Counter3Active signal is output.
The ExposureActive signal is output.
The FrameTriggerWait signal is output.
The Line0Signal signal is output.
...
The Line3Signal signal is output.
The PpsSignal of the pulse is output. You can use thissignal to verify that the devices’ clocks are synchronizedsufficiently for PTP.
No signal is output.
The Stream0TransferActive signal is output.
The Timer0Active signal is output.
The Timer1Active signal is output.

1 Currently, available with Alvium G1/G5 cameras only.
2

Available for cameras with global shutter sensors and with rolling shutter senors
if TriggerMode is enabled or if AcquisitionMode is set to Continuous.

3 Available with Alvium G1/G5 and Alvium USB cameras. Alvium CSI-2 cameras

support Line0 and Line1 only.

Alvium Features Reference V2.9.1

169

Feature descriptions: Camera

LineStatus[LineSelector]
Displays the current status of the selected input or output line.
Interface support

All

Display nameLine Status

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR

Affected features

Not applicable

Category/DigitalIOControl

ValuesDescription

False

Line status is disabled.

True

Line status is enabled.

LineStatusAll
Displays the current status of every input or output line in a sequence from Line0
to LineN in a single bitfield.
Interface support

All

Display nameLine Status All

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/DigitalIOControl

ValuesDescription0

Minimum

15

Maximum

Alvium Features Reference V2.9.1

170

Feature descriptions: Camera

SerialHubEnable
Enables or disables the serial port (UART).
Note: When this features is enabled, the corresponding lines become Rx and Tx.
Therefore, the user application can't control these lines then.
Interface support

All

Display name

Serial Hub Enable

Standard

CustomOrigin of feature

CameraFeature type

BooleanAccessR/W

Affected features

LineInverter, LineMode, LineSource

Category/DigitalIOControl

ValuesDescription

True

The serial port is enabled.

False

The serial port is disabled (default).

Available lines
For Alvium G1 and G5 cameras and for Alvium USB cameras, 2 lines can be used as
serial ports while 2 lines can be accessed by the user application at the same time.
For Alvium CSI-2 camera, 2 lines can be used as serial ports while the remaining 2lines are reserved for I2C traffic.:
UART signal

CSI-2 Lines

G1 / G5 lines

USB lines

UART Tx

Line2

Line0

Line2

UART Rx

Line3

Line1

Line3

Table 6: I/O lines available for serial ports by Alvium series
Changing between enabled and disabled serial ports
Previous line settings are not stored. You must reconfigure the corresponding lines
if you want to change between use as serial ports and access by the user
application.

Alvium Features Reference V2.9.1

171

Feature descriptions: Camera

SerialHub (subcategory)
The features in this subcategory enable using the I/Os by UART for serial port.
Interface support

All

Display name

Serial Hub

Standard

CustomOrigin of feature

CameraFeature type

Subcategory

Category/DigitalIOControl

SerialBaudRate
Selects the baud rate of the UART port.
Interface support

All

Display nameUart Baud Rate

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Unit

Baud = Bps (Bits per second)

Affected features

LineMode, LineInverter, LineSource

Category/DigitalIOControl/SerialHub

ValuesDescription

Baud_9600

9600 Baud is selected.

Baud_115200

115200 Baud is selected.

Baud_230400

230400 Baud is selected.

Alvium Features Reference V2.9.1

172

Feature descriptions: Camera

SerialParityBit
Selects the Parity Bit at the end of UART frames.
Interface support

All

Display name

Serial Parity Bit

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Unit

Baud = Bps (Bits per second)

Affected features

Not applicable

Category/DigitalIOControl/SerialHub

ValuesDescription

Even

The number of 1 bits in frame is even.

Mark

The parity bit is always set to 1.

None

No parity bit is in the frame.

Odd

The number of 1 bits in frame is odd.

Space

The parity bit is always set to 0.

SerialRxData
Displays the data to be fetched from the Rx queue.
Interface support

All

Display name

Serial Rx Data

Standard

CustomOrigin of feature

CameraFeature type

Raw

AccessR

Affected features

Not applicable

Category/DigitalIOControl/SerialHub

Alvium Features Reference V2.9.1

173

Feature descriptions: Camera

SerialRxSize
Controls the number of bytes inserted from the Rx queue.
Interface support

All

Display name

Serial Rx Size

Standard

CustomOrigin of feature

CameraFeature type

Integer

Access

R/W

Unit

Bytes

Affected features

Not applicable

Category/DigitalIOControl/SerialHub

ValuesDescription

1

Minimum

4

Default

128

Maximum

SerialRxWaiting
Displays the number of bytes from the Rx queue waiting to be received.
Interface support

All

Display name

Serial Rx WaitingStandard

CustomOrigin of feature

CameraFeature type

Integer

Access

R

Unit

Bytes

Affected features

Not applicable

Category/DigitalIOControl/SerialHub

ValuesDescription0

Minimum

128

Maximum

Alvium Features Reference V2.9.1

174

Feature descriptions: Camera

SerialStopBits
Controls the number of stop bits at the end of UART frames.
Interface support

All

Display name

Serial Stop Bits

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/DigitalIOControl/SerialHub

ValuesDescription

1

Minimum (default)

2

Maximum

SerialTxData
Controls the data that will be transmitted to the TX queue of the serial interface.
Interface support

All

Display name

Serial Tx Data

Standard

CustomOrigin of feature

CameraFeature type

Raw

AccessR/W

Affected features

Not applicable

Category/DigitalIOControl/SerialHub

Alvium Features Reference V2.9.1

175Feature descriptions: Camera

SerialTxLock
Locks or unlocks the transmission from the Tx queue.
When unlocked, the Tx queue is immediately sent over the serial port.
Interface support

All

Display name

Serial Tx Lock

Standard

CustomOrigin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Not applicable

Category/DigitalIOControl/SerialHub

ValuesDescription

True

The transmission from the Tx queue is locked.

False

The transmission from the Tx queue is unlocked (default).

Alvium Features Reference V2.9.1

176

Feature descriptions: Camera

SerialTxRemaining
Displays the number bytes from the Tx queue that remain free.
Interface support

All

Display name

Serial Tx Remaining

Standard

CustomOrigin of feature

CameraFeature type

Integer

Access

R

Unit

Bytes

Affected features

Not applicable

Category/DigitalIOControl/SerialHub

ValuesDescription0

Minimum

128

Maximum

SerialTxSize
Controls the number of bytes from the Tx data to be inserted into the Tx queue.
Interface support

All

Display name

Serial Tx Size

Standard

CustomOrigin of feature

CameraFeature type

Integer

Access

R/W

Unit

Bytes

Affected features

Not applicable

Category/DigitalIOControl/SerialHub

ValuesDescription

1

Minimum

4

Default

128

Maximum

Alvium Features Reference V2.9.1

177

Feature descriptions: Camera

FileAccessControl
The features in this category enable to read from and write files to the camera,
including such as firmware, user data, or datasets for DPC (Defect pixel correction)
and FPNC (Fixed pattern noise correction).
Interface support

All

Display name

File Access Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

FileAccessBuffer
Displays the intermediate access buffer that allows the exchange of data between
the camera file storage and the application.
Interface support

All

Display name

File Access Buffer

Standard

SFNC

Origin of feature

CameraFeature type

RegisterAccessR

Affected features

Not applicable

Category/FileAccessControl

FileAccessLength
Displays the length of the mapping between the camera file storage and
FileAccessBuffer.
Interface support

All

Display name

File Access Length

Standard

SFNC

Origin of feature

CameraFeature type

RegisterAccessR

Affected features

Not applicable

Category/FileAccessControl

Alvium Features Reference V2.9.1

178

Feature descriptions: Camera

FileAccessOffset
Displays the offset of the mapping between the camera file storage and theFileAccessBuffer.
Interface support

All

Display name

File Access Offset

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/FileAccessControl

FileOpenMode
Selects the access mode in which a file is opened in the camera.
Interface support

All

Display name

File Open Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/FileAccessControl

ValuesDescription

Read

Read access is enabled.

Write

Write access is enabled.

Alvium Features Reference V2.9.1

179

Feature descriptions: Camera

FileOperationExecute
Executes the operation selected by FileOperationSelector on the selected file.
Interface support

All

Display name

File Operation ExecuteStandard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

FileAccessBuffer, FileAccessOffset,
FileAccessLength, FileOperationStatus,
FileOperationResult, FileSize

Category/FileAccessControl

FileOperationResult[FileSelector][FileOperationSelector]
Displays the file operation result. For read or write operations, the number ofsuccessfully read or written bytes is returned.
Interface support

All

Display name

File Operation Result

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/FileAccessControl

Alvium Features Reference V2.9.1

180

Feature descriptions: Camera

FileOperationSelector[FileSelector]
Selects the target operation for the selected file in the camera. This operation is
executed when the FileOperationExecute feature is called.
Damage to the defect pixel correction data set
If you select DefectPixelCorrectionPreset for FileSelector, you also havewrite access. This way, the DPC correction data from manufacturing can be
overwritten.
Before you write to this data set, read and save the data to an external source forrecovery!
Interface support

All

Display name

File Operation Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

FileOperationExecute, FileAccessBuffer,
FileAccessOffset, FileAccessLength,
FileOperationStatus, FileOperationResult, FileSize

Category/FileAccessControl

ValuesDescription

Close

The selected file s closed.

DeleteThe selected file is deleted.

Open

The selected file is opened.

Read

The selected file is read from.

Write

The selected file is written to.

Alvium Features Reference V2.9.1

181

Feature descriptions: Camera

FileOperationStatus[FileSelector][FileOperationSelector]
Displays the file operation execution status.
Interface support

All

Display name

File Operation Status

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/FileAccessControl

ValuesDescription

FailureFile operation failed.

Success

File operation was successful (default).

FileProcessStatus[FileSelector]
Displays an additional process status.
Interface support

All

Display name

File Process Status

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/FileAccessControl

ValuesDescription

None

No extended status (default).

UpdateNotRequired

No file operation is required, because flash and filecontent are identical.

Alvium Features Reference V2.9.1

182

Feature descriptions: Camera

FileSelector
Selects the target file in the camera.
Damage to the defect pixel correction data set
If you select DefectPixelCorrectionPreset for FileSelector, you also havewrite access. This way, the DPC correction data from manufacturing can be
overwritten.
Before you write to this data set, read and save the data to an external source forrecovery!
Interface support

All

Display name

File Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

FileStatus, FileSize, FileOpenMode,
FileOperationSelector, FileOperationExecute,
FileAccessBuffer, FileAccessOffset,
FileAccessLength, FileOperationStatus,
FileOperationResult

Category/FileAccessControl

ValuesDescription

DefectPixel
CorrectionPreset

The preset for defect pixel correction (DPC) istarget for file operations.

DefectPixel
CorrectionUser

User defined defect pixel correction (DPC) is target
for file operations.

FirmwareFirmware is target for file operations.

FixedPattern
NoiseCorrectionPreset

The preset for fixed pattern noise correction(FPNC) is target for file operations.

FixedPattern
NoiseCorrectionUser

User defined fixed pattern noise correction (FPNC)
user set is target for file operations.

UserData

User data is target for file operations.

UserSet1

UserSet1 target for file operations.

UserSet2

UserSet2 target for file operations.

UserSet3

UserSet3 target for file operations.

UserSet4

UserSet4 target for file operations.

Alvium Features Reference V2.9.1

183

Feature descriptions: Camera

FileSize[FileSelector]
Displays the size of the selected file in bytes.
Interface support

All

Display name

File Size

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/FileAccessControl

FileStatus[FileSelector]
Displays the status of the selected file.
Interface support

All

Display name

File Status

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/FileAccessControl

ValuesDescription

ClosedThe selected file is currently closed (default).

Open

The selected file is currently open.

Alvium Features Reference V2.9.1

184

Feature descriptions: Camera

ImageFormatControl
The features in this category can be used to control pixel related data, including
binning and ROI (region of interest), and reverse image. PixelFormat andPixelSize enable selecting between different modes for Date of document
release and color pixel readout.
SensorBitDepth can be used to control the bandwidth by different sensor

readout modes (ADC).

When set to GlobalResetReleaseShutter, sensor lines are integrated
simultaneously for selected rolling shutter sensors with ShutterMode.
Interface support

All (most features)

Display nameImage Format Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

BinningHorizontal
Controls the number of horizontal pixels combined into one. This reduces thehorizontal resolution (width) of the image.
Note: For Alvium models ≥12 MP resolution, if BinningVertical is used,
BinningHorizontal is set to 2.
Interface support

All

Display nameBinning Horizontal

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

WidthMax

Category/ImageFormatControl

ValuesDescription

1

Minimum

8

Maximum

Alvium Features Reference V2.9.1

185

Feature descriptions: Camera

BinningHorizontalMode
Determines whether the result of binned pixels is averaged or summed up.
Note: Changing BinningHorizontalMode sets BinningVerticalMode to thesame value.
Interface support

All

Display nameBinning Horizontal Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AcquisitionFrameRate, BinningHorizontal,
BinningVertical, BinningVerticalMode,
DeviceLinkThroughputLimit, ExposureAutoMax,
ExposureAutoMin, ExposureTime, HeightMax,
WidthMax

Category/ImageFormatControl

ValuesDescription

Average

The charge or gray value of adjacent pixels is averaged.

Sum

The charge or gray value of adjacent pixels is summed up.

Alvium Features Reference V2.9.1

186

Feature descriptions: Camera

BinningSelector
Selects which binning engine is controlled by BinningHorizontal andBinningVertical.
Interface support

All

Display nameBinning Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AcquisitionFrameRate, BinningHorizontal,
BinningHorizontalMode, BinningVertical,
BinningVerticalMode, DeviceLinkThroughputLimit,
ExposureAutoMax, ExposureAutoMin, ExposureTime,
HeightMax, WidthMax

Category/ImageFormatControl

ValuesDescription

DigitalDigital binning is used (default).

Sensor*Sensor binning is used.

*Availability only for selected models.
In Sensor mode, vertical binning is disabled and BinningHorizontalMode canbe set to Sum only.

Alvium Features Reference V2.9.1

187

Feature descriptions: Camera

BinningVerticalControls the number of vertical pixels combined into one. This reduces the verticalresolution (height) of the image.
Interface support

All

Display nameBinning Vertical

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

AcquisitionFrameRate, BinningHorizontal,
DeviceLinkThroughputLimit, ExposureAutoMax,
ExposureAutoMin, ExposureTime, HeightMax,
WidthMax

Category/ImageFormatControl

ValuesDescription

1

Minimum

8

Maximum

Alvium Features Reference V2.9.1

188

Feature descriptions: Camera

BinningVerticalMode
Determines whether the result of binned pixels is averaged or summed up.
Note: Changing BinningVerticalMode sets BinningHorizontalMode to thesame value.
Interface support

All

Display nameBinning Vertical Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AcquisitionFrameRate, BinningHorizontal,
BinningVertical, BinningHorizontalMode,
DeviceLinkThroughputLimit, ExposureAutoMax,
ExposureAutoMin, ExposureTime, HeightMax,
WidthMax

Category/ImageFormatControl

ValuesDescription

Average

The charge or gray value of adjacent pixels is averaged.

Sum

The charge or gray value of adjacent pixels is summed up.

HeightControls the image height output by the camera.
Interface support

All

Display name

HeightStandard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

OffsetY, AutoModeRegionOffsetY,
AutoModeRegionHeight, AcquisitionFrameRate,
PayloadSize

Category/ImageFormatControl

Alvium Features Reference V2.9.1

189

Feature descriptions: Camera

HeightMax
Displays the available maximum image height.
Note: This dimension is calculated after vertical binning or any other functionchanging the vertical dimension of the image.
Interface support

All

Display name

Height Max

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Pixel

Affected features

Height, OffsetY

Category/ImageFormatControl

OffsetX
Controls the horizontal offset from the origin to the ROI.
Interface support

All

Display nameOffset X

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

AutoModeRegionOffsetX, AutoModeRegionWidth

Category/ImageFormatControl

ValuesDescription0

Minimum

Alvium Features Reference V2.9.1

190

Feature descriptions: Camera

OffsetY
Controls the vertical offset from the origin to the ROI.
Interface support

All

Display nameOffset Y

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

AutoModeRegionOffsetY, AutoModeRegionHeight

Category/ImageFormatControl

ValuesDescription0

Minimum

PixelFormat
Selects the pixel format output by the camera.
Note: The feature represents all the information provided by PixelCoding,
PixelSize, and PixelColorFilter combined in a single feature.
Interface support

All

Display name

Pixel Format

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

DeviceLinkThroughputLimit, PayloadSize, PixelSize,BlackLevel, ContrastEnable, ContrastDarkLimit,
ContrastBrightLimit, BlackLevel, Hue, Saturation,
ColorTransformationEnable,
ColorTransformationValue, HeightMax, WidthMax

Category/ImageFormatControl

Alvium Features Reference V2.9.1

191

Feature descriptions: Camera

PixelSize
Displays the total size of a pixel of the image as Bits per pixel (Bpp).
Interface support

All

Display name

Pixel Size

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

Access

R

Unit

Bits

Affected features

Not applicable

Category/ImageFormatControl

ReverseX
Enables or disables to flip the image horizontally.
Note: The ROI is applied after the flipping.
Interface support

All

Display name

Reverse X

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Width, WidthMax (color cameras)

Category/ImageFormatControl

ValuesDescription

False

Image is not flipped horizontally.

True

Image is flipped horizontally.

Alvium Features Reference V2.9.1

192

Feature descriptions: Camera

ReverseY
Enables or disables to flip the image vertically.
Note: The ROI is applied after the flipping.
Interface support

All

Display name

Reverse Y

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Height, HeightMax (color cameras)

Category/ImageFormatControl

ValuesDescription

False

Image is not flipped vertically.

True

Image is flipped vertically.

Alvium Features Reference V2.9.1

193Feature descriptions: Camera

SensorBitDepth
Selects the readout mode of the camera sensor.
If you are using pixel formats that do not require 12-bit readout and you want toachieve higher frame rates, you can select between readout modes for 12-bit,
10-bit, and 8-bit.
Notes• The sensor ADC bit depth is the default value.
• In the Adaptive mode, the bit depth is switched between 10-bit and 12-bit
automatically, depending on the selected pixel format and limitations of sensor
and camera.
Interface support

GigE, USB

Display nameSensor Bit DepthStandard

CustomOrigin of feature

CameraFeature type

Enumeration

Access

R/W

Unit

Bits

Affected features

AcquisitionFrameRate, DeviceLinkThroughputLimit,
ExposureActiveMode, ExposureAuto,
ExposureAutoMax, ExposureAutoMin, ExposureMode,
ExposureTime

Category/ImageFormatControl

Values1

Description

Adaptive

The sensor bit depth is switched automatically between 12bit and 10-bit readout, depending on the pixel format.
(Default value for all camera models.)

Bpp8

The sensor bit depth is set to 8-bit, if supported by thesensor.

Bpp10

The sensor bit depth is set to 10-bit, if supported by thesensor.

Bpp12

The sensor bit depth is set to 12-bit if the camera sensor
supports 12-bit readout mode.

1Camera model dependent

Alvium Features Reference V2.9.1

194Feature descriptions: Camera

SensorHeight
Displays the effective sensor height.
Interface support

All

Display nameSensor HeightStandard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Pixel

Affected features

HeightMax

Category/ImageFormatControl

SensorWidth
Displays the effective sensor width.
Interface support

All

Display nameSensor Width

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Pixel

Affected features

WidthMax

Category/ImageFormatControl

Alvium Features Reference V2.9.1

195Feature descriptions: Camera

MultipleRegionControl (subcategory)This subcategory holds the features to configure and control the multiple regionsof the camera.
Interface support

GigE, USB

Display nameMultiple Region Control

Standard

CustomOrigin of feature

CameraFeature type

(Subcategory)Category/ImageFormatControl

First overview
Multiple region features can be used to assign different image settings to sectionsof an image, or to exclude irrelevant contents from the image output. In somecases, frame rates can be increased as well.

i

Availability by model
You can find the feature availability for your Alvium model in the feature
specifications of your camera's user guide at www.alliedvision.com/en/support/
technical-documentation.

Features available with multiple regions
The following features for image control can be adjusted separately:
•
•
•
•
•
•
•
•
•
•
•
•

Hue
BalanceRatioBlue
BalanceRatioRed
ColorTransformationEnable
ColorTransformationValueContrastBrightLimit
ContrastDarkLimit
ContrastEnable
ContrastShape
Gamma
Hue
Saturation

Features disabled by multiple regions
The following features are disabled when multiple regions are used:•••

ReverseX
ReverseY

Binning features

Multiple regions cannot be configured when these features are enabled.

Alvium Features Reference V2.9.1

196

Feature descriptions: Camera

Multiple region arrangement
SubRegionSelector is set to Region0 by default for all camera models. For
cameras that support only single ROI, no other regions or multiple region features
are available. Selected Alvium models support 4 regions.

Free mode

Region1

Region1

Region3

Region2

Camera output

Region2Sensor input

Sensor area

Region3

Region0

Region0

Figure 7: Free mode - sensor input vs. camera output

Tile mode
Sensor input

Region0

Camera output

Region1

Region3

Region0

Region2

Region1

Region3

Sensor area

Region2

Figure 8: Tile mode - sensor input vs. camera output

Horizontal mode

Region1

Camera output

Region3

Region0

Region1

Region2

Region0

Sensor input

Region2Sensor area

Region3

Figure 9: Horizontal mode - sensor input vs. camera output

Alvium Features Reference V2.9.1

197

Feature descriptions: Camera

Vertical mode
Sensor area

Sensor input

Camera output
Region0
Region1

Region0

Region2

Region1
Region2

Region3

Region3

Figure 10: Vertical mode - sensor input vs. camera output

Rules for region ID numbers
Generally, the IDs for SubRegionSelector must be assigned continuously,
ascending from Region0, to output the selected regions completely.
In Tile mode, if an ID is missing in a line or column space, the following regions
are omitted, as shown in the top example of Figure 11 where Region1 andRegion2 have been disabled.
In the example below, Region0 and Region2. do not have continuous IDs, but theyshare a common line space. Therefore, the selected regions are output completely.
Sensor input

Camera output

disabled
Region0

Region1

Region2

Region3

Region0disabled
Region0
Region3disabled
Region0

Region1

Region0

Region2

Region3

Region2disabled
Region0
Region2

Figure 11: Tile mode - missing Region1

Alvium Features Reference V2.9.1

198

Feature descriptions: Camera

In Horizontal and Vertical mode, the values for SubRegionSelector must be
assigned continuously. If an ID is missing, the following regions are omitted, as
shown in the top example of Figure 12 where Region1 has been disabled. In theexample below, the regions have been reassigned for Region1 and Region2. The
selected regions are output completely.
Region2

Camera output
Region3

Region0

Region2

Region3

Region0

Region1

Sensor input

Region2

Region1

Region2

Region1

Region0

Region0

Region0

Region1disabled

Region2disabled
Region0

Figure 12: Horizontal mode - missing Region1

Region arrangement modes data at a glance
Table 7 shows ranges for MultipleRegionArrangement modes.
Arrangement
mode

Number of
Availability1 regions2
Position

Subregion ID Pixel
order
gaps

Free mode3

All

Free

Free
Common values for

SubRegionOffsetX andSubRegionWidth with regions

Tile

arranged one above anotherAll

Common values for

1 to 4See Figure 8,
Figure 11

SubRegionOffsetY and
SubRegionHeight with regions

Yes

arranged next to one another
HorizontalSomecamerasVerticalSomecamerasCommon values for

SubRegionOffsetY and
SubRegionHeight

Common values for

SubRegionOffsetX andSubRegionWidth

Left to right
Top tobottom1 For cameras that support multiple regions
2 Regions must not overlap
3 Default

Table 7: Ranges for MultipleRegionArrangement modes

Alvium Features Reference V2.9.1

199

Feature descriptions: Camera

Values for width, height, and offsets
When multiple regions are enabled, feature values are:• Width = Number of horizontal pixels of the output image• Height = Number of vertical pixels of the output image• OffsetX = Horizontal offset from the top left corner of the sensor image• OffsetY = Vertical offset from the top left corner of the sensor image

Single ROI and AutoModeControl
Multiple regions are part of the functional family for regions cropped out of the fullsensor image. The following section describes the relation between thesefunctions.

Single ROIMultiple regions can be set while the camera is operated in single ROI mode.
Changes become effective when MultipleRegionEnable is set to True.
When Region0 is activated in multiple regions for the first time, the feature values
for the active single ROI (or the full sensor image) are taken over. When features
for Region0 have been adjusted separately and multiple regions are disabled, thelast values for Region0 are applied for the single ROI (or the full sensor image).
Switching between ROI modes
We recommend you not to switch between single ROI and multiple ROI.

Auto mode regions
Auto mode regions equal single ROI (or the full sensor image) by default. Size andposition of auto mode regions can be adjusted to subsets. See Regions of interest
and auto mode regions on page 33.
When multiple regions are enabled, auto mode regions are automatically adjusted
to match Region0. Therefore, when Region0 is adjusted, an active auto mode
region is adjusted simultaneously. Afterwards, auto mode regions can be adjusted,but only as a subset of Region0.
When multiple regions are disabled, size and position for Region0 is applied forthe auto mode regions.

Alvium Features Reference V2.9.1

200

Feature descriptions: Camera

MultipleRegionArrangement
Selects the position of the separate ROIs in the merged image.
Note: ROIs cannot overlap.
Interface support

GigE, USB

Display nameMultiple Region Arrangement

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Height, OffsetX, OffsetY, Width

Category/ImageFormatControl/MultipleRegionControl

ValuesDescription

Tile

Selects 2 to 4 regions that add to a common rectangle
without gaps.

Horizontal

Selects 2 to 4 regions next to each other that add to acommon rectangle without gaps.

Vertical

Selects 2 to 4 regions above each other that add to acommon rectangle without gaps.

Free

Selects 2 to 4 regions in free arrangement, allowing gaps
(default).

Alvium Features Reference V2.9.1

201

Feature descriptions: Camera

MultipleRegionEnable
Selects between single region and multiple regions mode. The number ofsubregions to be configured depends on the camera model.
Interface support

GigE, USB

Display nameMultiple Region Enable

Standard

CustomOrigin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Height, OffsetX, OffsetY, Width

Category/ImageFormatControl/MultipleRegionControl

ValuesDescription

False

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

True

Subregions mode is enabled. Height, OffsetX, OffsetY,
and Width features are locked and are automaticallyaligned with the values set for subregions.

Alvium Features Reference V2.9.1

202

Feature descriptions: Camera

SubRegionHeight[SubRegionSelector]
Height of the selected subregion.
Note: If values are entered that are not dividable by 8, SubRegionHeight isincreased automatically to the next higher available value. For example, if 9 isentered, the value is increased to 16.
Interface support

GigE, USB

Display name

Sub Region HeightStandard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features

Height, Width

Category/ImageFormatControl/MultipleRegionControl

ValuesDescription

Model dependent

Minimum(Height max)

Maximum, depending on the height of other subregions

Model dependent

Increment

SubRegionMode[SubRegionSelector]
Enables or disables the selected subregion.
Interface support

GigE, USB

Display name

Sub Region Mode

Standard

CustomOrigin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Height, OffsetX, OffsetY, Width

Category/ImageFormatControl/MultipleRegionControl

ValuesDescriptionOn

The selected subregion is enabled.

OffThe selected subregion is disabled (default).

Alvium Features Reference V2.9.1

203

Feature descriptions: Camera

SubRegionOffsetX[SubRegionSelector]
X-offset of the selected subregion.
Note: If values are entered that are not dividable by 8, SubRegionOffsetX is
increased automatically to the next higher available value. For example, if 18 isentered, the value is increased to 32.
Interface support

GigE, USB

Display name

Sub Region Offset X

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features

OffsetX

Category/ImageFormatControl/MultipleRegionControl

ValuesDescription

Model dependent

Minimum(Height max)

Maximum, depending on the height of other subregions

Model dependent

Increment

Alvium Features Reference V2.9.1

204Feature descriptions: Camera

SubRegionOffsetY[SubRegionSelector]
Y-offset of the selected subregion.
Note: If values are entered that are not dividable by 8, SubRegionOffsetY isincreased automatically to the next higher available value. For example, if 9 isentered, the value is increased to 16.
Interface support

GigE, USB

Display name

Sub Region Offset Y

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features

OffsetY

Category/ImageFormatControl/MultipleRegionControl

ValuesDescription

Model dependent

Minimum(Height max)

Maximum, depending on the height of other subregions

Model dependent

Increment

Alvium Features Reference V2.9.1

205

Feature descriptions: Camera

SubRegionSelector
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.
Interface support

GigE, USB

Display name

Sub Region Selector

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

SubRegionHeight, SubRegionMode, SubRegionWidth,
SubRegionOffsetX, SubRegionOffsetY

Category/ImageFormatControl/MultipleRegionControl

Values1

Description

Region0

Minimum

RegionN

Maximum

Alvium Features Reference V2.9.1

206

Feature descriptions: Camera

SubRegionWidth[SubRegionSelector]
Width of the selected subregion.
Note: If values are entered that are not dividable by 8, SubRegionWidth isincreased automatically to the next higher available value. For example, if 626 isentered, the value is increased to 640.
Interface support

GigE, USB

Display name

Sub Region HeightStandard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Unit

PixelsAffected features

HeightCategory/ImageFormatControl/MultipleRegionControl

ValuesDescription

Model dependent

Minimum(Height max)

Maximum, depending on the height of other subregions

Model dependent

Increment

Alvium Features Reference V2.9.1

207

Feature descriptions: Camera

ImageFormatControl (category continued)
The feature descriptions for the /ImageFormatControl/MultipleRegion
Control subcategory have ended on the previous page. The following featurescontinue the /ImageFormatControl category, without a subcategory.

ShutterMode
Selects the shutter type for cameras where the sensor can be operated in different
shutter modes.
Interface support

All

Display nameShutter Mode

Standard

SFNC adapted

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/ImageFormatControl

Values*Description

GlobalResetReleaseShutter The camera is operated using global reset

release shutter (GRS).

GlobalShutter

The camera is operated using global shutter(GS).

RollingShutter

The camera is operated using rolling shutter(RS).

*Camera model dependent

Alvium Features Reference V2.9.1

208

Feature descriptions: Camera

WidthControls the image width of the image output by the camera.
Interface support

All

Display name

WidthStandard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Pixel

Affected features

OffsetX, AutoModeRegionOffsetX,
AutoModeRegionWidth, AcquisitionFrameRate,
ExposureAutoMin, ExposureAutoMax, ExposureTime,
PayloadSize

Category/ImageFormatControl

WidthMax
Displays the available maximum image width.
Note: The dimension is calculated after horizontal binning or any other functionchanging the horizontal dimension of the image.
Interface support

All

Display nameWidth Max

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Pixel

Affected features

Width, OffsetXCategory/ImageFormatControl

Alvium Features Reference V2.9.1

209

Feature descriptions: Camera

ImageProcessingControl
The features in this category enable on-board image processing for contrast, noise
suppression and convolution filters, sharpness and blur. You can use
ColorInterpolation to select the number of merged pixels used for debayering.
Interface support

All

Display nameImage Processing Control

Standard

CustomOrigin of feature

CameraFeature type

(Category)

AdaptiveNoiseSupressionFactor
Controls the amount of the noise suppression.
Interface support

All

Display name

Adaptive Noise Supression Factor

Standard

CustomOrigin of feature

CameraFeature type

Float

AccessR/W

Affected features

Not applicable

Category/ImageProcessingControl

ValuesDescription

0.5

Minimum value

1

The feature is disabled.

2

Maximum value

Alvium Features Reference V2.9.1

210

Feature descriptions: Camera

ColorInterpolation
Selects the ColorInterpolation filter.
Note: This feature is available only with color models.
Interface support

All

Display name

Color Interpolation

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/ImageProcessingControl

ValuesDescription

Basic2x2

Basic 2×2 algorithm for debayering is selected.

Bilinear3x3

A standard 3×3 algorithm for debayering is selected.

HighQuality
Linear5x5

A high-quality linear interpolation for debayering is selected(default).

Alvium Features Reference V2.9.1

211

Feature descriptions: Camera

ContrastControl (subcategory)
The features in this subcategory enable on-board image processing for contrast.
Interface support

All

Display nameContrast Control

Standard

CustomOrigin of feature

CameraFeature type

Subcategory

Category/ImageProcessingControl

ContrastBrightLimit
Selects the maximum gray value for the image.
Note: The current value ranges displayed for 8-bit and 10-bit pixel formats arehigher than the calculated values.
Interface support

All

Display nameContrast Bright Limit

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features

ContrastDarkLimit

Category/ImageProcessingControl/ContrastControl

ValuesDescription

ContrastDarkLimit + 1

The minimum value is selected.

4095

The maximum value is selected.

Pixel bit depth[bit]

Value range

Calculated value range

8

0 to 4095

0 to 255

1/
16

10

0 to 4095

0 to 1023

1

12

Alvium Features Reference V2.9.1

0 to 4095

Pixel count perincrement

/4

1

212

Feature descriptions: Camera

ContrastDarkLimit
Selects the minimum gray value for the image.
Note: The current value ranges displayed for 8-bit and 10-bit pixel formats arehigher than the calculated values. See ContrastBrightLimit on page 212.
Interface support

All

Display nameContrast Dark Limit

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features

ContrastBrightLimit

Category/ImageProcessingControl/ContrastControl

ValuesDescription0

The minimum value is selected.

ContrastBrightLimit – 1

The maximum value is selected.

ContrastEnable
Enables or disables the contrast enhancement features.
Interface support

All

Display nameContrast Enable

Standard

CustomOrigin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Not applicable

Category/ImageProcessingControl/ContrastControl

ValuesDescription

False

The feature is disabled.

True

The feature is enabled.

Alvium Features Reference V2.9.1

213

Feature descriptions: Camera

ContrastShapeControls the sigmoid shape of the transfer curve.
Interface support

All

Display nameContrast ShapeStandard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/ImageProcessingControl/ContrastControl

ValuesDescription

1

Minimum value

4

Default value

10

Maximum value

1

Increment

Figure 13 and Figure 14 on page 215 show the transfer curves for different values.

Figure 13: Image transfer for a value of 1.

Alvium Features Reference V2.9.1

214Feature descriptions: Camera

Figure 14: Image transfer for a value of 9.

Alvium Features Reference V2.9.1

215

Feature descriptions: Camera

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

ConvolutionMode
Selects the convolution filter to process the image.
Various filters enable to reduce image noise, emphasize the edges of an image, orto perform individual image processing.
Interface support

All

Display name

Convolution Mode

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AdaptiveNoiseSuppression,
CustomConvolutionValue, Sharpness

Category/ImageProcessingControl

ValuesDescription

AdaptiveNoiseSuppression To reduce noise while keeping the edges, theadaptive noise suppression is selected,(controlled by
AdaptiveNoiseSuppressionFactor).

CustomConvolution

Your individual settings defined in
CustomConvolutionValue are selected.

Off

The feature is disabled (default).

Sharpness

To increase the contrast of edges, the sharpness
mode is selected, (controlled by Sharpness).

Alvium Features Reference V2.9.1

216

Feature descriptions: Camera

CustomConvolutionValue[CustomConvolutionValueSelector]
Sets the value for the convolution filter selected by
CustomConvolutionValueSelector.
Interface support

All

Display name

Custom Convolution Value

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/ImageProcessingControl

ValuesDescription0

Minimum value

255

Maximum value

Alvium Features Reference V2.9.1

217Feature descriptions: Camera

CustomConvolutionValueSelector
Defines the position to read from or write to the selceted CustomConvolution
filter, using CustomConvolutionValue.
Interface support

All

Display name

Custom Convolution Value Selector

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AdaptiveNoiseSuppressionFactor,
CustomConvolutionValue, Sharpness

Category/ImageProcessingControl

ValuesDescription

Coefficient 00...04 Selects coefficients from 00 to 04.
Coefficient 10...14 Selects coefficients from 10 to 14.
Coefficient 20...24 Selects coefficients from 20 to 24.
Coefficient 30...34 Selects coefficients from 30 to 34.
0

1

2

3

4

0

00

01

02

03

04

1

10

11

12

13

14

2

20

21

22

23

24

3

30

31

32

33

34

4

40

41

42

43

44

Figure 15: Matrix for coefficient values

Alvium Features Reference V2.9.1

218

Feature descriptions: Camera

Sharpness
Selects the degree of sharpness or blurring of the image.
Interface support

All

Display nameSharpness

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/ImageProcessingControl

ValuesDescription-12

Maximum blurring is applied.

0

The image is not affected (default).

12

Maximum sharpness is applied.

Alvium Features Reference V2.9.1

219

Feature descriptions: Camera

LUTControl
The features in this category can be used to change intensity values, adjusted byluminance and RGB color channels.
Interface support

All

Display name

LUT Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

LUTEnable[LUTSelector]
Enables or disables the selected LUT.
Interface support

All

Display name

LUT Enable

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

LUTIndex, LUTValue

Category/LUTControl

ValuesDescription

False

The selected LUT is disabled.

True

The selected LUT is enabled.

Alvium Features Reference V2.9.1

220

Feature descriptions: Camera

LUTIndex[LUTSelector]
Controls the index (offset) of the coefficient to access in the selected LUT.
Interface support

All

Display name

LUT Index

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

LUTValue

Category/LUTControl

ValuesDescription0

Minimum

4095

Maximum

LUTSelector
Selects the LUT to be controlled.
Interface support

All

Display name

LUT Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

LUTEnable, LUTIndex, LUTValue

Category/LUTControl

ValuesDescription

Blue

The LUT for blue is selected.

Green

The LUT for green is selected.

Luminance

The LUT for luminance is selected.

Red

The LUT for red is selected.

Alvium Features Reference V2.9.1

221

Feature descriptions: Camera

LUTValue[LUTSelector][LUTIndex]
Controls the value for the selected LUT.
Interface support

All

Display name

LUT ValueStandard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not affected

Category/LUTControl

ValuesDescription0

Minimum

4095

Maximum

LUTValueAll[LUTSelector]
Controls all the LUT coefficients in a single access without using individual
LUTIndex. This can be used to write values for red, green, or blue at once.
Notes• Monochrome cameras support only Luminance, not RGB.
• One LUT entry is 12 bit, so 1 value occupies 2 Bytes (8192 elements) in the Raw
data array.
• Values can be read and written at the same time.
Interface support

All

Display name

LUT Value All

Standard

SFNC

Origin of feature

CameraFeature type

Raw

AccessR/W

Affected features

Not affected

Category/LUTControl

Alvium Features Reference V2.9.1

222

Feature descriptions: Camera

PtpControl
Note: Features in this category are available for Alvium GigE cameras only.
The features in this category can be used to synchronize your camera, for example,
with other cameras.
Interface support

GigE

Display name

Ptp Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

PtpClockAccuracy
Displays the expected accuracy of the camera’s PTP clock when it is the
grandmaster, or in the event it becomes the grandmaster.
Interface support

GigE

Display name

Ptp Clock AccuracyStandard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/PtpControl

ValuesDescription

Unknown

The accuracy cannot be stated (default).

Alvium Features Reference V2.9.1

223

Feature descriptions: Camera

PtpClockID

Displays the latched parent clock ID of the PTP device (=camera).
Interface support

GigE

Display name

Ptp Clock ID

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/PtpControl

ValuesDescription0

Minimum

9223372036854775807

Maximum

PtpDataSetLatch
Latches the current values from the camera’s PTP clock data set.
Interface support

GigE

Display namePtp Data Set Latch

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

Not applicable

Category/PtpControl

Alvium Features Reference V2.9.1

224

Feature descriptions: Camera

PtpEnable
Enable or disables using the Precision Time Protocol (PTP).
Interface support

GigE

Display namePtp Enable

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Not applicable

Category/PtpControl

ValuesDescription

False

PTP is disabled (default).

True

PTP is enabled.

PtpGrandmasterClockID

Displays the latched grandmaster clock ID of the PTP device (=camera).
Interface support

GigE

Display name

Ptp Grandmaster Clock ID

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/PtpControl

ValuesDescription0

Minimum

9223372036854775807

Maximum

Alvium Features Reference V2.9.1

225

Feature descriptions: Camera

PtpOffsetFromMaster
Displays the latched offset from the PTP master clock.
Interface support

GigE

Display name

Ptp Offset From Master

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessRUnit

ns (nanoseconds)

Affected features

Not applicable

Category/PtpControl

ValuesDescription-2147483648

Minimum

2147483647

Maximum

PtpOperationModeControls the IEEE 1588 operation mode.
Interface support

GigE

Display name

Ptp Operation Mode

Standard

CustomOrigin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/PtpControl

ValuesDescription

Auto

The status for the camera is set automatically.

MasterSets the camera to be master.

Slave

Sets the camera to be slave.

Alvium Features Reference V2.9.1

226

Feature descriptions: Camera

PtpParentClockID

Displays the latched parent (=current master) clock ID of the PTP device (=camera).
Interface support

GigE

Display name

Ptp Parent Clock ID

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/PtpControl

ValuesDescription0

Minimum

9223372036854775807

Maximum

Alvium Features Reference V2.9.1

227

Feature descriptions: Camera

PtpServoStatus
Displays the latched state of the PTP Servo Clock.
PTP accuracy
The average accuracy for PTP is 12 µs.
••

Typical PTP lock type with Alvium cameras:
Floating lock state in cycles: Idle > Locked > Stepchange
Average offset from Master: < 12 µs
Other PTP lock type with Alvium cameras (temporary, cannot be forced):
Strong lock state: Locked.
Average offset from Master: < 1 µs

Interface support

GigE

Display name

Ptp Servo Status

Standard

SFNC adapted

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/PtpControl

ValuesDescription

ClockChange

The status of the clock frequency configuration is changed.
This occurs when there is a big difference between masterand slave clock frequency.

Idle

The status of the clock controller is in idle state (waiting for
all data collection).

LockedThe status of the clock controller is in adjusting state, the PI
controller is used to follow the master clock drift.

StepChange

The status of the clock counter is changed step-by-step.

Unknown

The status of the clock controller is set to Unknown (forexample, if the camera works as a Master).

Alvium Features Reference V2.9.1

228

Feature descriptions: Camera

PtpStatus
Displays the PTP status.
Interface support

GigE

Display name

Ptp Status

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/PtpControl

ValuesDescription1

1

Initializing

2

Faulty3Disabled

4

Listening

5

Pre Master

6

Master7

Passive

8

Uncalibrated

9

Slave

1

Refer to the IEEE 1588-2008 specification for additional information on PTP
states.

Alvium Features Reference V2.9.1

229

Feature descriptions: Camera

SequencerControl
Note: Features in this category are available for Alvium 1800 U and GigE cameras
with Sony IMX global shutter sensors only. The support for Alvium CSI-2 is intended
for a future firmware release. The features in this category can be used to trigger
camera feature settings in sequencer sets (“set” on this page) during acquisition ina predefined order.
Interface support

GigE, USB

Display name

Sequencer Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

Functional overview
SequencerSetSelector is used to load and save the sets.

Configuring the feature adjustments in a set•

SequencerFeatureSelector displays features to be enabled or disabled for•

SequencerFeatureEnable[SequencerFeatureSelector] displays if a

•
•
•
•

sequencing.

feature can be used for sequencing.
SequencerConfigurationMode enables the configuration of sets.
SequencerSetSelector selects the set to be loaded or saved.
SequencerSetSave[SequencerSetSelector] stores settings on the camera.
SequencerSetLoad[SequencerSetSelector] reads or activates stored sets.

Configuring the triggering between sets•

SequencerSetStart controls the initial set to be activated. The default value•

SequencerPathSelector[SequencerSetSelector] offers 8 different paths•- TriggerSource- TriggerActivation- SequencerSetNext
SequencerSetNext[SequencerSetSelector][SequencerPathSelector]

is 0, it is not included in the 8 paths defined by the features below.

(higher IDs = indices have the higher priority) with 3 parameters to activatesequencer sets:

controls the set to be activated after the current set.

Controlling triggers to activate sets••

SequencerTriggerSource[SequencerSetSelector][SequencerPathSelector] selects the trigger source to activate a set.
SequencerTriggerActivation[SequencerSetSelector][SequencerPathSelector] selects the activation mode for triggering a set.

Alvium Features Reference V2.9.1

230

Feature descriptions: Camera

Pseudo code example
The following example reuses content of the SFNC V2.4 document. 4 sequencer
sets are used to adjust ExposureTime and Gain. The end of exposure triggers thenext sequencer. In parallel, two timers trigger sequencers.
Set

Code example

Description

ExposureTime = 4000

Initial settings for ExposureTime andGain are adjusted.

Gain = 1.0
SequencerSetNext[0] = 1
0SequencerTriggerSource[0] =ExposureActive

ExposureEnd triggers SequencerSet1.

SequencerTriggerActivation =FallingEdge
SequencerSetNext[1] = 3
SequencerTriggerSource[1] =Timer0End

Timer0End triggers SequencerSet3.

ExposureTime = 4000

Settings for ExposureTime and Gainare changed.

Gain = 2.0
1

SequencerSetNext[0] = 0
SequencerTriggerSource[0] =ExposureActive

ExposureEnd triggers SequencerSet0.

SequencerTriggerActivation =FallingEdge
ExposureTime = 32000
Gain = 1.0
2

Settings for ExposureTime and Gainare changed.

SequencerSetNext[0] = 0
SequencerTriggerSource[0] =ExposureActive

ExposureEnd triggers SequencerSet0.

SequencerTriggerActivation =FallingEdge
ExposureTime = 16000
Gain = 2.0

Settings for ExposureTime and Gainare changed.

SequencerSetNext[0] = 0
3

SequencerTriggerSource[0] =Timer1End

Timer1End triggers SequencerSet0.

SequencerSetNext[1] = 2SequencerTriggerSource[1] =Timer0End

Alvium Features Reference V2.9.1

Timer0End triggers SequencerSet2.

231

Feature descriptions: Camera

SequencerConfigurationMode
Enables or disables configuration of the sequencer.
Interface support

GigE, USB

Display name

Sequencer Configuration Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

ExposureAutoMin, ExposureAutoMax

Category/SequencerControl

ValuesDescription

Off

Configuration of the sequencer is disabled (default).

On

Configuration of the sequencer is enabled.

SequencerFeatureEnable[SequencerFeatureSelector]
Displays which feature can be used in sequencer sets.
Interface support

GigE, USB

Display name

Sequencer Feature Enable

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR

Affected features

Not applicable

Category/SequencerControl

ValuesDescription

False

The selected feature is disabled (default).

True

The selected feature is enabled.

Alvium Features Reference V2.9.1

232

Feature descriptions: Camera

SequencerFeatureSelector
Selects the features to be included in the corresponding sequencer sets.
Interface support

GigE, USB

Display name

Sequencer Feature Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable,

Category/SequencerControl

ValuesAcquisitionFrameRate, AcquisitionFrameRateEnable, BalanceRatio,
BinningHorizontal, BinningVertical, ChunkEnable,
ChunkModeActive, ColorTransformationEnable,
ColorTransformationValue, ExposureTime, Gain, Gamma, Height, Hue,
OffsetX, OffsetY, PayloadSize, PixelFormat, Saturation,
SequencerSetNext, SequencerTriggerActivation,
SequencerTriggerSource, Width

SequencerMode
Enables or disables the sequencer.
Interface support

GigE, USB

Display name

Sequencer Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

PayloadSize

Category/SequencerControl

ValuesDescription

Off

The sequencer is disabled (default).

On

The sequencer is enabled.

Alvium Features Reference V2.9.1

233

Feature descriptions: Camera

SequencerSetActive
Displays the index of the currently active sequencer set.
Interface support

GigE, USB

Display name

Sequencer Set Active

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/SequencerControl

ValuesDescription0

Minimum

4294967295

Maximum

SequencerSetLoad[SequencerSetSelector]
Loads and activates the sequencer set selected by SequencerSetSelector.
Note: Even if SequencerMode is Off, the configuration of the selected sequencer isactivated on the camera.
Interface support

GigE, USB

Display name

Sequencer Set Load

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

AcquisitionFrameRate,
AcquisitionFrameRateEnable, BalanceRatio,
BinningHorizontal, BinningVertical, ChunkEnable,
ChunkModeActive, ColorTransformationEnable,
ColorTransformationValue, ExposureTime, Gain,
Gamma, Height, Hue, OffsetX, OffsetY,
PayloadSize, PixelFormat, Saturation,
SequencerSetNext, SequencerTriggerActivation,
SequencerTriggerSource, Width

Category/SequencerControl

Alvium Features Reference V2.9.1

234

Feature descriptions: Camera

SequencerSetSave[SequencerSetSelector]
Saves the sequencer set selected by SequencerSetSelector.
Note: Even if SequencerMode is Off, the selected set is saved.
Interface support

GigE, USB

Display name

Sequencer Set Save

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

See SequencerSetLoad.

Category/SequencerControl

SequencerSetSelector
Selects the sequencer set to be configured or used.
Interface support

GigE, USB

Display name

Sequencer Set Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

See SequencerSetLoad.

Category/SequencerControl

ValuesDescription

Set0

Set0 is selected (default).

Set1

Set1 is selected.

...

...

Set15

Set15 is selected.

Alvium Features Reference V2.9.1

235

Feature descriptions: Camera

SequencerSetStart
Selects the sequencer set to start with.
Note: The sequencer set selected by SequencerSetStartequencer is the initial
sequencer set, including sets grouped in paths. See SequencerPathControl(subcategory) on page 237.
Interface support

GigE, USB

Display name

Sequencer Set Start

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/SequencerControl

ValuesDescription0

Minimum

15

Maximum

Alvium Features Reference V2.9.1

236

Feature descriptions: Camera

SequencerPathControl (subcategory)
Note: Features in this subcategory are available for the following Alvium cameras
with Sony IMX global shutter sensors only:• Alvium 1800 U• Alvium GigE cameras
The support for Alvium CSI-2 is intended for a future firmware release.
The features in this subcategory can be used to configure the Sequencer Paths ofsequencer sets to be triggered.
Interface support

GigE, USB

Display name

Sequencer Path Control

Standard

CustomOrigin of feature

CameraFeature type

(Subcategory)Category/SequencerControl

SequencerPathSelector[SequencerSetSelector]
Selects the SequencerPath including the sequencer sets to be configured or used.
Interface support

GigE, USB

Display name

Sequencer Path Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

SequencerSetNext, SequencerTriggerSource,
SequencerTriggerActivation

Category/SequencerControl/SequencerPathControl

ValuesDescription

Path0

Path0 is selected to be configured (default).

Path1

Path1 is selected to be configured.

...

...

Path7

Path7 is selected to be configured.

Alvium Features Reference V2.9.1

237

Feature descriptions: Camera

SequencerSetNext[SequencerSetSelector][SequencerPathSelector]
Selects the next sequencer set to be configured or used.
Interface support

GigE, USB

Display name

Sequencer Set Next

Standard

SFNC (adapted)

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

SequencerSetNext, SequencerTriggerSource,
SequencerTriggerActivation

Category/SequencerControl/SequencerPathControl

ValuesDescription0

Minimum value

15

Maximum value

SequencerTriggerActivation[SequencerSetSelector][SequencerPathSelector]
Selects the electrical signal level to trigger the corresponding sequencer set.
Interface support

GigE, USB

Display name

Sequencer Trigger Activation

Standard

SFNC (adapted)

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/SequencerControl/SequencerPathControl

ValuesDescription

AnyEdge

The sequencer is triggered on the falling or rising edge ofthe signal.

FallingEdge

The sequencer is triggered on the falling edge of the signal.

LevelHighThe sequencer is triggered at a high signal level.

LevelLow

The sequencer is triggered at a low signal level.

RisingEdge

The sequencer is triggered on the rising edge of the signal.

Alvium Features Reference V2.9.1

238

Feature descriptions: Camera

SequencerTriggerSource[SequencerSetSelector][SequencerPathSelector]
Selects the internal signal or physical input line to use as source for triggering thesequencer.
Note: The selected trigger must have its TriggerMode set to On.
Interface support

GigE, USB

Display name

Sequencer Trigger Source

Standard

SFNC (adapted)

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/AcquisitionControl

ValuesDescription (sheet 1 of 2)

Action01

The Action0 command is output as source signal.

Action11

The Action1 command is output as source signal.

Counter0Active

The Counter0Active signal triggers the sequencer.

Counter1Active

The Counter1Active signal triggers the sequencer.

Counter2Active

The Counter2Active signal triggers the sequencer.

Counter3Active

The Counter3Active signal triggers the sequencer.

ExposureActive2 The ExposureActive signal triggers the sequencer.
FrameActive

The FrameActive signal triggers the sequencer.

Line0

Physical Line0 triggers the sequencer.

Line1

Physical Line1 triggers the sequencer.

Line23

Physical Line2 triggers the sequencer.

Line33

Physical Line3 triggers the sequencer.

Off

Triggering is disabled.

SoftwareSignal0 SoftwareSignal0 triggers the sequencer.
SoftwareSignal1 SoftwareSignal1 triggers the sequencer.
1 Currently, available with Alvium G1/G5 cameras only.
2 Available for cameras with global shutter sensors and with rolling shutter

senors if TriggerMode is enabled or if AcquisitionMode is set to Continuous.

3

Available with Alvium G1/G5 and Alvium USB cameras. Alvium CSI-2 cameras
support Line0 and Line1 only.

Table 8: SequencerTriggerSource values (sheet 1 of 2)

Alvium Features Reference V2.9.1

239

Feature descriptions: Camera

ValuesDescription (sheet 2 of 2)...N

SoftwareSignalN triggers the sequencer.

Timer0Active

The Timer0Active signal triggers the sequencer.

Timer1Active

The Timer1Active signal triggers the sequencer.

1 Currently, available with Alvium G1/G5 cameras only.
2 Available for cameras with global shutter sensors and with rolling shutter

senors if TriggerMode is enabled or if AcquisitionMode is set to Continuous.

3

Available with Alvium G1/G5 and Alvium USB cameras. Alvium CSI-2 cameras
support Line0 and Line1 only.

Table 8: SequencerTriggerSource values (sheet 2 of 2)

Alvium Features Reference V2.9.1

240

Feature descriptions: Camera

SoftwareSignalControl
The features in this category can be used by external devices to trigger actions
within the camera by software commands.
See ActionControl on page 106 for the interaction with features in this category.
Interface support

All

Display nameSoftware Signal Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

SoftwareSignalPulse[SoftwareSignalSelector]
Generates a pulse signal used by external devices to trigger actions within thecamera by software commands.
Interface support

All

Display nameSoftware Signal Pulse

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

Not applicable

Category/SoftwareSignalControl

Alvium Features Reference V2.9.1

241

Feature descriptions: Camera

SoftwareSignalSelector
Selects which Software Signal features to control.
Interface support

All

Display nameSoftware Signal Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

SoftwareSignalPulse

Category/SoftwareSignalControl

ValuesDescription

SoftwareSignal0 Selects software signal 0 (default).
SoftwareSignal1 Selects software signal 1.

Alvium Features Reference V2.9.1

242

Feature descriptions: Camera

TestControl
The feature in this category can be used to test if packets are transmitted
successfully between the host and the camera.
Interface support

All

Display name

Test Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

TestPendingAck
Tests the camera's pending acknowledge feature. When this feature is written, thecamera waits a time period corresponding to the value of TestPendingAck before
acknowledging the write.
Note: If you select a high value, the camera does not respond for a long time.
Interface support

All

Display name

Test Pending Ack

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

ms

Affected features

Not applicable

Category/TestControl

ValuesDescription0

Minimum

60000

Maximum

Alvium Features Reference V2.9.1

243Feature descriptions: Camera

TransferControl
Note: Features in this category are available for Alvium GigE cameras only. Support
for the other Alvium series is intended for a future firmware release.
The features in this category can be used to acquire a sequence of images as aburst.
Interface support

GigE

Display name

Transfer Control

Standard

SFNC adapted

Origin of feature

CameraFeature type

(Category)TransferControlMode[TransferSelector]
Enables or disables image acquisition as burst.
Interface support

GigE

Display name

Transfer Control Mode

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AcquisitionFrameRate

Category/TransferControl

ValuesDescription

Automatic

The image burst is enabled

Basic

The image burst is disabled (default).*

Alvium Features Reference V2.9.1

244

Feature descriptions: Camera

TransferQueueCurrentBlockCount[TransferSelector]
Displays the current number of images in the frame buffer.
Interface support

GigE

Display name

Transfer Queue Current Block Count

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Bytes

Affected features

Not applicable

Category/TransferControl

ValuesDescription0

Minimum

4294967295

Maximum

TransferQueueMaxBlockCount[TransferSelector]
Controls the maximum number of images that can be stored in the frame buffer.
Interface support

GigE

Display name

Transfer Queue Max Block Count

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R/W

Unit

Bytes

Affected features

Not applicable

Category/TransferControl

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

245

Feature descriptions: Camera

TransferSelector
Selects the stream to be configured by Transfer Control features. Use as areference for your host software.
Interface support

GigE

Display name

Transfer Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

AcquisitionFrameRate, TransferControlMode,
TransferQueueCurrentBlockCount,
TransferQueueMaxBlockCount

Category/TransferControl

ValuesDescription

Stream0

Stream 0 is selected.

Alvium Features Reference V2.9.1

246

Feature descriptions: Camera

TransportLayerControl
The features in this category can be used to display the current bandwidth use andthe transfer status of packets between the host and the camera on the transportlayer level.

GigEVisionInterface support

All

Display name

Transport Layer Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

Note: Features in this subcategory are available for Alvium GigE cameras only.
The features in this subcategory can be used to control IP settings, thecommunication between the host and the camera, and the transfer of data
packets.
Interface support

GigE

Display name

GigE

Standard

SFNC

Origin of feature

CameraFeature type

(Category)Category/TransportLayerControl

GevCurrentDefaultGateway
Displays the current default gateway address.
Interface support

GigE

Display name

Gev Current Default Gateway

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

Alvium Features Reference V2.9.1

247

Feature descriptions: Camera

GevCurrentIPAddress
Displays the current IP address.
Interface support

GigE

Display name

Gev Current IP Address

Standard

SFNC adapted

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

Priorities for assigning IP addresses
Figure 16 shows the workflow to assign IP addresses to cameras according to the
GigE Vision standard:ĞŐŝŶIs a persistent
IP addressĐŽŶĮŐƵƌĞĚ͍Yes

Use a persistent
IP address

No

Is DHCPĞŶĂďůĞĚ͍Was anIP addressĂƐƐŝŐŶĞĚ͍

Yes

No

Yes

Use DHCPNo

Was anIP addressĂƐƐŝŐŶĞĚ͍Yes

No

Use LLA (Link
Local Address)

End(The DHCP clientŵŝŐŚƚƐƟůůďĞƌƵŶŶŝŶŐͿ

Figure 16: Priorities for assigning IP addresses

Alvium Features Reference V2.9.1

248

Feature descriptions: Camera

GevCurrentIPConfigurationDHCP
Enables or disables IP settings being configured by DHCP.
Interface support

GigE

Display name

Gev Current IP Configuration DHCP

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

ValuesDescription

True

IP settings are configured by DHCP (dynamic hostconfiguration protocol) (default).

False

IP settings are configured by LLA or by the user (persistent
IP).

Priorities for assigning IP addresses
See the flowchart in Figure 16: Priorities for assigning IP addresses on page 248 forthe priorities between GevCurrentIPConfigurationPersistentIP,
GevCurrentIPConfigurationDHCP, and GevCurrentIPConfigurationLLA.

Alvium Features Reference V2.9.1

249

Feature descriptions: Camera

GevCurrentIPConfigurationLLA
Enables or disables IP settings being configured by LLA.
Interface support

GigE

Display name

Gev Current IP Configuration LLA

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

ValuesDescription

True

IP settings are configured by LLA (link-local address)(default).

Priorities for assigning IP addresses
See the flowchart in Figure 16: Priorities for assigning IP addresses on page 248 forthe priorities between GevCurrentIPConfigurationPersistentIP,
GevCurrentIPConfigurationDHCP, and GevCurrentIPConfigurationLLA.

Alvium Features Reference V2.9.1

250

Feature descriptions: Camera

GevCurrentIPConfigurationPersistentIP
Enables or disables IP settings being configured by manually by the user.
Interface support

GigE

Display name

Gev Current IP Configuration Persistent IP

Standard

SFNC

Origin of feature

CameraFeature type

BooleanAccessR/W

Affected features

GevCurrentIPConfigurationDHCP,
GevIPConfigurationStatus

Category/TransportLayerControl/GigEVision

ValuesDescription

True

IP settings are configured manually by the user.

False

IP settings are configured by LLA or DHCP (default).

Priorities for assigning IP addresses
See the flowchart in Figure 16: Priorities for assigning IP addresses on page 248 forthe priorities between GevCurrentIPConfigurationPersistentIP,
GevCurrentIPConfigurationDHCP, and GevCurrentIPConfigurationLLA.

Alvium Features Reference V2.9.1

251

Feature descriptions: Camera

GevCurrentSubnetMask
Displays the current subnet mask address.
Interface support

GigE

Display name

Gev Current Subnet Mask

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

GevIPConfigurationStatus
Displays if IP settings are configured by DHCP, LLA, or manually by the user.
Interface support

GigE

Display nameGev IP Configuration Status

Standard

SFNC adapted

Origin of feature

CameraFeature type

Enumeration

AccessR

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

ValuesDescription

DHCP

IP settings are configured by DHCP (dynamic hostconfiguration protocol) (default).
If no DHCP server is found, DHCP falls back to LLA
automatically i.

LLA

IP settings are configured by LLA (link-local address).

Persistent

IP settings are configured manually by the user.

Priorities for assigning IP addresses
See the flowchart in Figure 16: Priorities for assigning IP addresses on page 248 forthe priorities between GevCurrentIPConfigurationPersistentIP,
GevCurrentIPConfigurationDHCP, and GevCurrentIPConfigurationLLA.

Alvium Features Reference V2.9.1

252

Feature descriptions: Camera

GevMACAddress
Displays the current MAC address.
Interface support

GigE

Display nameGev MAC Address

Standard

SFNC adapted

Origin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

GevPersistentDefaultGateway
Selects the default gateway address.
Interface support

GigE

Display nameGev Persistent Default Gateway

Standard

SFNC adapted

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

GevPersistentIPAddress
Selects the IP address.
Interface support

GigE

Display nameGev Persistent IP Address

Standard

SFNC adapted

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

Alvium Features Reference V2.9.1

253

Feature descriptions: Camera

GevPersistentSubnetMask
Selects the subnet mask address.
Interface support

GigE

Display nameGev Persistent Subnet Mask

Standard

SFNC adapted

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

Not applicable

Category/TransportLayerControl/GigEVision

GevSCPSPacketSize
Controls the stream packet size to be transmitted on the selected channel for a
GVSP transmitter.
Displays the maximum packet size supported by a GVSP receiver.
Notes:• The following data is excluded: Data leader, data trailer, the last data packet(which might be of smaller size because the packet size is not necessarily amultiple of block size for stream channel).
• If cameras cannot support the requested packet size, they must not fire test
packets when requested to do so.
• DeviceStreamChannelPacketSize is updated after writing to
GevSCPSPacketSize.
Interface support

GigE

Display name

Gev SCPS Packet Size

Standard

SFNC

Origin of feature

CameraFeature type

Integer

AccessR/W

Affected features

DeviceStreamChannelPacketSize

Category/TransportLayerControl/GigEVision

Alvium Features Reference V2.9.1

254

Feature descriptions: Camera

TransportLayerControlControl (category continued)
The feature descriptions for the /TransportLayerControl/GigEVisioncategory have ended on the previous page. The following features continue the/TransportLayerControl category, without a subcategory.

PayloadSize
Displays the number of bytes transferred for each image or chunk on the stream
channel. This includes any end-of-line, end-of-frame statistics, or other stamp data.
Therefore, the feature displays the total size of data payload for a data block.
Interface support

All

Display name

Payload Size

Standard

SFNC

Origin of feature

CameraFeature type

Integer

Access

R

Unit

Bytes

Affected features

Not applicable

Category/TransportLayerControl

ValuesDescription0

Minimum

Alvium Features Reference V2.9.1

255

Feature descriptions: Camera

Info (subcategory)

Note: Features in this subcategory are available for Alvium CSI-2 cameras only.

The features in this subcategory can be used to display the transfer status ofpackets between the host and the camera on the transport layer level.
Interface support

CSI-2

Display name

Info

Standard

CustomOrigin of feature

Transport layer

Feature type

Subcategory

Category/TransportLayerControl

CSI2ClockFrequency
Displays the MIPI CSI-2 clock frequency.
Interface support

CSI-2

Display name

CSI-2 Clock Frequency

Standard

CustomOrigin of feature

Transport layer

Feature type

Float

AccessR

Unit

Hz [Hertz]

Affected features

Not applicable

Category/TransportLayerControl/Info

CSI2DriverInterfaceVersion
Displays the version of the MIPI CSI-2 interface.
Interface support

CSI-2

Display name

CSI-2 Driver Interface Version

Standard

CustomOrigin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/TransportLayerControl/Info

Alvium Features Reference V2.9.1

256Feature descriptions: Camera

CSI2LaneCount
Displays the number of used MIPI CSI-2 lanes.
Interface support

CSI-2

Display name

CSI-2 Lane Count

Standard

CustomOrigin of feature

Transport layer, camera

Feature type

Integer

AccessR

Affected features

Not applicable

Category/TransportLayerControl/Info

LibcsiVersion
Displays the libcsi version.
Interface support

CSI-2

Display namelibcsi Version

Standard

CustomOrigin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/TransportLayerControl/Info

CSI2DriverVersion
Displays the version of the MIPI CSI-2 driver.
Interface support

CSI-2

Display name

CSI-2 Driver Version

Standard

CustomOrigin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/TransportLayerControl/Info

Alvium Features Reference V2.9.1

257

Feature descriptions: Camera

PacketCount
Displays the number of MIPI CSI-2 packets per frame.
Interface support

CSI-2

Display name

Packet Count

Standard

CustomOrigin of feature

CameraFeature type

Integer

AccessR

Affected features

Not applicable

Category/TransportLayerControl/Info

ValuesDescription0

Minimum

4294967295

Maximum

PacketSize
Displays the size of MIPI CSI-2 packets.
Interface support

CSI-2

Display name

Packet Size

Standard

CustomOrigin of feature

CameraFeature type

Integer

Access

R

Unit

Bytes

Affected features

Not applicable

Category/TransportLayerControl/Info

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.9.1

258

Feature descriptions: Camera

UserSetControl
The features in this category enable to store and select user-specific camera
settings, or to revert the camera to defined settings.
User sets can be loaded by default, without needing to set values by software after
every restart of the camera. Or they can be used to switch between different
settings, for example, to adjust from daylight to artificial light.
Supported features
User sets on Alvium cameras support all features except for:• Selectors• Command features• Read-only features• Features that do not apply to the corresponding interface, such as CSI-2
related features on a USB camera• Features in the LUTControl category.
Interface support

All

Display name

User Set Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

UserSetDefault
Selects the user set to be loaded by default when the camera is reset.
Interface support

All

Display name

User Set Default

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/UserSetControl

Value

Description

Default

The default user set is loaded at camera reset.

UserSet1

Your individual UserSet1 is loaded at camera reset.

UserSet2Your individual UserSet2 is loaded at camera reset.

UserSet3Your individual UserSet3 is loaded at camera reset.

UserSet4Your individual UserSet4 is loaded at camera reset.

Alvium Features Reference V2.9.1

259

Feature descriptions: Camera

UserSetLoad[UserSetSelector]
Loads the user set specified by UserSetSelector to the camera.
Interface support

All

Display name

User Set Load

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

All features that are not excluded from user sets. See yourAlvium camera's user guide for exceptions.

Category/UserSetControl

UserSetSave[UserSetSelector]
Writes and saves the current setup and state of the camera to the user set
specified by UserSetSelector.
Interface support

All

Display name

User Set Save

Standard

SFNC

Origin of feature

CameraFeature typeCommandAccessW

Affected features

All features that are not excluded from user sets. See yourAlvium camera's user guide for exceptions.

Category/UserSetControl

Alvium Features Reference V2.9.1

260

Feature descriptions: Camera

UserSetSelector
Selects the user set to be loaded or saved.
Interface support

All

Display name

User Set Selector

Standard

SFNC

Origin of feature

CameraFeature type

Enumeration

AccessR/W

Affected features

UserSetLoad, UserSetSave

All features that are not excluded from user sets. See yourAlvium camera's user guide for exceptions.
Category/UserSetControl

Value

Description

Default

The default user set is selected.

UserSet1

Your individual UserSet1 set is selected.

UserSet2Your individual UserSet2 set is selected.

UserSet3Your individual UserSet3 set is selected.

UserSet4Your individual UserSet4 set is selected.

Alvium Features Reference V2.9.1

261

Feature descriptions: Stream 0This chapter includes:
BufferHandlingControl ........................................................ 263
Stream ................................................................................. 266
StreamInformation.............................................................. 284

Alvium Features Reference V2.9.1

262

Feature descriptions: Stream 0

You need experience to use these features
We recommend you to use features in this category only if you are an advanced
user.

BufferHandlingControl
Stream 0 as GenTL Module
Current Alvium cameras use Stream0 only.
The features in this category can be used to control the buffers in the acquisitionengine of the data stream.
Interface support

All (most features)

Display name

Buffer Handling Control

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)

MaxDriverBuffersCount
Controls the maximum number of driver buffers used by the acquisition engine.
Note: We recommend you to use this feature only if you are an advanced user.
Interface support

CSI-2, USB

Display name

Max Driver Buffers Count

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/BufferHandlingControl

ValuesDescription

1

Minimum

4096

Maximum

1

Increment

Alvium Features Reference V2.9.1

263

Feature descriptions: Stream 0

StreamAnnounceBufferMinimum
Displays the minimum number of buffers to announce to enable selected buffer
handling mode. Corresponds to the STREAM_INFO_BUF_ANNOUNCE_MIN commandof DSGetInfo function.
Note: We recommend you to use this feature only if you are an advanced user.
Interface support

All

Display nameStream Announce Buffer MinimumStandard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/BufferHandlingControl

StreamAnnouncedBufferCount
Displays the number of announced (known) buffers on this stream. Corresponds to
the STREAM_INFO_NUM_ANNOUNCED command of DSGetInfo function.
Note: We recommend you to use this feature only if you are an advanced user.
Interface support

All

Display nameStream Announced Buffer Count

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/BufferHandlingControl

ValuesDescription0

Minimum

9223372036854775807 Maximum

Alvium Features Reference V2.9.1

264Feature descriptions: Stream 0

StreamBufferHandlingMode
Selects the available acquisition modes of the stream.
Note: We recommend you to use this feature only if you are an advanced user.
Interface support

All

Display nameStream Buffer Handling Mode

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

Enumeration

AccessR

Affected features

StreamAcquisitionModeSelector

Category/BufferHandlingControl

Value

Description

Default

Default stream buffer handling is available.

Alvium Features Reference V2.9.1

265Feature descriptions: Stream 0

StreamNote: Features in this category are available for Alvium GigE cameras only.
The features in this category can be used to control data traffic between the hostand the camera. This includes functions to avoid dropped frames. MultiCast canbe used to synchronize the timing between cameras.
Interface support

GigE

Display nameStreamStandard

CustomOrigin of feature

Transport layer

Feature type

(Category)

Info (subcategory)
Note: Features in this subcategory are available for Alvium GigE cameras only.
The features in this subcategory can be used to display the MAC address of thecamera and the version of the filter version for the GigE Vision Streaming Protocol.
Interface support

GigE

Display name

Info

Standard

CustomOrigin of feature

Transport layer

Feature type

(Subcategory)Category/Stream

Alvium Features Reference V2.9.1

266

Feature descriptions: Stream 0

GVSPFilterCompatibility
Displays the compatibility of the transport layer and the found GVSP filter driver.
Interface support

GigE

Display name

GVSP Filter Compatibility

Standard

CustomOrigin of feature

Transport layer

Feature type

Enumeration

AccessR

Affected features

Not applicable

Category/Stream/Info

ValuesDescription

Matching

The transport layer and the GVSP filter driver arecompatible.

TLOutdated

The filter driver is newer than expected by the transportlayer, but it is compatible.

DriverOutdated

The filter driver is older than expected by the transportlayer, but it is compatible.

Incompatible

The transport layer and the filter driver are not compatible.
The filter driver cannot be used for streaming.

Disabled

The filter driver is installed on the system but it is notenabled for the network adapter.

GVSPFilterVersion
Displays the GVSP filter version.
Interface support

GigE

Display name

GVSP Filter Version

Standard

CustomOrigin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/Stream/Info

Alvium Features Reference V2.9.1

267

Feature descriptions: Stream 0

Multicast (subcategory)

Note: Features in this subcategory are available for Alvium GigE cameras only.

The features in this subcategory enable synchronizing the timing between
cameras.
Interface support

GigE

Display nameMulticastStandard

CustomOrigin of feature

Transport layer

Feature type

(Subcategory)Category/StreamMulticastEnable
Enables or disables multicast.
Interface support

GigE

Display nameMulticast Enable

Standard

CustomOrigin of feature

Transport layer

Feature type

BooleanAccessR/W

Affected features

Not applicable

Category/Stream/Multicast

ValuesDescription

False

Disables multicast.

True

Enables multicast.

Alvium Features Reference V2.9.1

268

Feature descriptions: Stream 0

MulticastIPAddress
Selects the IP address of the target multicasting group. The Multicast transportlayer protocol enables multiple cameras to use IP connections most effectively bysending packets to many receivers at the same time.
Interface support

GigE

Display nameMulticast IP Address

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/Stream/Multicast

ValuesDescription

224.0.0.0

Minimum value(0xE0.00.00.00 in hexadecimal or 3.758.096.384 in decimal)

239.255.255.255 Maximum value(0xEF.FF.FF.FF in hexadecimal or 4.026.531.839 in decimal)

Alvium Features Reference V2.9.1

269

Feature descriptions: Stream 0

Settings (subcategory)

Note: Features in this subcategory are available for Alvium GigE cameras only.

The features in this subcategory can be used to control settings for the packet
transfer between the host and the camera. GVSPDriverSelector enables toselect between using the transport layer or the filter driver.
Interface support

GigE

Display name

Settings

Standard

CustomOrigin of feature

Transport layer

Feature type

(Subcategory)Category/StreamGVSPAdjustPacketSize
Request the packet size used to be adjusted automatically.
Interface support

GigE

Display name

GVSP Adjust Packet Size

Standard

CustomOrigin of feature

Transport layer

Feature typeCommandAccessW

Affected features

GVSPPacketSize, GevSCPSPacketSize,
DeviceStreamChannelPacketSize

Category/Stream/Settings

Alvium Features Reference V2.9.1

270

Feature descriptions: Stream 0

GVSPBurstSize
Controls the maximum number of GVSP packets to be processed in a burst.
Interface support

GigE

Display name

GVSP Burst Size

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/Stream/Settings

ValuesDescription

1

Minimum value

256

Maximum value

GVSPDriverSelector
Selects the streaming driver to be used.
Interface support

GigE

Display name

GVSP Driver Selector

Standard

CustomOrigin of feature

Transport layer

Feature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/Stream/Settings

ValuesDescription

Filter

Selects the filter drivers stream engine (default).

SocketSelects the transport layers stream engine.

Alvium Features Reference V2.9.1

271

Feature descriptions: Stream 0

GVSPHostReceiveBufferSize
Controls the socket buffer space used to receive GVSP packets.
The operating system adjusts the socket buffer continuously. The value may belimited internally by the operating system. See the SO_RCVBUF documentation of
the operating system.
Note: This feature cannot be used with the filter driver.
Interface support

GigE

Display name

GVSP Host Receive Buffer Size

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

Access

R/W

Unit

Bytes

Affected features

Not applicable

Category/Stream/Settings

GVSPMaxLookBack
Controls the size for the detection of the missing GVSP packets under Windows.
This feature can be used to delay the first RESEND_CMD for a missing GVSP packet
by X packets.
Interface support

GigE

Display name

GVSP Max Look Back

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/Stream/Settings

ValuesDescription

1

Minimum value

1024

Maximum value

Alvium Features Reference V2.9.1

272

Feature descriptions: Stream 0

GVSPMaxRequests
Controls the maximum amount of RESEND_CMDs requested for a missing GVSP
packet.
Note: Setting the feature to 0 disables the GigE Vision resend mechanism. The
transport layer or filter driver does not request the re-transmission of any missing
GVSP packet.
Interface support

GigE

Display name

GVSP Max Requests

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/Stream/Settings

ValuesDescription0

Minimum value, disables GigE Vision resend mechanism.

512

Maximum value

GVSPMaxWaitSize
Controls the maximum number of received GVSP packets following a resendrequest to wait before requesting again. The transport layer or the filter driverwaits until GVSPMaxWaitSize of packets has been reached before requesting a
resend for the same packet again.
Interface support

GigE

Display name

GVSP Max Wait Size

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/Stream/Settings

ValuesDescription

8

Minimum value

1024

Maximum value

Alvium Features Reference V2.9.1

273

Feature descriptions: Stream 0

GVSPMissingSize
Controls the maximum number of simultaneously missing GVSP packets before
dropping the frame.
You can use this feature to cancel the reception of a single frame if the resend limit
GVSPMaxRequests is reached for too many packets. The frame is marked asincomplete and returned to the GenTL consumer.
Interface support

GigE

Display name

GVSP Missing Size

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/Stream/Settings

ValuesDescription0

Minimum value, disables the feature.

1024

Maximum value

GVSPPacketSize
Controls the total size of a GVSP packet, including the IP, UDP, and GVSP headers.
Interface support

GigE

Display name

GVSP Packet Size

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

Access

R/W

Unit

Bytes

Affected features

GevSCPSPacketSize, DeviceStreamChannelPacketSize

Category/Stream/Settings

ValuesDescription

500

Minimum value for Alvium G1

9190

Maximum value for Alvium G1

500

Minimum value for Alvium G5

16358

Maximum value for Alvium G5

Alvium Features Reference V2.9.1

274

Feature descriptions: Stream 0

GVSPTiltingSize
Controls the maximum number of GVSP packets received from a following frame
before dropping the frame.
You can use this feature to cancel the reception of a single frame if a certain
number of GVSP packets of the following frame have already been received. The
frame is marked as incomplete and returned to the GenTL consumer.
Interface support

GigE

Display name

GVSP Tilting Size

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/Stream/Settings

ValuesDescription0

Minimum value, disables the feature.

1024

Maximum value

GVSPTimeout
Controls the timeout used for stream packets.
You can use this feature to react on a possible streaming interruptions. If no GVSP
packet is received during the last GVSPTimeout milliseconds, the stream engine
forces a resend of currently missing GVSP packets.
Interface support

GigE

Display name

GVSP Timeout

Standard

CustomOrigin of feature

Transport Layer

Feature type

Integer

AccessR/W

Unit

Milliseconds [ms]Affected features

Not applicable

Category/Stream/Settings

ValuesDescription0

Minimum value, disables the feature.

5000

Maximum value

Alvium Features Reference V2.9.1

275

Feature descriptions: Stream 0

Statistics (subcategory)

Note: Features in this subcategory are available for Alvium GigE cameras only.

The features in this subcategory can be used to display frame rates, streaming
duration, and the transfer status of packets between the host and the camera.
Interface support

GigE

Display name

Statistics

Standard

CustomOrigin of feature

Transport layer

Feature type

(Subcategory)Category/Stream

StatFrameDelivered
Displays the number of frames that have been delivered to the TL consumer
without errors.
Interface support

GigE

Display nameStat Frame Delivered

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

276

Feature descriptions: Stream 0

StatFrameDropped
Displays the number of frames received by the host that are incomplete due tomissing packets.
Note: This does not include shoved frames.
Interface support

GigE

Display nameStat Frame Dropped

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

StatFrameRate
Displays the frequency at which the device is sending frames to the host (derived
from the frame timestamps).
Interface support

GigE

Display nameStat Frame Rate

Standard

CustomOrigin of feature

Transport layer

Feature type

Float

AccessR

Unit

Hertz [Hz] (frames per second)

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

1.79769313486e+308

Maximum value

Alvium Features Reference V2.9.1

277

Feature descriptions: Stream 0

StatFrameRescued
Displays the number of frames that initially had missing packets but weresuccessfully completed after packet resend.
Interface support

GigE

Display nameStat Frame Rescued

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

StatFrameShoved
Displays the number of frames dropped because the transfer of a following frame
was completed earlier.
Interface support

GigE

Display nameStat Frame Shoved

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

278

Feature descriptions: Stream 0

StatFrameUnderrun
Displays the number of frames missed due to the non-availability of a user
supplied buffer (buffer underrun).
Interface support

GigE

Display nameStat Frame Underrun

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

StatLocalRate
Displays the frequency at which the host has received complete and incomplete
frames (derived from the host clock).
Interface support

GigE

Display nameStat Local Rate

Standard

CustomOrigin of feature

Transport layer

Feature type

Float

AccessR

Unit

Hz (frames per second)

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

1.79769313486e+308

Maximum value

Alvium Features Reference V2.9.1

279

Feature descriptions: Stream 0

StatPacketErrors
Displays the number of received packets that are erroneous.
Interface support

GigE

Display nameStat Packet Errors

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

StatPacketMissed
Displays the number of packets expected, but not received by the host.
Note: This does not include successfully resent packets.
Interface support

GigE

Display nameStat Packet MissedStandard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

280

Feature descriptions: Stream 0

StatPacketReceived
Displays the number of error-free packets received and processed by the host.
Note: This includes successfully resent packets.
Interface support

GigE

Display nameStat Packet Received

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

StatPacketRequested
Displays the number of missing packets that were requested for resend from thecamera.
Interface support

GigE

Display nameStat Packet Requested

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

281

Feature descriptions: Stream 0

StatPacketResent
Displays the number of missing packets that were resent by the camera after
having been requested.
Interface support

GigE

Display nameStat Packet ResentStandard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

StatPacketUnavailable
Displays the number of packets that could not be resent by the camera after
having been requested.
Interface support

GigE

Display nameStat Packet Unavailable

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

Alvium Features Reference V2.9.1

282

Feature descriptions: Stream 0

StatTimeElapsed
Displays the Elapsed time since the streaming was started.
Interface support

GigE

Display nameStat Time Elapsed

Standard

CustomOrigin of feature

Transport layer

Feature type

Float

AccessR

Unit

Seconds [s]Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

1.79769313486e+308

Maximum value

Alvium Features Reference V2.9.1

283

Feature descriptions: Stream 0

StreamInformation
The features in this category can be used to display, such as the streaming status,
the frame rate, and the transfer status of frames sent by the camera.
Interface support

All (most features)

Display nameStream Information

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

(Category)StreamID
Displays the camera’s unique ID for the stream, for instance a GUID.
Interface support

All

Display nameStream ID

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/StreamInformation

StreamIsGrabbing
Displays the status of the acquisition engine.
Interface support

CSI-2, USB

Display nameStream Is Grabbing

Standard

GenTL SFNC

Origin of feature

Transport layer

Feature type

BooleanAccessR

Affected features

MaxDriverBuffersCount, StreamPayloadSizeMode,
StreamPayloadSizeAlignment,
ManualStreamPayloadSize

Category/StreamInformation

ValuesDescription

False

Acquisition engine is not started.

True

Acquisition engine is started.

Alvium Features Reference V2.9.1

284

Feature descriptions: Stream 0

StreamType
Displays the transport layer type of the data stream.
Interface support

All

Display nameStream TypeStandard

GenTL SFNC adapted

Origin of feature

Transport layer

Feature type

Enumeration

AccessR

Affected features

Not applicable

Category/StreamInformation

ValuesDescription

CustomThe transport layer is MIPI CSI-2 type.

GEV

The transport layer is GigE type.

USB3

The transport layer is USB 3.x type.

Alvium Features Reference V2.9.1

285

Feature descriptions: Stream 0

Statistics (subcategory)

Note: Features in this subcategory are available for Alvium CSI-2 cameras only.

The features in this subcategory can be used to display the frame rate and thetransfer status of frames sent by the camera.
Interface support

CSI-2

Display name

Statistics

Standard

CustomOrigin of feature

Transport layer

Feature type

Subcategory

Category/StreamInformation

StatFrameRate
Displays the rate at which the device is sending frames to the host, derived fromthe frame timestamps.
Interface support

CSI-2

Display nameStat Frame Rate

Standard

CustomOrigin of feature

Transport layer

Feature type

Float

AccessR

Unit

fps [frames per second]

Affected features

Not applicable

Category/StreamInformation/Statistics

ValuesDescription0

Minimum value

1.79769313486e+308

Maximum value

Alvium Features Reference V2.9.1

286

Feature descriptions: Stream 0

StatFrameCRCError
Displays the number of frames received with CRC errors.
Interface support

CSI-2

Display nameStat Frame CRC Error

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/StreamInformation/Statistics

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

StatFrameDelivered
Displays the number of frames received without errors.
Interface support

CSI-2

Display nameStat Frame Delivered

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/StreamInformation/Statistics

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

Alvium Features Reference V2.9.1

287

Feature descriptions: Stream 0

StatFrameIncomplete
Displays the number of incomplete frames received.
Note: Shoved frames are not included.
Interface support

CSI-2

Display nameStat Frame Incomplete

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/StreamInformation/Statistics

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

StatFrameUnderrun
Displays the number of missed frames caused by a missing user supplied buffer(buffer underrun).
Interface support

CSI-2

Display nameStat Frame Underrun

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/StreamInformation/Statistics

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

Alvium Features Reference V2.9.1

288

Index

Index
A

AcquisitionControl (category) .........................91
AcquisitionFrameCount ...................................91
AcquisitionFrameRate .....................................92
AcquisitionFrameRateEnable ..........................92
AcquisitionFrameRateMode ............................93
AcquisitionMode .............................................94
AcquisitionStart ...............................................94
AcquisitionStatus .............................................95
AcquisitionStatusSelector ................................95
AcquisitionStop ................................................96
ActionCommand ....................................... 36, 56
ActionControl ................................................ 106
ActionControl (category) .......................... 36, 56
ActionDeviceKey ............................... 36, 56, 106
ActionGroupKey ................................ 37, 57, 107
ActionGroupMask ............................. 37, 57, 108
ActionQueueSize .......................................... 109
ActionScheduledTime ............................... 38, 58
ActionScheduledTimeEnable .................... 38, 58
ActionSelector .............................................. 110
AdaptiveNoiseSupressionFactor .................. 210
AnalogControl (category) ............................. 111
AutoModeControl (category) ....................... 116
AutoModeRegionHeight ............................... 116
AutoModeRegionOffsetX ............................. 116
AutoModeRegionOffsetY .............................. 117
AutoModeRegionSelector ............................ 117
AutoModeRegionWidth ............................... 118

B

BalanceRatio ................................................. 111
BalanceRatioSelector .................................... 112
BalanceWhiteAuto ........................................ 112
BalanceWhiteAutoRate ................................ 118
BalanceWhiteAutoTolerance ....................... 119
BinningHorizontal ......................................... 185
BinningHorizontalMode ............................... 186
BinningSelector ............................................. 187
BinningVertical .............................................. 188
BinningVerticalMode .................................... 189
BlackLevel ..................................................... 113
BlackLevelSelector ........................................ 113
BufferHandlingControl ................................. 263

Alvium Features Reference V2.9.1

BufferHandlingControl (category) ................ 263

C

CameraAddressForcing (category) ................. 48
ColorInterpolation ........................................ 211
ColorTransformationControl (category) ...... 126
ColorTransformationControll (category) ...... 126
ColorTransformationEnable ......................... 126
ColorTransformationValue ........................... 127
ColorTransformationValueSelector .............. 128
ContrastBrightLimit ....................................... 212
ContrastControl (subcategory) ..................... 212
ContrastDarkLimit ......................................... 213
ContrastEnable ............................................. 213
ContrastShape .............................................. 214
ConvolutionMode ......................................... 216
CorrectionControl (category) ....................... 131
CorrectionDataSize ....................................... 134
CorrectionEntryType ..................................... 134
CorrectionInfo (subcategory) ....................... 134
CorrectionMode ........................................... 131
CorrectionSelector ........................................ 132
CorrectionSet ................................................ 132
CorrectionSetDefault .................................... 133
CounterAndTimerControl (category) ........... 131
CounterDuration ........................................... 135
CounterEventActivation ............................... 136
CounterEventSource ..................................... 137
CounterReset ................................................ 138
CounterResetActivation ................................ 138
CounterResetSource ..................................... 139
CounterSelector ............................................ 140
CounterTriggerActivation ............................. 141
CounterTriggerSource .................................. 142
CounterValue ................................................ 143
CounterValueAtReset ................................... 143
CSI-2ClockFrequency .................................... 256
CSI-2DriverInterfaceVersion ......................... 256
CSI-2DriverVersion ........................................ 257
CSI-2LaneCount ............................................ 257
CurrentIPAddress .......................................... 253
CustomConvolutionValue ............................. 217
CustomConvolutionValueSelector ............... 218

D

DeviceAccessStatus ........................................ 60
DeviceControl (category) .............................. 149
DeviceCount .................................................... 61

289

Index

DeviceDisplayName .................................. 61, 78
DeviceDriverPath .............................................62
DeviceEndianessMechanism ...........................79
DeviceEnumeration (category) .......................60
DeviceFamilyName ....................................... 149
DeviceFirmwareID ........................................ 149
DeviceFirmwareIDSelector ........................... 150
DeviceFirmwareVersion ............................... 150
DeviceFirmwareVersionSelector .................. 151
DeviceGenCPVersionMajor .......................... 151
DeviceGenCPVersionMinor .......................... 152
DeviceID .................................................... 62, 82
DeviceIndicatorLuminance ........................... 152
DeviceIndicatorMode ................................... 153
DeviceInformation (category) .........................78
DeviceLinkCommandTimeout ...................... 153
DeviceLinkSpeed ........................................... 154
DeviceLinkThroughputLimit ......................... 155
DeviceLinkThroughputLimitMode ................ 156
DeviceLocation ......................................... 63, 82
DeviceManufacturerInfo .............................. 156
DeviceModelName ........................... 63, 83, 157
DevicePowerSavingMode ............................. 157
DeviceReset .................................................. 158
DeviceScanType ............................................ 159
DevicesDiscoveryBroadcastMode ...................72
DevicesDiscoveryMode ...................................73
DeviceSelector .................................................64
DeviceSerialNumber ..................................... 160
DeviceSFNCVersionMajor ............................. 158
DeviceSFNCVersionMinor ............................ 158
DeviceSFNCVersionSubMinor ...................... 159
DeviceStreamChannelSize ............................ 160
DeviceTemperature ...................................... 161
DeviceTemperatureSelector ........................ 161
DeviceTLVersionMajor ................................. 162
DeviceTLVersionMinor ................................. 162
DeviceType ............................................... 64, 83
DeviceUpdateList .............................................65
DeviceUserID ................................................ 163
DeviceVendorName .......................... 65, 84, 163
DeviceVersion ............................................... 163
DigitalIOControl (category) .......................... 166
DriverPath ........................................................84

E

ExposureActiveMode ......................................96
ExposureAuto ..................................................97

Alvium Features Reference V2.9.1

ExposureAutoMax ........................................ 119
ExposureAutoMin ......................................... 120
ExposureMode ................................................ 98
ExposureTime ............................................... 100

F

FileAccessBuffer ............................................ 178
FileAccessControl (category) ........................ 178
FileAccessLength ........................................... 178
FileAccessOffset ............................................ 179
FileOpenMode .............................................. 179
FileOperationExecute ................................... 180
FileOperationResult ...................................... 180
FileOperationSelector ................................... 181
FileOperationStatus ...................................... 182
FileProcessStatus .......................................... 182
FileSelector ................................................... 183
FileSize .......................................................... 184
FileStatus ....................................................... 184

G

Gain ............................................................... 114
GainAuto ....................................................... 114
GainAutoMax ................................................ 120
GainAutoMin ................................................. 120
GainSelector .................................................. 115
Gamma .......................................................... 115
GenTLSFNCVersionMajor ............................... 40
GenTLSFNCVersionMinor ............................... 41
GenTLSFNCVersionSubMinor ......................... 41
GenTLVersionMajor ........................................ 42
GenTLVersionMinor ........................................ 42
Gev (subcategory) ..................................... 66, 79
GevActionDestinationIPAddress ............... 39, 59
GevCurrentDefaultGateway ......................... 247
GevCurrentIPAddress ................................... 248
GevCurrentIPConfigurationDHCP ................. 249
GevCurrentIPConfigurationPersistentIP ....... 251
GevCurrentSubnetMask ............................... 252
GevDeviceForceGateway .......................... 48, 66
GevDeviceForceIP ..................................... 48, 67
GevDeviceForceIPAddress ........................ 49, 67
GevDeviceForceMACAddress ......................... 49
GevDeviceForceSubnetMask .................... 50, 68
GevDeviceGateway ......................................... 80
GevDeviceIPAddress ................................. 68, 80
GevDeviceMACAddress ............................ 69, 81
GevDeviceSubnetMask ............................. 69, 81

290IndexInterfaceBeatRate ........................................... 73
InterfaceCount ................................................ 51
InterfaceDisplayName .............................. 51, 75
InterfaceEnumeration (category) ................... 51
InterfaceHailPace ............................................ 74
InterfaceID ................................................ 52, 75
InterfaceInformation (category) ..................... 75
InterfacePingPace ........................................... 74
InterfaceSelector ............................................ 54
InterfaceType .................................................. 76
InterfaceUpdateList ........................................ 54
IPConfigurationLLA ....................................... 250

GevHeartbeatInterval ......................................87
GevHeartbeatTimeout .....................................87
GevInterfaceIPAddress ............................. 52, 70
GevInterfaceIPSubnetMask .............................53
GevInterfaceMACAddress ........................ 53, 70
GevInterfaceSubnetMask ................................71
GevIPConfigurationStatus ............................ 252
GevMACAddress ........................................... 253
GevPersistentDefaultGateway ..................... 253
GevPersistentIPAddress ............................... 253
GevSCPSPacketSize ....................................... 254
GevVersionMajorNumber ...............................43
GevVersionMinorNumber ...............................43
GigEVision (subcategory) .............................. 247
GVCPCmdRetries .............................................86
GVCPCmdTimeout ...........................................86
GVSPAdjustPacketSize .................................. 270
GVSPBurstSize ............................................... 271
GVSPDriverSelector ...................................... 271
GVSPFilterCompatibility ............................... 267
GVSPFilterVersion ......................................... 267
GVSPHostReceiveBufferSize ......................... 272
GVSPMaxLookBack ....................................... 272
GVSPMaxRequests ........................................ 273
GVSPMaxWaitSize ........................................ 273
GVSPMissingSize ........................................... 274
GVSPPacketSize ............................................ 274
GVSPTiltingSize ............................................. 275
GVSPTimeout ................................................ 275

LibcsiVersion ................................................. 257
LineDebounceDuration ................................. 166
LineDebounceMode ..................................... 167
LineInverter ................................................... 167
LineMode ...................................................... 168
LineSelector .................................................. 168
LineSource .................................................... 169
LineStatus ...................................................... 170
LineStatusAll ................................................. 170
LUTControl (category) .................................. 220
LUTEnable ..................................................... 220
LUTIndex ....................................................... 221
LUTSelector ................................................... 221
LUTValue ....................................................... 222
LUTValueAll ................................................... 222

H

M

Height ........................................................... 189
HeightMax .................................................... 190
Hue ................................................................ 129

I

ImageFormatControl (category) .................. 185
ImageProcessingControl (category) ............. 210
Info (subcategory) ................................ 256, 266
IntensityAutoPrecedence ............................. 121
IntensityControllerAlgorithm ....................... 121
IntensityControllerOutliersBright ................. 122
IntensityControllerOutliersDark ................... 122
IntensityControllerRate ................................ 123
IntensityControllerRegion ............................ 123
IntensityControllerSelector .......................... 124
IntensityControllerTarget ............................. 124
IntensityControllerTolerance ....................... 125

Alvium Features Reference V2.9.1

L

MaxDriverBuffersCount ................................ 263
Multicast (subcategory) ................................ 268
MulticastEnable ............................................ 268
MulticastIPAddress ....................................... 269
MultipleRegionArrangement ........................ 201
MultipleRegionControl (subcategory) .......... 196
MultipleRegionEnable .................................. 202

O

OffsetX .......................................................... 190
OffsetY ........................................................... 191

P

PacketCount .................................................. 258
PacketSize ..................................................... 258
PayloadSize ................................................... 255
PersistentSubnetMask .................................. 254

291

Index

PixelFormat ................................................... 191
PixelSize ........................................................ 192
PtpClockAccuracy ......................................... 223
PtpClockID ..................................................... 224
PtpDataSetLatch ........................................... 224
PtpEnable ...................................................... 225
PtpGrandmasterClockID ............................... 225
PtpOffsetFromMaster .................................. 226
PtpOperationMode ...................................... 226
PtpParentClockID .......................................... 227
PtpProtocol (category) ................................. 223
PtpServoStatus ............................................. 228
PtpStatus ....................................................... 229

R

ReverseX ....................................................... 192
ReverseY ....................................................... 193

S

Saturation ..................................................... 130
SensorBitDepth ............................................. 194
SensorHeight ................................................ 195
SensorWidth ................................................. 195
SequencerConfigurationMode ..................... 232
SequencerControl (category) ....................... 230
SequencerFeatureEnable ............................. 232
SequencerFeatureSelector ........................... 233
SequencerMode ........................................... 233
SequencerPathControl (subcategory) .......... 237
SequencerPathSelector ................................ 237
SequencerSetActive ...................................... 234
SequencerSetLoad ........................................ 234
SequencerSetNext ........................................ 238
SequencerSetSave ........................................ 235
SequencerSetSelector .................................. 235
SequencerSetStart ........................................ 236
SequencerTriggerActivation ......................... 238
SequencerTriggerSource .............................. 239
SerialBaudRate .............................................. 172
SerialHub (subcategory) ............................... 172
SerialHubEnable ........................................... 171
SerialParityBit ............................................... 173
SerialRxData .................................................. 173
SerialRxSize ................................................... 174
SerialRxWaiting ............................................. 174
SerialStopBits ................................................ 175
SerialTxData .................................................. 175
SerialTxLock .................................................. 176

Alvium Features Reference V2.9.1

SerialTxRemaining ......................................... 177
SerialTxSize ................................................... 177
Settings (category) .......................................... 72
Settings (subcategory) .................................. 270
Sharpness ...................................................... 219
ShutterMode ................................................. 208
SoftwareSignalControl (category) ................ 241
SoftwareSignalPulse ..................................... 241
SoftwareSignalSelector ................................. 242
StatFrameCRCError ....................................... 287
StatFrameDelivered .............................. 276, 287
StatFrameDropped ....................................... 277
StatFrameIncomplete ................................... 288
StatFrameRate ...................................... 277, 286
StatFrameRescued ........................................ 278
StatFrameShoved .......................................... 278
StatFrameUnderrun .............................. 279, 288
Statistics (subcategory) ......................... 276, 286
StatLocalRate ................................................ 279
StatPacketErrors ........................................... 280
StatPacketMissed ......................................... 280
StatPacketReceived ...................................... 281
StatPacketRequested .................................... 281
StatPacketResent .......................................... 282
StatPacketUnavailable .................................. 282
StatTimeElapsed ........................................... 283
Stream (category) ......................................... 286
StreamAnnounceBufferMinimum ................ 264
StreamAnnouncedBufferCount .................... 264
StreamBufferHandlingMode ........................ 265
StreamCount ................................................... 88
StreamEnumeration (category) ...................... 88
StreamID ................................................. 89, 284
StreamInformation (category) ...................... 286
StreamIsGrabbing ......................................... 284
StreamSelector ............................................... 89
StreamType ................................................... 285
SubRegionHeight .......................................... 203
SubRegionMode ........................................... 203
SubRegionOffsetX ......................................... 204
SubRegionOffsetY ......................................... 205
SubRegionSelector ........................................ 206
SubRegionWidth ........................................... 207
SystemInformation (category) ........................ 40

T

TestControl (category) .................................. 243
TestPendingAck ............................................ 243

292

IndexTimerDelay .................................................... 144
TimerDuration .............................................. 145
TimerReset .................................................... 145
TimerSelector ............................................... 146
TimerStatus ................................................... 146
TimerTriggerActivation ................................. 147
TimerTriggerSource ...................................... 148
TimestampLatch ........................................... 164
TimestampLatchValue .................................. 164
TimestampReset ........................................... 165
TLDisplayName ................................................44
TLID ..................................................................44
TLModelName .................................................45
TLPath ..............................................................45
TLType ..............................................................46
TLVendorName ................................................46
TLVersion .........................................................47
TransferControl (category) ........................... 244
TransferControlMode ................................... 244
TransferQueueCurrentBlockCount .............. 245
TransferQueueMaxBlockCount .................... 245
TransferSelector ........................................... 246
TransportLayerControl (category) ................ 247
TriggerActivation .......................................... 100
TriggerDelay .................................................. 101
TriggerMode ................................................. 102
TriggerSelector ............................................. 103
TriggerSoftware ............................................ 104
TriggerSource ................................................ 105

U

UserSetControl (category) ............................ 259
UserSetDefault .............................................. 259
UserSetLoad .................................................. 260
UserSetSelector ............................................ 261

W

Width ............................................................ 209
WidthMax ..................................................... 209

Alvium Features Reference V2.9.1

293