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

AlviumFeatures Reference
V2.8.1
FW 00.11.00.9cf0c21e

Allied Vision Technologies GmbH // Taschenweg 2a, 07646 Stadtroda / Germany

2022-Nov-14

This document at a glanceThis document at a glance
Read this document carefully
Learn to avoid damage to your Alvium camera and use it in the most safe andefficient way.
The Alvium Features Reference describes Alvium features, based on GenICam
features as seen from the Vimba Viewer.

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 selected camera models, please see theAlvium CSI-2 Cameras User Guide for details.
ActionControl features are currently supported only by Alvium GigE cameras.

Support for the other Alvium series is intended for a future firmware release.

SequencerControl features are supported only by Alvium GigE and USB cameras

with Sony IMX global shutter sensors. Support for Alvium CSI-2 is intended for a
future firmware release.
TransferControl features for image acquisition in burst mode are currently

supported only by Alvium G1 cameras. Support for the other Alvium series isintended for a future firmware release.

i

Further information and feedback••

For more information on Alvium cameras, seewww.alliedvision.com/en/support/technical-documentation.html.
For feedback or technical questions, please visit
www.alliedvision.com/en/support.

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

i

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

Alvium Features Reference V2.8.1

2

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.8.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

3

Contents

Contents
This document at a glance ......................................................................... 2

Differences in features and values ........................................................................................2
Vimba and third party software .............................................................................................2

Contact us .................................................................................................. 3Contents ..................................................................................................... 4
Document history and conventions ........................................................ 13
Document history .................................................................................................................14
Conventions used in this document ....................................................................................18

Styles ......................................................................................................................................................... 18
Symbols and notes ................................................................................................................................... 18
Access ....................................................................................................................................................... 19
Standards referred to in this document .................................................................................................. 19
Acronyms and terms ................................................................................................................................ 20
Features description scheme ................................................................................................................... 20

Category name ...........................................................................................................20
Subcategory ...........................................................................................................20
Feature ................................................................................................................................ 20
Features availability .................................................................................................................................. 21
AcquisitionFrameCount ....................................................................................................... 21

Copyright and trademarks ...................................................................................................21

Feature description .................................................................................. 22
Features processing order ...................................................................................................23

Image data flow ........................................................................................................................................ 23
Feature interdependencies ...................................................................................................................... 24

Config mode for IP settings ..................................................................................................24
Regions of interest and auto mode regions ........................................................................25

Basic rules ................................................................................................................................................. 25
ROI and auto mode region effects ........................................................................................................... 26

Feature descriptions ............................................................................................................27
AcquisitionControl ......................................................................................................27

AcquisitionFrameCount ....................................................................................................... 27
AcquisitionFrameRate ......................................................................................................... 28
AcquisitionFrameRateEnable .............................................................................................. 28
AcquisitionFrameRateMode ................................................................................................ 29
AcquisitionMode .................................................................................................................. 30

Alvium Features Reference V2.8.1

4

Contents

AcquisitionStart ................................................................................................................... 30
AcquisitionStatus ................................................................................................................. 31
AcquisitionStatusSelector .................................................................................................... 31
AcquisitionStop .................................................................................................................... 32
ExposureActiveMode ........................................................................................................... 32
ExposureAuto ...................................................................................................................... 33
ExposureMode ..................................................................................................................... 34
ExposureMode - Using TriggerWidth ....................................................................................................... 35
ExposureTime ...................................................................................................................... 36
TriggerActivation ................................................................................................................. 36
TriggerDelay ........................................................................................................................ 37
TriggerMode ........................................................................................................................ 38
TriggerSelector .................................................................................................................... 39
TriggerSoftware ................................................................................................................... 40
TriggerSource ...................................................................................................................... 41

ActionControl ..............................................................................................................42
ActionDeviceKey .................................................................................................................. 42
ActionGroupKey ................................................................................................................... 43
ActionGroupMask ................................................................................................................ 44
ActionQueueSize .................................................................................................................. 45
ActionSelector ...................................................................................................................... 46

AnalogControl .............................................................................................................47
BalanceRatio ........................................................................................................................ 47
BalanceRatioSelector ........................................................................................................... 48
BalanceWhiteAuto ............................................................................................................... 48
BlackLevel ............................................................................................................................ 49
BlackLevelSelector ............................................................................................................... 49
Gain ..................................................................................................................................... 50
GainAuto .............................................................................................................................. 50
GainSelector ........................................................................................................................ 51
Gamma ................................................................................................................................ 51

AutoModeControl .......................................................................................................52
AutoModeRegionHeight ...................................................................................................... 52
AutoModeRegionOffsetX ..................................................................................................... 52
AutoModeRegionOffsetY ..................................................................................................... 53
AutoModeRegionSelector .................................................................................................... 53
AutoModeRegionWidth ....................................................................................................... 54
BalanceWhiteAutoRate ....................................................................................................... 54
BalanceWhiteAutoTolerance ............................................................................................... 55
ExposureAutoMax ............................................................................................................... 55
ExposureAutoMin ................................................................................................................ 56
GainAutoMax ...................................................................................................................... 56
GainAutoMin ....................................................................................................................... 56
IntensityAutoPrecedence ..................................................................................................... 57
IntensityControllerAlgorithm ............................................................................................... 57
IntensityControllerOutliersBright ........................................................................................ 58
IntensityControllerOutliersDark .......................................................................................... 58

Alvium Features Reference V2.8.1

5

Contents

IntensityControllerRate ....................................................................................................... 59
IntensityControllerRegion .................................................................................................... 59
IntensityControllerSelector .................................................................................................. 60
IntensityControllerTarget .................................................................................................... 60
IntensityControllerTolerance ............................................................................................... 61

BufferHandlingControl ................................................................................................62
MaxDriverBuffersCount ....................................................................................................... 62
StreamAnnounceBufferMinimum ....................................................................................... 63
StreamAnnouncedBufferCount ........................................................................................... 63
StreamBufferHandlingMode ............................................................................................... 64

ColorTransformationControl ......................................................................................65
ColorTransformationEnable ................................................................................................ 65
ColorTransformationValue .................................................................................................. 66
ColorTransformationValueSelector ..................................................................................... 67
Hue ....................................................................................................................................... 68
Saturation ............................................................................................................................ 69

CorrectionControl .......................................................................................................70
CorrectionMode ................................................................................................................... 70
CorrectionSelector ............................................................................................................... 71
CorrectionSet ....................................................................................................................... 71
CorrectionSetDefault ........................................................................................................... 72

CorrectionInfo (subcategory) .................................................................................73
CorrectionDataSize .............................................................................................................. 73
CorrectionEntryType ............................................................................................................ 73

CounterAndTimerControl ...........................................................................................74
CounterDuration .................................................................................................................. 74
CounterEventActivation ...................................................................................................... 75
CounterEventSource ............................................................................................................ 76
CounterReset ....................................................................................................................... 77
CounterResetActivation ....................................................................................................... 77
CounterResetSource ............................................................................................................ 78
CounterSelector ................................................................................................................... 79
CounterStatus ...................................................................................................................... 79
CounterTriggerActivation .................................................................................................... 80
CounterTriggerSource ......................................................................................................... 81
CounterValue ....................................................................................................................... 82
CounterValueAtReset .......................................................................................................... 82
TimerDelay ........................................................................................................................... 83
TimerDuration ..................................................................................................................... 84
TimerReset ........................................................................................................................... 84
TimerSelector ....................................................................................................................... 85
TimerStatus ......................................................................................................................... 85
TimerTriggerActivation ........................................................................................................ 86
TimerTriggerSource ............................................................................................................. 87

DeviceControl ..............................................................................................................88

Alvium Features Reference V2.8.1

6

Contents

DeviceFamilyName .............................................................................................................. 88
DeviceFirmwareID ............................................................................................................... 88
DeviceFirmwareIDSelector .................................................................................................. 89
DeviceFirmwareVersion ....................................................................................................... 89
DeviceFirmwareVersionSelector .......................................................................................... 90
DeviceGenCPVersionMajor ................................................................................................. 90
DeviceGenCPVersionMinor .................................................................................................. 91
DeviceIndicatorLuminance .................................................................................................. 91
DeviceIndicatorMode .......................................................................................................... 92
DeviceLinkCommandTimeout .............................................................................................. 92
DeviceLinkSpeed .................................................................................................................. 93
DeviceLinkThroughputLimit ................................................................................................. 94
DeviceLinkThroughputLimitMode ....................................................................................... 95
DeviceManufacturerInfo ..................................................................................................... 95
DeviceModelName .............................................................................................................. 96
DevicePowerSavingMode .................................................................................................... 96
DeviceReset ......................................................................................................................... 97
DeviceSFNCVersionMajor .................................................................................................... 97
DeviceSFNCVersionMinor .................................................................................................... 97
DeviceSFNCVersionSubMinor .............................................................................................. 98
DeviceScanType ................................................................................................................... 98
DeviceSerialNumber ............................................................................................................ 99
DeviceStreamChannelPacketSize ........................................................................................ 99
DeviceTemperature ........................................................................................................... 100
DeviceTemperatureSelector .............................................................................................. 100
DeviceTLVersionMajor ....................................................................................................... 101
DeviceTLVersionMinor ....................................................................................................... 101
DeviceUserID ..................................................................................................................... 102
DeviceVendorName ........................................................................................................... 102
DeviceVersion .................................................................................................................... 102
TimestampLatch ................................................................................................................ 103
TimestampLatchValue ....................................................................................................... 103
TimestampReset ................................................................................................................ 104

DigitalIOControl ........................................................................................................105
LineDebounceDuration ...................................................................................................... 105
LineDebounceMode ........................................................................................................... 106
LineInverter ........................................................................................................................ 106
LineMode ........................................................................................................................... 107
LineSelector ....................................................................................................................... 107
LineSource ......................................................................................................................... 108
LineStatus .......................................................................................................................... 109
LineStatusAll ...................................................................................................................... 109
SerialHubEnable ................................................................................................................ 110

SerialHub (subcategory) .......................................................................................111
SerialBaudRate .................................................................................................................. 111
SerialParityBit .................................................................................................................... 112
SerialRxData ...................................................................................................................... 112

Alvium Features Reference V2.8.1

7

Contents

SerialRxSize ........................................................................................................................ 113
SerialRxWaiting ................................................................................................................. 113
SerialStopBits ..................................................................................................................... 114
SerialTxData ...................................................................................................................... 114
SerialTxRemaining ............................................................................................................. 115
SerialTxSize ........................................................................................................................ 115

FileAccessControl .....................................................................................................116
FileAccessBuffer ................................................................................................................. 116
FileAccessLength ............................................................................................................... 116
FileAccessOffset ................................................................................................................. 117
FileOpenMode ................................................................................................................... 117
FileOperationExecute ........................................................................................................ 118
FileOperationResult ........................................................................................................... 118
FileOperationSelector ........................................................................................................ 119
FileOperationStatus ........................................................................................................... 120
FileProcessStatus ............................................................................................................... 120
FileSelector ........................................................................................................................ 121
FileSize ............................................................................................................................... 122
FileStatus ........................................................................................................................... 122

GigE ...........................................................................................................................123
Configuration (subcategory) ................................................................................123
IPConfigurationMode ........................................................................................................ 124

Current (subcategory) ..........................................................................................125
CurrentDefaultGateway .................................................................................................... 125
CurrentIPAddress ............................................................................................................... 125
CurrentSubnetMask ........................................................................................................... 126

GVCP (subcategory) .............................................................................................127
GVCPCmdRetries ............................................................................................................... 127
GVCPCmdTimeout ............................................................................................................. 128
GevHeartbeatInterval ........................................................................................................ 128
GevHeartbeatTimeout ....................................................................................................... 129

GigE (category continued) ........................................................................................130
GevSCPSPacketSize ............................................................................................................ 130

Persistent (subcategory) ......................................................................................131
PersistentDefaultGateway ................................................................................................ 131
PersistentIPAddress ........................................................................................................... 132
PersistentSubnetMask ....................................................................................................... 132

ImageFormatControl ................................................................................................133
BinningHorizontal .............................................................................................................. 133
BinningHorizontalMode .................................................................................................... 134
BinningSelector .................................................................................................................. 134
BinningVertical .................................................................................................................. 135
BinningVerticalMode ......................................................................................................... 136
Height ................................................................................................................................ 136

Alvium Features Reference V2.8.1

8

Contents

HeightMax ......................................................................................................................... 137
OffsetX ............................................................................................................................... 137
OffsetY ............................................................................................................................... 138
PixelFormat ........................................................................................................................ 138
PixelSize ............................................................................................................................. 139
ReverseX ............................................................................................................................ 139
ReverseY ............................................................................................................................ 140
SensorBitDepth .................................................................................................................. 141
SensorHeight ..................................................................................................................... 142
SensorWidth ...................................................................................................................... 142
ShutterMode ...................................................................................................................... 143
Width ................................................................................................................................. 143
WidthMax .......................................................................................................................... 144

ImageProcessingControl ...........................................................................................145
AdaptiveNoiseSupressionFactor ........................................................................................ 145
ColorInterpolation ............................................................................................................. 146

ContrastControl (subcategory) ............................................................................147
ContrastBrightLimit ........................................................................................................... 147
ContrastDarkLimit ............................................................................................................. 148
ContrastEnable .................................................................................................................. 148
ContrastShape ................................................................................................................... 149

ImageProcessingControl (category continued) ........................................................151
ConvolutionMode .............................................................................................................. 151
CustomConvolutionValue .................................................................................................. 152
CustomConvolutionValueSelector ..................................................................................... 153
Sharpness .......................................................................................................................... 154

LUTControl ................................................................................................................155
LUTEnable .......................................................................................................................... 155
LUTIndex ............................................................................................................................ 156
LUTSelector ........................................................................................................................ 156
LUTValue ............................................................................................................................ 157

PtpControl .................................................................................................................158
PtpClockAccuracy .............................................................................................................. 158
PtpClockID ......................................................................................................................... 159
PtpDataSetLatch ................................................................................................................ 159
PtpEnable ........................................................................................................................... 160
PtpGrandmasterClockID .................................................................................................... 160
PtpOffsetFromMaster ....................................................................................................... 161
PtpOperationMode ............................................................................................................ 161
PtpParentClockID ............................................................................................................... 162
PtpServoStatus .................................................................................................................. 163
PtpStatus ........................................................................................................................... 164

SequencerControl .....................................................................................................165
Functional overview ............................................................................................................................... 165
Configuring the feature adjustments in a set ......................................................................... 165

Alvium Features Reference V2.8.1

9

Contents

Configuring the triggering between sets ................................................................................ 165
Controlling triggers to activate sets ........................................................................................ 165
Pseudo code example ............................................................................................................................ 166
SequencerConfigurationMode .......................................................................................... 167
SequencerFeatureEnable ................................................................................................... 167
SequencerFeatureSelector ................................................................................................. 168
SequencerMode ................................................................................................................. 168
SequencerSetActive ........................................................................................................... 169
SequencerSetLoad ............................................................................................................. 169
SequencerSetSave .............................................................................................................. 170
SequencerSetSelector ........................................................................................................ 170
SequencerSetStart ............................................................................................................. 171

SequencerPathControl (subcategory) ..................................................................172
SequencerPathSelector ...................................................................................................... 172
SequencerSetNext .............................................................................................................. 173
SequencerTriggerActivation .............................................................................................. 173
SequencerTriggerSource .................................................................................................... 174

SoftwareSignalControl ..............................................................................................176
SoftwareSignalPulse .......................................................................................................... 176
SoftwareSignalSelector ..................................................................................................... 177

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

Multicast (subcategory) .......................................................................................179
MulticastEnable ................................................................................................................. 179
MulticastIPAddress ............................................................................................................ 180

Settings (subcategory) .........................................................................................181
GVSPAdjustPacketSize ....................................................................................................... 181
GVSPBurstSize .................................................................................................................... 182
GVSPDriverSelector ........................................................................................................... 182
GVSPHostReceiveBufferSize .............................................................................................. 183
GVSPMaxLookBack ............................................................................................................ 183
GVSPMaxRequests ............................................................................................................ 184
GVSPMaxWaitSize ............................................................................................................. 184
GVSPMissingSize ................................................................................................................ 185
GVSPPacketSize ................................................................................................................. 185
GVSPTiltingSize .................................................................................................................. 186
GVSPTimeout ..................................................................................................................... 186

Statistics (subcategory) ........................................................................................187
StatFrameRate ................................................................................................................... 187
StatFramesDelivered ......................................................................................................... 188
StatFramesDropped .......................................................................................................... 188
StatFramesRescued ........................................................................................................... 189

Alvium Features Reference V2.8.1

10

Contents

StatFramesShoved ............................................................................................................. 189
StatFramesUnderrun ......................................................................................................... 190
StatLocalRate ..................................................................................................................... 190
StatPacketsErrors .............................................................................................................. 191
StatPacketsMissed ............................................................................................................ 191
StatPacketsReceived .......................................................................................................... 192
StatPacketsRequested ....................................................................................................... 192
StatPacketsResent ............................................................................................................. 193
StatPacketsUnavailable ..................................................................................................... 193
StatTimeElapsed ................................................................................................................ 194

StreamInformation ...................................................................................................195
StreamID ............................................................................................................................ 195
StreamIsGrabbing .............................................................................................................. 195
StreamType ........................................................................................................................ 196

Statistics (subcategory) ........................................................................................197
StatFrameRate ................................................................................................................... 197
StatFramesCRCError .......................................................................................................... 198
StatFramesDelivered ......................................................................................................... 198
StatFramesIncomplete ...................................................................................................... 199
StatFramesUnderrun ......................................................................................................... 199

TestControl ...............................................................................................................200
TestPendingAck ................................................................................................................. 200

TransferControl .........................................................................................................201
TransferControlMode ........................................................................................................ 201
TransferQueueCurrentBlockCount .................................................................................... 202
TransferQueueMaxBlockCount ......................................................................................... 202
TransferSelector ................................................................................................................ 203

TransportLayerControl .............................................................................................204
PayloadSize ........................................................................................................................ 204

GigEVision ............................................................................................................205
GevSCPSPacketSize ............................................................................................................ 205

Info (subcategory) ................................................................................................206
CSI2ClockFrequency ........................................................................................................... 206
CSI2DriverInterfaceVersion ............................................................................................... 206
CSI2LaneCount ................................................................................................................... 207
LibcsiVersion ...................................................................................................................... 207
CSI2DriverVersion .............................................................................................................. 207
PacketCount ...................................................................................................................... 208
PacketSize .......................................................................................................................... 208

UserSetControl ..........................................................................................................209
UserSetDefault .................................................................................................................. 209
UserSetLoad ....................................................................................................................... 210
UserSetSave ....................................................................................................................... 210
UserSetSelector ................................................................................................................. 211

Alvium Features Reference V2.8.1

11

Contents

Index ....................................................................................................... 212

Alvium Features Reference V2.8.1

12Document history and conventions

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

Alvium Features Reference V2.8.1

13

Document history and conventions

Document history
Version Date
V2.8.12022-Nov-14
V2.8.02022-Oct-27

V2.7.22022-Jul-20

V2.7.12022-Jul-15

Document updates
Updated the title image.
Firmware version: V00.11.00.9cf0c21e• Updated standard references in Standards
referred to in this document on page 19.
• Updated Pseudo code example on page 166 forSequencerControl.
• Updated options for TriggerSource inAcquisitionControl on page 27, forTimerTriggerSource inCounterAndTimerControl on page 74, for
LineSource in DigitalIOControl on page 105, andfor SequencerTriggerSource inSequencerControl on page 165.
• Added features support for ActionControl on page
42 by Alvium G1 cameras.
• Added options for DeviceTemperatureSelector
in DeviceControl on page 88.
• Added Line Debounce features in DigitalIOControl
on page 105.
• Removed ChunkDataControl category.
• Added Counter features toCounterAndTimerControl on page 74.
• Updated options for SoftwareSignalSelector on
page 177.
• Added TransferControl on page 201 for burst
image aquisition.
• Applied editorial changes.
Added notes that ActionControl features are notworking properly on Alvium G1 cameras yet.
Firmware versions• Alvium CSI-2, G5, USB: V00.10.6c9062b1• Alvium G1: V00.10.00.2cf3b22e
Applied changes• Added options for TriggerSource inAcquisitionControl on page 27.
Continued on next page.

Table 1: Document history (Sheet 1 of 4)

Alvium Features Reference V2.8.1

14

Document history and conventions

Version Date
V2.7.12022-Jul-15

Document updates
Continued from previous page.
•V2.7.02022-Jun-09

Added feature support for Alvium G5 in:- ActionControl on page 42- GVCP (subcategory) on page 127- PtpControl on page 158.
• Added feature support for Alvium USB cameras in
ChunkDataControl.
• Added options for TimerTriggerSource inCounterAndTimerControl on page 74.
• Added support for all Alvium cameras andreorganized features in SerialHub (subcategory) on
page 111.
• Added options to FileSelector in
FileAccessControl on page 116.
• Added TestPattern in ImageFormatControl on
page 133.
• Added features in SequencerControl on page 165.
• Added features in SoftwareSignalControl on page176.
• Removed ColorTransformationSelector from
ColorTransformationControl on page 65.
• Applied editorial changes.
Firmware versions• Alvium CSI-2, G5,USB: V00.08.00.6727174b• Alvium 1500 C-050, C-120, C-210, C -500, and1800 C-500: V00.08.01.13f227a4• Alvium G1: V00.09.00.45ce470f
Applied changes• Added support for Alvium G1 and G5 models.
• Added features in ActionControl on page 42.
(Currently available for Alvium G1 only)• Added features in SerialHub (subcategory) on
page 111. (Currently available for Alvium G1 only)• Added features in GVCP (subcategory) on page127. (Currently available for Alvium G1 only)• Added features in PtpControl on page 158.
(Currently available for Alvium G1 only)• Updated diagrams in Features processing order on
page 23 for GigE cameras.
• Applied editorial changes.

Table 1: Document history (Sheet 2 of 4)

Alvium Features Reference V2.8.1

15

Document history and conventions

Version Date
V2.6.12022-Mar-28
V2.6.02022-Mar-21

V2.5.02021-Dec-07

V2.4.12021-Sep-22

V2.4.02021-Aug-04

Document updates
Added Timer0Active and Timer1Active options for
LineSource.
Firmware version: V00.08.00.6727174b• Added support for selected Alvium 1800 C
models.
• Updated diagrams in Features processing order on
page 23 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.
Firmware version: V00.07.00.81db3896• Updated diagrams in Features processing order on
page 23 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: V00.06.00.35992• Updated Figure 1: Image data flow for Alvium
cameras on page 23.
• Added feature descriptions for
BinningHorizontal, BinningHorizontalMode,
BinningSelector, BinningVertical,
BinningVerticalMode, andDevicePowerSavingMode.
• Applied editorial changes.

Table 1: Document history (Sheet 3 of 4)

Alvium Features Reference V2.8.1

16

Document history and conventions

Version Date
V2.3.0. 2021-Apr-07

Document updates
Firmware version: V00.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

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• Applied editorial changes.
Firmware version: V00.03.00.31919• Added descriptions in Features processing orderon page 23.
• 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.
Firmware version: V00.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: V00.01.00.26405
Release version

Table 1: Document history (Sheet 4 of 4)

Alvium Features Reference V2.8.1

17Document history and conventions

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 2: Markup conventions used in this reference

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.

Alvium Features Reference V2.8.1

18Document history and conventions

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 3: 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 1.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

i

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 20.

Alvium Features Reference V2.8.1

19Document history and conventions

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 4: Standards used in this reference

Features description scheme
This document describes categories and features as seen from Vimba Viewer andfeatures in alphabetical order for Allied Vision Alvium cameras.
The features in this reference are described according to the formatting scheme
described below.

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).

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

Alvium Features Reference V2.8.1

20Document history and conventions

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.

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 © 2022 Allied Vision Technologies GmbH. All rights reserved.

Alvium Features Reference V2.8.1

21

Feature description

This chapter includes:
Features processing order .................................................... 23
Regions of interest and auto mode regions ......................... 25
Feature descriptions ............................................................. 27

Alvium Features Reference V2.8.1

22

Feature description

Features processing order
To develop your application effectively, note the order in which the features areprocessed in Alvium cameras.

Image data flow
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 frontend

Region of interest(ROI)

Reverse Y
Analog

FPNC2

Analogn-bit1

n-bit

n-bit

1

White balance

R,G,B4

R,G,B

n-bit1

Color transform
matrix4

ConvoluƟoŶĮůter
4

Y,U,V

n-bit1n-bit1De-Bayering4

R,G,B4

12

5x5

Hue4

Reverse X
n-bit15

12ADC
AnalogDigital verƟcal
Binning
n-bit1

3 Look up tables(LUTs)

Gamma
1

Black level
AnalogDigital horizontal
binning

DPC3
n-bit1

Contrast

Gain
AnalogAdaptive
noise filter

Customconvolution

Sharpness/
Blur

SaturaƟŽŶ4
R,G,B4

R,G,B4

Pixel formaƩer

1 Model dependent: See ADC bit depths
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

Frame memory6

MAC (Media
Access Control)stated in your Alvium camera’s user
guide.
2 Factory preset for FPNC = Fixed Pattern
Noise Correction.
The current firmware version does notsupport FPNC for Alvium 030 VSWIR,
052, 130 VSWIR, 291, and 2050 models.
3
Factory preset for DPC = Defect pixel
correction
4 Color models only
5 For monochrome models: Y only
6
Referred to as Image buffer in thefeature descriptions.

Figure 1: Image data flow for Alvium cameras

Alvium Features Reference V2.8.1

23

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

PixelFormat
SensorBitDepth

USB and GigE
DeviceLinkThroughputLimit
BlackLevel
ReverseX/Y
Binning SeƫngsROI Seƫngs

Set Last

ExposureTime
AcquisiƟonFrameRate

May interact

Figure 2: Interdependencies between features

Config mode for IP settings
GigE cameras: Use the Config mode in Vimba Viewer to write values for featuresin the GigE/Configuration and GigE/Persistent categories:

Figure 3: Opening a camera in Vimba Viewer’s Config mode

Alvium Features Reference V2.8.1

24

Feature description

Regions of interest and auto mode regions
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.

AutoModeRegionOffsetY
AutoModeRegionHeight

HeightHeightMax

OffsetY

WidthMax

AutoModeRegionOīsetX
OīsetX

Full sensor area
ROI
Auto mode region

AutoModeRegionWidth
Width

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.
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.

Alvium Features Reference V2.8.1

25

Feature description•••

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

C

Full sensor area

Full sensor area

ROI

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.8.1

26

Feature description

Feature descriptions
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.8.1

27

Feature description

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 24. 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.8.1

28

Feature description

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.8.1

29

Feature description

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.8.1

30

Feature description

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.8.1

31

Feature description

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.8.1

32

Feature description

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.8.1

33

Feature description

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 35.

2

Global shutter sensor cameras only.

Alvium Features Reference V2.8.1

34

Feature description

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.8.1

35

Feature description

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.8.1

36

Feature description

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.8.1

37

Feature description

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.8.1

38

Feature description

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.8.1

39

Feature description

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.8.1

40

Feature description

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.8.1

41

Feature description

ActionControl
Note: Features in this category are available for Alvium G1 and Alvium G5 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 176 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.8.1

42

Feature description

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.8.1

43

Feature description

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.8.1

44

Feature description

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.8.1

45

Feature description

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.8.1

46

Feature description

AnalogControl
The features in this category can be used to control the intensity levels formonochrome 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.8.1

47

Feature description

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.8.1

48

Feature description

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.8.1

49

Feature description

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.8.1

50

Feature description

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.8.1

51

Feature description

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.8.1

52

Feature description

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.8.1

53

Feature description

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.8.1

54

Feature description

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.8.1

55

Feature description

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.8.1

56

Feature description

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.8.1

57

Feature description

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.8.1

58

Feature description

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.8.1

The intensity controller controls the full sensor area.

59

Feature description

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.8.1

60

Feature description

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.8.1

61

Feature description

BufferHandlingControl
You need experience to use these features
We recommend you to use features in this category only if you are an advanceduser.
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

GenTL SFNC

Origin 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.8.1

62

Feature description

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.8.1

63

Feature description

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.8.1

64Feature description

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.8.1

65

Feature description

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.8.1

66

Feature description

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 65 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.8.1

67

Feature description

HueControls 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.8.1

68

Feature description

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.8.1

69

Feature description

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.8.1

70Feature description

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.8.1

71Feature description

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.8.1

72

Feature description

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.8.1

73

Feature description

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

Unit

Microseconds

Affected features

Not applicable

Category/CounterAndTimerControl

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.8.1

74

Feature description

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.8.1

75

Feature description

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.8.1

76

Feature description

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.8.1

77

Feature description

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.8.1

78

Feature description

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.8.1

The counter is inactive.

79

Feature description

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.8.1

80

Feature description

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.8.1

81Feature description

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.8.1

82

Feature description

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.8.1

83

Feature description

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.8.1

84

Feature description

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.8.1

85

Feature description

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.8.1

86Feature description

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.8.1

87

Feature description

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.8.1

88Feature description

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.8.1

89Feature description

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.8.1

90

Feature description

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.8.1

91

Feature description

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.8.1

92

Feature description

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.8.1

93

Feature description

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.8.1

94

Feature description

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.8.1

95

Feature description

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.8.1

96Feature description

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.8.1

97

Feature description

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.8.1

98

Feature description

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.8.1

99

Feature description

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.8.1

100Feature description

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.8.1

101

Feature description

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.8.1

102

Feature description

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.8.1

103

Feature description

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.8.1

104

Feature description

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

All

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.8.1

105

Feature description

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

All

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.8.1

106Feature description

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.8.1

107

Feature description

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.8.1

108

Feature description

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.8.1

109

Feature description

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 5: 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.8.1

110Feature description

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.8.1

111

Feature description

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.8.1

112

Feature description

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.8.1

113

Feature description

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.8.1

114

Feature description

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.8.1

115

Feature description

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.8.1

116

Feature description

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.8.1

117

Feature description

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.8.1

118

Feature description

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.8.1

119Feature description

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.8.1

120

Feature description

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.8.1

121

Feature description

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.8.1

122

Feature description

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

GigE

Display name

GigE

Standard

CustomOrigin of feature

Transport Layer

Feature type

(Category)Configuration (subcategory)

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

The feature in this subcategory can be used to select IP settings between DHCP,
LLA and user defined.
Interface support

GigE

Display name

Configuration

Standard

CustomOrigin of feature

Transport Layer

Feature type

(Subcategory)

Note: Open the camera in the Vimba Viewer’s Config mode to write features in thissubcategory. See Config mode for IP settings on page 24.

Alvium Features Reference V2.8.1

123Feature description

IPConfigurationMode
Selects if IP settings are configured by DHCP or by feature settings in
GigE/Persistent (subcategory) on page 131.
Interface support

GigE

Display name

IP Configuration Mode

Standard

SFNC adapted

Origin of feature

Transport Layer

Feature type

Enumeration

AccessR/W

Affected features

Not applicable

Category/GigE/Configuration

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.

Note: Open the camera in the Vimba Viewer’s Config mode to write this feature.
See Config mode for IP settings on page 24.

Alvium Features Reference V2.8.1

124

Feature description

Current (subcategory)

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

The features in this subcategory can be used to display the current IP settings ofthe camera.
Interface support

GigE

Display nameCurrent

Standard

CustomOrigin of feature

Transport Layer

Feature type

(Subcategory)

CurrentDefaultGateway
Displays the current default gateway address.
Interface support

GigE

Display nameCurrent Default Gateway

Standard

SFNC adapted

Origin of feature

Transport Layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/GigE/Current

CurrentIPAddress
Displays the current IP address.
Interface support

GigE

Display nameCurrent IP Address

Standard

SFNC adapted

Origin of feature

Transport Layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/GigE/Current

Alvium Features Reference V2.8.1

125Feature description

CurrentSubnetMask
Displays the current subnet mask address.
Interface support

GigE

Display nameCurrent Subnet Mask

Standard

SFNC adapted

Origin of feature

Transport Layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/GigE/Current

Alvium Features Reference V2.8.1

126

Feature description

GVCP (subcategory)

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)

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

Alvium Features Reference V2.8.1

127Feature description

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

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

Alvium Features Reference V2.8.1

128Feature description

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.8.1

129Feature description

GigE (category continued)
The feature descriptions for the /GigE/GVCP subcategory have ended on theprevious page. The following feature continues the GigE category, without asubcategory.

GevSCPSPacketSize
Sets the current packet size of the stream channel.
Interface support

GigE

Display name

Gev SCPS Packet Size

Standard

SFNC adapted

Origin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

DeviceStreamChannelPacketSize, GVSPPacketSize

Category/GigE

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.8.1

130Feature description

Persistent (subcategory)

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

The features in this subcategory can be used to adjust the IP settings of thecamera.
Interface support

GigE

Display name

PersistentStandard

CustomOrigin of feature

Transport Layer

Feature type

(Subcategory)

Note: Open the camera in the Vimba Viewer’s Config mode to write features in thissubcategory. See Config mode for IP settings on page 24.

PersistentDefaultGateway
Selects the default gateway address.
Interface support

GigE

Display name

Persistent Default Gateway

Standard

SFNC adapted

Origin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/GigE/PersistentNote: Open the camera in the Vimba Viewer’s Config mode to write this feature.
See Config mode for IP settings on page 24

Alvium Features Reference V2.8.1

131

Feature description

PersistentIPAddress
Selects the IP address.
Interface support

GigE

Display name

Persistent IP Address

Standard

SFNC adapted

Origin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/GigE/PersistentNote: Open the camera in the Vimba Viewer’s Config mode to write this feature.
See Config mode for IP settings on page 24.

PersistentSubnetMask
Selects the subnet mask address.
Interface support

GigE

Display name

Persistent Subnet Mask

Standard

SFNC adapted

Origin of feature

Transport Layer

Feature type

Integer

AccessR/W

Affected features

Not applicable

Category/GigE/PersistentNote: Open the camera in the Vimba Viewer’s Config mode to write this feature.
See Config mode for IP settings on page 24.

Alvium Features Reference V2.8.1

132

Feature description

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 monochrome 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.8.1

133

Feature description

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.

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.

Alvium Features Reference V2.8.1

134Feature description

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.8.1

135Feature description

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.8.1

136

Feature description

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.8.1

137

Feature description

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.8.1

138

Feature description

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.8.1

139

Feature description

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.8.1

140Feature description

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.8.1

141

Feature description

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.8.1

142

Feature description

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

Width
Controls 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

Alvium Features Reference V2.8.1

143

Feature description

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.8.1

144

Feature description

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.8.1

145

Feature description

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.8.1

146

Feature description

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.8.1

0 to 4095

Pixel count perincrement

/4

1

147

Feature description

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 147.
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.8.1

148

Feature description

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 7 and Figure 8 on page 150 show the transfer curves for different values.

Figure 7: Image transfer for a value of 1.

Alvium Features Reference V2.8.1

149

Feature description

Figure 8: Image transfer for a value of 9.

Alvium Features Reference V2.8.1

150

Feature description

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.8.1

151

Feature description

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.8.1

152

Feature description

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 9: Matrix for coefficient values

Alvium Features Reference V2.8.1

153

Feature description

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.8.1

154

Feature description

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.8.1

155

Feature description

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.

Luninance

The LUT for luminance is selected.

Red

The LUT for red is selected.

Alvium Features Reference V2.8.1

156

Feature description

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

Alvium Features Reference V2.8.1

157

Feature description

PtpControl
Note: Features in this subcategory 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.8.1

158

Feature description

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.8.1

159

Feature description

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.8.1

160

Feature description

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.8.1

161

Feature description

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.8.1

162

Feature description

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.8.1

163

Feature description

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.8.1

164

Feature description

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.8.1

165

Feature description

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.8.1

Timer0End triggers SequencerSet2.

166

Feature description

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.8.1

167

Feature description

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, LUTEnable, OffsetX, OffsetY, PixelFormat,
Saturation, 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.8.1

168Feature description

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, ChunkEnable, ChunkModeActive,
ColorTransformationEnable,
ColorTransformationValue, ExposureTime, Gain,
Gamma, Hue, PayloadSize, Saturation,
SequencerSetNext, SequencerTriggerActivation,
SequencerTriggerSource

Category/SequencerControl

Alvium Features Reference V2.8.1

169

Feature description

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.8.1

170

Feature description

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 172.
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.8.1

171

Feature description

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)

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.8.1

172

Feature description

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.8.1

173

Feature description

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 6: SequencerTriggerSource values (sheet 1 of 2)

Alvium Features Reference V2.8.1

174

Feature description

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 6: SequencerTriggerSource values (sheet 2 of 2)

Alvium Features Reference V2.8.1

175Feature description

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 42 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.8.1

176

Feature description

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.8.1

177

Feature description

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)

DeviceMACAddress
Displays the 48-bit MAC address of the camera’s GVCP interface.
Interface support

GigE

Display name

Device MAC Address

Standard

CustomOrigin of feature

Transport layer

Feature type

StringAccessR

Affected features

Not applicable

Category/Stream/Info

Alvium Features Reference V2.8.1

178

Feature description

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

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)MulticastEnable
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.8.1

179

Feature description

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.8.1

180

Feature description

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)

GVSPAdjustPacketSize
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.8.1

181

Feature description

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.8.1

182

Feature description

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.8.1

183

Feature description

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.8.1

184

Feature description

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.8.1

185

Feature description

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.8.1

186

Feature description

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)

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.8.1

187

Feature description

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

GigE

Display nameStat Frames Delivered

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

StatFramesDropped
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 Frames Dropped

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.8.1

188

Feature description

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

GigE

Display nameStat Frames Rescued

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

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

GigE

Display nameStat Frames 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.8.1

189

Feature description

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

GigE

Display nameStat Frames 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.8.1

190

Feature description

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

GigE

Display nameStat Packets Errors

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

StatPacketsMissed
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 Packets 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.8.1

191

Feature description

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

GigE

Display nameStat Packets Received

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

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

GigE

Display nameStat Packets 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.8.1

192

Feature description

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

GigE

Display nameStat Packets ResentStandard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/Stream/Statistics

ValuesDescription0

Minimum value

4294967295

Maximum value

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

GigE

Display nameStat Packets 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.8.1

193Feature description

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.8.1

194Feature description

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.8.1

195Feature description

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

CSI-2

The 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.8.1

196

Feature description

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.8.1

197

Feature description

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

CSI-2

Display nameStat Frames 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

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

CSI-2

Display nameStat Frames 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.8.1

198

Feature description

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

CSI-2

Display nameStat Frames Incomplete

Standard

CustomOrigin of feature

Transport layer

Feature type

Integer

AccessR

Affected features

Not applicable

Category/StreamInformation/Statistics

ValuesDescription0

Minimum value

9223372036854775807

Maximum value

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

CSI-2

Display nameStat Frames 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.8.1

199

Feature description

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

CSI-2, USB

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

CSI-2, USB

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.8.1

200

Feature description

TransferControl
Note: Features in this category are available for Alvium G1 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

Alvium G1

Display name

Transfer Control

Standard

SFNC adapted

Origin of feature

CameraFeature type

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

Alvium G1

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.8.1

201

Feature description

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

Alvium G1

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

Alvium G1

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.8.1

202

Feature description

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

Alvium G1

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.8.1

203Feature description

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

All

Display name

Transport Layer Control

Standard

SFNC

Origin of feature

CameraFeature type

(Category)

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.8.1

204Feature description

GigEVision
Note: The feature in this subcategory is• Available for Alvium GigE cameras only
• Invisible in Vimba Viewer.
The feature in this subcategory can be used to control the stream packet size to betransmitted on the selected channel for a GVSP transmitter.
Interface support

GigE

Display name

GigE Vison

Standard

SFNC

Origin of feature

Transport layer

Feature type

(Subcategory)

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

Transport layer

Feature type

Integer

AccessR/W

Affected features

DeviceStreamChannelPacketSize

Category/TransportLayerControl/GigEVision

Alvium Features Reference V2.8.1

205

Feature description

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.8.1

206

Feature description

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

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.8.1

207Feature description

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

CSI-2

Display name

Packet Count

Standard

CustomOrigin of feature

Transport layer

Feature 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

Transport layer

Feature type

Integer

Access

R

Unit

Bytes

Affected features

Not applicable

Category/TransportLayerControl/Info

ValuesDescription0

Minimum

4294967295

Maximum

Alvium Features Reference V2.8.1

208

Feature description

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.8.1

209

Feature description

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.8.1

210

Feature description

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.8.1

211

Index

Index
A

AcquisitionControl (category) .........................27
AcquisitionFrameCount ...................................27
AcquisitionFrameRate .....................................28
AcquisitionFrameRateEnable ..........................28
AcquisitionFrameRateMode ............................29
AcquisitionMode .............................................30
AcquisitionStart ...............................................30
AcquisitionStatus .............................................31
AcquisitionStatusSelector ................................31
AcquisitionStop ................................................32
ActionControl ...................................................42
ActionDeviceKey ..............................................42
ActionGroupKey ...............................................43
ActionGroupMask ............................................44
ActionQueueSize .............................................45
ActionSelector .................................................46
AdaptiveNoiseSupressionFactor .................. 145
AnalogControl (category) ................................47
AutoModeControl (category) ..........................52
AutoModeRegionHeight ..................................52
AutoModeRegionOffsetX ................................52
AutoModeRegionOffsetY .................................53
AutoModeRegionSelector ...............................53
AutoModeRegionWidth ..................................54

B

BalanceRatio ....................................................47
BalanceRatioSelector .......................................48
BalanceWhiteAuto ...........................................48
BalanceWhiteAutoRate ...................................54
BalanceWhiteAutoTolerance ..........................55
BinningHorizontal ......................................... 133
BinningHorizontalMode ............................... 134
BinningSelector ............................................. 134
BinningVertical .............................................. 135
BinningVerticalMode .................................... 136
BlackLevel ........................................................49
BlackLevelSelector ...........................................49
BufferHandlingControl (category) ...................62

C

ColorInterpolation ........................................ 146
ColorTransformationControl (category) .........65

Alvium Features Reference V2.8.1

ColorTransformationEnable ........................... 65
ColorTransformationValue ............................. 66
ColorTransformationValueSelector ................ 67
Configuration (subcategory) ......................... 123
ContrastBrightLimit ....................................... 147
ContrastControl (subcategory) ..................... 147
ContrastDarkLimit ......................................... 148
ContrastEnable ............................................. 148
ContrastShape .............................................. 149
ConvolutionMode ......................................... 151
CorrectionControl (category) ......................... 70
CorrectionDataSize ......................................... 73
CorrectionEntryType ....................................... 73
CorrectionInfo (subcategory) ................. 73, 111
CorrectionMode ............................................. 70
CorrectionSelector .......................................... 71
CorrectionSet .................................................. 71
CorrectionSetDefault ...................................... 72
CounterAndTimerControl (category) ............. 70
CounterDuration ............................................. 74
CounterEventActivation ................................. 75
CounterEventSource ....................................... 76
CounterReset .................................................. 77
CounterResetActivation .................................. 77
CounterResetSource ................................. 78, 79
CounterSelector .............................................. 79
CounterTriggerActivation ............................... 80
CounterTriggerSource .................................... 81
CounterValue .................................................. 82
CounterValueAtReset ..................................... 82
CSI-2ClockFrequency .................................... 206
CSI-2DriverInterfaceVersion ......................... 206
CSI-2DriverVersion ........................................ 207
CSI-2LaneCount ............................................ 207
Current (subcategory) .................................. 125
CurrentDefaultGateway ....................... 125, 131
CurrentIPAddress .......................................... 125
CurrentSubnetMask ...................................... 126
CustomConvolutionValue ............................. 152
CustomConvolutionValueSelector ............... 153

D

DeviceControl (category) ................................ 88
DeviceFamilyName ......................................... 88
DeviceFirmwareID .......................................... 88
DeviceFirmwareIDSelector ............................. 89
DeviceFirmwareVersion .................................. 89
DeviceFirmwareVersionSelector .................... 90212

Index

DeviceGenCPVersionMajor .............................90
DeviceGenCPVersionMinor .............................91
DeviceIndicatorLuminance ..............................91
DeviceIndicatorMode ......................................92
DeviceLinkCommandTimeout .........................92
DeviceLinkSpeed ..............................................93
DeviceLinkThroughputLimit ............................94
DeviceLinkThroughputLimitMode ...................95
DeviceMACAddress ...................................... 178
DeviceManufacturerInfo .................................95
DeviceModelName ..........................................96
DevicePowerSavingMode ................................96
DeviceReset .....................................................97
DeviceScanType ...............................................98
DeviceSerialNumber ........................................99
DeviceSFNCVersionMajor ................................97
DeviceSFNCVersionMinor ...............................97
DeviceSFNCVersionSubMinor .........................98
DeviceStreamChannelSize ...............................99
DeviceTemperature ...................................... 100
DeviceTemperatureSelector ........................ 100
DeviceTLVersionMajor ................................. 101
DeviceTLVersionMinor ................................. 101
DeviceUserID ................................................ 102
DeviceVendorName ...................................... 102
DeviceVersion ............................................... 102
DigitalIOControl (category) .......................... 105

E

FileSize .......................................................... 122
FileStatus ....................................................... 122

GGain ................................................................. 50
GainAuto ......................................................... 50
GainAutoMax .................................................. 56
GainAutoMin ................................................... 56
GainSelector .................................................... 51
Gamma ............................................................ 51
GevHeartbeatInterval ................................... 128
GevHeartbeatTimeout .................................. 129
GevSCPSPacketSize ............................... 130, 205
GigE (category) ............................................. 123
GigEVision (subcategory) .............................. 205
GVCP (subcategory) ...................................... 127
GVCPCmdRetries .......................................... 127
GVCPCmdTimeout ........................................ 128
GVSPAdjustPacketSize .................................. 181
GVSPBurstSize ............................................... 182
GVSPDriverSelector ...................................... 182
GVSPFilterVersion ......................................... 179
GVSPHostReceiveBufferSize ......................... 183
GVSPMaxLookBack ....................................... 183
GVSPMaxRequests ........................................ 184
GVSPMaxWaitSize ......................................... 184
GVSPMissingSize ........................................... 185
GVSPPacketSize ............................................ 185
GVSPTiltingSize ............................................. 186
GVSPTimeout ................................................ 186

ExposureActiveMode ......................................32
ExposureAuto ..................................................33
ExposureAutoMax ...........................................55
ExposureAutoMin ............................................56
ExposureMode .................................................34
ExposureTime ..................................................36

Height ............................................................ 136
HeightMax ..................................................... 137
Hue .................................................................. 68

F

I

FileAccessBuffer ............................................ 116
FileAccessControl (category) ........................ 116
FileAccessLength .......................................... 116
FileAccessOffset ............................................ 117
FileOpenMode .............................................. 117
FileOperationExecute ................................... 118
FileOperationResult ...................................... 118
FileOperationSelector ................................... 119
FileOperationStatus ...................................... 120
FileProcessStatus .......................................... 120
FileSelector ................................................... 121

Alvium Features Reference V2.8.1

H

ImageFormatControl (category) ................... 133
ImageProcessingControl (category) ............. 145
Info (subcategory) ................................. 178, 206
IntensityAutoPrecedence ............................... 57
IntensityControllerAlgorithm ......................... 57
IntensityControllerOutliersBright ................... 58
IntensityControllerOutliersDark ..................... 58
IntensityControllerRate .................................. 59
IntensityControllerRegion .............................. 59
IntensityControllerSelector ............................ 60
IntensityControllerTarget ............................... 60

213

IndexIntensityControllerTolerance ..........................61
IPConfigurationMode ................................... 124

PtpServoStatus .............................................. 163
PtpStatus ....................................................... 164

LR

LibcsiVersion ................................................. 207
LineDebounceDuration ................................ 105
LineDebounceMode ..................................... 106
LineInverter .................................................. 106
LineMode ...................................................... 107
LineSelector .................................................. 107
LineSource .................................................... 108
LineStatus ..................................................... 109
LineStatusAll ................................................. 109
LUTControl (category) .................................. 155
LUTEnable ..................................................... 155
LUTIndex ....................................................... 156
LUTSelector ................................................... 156
LUTValue ....................................................... 157

M

MaxDriverBuffersCount ...................................62
Multicast (subcategory) ................................ 179
MulticastEnable ............................................ 179
MulticastIPAddress ....................................... 180

O

OffsetX .......................................................... 137
OffsetY .......................................................... 138

P

PacketCount .................................................. 208
PacketSize ..................................................... 208
PayloadSize ................................................... 204
Persistent (subcategory) .............................. 131
PersistentDefaultGateway ............................ 131
PersistentIPAddress ...................................... 132
PersistentSubnetMask .................................. 132
PixelFormat ................................................... 138
PixelSize ........................................................ 139
PtpClockAccuracy ......................................... 158
PtpClockID ..................................................... 159
PtpDataSetLatch ........................................... 159
PtpEnable ...................................................... 160
PtpGrandmasterClockID ............................... 160
PtpOffsetFromMaster .................................. 161
PtpOperationMode ...................................... 161
PtpParentClockID .......................................... 162
PtpProtocol (category) ................................. 158

Alvium Features Reference V2.8.1

ReverseX ....................................................... 139
ReverseY ........................................................ 140

S

Saturation ....................................................... 69
SensorBitDepth ............................................. 141
SensorHeight ................................................. 142
SensorWidth ................................................. 142
SequencerConfigurationMode ..................... 167
SequencerControl (category) ....................... 165
SequencerFeatureEnable ............................. 167
SequencerFeatureSelector ........................... 168
SequencerMode ........................................... 168
SequencerPathControl (subcategory) .......... 172
SequencerPathSelector ................................ 172
SequencerSetActive ...................................... 169
SequencerSetLoad ........................................ 169
SequencerSetNext ........................................ 173
SequencerSetSave ........................................ 170
SequencerSetSelector .................................. 170
SequencerSetStart ........................................ 171
SequencerTriggerActivation ......................... 173
SequencerTriggerSource .............................. 174
SerialBaudRate .............................................. 111
SerialHub (subcategory) ............................... 111
SerialHubEnable ............................................ 110
SerialParityBit ................................................ 112
SerialRxData .................................................. 112
SerialRxSize ................................................... 113
SerialRxWaiting ............................................. 113
SerialStopBits ................................................ 114
SerialTxData .................................................. 114
SerialTxRemaining ......................................... 115
SerialTxSize ................................................... 115
Settings (subcategory) .................................. 181
Sharpness ...................................................... 154
ShutterMode ................................................. 143
SoftwareSignalControl (category) ................ 176
SoftwareSignalPulse ..................................... 176
SoftwareSignalSelector ................................. 177
StatFrameRate ...................................... 187, 197
StatFrameRescued ........................................ 189
StatFramesCRCError ..................................... 198
StatFramesDelivered ............................ 188, 198214

IndexStatFramesDropped ..................................... 188
StatFrameShoved ......................................... 189
StatFramesIncomplete ................................. 199
StatFramesUnderrun ............................ 190, 199
StatFrameUnderrun ..................................... 199
Statistics (subcategory) ........................ 187, 197
StatLocalRate ................................................ 190
StatPacketMissed ......................................... 191
StatPacketReceived ...................................... 192
StatPacketsErrors ......................................... 191
StatPacketsRequested .................................. 192
StatPacketsResent ........................................ 193
StatPacketsUnavailable ................................ 193
StatTimeElapsed ........................................... 194
Stream (category) ......................................... 178
StreamAnnounceBufferMinimum ...................63
StreamAnnouncedBufferCount .......................63
StreamBufferHandlingMode ...........................64
StreamID ....................................................... 195
StreamInformation (category) ..................... 195
StreamIsGrabbing ......................................... 195
StreamType ................................................... 196

U

UserSetControl (category) ............................ 209
UserSetDefault .............................................. 209
UserSetLoad .................................................. 210
UserSetSelector ............................................ 211

W

Width ............................................................ 143
WidthMax ..................................................... 144

T

TestControl (category) .................................. 200
TestPendingAck ............................................ 200
TimerDelay .......................................................83
TimerDuration .................................................84
TimerReset .......................................................84
TimerSelector ..................................................85
TimerStatus ......................................................85
TimerTriggerActivation ....................................86
TimerTriggerSource .........................................87
TimestampLatch ........................................... 103
TimestampLatchValue .................................. 103
TimestampReset ........................................... 104
TransferControl (category) ........................... 201
TransferControlMode ................................... 201
TransferQueueCurrentBlockCount .............. 202
TransferQueueMaxBlockCount .................... 202
TransferSelector ........................................... 203
TransportLayerControl (category) ................ 204
TriggerActivation .............................................36
TriggerDelay ............................................ 37, 105
TriggerMode ....................................................38
TriggerSelector ................................................39
TriggerSoftware ...............................................40
TriggerSource ...................................................41

Alvium Features Reference V2.8.1

215