GenICam SFNC 2 0 0 PDF

Version 2.
0 Standard Features Naming Convention
GenICam
Standard Features
Naming Convention
Version 2.0
2012-10-25 Page 1 of 366

Version 2.0 Standard Features Naming Convention
Table of Content
TABLE OF CONTENT .............................................................................................................. 2
TABLE OF FIGURES .............................................................................................................. 14
HISTORY................................................................................................................................... 16
1 INTRODUCTION .............................................................................................................. 26
1.1 CONVENTIONS ............................................................................................................. 27

1.2 STANDARD UNITS ........................................................................................................ 29
1.3 ACRONYMS .................................................................................................................. 30
1.4 STANDARD DEFINITIONS .............................................................................................. 31
1.5 DEVICE COMMUNICATION MODEL .............................................................................. 32
1.6 DEVICE ACQUISITION MODEL...................................................................................... 33
2 FEATURES SUMMARY................................................................................................... 35
2.1 DEVICE CONTROL ........................................................................................................ 35

2.1 IMAGE FORMAT CONTROL ...........................................................................................39
2.2 ACQUISITION CONTROL ............................................................................................... 41
2.3 DIGITAL I/O CONTROL.................................................................................................42
2.4 COUNTER AND TIMER CONTROL .................................................................................. 43
2.5 EVENT CONTROL ......................................................................................................... 44
2.6 ANALOG CONTROL ......................................................................................................46
2.7 LUT CONTROL ............................................................................................................ 47
2.8 GENICAM CONTROL .................................................................................................... 48
2.9 TRANSPORT LAYER CONTROL ..................................................................................... 48
2.10 USER SET CONTROL.....................................................................................................55
2.11 CHUNK DATA CONTROL .............................................................................................. 55
2.12 FILE ACCESS CONTROL................................................................................................ 57
2.13 COLOR TRANSFORMATION CONTROL .......................................................................... 58
2.14 ACTION CONTROL........................................................................................................ 59
2.15 SOURCE CONTROL .......................................................................................................59
2.16 TRANSFER CONTROL ...................................................................................................60
3 DEVICE CONTROL ......................................................................................................... 62
3.1 DEVICECONTROL ......................................................................................................... 62

3.2 DEVICETYPE ................................................................................................................ 62
3.3 DEVICESCANTYPE .......................................................................................................63
3.4 DEVICEVENDORNAME ................................................................................................ 63
3.5 DEVICEMODELNAME .................................................................................................. 63
3.6 DEVICEFAMILYNAME .................................................................................................. 64
3.7 DEVICEMANUFACTURERINFO...................................................................................... 64
2012-10-25 Page 2 of 366

3.8 DEVICEVERSION .......................................................................................................... 64

3.9 DEVICEFIRMWAREVERSION ........................................................................................ 65
3.1 DEVICESERIALNUMBER .............................................................................................. 65
3.2 DEVICEID (DEPRECATED) ...........................................................................................65
3.3 DEVICEUSERID ...........................................................................................................66
3.4 DEVICESFNCVERSIONMAJOR .................................................................................... 66
3.5 DEVICESFNCVERSIONMINOR.....................................................................................67
3.6 DEVICESFNCVERSIONSUBMINOR .............................................................................. 67
3.7 DEVICEMANIFESTENTRYSELECTOR ............................................................................ 67
3.8 DEVICEMANIFESTXMLMAJORVERSION ..................................................................... 68
3.9 DEVICEMANIFESTXMLMINORVERSION .....................................................................68
3.10 DEVICEMANIFESTXMLSUBMINORVERSION .............................................................. 68
3.11 DEVICEMANIFESTSCHEMAMAJORVERSION ................................................................ 69
3.12 DEVICEMANIFESTSCHEMAMINORVERSION ................................................................ 69
3.13 DEVICEMANIFESTPRIMARYURL ................................................................................. 69
3.14 DEVICEMANIFESTSECONDARYURL ............................................................................ 70
3.15 DEVICETLTYPE ...........................................................................................................70
3.16 DEVICETLVERSIONMAJOR .........................................................................................71
3.17 DEVICETLVERSIONMINOR .......................................................................................... 71
3.18 DEVICETLVERSIONSUBMINOR ................................................................................... 71
3.19 DEVICEGENCPVERSIONMAJOR .................................................................................. 72
3.20 DEVICEGENCPVERSIONMINOR................................................................................... 72
3.21 DEVICEMAXTHROUGHPUT .......................................................................................... 72
3.22 DEVICECONNECTIONSELECTOR................................................................................... 73
3.23 DEVICECONNECTIONSPEED .........................................................................................73
3.24 DEVICECONNECTIONSTATUS .......................................................................................73
3.25 DEVICELINKSELECTOR ................................................................................................ 74
3.26 DEVICELINKSPEED ...................................................................................................... 74
3.27 DEVICELINKTHROUGHPUTLIMITMODE .......................................................................75
3.28 DEVICELINKTHROUGHPUTLIMIT .................................................................................75
3.29 DEVICELINKCONNECTIONCOUNT................................................................................ 76
3.30 DEVICELINKHEARTBEATMODE...................................................................................76
3.31 DEVICELINKHEARTBEATTIMEOUT .............................................................................. 76
3.32 DEVICELINKCOMMANDTIMEOUT ................................................................................ 77
3.33 DEVICESTREAMCHANNELCOUNT ................................................................................ 77
3.34 DEVICESTREAMCHANNELSELECTOR ...........................................................................77
3.35 DEVICESTREAMCHANNELTYPE ...................................................................................78
3.36 DEVICESTREAMCHANNELLINK ...................................................................................78
3.37 DEVICESTREAMCHANNELENDIANNESS ....................................................................... 78
3.38 DEVICESTREAMCHANNELPACKETSIZE .......................................................................79
3.39 DEVICEMESSAGECHANNELCOUNT.............................................................................. 79
3.40 DEVICECHARACTERSET .............................................................................................. 80
3.41 DEVICERESET .............................................................................................................. 80
3.42 DEVICEINDICATORMODE ............................................................................................ 80
3.43 DEVICEFEATUREPERSISTENCESTART .......................................................................... 81
3.44 DEVICEFEATUREPERSISTENCEEND .............................................................................81
2012-10-25 Page 3 of 366
3.45 DEVICEREGISTERSSTREAMINGSTART ......................................................................... 81

3.46 DEVICEREGISTERSSTREAMINGEND .............................................................................82
3.47 DEVICEREGISTERSCHECK ........................................................................................... 82
3.48 DEVICEREGISTERSVALID ............................................................................................ 83
3.49 DEVICETEMPERATURESELECTOR ................................................................................ 83
3.50 DEVICETEMPERATURE .................................................................................................83
3.51 DEVICECLOCKSELECTOR ............................................................................................ 84
3.52 DEVICECLOCKFREQUENCY ......................................................................................... 84
3.53 DEVICESERIALPORTSELECTOR .................................................................................... 85
3.54 DEVICESERIALPORTBAUDRATE .................................................................................. 85
3.55 TIMESTAMP.................................................................................................................. 86
3.56 TIMESTAMPRESET ....................................................................................................... 86
4 IMAGE FORMAT CONTROL ........................................................................................ 88
4.1 IMAGEFORMATCONTROL............................................................................................. 89
4.2 SENSORWIDTH ............................................................................................................ 89
4.3 SENSORHEIGHT ...........................................................................................................90
4.4 SENSORTAPS................................................................................................................ 90
4.5 SENSORDIGITIZATIONTAPS .........................................................................................91
4.6 WIDTHMAX ................................................................................................................. 91
4.7 HEIGHTMAX ................................................................................................................ 92
4.8 REGIONSELECTOR .......................................................................................................92
4.9 REGIONMODE .............................................................................................................. 93
4.10 REGIONDESTINATION .................................................................................................. 93
4.11 WIDTH ......................................................................................................................... 94
4.12 HEIGHT ........................................................................................................................ 94
4.13 OFFSETX .....................................................................................................................95
4.14 OFFSETY .....................................................................................................................95
4.15 LINEPITCH ................................................................................................................... 95
4.16 BINNINGSELECTOR ...................................................................................................... 96
4.17 BINNINGHORIZONTAL .................................................................................................96
4.18 BINNINGVERTICAL ...................................................................................................... 97
4.19 DECIMATIONHORIZONTAL ...........................................................................................97
4.20 DECIMATIONVERTICAL ...............................................................................................97
4.21 REVERSEX ................................................................................................................... 98
4.22 REVERSEY ................................................................................................................... 98
4.23 PIXELFORMAT ............................................................................................................. 99
4.24 PIXELCODING (DEPRECATED) ................................................................................... 105
4.25 PIXELSIZE .................................................................................................................. 106
4.26 PIXELCOLORFILTER .................................................................................................. 107
4.27 PIXELDYNAMICRANGEMIN .......................................................................................107
4.28 PIXELDYNAMICRANGEMAX ...................................................................................... 108
4.29 TESTPATTERNGENERATORSELECTOR ....................................................................... 108
4.30 TESTPATTERN............................................................................................................ 109
4.31 TESTIMAGESELECTOR (DEPRECATED)....................................................................... 110
2012-10-25 Page 4 of 366
4.32 DEINTERLACING ........................................................................................................ 111

4.33 IMAGE COMPRESSION ................................................................................................ 112
4.33.1 IMAGECOMPRESSIONMODE ....................................................................................... 112
4.33.2 IMAGECOMPRESSIONRATEOPTION ............................................................................ 112
4.33.3 IMAGECOMPRESSIONQUALITY .................................................................................. 113
4.33.4 IMAGECOMPRESSIONBITRATE ................................................................................... 113
4.33.5 IMAGECOMPRESSIONJPEGFORMATOPTION .............................................................. 114
5 ACQUISITION CONTROL ............................................................................................ 115
5.1 ACQUISITION RELATED VOCABULARY AND SIGNALS.................................................. 115

5.2 ACQUISITION FEATURES USAGE MODEL .....................................................................119
5.3 ACQUISITION TIMING DIAGRAMS ...............................................................................120
5.4 ACQUISITION CONTROL FEATURES ............................................................................ 131
5.4.1 ACQUISITIONCONTROL .............................................................................................. 131
5.4.2 ACQUISITIONMODE ................................................................................................... 131
5.4.3 ACQUISITIONSTART ...................................................................................................132
5.4.4 ACQUISITIONSTOP ..................................................................................................... 132
5.4.5 ACQUISITIONABORT .................................................................................................. 133
5.4.6 ACQUISITIONARM...................................................................................................... 133
5.4.7 ACQUISITIONFRAMECOUNT.......................................................................................134
5.4.8 ACQUISITIONBURSTFRAMECOUNT ............................................................................ 134
5.4.9 ACQUISITIONFRAMERATE ......................................................................................... 135
5.4.10 ACQUISITIONLINERATE .............................................................................................135
5.4.11 ACQUISITIONSTATUSSELECTOR ................................................................................ 135
5.4.12 ACQUISITIONSTATUS .................................................................................................136
5.5 TRIGGER CONTROL FEATURES ................................................................................... 138
5.5.1 TRIGGERSELECTOR .................................................................................................... 139
5.5.2 TRIGGERMODE ..........................................................................................................141
5.5.3 TRIGGERSOFTWARE ...................................................................................................141
5.5.4 TRIGGERSOURCE ....................................................................................................... 142
5.5.5 TRIGGERACTIVATION ................................................................................................ 143
5.5.6 TRIGGEROVERLAP .....................................................................................................144
5.5.7 TRIGGERDELAY .........................................................................................................144
5.5.8 TRIGGERDIVIDER....................................................................................................... 145
5.5.9 TRIGGERMULTIPLIER .................................................................................................145
5.6 EXPOSURE CONTROL FEATURES ................................................................................ 146
5.6.1 EXPOSUREMODE .......................................................................................................146
5.6.2 EXPOSURETIME ......................................................................................................... 148
5.6.3 EXPOSUREAUTO ........................................................................................................148
6 DIGITAL I/O CONTROL ............................................................................................... 150
6.1 DIGITALIOCONTROL ................................................................................................. 151

6.2 LINESELECTOR .......................................................................................................... 152
6.3 LINEMODE.................................................................................................................153
2012-10-25 Page 5 of 366

6.4 LINEINVERTER ...........................................................................................................153

6.5 LINESTATUS .............................................................................................................. 154
6.6 LINESTATUSALL .......................................................................................................154
6.7 LINESOURCE .............................................................................................................. 155
6.8 LINEFORMAT .............................................................................................................156
6.9 USEROUTPUTSELECTOR ............................................................................................157
6.10 USEROUTPUTVALUE ................................................................................................. 157
6.11 USEROUTPUTVALUEALL...........................................................................................158
6.12 USEROUTPUTVALUEALLMASK.................................................................................158
7 COUNTER AND TIMER CONTROL ........................................................................... 160
7.1 COUNTERANDTIMERCONTROL.................................................................................. 160

7.2 COUNTERSELECTOR .................................................................................................. 161
7.3 COUNTEREVENTSOURCE ...........................................................................................161
7.4 COUNTEREVENTACTIVATION .................................................................................... 163
7.5 COUNTERRESETSOURCE ............................................................................................ 163
7.6 COUNTERRESETACTIVATION.....................................................................................165
7.7 COUNTERRESET .........................................................................................................165
7.8 COUNTERVALUE........................................................................................................ 166
7.9 COUNTERVALUEATRESET.........................................................................................166
7.10 COUNTERDURATION .................................................................................................. 167
7.11 COUNTERSTATUS ...................................................................................................... 167
7.12 COUNTERTRIGGERSOURCE ........................................................................................ 168
7.13 COUNTERTRIGGERACTIVATION................................................................................. 169
7.14 TIMERSELECTOR........................................................................................................ 170
7.15 TIMERDURATION ....................................................................................................... 170
7.16 TIMERDELAY ............................................................................................................. 171
7.17 TIMERRESET .............................................................................................................. 171
7.18 TIMERVALUE ............................................................................................................. 172
7.19 TIMERSTATUS ............................................................................................................ 172
7.20 TIMERTRIGGERSOURCE .............................................................................................173
7.21 TIMERTRIGGERACTIVATION ...................................................................................... 174
8 EVENT CONTROL ......................................................................................................... 176
8.1 EVENTCONTROL ........................................................................................................ 178

8.2 EVENTSELECTOR .......................................................................................................179
8.3 EVENTNOTIFICATION................................................................................................. 182
8.4 FRAME TRIGGER EVENT (EXAMPLE #1).....................................................................182
8.4.1 EVENTFRAMETRIGGERDATA .................................................................................... 183
8.4.2 EVENTFRAMETRIGGER .............................................................................................. 183
8.4.3 EVENTFRAMETRIGGERTIMESTAMP ...........................................................................183
8.4.4 EVENTFRAMETRIGGERFRAMEID .............................................................................. 184
8.5 EXPOSURE END EVENT (EXAMPLE #2) ...................................................................... 184
8.5.1 EVENTEXPOSUREENDDATA ...................................................................................... 184
2012-10-25 Page 6 of 366

8.5.2 EVENTEXPOSUREEND ................................................................................................ 185

8.5.3 EVENTEXPOSUREENDTIMESTAMP ............................................................................. 185
8.5.4 EVENTEXPOSUREENDFRAMEID ................................................................................ 185
8.6 ERROR EVENT (EXAMPLE #3) .................................................................................... 186
8.6.1 EVENTERRORDATA ...................................................................................................186
8.6.2 EVENTERROR ............................................................................................................ 186
8.6.3 EVENTERRORTIMESTAMP .......................................................................................... 187
8.6.4 EVENTERRORFRAMEID .............................................................................................187
8.6.5 EVENTERRORCODE ................................................................................................... 188
9 ANALOG CONTROL ..................................................................................................... 189
9.1 ANALOGCONTROL ..................................................................................................... 190

9.2 GAINSELECTOR .........................................................................................................190
9.3 GAIN .......................................................................................................................... 193
9.4 GAINAUTO ................................................................................................................ 193
9.5 GAINAUTOBALANCE .................................................................................................194
9.6 BLACKLEVELSELECTOR ............................................................................................195
9.7 BLACKLEVEL............................................................................................................. 196
9.8 BLACKLEVELAUTO ................................................................................................... 196
9.9 BLACKLEVELAUTOBALANCE .................................................................................... 197
9.10 WHITECLIPSELECTOR................................................................................................ 198
9.11 WHITECLIP ................................................................................................................ 199
9.12 BALANCERATIOSELECTOR ........................................................................................ 199
9.13 BALANCERATIO .........................................................................................................200
9.14 BALANCEWHITEAUTO...............................................................................................201
9.15 GAMMA ..................................................................................................................... 201
10 LUT CONTROL ............................................................................................................... 203
10.1 LUTCONTROL ...........................................................................................................203

10.2 LUTSELECTOR .......................................................................................................... 203
10.3 LUTENABLE .............................................................................................................. 204
10.4 LUTINDEX ................................................................................................................ 204
10.5 LUTVALUE ............................................................................................................... 204
10.6 LUTVALUEALL.........................................................................................................205
11 GENICAM CONTROL ................................................................................................... 206
11.1 ROOT ......................................................................................................................... 206

11.2 DEVICE ...................................................................................................................... 206
11.3 TLPARAMSLOCKED ................................................................................................... 207
12 TRANSPORT LAYER CONTROL ............................................................................... 208
12.1 TRANSPORT LAYER FEATURES ...................................................................................209

12.1.1 TRANSPORTLAYERCONTROL .....................................................................................209
2012-10-25 Page 7 of 366
12.1.2 PAYLOADSIZE ............................................................................................................ 209

12.1.3 DEVICETAPGEOMETRY.............................................................................................. 210
12.2 GIGE VISION FEATURES ............................................................................................. 213
12.2.1 GIGEVISION .............................................................................................................. 213
12.2.2 GEVVERSIONMAJOR .................................................................................................213
12.2.3 GEVVERSIONMINOR .................................................................................................. 213
12.2.4 GEVDEVICEMODEISBIGENDIAN ............................................................................... 214
12.2.5 GEVDEVICECLASS ..................................................................................................... 214
12.2.6 GEVDEVICEMODECHARACTERSET ...........................................................................215
12.2.7 GEVPHYSICALLINKCONFIGURATION .........................................................................215
12.2.8 GEVCURRENTPHYSICALLINKCONFIGURATION ......................................................... 216
12.2.9 GEVACTIVELINKCOUNT............................................................................................ 216
12.2.10 GEVINTERFACESELECTOR .........................................................................................216
12.2.11 GEVLINKSPEED ......................................................................................................... 217
12.2.12 GEVMACADDRESS ................................................................................................... 217
12.2.13 GEVSUPPORTEDOPTIONSELECTOR ............................................................................ 218
12.2.14 GEVSUPPORTEDOPTION ............................................................................................ 219
12.2.15 GEVPAUSEFRAMERECEPTION ................................................................................. 220
12.2.16 GEVPAUSEFRAMETRANSMISSION ........................................................................... 220
12.2.17 GEVCURRENTIPCONFIGURATIONLLA ...................................................................... 220
12.2.18 GEVCURRENTIPCONFIGURATIONDHCP ................................................................... 221
12.2.19 GEVCURRENTIPCONFIGURATIONPERSISTENTIP ....................................................... 221
12.2.20 GEVCURRENTIPADDRESS ......................................................................................... 222
12.2.21 GEVCURRENTSUBNETMASK ..................................................................................... 222
12.2.22 GEVCURRENTDEFAULTGATEWAY ............................................................................ 222
12.2.23 GEVIPCONFIGURATIONSTATUS ................................................................................. 223
12.2.24 GEVFIRSTURL .......................................................................................................... 223
12.2.25 GEVSECONDURL ...................................................................................................... 224
12.2.26 GEVNUMBEROFINTERFACES .....................................................................................224
12.2.27 GEVPERSISTENTIPADDRESS ...................................................................................... 224
12.2.28 GEVPERSISTENTSUBNETMASK .................................................................................. 225
12.2.29 GEVPERSISTENTDEFAULTGATEWAY .........................................................................225
12.2.30 GEVMESSAGECHANNELCOUNT.................................................................................226
12.2.31 GEVSTREAMCHANNELCOUNT ...................................................................................226
12.2.32 GEVHEARTBEATTIMEOUT .........................................................................................226
12.2.33 GEVTIMESTAMPTICKFREQUENCY .............................................................................227
12.2.34 GEVTIMESTAMPCONTROLLATCH .............................................................................. 227
12.2.35 GEVTIMESTAMPCONTROLRESET ...............................................................................228
12.2.36 GEVTIMESTAMPVALUE ............................................................................................. 228
12.2.37 GEVDISCOVERYACKDELAY ...................................................................................... 228
12.2.38 GEVIEEE1588 ........................................................................................................... 229
12.2.39 GEVIEEE1588CLOCKACCURACY .............................................................................229
12.2.40 GEVIEEE1588STATUS .............................................................................................. 230
12.2.41 GEVGVCPEXTENDEDSTATUSCODESSELECTOR ....................................................... 231
12.2.42 GEVGVCPEXTENDEDSTATUSCODES ........................................................................ 231
12.2.43 GEVGVCPPENDINGACK ...........................................................................................231
2012-10-25 Page 8 of 366
12.2.44 GEVGVCPHEARTBEATDISABLE ............................................................................... 232

12.2.45 GEVGVCPPENDINGTIMEOUT ...................................................................................232
12.2.46 GEVPRIMARYAPPLICATIONSWITCHOVERKEY ...........................................................233
12.2.47 GEVGVSPEXTENDEDIDMODE ................................................................................. 233
12.2.48 GEVCCP .................................................................................................................... 233
12.2.49 GEVPRIMARYAPPLICATIONSOCKET ..........................................................................234
12.2.50 GEVPRIMARYAPPLICATIONIPADDRESS .................................................................... 234
12.2.51 GEVMCPHOSTPORT .................................................................................................235
12.2.52 GEVMCDA ............................................................................................................... 235
12.2.53 GEVMCTT ................................................................................................................ 235
12.2.54 GEVMCRC ................................................................................................................ 236
12.2.55 GEVMCSP................................................................................................................. 236
12.2.56 GEVSTREAMCHANNELSELECTOR .............................................................................. 237
12.2.57 GEVSCCFGPACKETRESENDDESTINATION ...............................................................237
12.2.58 GEVSCCFGALLINTRANSMISSION ............................................................................ 237
12.2.59 GEVSCCFGUNCONDITIONALSTREAMING .................................................................238
12.2.60 GEVSCCFGEXTENDEDCHUNKDATA ........................................................................ 238
12.2.61 GEVSCPDIRECTION...................................................................................................239
12.2.62 GEVSCPINTERFACEINDEX ........................................................................................ 239
12.2.63 GEVSCPHOSTPORT ...................................................................................................239
12.2.64 GEVSCPSFIRETESTPACKET ...................................................................................... 240
12.2.65 GEVSCPSDONOTFRAGMENT .................................................................................... 240
12.2.66 GEVSCPSBIGENDIAN ............................................................................................... 241
12.2.67 GEVSCPSPACKETSIZE .............................................................................................. 241
12.2.68 GEVSCPD ................................................................................................................. 242
12.2.69 GEVSCDA................................................................................................................. 242
12.2.70 GEVSCSP .................................................................................................................. 243
12.2.71 GEVSCZONECOUNT .................................................................................................. 243
12.2.72 GEVSCZONEDIRECTIONALL .....................................................................................243
12.2.73 GEVSCZONECONFIGURATIONLOCK .......................................................................... 244
12.3 NETWORK STATISTICS FEATURES .............................................................................. 244
12.3.1 NETWORKSTATISTICS ................................................................................................ 244
12.3.2 OMACCONTROLFUNCTIONENTITY ........................................................................... 245
12.3.3 APAUSEMACCTRLFRAMESTRANSMITTED .............................................................. 245
12.3.4 APAUSEMACCTRLFRAMESRECEIVED .................................................................... 246
12.4 CAMERA LINK FEATURES ...........................................................................................246
12.4.1 CAMERALINK ............................................................................................................ 246
12.4.2 CLCONFIGURATION ................................................................................................... 246
12.4.3 CLTIMESLOTSCOUNT ................................................................................................ 247
12.5 COAXPRESS FEATURES .............................................................................................. 248
12.5.1 COAXPRESS .............................................................................................................. 248
12.5.2 CXPLINKCONFIGURATIONSTATUS .............................................................................249
12.5.3 CXPLINKCONFIGURATIONPREFERRED.......................................................................250
12.5.4 CXPLINKCONFIGURATION .........................................................................................251
12.5.5 CXPCONNECTIONSELECTOR ...................................................................................... 252
12.5.6 CXPCONNECTIONTESTMODE .................................................................................... 253
2012-10-25 Page 9 of 366
12.5.7 CXPCONNECTIONTESTERRORCOUNT ........................................................................ 253

12.5.8 CXPCONNECTIONTESTPACKETCOUNT ......................................................................254
12.5.9 CXPPOCXPAUTO .......................................................................................................254
12.5.10 CXPPOCXPTURNOFF ................................................................................................. 255
12.5.11 CXPPOCXPTRIPRESET ...............................................................................................255
12.5.12 CXPPOCXPSTATUS .................................................................................................... 256
13 USER SET CONTROL .................................................................................................... 257
13.1 USERSETCONTROL .................................................................................................... 257

13.2 USERSETSELECTOR ...................................................................................................257
13.3 USERSETLOAD .......................................................................................................... 258
13.4 USERSETSAVE ...........................................................................................................258
13.5 USERSETDEFAULT.....................................................................................................258
13.6 USERSETDEFAULTSELECTOR (DEPRECATED) ........................................................... 259
14 CHUNK DATA CONTROL ............................................................................................ 261
14.1 CHUNKDATACONTROL .............................................................................................. 261

14.2 CHUNKMODEACTIVE ................................................................................................ 262
14.3 CHUNKSELECTOR ......................................................................................................262
14.4 CHUNKENABLE.......................................................................................................... 263
14.5 CHUNKIMAGE ............................................................................................................ 263
14.6 CHUNKOFFSETX ........................................................................................................ 264
14.7 CHUNKOFFSETY ........................................................................................................ 264
14.8 CHUNKWIDTH ........................................................................................................... 265
14.9 CHUNKHEIGHT .......................................................................................................... 265
14.10 CHUNKPIXELFORMAT ...............................................................................................265
14.11 CHUNKPIXELDYNAMICRANGEMIN ...........................................................................272
14.12 CHUNKPIXELDYNAMICRANGEMAX .......................................................................... 272
14.13 CHUNKTIMESTAMP .................................................................................................... 273
14.14 CHUNKLINESTATUSALL ............................................................................................ 273
14.15 CHUNKCOUNTERSELECTOR.......................................................................................274
14.16 CHUNKCOUNTERVALUE ............................................................................................ 274
14.17 CHUNKTIMERSELECTOR ............................................................................................ 275
14.18 CHUNKTIMERVALUE .................................................................................................275
14.19 CHUNKEXPOSURETIME .............................................................................................276
14.20 CHUNKGAINSELECTOR .............................................................................................. 276
14.21 CHUNKGAIN .............................................................................................................. 278
14.22 CHUNKBLACKLEVELSELECTOR ................................................................................ 278
14.23 CHUNKBLACKLEVEL .................................................................................................279
14.24 CHUNKLINEPITCH ..................................................................................................... 280
14.25 CHUNKFRAMEID ....................................................................................................... 280
14.26 CHUNKSOURCEID .....................................................................................................280
14.27 CHUNKREGIONID ...................................................................................................... 281
14.28 CHUNKTRANSFERBLOCKID ...................................................................................... 282
2012-10-25 Page 10 of 366

14.29 CHUNKTRANSFERSTREAMID .................................................................................... 282

14.30 CHUNKTRANSFERQUEUECURRENTBLOCKCOUNT .................................................... 283
14.31 CHUNKSTREAMCHANNELID .....................................................................................283
15 FILE ACCESS CONTROL ............................................................................................. 284
15.1 FILEACCESSCONTROL ............................................................................................... 287

15.2 FILESELECTOR ...........................................................................................................287
15.3 FILEOPERATIONSELECTOR ........................................................................................ 288
15.4 FILEOPERATIONEXECUTE .......................................................................................... 289
15.5 FILEOPENMODE ........................................................................................................ 289
15.6 FILEACCESSBUFFER .................................................................................................. 290
15.7 FILEACCESSOFFSET...................................................................................................290
15.8 FILEACCESSLENGTH.................................................................................................. 291
15.9 FILEOPERATIONSTATUS ............................................................................................ 291
15.10 FILEOPERATIONRESULT ............................................................................................ 292
15.11 FILESIZE ....................................................................................................................292
16 COLOR TRANSFORMATION CONTROL ................................................................ 294
16.1 COLORTRANSFORMATIONCONTROL .......................................................................... 295

16.2 COLORTRANSFORMATIONSELECTOR ......................................................................... 295
16.3 COLORTRANSFORMATIONENABLE ............................................................................ 296
16.4 COLORTRANSFORMATIONVALUESELECTOR.............................................................. 296
16.5 COLORTRANSFORMATIONVALUE .............................................................................. 297
17 ACTION CONTROL ....................................................................................................... 299
17.1 ACTIONCONTROL ...................................................................................................... 299

17.2 ACTIONUNCONDITIONALMODE .................................................................................299
17.3 ACTIONDEVICEKEY...................................................................................................300
17.4 ACTIONQUEUESIZE ................................................................................................... 300
17.5 ACTIONSELECTOR ..................................................................................................... 301
17.6 ACTIONGROUPMASK.................................................................................................301
17.7 ACTIONGROUPKEY ...................................................................................................302
18 SOURCE CONTROL ...................................................................................................... 303
18.1 SOURCES CONTROL MODEL WITH MULTI-REGIONS AND TRANSFER .......................... 303
18.2 SOURCE CONTROL FEATURES .................................................................................... 307
18.3 SOURCECONTROL ...................................................................................................... 308
18.4 SOURCECOUNT .......................................................................................................... 309
18.5 SOURCESELECTOR .....................................................................................................309
19 TRANSFER CONTROL ................................................................................................. 311
19.1 TRANSFER CONTROL MODEL.....................................................................................312

2012-10-25 Page 11 of 366
19.1 TRANSFER CONTROL FEATURES .................................................................................315

19.2 TRANSFERCONTROL .................................................................................................. 315
19.3 TRANSFERSELECTOR ................................................................................................. 315
19.4 TRANSFERCONTROLMODE ........................................................................................316
19.5 TRANSFEROPERATIONMODE ..................................................................................... 317
19.6 TRANSFERBLOCKCOUNT ...........................................................................................317
19.7 TRANSFERBURSTCOUNT ...........................................................................................318
19.8 TRANSFERQUEUEMAXBLOCKCOUNT .......................................................................318
19.9 TRANSFERQUEUECURRENTBLOCKCOUNT ................................................................ 319
19.10 TRANSFERQUEUEMODE ............................................................................................ 319
19.11 TRANSFERSTART ....................................................................................................... 319
19.12 TRANSFERSTOP .........................................................................................................320
19.13 TRANSFERABORT ...................................................................................................... 320
19.14 TRANSFERPAUSE ....................................................................................................... 321
19.15 TRANSFERRESUME .................................................................................................... 321
19.16 TRANSFERTRIGGERSELECTOR ................................................................................... 322
19.17 TRANSFERTRIGGERMODE .........................................................................................322
19.18 TRANSFERTRIGGERSOURCE.......................................................................................323
19.19 TRANSFERTRIGGERACTIVATION ............................................................................... 324
19.20 TRANSFERSTATUSSELECTOR ..................................................................................... 325
19.21 TRANSFERSTATUS ..................................................................................................... 325
19.22 TRANSFERCOMPONENTSELECTOR .............................................................................326
19.23 TRANSFERSTREAMCHANNEL ..................................................................................... 326
20 TYPICAL STANDARD FEATURE USAGE EXAMPLES ......................................... 328
20.1 ACQUISITION AND TRIGGER EXAMPLES .....................................................................328

20.2 COUNTER AND TIMER EXAMPLES .............................................................................. 334
20.3 I/O EXAMPLES ...........................................................................................................337
20.4 ACTION SIGNAL EXAMPLES .......................................................................................338
21 ACKNOWLEDGEMENTS ............................................................................................. 339
22 TAP GEOMETRY APPENDIX ...................................................................................... 340
22.1 MOTIVATIONS ............................................................................................................ 340

22.2 IDENTIFYING THE GEOMETRICAL PROPERTIES ........................................................... 340
22.2.1 IMAGE GEOMETRICAL PROPERTIES ............................................................................340
22.2.1.1 RESTRICTIONS ...........................................................................................................341
22.2.1.2 TAP NAMING CONVENTION .......................................................................................341
22.2.1.3 TAP GEOMETRICAL PROPERTIES ................................................................................ 342
22.3 TAP GEOMETRY DRAWINGS ...................................................................................... 347
22.3.1 SINGLE TAP GEOMETRY ............................................................................................ 347
1X-1Y (area-scan)............................................................................................................... 347
1X (line-scan)...................................................................................................................... 347
22.3.2 DUAL TAP GEOMETRIES ............................................................................................ 348
2012-10-25 Page 12 of 366

1X2-1Y (area-scan)............................................................................................................. 348

1X2 (line-scan).................................................................................................................... 348
2X-1Y (area-scan)............................................................................................................... 349
2X (line-scan)...................................................................................................................... 349
2XE-1Y (area-scan) ............................................................................................................ 350
2XE (line-scan) ................................................................................................................... 350
2XM-1Y (area-scan) ........................................................................................................... 351
2XM (line-scan) .................................................................................................................. 351
1X-1Y2 (area-scan)............................................................................................................. 352
1X-2YE (area-scan) ............................................................................................................ 352
22.4 TRIPLE TAP GEOMETRIES .......................................................................................... 353
1X3-1Y (area-scan)............................................................................................................. 353
1X3 (line-scan).................................................................................................................... 353
3X-1Y (area-scan)............................................................................................................... 354
3X (line-scan)...................................................................................................................... 354
22.5 QUAD TAP GEOMETRIES ............................................................................................ 355
1X4-1Y (area-scan)............................................................................................................. 355
1X4 (line-scan).................................................................................................................... 355
4X-1Y (area-scan)............................................................................................................... 356
4X (line-scan)...................................................................................................................... 356
2X2-1Y (area-scan)............................................................................................................. 357
2X2 (line-scan).................................................................................................................... 357
2X2E-1Y (area-scan) .......................................................................................................... 358
2X2E (line-scan) ................................................................................................................. 358
2X2M-1Y (area-scan) ......................................................................................................... 359
2X2M (line-scan) ................................................................................................................ 359
1X2-2YE (area-scan) .......................................................................................................... 360
2X-2YE (area-scan) ............................................................................................................ 361
2XE-2YE (area-scan) .......................................................................................................... 362
2XM-2YE (area-scan) ......................................................................................................... 363
22.6 OCTAL TAP GEOMETRIES...........................................................................................364
1X8-1Y (area-scan)............................................................................................................. 364
1X8 (line-scan).................................................................................................................... 364
8X-1Y (area-scan)............................................................................................................... 364
8X (line-scan)...................................................................................................................... 364
4X2-1Y (area-scan)............................................................................................................. 364
4X2 (line-scan).................................................................................................................... 364
2X2E-2YE (area-scan) ........................................................................................................ 365
22.7 DECA TAP GEOMETRIES ............................................................................................ 366
1X10-1Y (area-scan)........................................................................................................... 366
1X10 (line-scan).................................................................................................................. 366
10X-1Y (area-scan)............................................................................................................. 366
10X (line-scan).................................................................................................................... 366
2012-10-25 Page 13 of 366

Table of Figures
FIGURE 1-1 DEVICE COMMUNICATION MODEL ..................................................................................................................... 32
FIGURE 1-2: BASIC ACQUISITION DEVICE WITH FIXED CONFIGURATION. ............................................................................... 33
FIGURE 1-3: MULTI-SOURCE, MULTI-REGION ACQUISITION DEVICE WITH DATA STREAM TRANSFER CONTROL. .................... 34
FIGURE 4-1: IMAGE SIZE AND DEFINING A REGION OF INTEREST ........................................................................................... 88
FIGURE 5-1: ACQUISITION SIGNALS DEFINITION .................................................................................................................. 115
FIGURE 5-2: BURST SIGNALS DEFINITION ............................................................................................................................ 116
FIGURE 5-3: FRAME SIGNALS DEFINITION............................................................................................................................ 117
FIGURE 5-4: FRAME SIGNALS DEFINITIONS IN LINE SCAN MODE ......................................................................................... 118
FIGURE 5-5: CONTINUOUS ACQUISITION ............................................................................................................................. 120
FIGURE 5-6: CONTINUOUS ACQUISITION WITH ACQUISITIONSTART TRIGGER ..................................................................... 120
FIGURE 5-7: CONTINUOUS ACQUISITION WITH FRAMESTART TRIGGER ............................................................................... 122
FIGURE 5-8: CONTINUOUS ACQUISITION WITH FRAMEBURSTSTART TRIGGER .................................................................... 123
FIGURE 5-9: MULTIFRAME ACQUISITION ............................................................................................................................ 124
FIGURE 5-10: MULTI FRAME ACQUISITION WITH ACQUISITIONSTART TRIGGER ................................................................. 125
FIGURE 5-11: MULTI FRAME ACQUISITION WITH FRAMESTART TRIGGER ........................................................................... 126
FIGURE 5-12: MULTI FRAME ACQUISITION WITH FRAMEBURSTSTART TRIGGER ................................................................ 127
FIGURE 5-13: SINGLE FRAME ACQUISITION ........................................................................................................................ 128
FIGURE 5-14: SINGLE FRAME ACQUISITION WITH ACQUISITIONSTART TRIGGER ................................................................ 129
FIGURE 5-15: SINGLE FRAME ACQUISITION WITH FRAMESTART TRIGGER .......................................................................... 130
FIGURE 5-16: TRIGGER GENERATION FUNCTIONAL MODEL. ................................................................................................ 139
FIGURE 6-1: I/O CONTROL .................................................................................................................................................. 150
FIGURE 9-1: GAIN ALL PRE AMPLIFICATION ........................................................................................................................ 191
FIGURE 9-2: GAIN ALL POST AMPLIFICATION ...................................................................................................................... 192
FIGURE 14-1: FRAME WITH CHUNKS DISABLED ................................................................................................................... 261
FIGURE 14-2: FRAME WITH CHUNKS ENABLED .................................................................................................................. 261
FIGURE 15-1: FILE ACCESS MODEL..................................................................................................................................... 284
FIGURE 15-2: LAYOUT OF FILE ACCESS BUFFER. ................................................................................................................ 286
FIGURE 18-1: MULTI-SOURCE MULTI-REGION DEVICE WITH DATA STREAM TRANSFER CONTROL...................................... 305
FIGURE 19-1: ACQUISITION AND TRANSFER DATA FLOW. ................................................................................................... 312
FIGURE 19-2: TRANSFER CONTROL SECTION. ...................................................................................................................... 313
FIGURE 19-3: TRANSFER CONTROL STATE. .......................................................................................................................... 314
FIGURE 23-1 GEOMETRY 1X-1Y (AREA-SCAN) ................................................................................................................... 347
FIGURE 23-2 GEOMETRY 1X (LINE-SCAN) ........................................................................................................................... 347
FIGURE 23-3 GEOMETRY 1X2-1Y (AREA-SCAN) ................................................................................................................. 348
FIGURE 23-4 GEOMETRY 1X2 (LINE-SCAN) ......................................................................................................................... 348
FIGURE 23-5 GEOMETRY 2X-1Y (AREA-SCAN) ................................................................................................................... 349
FIGURE 23-6 GEOMETRY 2X (LINE-SCAN) ........................................................................................................................... 349
FIGURE 23-7 GEOMETRY 2XE-1Y (AREA-SCAN) ................................................................................................................. 350
FIGURE 23-8 GEOMETRY 2XE (LINE-SCAN) ........................................................................................................................ 350
FIGURE 23-9 GEOMETRY 2XM-1Y (AREA-SCAN) ................................................................................................................ 351
FIGURE 23-10 GEOMETRY 2XM (LINE-SCAN) ..................................................................................................................... 351
FIGURE 23-11 GEOMETRY 1X-1Y2 (AREA-SCAN) ............................................................................................................... 352
FIGURE 23-12 GEOMETRY 1X-2YE (AREA-SCAN) ............................................................................................................... 352
FIGURE 23-13 GEOMETRY 1X3-1Y (AREA-SCAN) ............................................................................................................... 353
FIGURE 23-14 GEOMETRY 1X3 (LINE-SCAN) ....................................................................................................................... 353
FIGURE 23-19 GEOMETRY 4X-1Y (AREA-SCAN) ................................................................................................................. 356
FIGURE 23-20 GEOMETRY 4X (LINE-SCAN) ......................................................................................................................... 356
2012-10-25 Page 14 of 366
FIGURE 23-23 GEOMETRY 2X2E-1Y (AREA-SCAN) ............................................................................................................. 358

FIGURE 23-24 GEOMETRY 2X2E (LINE-SCAN) .................................................................................................................... 358
FIGURE 23-25 GEOMETRY 2X2M-1Y (AREA-SCAN) ............................................................................................................ 359
FIGURE 23-26 GEOMETRY 2X2M (LINE-SCAN) ................................................................................................................... 359
FIGURE 23-27 GEOMETRY 1X2-2YE (AREA-SCAN) ............................................................................................................. 360
FIGURE 23-28 GEOMETRY 1X2-2YE (AREA-SCAN) ............................................................................................................. 361
FIGURE 23-29 GEOMETRY 2XE-2YE (AREA-SCAN) ............................................................................................................ 362
FIGURE 23-30 GEOMETRY 2XM-2YE (AREA-SCAN) ........................................................................................................... 363
FIGURE 23-31 GEOMETRY 2X2E-2YE (AREA-SCAN) .......................................................................................................... 365
2012-10-25 Page 15 of 366

History
Version Date Changed by Change
0.01 14.02.2006 Eric Carey, DALSA Initial version based on the GenICam
Coreco standard feature list document of the GigE
Vision/GenICam joint sub-committee. This
version is intended to be the official feature
naming convention to be used for GigE
Vision cameras.
Original contributors:
Basler (Fritz Dierks, Thies Moeller,
Andreas Gäer),
Leutron Vision (Jan Becvar),
DALSA Coreco (Eric Carey),
Euresys (Jean-Michel Wintgens),
MVTec (Christoph Zierl),
National Instruments (Chris Graf),
Stemmer (Sascha Dorenbeck),
SICKIVP (Mattias Johannesson),
JAI (Ole Krogh Jørgensen),
Matrox (Stephane Maurice)
0.02 16.03.2006 Stephane Maurice, Matrox Define the new Acquisition, Trigger and
I/O feature set.
Introduced the notion of counters and
grouped it with Timers in a separate
chapter.
Reviewed feature names for consistency
and grouping.
draft 04.04.2006 Stephane Maurice, Matrox Included modifications and corrections
1.00 based on the feedbacks from version 0.02 to
0.9.
Final Draft.
2012-10-25 Page 16 of 366


draft 06.06.2006 Stephane Maurice, Matrox Changed PixelSize to Bpp8, Bpp10, …
1.00.01 Removed all “_” in enumerations and all
feature names.
draft 22.06.2006 Stephane Maurice, Matrox Changed Software Trigger from
1.00.02 TriggerMode to TriggerSource to permit
1394 DCAM feature compatibility.
Removed ticks as standard unit for Raw
time unit.
Added AnyEdge as standard signal
activation and event type.
Added Line0 and UserOutput0 as standard
optional names for enumeration.
Added AcquisitionFrameRateRaw and
AcquisitionLineRateRaw.
Defined standard Event numbers that
matches the GigEvision Event numbers.
draft 16.06.2007 Vincent Rowley, Pleora Prepared Version 1.0.
1.00.03 Technologies Inc. Removed the AIA logo.
Fixed typos.
Added a note with respect to how the
GevMACAddress feature should be
implemented.
Added a note specifying that the
GevCurrentIPConfiguration feature should
not be used in production GenICam XML
files since it will be deprecated in the next
version of the present document.
Fixed GevTimestampTickFrequency valid
range.
2012-10-25 Page 17 of 366


draft 19.06.2007 Stephane Maurice, Matrox Preparation for Version 1.0 continued:
1.00.03 Added a note about the Selector usage
cont. specifying that they must not introduce side
effect when their value is changed.
Removed GiGEVision logo since the
Standard Feature List is now part of the
GenICam standard.
Specified that features with big value such
as GevMACAddress,
GEVTimestampTickFrequency and
GEVTimestampValue must be returned as a
single 64 bit values.
Release 20.06.2007 Stephane Maurice, Matrox Final release Version 1.00
1.00.00 Note: This release includes all the features
as they were defined in the draft 1.00.02
referenced in the final GigE Vision
specification version 1.00.
Version 04.07.2007 Vincent Rowley, Pleora Added SensorTaps,
1.01.01 Technologies Inc. SensorDigitizationTaps,
GevCurrentIPConfigurationLLA,
GevCurrentIPConfigurationDHCP,
GevCurrentIPConfigurationPersistentIP and
GevIPConfigurationStatus features.
Deprecated GevCurrentIPConfiguration.
Added OpenAccess to the list of valid
values for the GevCCP feature.
Version 24.07.2007 Stephane Maurice Matrox Added the PixelFormat description chapter
1.01.02 and note about zero based user bits.
Release 2.10.2007 Stephane Maurice, Matrox Final release Version 1.1
1.1
2012-10-25 Page 18 of 366


Version 10.09.2007 Thies Möller, Basler Created chapter for File Access.
1.1.01
Version 12.01.2008 Stephane Maurice, Matrox Review and modification to the File Access
1.1.02 features proposal.
Vincent Rowley , Pleora
Release 29.04.2008 Stephane Maurice, Matrox SFNC 1.2 including the File Access
1.2 features and corrections. Also removed the
PixelFormat description chapter and GEV
event numbers.
Version 17.07.2008 Karsten Ingeman Merged with recommended visibility
1.2.01 Christensen, JAI proposal from JAI and commented by
Vincent Rowley, Pleora
Release 19.08.2008 Stephane Maurice, Matrox SFNC 1.2.1 including the recommended
1.2.1 visibility.
Version 28.10.2008 Stephane Maurice, Matrox Matrox: Created draft for 1.3 including:
1.2.12 minors corrections, deprecated Raw and
Thies Möller, Basler
Abs feature and deprecated GigEVision
Event, Changed chapters names and
created according category features, added
Root, Device, TLParamsLocked,
PixelClock, Temperature features and made
ICommand optionally readable, …
Basler: Action command was added.
Version 05.05.2009 Stephane Maurice, Matrox Deprecated all the GEVSupported…
1.2.13 feature to regroup them in a selector.
Added Color Transformation features.
Action command reworked and moved in a
separate chapter. Added Event data
delivery features.
2012-10-25 Page 19 of 366


Version 20.05.2009 Stephane Maurice, Matrox Deprecated Line0RisingEdge, …compound
1.2.14 enumeration in CountersEventSource and
created separate CounterEventActivation
and CounterResetActivation features to be
consistent with the trigger features.
Made CounterValue and TimerValue
Writable.
Modified descriptions to be able to extract
tooltips and descriptions for the reference
SFNC XML.
Added a VBA macro to be able to generate
machine readable version of the SFNC.
Added a VBA macro to be able to generate
the Features summary (Chapter 2)
automatically.
Changed units to have a standard notation.
Release 11.08.2009 Stephane Maurice, Matrox SFNC 1.3 release including the changes
1.3 since version 1.2.1.
Draft 05.01.2009 Vincent Rowley, Pleora Added GigE Vision 1.2 support.
1.4a-c and Technologies Inc. Added missing Bpp36 and Bpp48
22.01.2010 enumeration entries for PixelSize feature.
Added missing RawPacked enumeration
entry for PixelCoding feature.
Updated support level for
GevSCPInterfaceIndex feature in order to
be consistent with related features.
Clarified text when necessary and fixed
typos.
Corrected some feature descriptions.
2012-10-25 Page 20 of 366


Release 17.03.2010 Stephane Maurice, Matrox Minor fixes to remove mistakes.
1.4 YUV422YUYVPacked was removed,
changed all the ExposureTimeAuto to
ExposureAuto.
Corrected GevGVCPPendingAck and
GevManifestSecondaryURL names.
Added ChunkTimer and ChunkCounter to
ChunkSelector.
Updated VB macros.
Release 22.11.2010 Stephane Maurice, Matrox - Added Camera Link related features.
1.5 - ActionSelector now >0.
- Added Bpp30 to PixelSize.
-Added RGB16Packed, BGR16Packed,
BGR10V1Packed and BGR10V2Packed to
pixel Format.
- DeviceUserID is now recommended to
be an empty string.
- GenICam Access chapter added.
- DeviceSFNCVersion… features added.
- Clarified and corrected points in
Counter and Timer chapter.
- Added new TimerReset feature and
removed LevelHigh and LevelLow in
CounterEventActivation of
Counter and Timer chapter.
- Updated Chunk chapter to correct
inconsistencies and add missing items.
- Minor fixes to remove mistakes.
- Updated VB macros to extract the
description of the enumerations and fix
other minor parsing issues.
2012-10-25 Page 21 of 366


Release 20.09.2011 Stephane Maurice, Matrox - Added FrameBurst triggers functionality
1.5.1 and their associated features.
- Corrected signal names in the figures of
the Acquisition control chapter.
- Added acquisition timing diagrams in the
Acquisition control chapter to
illustrate the typical acquisition cases.
- Removed and changed some GigE Vision
mentions that were too standard specific
to accommodate other TL standards.
- UserOutputValueAll now mentions that
UserOutput0 maps to the Lsb of the
register instead of saying Bit 0.
- AcquisitionStart is now (Read)/Write
instead of Read/Write.
- Added Timestamp features.
- Added clarifications for Width,
WidthMax, Height, and HeightMax.
- Added clarifications for the usage of the
All enumeration of GainSelector,
BlackLevelSelector and
WhiteClipSelector.
- Replaced AOI per ROI to better match
other standands nomenclature.
- Made DeviceTapGeometry less Camera
Link specific.
- Added a note for ExposureTime that the
feature is inactive if ExposureAuto is On.
- Added a note for AcquisitionLineRate
that the feature is inactive if TriggerMode
is On.
- Minor corrections from 1.5.
2012-10-25 Page 22 of 366


Draft 1 23.12.2011 Stephane Maurice, Matrox - Moved the document to Word .Docm
1.5.2 format (.Docx with macro).
- Removed and changed some GigE
Vision references that were too
standard specific to accommodate other
TL standards.
- Generalized many GEV features that
are now in Device Control chapter to be
usable by other TL.
- Added DeviceLinkThroughputLimit
features.
- Updated the PixelFormat and
ChunkPixelFormat features and the
corresponding text according to the new
Pixel Format Naming Convention of
the AIA.
- Added a standard definitions table and
figure.
Draft 2 23.01.2012 Vincent Rowley, Pleora - Added GigE Vision 2.0 support.
1.5.2 Technologies Inc. o Added ActionLate event.
o Added support for link
aggregation.
o Added support for PAUSE
frames.
o Added support for extended and
standard IDs modes.
o Added support for IEEE 1588.
o Added support for unconditional
and scheduled action
commands.
o Added support for extended
status codes introduced by GigE
Vision 2.0.
o Added multi-zone support.
o Added support for alternate
packet resend destination
option.
o Added support for All-in
Transmission mode.
- Added PrimaryApplicationSwitch and
LinkSpeedChange events.
- Added support for 10-tap geometries.
2012-10-25 Page 23 of 366


Release 25.10.2012 Stephane Maurice, Matrox - Include all items from 1.5.2 Drafts
2.0 - Changed all the Mandatory features that
were not GenICam related to
Recommended to let each TL standards
define this.
- Replaced "Recommended Visibility" by
"Visibility" only.
- Added notes to mention that Visibility
and Category are recommended.
- Deprecated PixelCoding.
- Deprecated DeviceID and replaced it
with DeviceSerialNumber.
- Deprecated TestImageSelector and
replaced it with TestPattern.
- Deprecated UserSetDefaultSelector and
replaced it with UserSetDefault.
- Removed all the features and
enumerations that were deprecated
before this major version of the SFNC.
- Added the Device Communication and
Device Acquisition Model section.
- Added the multiple Region (ROI)
handling features (RegionSelector, ...)
to the ImageFormat Control chapter.
- Added the multiple Source handling
features (SourceSelector, ...).
- Added the Stream Transfer handling
features (TransferSelector, ...).
- Added a note for a possible optional
DeviceStreamChannelSelector for
PayloadSize .
- Updated the Selector description
section.
2012-10-25 Page 24 of 366


Release 25.10.2012 Stephane Maurice, Matrox - Added option to have 0 based Timers,
2.0 Counters, Actions, Sources, Streams,…
(cont.)
- Added the CoaXPress transport layer
specific features.
- Added the Deinterlacing feature.
- Added the Image Compression features.
- Added DeviceIndicatorMode feature.
- GenICam Access chapter was renamed
GenICam Control.
- Updated the VB macro.
2012-10-25 Page 25 of 366

1 Introduction
The GenICam technology allows exposing arbitrary features of a camera through a unified API
and GUI. Each feature can be defined in an abstract manner by its name, interface type, unit of
measurement and behavior. The GenApi module of the GenICam standard defines how to write a
camera description file that describes the features of a device
The usage of GenApi alone could be sufficient to make all the features of a camera or a device
accessible through the GenICam API. However if the user wants to write generic and portable
software for a whole class of cameras or devices and be interoperable, then GenApi alone is not
sufficient and the software and the device vendors have to agree on a common naming
convention for the standard features. This is the role of the GenICam "Standard Features Naming
Convention (SFNC)" to provide this common set of features, their name, and to define a standard
behavior for them.
The Standard Features Naming Convention of GenICam is targeting maximum usability by
existing and future transport layer technologies. It provides the definitions of a standard
behavioral model and of standard features. The goal is to cover and to standardize the naming
convention used in all the basic use cases where the implementation by different vendors would
be very similar anyway.
Note that to be GenICam compliant a product:
- Must provide or accept a GenICam XML file compatible with the latest GenApi and schema.
- The GenICam XML file must include all the public features of the product it describes.
- The GenICam XML must follow the Standard Features Naming Convention whenever
applicable or possible for its features.
Those requirements ensure that the users can rely on a complete, consistent and portable feature
set for its device and that those features are always accessible in a standard way.
2012-10-25 Page 26 of 366

1.1 Conventions
Feature Name and Interface

According to the GenICam standard, all the public features of a device must be included in the
GenICam XML file and must use the SFNC Name and Interface type for those features if they
exist. Other vendor specifc or specialized features not mapping to existing SNFC features can be
included but must be located in a vendor specific namespace in the GenICam XML and may use
a vendor specific name.
This document lists for each feature, the Name and Interface type that must be used.
Feature Category
With the GenICam standard, each feature should be included in a "Category". The Category
element defines in which group of features, the feature will be located.
The Category does not affect the functionality of the features but is used by the GUIs to group
the features when displaying them. The purpose is mainly to insure that the GUI can present
features in a more organized way.
This document lists for each feature, a recommended Category that should be used.
Feature Level
In this document, features are tagged according to the following requirement levels:
 M: Mandatory - Must be implemented to achieve compliance with the GenICam
standard.
 R: Recommended - This feature adds important aspects to the use case and must respect
the naming convention if used.
 O: Optional - This feature is less critical. Nevertheless, it is considered and must respect
the naming convention if used.
For additional details about the mandatory features specific to a particular transport layers,
please refer to the text of those standards.
Feature Visibility
According to the GenICam standard each feature can be assigned a "Visibility". The Visibility
defines the type of user that should get access to the feature. Possible values are: Beginner,
Expert, Guru and Invisible. The latter is required to make features accessible from the API, but
invisible in the GUI.
The visibility does not affect the functionality of the features but is used by the GUI to decide
which features to display based on the current user level. The purpose is mainly to insure that the
GUI is not cluttered with information that is not intended at the current user level.
2012-10-25 Page 27 of 366

The following criteria have been used for the assignment of the recommended visibility:
 B: Beginner - Features that should be visible for all users via the GUI and API. This is
the default visibility in the GenICam XMLfiles and will be used if the Visibility element
is omitted for a feature. The number of features with "Beginner" visibility should be
limited to all basic features of the devices so the GUI display is well-organized and is
easy to use.
 E: Expert - Features that require a more in-depth knowledge of the camera functionality.
This is the preferred visibility level for all advanced features in the cameras.
 G: Guru – Advanced features that might bring the cameras into a state where it will not
work properly anymore if it is set incorrectly for the cameras current mode of operation.
 I: Invisible – Features that should be kept hidden for the GUI users but still be available
via the API.
This document lists for each feature, a recommended Visibility that should be used.
Selector
A selector is used to index which instance of the feature is accessed in situations where multiple
instances of a feature exist (For instance, the analog gain for each separate channel of the
red/green/blue component of a color camera).
A selector is a separate feature that is typically an IEnumeration or an IInteger. Selectors must be
used only to select the target features for subsequent changes. It is not allowed to change the
behavior of a device in response to a change of a selector value.
If a selector has only one possible value, the selector relation can be omitted but it is recommended to
leave the selector feature as read only for information purpose (Ex: TriggerSelector = FrameStart
(read only) for a device that has only this trigger type supported).
In this document, the features potentially dependent on a selector are expressed using the C
language convention for arrays: a pair of brackets follows the feature name, like in
SelectedFeature[Selector]. When the Selector is not present, one must deduce the feature is not
an array.
In general, a selector should apply only to a single category of feature (Ex: TriggerSelector applies
only to the Trigger related features). However, it is possible that certain more advanced devices will
require a selector that applies to features in different categories. For example a device with 2
independent input sensors could have a SourceSelector feature that would select features in the Image
Format Control, Acquisition Control, Analog Control, LUT Control and Color Transformation
Control categories in order to globally control all the features associated with a particular source (Ex":
SourceSelector = Source1, PixelFormat[SourceSelector] = Mono8, Gain[SourceSelector] = 10,
AcquisitionStart[SourceSelector]).
Note also that when a feature that has a selector is persisted to a file, the selector is iterated to allow
saving the complete array of values and not only the currently selected element.
2012-10-25 Page 28 of 366

1.2 Standard Units
The following abbreviations are used as standard units for features described in this document.
Note that all units are using plain ASCII characters.
ns nanoseconds
us microseconds
ms milliseconds
s seconds
B Bytes
Bps Bytes per second
MBps Mega Bytes per second
Mbps Mega bits per second
Fps Frames per second
dB decibels
C Celsius
Hz Hertz
2012-10-25 Page 29 of 366

1.3 Acronyms
The following definitions are used in this document.
ADC Analog to Digital Converter

AGC Automatic Gain Control
AIA Automated Imaging Association
CRT Cathode Ray Tube
DC Direct Current
DHCP Dynamic Host Configuration Protocol
EMVA European Machine Vision Association
ID Identifier
I/O Input/Output
IP Internet Protocol
LLA Link-Local Address
LUT Look-Up Table
M Mandatory
O Optional
R Recommended or Read (depends on the context)
ROI Region Of Interest
URL Uniform Resource Locator
W Write
XML eXtensible Markup Language
2012-10-25 Page 30 of 366

1.4 Standard Definitions
This section defines the terms used in this document. An illustration of their inter-relation is provided
in the Device Communication Model section below (see Figure 1-1).
Entity An Entity is an end point located at either side (Host or Device) of a Communication.
Host System The Host System is the Entity which takes control over a Device. A Host System can
be the sink or the source for the data being streamed.
Under GenICam the Host System must read and use the GenICam compliant XML
file of the Device to control it.
Device The Device is an Entity which is controlled by a Host System. A Device can be the
source or the sink for streaming data. It can be remote (outside the Host System) or
local (in the Host System).
Under GenICam the Device must provide a GenICam compliant XML file and a
register-based control access.
Link A Link is the virtual binding between a Host System and a Device to establish a
Communication. A Link is logical and may use one or more physical Connections.
Connection A Connection is the physical binding between a Host System and a Device.
Interface A virtual end point of the Link between a Device and a Host System.
Adapter A physical entity located in the Host System that has one or many Interfaces.
Communication A Communication is an exchange of information between two Entities using a Link.
Channel A logical point-to-point Communication over a Link. There may be multiple
Channels on a single Link.
Transport Layer The layer of Communication responsible to transport information between Entities.
Transmitter An Entity which acts as the source for streaming data. This may apply to a Host
System or a Device.
Receiver An Entity which acts as the sink for streaming data. This may apply to a Host System
or a Device.
Transceiver An Entity which can receive and transmit streaming data. This may apply to a Host
System or a Device.
Peripheral An Entity which neither acts as a source nor as a sink for streaming data but can be
controlled.
Stream A flow of data that comes from a source and goes to a sink. A data Stream can be
composed of images or chunk of data.
Stream Channel A Communication Channel used to transmit a data Stream from a Transmitter (or
Transceiver) to a Receiver (or Transceiver).
Message Channel A Communication Channel used by the Device to notify the Host System
asynchronously of Events. The Host System could also use a Message Channel to
communicate events to the Device.
Control Channel A Communication Channel used to configure and control a Device. For a Control
Channel the Device acts as a server that provides the initial point of Communication
for the Host System that acts as a Client. The Communication on a Control Channel
2012-10-25 Page 31 of 366

is bidirectional and initiated by the Host System.

Event An asynchronous notification of the occurrence of a fact. Events are transmitted on a
Message Channel.
1.5 Device Communication Model

This section presents the general communication model for the devices controlled using the SFNC. It
presents the main elements involved in the communication for control and data streaming between the
Host System and the acquisition Device.
Figure 1-1 Device Communication Model
Remote Transmitter Virtual Interface 1 Host System

Device 1
Device 1 Link Chunk Adapters
C1
Event
XML Control Image
Remote Transmitter
Device 2
Device 2
Link Device 1
Switch
C1 I1
I2 Device 2
XML
Remote Transmitter I3 Device 3

Device 3 Link
Dev ice 3
C1
C2
Data Stream(s) XML Virtual Interface 3
Virtual Links Data Stream(s) Local Virtual

Receiver Devices
Physical Connections
In general, the Device Communication model is:
The remote Device and the Host System communicate using a virtual Link.
The virtual Link is established on an Interface using one or more physical Connections.
The Host System controls the remote Device using the features present in its GenICam XML file.
The remote Transmitter Device has a data Source that generates a data Stream.
The data Stream is sent to the Host System on a Stream Channel of the virtual Link.
The reception of the data Stream on a Host Interface is handled by a local receiver Device.
The local receiver Device writes the data Stream to the Host System memory.
See section 1.4 Standard Definitions section above for more detailed information.
2012-10-25 Page 32 of 366

1.6 Device Acquisition Model
This section presents the general data acquisition model for the devices controlled using the SFNC. It
presents the main elements involved in the data acquisition by a Device and the typical data flow for
transfer of images to the Host System. It covers the typical devices with a single data source and the
more complex devices with multi-source, multi-region of interest and data transfer control.
Basic acquisition Devices with one source of data, one region of interest and automatic control of the
transfer of data such as the one shown in Figure 1-2, are simple particular case of this model where the
Source, Region and Transfer features are fixed and cannot be changed (so the corresponding fixed
features can be omitted).
Region of interest Transfer Control Stream

Source Stream Automatically sent to Link
Width and Height Stream Channel
features
Device
Figure 1-2: Basic acquisition device with fixed configuration.
The typical features setting for such a basic device where the values of Source, Region and Transfer
Control Stream are fixed is typically reduced to:
Width = 320
Height = 240
AcquisitionStart
…
AcquisitionStop
But in general, for more complex devices, the acquisition and data transfer model is:
A Device has one or many Source(s).
A Source has one or many Region(s) of interest.
A Region of interest goes to a data Stream.
The data generation by the Source is controlled by the "Acquisition Control" features.
The dimensions of a Region of interest are controlled by the "Image Format Control" features.
The outgoing data flow of a Stream is controlled by a "Transfer Control" features.
The Transfer Control module output the data Stream to a Stream Channel.
The Stream Channel is transmitted on a virtual Link.
The virtual Link is established with a Host System using one or many Device`s physical Connection(s).
2012-10-25 Page 33 of 366

Figure 1-3 below presents an example of a more complex device supporting multi-source, multi-region
with data stream transfer control.
Source1 Region1
Width and Height

features Transfer Control Stream0
Source1 Stream0 Sent to Stream
Channel 0
Source1 Region2
Width and Height

features
Source2 Region1 Transfer Control Stream1

Stream1 Sent to Stream Link
Width and Height Channel 1
features
Source2

Stream2 Sent to Stream
Width and Height
Channel 2
features
Device
Figure 1-3: Multi-source, multi-region acquisition device with data stream transfer control.
The typical feature setting model for such a complex multi-source device is presented in detail the
chapter 18 (Source Control). The features for the control of the regions of interest and image format
handling are documented in chapter 4 (Image Format Control) and Chapter 19 (Transfer Control)
presents the features to control the flow of data on the external link.
2012-10-25 Page 34 of 366

2 Features Summary
This chapter provides a comprehensive summary of the standard features covered by this document. The following chapters provide more
detailed explanation of each feature.
In case of discrepancy, the sections describing the features in detail prevail.
2.1 Device Control

Contains the features related to the device and its sensor.
Table 2-1: Device Control Summary
Name Level Interface Access Unit Visibility Description
DeviceControl R ICategory R - Category for device information and control.
DeviceType O IEnumeration R - Returns the device type.
DeviceScanType R IEnumeration R/(W) - Scan type of the sensor of the device.
DeviceVendorName R IString R - Name of the manufacturer of the device.
DeviceModelName R IString R - Model of the device.
DeviceFamilyName O IString R - Identifier of the product family of the device.
DeviceManufacturerInfo R IString R - Manufacturer information about the device.
DeviceVersion R IString R - Version of the device.
DeviceFirmwareVersion R IString R - Version of the firmware in the device.
DeviceSerialNumber R IString R - Device’s serial number.
DeviceID R IString R - This feature is deprecated (See DeviceSerialNumber).
DeviceUserID O IString R/W - User-programmable device identifier.
DeviceSFNCVersionMajor R IInteger R - Major version of the Standard Features Naming Convention that was
used to create the device`s GenICam XML.
2012-10-25 Page 35 of 366

DeviceSFNCVersionMinor R IInteger R - Minor version of the Standard Features Naming Convention that was
DeviceSFNCVersionSubMinor R IInteger R - Sub minor version of Standard Features Naming Convention that was
DeviceManifestEntrySelector O IInteger R/W - Selects the manifest entry to reference.
DeviceManifestXMLMajorVersion[Dev O IInteger R - Indicates the major version number of the GenICam XML file of the
iceManifestEntrySelector] selected manifest entry.
DeviceManifestXMLMinorVersion[Dev O IInteger R - Indicates the minor version number of the GenICam XML file of the
iceManifestEntrySelector] selected manifest entry.
DeviceManifestXMLSubMinorVersion[ O IInteger R - Indicates the subminor version number of the GenICam XML file of the
DeviceManifestEntrySelector] selected manifest entry.
DeviceManifestSchemaMajorVersion[D O IInteger R - Indicates the major version number of the schema file of the selected
eviceManifestEntrySelector] manifest entry.
DeviceManifestSchemaMinorVersion[D O IInteger R - Indicates the minor version number of the schema file of the selected
eviceManifestEntrySelector] manifest entry.
DeviceManifestPrimaryURL[DeviceMa O IString R - Indicates the first URL to the GenICam XML device description file of
nifestEntrySelector] the selected manifest entry.
DeviceManifestSecondaryURL[Device O IString R - Indicates the second URL to the GenICam XML device description file
ManifestEntrySelector] of the selected manifest entry.
DeviceTLType R IEnumeration R - Transport Layer type of the device.
DeviceTLVersionMajor R IInteger R - Major version of the Transport Layer of the device.
DeviceTLVersionMinor R IInteger R - Minor version of the Transport Layer of the device.
DeviceTLVersionSubMinor R IInteger R - Sub minor version of the Transport Layer of the device.
DeviceGenCpVersionMajor R IInteger R - Major version of the GenCP protocol supported by the device.
DeviceGenCPVersionMinor R IInteger R - Minor version of the GenCP protocol supported by the device.
DeviceMaxThroughput O IInteger R Bps Maximum bandwidth of the data that can be streamed out of the device.
DeviceConnectionSelector R IInteger R/(W) - Selects which Connection of the device to control.
2012-10-25 Page 36 of 366

DeviceConnectionSpeed[DeviceConnect O IInteger R Bps Indicates the speed of transmission of the specified Connection.
ionSelector]
DeviceConnectionStatus[DeviceConnect O IEnumeration R - Indicates the status of the specified Connection.
ionSelector]
DeviceLinkSelector R IInteger R/(W) - Selects which Link of the device to control.
DeviceLinkSpeed[DeviceLinkSelector] O IInteger R Bps Indicates the speed of transmission negotiated on the specified Link.
DeviceLinkThroughputLimitMode[Devi R IEnumeration R/W - Controls if the DeviceLinkThroughputLimit is active.
ceLinkSelector]
DeviceLinkThroughputLimit[DeviceLin R IInteger R/(W) Bps Limits the maximum bandwidth of the data that will be streamed out by
kSelector] the device on the selected Link.
DeviceLinkConnectionCount[DeviceLin O IInteger R - Returns the number of physical connection of the device used by a
kSelector] particular Link.
DeviceLinkHeartbeatMode[DeviceLink O IEnumeration R/W - Activate or deactivate the Link`s heartbeat.
Selector]
DeviceLinkHeartbeatTimeout[DeviceLi O IFloat R/W us Controls the current heartbeat timeout of the specific Link.
nkSelector]
DeviceCommandTimeout O IFloat R us Indicates the current command timeout of the specific Link.
[DeviceLinkSelector]
DeviceStreamChannelCount O IInteger R - Indicates the number of streaming channels supported by the device.
DeviceStreamChannelSelector O IInteger R/W - Selects the stream channel to control.
DeviceStreamChannelDirection[Device O IEnumeration R - Reports the direction of the stream channel.
StreamChannelSelector]
DeviceStreamChannelLink[DeviceStrea O IInteger R/(W) - Index of device`s Link to use for streaming the specifed stream channel.
mChannelSelector]
DeviceStreamChannelEndianness O IBoolean R/(W) - Endianess of multi-byte pixel data for this stream.
[DeviceStreamChannelSelector]
DeviceStreamChannelPacketSize R IInteger R/(W) B Specifies the stream packet size, in bytes, to send on the selected
[DeviceStreamChannelSelector] channel for a Transmitter or specifies the maximum packet size
2012-10-25 Page 37 of 366

supported by a receiver.
DeviceMessageChannelCount O IInteger R - Indicates the number of message channels supported by the specified
Link of the device.
DeviceCharacterSet O IEnumeration R - Character set used by the strings of the device`s bootstrap registers.
DeviceReset R ICommand W - Resets the device to its power up state.
DeviceIndicatorMode O IEnumeration R/W - Controls the behavior of the indicators (such as LEDs) showing the
status of the Device.
DeviceFeaturePersistenceStart O ICommand (R)/W - Indicate to the device and GenICam XML to get ready for persisting of
all streamable features.
DeviceFeaturePersistenceEnd O ICommand (R)/W - Indicate to the device the end of feature persistence.
DeviceRegistersStreamingStart R ICommand (R)/W - Prepare the device for registers streaming without checking for
consistency.
DeviceRegistersStreamingEnd R ICommand (R)/W - Announce the end of registers streaming.
DeviceRegistersCheck R ICommand (R)/W - Perform the validation of the current register set for consistency.
DeviceRegistersValid R IBoolean R - Returns if the current register set is valid and consistent.
DeviceTemperatureSelector O IEnumeration R/W - Selects the location within the device, where the temperature will be
measured.
DeviceTemperature[DeviceTemperature O IFloat R C Device temperature in degrees Celsius (C).
Selector]
DeviceClockSelector O IEnumeration R/(W) - Selects the clock frequency to access from the device.
DeviceClockFrequency[DeviceClockSel O IFloat R/(W) Hz Returns the frequency of the selected Clock.
ector]
DeviceSerialPortSelector R IEnumeration R/(W) - Selects which serial port of the device to control.
DeviceSerialPortBaudRate[DeviceSerial R IEnumeration R/(W) - This feature controls the baud rate used by the selected serial port.
PortSelector]
Timestamp R IInteger R ns Reports the current value of the device timestamp counter.
2012-10-25 Page 38 of 366

TimestampReset O ICommand (R)/W - Resets the current value of the device timestamp counter.
2.1 Image Format Control

Contains the features related to the format of the transmitted image.
Table 2-2: Image Format Control Summary
ImageFormatControl R ICategory R - Category for Image Format Control features.
SensorWidth R IInteger R - Effective width of the sensor in pixels.
SensorHeight R IInteger R - Effective height of the sensor in pixels.
SensorTaps O IEnumeration R/(W) - Number of taps of the camera sensor.
SensorDigitizationTaps O IEnumeration R/(W) - Number of digitized samples outputted simultaneously by the camera
A/D conversion stage.
WidthMax R IInteger R - Maximum width of the image (in pixels).
HeightMax R IInteger R - Maximum height of the image (in pixels).
RegionSelector O IEnumeration R/(W) - Selects the Region of interest to control.
RegionMode[RegionSelector] O IEnumeration R/W - Controls if the selected Region of interest is active and streaming.
RegionDestination[RegionSelector] O IEnumeration R/(W) - Control the destination of the selected region.
Width[RegionSelector] R IInteger R/(W) - Width of the image provided by the device (in pixels).
Height[RegionSelector] R IInteger R/(W) - Height of the image provided by the device (in pixels).
OffsetX[RegionSelector] R IInteger R/W - Horizontal offset from the origin to the region of interest (in pixels).
OffsetY[RegionSelector] R IInteger R/W - Vertical offset from the origin to the region of interest (in pixels).
LinePitch[RegionSelector] R IInteger R/W B Total number of bytes between 2 successive lines.
BinningSelector O IEnumeration R/(W) - Selects which binning engine is controlled by the BinningHorizontal
and BinningVertical features.
2012-10-25 Page 39 of 366

BinningHorizontal[BinningSelector] O IInteger R/W - Number of horizontal photo-sensitive cells to combine together.

BinningVertical[BinningSelector] O IInteger R/W - Number of vertical photo-sensitive cells to combine together.
DecimationHorizontal O IInteger R/W - Horizontal sub-sampling of the image.
DecimationVertical O IInteger R/W - Vertical sub-sampling of the image.
ReverseX R IBoolean R/W - Flip horizontally the image sent by the device.
ReverseY R IBoolean R/W - Flip vertically the image sent by the device.
PixelFormat R IEnumeration R/(W) - Format of the pixels provided by the device.
PixelCoding R IEnumeration R/(W) - This feature is deprecated.
PixelSize R IEnumeration R/(W) - Total size in bits of a pixel of the image.
PixelColorFilter R IEnumeration R/(W) - Type of color filter that is applied to the image.
PixelDynamicRangeMin O IInteger R/W - Minimum value that can be returned during the digitization process.
PixelDynamicRangeMax O IInteger R/W - Maximum value that will be returned during the digitization process.
TestPatternGeneratorSelector O IEnumeration R/(W) - Selects which test pattern generator is controlled by the TestPattern
feature.
TestPattern[TestPatternGeneratorSelecto O IEnumeration R/W - Selects the type of test pattern that is generated by the device as image
r] source.
TestImageSelector O IEnumeration R/W - This feature is deprecated (see TestPattern).
Deinterlacing O IEnumeration R/W - Controls how the device performs de-interlacing.
ImageCompressionMode O IEnumeration R/W - Enable a specific image compression mode as the base mode for image
transfer.
ImageCompressionRateOption O IEnumeration R/W - Two rate controlling options are offered: fixed bit rate or fixed quality.
ImageCompressionQuality O IInteger R/(W) - Control the quality of the produced compressed stream.
ImageCompressionBitrate O IFloat R/(W) Mbps Control the rate of the produced compressed stream.
ImageCompressionJPEGFormatOption O IEnumeration R/W - When JPEG is selected as the compression format, a device might
optionally offer better control over JPEG-specific options through this
2012-10-25 Page 40 of 366

feature.
2.2 Acquisition Control

Contains the features related to image acquisition, including the triggering mode.
Table 2-3: Acquisition Control Summary
AcquisitionControl R ICategory R - Category for the acquisition and trigger control features.
AcquisitionMode R IEnumeration R/(W) - Sets the acquisition mode of the device.
AcquisitionStart R ICommand (R)/W - Starts the Acquisition of the device.
AcquisitionStop R ICommand (R)/W - Stops the Acquisition of the device at the end of the current Frame.
AcquisitionAbort R ICommand (R)/W - Aborts the Acquisition immediately.
AcquisitionArm O ICommand (R)/W - Arms the device before an AcquisitionStart command.
AcquisitionFrameCount R IInteger R/W - Number of frames to acquire in MultiFrame Acquisition mode.
AcquisitionBurstFrameCount O IInteger R/W - Number of frames to acquire for each FrameBurstStart trigger.
AcquisitionFrameRate R IFloat R/W Hz Controls the acquisition rate (in Hertz) at which the frames are
captured.
AcquisitionLineRate R IFloat R/W Hz Controls the rate (in Hertz) at which the Lines in a Frame are captured.
AcquisitionStatusSelector R IEnumeration R/W - Selects the internal acquisition signal to read using AcquisitionStatus.
AcquisitionStatus[AcquisitionStatusSele R IBoolean R - Reads the state of the internal acquisition signal selected using
ctor] AcquisitionStatusSelector.
TriggerSelector R IEnumeration R/W - Selects the type of trigger to configure.
TriggerMode[TriggerSelector] R IEnumeration R/W - Controls if the selected trigger is active.
TriggerSoftware[TriggerSelector] R ICommand (R)/W - Generates an internal trigger.
TriggerSource[TriggerSelector] R IEnumeration R/W - Specifies the internal signal or physical input Line to use as the trigger
2012-10-25 Page 41 of 366

source.
TriggerActivation[TriggerSelector] R IEnumeration R/W - Specifies the activation mode of the trigger.
TriggerOverlap[TriggerSelector] R IEnumeration R/W - Specifies the type trigger overlap permitted with the previous frame.
TriggerDelay[TriggerSelector] R IFloat R/W us Specifies the delay in microseconds (us) to apply after the trigger
reception before activating it.
TriggerDivider[TriggerSelector] R IInteger R/W - Specifies a division factor for the incoming trigger pulses.
TriggerMultiplier[TriggerSelector] R IInteger R/W - Specifies a multiplication factor for the incoming trigger pulses.
ExposureMode R IEnumeration R/W - Sets the operation mode of the Exposure (or shutter).
ExposureTime R IFloat R/W us Sets the Exposure time when ExposureMode is Timed and
ExposureAuto is Off.
ExposureAuto O IEnumeration R/W - Sets the automatic exposure mode when ExposureMode is Timed.
2.3 Digital I/O Control

Contains the features related to the control of the general input and output pins of the device.
Table 2-4: Digital I/O Control Summary
DigitalIOControl R ICategory R - Category that contains the digital input and output control features.
LineSelector R IEnumeration R/W - Selects the physical line (or pin) of the external device connector to
configure.
LineMode[LineSelector] O IEnumeration R/W - Controls if the physical Line is used to Input or Output a signal.
LineInverter[LineSelector] R IBoolean R/W - Controls the inversion of the signal of the selected input or output Line.
LineStatus[LineSelector] R IBoolean R - Returns the current status of the selected input or output Line.
LineStatusAll O IInteger R - Returns the current status of all available Line signals at time of polling
2012-10-25 Page 42 of 366

in a single bitfield.
LineSource[LineSelector] R IEnumeration R/W - Selects which internal acquisition or I/O source signal to output on the
selected Line.
LineFormat[LineSelector] O IEnumeration R/W - Controls the current electrical format of the selected physical input or
output Line.
UserOutputSelector R IEnumeration R/W - Selects which bit of the User Output register will be set by
UserOutputValue.
UserOutputValue[UserOutputSelector] R IBoolean R/W - Sets the value of the bit selected by UserOutputSelector.
UserOutputValueAll O IInteger R/W - Sets the value of all the bits of the User Output register.
UserOutputValueAllMask O IInteger R/W - Sets the write mask to apply to the value specified by
UserOutputValueAll before writing it in the User Output register.
2.4 Counter and Timer Control

Contains the features related to the usage of programmable counters and timers.
Table 2-5: Counter and Timer Control Summary
CounterAndTimerControl R ICategory R - Category that contains the Counter and Timer control features.
CounterSelector R IEnumeration R/W - Selects which Counter to configure.
CounterEventSource[CounterSelector] R IEnumeration R/W - Select the events that will be the source to increment the Counter.
CounterEventActivation[CounterSelecto R IEnumeration R/W - Selects the Activation mode Event Source signal.
r]
CounterResetSource[CounterSelector] R IEnumeration R/W - Selects the signals that will be the source to reset the Counter.
CounterResetActivation[CounterSelecto R IEnumeration R/W - Selects the Activation mode of the Counter Reset Source signal.
r]
2012-10-25 Page 43 of 366

CounterReset[CounterSelector] R ICommand (R)/W - Does a software reset of the selected Counter and starts it.
CounterValue[CounterSelector] R IInteger R/W - Reads or writes the current value of the selected Counter.
CounterValueAtReset[CounterSelector] R IInteger R - Reads the value of the selected Counter when it was reset by a trigger
or by an explicit CounterReset command.
CounterDuration[CounterSelector] R IInteger R/W - Sets the duration (or number of events) before the CounterEnd event is
generated.
CounterStatus[CounterSelector] R IEnumeration R - Returns the current state of the Counter.
CounterTriggerSource[CounterSelector] R IEnumeration R/W - Selects the source to start the Counter.
CounterTriggerActivation[CounterSelec R IEnumeration R/W - Selects the activation mode of the trigger to start the Counter.
tor]
TimerSelector R IEnumeration R/W - Selects which Timer to configure.
TimerDuration[TimerSelector] R IFloat R/W us Sets the duration (in microseconds) of the Timer pulse.
TimerDelay[TimerSelector] R IFloat R/W us Sets the duration (in microseconds) of the delay to apply at the
reception of a trigger before starting the Timer.
TimerReset[TimerSelector] R ICommand (R)/W - Does a software reset of the selected timer and starts it.
TimerValue[TimerSelector] R IFloat R/W us Reads or writes the current value (in microseconds) of the selected
Timer.
TimerStatus[TimerSelector] R IEnumeration R - Returns the current state of the Timer.
TimerTriggerSource[TimerSelector] R IEnumeration R/W - Selects the source of the trigger to start the Timer.
TimerTriggerActivation[TimerSelector] R IEnumeration R/W - Selects the activation mode of the trigger to start the Timer.
2.5 Event Control

Contains the features related to the generation of Event notifications by the device.
Table 2-6: Event Control Summary
2012-10-25 Page 44 of 366


EventControl R ICategory R - Category that contains Event control features.
EventSelector R IEnumeration R/W - Selects which Event to signal to the host application.
EventNotification[EventSelector] R IEnumeration R/W - Activate or deactivate the notification to the host application of the
occurrence of the selected Event.

EventFrameTriggerData R ICategory R - Category that contains all the data features related to the FrameTrigger
Event.
EventFrameTrigger R IInteger R - Returns the unique Identifier of the FrameTrigger type of Event.
EventFrameTriggerTimestamp R IInteger R - Returns the Timestamp of the AcquisitionTrigger Event.
EventFrameTriggerFrameID R IInteger R - Returns the unique Identifier of the Frame (or image) that generated the
FrameTrigger Event.

EventExposureEndData R ICategory R - Category that contains all the data features related to the ExposureEnd
Event.
EventExposureEnd R IInteger R - Returns the unique identifier of the ExposureEnd type of Event.
EventExposureEndTimestamp R IInteger R - Returns the Timestamp of the ExposureEnd Event.
EventExposureEndFrameID R IInteger R - Returns the unique Identifier of the Frame (or image) that generated the
ExposureEnd Event.

EventErrorData R ICategory R - Category that contains all the data features related to the Error Event.
EventError R IInteger R - Returns the unique identifier of the Error type of Event.
2012-10-25 Page 45 of 366

EventErrorTimestamp R IInteger R - Returns the Timestamp of the Error Event.

EventErrorFrameID R IInteger R - If applicable, returns the unique Identifier of the Frame (or image) that
generated the Error Event.
EventErrorCode R IInteger R - Returns an error code for the error(s) that happened.
2.6 Analog Control

Contains the features related to the video signal conditioning in the analog domain.
Table 2-7: Analog Control Summary
AnalogControl O ICategory R - Category that contains the Analog control features.
GainSelector O IEnumeration R/W - Selects which Gain is controlled by the various Gain features.
Gain[GainSelector] O IFloat R/W - Controls the selected gain as an absolute physical value.
GainAuto[GainSelector] O IEnumeration R/W - Sets the automatic gain control (AGC) mode.
GainAutoBalance O IEnumeration R/W - Sets the mode for automatic gain balancing between the sensor color
channels or taps.
BlackLevelSelector O IEnumeration R/W - Selects which Black Level is controlled by the various Black Level
features.
BlackLevel[BlackLevelSelector] O IFloat R/W - Controls the analog black level as an absolute physical value.
BlackLevelAuto[BlackLevelSelector] O IEnumeration R/W - Controls the mode for automatic black level adjustment.
BlackLevelAutoBalance O IEnumeration R/W - Controls the mode for automatic black level balancing between the
sensor color channels or taps.
WhiteClipSelector O IEnumeration R/W - Selects which White Clip to control.
WhiteClip[WhiteClipSelector] O IFloat R/W - Controls the maximal intensity taken by the video signal before being
clipped as an absolute physical value.
2012-10-25 Page 46 of 366

BalanceRatioSelector O IEnumeration R/W - Selects which Balance ratio to control.

BalanceRatio[BalanceRatioSelector] O IFloat R/W - Controls ratio of the selected color component to a reference color
component.
BalanceWhiteAuto O IEnumeration R/W - Controls the mode for automatic white balancing between the color
channels.
Gamma O IFloat R/W - Controls the gamma correction of pixel intensity.
2.7 LUT Control

Contains the features related to the look-up table (LUT) control.
Table 2-8: Lut Control Summary
LUTControl O ICategory R - Category that includes the LUT control features.
LUTSelector O IEnumeration R/W - Selects which LUT to control.
LUTEnable[LUTSelector] O IBoolean R/W - Activates the selected LUT.
LUTIndex[LUTSelector] O IInteger R/W - Control the index (offset) of the coefficient to access in the selected
LUT.
LUTValue[LUTSelector][LUTIndex] O IInteger R/W - Returns the Value at entry LUTIndex of the LUT selected by
LUTSelector.
LUTValueAll[LUTSelector] O IRegister R/W - Accesses all the LUT coefficients in a single access without using
individual LUTIndex.
2012-10-25 Page 47 of 366

2.8 GenICam Control

Contains the features related to GenICam control and access.
Table 2-9: GenICam Control Summary
Root M ICategory R - Provides the Root of the GenICam features tree.
Device M IPort R/W - Provides the default GenICam port of the Device.
TLParamsLocked M IInteger R/W - Used by the Transport Layer to prevent critical features changes during
acquisition.
2.9 Transport Layer Control

Contains the features related to the Transport Layer Control.
Table 2-10: Transport Layer Control Summary
TransportLayerControl R ICategory R - Category that contains the transport Layer control features.
PayloadSize R IInteger R B Provides the number of bytes transferred for each image or chunk on
the stream channel.
DeviceTapGeometry R IEnumeration R/(W) - This device tap geometry feature describes the geometrical properties
characterizing the taps of a camera as presented at the output of the
device.

GigEVision O ICategory R - Category that contains the features pertaining to the GigE Vision
transport layer of the device.
2012-10-25 Page 48 of 366

GevVersionMajor R IInteger R - Major version of the specification.

GevVersionMinor R IInteger R - Minor version of the specification.
GevDeviceModeIsBigEndian O IBoolean R - Endianess of the device registers.
GevDeviceClass O IEnumeration R - Returns the class of the device.
GevDeviceModeCharacterSet O IEnumeration R - Character set used by all the strings of the bootstrap registers.
GevPhysicalLinkConfiguration O IEnumeration R/W - Controls the principal physical link configuration to use on next
restart/power-up of the device.
GevCurrentPhysicalLinkConfiguration O IEnumeration R - Indicates the current physical link configuration of the device.
GevActiveLinkCount O IInteger R - Indicates the current number of active logical links.
GevInterfaceSelector O IInteger R/W - Selects which logical link to control.
GevLinkSpeed[GevInterfaceSelector] O IInteger R Mbs Indicates the speed of transmission negotiated by the given logical link.
GevMACAddress[GevInterfaceSelector] O IInteger R - MAC address of the logical link.
GevSupportedOptionSelector O IEnumeration R/W - Selects the GEV option to interrogate for existing support.
GevSupportedOption[GevSupportedOpt O IBoolean R - Returns if the selected GEV option is supported.
ionSelector]
GevPAUSEFrameReception[GevInterfa O IBoolean R/(W) - Controls whether incoming PAUSE Frames are handled on the given
ceSelector] logical link.
GevPAUSEFrameTransmission[GevInte O IBoolean R/(W) - Controls whether PAUSE Frames can be generated on the given logical
rfaceSelector] link.
GevCurrentIPConfigurationLLA[GevInt O IBoolean R/W - Controls whether the Link Local Address IP configuration scheme is
erfaceSelector] activated on the given logical link.
GevCurrentIPConfigurationDHCP[GevI O IBoolean R/W - Controls whether the DHCP IP configuration scheme is activated on the
nterfaceSelector] given logical link.
GevCurrentIPConfigurationPersistentIP[ O IBoolean R/W - Controls whether the PersistentIP configuration scheme is activated on
GevInterfaceSelector] the given logical link.
GevCurrentIPAddress[GevInterfaceSele O IInteger R - Reports the IP address for the given locical link.
2012-10-25 Page 49 of 366

ctor]
GevCurrentSubnetMask[GevInterfaceSe O IInteger R - Reports the subnet mask of the given logical link.
lector]
GevCurrentDefaultGateway[GevInterfac O IInteger R - Reports the default gateway IP address to be used on the given logical
eSelector] link.
GevIPConfigurationStatus[GevInterface O IEnumeration R - Reports the current IP configuration status.
Selector]
GevFirstURL O IString R - Indicates the first URL to the GenICam XML device description file.
GevSecondURL O IString R - Indicates the second URL to the GenICam XML device description file.
GevNumberOfInterfaces O IInteger R - Indicates the number of logical links supported by this device.
GevPersistentIPAddress[GevInterfaceSe O IInteger R/W - Controls the Persistent IP address for this logical link.
lector]
GevPersistentSubnetMask[GevInterface O IInteger R/W - Controls the Persistent subnet mask associated with the Persistent IP
Selector] address on this logical link.
GevPersistentDefaultGateway[GevInterf O IInteger R/W - Controls the persistent default gateway for this logical link.
aceSelector]
GevMessageChannelCount O IInteger R - Indicates the number of message channels supported by this device.
GevStreamChannelCount O IInteger R - Indicates the number of stream channels supported by this device.
GevHeartbeatTimeout O IInteger R/W ms Controls the current heartbeat timeout in milliseconds.
GevTimestampTickFrequency O IInteger R Hz Indicates the number of timestamp ticks in 1 second (frequency in Hz).
GevTimestampControlLatch O ICommand W - Latches the current timestamp counter into GevTimestampValue.
GevTimestampControlReset O ICommand W - Resets the timestamp counter to 0.
GevTimestampValue O IInteger R Returns the latched 64-bit value of the timestamp counter.
GevDiscoveryAckDelay O IInteger R/(W) ms Indicates the maximum randomized delay the device will wait to
acknowledge a discovery command.
GevIEEE1588 O IBoolean R/W - Enables the IEEE 1588 Precision Time Protocol to control the
2012-10-25 Page 50 of 366

timestamp register.
GevIEEE1588ClockAccuracy O IEnumeration R/(W) - Indicates the expected accuracy of the device clock when it is the
grandmaster, or in the event it becomes the grandmaster.
GevIEEE1588Status O IEnumeration R - Provides the state of the IEEE 1588 clock.
GevGVCPExtendedStatusCodesSelector O IEnumeration R/W - Selects the GigE Vision version to control extended status codes for.
GevGVCPExtendedStatusCodes[GevG O IBoolean R/W - Enables the generation of extended status codes.
VCPExtendedStatusCodesSelector]
GevGVCPPendingAck O IBoolean R/W - Enables the generation of PENDING_ACK.
GevGVCPHeartbeatDisable O IBoolean R/W - Disables the GVCP heartbeat.
GevGVCPPendingTimeout O IInteger R - Indicates the longest GVCP command execution time before a device
returns a PENDING_ACK.
GevPrimaryApplicationSwitchoverKey O IInteger W-O - Controls the key to use to authenticate primary application switchover
requests.
GevGVSPExtendedIDMode O IEnumeration R/(W) - Enables the extended IDs mode.
GevCCP O IEnumeration R/W - Controls the device access privilege of an application.
GevPrimaryApplicationSocket O IInteger R - Returns the UDP source port of the primary application.
GevPrimaryApplicationIPAddress O IInteger R - Returns the address of the primary application.
GevMCPHostPort O IInteger R/W - Controls the port to which the device must send messages.
GevMCDA O IInteger R/W - Controls the destination IP address for the message channel.
GevMCTT O IInteger R/W ms Provides the transmission timeout value in milliseconds.
GevMCRC O IInteger R/W - Controls the number of retransmissions allowed when a message
channel message times out.
GevMCSP O IInteger R - This feature indicates the source port for the message channel.
GevStreamChannelSelector O IInteger R/W - Selects the stream channel to control.
GevSCCFGPacketResendDestination[G O IBoolean R/W - Enables the alternate IP destination for stream packets resent due to a
evStreamChannelSelector] packet resend request.
2012-10-25 Page 51 of 366

GevSCCFGAllInTransmission[GevStrea O IBoolean R/W - Enables the selected GVSP transmitter to use the single packet per data
mChannelSelector] block All-in Transmission mode.
GevSCCFGUnconditionalStreaming[Ge O IBoolean R/W - Enables the camera to continue to stream, for this stream channel, if its
vStreamChannelSelector] control channel is closed or regardless of the reception of any ICMP
messages (such as destination unreachable messages).
GevSCCFGExtendedChunkData[GevStr O IBoolean R/W - Enables cameras to use the extended chunk data payload type for this
eamChannelSelector] stream channel.
GevSCPDirection[GevStreamChannelSe O IEnumeration R - Reports the direction of the stream channel.
lector]
GevSCPInterfaceIndex[GevStreamChan O IInteger R/(W) - Index of the logical link to use.
nelSelector]
GevSCPHostPort[GevStreamChannelSe O IInteger R/W - Controls the port of the selected channel to which a GVSP transmitter
lector] must send data stream or the port from which a GVSP receiver may
receive data stream.
GevSCPSFireTestPacket[GevStreamCh O IBoolean R/W - Sends a test packet.
annelSelector]
GevSCPSDoNotFragment[GevStreamC O IBoolean R/W - The state of this feature is copied into the "do not fragment" bit of IP
hannelSelector] header of each stream packet.
GevSCPSBigEndian[GevStreamChanne O IBoolean R/W - Endianess of multi-byte pixel data for this stream.
lSelector]
GevSCPSPacketSize[GevStreamChanne R IInteger R/(W) B Specifies the stream packet size, in bytes, to send on the selected
lSelector] channel for a GVSP transmitter or specifies the maximum packet size
supported by a GVSP receiver.
GevSCPD[GevStreamChannelSelector] R IInteger R/W Controls the delay (in timestamp counter unit) to insert between each
packet for this stream channel.
GevSCDA[GevStreamChannelSelector] O IInteger R/W - Controls the destination IP address of the selected stream channel to
which a GVSP transmitter must send data stream or the destination IP
address from which a GVSP receiver may receive data stream.
GevSCSP[GevStreamChannelSelector] O IInteger R - Indicates the source port of the stream channel.
2012-10-25 Page 52 of 366

GevSCZoneCount[GevStreamChannelS O IInteger R - Reports the number of zones per block transmitted on the selected
elector] stream channel.
GevSCZoneDirectionAll[GevStreamCh O IInteger R - Reports the transmission direction of each zone transmitted on the
annelSelector] selected stream channel.
GevSCZoneConfigurationLock[GevStre O IBoolean R/W - Controls whether the selected stream channel multi-zone configuration
amChannelSelector] is locked.

NetworkStatistics O ICategory R - Category that contains statistics pertaining to various modules of the
GigE Vision transport layer.

oMACControlFunctionEntity O ICategory R - Category that contains statistics pertaining to the MAC control PAUSE
function of the device.
aPAUSEMACCtrlFramesTransmitted[G O IInteger R - Reports the number of transmitted PAUSE frames.
evInterfaceSelector]
aPAUSEMACCtrlFramesReceived[Gev O IInteger R - Reports the number of received PAUSE frames.
InterfaceSelector]

CameraLink O ICategory R - Category that contains the features pertaining to the Camera Link
ClConfiguration R IEnumeration R/(W) - This Camera Link specific feature describes the configuration used by
the camera.
2012-10-25 Page 53 of 366

ClTimeSlotsCount O IEnumeration R/(W) - This Camera Link specific feature describes the time multiplexing of
the camera link connection to transfer more than the configuration
allows, in one single clock.

CoaXPress O ICategory R - Category that contains the features pertaining to the CoaXPress
CxpLinkConfigurationStatus R IEnumeration R - This feature indicates the current and active Link configuration used by
the Device.
CxpLinkConfigurationPreferred R IEnumeration R - Returns the preferred Link configuration of the Transmitter Device.
CxpLinkConfiguration R IEnumeration R/(W) - This feature can be used to set the Link configuration for the
communication between the Receiver and Transmitter Device.
CxpConnectionSelector R IInteger R/W - Selects the CoaXPress physical connection to control.
CxpConnectionTestMode[CxpConnecti R IEnumeration R/W - Enables the test mode for an individual physical connection of the
onSelector] Device.
CxpConnectionTestErrorCount[CxpCon R IInteger R/W - Reports the current connection error count for test packets recieved by
nectionSelector] the device on the connection selected by CxpConnectionSelector.
CxpConnectionTestPacketCount[CxpCo R IInteger R/W - Reports the current count for test packets recieved by the device on the
nnectionSelector] connection selected by CxpConnectionSelector.
CxpPoCxpAuto O ICommand W - Activate automatic control of the Power over CoaXPress (PoCXP) for
the Link.
CxpPoCxpTurnOff O ICommand W - Disable Power over CoaXPress (PoCXP) for the Link.
CxpPoCxpTripReset O ICommand W - Reset the Power over CoaXPress (PoCXP) Link after an over-current
trip on the Device connection(s).
CxpPoCxpStatus O IEnumeration R - Returns the Power over CoaXPress (PoCXP) status of the Device.
2012-10-25 Page 54 of 366

2.10 User Set Control

Contains the features related to the User Set Control to save and load the user device settings.
Table 2-11: User Set Control Summary
UserSetControl R ICategory R - Category that contains the User Set control features.
UserSetSelector R IEnumeration R/W - Selects the feature User Set to load, save or configure.
UserSetLoad[UserSetSelector] R ICommand (R)/W - Loads the User Set specified by UserSetSelector to the device and
makes it active.
UserSetSave[UserSetSelector] R ICommand (R)/W - Save the User Set specified by UserSetSelector to the non-volatile
memory of the device.
UserSetDefault O IEnumeration R/W - Selects the feature User Set to load and make active by default when the
device is reset.
UserSetDefaultSelector O IEnumeration R/W - This feature is deprecated (See UserSetDefault).
2.11 Chunk Data Control

Contains the features related to the Chunk Data Control.
Table 2-12: Chunk Data Control Summary
ChunkDataControl R ICategory R - Category that contains the Chunk Data control features.
ChunkModeActive R IBoolean R/W - Activates the inclusion of Chunk data in the payload of the image.
ChunkSelector R IEnumeration R/W - Selects which Chunk to enable or control.
ChunkEnable[ChunkSelector] R IBoolean R/W - Enables the inclusion of the selected Chunk data in the payload of the
image.
2012-10-25 Page 55 of 366

ChunkImage R IRegister R - Returns the entire image data included in the payload.
ChunkOffsetX R IInteger R - Returns the OffsetX of the image included in the payload.
ChunkOffsetY R IInteger R - Returns the OffsetY of the image included in the payload.
ChunkWidth R IInteger R - Returns the Width of the image included in the payload.
ChunkHeight R IInteger R - Returns the Height of the image included in the payload.
ChunkPixelFormat R IEnumeration R - Returns the PixelFormat of the image included in the payload.
ChunkPixelDynamicRangeMin R IInteger R - Returns the minimum value of dynamic range of the image included in
the payload.
ChunkPixelDynamicRangeMax R IInteger R - Returns the maximum value of dynamic range of the image included in
the payload.
ChunkTimestamp R IInteger R - Returns the Timestamp of the image included in the payload at the time
of the FrameStart internal event.
ChunkLineStatusAll R IInteger R - Returns the status of all the I/O lines at the time of the FrameStart
internal event.
ChunkCounterSelector R IEnumeration R/W - Selects which counter to retrieve data from.
ChunkCounterValue[ChunkCounterSele R IInteger R - Returns the value of the selected Chunk counter at the time of the
ctor] FrameStart event.
ChunkTimerSelector R IEnumeration R/W - Selects which Timer to retrieve data from.
ChunkTimerValue[ChunkTimerSelector R IFloat R us Returns the value of the selected Timer at the time of the FrameStart
] internal event.
ChunkExposureTime R IFloat R us Returns the exposure time used to capture the image.
ChunkGainSelector R IEnumeration R/W - Selects which Gain to retrieve data from.
ChunkGain[ChunkGainSelector] R IFloat R - Returns the gain used to capture the image.
ChunkBlackLevelSelector R IEnumeration R/W - Selects which Black Level to retrieve data from.
ChunkBlackLevel[ChunkBlackLevelSel R IFloat R - Returns the black level used to capture the image included in the
ector] payload.
2012-10-25 Page 56 of 366

ChunkLinePitch R IInteger R B Returns the LinePitch of the image included in the payload.
ChunkFrameID R IInteger R - Returns the unique Identifier of the frame (or image) included in the
payload.
ChunkSourceID O IEnumeration R - Returns the identifier of Source that the image comes from.
ChunkRegionID O IEnumeration R - Returns the identifier of Region that the image comes from.
ChunkTransferBlockID R IInteger R - Returns the unique identifier of the transfer block used to transport the
payload.
ChunkTransferStreamID R IEnumeration R - Returns identifier of the stream that generates this block.
ChunkTransferQueueCurrentBlockCoun O IInteger R - Returns the current number of blocks in the transfer queue.
t
ChunkStreamChannelID R IInteger R - Returns identifier of the stream channel used to carry the block.
2.12 File Access Control

Contains the features related to the File that provides all the sevices necessary for generic file access of a device.
Table 2-13: File Control Summary
FileAccessControl R ICategory R - Category that contains the File Access control features.
FileSelector R IEnumeration R/(W) - Selects the target file in the device.
FileOperationSelector[FileSelector] R IEnumeration R/W - Selects the target operation for the selected file in the device.
FileOperationExecute[FileSelector][File R ICommand (R)/W - Executes the operation selected by FileOperationSelector on the
OperationSelector] selected file.
FileOpenMode[FileSelector] R IEnumeration R/(W) - Selects the access mode in which a file is opened in the device.
FileAccessBuffer R IRegister R/(W) - Defines the intermediate access buffer that allows the exchange of data
between the device file storage and the application.
2012-10-25 Page 57 of 366

FileAccessOffset[FileSelector][FileOper R IInteger R/(W) B Controls the Offset of the mapping between the device file storage and
ationSelector] the FileAccessBuffer.
FileAccessLength[FileSelector][FileOpe R IInteger R/W B Controls the Length of the mapping between the device file storage and
rationSelector] the FileAccessBuffer.
FileOperationStatus[FileSelector][FileO R IEnumeration R - Represents the file operation execution status.
perationSelector]
FileOperationResult[FileSelector][FileO R IInteger R - Represents the file operation result.
perationSelector]
FileSize[FileSelector] R IInteger R B Represents the size of the selected file in bytes.
2.13 Color Transformation Control

Contains the features related to the control of the color transformation.
Table 2-14: Color Transformation summary
ColorTransformationControl R ICategory R - Category that contains the Color Transformation control features.
ColorTransformationSelector O IEnumeration R/W - Selects which Color Transformation module is controlled by the various
Color Transformation features.
ColorTransformationEnable[ColorTrans O IBoolean R/W - Activates the selected Color Transformation module.
formationSelector]
ColorTransformationValueSelector[Col O IEnumeration R/W - Selects the Gain factor or Offset of the Transformation matrix to access
orTransformationSelector] in the selected Color Transformation module.
ColorTransformationValue[ColorTransf O IFloat R/W - Represents the value of the selected Gain factor or Offset inside the
ormationSelector][ColorTransformation Transformation matrix.
ValueSelector]
2012-10-25 Page 58 of 366

2.14 Action Control

Contains the features related to the control of the Action command mechanism.
Table 2-15: Action Control Summary
ActionControl R ICategory R - Category that contains the Action control features.
ActionUnconditionalMode O IEnumeration R/W - Enables the unconditional action command mode where action
commands are processed even when the primary control channel is
closed.
ActionDeviceKey O IInteger W-O - Provides the device key that allows the device to check the validity of
action commands.
ActionQueueSize O IInteger R - Indicates the size of the scheduled action commands queue.
ActionSelector O IInteger R/W - Selects to which Action Signal further Action settings apply.
ActionGroupMask[ActionSelector] O IInteger R/W - Provides the mask that the device will use to validate the action on
reception of the action protocol message.
ActionGroupKey[ActionSelector] O IInteger R/W - Provides the key that the device will use to validate the action on
reception of the action protocol message.
2.15 Source Control

Contains the features related to the control of the multiple Source devices.
Table 2-16: Source Control Summary
SourceControl O ICategory R - Category that contains the source control features.
2012-10-25 Page 59 of 366

SourceCount O IInteger R/(W) - Controls or returns the number of sources supported by the device.
SourceSelector O IEnumeration R/W - Selects the source to control.
2.16 Transfer Control

Contains the features related to the control of the Transfers.
Table 2-17: Transfer Control Summary
TransferControl R ICategory --- - Category for the data Transfer Control features.
TransferSelector O IEnumeration R/(W) - Selects which stream transfers are currently controlled by the selected
Transfer features.
TransferControlMode[TransferSelector] R IEnumeration R/(W) - Selects the control method for the transfers.
TransferOperationMode[TransferSelecto O IEnumeration R/(W) - Selects the operation mode of the transfer.
r]
TransferBlockCount[TransferSelector] O IInteger R/(W) - Specifies the number of data Blocks that the device should stream
before stopping.
TransferBurstCount O IInteger R/W - Number of Block(s) to transfer for each TransferBurstStart trigger.
TransferQueueMaxBlockCount[Transfer O IInteger R/(W) - Controls the maximum number of data blocks that can be stored in the
Selector] block queue of the selected stream.
TransferQueueCurrentBlockCount[Tran O IInteger R - Returns the number of Block(s) currently in the transfer queue.
sferSelector]
TransferQueueMode[TransferSelector] O IEnumeration R/(W) - Specifies the operation mode of the transfer queue.
TransferStart[TransferSelector] O ICommand (R)/W - Starts the streaming of data blocks out of the device.
TransferStop[TransferSelector] O ICommand (R)/W - Stops the streaming of data Block(s).
TransferAbort[TransferSelector] O ICommand (R)/W - Aborts immediately the streaming of data block(s).
2012-10-25 Page 60 of 366

TransferPause[TransferSelector] O ICommand (R)/W - Pauses the streaming of data Block(s).

TransferResume[TransferSelector] O ICommand (R)/W - Resumes a data Blocks streaming that was previously paused by a
TransferPause command.
TransferTriggerSelector[TransferSelecto O IEnumeration R/W - Selects the type of transfer trigger to configure.
r]
TransferTriggerMode[TransferSelector][ R IEnumeration R/W - Controls if the selected trigger is active.
TransferTriggerSelector]
TransferTriggerSource[ O IEnumeration R/W - Specifies the signal to use as the trigger source for transfers.
TransferTriggerActivation [ O IEnumeration R/W - Specifies the activation mode of the transfer control trigger.
TransferStatusSelector[TransferSelector R IEnumeration R/W - Selects which state of the transfer module to read.
]
TransferStatus[TransferStatusSelector] R IBool R - Reads the state of the Transfer module signal selected by
TransferStatusSelector.
TransferComponentSelector[TransferSel O IEnumeration R/W - Selects the color component for the control of the
ector] TransferStreamChannel feature.
TransferStreamChannel[TransferSelecto O IInteger R/W - Selects the streaming channel that will be used to transfer the selected
r][TransferComponentSelector] stream of data.
2012-10-25 Page 61 of 366

3 Device Control
Device control features provides general information and control for the device (camera) and its
sensor. This is mainly used to identify the device during the enumeration process and to obtain
information about the sensor resolution. Other information and controls pertaining to the general
state of the device are also included in this category.
3.1 DeviceControl
Name DeviceControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Beginner
Values -
Category for device information and control.
3.2 DeviceType
Name DeviceType
Category DeviceControl
Level Optional
Interface IEnumeration
Access Read
Unit -
Visibility Guru
Values Transmitter
Receiver
Transceiver
Peripheral
Returns the device type.

Possible values are:
• Transmitter: Data stream transmitter device.
• Receiver: Data stream receiver device.
• Transceiver: Data stream receiver and transmitter device.
• Peripheral: Controlable device (with no data stream handling).
2012-10-25 Page 62 of 366

3.3 DeviceScanType
Name DeviceScanType
Level Recommended
Access Read/(Write)
Unit -
Visibility Expert
Values Areascan
Linescan
Scan type of the sensor of the device.

Typically, this feature is not writable. But some cameras might allow switching between linescan
and areascan.
• Areascan: 2D sensor.
• Linescan: 1D sensor.
3.4 DeviceVendorName
Name DeviceVendorName
Level Recommended
Interface IString
Access Read
Unit -
Visibility Beginner
Values Any NULL-terminated string
Name of the manufacturer of the device.
3.5 DeviceModelName
Name DeviceModelName
Level Recommended
Interface IString
2012-10-25 Page 63 of 366

Access Read
Unit -
Visibility Beginner
Model of the device.
3.6 DeviceFamilyName
Name DeviceFamilyName
Level Optional
Interface IString
Access Read
Unit -
Visibility Beginner
Identifier of the product family of the device.
3.7 DeviceManufacturerInfo
Name DeviceManufacturerInfo
Level Recommended
Interface IString
Access Read
Unit -
Visibility Beginner
Manufacturer information about the device.
3.8 DeviceVersion
Name DeviceVersion
Level Recommended
Interface IString
2012-10-25 Page 64 of 366

Access Read
Unit -
Visibility Beginner
Version of the device.
3.9 DeviceFirmwareVersion
Name DeviceFirmwareVersion
Level Recommended
Interface IString
Access Read
Unit -
Visibility Beginner
Version of the firmware in the device.
3.1 DeviceSerialNumber
Name DeviceSerialNumber
Level Recommended
Interface IString
Access Read
Unit -
Visibility Expert
Device’s serial number. This string is a unique identifier of the device.
3.2DeviceID (Deprecated)
Name DeviceID
Level Recommended
Interface IString
2012-10-25 Page 65 of 366

Access Read
Unit -
Visibility Invisible
This feature is deprecated (See DeviceSerialNumber). It was representing the Device unique
identifier (serial number) .
To help backward compatibility, this feature can be included as Invisible in the device’s XML.
3.3 DeviceUserID
Name DeviceUserID
Level Optional
Interface IString
Access Read/Write
Unit -
Visibility Beginner
User-programmable device identifier.

When this feature is present, it must be writable. The recommended factory default value is an
empty string.
3.4 DeviceSFNCVersionMajor
Name DeviceSFNCVersionMajor
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values >0
Major version of the Standard Features Naming Convention that was used to create the device`s
GenICam XML.
2012-10-25 Page 66 of 366

3.5 DeviceSFNCVersionMinor
Name DeviceSFNCVersionMinor
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values ≥0
Minor version of the Standard Features Naming Convention that was used to create the device`s
GenICam XML.
3.6 DeviceSFNCVersionSubMinor
Name DeviceSFNCVersionSubMinor
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values ≥0
Sub minor version of Standard Features Naming Convention that was used to create the device`s
GenICam XML.
3.7 DeviceManifestEntrySelector
Name DeviceManifestEntrySelector
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Guru
2012-10-25 Page 67 of 366

Values ≥1
Selects the manifest entry to reference.
3.8 DeviceManifestXMLMajorVersion
Name DeviceManifestXMLMajorVersion[DeviceManifestEntrySelector]
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
Indicates the major version number of the GenICam XML file of the selected manifest entry.
3.9 DeviceManifestXMLMinorVersion
Name DeviceManifestXMLMinorVersion[DeviceManifestEntrySelector]
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
Indicates the minor version number of the GenICam XML file of the selected manifest entry.
3.10 DeviceManifestXMLSubMinorVersion
Name DeviceManifestXMLSubMinorVersion[DeviceManifestEntrySelector]
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
2012-10-25 Page 68 of 366

Values ≥0
Indicates the subminor version number of the GenICam XML file of the selected manifest entry.
3.11 DeviceManifestSchemaMajorVersion
Name DeviceManifestSchemaMajorVersion[DeviceManifestEntrySelector]
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
Indicates the major version number of the schema file of the selected manifest entry.
3.12 DeviceManifestSchemaMinorVersion
Name DeviceManifestSchemaMinorVersion[DeviceManifestEntrySelector]
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
Indicates the minor version number of the schema file of the selected manifest entry.
3.13 DeviceManifestPrimaryURL
Name DeviceManifestPrimaryURL[DeviceManifestEntrySelector]
Level Optional
Interface IString
Access Read
Unit -
Visibility Guru
2012-10-25 Page 69 of 366

Values -
Indicates the first URL to the GenICam XML device description file of the selected manifest entry.
3.14 DeviceManifestSecondaryURL
Name DeviceManifestSecondaryURL[DeviceManifestEntrySelector]
Level Optional
Interface IString
Access Read
Unit -
Visibility Guru
Values -
Indicates the second URL to the GenICam XML device description file of the selected manifest
entry.
3.15 DeviceTLType
Name DeviceTLType
Level Recommended
Access Read
Unit -
Visibility Beginner
Values GigEVision
CameraLink
CameraLinkHS
CoaXPress
USB3Vision
Custom
Transport Layer type of the device.

• GigEVision: GigE Vision.
• CameraLink: Camera Link.
• CameraLinkHS: Camera Link High Speed.
2012-10-25 Page 70 of 366

• CoaXPress: CoaXPress.
• USB3Vision: USB3 Vision.
• Custom: Custom Transport Layer.
3.16 DeviceTLVersionMajor
Name DeviceTLVersionMajor
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values >0
Major version of the Transport Layer of the device.
3.17 DeviceTLVersionMinor
Name DeviceTLVersionMinor
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values ≥0
Minor version of the Transport Layer of the device.
3.18 DeviceTLVersionSubMinor
Name DeviceTLVersionSubMinor
Level Recommended
Interface IInteger
Access Read
2012-10-25 Page 71 of 366

Unit -
Visibility Beginner
Values ≥0
Sub minor version of the Transport Layer of the device.
3.19 DeviceGenCPVersionMajor
Name DeviceGenCpVersionMajor
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values >0
Major version of the GenCP protocol supported by the device.
3.20 DeviceGenCPVersionMinor
Name DeviceGenCPVersionMinor
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values ≥0
Minor version of the GenCP protocol supported by the device.
3.21 DeviceMaxThroughput
Name DeviceMaxThroughput
Level Optional
Interface IInteger
Access Read
2012-10-25 Page 72 of 366

Unit Bps
Visibility Expert
Values >0
Maximum bandwidth of the data that can be streamed out of the device. This can be used to
estimate if the connection can sustain transfer of free-running images from the camera at its
maximum speed.
3.22 DeviceConnectionSelector
Name DeviceConnectionSelector
Level Recommended
Interface IInteger
Access Read/(Write)
Unit -
Visibility Beginner
Values ≥0
Selects which Connection of the device to control.
3.23 DeviceConnectionSpeed
Name DeviceConnectionSpeed[DeviceConnectionSelector]
Level Optional
Interface IInteger
Access Read
Unit Bps
Visibility Expert
Values >0
Indicates the speed of transmission of the specified Connection
3.24 DeviceConnectionStatus
Name DeviceConnectionStatus[DeviceConnectionSelector]
Level Optional
2012-10-25 Page 73 of 366

Access Read
Unit -
Visibility Expert
Values Active
Inactive
Indicates the status of the specified Connection.

• Active: Connection is in use.
• Inactive: Connection is not in use.
3.25 DeviceLinkSelector
Name DeviceLinkSelector
Level Recommended
Interface IInteger
Access Read/(Write)
Unit -
Visibility Beginner
Values ≥0
Selects which Link of the device to control.

Generally, a device has only one Link that can be composed of one or many connections. But if
there is many, this selector can be used to target a particular Link of the device with certain features.
3.26 DeviceLinkSpeed
Name DeviceLinkSpeed[DeviceLinkSelector]
Level Optional
Interface IInteger
Access Read
Unit Bps
Visibility Expert
Values ≥0
Indicates the speed of transmission negotiated on the specified Link.
2012-10-25 Page 74 of 366

Note that this represents the total speed of all the connections of the Link.
3.27 DeviceLinkThroughputLimitMode
Name DeviceLinkThroughputLimitMode[DeviceLinkSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values On
Off
Controls if the DeviceLinkThroughputLimit is active. When disabled, lower level TL specific

features are expected to control the throughput. When enabled, DeviceLinkThroughputLimit
controls the overall throughput.
• On: Enables the DeviceLinkThroughputLimit feature.
• Off: Disables the DeviceLinkThroughputLimit feature.
3.28 DeviceLinkThroughputLimit
Name DeviceLinkThroughputLimit[DeviceLinkSelector]
Level Recommended
Interface IInteger
Access Read/(Write)
Unit Bps
Visibility Expert
Values ≥0
Limits the maximum bandwidth of the data that will be streamed out by the device on the selected
Link. If necessary, delays will be uniformly inserted between transport layer packets in order to
control the peak bandwidth.
If the device uses many connections to transmit the data, the feature represents the sum of all the
traffic and the bandwidth should be distributed uniformly on the various connections.
Any Transport Layer specific bandwidth controls should be kept in sync with this control as much
as possible.
2012-10-25 Page 75 of 366

3.29 DeviceLinkConnectionCount
Name DeviceLinkConnectionCount[DeviceLinkSelector]
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values ≥0
Returns the number of physical connection of the device used by a particular Link.
3.30 DeviceLinkHeartbeatMode
Name DeviceLinkHeartbeatMode[DeviceLinkSelector]
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values On
Off
Activate or deactivate the Link`s heartbeat.

• Off: Disables the Link heartbeat.
• On: Enables the Link heartbeat.
3.31 DeviceLinkHeartbeatTimeout
Name DeviceLinkHeartbeatTimeout[DeviceLinkSelector]
Level Optional
Interface IFloat
Access Read/Write
Unit us
2012-10-25 Page 76 of 366

Visibility Guru
Values >0
Controls the current heartbeat timeout of the specific Link.
3.32 DeviceLinkCommandTimeout
Name DeviceCommandTimeout [DeviceLinkSelector]
Level Optional
Interface IFloat
Access Read
Unit us
Visibility Guru
Values >0
Indicates the current command timeout of the specific Link.
3.33 DeviceStreamChannelCount
Name DeviceStreamChannelCount
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Indicates the number of streaming channels supported by the device.
3.34 DeviceStreamChannelSelector
Name DeviceStreamChannelSelector
Level Optional
Interface IInteger
Access Read/Write
Unit -
2012-10-25 Page 77 of 366

Visibility Expert
Values ≥0
Selects the stream channel to control.
3.35 DeviceStreamChannelType
Name DeviceStreamChannelDirection[DeviceStreamChannelSelector]
Level Optional
Access Read
Unit -
Visibility Guru
Values Transmitter
Receiver
Reports the direction of the stream channel.

• Transmitter: Data stream transmitter channel.
• Receiver: Data stream receiver channel.
3.36 DeviceStreamChannelLink
Name DeviceStreamChannelLink[DeviceStreamChannelSelector]
Level Optional
Interface IInteger
Access Read/(Write)
Unit -
Visibility Guru
Values ≥0
Index of device`s Link to use for streaming the specifed stream channel.
3.37 DeviceStreamChannelEndianness
Name DeviceStreamChannelEndianness [DeviceStreamChannelSelector]
2012-10-25 Page 78 of 366

Level Optional
Interface IBoolean
Access Read/(Write)
Unit -
Visibility Guru
Values Big
Little
Endianess of multi-byte pixel data for this stream.

• Big: Stream channel data is big Endian.
• Little: Stream channel data is little Endian.
3.38 DeviceStreamChannelPacketSize
Name DeviceStreamChannelPacketSize [DeviceStreamChannelSelector]
Level Recommended
Interface IInteger
Access Read/(Write)
Unit B
Visibility Expert
Values >0
Specifies the stream packet size, in bytes, to send on the selected channel for a Transmitter or
specifies the maximum packet size supported by a receiver.
3.39 DeviceMessageChannelCount
Name DeviceMessageChannelCount
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Indicates the number of message channels supported by the specified Link of the device.
2012-10-25 Page 79 of 366
3.40 DeviceCharacterSet
Name DeviceCharacterSet
Level Optional
Access Read
Unit -
Visibility Guru
Values UTF8
ASCII
Character set used by the strings of the device`s bootstrap registers.

• UTF8: Device use UTF8 character set.
• ASCII: Device use ASCII character set.
3.41 DeviceReset
Name DeviceReset
Level Recommended
Interface ICommand
Access Write
Unit -
Visibility Guru
Values -
Resets the device to its power up state.
3.42 DeviceIndicatorMode
Name DeviceIndicatorMode
Level Optional
Access Read/Write
Unit -
Visibility Expert
2012-10-25 Page 80 of 366

Values Inactive
Active
ErrorStatus
Controls the behavior of the indicators (such as LEDs) showing the status of the Device.
• Inactive: Device`s indicators are inactive (Off).

• Active: Device`s indicators are active showing their respective status.
• ErrorStatus: Device`s indicators are inactive unless an error occurs.
3.43 DeviceFeaturePersistenceStart
Name DeviceFeaturePersistenceStart
Level Optional
Interface ICommand
Access (Read)/Write
Unit -
Visibility Guru
Values -
Indicate to the device and GenICam XML to get ready for persisting of all streamable features.
Note that device persistence is done by reading the device features and saving them outside of the
device.
3.44 DeviceFeaturePersistenceEnd
Name DeviceFeaturePersistenceEnd
Level Optional
Interface ICommand
Access (Read)/Write
Unit -
Visibility Guru
Values -
Indicate to the device the end of feature persistence.
3.45 DeviceRegistersStreamingStart
Name DeviceRegistersStreamingStart
2012-10-25 Page 81 of 366

Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Guru
Values -
Prepare the device for registers streaming without checking for consistency.
If the camera implements this feature, GenApi guarantees using it to announce register streaming.
If the feature is present, but currently not writable (locked), the application must not start register
streaming and must avoid switching the access mode and range verification off until the feature
becomes writable again.
3.46 DeviceRegistersStreamingEnd
Name DeviceRegistersStreamingEnd
Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Guru
Values -
Announce the end of registers streaming. This will do a register set validation for consistency and
activate it. This will also update the DeviceRegistersValid flag.
3.47 DeviceRegistersCheck
Name DeviceRegistersCheck
Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Expert
Values -
2012-10-25 Page 82 of 366
Perform the validation of the current register set for consistency. This will update the
DeviceRegistersValid flag.
3.48 DeviceRegistersValid
Name DeviceRegistersValid
Level Recommended
Interface IBoolean
Access Read
Unit -
Visibility Expert
Values True
False
Returns if the current register set is valid and consistent.
3.49 DeviceTemperatureSelector
Name DeviceTemperatureSelector
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values Sensor
Mainboard
Device-specific
Selects the location within the device, where the temperature will be measured.
• Sensor: Temperature of the image sensor of the camera.
• Mainboard: Temperature of the device`s mainboard.
3.50 DeviceTemperature
Name DeviceTemperature[DeviceTemperatureSelector]
2012-10-25 Page 83 of 366

Level Optional
Interface IFloat
Access Read
Unit C
Visibility Expert
Values Device-specific
Device temperature in degrees Celsius (C). It is measured at the location selected by

DeviceTemperatureSelector.
3.51 DeviceClockSelector
Name DeviceClockSelector
Level Optional
Access Read/(Write)
Unit -
Visibility Expert
Values Sensor
SensorDigitization
CameraLink
Device-specific
Selects the clock frequency to access from the device.

• Sensor: Clock frequency of the image sensor of the camera.
• SensorDigitization: Clock frequency of the camera A/D conversion stage.
• CameraLink: Frequency of the Camera Link clock.
3.52 DeviceClockFrequency
Name DeviceClockFrequency[DeviceClockSelector]
Level Optional
Interface IFloat
Access Read/(Write)
Unit Hz
Visibility Expert
2012-10-25 Page 84 of 366
Values ≥0
Returns the frequency of the selected Clock.
3.53 DeviceSerialPortSelector
Name DeviceSerialPortSelector
Level Recommended
Access Read/(Write)
Unit -
Visibility Expert
Values CameraLink
Device-specific
Selects which serial port of the device to control.

• CameraLink: Serial port associated to the Camera link connection.
3.54 DeviceSerialPortBaudRate
Name DeviceSerialPortBaudRate[DeviceSerialPortSel
ector]
Level Recommended
Access Read/(Write)
Unit -
Visibility Expert
Values Baud9600
Baud19200
Baud38400
Baud57600
Baud115200
Baud230400
Baud460800
Baud921600
…
2012-10-25 Page 85 of 366

This feature controls the baud rate used by the selected serial port. Typical values listed should be
used whenever possible. Arbitrary values can also be used by defining new enumeration entries.
• Baud9600: Serial port speed of 9600 baud.
3.55 Timestamp
Name Timestamp
Level Recommended
Interface IInteger
Access Read
Unit ns
Visibility Expert
Values ≥0
Reports the current value of the device timestamp counter.

The same timestamp counter is used for tagging images, chunk and event data.
3.56 TimestampReset
Name TimestampReset
Level Optional
Interface ICommand
Access (Read)/Write
Unit -
Visibility Expert
Values -
Resets the current value of the device timestamp counter.

2012-10-25 Page 86 of 366
After executing this command, the timestamp counter restarts automatically.
2012-10-25 Page 87 of 366

4 Image Format Control

This chapter describes how to influence and determine the image size and format. It also provides
the necessary information to acquire and to display the image data. It assumes that the device has a
Source of data that generates a single rectangular image. This image can be entirely or partially
streamed out of the device using one or many Region of interest (ROI).
(0,0)
OffsetY
OffsetX
Region of Interest
HeightMax Height
Height.Max
Width
Width.Max
WidthMax
Figure 4-1: Image size and defining a Region of interest
The sensor provides SensorWidth time SensorHeight pixels.

Using BinningHorizontal and/or BinningVertical or DecimationHorizontal and/or
DecimationVertical the image is shrunk toWidthMax time HeightMax pixels.
In addition the features ReverseX and ReverseY can be used to flip the image respectively along
the X-axis or Y-axis. The flipping is done before the Region of interest is applied.
Within the shrunk image the user can set a Region of interest using the features OffsetX, OffsetY,
Width, and Height. The resulting image generated by the device has Width time Height pixels.
OffsetX and OffsetY are given with respect to the upper left corner of the image which has the
coordinate (0, 0), see Figure 4-1. If multiple Regions of interest are supported by the device, the
RegionSelector, RegionMode and RegionDestination features can be used to select and control
each Region individually.All measures are given in pixel. As a result the values should not change
if the PixelFormat changes. For monochrome cameras each pixel corresponds to one gray value.
For color camera in raw mode (Bayer pattern, etc.) each pixel corresponds to one pixel in the color
mask. For color cameras in RGB mode each pixel corresponds to one RGB triplet. For color
cameras in YUV mode each pixel corresponds to one Y value with the associated color information.
The feature Height describes the height of the image in lines. The pixels within a line are
contiguous. The lines however may be not contiguous, e.g. in order to yield a DWORD alignment.
LinePitch gives the number of bytes separating the starting pixels of two consecutive lines.
2012-10-25 Page 88 of 366

Each pixel in the image has a format defined by the PixelFormat feature. Only a subset of the
possible pixel formats is presented in this document. The complete list of possible standard pixel
formats and their layout can be found in the "Pixel Format naming Convention (PFNC) "
specification hosted by the AIA organization (see http://www.visiononline.org). .Because the
PixelFormat feature contains a mix of informations specified by the user and informations
provided by the device, it is suitable for describing the whole pixel settings but might be less
practical when individual setting must be set or inquired. Therefore a second set of features exists
composed of the individual components of PixelFormat. Those features are PixelCoding,
PixelSize, PixelColorFilter, PixelDynamicRangeMin and PixelDynamicRangeMax.
Even if the PixelFormat might allow for, e.g. 16 bits per pixel, the real image data might provide
only a certain range of value (e.g. 12 bits per pixel because the camera is equipped with a 12 bit
analog to digital converter only). In that case, PixelDynamicRangeMin and
PixelDynamicRangeMax specify the lower and upper limits of the pixel values in the image. In
general, PixelDynamicRangeMin should be zero and PixelDynamicRangeMax should be a power
[
of two ( 0, 2
DataDepth
]
− 1 ). There should be no missing codes in the range.
4.1 ImageFormatControl
Name ImageFormatControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Beginner
Values -
Category for Image Format Control features.
4.2 SensorWidth
Name SensorWidth
Category ImageFormatControl
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values >0
2012-10-25 Page 89 of 366

Effective width of the sensor in pixels.
4.3 SensorHeight
Name SensorHeight
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values >0
Effective height of the sensor in pixels.

For linescan sensor, this value is 1.
4.4 SensorTaps
Name SensorTaps
Level Optional
Access Read/(Write)
Unit -
Visibility Expert
Values One
Two
Three
Four
Eight
Ten
…
Device-specific
Number of taps of the camera sensor.

• One: 1 tap.
• Two: 2 taps.
• Three: 3 taps.
• Four: 4 taps.
2012-10-25 Page 90 of 366
• Eight: 8 taps.
• Ten: 10 taps.
4.5 SensorDigitizationTaps
Name SensorDigitizationTaps
Level Optional
Access Read/(Write)
Unit -
Visibility Expert
Values One
Two
Three
Four
Eight
Ten
…
Device-specific
Number of digitized samples outputted simultaneously by the camera A/D conversion stage.
• One: 1 tap.
• Two: 2 taps.
• Three: 3 taps.
• Four: 4 taps.
• Eight: 8 taps.
• Ten: 10 taps.
4.6 WidthMax
Name WidthMax
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
2012-10-25 Page 91 of 366

Values >0
Maximum width of the image (in pixels). The dimension is calculated after horizontal binning,
decimation or any other function changing the horizontal dimension of the image.
WidthMax does not take into account the current Region of interest (Width or OffsetX). Its value
must be greater than 0 and less than or equal to SensorWidth (unless an oversampling feature is
present).
4.7 HeightMax
Name HeightMax
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values >0
Maximum height of the image (in pixels). This dimension is calculated after vertical binning,
decimation or any other function changing the vertical dimension of the image
HeightMax does not take into account the current Region of interest (Height or OffsetY). Its value
must be greater than 0 and less than or equal to SensorHeight (unless an oversampling feature is
present).
4.8 RegionSelector
Name RegionSelector
Level Optional
Access Read/(Write)
Unit -
Visibility Beginner
Values Region0 (if 0 based)
Region1
Region2
…
All
2012-10-25 Page 92 of 366

Selects the Region of interest to control. The RegionSelector feature allows devices that are able to
extract multiple regions out of an image, to configure the features of those individual regions
independently.
• Region0: Selected feature will control the region 0.
• All: Selected features will control all the regions at the same time.
4.9 RegionMode
Name RegionMode[RegionSelector]
Level Optional
Access Read/Write
sUnit -
Visibility Beginner
Values Off
On
Controls if the selected Region of interest is active and streaming.

• Off: Disable the usage of the Region.
• On: Enable the usage of the Region.
4.10 RegionDestination
Name RegionDestination[RegionSelector]
Level Optional
Access Read/(Write)
Unit -
Visibility Expert
Values Stream0
Stream1
Stream2
…
2012-10-25 Page 93 of 366

Control the destination of the selected region.

• Stream0: The destination of the region is the data stream 0.
• …
4.11 Width
Name Width[RegionSelector]
Level Recommended
Interface IInteger
Access Read/(Write)
Unit -
Visibility Beginner
Values >0
Width of the image provided by the device (in pixels).

This reflects the current Region of interest. The maximum value of this feature takes into account
horizontal binning, decimation, or any other function changing the maximum horizontal dimensions
of the image and is typically equal to WidthMax - OffsetX.
This feature is generaly mandatory for transmitters and transceivers of most Transport Layers.
4.12 Height
Name Height[RegionSelector]
Level Recommended
Interface IInteger
Access Read/(Write)
Unit -
Visibility Beginner
Values >0
Height of the image provided by the device (in pixels).
2012-10-25 Page 94 of 366

This reflects the current Region of interest. The maximum value of this feature takes into account
vertical binning, decimation, or any other function changing the maximum vertical dimensions of
the image and is typically equal to HeightMax - OffsetY.
4.13 OffsetX
Name OffsetX[RegionSelector]
Level Recommended
Interface IInteger
Access Read/Write
Unit -
Visibility Beginner
Values ≥0
Horizontal offset from the origin to the region of interest (in pixels).
4.14 OffsetY
Name OffsetY[RegionSelector]
Level Recommended
Interface IInteger
Access Read/Write
Unit -
Visibility Beginner
Values ≥0
Vertical offset from the origin to the region of interest (in pixels).
4.15 LinePitch
Name LinePitch[RegionSelector]
Level Recommended
Interface IInteger
Access Read/Write
Unit B
Visibility Expert
2012-10-25 Page 95 of 366

Values ≥0
Total number of bytes between 2 successive lines. This feature is used to facilitate alignment of
image data.
This might be useful if the system has specific limitations, such as having the lines aligned on 32-
bit boundaries.
4.16 BinningSelector
Name BinningSelector
Level Optional
Access Read/(Write)
Unit -
Visibility Expert
Values Sensor
Region0 (if 0 based)
Region1
Region2
…
Selects which binning engine is controlled by the BinningHorizontal and BinningVertical features.
• Sensor: Selected features will control the sensor binning.
• Region0: Selected feature will control the region 0 binning.
4.17 BinningHorizontal
Name BinningHorizontal[BinningSelector]
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Values >0
2012-10-25 Page 96 of 366

Number of horizontal photo-sensitive cells to combine together. This increases the intensity (or
signal to noise ratio) of the pixels and reduces the horizontal resolution (width) of the image.
A value of 1 indicates that no horizontal binning is performed by the camera.
4.18 BinningVertical
Name BinningVertical[BinningSelector]
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Values >0
Number of vertical photo-sensitive cells to combine together. This increases the intensity (or signal
to noise ratio) of the pixels and reduces the vertical resolution (height) of the image.
A value of 1 indicates that no vertical binning is performed by the camera.
4.19 DecimationHorizontal
Name DecimationHorizontal
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Values ≥0
Horizontal sub-sampling of the image. This reduces the horizontal resolution (width) of the image
by the specified horizontal decimation factor.
This might be done by pixel dropping or by first applying a horizontal low-pass filter before pixel
dropping.
A value of 1 indicates that the camera performs no horizontal decimation.
4.20 DecimationVertical
Name DecimationVertical
2012-10-25 Page 97 of 366

Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Values ≥0
Vertical sub-sampling of the image. This reduces the vertical resolution (height) of the image by the
specified vertical decimation factor.
This might be implemented by pixel dropping or by first applying a vertical low-pass filter before
pixel dropping.
A value of 1 indicates that the camera performs no vertical decimation.
4.21 ReverseX
Name ReverseX
Level Recommended
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values True
False
Flip horizontally the image sent by the device. The Region of interest is applied after the flipping.
4.22 ReverseY
Name ReverseY
Level Recommended
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values True
False
2012-10-25 Page 98 of 366

Flip vertically the image sent by the device. The Region of interest is applied after the flipping.
4.23 PixelFormat
Name PixelFormat
Level Recommended
Access Read/(Write)
Unit -
Visibility Beginner
Values Mono1p
Mono2p
Mono4p
Mono8
Mono8s
Mono10
Mono10c3a64
Mono10c3p32
Mono10g12
Mono10msb
Mono10p
Mono10pmsb
Mono10s
Mono12
Mono12g
Mono12msb
Mono14
Mono16
R8
G8
B8
RGB8
RGB8_Planar
RGB8a32
RGBa8
RGB10
RGB10_Planar
RGB10g32
RGB10g32msb
RGB10p32
RGB10p32msb
RGB12
RGB12_Planar
RGB16
RGB16_Planar
2012-10-25 Page 99 of 366
RGB565p
BGR10
BGR12
BGR16
BGR565p
BGR8
BGRa8
YUV411_8
YUV422_8
YUV8
YCbCr411_8
YCbCr422_8
YCbCr601_411_8
YCbCr601_422_8
YCbCr601_8
YCbCr709_411_8
YCbCr709_422_8
YCbCr709_8
YCbCr8
BayerBG8
BayerGB8
BayerGR8
BayerRG8
BayerBG10
BayerBG10g12
BayerGB10
BayerGB10g12
BayerGR10
BayerGR10g12
BayerRG10
BayerRG10g12
BayerBG12
BayerBG12g
BayerGB12
BayerGB12g
BayerGR12
BayerGR12g
BayerRG12
BayerRG12g
BayerBG16
BayerGB16
BayerGR16
BayerRG16
Raw16
2012-10-25 Page 100 of 366
Raw8
Device-specific
- GigE Vision Specific:
Mono12Packed
BayerGR10Packed
BayerRG10Packed
BayerGB10Packed
BayerBG10Packed
BayerGR12Packed
BayerRG12Packed
BayerGB12Packed
BayerBG12Packed
RGB10V1Packed
BGR10V1Packed
RGB12V1Packed
- Deprecated:
Mono8Signed (Deprecated, use Mono10Packed

RGB8Packed (Deprecated, use RGB8)
BGR8Packed (Deprecated, use BGR8)
RGBA8Packed (Deprecated, use RGBa8)
BGRA8Packed (Deprecated, use BGRa8)
RGB10V2Packed (Deprecated, use RGB10p32)
BGR10V2Packed (Deprecated, use BGR10p32)
RGB565Packed (Deprecated, use RGB565p)
BGR565Packed (Deprecated, use BGR565p)
YUV411Packed (Deprecated, use YUV411_8_UYYVYY)
YUV422Packed (Deprecated, use YUV422_8_UYVY)
YUV444Packed (Deprecated, use YUV8_UYV)
YUYVPacked (Deprecated, use YUV422_8)
RGB8Planar (Deprecated, use RGB8_Planar)
Format of the pixels provided by the device. It represents all the information provided by
PixelCoding, PixelSize, PixelColorFilter combined in a single feature.
Note that only a subset of the possible pixel formats is listed here. The complete list of possible
standard pixel formats and their detailed layout can be found in the "Pixel Format Naming
2012-10-25 Page 101 of 366
Convention (PFNC)" specification hosted by the AIA organisation. Refer to the most recent version
of that convention for additional information about the construction of a pixel format name.
• Mono1p: Mono 1 bit packed.
• Mono8: Mono 8 bit packed.
• Mono8s: Mono 1 bit signed.
• Mono10: Mono 10 bit.
• Mono10c3a64: Mono 10 bit in 64 bit.
• Mono10c3p32: Mono 10 bit in 32bit.
• Mono10g12: Mono 10 bit grouped in 12 bit.
• Mono10msb: Mono 10 bit packed aligned on Msb.
• Mono10pmsb: Mono 10 bit packed aligned on Msb.
• Mono12g: Mono 12 bit grouped.
• Mono12msb: Mono 12 bit aligned on Msb.
• R8: Red 8 bit.
• G8: Green 8 bit.
• B8: Blue 8 bit.
• RGB8: Red, Green, Blue 8 bit
• RGB8_Planar: Red, Green, Blue 8 bit planar.
• RGB8a32: Red, Green, Blue 8 bit aligned in 32 bit pixel
• RGBa8: Red, Green, Blue 8 bit aligned on 8 bit
• RGB10: Red, Green, Blue 10 bit.
• RGB10g32: Red, Green, Blue 8 bit grouped in 32 bit pixel.
• RGB10g32msb: Red, Green, Blue 10 bit grouped in 32 bit pixel aligned on Msb.
• RGB10p32: Red, Green, Blue 10 bit packed in 32 bit pixel.
• RGB10p32msb: Red, Green, Blue 10 bit packed in 32 bit pixel.
2012-10-25 Page 102 of 366

• RGB565p: Red, Green, Blue 16 bit packet in 5, 6, 5 bits.
• BGR10: Blue, Green, Red, 10 bit.
• BGR565p: Blue, Green, Red, 16 bit packet in 5, 6, 5 bits.
• BGRa8: Blue, Green, Red, Alpha 8 bit.
• YUV411_8: YUV 411 8 bit.
• YUV422_8: YUV 422 8 bit.
• YUV8: YUV 8 bit.
• YCbCr411_8: YCrCb 411 8 bit.
• YCbCr601_411_8: YCrCb 601 411 8 bit.
• YCbCr601_422_8: YCrCb 601 422 8 bit.
• YCbCr709_411_8: YCrCb 709 411 8 bit.
• YCbCr709_422_8: YCrCb 709 422 8 bit.
• YCbCr8: YCbCr 8 bit.
• BayerBG8: Bayer Blue Green 8 bit.
• BayerGB8: Bayer Green Blue 8 bit.
• BayerGR8: Bayer Green Red 8 bit.
• BayerRG8: Bayer Red Green 8 bit.
• BayerBG10g12: Bayer Blue Green 8 bit grouped on 12 bit.
• BayerGB10g12: Bayer Green Blue 10 bit grouped on 12 bit.
• BayerGR10g12: Bayer Green Red 10 bit grouped on 12 bit.
2012-10-25 Page 103 of 366


• BayerRG10g12: Bayer Red Green 10 bit grouped on 12 bit.
• BayerBG12: Bayer Blue Green 12 bit
• BayerBG12g: Bayer Blue Green 12 bit grouped.
• BayerGB12: Bayer Green Blue 12 bit
• BayerGB12g: Bayer Green Blue 12 bit grouped on 12 bit.
• BayerGR12g: Bayer Green Red 12 bit grouped on 12 bit.
• BayerRG12g: Bayer Red Green 12 bit grouped on 12 bit.
• Raw16: Raw 16 bit.
• Raw8: Raw bit.
• Mono12Packed: Mono 12 bit packed (GigE Vision Specific).
• BayerGR10Packed: Bayer GR 10 bit packed (GigE Vision Specific).
• BayerRG10Packed: Bayer RG 10 bit packed (GigE Vision Specific).
• BayerGB10Packed: Bayer GB 10 bit packed (GigE Vision Specific).
• BayerBG10Packed: Bayer BG 10 bit packed (GigE Vision Specific).
• RGB10V1Packed: RGB 10 bit packed (GigE Vision Specific).
• BGR10V1Packed: BGR 10 bit packed (GigE Vision Specific).
The values of the enumeration entries are transport layer specific. Refer to the appropriate transport
layer specification for additional information.
2012-10-25 Page 104 of 366

4.24 PixelCoding (Deprecated)

Name PixelCoding
Level Recommended
Access Read/(Write)
Unit -
Visibility Expert
Values Mono
MonoSigned
MonoPacked
RGBPacked
BGRPacked
RGBAPacked
BGRAPacked
RGBPlanar
YUV411Packed
YUV422Packed
YUV444Packed
YUYVPacked
Raw
RawPacked
This feature is deprecated. It represents the coding of the pixels in the image. Raw gives the data in
the native format of the sensor.
• Mono: Mono.
• MonoSigned: Mono signed.
• MonoPacked: Mono packed.
• RGBPacked: RGB packed.
• BGRPacked: BGR packed.
• RGBAPacked: RGBA packed.
• BGRAPacked: BGRA packed.
• RGBPlanar: RGB planar.
• YUV411Packed: YUV 411 packed.
• YUYVPacked: YUYV packed.
2012-10-25 Page 105 of 366

• Raw: Raw.
• RawPacked: Raw packed.
Raw is mainly used for Bayer sensor. This value must always be coherent with the PixelFormat
feature.
4.25 PixelSize
Name PixelSize
Level Recommended
Access Read/(Write)
Unit -
Visibility Expert
Values Bpp1
Bpp2
Bpp4
Bpp8
Bpp10
Bpp12
Bpp14
Bpp16
Bpp24
Bpp30
Bpp32
Bpp36
Bpp48
Bpp64
Total size in bits of a pixel of the image.

This value must always be coherent with the PixelFormat feature.
• Bpp1: 1 bit per pixel.
• Bpp2: 2 bits per pixel.
2012-10-25 Page 106 of 366


4.26 PixelColorFilter
Name PixelColorFilter
Level Recommended
Access Read/(Write)
Unit -
Visibility Expert
Values None
BayerRG
BayerGB
BayerGR
BayerBG
Type of color filter that is applied to the image.

This value must always be coherent with the PixelFormat feature.
• None: No color filter.
• BayerRG: Bayer Red Green filter.
• BayerGB: Bayer Green Blue filter.
• BayerGR: Bayer Green Red filter.
• BayerBG: Bayer Blue Green filter.
4.27 PixelDynamicRangeMin
Name PixelDynamicRangeMin
Level Optional
Interface IInteger
Access Read/Write
2012-10-25 Page 107 of 366

Unit -
Visibility Expert
Minimum value that can be returned during the digitization process. This corresponds to the darkest
value of the camera. For color camera, this returns the smallest value that each color component can
take.
4.28 PixelDynamicRangeMax
Name PixelDynamicRangeMax
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Maximum value that will be returned during the digitization process. This corresponds to the
brightest value of the camera. For color camera, this returns the biggest value that each color
component can take.
4.29 TestPatternGeneratorSelector
Name TestPatternGeneratorSelector
Level Optional
Access Read/(Write)
Unit -
Visibility Beginner
Values Sensor
Region0 (if 0 based)
Region1
Region2
…
Selects which test pattern generator is controlled by the TestPattern feature.

2012-10-25 Page 108 of 366
• Sensor: TestPattern feature will control the sensor’s test pattern generator.
• Region0: TestPattern feature will control the region 0 test pattern generator.
4.30 TestPattern
Name TestPattern[TestPatternGeneratorSelector]
Level Optional
Access Read/Write
Unit -
Visibility Beginner
Values Off
Black
White
GreyHorizontalRamp
GreyVerticalRamp
GreyHorizontalRampMoving
GreyVerticalRampMoving
HorizontalLineMoving
VerticalLineMoving
ColorBar
FrameCounter
Device-specific
Selects the type of test pattern that is generated by the device as image source.
• Off: Image is coming from the sensor.
• Black: Image is filled with the darkest possible image.
• White: Image is filled with the brightest possible image.
• GreyHorizontalRamp: Image is filled horizontally with an image that goes from the
darkest possible value to the brightest.
• GreyVerticalRamp: Image is filled vertically with an image that goes from the darkest
possible value to the brightest.
• GreyHorizontalRampMoving: Image is filled horizontally with an image that goes from
the darkest possible value to the brightest and that moves horizontally from left to right at
each frame.
2012-10-25 Page 109 of 366

• GreyVerticalRampMoving: Image is filled vertically with an image that goes from the
darkest possible value to the brightest and that moves verticaly from top to bottom at each
frame.
• HorizontalLineMoving: A moving horizontal line is superimposed on the live image.
• VerticalLineMoving: A moving vertical line is superimposed on the live image.
• ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue,
Cyan, Magenta and Yellow.
• FrameCounter: A frame counter is superimposed on the live image.
Other values are device-specific and represent particular test images digitally generated by the
camera.
4.31 TestImageSelector (Deprecated)

Name TestImageSelector
Level Optional
Access Read/Write
Unit -
Values Off
Black
White
GreyHorizontalRamp
GreyVerticalRamp
GreyHorizontalRampMoving
GreyVerticalRampMoving
HorizontalLineMoving
VerticalLineMoving
ColorBar
FrameCounter
Device-specific
This feature is deprecated (see TestPattern). Selects the type of test image that is sent by the device.
• Off: Image is coming from the sensor.
• Black: Image is filled with the darkest possible image.
• White: Image is filled with the brightest possible image.
2012-10-25 Page 110 of 366

• GreyHorizontalRamp: Image is filled horizontally with an image that goes from the
darkest possible value to the brightest.
• GreyVerticalRamp: Image is filled vertically with an image that goes from the darkest
possible value to the brightest.
• GreyHorizontalRampMoving: Image is filled horizontally with an image that goes from
the darkest possible value to the brightest and that moves horizontally from left to right at
each frame.
• GreyVerticalRampMoving: Image is filled vertically with an image that goes from the
darkest possible value to the brightest and that moves verticaly from top to bottom at each
frame.
• HorizontalLineMoving: A moving horizontal line is superimposed on the live image.
• VerticalLineMoving: A moving vertical line is superimposed on the live image.
• ColorBar: Image is filled with stripes of color including White, Black, Red, Green, Blue,
Cyan, Magenta and Yellow.
• FrameCounter: A frame counter is superimposed on the live image.
Other values are device-specific and represent particular test images digitally generated by the
camera.
4.32 Deinterlacing
Name Deinterlacing
Level Optional
Access Read/Write
Unit -
Visibility Beginner
Values Off
LineDuplication
Weave
…
Device-specific
Controls how the device performs de-interlacing.

• Off: The device doesn`t perform de-interlacing.
• LineDuplication: The device performs de-interlacing by outputting each line of each field
twice.
• Weave: The device performs de-interlacing by interleaving the lines of all fields.
2012-10-25 Page 111 of 366

4.33 Image Compression

This section describes the feature related to image compression.
4.33.1 ImageCompressionMode
Name ImageCompressionMode
Level Optional
Access Read/Write
Visibility Beginner
Unit -
Values Off
JPEG
JPEG2000
H264
…
Device-specific
Enable a specific image compression mode as the base mode for image transfer. Optionally, chunk
data can be appended to the compressed image (see chunk section).
• Off: Default value. Image compression is disabled. Images are transmitted uncompressed.
• JPEG: JPEG compression is selected.
• JPEG2000: JPEG 2000 compression is selected.
• H264: H.264 compression is selected.
4.33.2 ImageCompressionRateOption
Name ImageCompressionRateOption
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values FixBitrate
FixQuality
…
Device-specific
2012-10-25 Page 112 of 366

Two rate controlling options are offered: fixed bit rate or fixed quality. The exact implementation to
achieve one or the other is vendor-specific.
Note that not all compression techniques or implementations may support this feature.
• FixBitrate: Output stream follows a constant bit rate. Allows easy bandwidth management
on the link.
• FixQuality: Output stream has a constant image quality. Can be used when image
processing algorithms are sensitive to image degradation caused by excessive data
compression.
4.33.3 ImageCompressionQuality
Name ImageCompressionQuality
Level Optional
Interface IInteger
Access Read/(Write)
Unit -
Visibility Expert
Control the quality of the produced compressed stream.

This feature is available when ImageCompressionRateOption is equal to FixQuality or if the device
only supports the FixQuality mode.
The list of valid values is device-specific. A higher value means a better quality for the produced
compressed stream.
4.33.4 ImageCompressionBitrate
Name ImageCompressionBitrate
Level Optional
Interface IFloat
Access Read/(Write)
Unit Mbps
Visibility Expert
Control the rate of the produced compressed stream.

2012-10-25 Page 113 of 366
This feature is available when ImageCompressionRateOption is equals to FixBitrate or if the device

only supports the FixBitrate mode.
The list of valid values is device specific.
4.33.5 ImageCompressionJPEGFormatOption
Name ImageCompressionJPEGFormatOption
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values Lossless
BaselineStandard
BaselineOptimized
Progressive
…
Device-specific
When JPEG is selected as the compression format, a device might optionally offer better control
over JPEG-specific options through this feature.
• Lossless: Selects lossless JPEG compression based on a predictive coding model.
• BaselineStandard: Indicates this is a baseline sequential (single-scan) DCT-based JPEG.
• BaselineOptimized: Provides optimized color and slightly better compression than baseline
standard by using custom Huffman tables optimized after statistical analysis of the image
content.
• Progressive: Indicates this is a progressive (multi-scan) DCT-based JPEG.
2012-10-25 Page 114 of 366

5 Acquisition Control
The Acquisition Control chapter describes all features related to image acquisition, including the
trigger and exposure control. It describes the basic model for acquisition and the typical behavior of
the device.
5.1 Acquisition related vocabulary and signals
This section describes the vocabulary and terms used to describe and name the acquisition related
features. It also defines the acquisition related signals and their position in time during the
acquisition of images by a device.
An Acquisition is composed of one or many Frames made of Line(s). The Frames of an
Acquisition can optionally be grouped in smaller Bursts that are triggered individually. An
Acquisition is defined as the capture of a sequence of one or many Frame(s) (see Figure 5-1).
The transfer of the frame(s) of an Acquisition starts with the beginning of the transfer of the first
frame and ends with the completion of the transfer of the last one.
Figure 5-1: Acquisition signals definition
AcquisitionStart
Trigger
Frame 1 Frame 2 … Frame N
(optional)
(optional) (optional)
AcquisitionStart AcquisitionEnd
AcquisitionActive
Frame Frame … Frame N

Transfer 1 Transfer 2 Transfer N
AcquisitionTransferStart AcquisitionTransferEnd
AcquisitionTransfer
2012-10-25 Page 115 of 366

A Burst of Frame(s) is defined as the capture of a group of one or many Frame(s) within an
Acquisition (see Figure 5-2). If a FrameBurstStart or FrameBurstActive trigger is enabled (its
TriggerMode=On), an acquisition can be broken in many smaller Bursts. In this case, each Burst
has its own trigger. If only the FrameBurstStart trigger is enabled,
AcquisitionBurstFrameCount determines the length of each burst. If the FrameBurstStart and
FrameBurstEnd triggers are enabled, they are used to delimit the length of every single burst. If
the FrameBurstActive trigger is enabled, it determines the length of each individual burst (the
burst lasts as long as the trigger is asserted).
The transfer of the frame(s) of a burst starts with the beginning of the transfer of the first frame of
the burst and end with the completion of the transfer of the last one.
Figure 5-2: Burst signals definition
Frame 1 Frame 2 … Frame N Frame 1 Frame 2 … Frame N

(optional) (optional) (optional) (optional)
(optional) …
…
FrameBurstStart FrameBurstEnd FrameBurstStart FrameBurstEnd

Trigger 1 Trigger 1 (optional) Trigger N Trigger N
(optional)
AcquisitionActive
Frame 1 Frame 2 … Frame N Frame 1 Frame 2 … Frame N

Transfer Transfer Transfer Transfer Transfer 1 Transfer
…
…
FrameBurstTransferStart FrameBurstTransferEnd FrameBurstTransferStart FrameBurstTransferEnd

1 1 N N
AcquisitionTransfer
2012-10-25 Page 116 of 366

A Frame is defined as the capture of Width pixels x Height lines. A Frame starts with an optional
Exposure period and ends with the completion of the sensor read out. Generally, a transfer period
will start during the sensor read out and will finish sometime after it but it is not considered as part
of the Frame.
Figure 5-3: Frame signals definition
Frame 1:
FrameStart Exposure 1 Sensor ReadOut 1

Trigger
FrameStart ExposureEnd FrameEnd

and
ExposureStart
ExposureActive
FrameActive
Transfer 1
FrameTransferStart FrameTransferEnd
FrameTransfer
Frame 2:
FrameStart Exposure 2 Sensor ReadOut 2

Trigger
Transfer 2
2012-10-25 Page 117 of 366

For Line Scan acquisition, the definition of Frame stays the same but the exposure and read out are
done for each line of the virtual Frame.
Figure 5-4: Frame signals definitions in Line Scan mode
Line 1:
LineStart Exposure 1 ReadOut 1

Trigger
LineStart and ExposureEnd LineEnd

ExposureStart
ExposureActive
LineActive
Transfer 1
LineTransferStart LineTransferEnd
FrameActive
LineTransfer
Line 2:
LineStart Exposure 2 ReadOut 2

Trigger
Transfer 2
Line 3:
LineStart Exposure 3 …
Trigger
2012-10-25 Page 118 of 366

5.2 Acquisition features usage model
The AcquisitionMode controls the mode of acquisition for the device. This mainly affects the
number of frames captured in the Acquisition (SingleFrame, MultiFrame or Continuous).
The optional AcquisitionArm command is used to verify and freeze all parameters relevant for the
image data capture. It prepares the device for the AcquisitionStart.
The AcquisitionStart command is used to start the Acquisition.
The AcquisitionStop command will stop the Acquisition at the end of the current Frame. It can be
used in any acquisition mode and if the camera is waiting for a trigger, the pending Frame will be
cancelled.
The AcquisitionAbort command can be used to abort an Acquisition at any time. This will end the
capture immediately without completing the current Frame.
AcquisitionFrameCount controls the number of frames that will be captured when
AcquisitionMode is MultiFrame.
AcquisitionBurstFrameCount determines the length of each burst to capture if the
FrameBurstStart trigger is enabled and the FrameBurstEnd trigger is disabled.
AcquisitionFrameRate controls the rate at which the Frames are captured when TriggerMode is
Off.
AcquisitionLineRate controls the rate at which the Lines in each Frame are captured when
TriggerMode is Off. This is generally useful for line scan cameras.
AcquisitionStatusSelector and AcquisitionStatus can be used to read the status of the internal
acquisition signals. The standard acquisition signals Status are: AcquisitionTriggerWait,
AcquisitionActive, AcquisitionTransfer, FrameTriggerWait, FrameActive, ExposureActive
(see Figure 5-1 and Figure 5-3).
See the Acquisition and Trigger Examples section of this document for more complete use cases
of the acquisition and trigger features in conjunction with other related sections such as I/O and
analog controls.
2012-10-25 Page 119 of 366

5.3 Acquisition timing diagrams
This section gives the timing diagrams and features setting order for the most common acquisition scenarios.
Figure 5-5: Continuous Acquisition
AcquisitionMode = Continuous;
TriggerSelector = AcquisitionStart;
AcquisitionStop (); TLParamsLocked = 1;
TriggerMode = Off;
TLParamsLocked = 0; AcquisitionStart ();
TLParamsLocked = 1;
AcquisitionStart ();
Frame 1 Frame 2 c c Frame N Frame N + 1 c c
Frames are acquired as soon as

AcquisitionStop is received,
available.
finishing the current Frame. Frames are acquired as soon as
available.
Figure 5-6: Continuous Acquisition with AcquisitionStart trigger
2012-10-25 Page 120 of 366

TriggerMode = On; AcquisitionStop ();
TriggerSource = Line1; TLParamsLocked = 0;
TLParamsLocked = 1;
Line1 Trigger
Frame 1 Frame 2 c c Frame N
Frames are acquired as soon as AcquisitionStop is received,

available after the trigger. finishing the current Frame.
Only one trigger is expected. Extra
triggers are ignored.
2012-10-25 Page 121 of 366

Figure 5-7: Continuous Acquisition with FrameStart trigger
TriggerSelector = FrameStart;
TLParamsLocked = 1;
Line1 Trigger Line1 Trigger Line1 Trigger
1 2 N
Frame 1 Frame 2 c c Frame N
1 Frame is acquired as soon as available AcquisitionStop is received, finishing

after each trigger. the current Frame.
One trigger is needed per Frame.
2012-10-25 Page 122 of 366

Figure 5-8: Continuous Acquisition with FrameBurstStart trigger
AcquisitionBurstFrameCount = 2;
TriggerSelector = FrameBurstStart;
AcquisitionStop ();
TriggerMode = On;
TLParamsLocked = 0;
TriggerSource = Line1;
TLParamsLocked = 1;
Line1 Trigger Line1 Trigger
1 2
Frame 1 Frame 2 Frame 3 Frame 4
For each trigger, 2 Frames are acquired finishing the current Frame.
as soon as available .
2012-10-25 Page 123 of 366

Figure 5-9: MultiFrame Acquisition
AcquisitionMode = MultiFrame;
AcquisitionFrameCount = 2;
TriggerSelector = AcquisitionStart; TLParamsLocked = 1;
TriggerMode = Off; AcquisitionStart ();
TLParamsLocked = 1;
AcquisitionStop (); AcquisitionStop ();
TLParamsLocked = 0; TLParamsLocked = 0;
Frame 1 Frame 2 Frame 3 Frame 4 Frame 5
2 Frames are acquired as soon as 2 Frames are acquired as soon as finishing the current Frame.
available. available.
Frame 6 is not acquired.
AcquisitionStop is optional. AcquisitionStop is optional.
2012-10-25 Page 124 of 366

Figure 5-10: Multi Frame Acquisition with AcquisitionStart trigger
TriggerMode = On; AcquisitionStart ();
TLParamsLocked = 1;
TLParamsLocked = 0;
1 2
2 Frames are acquired as soon as

available for each trigger.
AcquisitionStop is optional.
2012-10-25 Page 125 of 366

Figure 5-11: Multi Frame Acquisition with FrameStart trigger
TriggerMode = On; AcquisitionStart ();
TriggerSource = Line1; TLParamsLocked
TLParamsLocked = 1; = 0;
Line1 Trigger Line1 Trigger Line1 Trigger Line1 Trigger
1 2 3 4
2 Frames are acquired. A trigger is

necessary for each of them.
2012-10-25 Page 126 of 366

Figure 5-12: Multi Frame Acquisition with FrameBurstStart trigger
AcquisitionFrameBurstCount = 2;
TriggerMode = On; TLParamsLocked = 0;
TLParamsLocked = 1;
1 2
Frame 1 Frame 2 Frame 3
AcqusitionFrameCount frames were

captured so the acquisition stops even
if the last bursts is incomplete..
For each trigger, 2 Frames are acquired Therefore Frame 4 is not acquired.
as soon as available .
2012-10-25 Page 127 of 366

Figure 5-13: Single Frame Acquisition
TLParamsLocked = 0;
AcquisitionMode = SingleFrame;
AcquisitionStop (); TLParamsLocked = 1; TLParamsLocked = 1;
TriggerMode = Off;
TLParamsLocked = 0; AcquisitionStart (); AcquisitionStart ();
TLParamsLocked = 1;
AcquisitionStart (); AcquisitionStop ();
TLParamsLocked = 0;
Frame 1 Frame 2
AcqusitionStop is
received before a Frame
AcquisitionStop is optional. is available. The device
TLParamsLocked = 0 is 1 Frame is acquired as soon as needs to stop as soon as
1 Frame is acquired as soon as available. possible on a frame
optional if no locked
available. boundary. Therefore it is
features are changed before AcquisitionStop is optional. possible that no frame is
the next AcquisitionStart acquired.
2012-10-25 Page 128 of 366

Figure 5-14: Single Frame Acquisition with AcquisitionStart trigger
AcquisitionStart (); AcquisitionStart ();
TLParamsLocked = 1;
1 2 3
1 Frame is acquired as soon as available

for each trigger
2012-10-25 Page 129 of 366

Figure 5-15: Single Frame Acquisition with FrameStart trigger
AcquisitionStart (); AcquisitionStart ();
TLParamsLocked = 1;
1 2 3
1 Frame is acquired as soon as available

for each trigger
2012-10-25 Page 130 of 366

5.4 Acquisition Control features
This section gives the detailed description of all the Acquisition related features.
5.4.1 AcquisitionControl
Name AcquisitionControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Beginner
Values -
Category for the acquisition and trigger control features.
5.4.2 AcquisitionMode
Name AcquisitionMode
Category AcquisitionControl
Level Recommended
Access Read/(Write)
Unit -
Visibility Beginner
Values SingleFrame
MultiFrame
Continuous
Sets the acquisition mode of the device. It defines mainly the number of frames to capture during
an acquisition and the way the acquisition stops.
• SingleFrame: One frame is captured.
2012-10-25 Page 131 of 366

• MultiFrame: The number of frames specified by AcquisitionFrameCount is captured.

• Continuous: Frames are captured continuously until stopped with the AcquisitionStop
command.
5.4.3 AcquisitionStart
Name AcquisitionStart
Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Beginner
Values -
Starts the Acquisition of the device. The number of frames captured is specified by
AcquisitionMode.
The Acquisition might be conditioned by various triggers (see Trigger… features). An
AcquisitionStart command must be sent to the device before the acquisition related triggers
become effective.
Note that unless the AcquisitionArm was executed since the last feature change, the
AcquisitionStart command must validate all the current features for consistency before starting
the Acquisition. This validation will not be repeated for the subsequent acquisitions unless a
feature is changed in the device.
If the AcquisitionStart feature is currently not writable (locked), the application must not start the
acquisition and must avoid using the feature until the feature becomes writable again.
5.4.4 AcquisitionStop
Name AcquisitionStop
Level Recommended
Interface ICommand
Access (Read)/Write
2012-10-25 Page 132 of 366

Unit -
Visibility Beginner
Values -
Stops the Acquisition of the device at the end of the current Frame. It is mainly used when
AcquisitionMode is Continuous but can be used in any acquisition mode.
If the camera is waiting for a trigger, the pending Frame will be cancelled. If no Acquisition is in
progress, the command is ignored.
5.4.5 AcquisitionAbort
Name AcquisitionAbort
Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Expert
Values -
Aborts the Acquisition immediately. This will end the capture without completing the current
Frame or waiting on a trigger. If no Acquisition is in progress, the command is ignored.
5.4.6 AcquisitionArm
Name AcquisitionArm
Level Optional
Interface ICommand
Access (Read)/Write
Unit -
Visibility Expert
Values -
2012-10-25 Page 133 of 366

Arms the device before an AcquisitionStart command. This optional command validates all the
current features for consistency and prepares the device for a fast start of the Acquisition.
If not used explicitly, this command will be automatically executed at the first AcquisitionStart
but will not be repeated for the subsequent ones unless a feature is changed in the device.
5.4.7 AcquisitionFrameCount
Name AcquisitionFrameCount
Level Recommended
Interface IInteger
Access Read/Write
Unit -
Visibility Beginner
Values ≥1
Number of frames to acquire in MultiFrame Acquisition mode.
5.4.8 AcquisitionBurstFrameCount
Name AcquisitionBurstFrameCount
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Beginner
Values ≥1
Number of frames to acquire for each FrameBurstStart trigger.

This feature is used only if the FrameBurstStart trigger is enabled and the FrameBurstEnd trigger
is disabled. Note that the total number of frames captured is also conditioned by
AcquisitionFrameCount if AcquisitionMode is MultiFrame and ignored if AcquisitionMode is
Single.
2012-10-25 Page 134 of 366

5.4.9 AcquisitionFrameRate
Name AcquisitionFrameRate
Level Recommended
Interface IFloat
Access Read/Write
Unit Hz
Visibility Beginner
Controls the acquisition rate (in Hertz) at which the frames are captured.
TriggerMode must be Off for the Frame trigger.
5.4.10 AcquisitionLineRate
Name AcquisitionLineRate
Level Recommended
Interface IFloat
Access Read/Write
Unit Hz
Visibility Beginner
Controls the rate (in Hertz) at which the Lines in a Frame are captured.
TriggerMode must be Off for the Line trigger.
This is generally useful for line scan camera only.
5.4.11 AcquisitionStatusSelector
Name AcquisitionStatusSelector
Level Recommended
2012-10-25 Page 135 of 366

Access Read/Write
Unit -
Visibility Expert
Values AcquisitionTriggerWait
AcquisitionActive
AcquisitionTransfer
FrameTriggerWait
FrameActive
ExposureActive
FrameTransfer (deprecated)
Selects the internal acquisition signal to read using AcquisitionStatus.

See Figure 5-1 and Figure 5-3 for details.Possible values are:
• AcquisitionTriggerWait: Device is currently waiting for a trigger for the capture of one
or many frames.
• AcquisitionActive: Device is currently doing an acquisition of one or many frames.
• AcquisitionTransfer: Device is currently transferring an acquisition of one or many
frames.
• FrameTriggerWait: Device is currently waiting for a frame start trigger.
• FrameActive: Device is currently doing the capture of a frame.
• ExposureActive: Device is doing the exposure of a frame.
• FrameTransfer (deprecated): See TransferStatus.
5.4.12 AcquisitionStatus
Name AcquisitionStatus[AcquisitionStatusSelector]
Level Recommended
Interface IBoolean
Access Read
Unit -
Visibility Expert
Values True
False
2012-10-25 Page 136 of 366

Reads the state of the internal acquisition signal selected using AcquisitionStatusSelector.
2012-10-25 Page 137 of 366

5.5 Trigger Control features
The Trigger Control section describes all features related to image acquisition using trigger(s).
One or many Trigger(s) can be used to control the start of an Acquisition (Figure 5-1), of a
Burst of Frames (Figure 5-2), of individual Frames (Figure 5-3) or of each Line of a Frame for
a line scan device (Figure 5-4). Triggers can also be used to control the exposure duration at the
beginning of a frame.
TriggerSelector is used to select which type of trigger to configure. The standard trigger types
are: AcquisitionStart, AcquisitionEnd, AcquisitionActive, FrameBurstStart,
FrameBurstEnd, FrameBurstActive, FrameStart, FrameEnd, FrameActive, LineStart,
ExposureStart, ExposureEnd and ExposureActive.
TriggerMode activate/desactivate trigger operation. It can be On or Off.
TriggerSource specifies the physical input Line or internal signal to use for the selected trigger.
Standard trigger sources are: Software, Line0, Line1, …, Counter0Start, Counter0End, …,
Timer0Start, Timer0End, , …, UserOutput0, UserOutput1, …, Action0, Action1, …
With a Software trigger source, the TriggerSoftware command can be used by an application to
generate an internal trigger signal.
With the hardware trigger sources, TriggerActivation specifies the activation mode of the
trigger. This can be a RisingEdge, FallingEdge, AnyEdge, LevelHigh or LevelLow.
TriggerOverlap specifies the type of trigger overlap permitted with the previous frame. This
defines when a valid trigger will be accepted (or latched) for a new frame. This can be Off for no
overlap, ReadOut to accept a trigger immediately after the exposure period or PreviousFrame to
accept (latch) a trigger that happened at any time after the start of the previous frame.
TriggerDelay specifies the delay to apply after the trigger signal reception before effectively
activating it.
TriggerDivider and TriggerMultiplier are used to control the ratio of triggers that are accepted.
Note that, a trigger is considered valid after the Dividers, Multipliers, Delay, ...
For example to setup a hardware triggered acquisition that will start the capture of each frame on
the rising edge of the signal coming from the physical input Line 1, the following pseudo-code
can be used:
Camera.TriggerSelector = FrameStart;
Camera.TriggerMode = On;
Camera.TriggerActivation = RisingEdge;
Camera.TriggerSource = Line1;
2012-10-25 Page 138 of 366

See also the Acquisition and Trigger Examples for more complete use cases of the acquisition
and trigger features in conjunction with other related sections such as I/O.
The drawing below shows the functional model of the trigger generation in SFNC.
It shows the order and the stages that an input signal received on an external line may pass to
become a valid trigger (Ex: a FrameTrigger).
Note that the signal received on an external line or generated from an internal circuit is
considered a valid trigger for the Acquisition section only after passing all those stages (if they re
implemented).
Input Line Trigger Trigger Trigger Trigger Valid

Signal I/O Mode/ Divider/ Delay Overlap Trigger
Control Activation Multiplier Control
Figure 5-16: Trigger generation functional model.
- Input Signal represents an electrical signal received on an external Line or an internal

signal.
- Line I/O Control represents the Line Control Block as described in the Figure 6-1.
- Trigger Mode/Activation represents the effect of the TriggerMode and TriggerActivation
features.
- Trigger Divider/Multiplier represents the effect of the TriggerDivider and
TriggerMultiplier features.
- Trigger Delay represents the effect of the TriggerDelay feature
- Trigger Overlap Control represents the effect of the TriggerOverlap feature.
- Valid Trigger represent when an incoming signal becomes a valid Trigger.
5.5.1 TriggerSelector
Name TriggerSelector
Level Recommended
Access Read/Write
Unit -
Visibility Beginner
Values AcquisitionStart
2012-10-25 Page 139 of 366

AcquisitionEnd
AcquisitionActive
FrameStart
FrameEnd
FrameActive
FrameBurstStart
FrameBurstEnd
FrameBurstActive
LineStart
ExposureStart
ExposureEnd
ExposureActive
Selects the type of trigger to configure.

See Figure 5-1 and Figure 5-3for details.
• AcquisitionStart: Selects a trigger that starts the Acquisition of one or many frames
according to AcquisitionMode.
• AcquisitionEnd: Selects a trigger that ends the Acquisition of one or many frames
according to AcquisitionMode.
• AcquisitionActive: Selects a trigger that controls the duration of the Acquisition of one or
many frames. The Acquisition is activated when the trigger signal becomes active and
terminated when it goes back to the inactive state.
• FrameStart: Selects a trigger starting the capture of one frame.
• FrameEnd: Selects a trigger ending the capture of one frame (mainly used in line scan
mode).
• FrameActive: Selects a trigger controlling the duration of one frame (mainly used in line
scan mode).
• FrameBurstStart: Selects a trigger starting the capture of the bursts of frames in an
acquisition. AcquisitionBurstFrameCount controls the length of each burst unless a
FrameBurstEnd trigger is active. The total number of frames captured is also conditioned
by AcquisitionFrameCount if AcquisitionMode is MultiFrame.
• FrameBurstEnd: Selects a trigger ending the capture of the bursts of frames in an
acquisition.
• FrameBurstActive: Selects a trigger controlling the duration of the capture of the bursts
of frames in an acquisition.
• LineStart: Selects a trigger starting the capture of one Line of a Frame (mainly used in
line scan mode).
2012-10-25 Page 140 of 366
• ExposureStart: Selects a trigger controlling the start of the exposure of one Frame (or
Line).
• ExposureEnd: Selects a trigger controlling the end of the exposure of one Frame (or
Line).
• ExposureActive: Selects a trigger controlling the duration of the exposure of one frame
(or Line).
5.5.2 TriggerMode
Name TriggerMode[TriggerSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Beginner
Values Off
On
Controls if the selected trigger is active.

• Off: Disables the selected trigger.
• On: Enable the selected trigger.
5.5.3 TriggerSoftware
Name TriggerSoftware[TriggerSelector]
Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Beginner
Values -
2012-10-25 Page 141 of 366

Generates an internal trigger. TriggerSource must be set to Software.
5.5.4 TriggerSource
Name TriggerSource[TriggerSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Beginner
Values Software
Line0 (If 0 based), Line1, Line2,
…
Counter0Start (If 0 based),
Counter1Start, Counter2Start, …
Counter0End (If 0 based),
Counter1End, Counter2End, …
Timer0Start (If 0 based),
Timer1Start, Timer2Start, …
Timer0End (If 0 based),
Timer1End, Timer2End, …
UserOutput0, UserOutput1,
UserOutput2, ...
Action0 (If 0 based), Action1,
Action2, …
CC1, CC2, CC3, CC4,
…
Specifies the internal signal or physical input Line to use as the trigger source. The selected
trigger must have its TriggerMode set to On.
• Software: Specifies that the trigger source will be generated by software using the
TriggerSoftware command.
• Line0 , Line1, Line2, …: Specifies which physical line (or pin) and associated I/O
control block to use as external source for the trigger signal.
2012-10-25 Page 142 of 366

• Counter0Start, Counter1Start, Counter2Start, …, Counter0End, Counter1End,

Counter2End, …: Specifies which of the Counter signal to use as internal source for the
trigger.
• Timer0Start, Timer1Start, Timer2Start, …, Timer0End, Timer1End, Timer2End,
…: Specifies which Timer signal to use as internal source for the trigger.
• UserOutput0, UserOutput1, UserOutput2, …: Specifies which User Output bit signal
to use as internal source for the trigger.
• Action0, Action1, Action2, …: Specifies which Action command to use as internal
source for the trigger.
• CC1, CC2, CC3, CC4: Index of the Camera Link physical line and associated I/O control
block to use. This ensures a direct mapping between the lines on the frame grabber and on
the camera. Applicable to CameraLink products only.
5.5.5 TriggerActivation
Name TriggerActivation[TriggerSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Beginner
Values RisingEdge
FallingEdge
AnyEdge
LevelHigh
LevelLow
Specifies the activation mode of the trigger.

• RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source
signal.
• FallingEdge: Specifies that the trigger is considered valid on the falling edge of the
source signal.
• AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the
source signal.
2012-10-25 Page 143 of 366

• LevelHigh: Specifies that the trigger is considered valid as long as the level of the source
signal is high.
• LevelLow: Specifies that the trigger is considered valid as long as the level of the source
signal is low.
5.5.6 TriggerOverlap
Name TriggerOverlap[TriggerSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Off
ReadOut
PreviousFrame
Specifies the type trigger overlap permitted with the previous frame. This defines when a valid
trigger will be accepted (or latched) for a new frame.
• Off: No trigger overlap is permitted.
• ReadOut: Trigger is accepted immediately after the exposure period.
• PreviousFrame: Trigger is accepted (latched) at any time during the capture of the
previous frame.
5.5.7 TriggerDelay
Name TriggerDelay[TriggerSelector]
Level Recommended
Interface IFloat
Access Read/Write
Unit us
Visibility Expert
2012-10-25 Page 144 of 366

Specifies the delay in microseconds (us) to apply after the trigger reception before activating it.
5.5.8 TriggerDivider
Name TriggerDivider[TriggerSelector]
Level Recommended
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Specifies a division factor for the incoming trigger pulses.
5.5.9 TriggerMultiplier
Name TriggerMultiplier[TriggerSelector]
Level Recommended
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Specifies a multiplication factor for the incoming trigger pulses. It is used generally used in
conjunction with TriggerDivider to control the ratio of triggers that are accepted.
2012-10-25 Page 145 of 366

5.6 Exposure Control features
The Exposure Control section describes all features related to the exposure of the photosensitive
cells (shutter control) during image acquisition.
The Exposure of the photosensitive cells during Frame or Line acquisition can be in 3 differents
modes.
• ExposureMode can be Off to disable the Shutter and let it open.
• ExposureMode can be Timed to have a timed exposure and allow programming the
duration using the ExposureTime or ExposureAuto features.
For example to have a fixed exposure time of 1 milisecond, use the following pseudo
code:
Camera.ExposureMode = Timed;
Camera.ExposureTime = 1000;
• ExposureMode can be TriggerWidth to use the width of the current Frame or Line
trigger signal(s) to control exposure duration.
• ExposureMode can be TriggerControlled to use one or more trigger signal(s) to control
the exposure duration independently from the current Frame or Line triggers (See
ExposureStart, ExposureEnd and ExposureActive of the TriggerSelector feature).
For example: To use 2 hardware triggers respectively starting and stopping the Exposure,
use the following pseudo code:
Camera.ExposureMode = TriggerControlled;
Camera.TriggerSelector = ExposureStart;
Camera.TriggerSelector = ExposureEnd;
5.6.1 ExposureMode
Name ExposureMode
Level Recommended
2012-10-25 Page 146 of 366

Access Read/Write
Unit -
Visibility Beginner
Values Off
Timed
TriggerWidth
TriggerControlled
Sets the operation mode of the Exposure (or shutter).

• Off: Disables the Exposure and let the shutter open.
• Timed: Timed exposure. The exposure duration time is set using the ExposureTime or
ExposureAuto features and the exposure starts with the FrameStart or LineStart (see
Figure 5-3 and Figure 5-4).
• TriggerWidth: Uses the width of the current Frame or Line trigger signal(s) pulse to
control the exposure duration. Note that if the Frame or Line TriggerActivation is
RisingEdge or LevelHigh, the exposure duration will be the time the trigger stays High. If
TriggerActivation is FallingEdge or LevelLow, the exposure time will last as long as the
trigger stays Low.
• TriggerControlled: Uses one or more trigger signal(s) to control the exposure duration
independently from the current Frame or Line triggers. See ExposureStart,
ExposureEnd and ExposureActive of the TriggerSelector feature.
Note also that ExposureMode as priority over the Exposure Trigger settings defined using
TriggerSelector=Exposure… and defines which trigger (if any) is active.
For example, if:
ExposureMode = Timed;
ExposureTime = 200;
Then the Exposure will be controlled using the ExposureTime Feature, even if the following
code is done:
TriggerSelector = ExposureActive;
TriggerMode = On;
TriggerActivation = LevelHigh;
2012-10-25 Page 147 of 366

But simply by adding:

ExposureMode = TriggerControlled;
The Exposure duration will become controlled by the length of the positive pulse on physical
Line 1.
5.6.2 ExposureTime
Name ExposureTime
Level Recommended
Interface IFloat
Access Read/Write
Unit us
Visibility Beginner
Values ≥0
Sets the Exposure time when ExposureMode is Timed and ExposureAuto is Off. This controls
the duration where the photosensitive cells are exposed to light.
5.6.3 ExposureAuto
Name ExposureAuto
Level Optional
Access Read/Write
Unit -
Visibility Beginner
Values Off
Once
Continuous
Device-specific
2012-10-25 Page 148 of 366

Sets the automatic exposure mode when ExposureMode is Timed. The exact algorithm used to
implement this control is device-specific.
Some other device-specific features might be used to allow the selection of the algorithm.
• Off: Exposure duration is user controlled using ExposureTime.
• Once: Exposure duration is adapted once by the device. Once it has converged, it returns
to the Off state.
• Continuous: Exposure duration is constantly adapted by the device to maximize the
dynamic range.
On top of the previous standard values, a device might also provide device-specific values.
2012-10-25 Page 149 of 366

6 Digital I/O Control

The Digital I/O chapter covers the features required to control the general Input and Output
signals of the device. This includes input and output control signals for Triggers Timers, counters
and also static signals such as user configurable input or output bits.
The Digital I/O Control model presents each I/O Line as a physical line that comes from the
device connector and that goes into an I/O Control Block permitting to condition and to monitor
the incoming or outgoing signal.
LineSelector = Line1 LineStatus

and Line
TriggerSource signal
Events
monitoring
CounterSource signal
Physical Input TimerTrigger signal
Line1 inverter
…
LineInverter control
Tri- Output
State inverter
ExposureActive signal
Line
LineMode control TimerActive signal
Output
Mux UserOutput1 signal
UserOutput2 signal
…
LineSource control
Figure 6-1: I/O Control
2012-10-25 Page 150 of 366

I/O Lines:
For a Digital I/O, when the full I/O Control Block is implemented, each physical Line (or pin)
selected using LineSelector can be configured as Input or Output using LineMode. For an input
or output Line, it is possible to read the Status of the Line with LineStatus and the incoming or
outgoing signal can also be inverted using LineInverter. For an Output signal, the source of the
signal is controlled using LineSource (See Figure 6-1).
For example, to output an inverted pulse coming from the Timer 1 on the physical Line 2 of the
device connector, use the following code:
LineSelector = Line2;
LineMode = Output;
LineInverter = True;
LineSource = Timer1Active;
Note that all the features of an I/O control block are optional. Typically, an Input only line will
report the LineMode as Input (read-only) and will implement only the LineSelector,
LineInverter and LineStatus features (top half in Figure 6-1). An Output only line will report
the LineMode as Output (read-only) and will implement only the LineSelector, LineInverter
and LineSource features (bottom half of
Figure 6-1). Even a hard-wired input or output line is just particular case where all the features
are read-only.
The electrical format of the physical Line (TTL. LVDS, Opto-Coupled…) can be read or
controlled (if supported) using LineFormat.
Note also that the Status of all the Lines can be monitored in one single access using
LineStatusAll.
UserOutput:
One possible source for Output lines is the User Output bit register.
Using LineSource, each of the bits of the User Output register can be directed to a physical
output Line after going trough the I/O control block (See Figure 6-1).
UserOutputSelector and UserOutputValue are used to set any individual bit of the User Output
register. UserOutputValueAll and UserOutputValueAllMask can be used to set all or many of
the User Output bits in one access.
See the I/O Examples section for more complete use cases of the I/O usage.
6.1 DigitalIOControl
Name DigitalIOControl
2012-10-25 Page 151 of 366

Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Expert
Values -
Category that contains the digital input and output control features.
6.2 LineSelector
Name LineSelector
Category DigitalIOControl
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Line0 (If 0 based), Line1, Line2,
…
CC1, CC2, CC3, CC4,
…
Selects the physical line (or pin) of the external device connector to configure.
When a Line is selected, all the other Line features will be applied to its associated I/O control
block and will condition the resulting input or output signal.
• Line0 (If 0 based), Line1, Line2, ...: Index of the physical line and associated I/O control
block to use.
• CC1, CC2, CC3, CC4: Index of the Camera Link physical line and associated I/O control
block to use. This ensures a direct mapping between the lines on the frame grabber and
on the camera. Applicable to CameraLink Product only.
2012-10-25 Page 152 of 366

6.3 LineMode
Name LineMode[LineSelector]
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values Input
Output
Controls if the physical Line is used to Input or Output a signal.

When a Line supports input and output mode, the default state is Input to avoid possible electrical
contention.
• Input: The selected physical line is used to Input an electrical signal.
• Output: The selected physical line is used to Output an electrical signal.
6.4 LineInverter
Name LineInverter[LineSelector]
Level Recommended
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values False
True
Controls the inversion of the signal of the selected input or output Line.
• False: The Line signal is not inverted.
2012-10-25 Page 153 of 366

• True: The Line signal is inverted.
6.5 LineStatus
Name LineStatus[LineSelector]
Level Recommended
Interface IBoolean
Access Read
Unit -
Visibility Expert
Values False
True
Returns the current status of the selected input or output Line.

The status of the signal is taken after the input Line inverter of the I/O control block.
• True: The level of the Line signal is High.
• False: The level of the Line signal is Low.
6.6 LineStatusAll
Name LineStatusAll
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Expert
Returns the current status of all available Line signals at time of polling in a single bitfield.
The order is Line0 (If 0 based), Line1, Line2,...
2012-10-25 Page 154 of 366

6.7 LineSource
Name LineSource[LineSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Off
AcquisitionTriggerWait
AcquisitionActive
FrameTriggerWait
FrameActive
ExposureActive
Stream0TransferActive,
Stream1TransferActive, …
Stream0TransferPaused,
Stream1TransferPaused, …
Stream0TransferStopping,
Stream1TransferStopping, …
Stream0TransferStopped,
Stream1TransferStopped, …
Stream0TransferOverflow
Stream1TransferOverflow, ...
Counter0Active,
Counter1Active,
Counter2Active, …
Timer0Active,
Timer1Active,
Timer2Active, …
UserOutput0,
UserOutput1,
UserOutput2, …
Selects which internal acquisition or I/O source signal to output on the selected Line. LineMode
must be Output.
See Figure 6-1 for details.
2012-10-25 Page 155 of 366

• Off: Line output is disabled (Tri-State).

• AcquisitionTriggerWait: Device is currently waiting for a trigger for the capture of one
or many Frames.
• AcquisitionActive: Device is currently doing an acquisition of one or many Frames.
• FrameTriggerWait: Device is currently waiting for a Frame start trigger.
• FrameActive: Device is currently doing the capture of a Frame.
• ExposureActive: Device is doing the exposure of a Frame (or Line).
• Counter0Active, Counter1Active, Counter2Active, …: The chosen counter is in active
state (counting).
• Stream0TransferActive, Stream1TransferActive, …: Transfer on the stream is active.
• Stream0TransferPaused, Stream1TransferPaused, …: Transfer on the stream is
paused.
• Stream0TransferStopping, Stream1TransferStopping, …: Transfer on the stream is
stopping.
• Stream0TransferStopped, Stream1TransferStopped, …: Transfer on the stream is
stopped.
• Stream0TransferOverflow, Stream1TransferOverflow, …: Transfer on the stream is
in overflow.
• Timer0Active, Timer1Active, Timer2Active, …: The chosen Timer is in active state.
• UserOutput0, UserOutput1, UserOutput2, …: The chosen User Output Bit state as
defined by its current UserOutputValue.
6.8 LineFormat
Name LineFormat[LineSelector]
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values NoConnect
TriState
TTL
LVDS
RS422
2012-10-25 Page 156 of 366
OptoCoupled
Controls the current electrical format of the selected physical input or output Line.
• NoConnect: The Line is not connected.
• TriState: The Line is currently in Tri-State mode (Not driven).
• TTL: The Line is currently accepting or sending TTL level signals.
• LVDS: The Line is currently accepting or sending LVDS level signals.
• RS422: The Line is currently accepting or sending RS422 level signals.
• OptoCoupled: The Line is opto-coupled.
6.9 UserOutputSelector
Name UserOutputSelector
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values UserOutput0, UserOutput1,
UserOutput2, …
Selects which bit of the User Output register will be set by UserOutputValue.
• UserOutput0: Selects the bit 0 of the User Output register.
• …
6.10 UserOutputValue
Name UserOutputValue[UserOutputSelector]
2012-10-25 Page 157 of 366

Level Recommended
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values True
False
Sets the value of the bit selected by UserOutputSelector.
6.11 UserOutputValueAll
Name UserOutputValueAll
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Sets the value of all the bits of the User Output register. It is subject to the
UserOutputValueAllMask.
UserOutputValueAll can take any binary value and each bit set to one will set the corresponding
User Output register bit to high. Note that the UserOutputs are numbered from 0 to N (If 0
based). This means that the least significant bit of UserOutputValueAll corresponds to the
UserOutput0 (if 0 based).
6.12 UserOutputValueAllMask
Name UserOutputValueAllMask
Level Optional
Interface IInteger
Access Read/Write
2012-10-25 Page 158 of 366

Unit -
Visibility Expert
Sets the write mask to apply to the value specified by UserOutputValueAll before writing it in
the User Output register. If the UserOutputValueAllMask feature is present, setting the user
Output register using UserOutputValueAll will only change the bits that have a corresponding
bit in the mask set to one.
UserOutputValueAllMask can take any binary value. Each bit set to one will enable writing of
the corresponding User Output register bit and each bit set to zero will prevent it.
Note that UserOutputValueAllMask is ignored when an individual bit is set using
UserOutputValue.
2012-10-25 Page 159 of 366

7 Counter and Timer Control

This chapter lists all features that relates to control and monitoring of Counters and Timers.
A Counter is used to count internal events (FrameStart, Timer1End, …), I/O external events
(Input Line rising edge, …) and even clock ticks. It can be reset, read or written at anytime.
Counters and Timers can also be cascaded to increase their range if necessary.
Timers are readable and can be used to measure the duration of internal or external signals. A
Timer can also be used to generate a timed strobe pulse with an optional delay before activation.
For example,to generate a 300 us strobe pulse coming from the Timer 1 when a rising edge
trigger is detected on the physical Line 2 of the device connector, use the following code:
TimerSelector = Timer1;
TimerDuration = 300;
TimerTriggerActivation = RisingEdge;
TimerTriggerSource = Line2;
To set the destination output Line of the Timer pulse, see for example Timer1Active entry of the
LineSource feature.
Note that Counters and Timers can also be used to generate an Event when a predetermined
maximum count (or duration) is reached. See the EventSelector feature.
See the Counter and Timer Examples section for more complete use cases of the counters and
timers usage.
7.1 CounterAndTimerControl
Name CounterAndTimerControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Expert
Values -
Category that contains the Counter and Timer control features.

2012-10-25 Page 160 of 366
7.2 CounterSelector
Name CounterSelector
Category CounterAndTimerControl
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Counter0 (If 0 based),
Counter1,
Counter2,
…
Selects which Counter to configure.

• Counter0: Selects the counter 0.
• …
7.3 CounterEventSource
Name CounterEventSource[CounterSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Off
AcquisitionTrigger
AcquisitionStart
AcquisitionEnd
FrameTrigger
FrameStart
2012-10-25 Page 161 of 366
FrameEnd
FrameBurstStart
FrameBurstEnd
LineStart
LineEnd
ExposureStart
ExposureEnd
Line0 (If 0 based), Line1, Line2, …
Timer0End (If 0 based), Timer1End,
Timer2End, …
TimestampTick,
Action2, …
Select the events that will be the source to increment the Counter.
See Figure 5-1, Figure 5-3 and Figure 5-4 for details.
• Off: Counter is stopped.
• AcquisitionTrigger: Counts the number of Acquisition Trigger.
• AcquisitionStart: Counts the number of Acquisition Start.
• AcquisitionEnd: Counts the number of Acquisition End.
• FrameTrigger: Counts the number of Frame Start Trigger.
• FrameStart: Counts the number of Frame Start.
• FrameEnd: Counts the number of Frame End.
• FrameBurstStart: Counts the number of Frame Burst Start.
• FrameBurstEnd: Counts the number of Frame Burst End.
• LineStart: Counts the number of Line Start.
• LineEnd: Counts the number of Line End.
• ExposureStart: Counts the number of Exposure Start.
• ExposureEnd: Counts the number of Exposure End.
• Line0, Line1, Line2, …: Counts the number of transitions on the chosen I/O Line.
2012-10-25 Page 162 of 366

• Counter0End, Counter1End, Counter2End, …: Counts the number of Counter End

when counter are cascaded.
• Timer0End, Timer1End, Timer2End, …: Counts the number of Timer End pulses
generated.
• TimestampTick: Counts the number of clock ticks of the Timestamp clock. Can be used
to create a programmable timer.
• Action0, Action1, Action2, … : Counts the number of assertions of the chosen action
signal.
7.4 CounterEventActivation
Name CounterEventActivation[CounterSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values RisingEdge
FallingEdge
AnyEdge
Selects the Activation mode Event Source signal.

• RisingEdge: Counts on the Rising Edge of the signal.
• FallingEdge: Counts on the Falling Edge of the signal.
• AnyEdge: Counts on the Falling or rising Edge of the selected signal.
7.5 CounterResetSource
Name CounterResetSource[CounterSelector]
Level Recommended
Access Read/Write
Unit -
2012-10-25 Page 163 of 366
Visibility Expert
Values Off
CounterTrigger
AcquisitionTrigger
AcquisitionStart
AcquisitionEnd
FrameTrigger
FrameStart
FrameEnd
ExposureStart
ExposureEnd
Timer0End (If 0 based), Timer1End,
Timer2End, …
UserOutput2,…
Action2, …
Selects the signals that will be the source to reset the Counter.
• Off: Disable the Counter Reset trigger.
• CounterTrigger: Resets with the reception of a trigger on the CounterTriggerSource.
• AcquisitionTrigger: Resets with the reception of the Acquisition Trigger.
• AcquisitionStart: Resets with the reception of the Acquisition Start.
• AcquisitionEnd: Resets with the reception of the Acquisition End.
• FrameTrigger: Resets with the reception of the Frame Start Trigger.
• FrameStart: Resets with the reception of the Frame Start.
• FrameEnd: Resets with the reception of the Frame End.
• FrameBurstStart: Resets with the reception of the Frame Burst Start.
• FrameBurstEnd: Resets with the reception of the Frame Burst End.
• ExposureStart: Resets with the reception of the Exposure Start.
• ExposureEnd: Resets with the reception of the Exposure End.
• Line0 (If 0 based), Line1, Line2, …: Resets by the chosen I/O Line.
2012-10-25 Page 164 of 366

• UserOutput0, UserOutput1, UserOutput2, …: Resets by the chosen User Output bit.

• Counter0End, Counter1End, Counter2End, …: Resets with the reception of the
Counter End.
• Timer0End, Timer1End, Timer2End, …: Resets with the reception of the Timer End.
• Action0, Action1, Action2, …: Resets on assertions of the chosen action signal
(Broadcasted signal on the transport layer).
Note that the value of the Counter at time of reset is automatically latched and reflected in
CounterValueAtReset.
7.6 CounterResetActivation
Name CounterResetActivation[CounterSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values RisingEdge
FallingEdge
AnyEdge
LevelHigh
LevelLow
Selects the Activation mode of the Counter Reset Source signal.

• RisingEdge: Resets the counter on the Rising Edge of the signal.
• FallingEdge: Resets the counter on the Falling Edge of the signal.
• AnyEdge: Resets the counter on the Falling or rising Edge of the selected signal.
• LevelHigh: Resets the counter as long as the selected signal level is High.
• LevelLow: Resets the counter as long as the selected signal level is Low.
7.7 CounterReset
Name CounterReset[CounterSelector]
2012-10-25 Page 165 of 366

Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Expert
Values -
Does a software reset of the selected Counter and starts it. The counter starts counting events
immediately after the reset unless a Counter trigger is active. CounterReset can be used to reset
the Counter independently from the CounterResetSource. To disable the counter temporarily, set
CounterEventSource to Off.
Note that the value of the Counter at time of reset is automatically latched and reflected in the
CounterValueAtReset.
7.8 CounterValue
Name CounterValue[CounterSelector]
Level Recommended
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Values ≥0
Reads or writes the current value of the selected Counter.

Writing to CounterValue is typically used to set the start value.
7.9 CounterValueAtReset
Name CounterValueAtReset[CounterSelector]
Level Recommended
Interface IInteger
Access Read
2012-10-25 Page 166 of 366

Unit -
Visibility Expert
Values ≥0
Reads the value of the selected Counter when it was reset by a trigger or by an explicit
CounterReset command.
It represents the last counter value latched before reseting the counter.
7.10 CounterDuration
Name CounterDuration[CounterSelector]
Level Recommended
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Values ≥0
Sets the duration (or number of events) before the CounterEnd event is generated.
When the counter reaches the CounterDuration value, a CounterEnd event is generated, the
CounterActive signal becomes inactive and the counter stops counting until a new trigger
happens or it is explicitly reset with CounterReset.
7.11 CounterStatus
Name CounterStatus[CounterSelector]
Level Recommended
Access Read
Unit -
Visibility Expert
Values CounterIdle
CounterTriggerWait
CounterActive
2012-10-25 Page 167 of 366
CounterCompleted
CounterOverflow
Returns the current state of the Counter.

• CounterIdle: The counter is idle. CounterEventSource is Off.
• CounterTriggerWait: The counter is waiting for a start trigger.
• CounterActive: The counter is counting for the specified duration.
• CounterCompleted: The counter reached the CounterDuration count.
• CounterOverflow: The counter reached its maximum possible count.
7.12 CounterTriggerSource
Name CounterTriggerSource[CounterSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Off
AcquisitionTrigger
AcquisitionStart
AcquisitionEnd
FrameTrigger
FrameStart
FrameEnd
FrameBurstStart
FrameBurstEnd
ExposureStart
ExposureEnd
UserOutput2,…
Counter0End (if 0 based), Counter1End,
Counter2End, …
Timer0End (if 0 based), Timer1End,
Timer2End, …
2012-10-25 Page 168 of 366

Action0, Action1, Action2, …
Selects the source to start the Counter.

• Off: Disables the Counter trigger.
• AcquisitionTrigger: Starts with the reception of the Acquisition Trigger.
• AcquisitionStart: Starts with the reception of the Acquisition Start.
• AcquisitionEnd: Starts with the reception of the Acquisition End.
• FrameTrigger: Starts with the reception of the Frame Start Trigger.
• FrameStart: Starts with the reception of the Frame Start.
• FrameEnd: Starts with the reception of the Frame End.
• FrameBurstStart: Starts with the reception of the Frame Burst Start.
• FrameBurstEnd: Starts with the reception of the Frame Burst End.
• ExposureStart: Starts with the reception of the Exposure Start.
• ExposureEnd: Starts with the reception of the Exposure End.
• Line0 (If 0 based), Line1, Line2, …: Starts when the specified CounterTriggerActivation
condition is met on the chosen I/O Line.
• Counter0End, Counter1End, Counter2End, …: Starts with the reception of the
Counter End.
• Timer0End, Timer1End, Timer2End, …: Starts with the reception of the Timer End.
• Action0, Action1, Action2, …: Starts with the assertion of the chosen action signal.
7.13 CounterTriggerActivation
Name CounterTriggerActivation[CounterSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
2012-10-25 Page 169 of 366

Values RisingEdge
FallingEdge
AnyEdge
LevelHigh
LevelLow
Selects the activation mode of the trigger to start the Counter.

• RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
• FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
• AnyEdge: Starts counting on the Falling or rising Edge of the selected trigger signal.
• LevelHigh: Counts as long as the selected trigger signal level is High.
• LevelLow: Counts as long as the selected trigger signal level is Low.
7.14 TimerSelector
Name TimerSelector
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Timer0 (if 0 based), Timer1,
Timer2, …
Selects which Timer to configure.

• Timer0: Selects the Timer 0.
7.15 TimerDuration
Name TimerDuration[TimerSelector]
2012-10-25 Page 170 of 366
Level Recommended
Interface IFloat
Access Read/Write
Unit us
Visibility Expert
Values ≥0
Sets the duration (in microseconds) of the Timer pulse.

When the Timer reaches the TimerDuration value, a TimerEnd event is generated, the
TimerActive signal becomes low and the Timer stops counting until a new trigger happens or it
is explicitly reset with TimerReset.
7.16 TimerDelay
Name TimerDelay[TimerSelector]
Level Recommended
Interface IFloat
Access Read/Write
Unit us
Visibility Expert
Values ≥0
Sets the duration (in microseconds) of the delay to apply at the reception of a trigger before
starting the Timer.
7.17 TimerReset
Name TimerReset[TimerSelector]
Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Expert
2012-10-25 Page 171 of 366

Values -
Does a software reset of the selected timer and starts it. The timer starts counting events
immediately after the reset unless a timer trigger is active.
7.18 TimerValue
Name TimerValue[TimerSelector]
Level Recommended
Interface IFloat
Access Read/Write
Unit us
Visibility Expert
Values ≥0
Reads or writes the current value (in microseconds) of the selected Timer.
Writing TimerValue is typically used to set the start value.
7.19 TimerStatus
Name TimerStatus[TimerSelector]
Level Recommended
Access Read
Unit -
Visibility Expert
Values TimerIdle
TimerTriggerWait
TimerActive
TimerCompleted
Returns the current state of the Timer.

2012-10-25 Page 172 of 366

• TimerIdle: The Timer is idle. TimerTriggerSource is Off.

• TimerTriggerWait: The Timer is waiting for a start trigger.
• TimerActive: The Timer is counting for the specified duration.
• TimerCompleted: The Timer reached the TimerDuration count.
7.20 TimerTriggerSource
Name TimerTriggerSource[TimerSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Off
AcquisitionTrigger
AcquisitionStart
AcquisitionEnd
FrameTrigger
FrameStart
FrameEnd
FrameBurstStart
FrameBurstEnd
ExposureStart
ExposureEnd
Line0 (If 0 based), Line1, Line2,…
UserOutput0, UserOutput1, UserOutput2,…
Counter0End (If 0 based), Counter1End, Counter2End,
…
Timer0End (If 0 based), Timer1End, Timer2End, …
Action0 (If 0 based), Action1, Action2, …
Selects the source of the trigger to start the Timer.

• Off: Disables the Timer trigger.
• AcquisitionTrigger: Starts with the reception of the Acquisition Trigger.
• AcquisitionStart: Starts with the reception of the Acquisition Start.
2012-10-25 Page 173 of 366

• AcquisitionEnd: Starts with the reception of the Acquisition End.

• FrameTrigger: Starts with the reception of the Frame Start Trigger.
• FrameStart: Starts with the reception of the Frame Start.
• FrameEnd: Starts with the reception of the Frame End.
• FrameBurstStart: Starts with the reception of the Frame Burst Start.
• FrameBurstEnd: Starts with the reception of the Frame Burst End.
• ExposureStart: Starts with the reception of the Exposure Start.
• ExposureEnd: Starts with the reception of the Exposure End.
• Line0 (If 0 based), Line1, Line2, …: Starts when the specidfied TimerTriggerActivation
condition is met on the chosen I/O Line.
• Counter0End, Counter1End, Counter2End, …: Starts with the reception of the
Counter End.
• Timer0End, Timer1End, Timer2End, …: Starts with the reception of the Timer End
when Timer are cascaded. Note that a timer can retrigger itself to achieve a free running
Timer.
• Action0, Action1, Action2, …: Starts with the assertion of the chosen action signal.
7.21 TimerTriggerActivation
Name TimerTriggerActivation[TimerSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values RisingEdge
FallingEdge
AnyEdge
LevelHigh
LevelLow
Selects the activation mode of the trigger to start the Timer.
2012-10-25 Page 174 of 366


• RisingEdge: Starts counting on the Rising Edge of the selected trigger signal.
• FallingEdge: Starts counting on the Falling Edge of the selected trigger signal.
• AnyEdge: Starts counting on the Falling or Rising Edge of the selected trigger signal.
• LevelHigh: Counts as long as the selected trigger signal level is High.
• LevelLow: Counts as long as the selected trigger signal level is Low.
2012-10-25 Page 175 of 366

8 Event Control
This chapter describes how to control the generation of Events to the host application. An Event
is a message that is sent to the host application to notify it of the occurrence of an internal event.
Events are typically used to synchronize the host application with some Events happening in the
device. A typical use in machine vision is a host application that waits to be notified of the CCD
exposure end to move the inspected part on a conveyer belt.
EventSelector selects which particular Event to control. There are 4 typical sources of events:
Acquisition, Timer, Counter and I/O lines.
The standard Acquisition related Events are: AcquisitionTrigger, AcquisitionStart,
AcquisitionEnd, AcquisitionTransferStart, AcquisitionTransferEnd, AcquisitionError,
FrameTrigger, FrameStart, FrameEnd, FrameBurstStart, FrameBurstEnd,
FrameTransferStart, FrameTransferEnd, ExposureStart, ExposureEnd (See Figure 5-1 to
Figure 5-4).
The standard Counters and Timers related Events are: Counter0Start, Counter0End,
Counter1Start, Counter1End, … Timer0Start, Timer0End, Timer1Start, Timer1End, …
The standard I/O line Events are: Line0RisingEdge , Line0FallingEdge, Line0AnyEdge,
Line1RisingEdge, Line1FallingEdge, … Note that the event signal is monitored at the same
place as LineStatus in the I/O control block (See
Figure 6-1). This means that event is checked against the condition after the input inverter.
EventNotification is used to enable or disable the notification of the occurrence of the internal
event selected by EventSelector. If EventNotification is Off, no event of the selected type is
generated.
For each of the events listed in the EventSelector enumeration, there must be a corresponding
feature with a standard name (ex: EventExposureEnd). The controlling application can rely on
this event identifier to register a callback function to be notified that the event happened.
Also for each Event in EventSelector, there should be one category grouping all the related data
members (Ex: EventExposureEndData).
The other data members in that category should also follow the naming convention described
below (Ex: EventExposureEndTimestamp).
The recommended optional data members are:
- Timestamp: Unique timestamp of the Event.

- FrameID: Unique ID of the Frame (or image) that generated the Event.
- Followed by any other data related to this particular event.
2012-10-25 Page 176 of 366

Therefore, the naming convention for the Event related features is:
For each Event member of the EventSelector (Ex: ExposureEnd):
- You should provide an ICategory named:

Event prefix + "EventName" + Data postfix (Ex: EventExposureEndData)
- You must provide an IInteger Event feature that will be used to register the callback and is
named:
Event prefix +"EventName" (Ex: EventExposureEnd).
- You should provide for each optional data member a corresponding feature named:
Event prefix + "EventName"+"DataMember" (Ex: EventExposureEndTimestamp).
For the ExposureEnd member of EventSelector, this would give:
ICategory EventExposureEndData
IInteger EventExposureEnd
IInteger EventExposureEndTimeStamp
IInteger EventExposureEndFrameID
…
With the above naming convention, for each Event listed in EventSelector:
- A user always knows the name of the Feature to use to register a call back on that Event.
- The user can take the parent of this feature to find the corresponding Event category.
- In this Event category, the user will find all the features related to this Event.
For example, to do a continuous acquisition and be notified at the end of the exposure period of
each frame to move the part and also get the timestamp, the following pseudo-code can be used:
2012-10-25 Page 177 of 366

Register(Camera.EventExposureEnd, CallbackDataObject, CallbackFunctionPtr)
Camera.EventSelector = ExposureEnd;
Camera.EventNotification = On;
Camera.AcquisitionMode = Continuous;
Camera.AcquisitionStart();
…
// In the callback of the ExposureEnd event, gets the event timestamp:
Timestamp = Camera.EventExposureEndTimestamp;
…
Camera.AcquisitionStop();
Here below, in addition to EventControl, EventSelector and EventNotification should be listed

all the categories and data related features for each Event listed in the EventSelector enumeration
feature.
For simplicity, all the categories and their data members are not listed explicitly in that document
but a precise naming convention for the categories and their member is provided above instead.
Below, the detailled features for the members of the EventSelector are only listed for 3 typically
recommended events: FrameTrigger, ExposureEnd and Error.
All the other members of the EventSelector feature should follow the exact same pattern for their
features naming and category if they are present in a device.
See the Acquisition and Trigger Examples section for more complete use cases of the Events
usage.
8.1 EventControl
Name EventControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
2012-10-25 Page 178 of 366
Visibility Expert
Values -
Category that contains Event control features.
8.2 EventSelector
Name EventSelector
Category EventControl
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values AcquisitionTrigger
AcquisitionStart
AcquisitionEnd
AcquisitionTransferStart
AcquisitionTransferEnd
AcquisitionError
FrameTrigger
FrameStart
FrameEnd
FrameBurstStart
FrameBurstEnd
FrameTransferStart
FrameTransferEnd
ExposureStart
ExposureEnd
Stream0TransferStart
Stream0TransferEnd
Stream0TransferPause
Stream0TransferResume
Stream0TransferBlockStart
Stream0TransferBlockEnd
Stream0TransferBlockTrigger
Stream0TransferBurstStart
Stream0TransferBurstEnd
Stream0TransferOverflow
Counter0Start (If 0 based), Counter1Start, …
Counter0End (If 0 based), …, Counter1End,
2012-10-25 Page 179 of 366
…
Timer0Start (If 0 based), Timer1Start, …
Timer0End (If 0 based), Timer1End, …
Line0RisingEdge (If 0 based),
Line1RisingEdge, …
Line0FallingEdge (If 0 based),
Line1FallingEdge, …
Line0AnyEdge (If 0 based),
Line1AnyEdge, …
ActionLate
LinkSpeedChange
Error
Device-specific
PrimaryApplicationSwitch
Selects which Event to signal to the host application.

See Figure 5-1 to Figure 5-4 and Figure 6-1 for details.
• AcquisitionTrigger: Device just received a trigger for the Acquisition of one or many
Frames.
• AcquisitionStart: Device just started the Acquisition of one or many Frames.
• AcquisitionEnd: Device just completed the Acquisition of one or many Frames.
• AcquisitionTransferStart: Device just started the transfer of one or many Frames.
• AcquisitionTransferEnd: Device just completed the transfer of one or many Frames.
• AcquisitionError: Device just detected an error during the active Acquisition.
• FrameTrigger: Device just received a trigger to start the capture of one Frame.
• FrameStart: Device just started the capture of one Frame.
• FrameEnd: Device just completed the capture of one Frame.
• FrameBurstStart: Device just started the capture of a burst of Frames.
• FrameBurstEnd: Device just completed the capture of a burst of Frames.
• FrameTransferStart: Device just started the transfer of one Frame.
• FrameTransferEnd: Device just completed the transfer of one Frame.
2012-10-25 Page 180 of 366
• ExposureStart: Device just started the exposure of one Frame (or Line).
• ExposureEnd: Device just completed the exposure of one Frame (or Line).
• Stream0TransferStart: Device just started the transfer of one or many Blocks.
• Stream0TransferEnd: Device just completed the transfer of one or many Blocks.
• Stream0TransferPause: Device just paused the transfer.
• Stream0TransferResume: Device just resumed the transfer.
• Stream0TransferBlockStart: Device just started the transfer of one Block.
• Stream0TransferBlockEnd: Device just completed the transfer of one Block.
• Stream0TransferBlockTrigger: Device just received a trigger to start the transfer of one
Block.
• Stream0TransferBurstStart: Device just started the transfer of a burst of Blocks.
• Stream0TransferBurstEnd: Device just completed the transfer of a burst of Blocks.
• Stream0TransferOverflow: Device transfer queue overflowed.
• Counter0Start: The event will be generated when counter 0 starts counting.
• Counter0End: The event will be generated when counter 0 ends counting.
• Counter1Start: The event will be generated when counter 1 starts counting.
• Counter1End: The event will be generated when counter 1 ends counting.
• Timer0Start: The event will be generated when Timer 0 starts counting.
• Timer0End: The event will be generated when Timer 0 ends counting.
• Timer1Start: The event will be generated when Timer 1 starts counting.
• Timer1End: The event will be generated when Timer 1 ends counting.
• Line0RisingEdge: The event will be generated when a Rising Edge is detected on the
Line 0.
• Line1RisingEdge: The event will be generated when a Rising Edge is detected on the
Line 1.
• Line0FallingEdge: The event will be generated when a Falling Edge is detected on the
Line 0.
• Line1FallingEdge: The event will be generated when a Falling Edge is detected on the
Line 1.
• Line0AnyEdge: The event will be generated when a Falling or Rising Edge is detected on
the Line 0
2012-10-25 Page 181 of 366

• Line1AnyEdge: The event will be generated when a Falling or Rising Edge is detected on
the Line 1.
• ActionLate: Then event will be generated when a valid scheduled action command is
received and is scheduled to be executed at a time that is already past.
• LinkSpeedChange: Then event will be generated when the link speed has changed.
• PrimaryApplicationSwitch: Then event will be generated when a primary application
switchover has been granted.
• Error: The event will be generated when the device encounter an error.
• …
8.3 EventNotification
Name EventNotification[EventSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Off
On
Activate or deactivate the notification to the host application of the occurrence of the selected
Event.
• Off: The selected Event notification is disabled.
• On: The selected Event notification is enabled.
8.4 Frame Trigger Event (Example #1)
Below the recommended features for the Frame Trigger Event handling.
2012-10-25 Page 182 of 366

8.4.1 EventFrameTriggerData
Name EventFrameTriggerData
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Expert
Values -
Category that contains all the data features related to the FrameTrigger Event.
8.4.2 EventFrameTrigger
Name EventFrameTrigger
Category EventFrameTriggerData
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values -
Returns the unique Identifier of the FrameTrigger type of Event. It can be used to register a
callback function to be notified of the event occurrence. Its value uniquely identifies the type
event received.
8.4.3 EventFrameTriggerTimestamp
Name EventFrameTriggerTimestamp
Level Recommended
Interface IInteger
Access Read
2012-10-25 Page 183 of 366

Unit -
Visibility Expert
Values -
Returns the Timestamp of the AcquisitionTrigger Event. It can be used to determine precisely
when the event occured.
8.4.4 EventFrameTriggerFrameID
Name EventFrameTriggerFrameID
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values -
Returns the unique Identifier of the Frame (or image) that generated the FrameTrigger Event.
8.5 Exposure End Event (Example #2)
Below the recommended features for the Exposure End Event handling.
8.5.1 EventExposureEndData
Name EventExposureEndData
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Expert
2012-10-25 Page 184 of 366

Values -
Category that contains all the data features related to the ExposureEnd Event.
8.5.2 EventExposureEnd
Name EventExposureEnd
Category EventExposureEndData
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values -
Returns the unique identifier of the ExposureEnd type of Event. This feature can be used to
register a callback function to be notified of the event occurrence. Its value uniquely identifies the
type of event that will be received.
8.5.3 EventExposureEndTimestamp
Name EventExposureEndTimestamp
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values -
Returns the Timestamp of the ExposureEnd Event. It can be used to determine precisely when the
event occured.
8.5.4 EventExposureEndFrameID
Name EventExposureEndFrameID
2012-10-25 Page 185 of 366
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values -
Returns the unique Identifier of the Frame (or image) that generated the ExposureEnd Event.
8.6 Error Event (Example #3)
Below the recommended features for the Error Event handling.
8.6.1 EventErrorData
Name EventErrorData
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Expert
Values -
Category that contains all the data features related to the Error Event.
8.6.2 EventError
Name EventError
Category EventErrorData
Level Recommended
Interface IInteger
Access Read
2012-10-25 Page 186 of 366

Unit -
Visibility Expert
Values -
Returns the unique identifier of the Error type of Event. It can be used to register a callback
function to be notified of the Error event occurrence. Its value uniquely identifies that the event
received was an Error.
8.6.3 EventErrorTimestamp
Name EventErrorTimestamp
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values -
Returns the Timestamp of the Error Event. It can be used to determine when the event occured.
8.6.4 EventErrorFrameID
Name EventErrorFrameID
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values -
If applicable, returns the unique Identifier of the Frame (or image) that generated the Error Event.
2012-10-25 Page 187 of 366

8.6.5 EventErrorCode
Name EventErrorCode
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values -
Returns an error code for the error(s) that happened.
2012-10-25 Page 188 of 366

9 Analog Control
Features in this chapter describes how to influence the analog features of an image, such as gain,
black level, white clip and gamma.
The Gain, BlackLevel and Gamma features will transform the original pixel value Y to a new
value Y` according to the following formula:
Y ′ = [(Y + BlackLevel ) ⋅ Gain ]
Gamma
For some color cameras in Raw or RGB mode, the red/blue channel can be white balanced with
respect to the green channel using the Red and blue BalanceRatio gain. For cameras in YUV
mode the U/V channel can be balanced with respect to the Y channel using the U and V
BalanceRatio, according to:
B ' = B ( BlueBalanceRatio ⋅ Gain )
Other color camera controls each color channel gain independently, in which case, the Red,
Green and Blue Gain features can be used for white balancing.
The automatic functions GainAuto, BlackLevelAuto, BalanceWhiteAuto,
GainAutoTapBalance and BlackLevelAutoTapBalance can be used to auto-adjust a device
once or continuously and to turn the function on and off.
Most of the automatic functions have 3 possible values: {Off, Once, Continuous}.
• Off: The automatic adjustement is disabled (ie. User control).
• Once: The automatic adjustement is performed once by the device. The affected features
report the effective values. If necessary, the feature is automatically set to "Off" after the
adjustment.
• Continuous: The automatic adjustement is continuously done by the device. The affected
features report their effective values.
When a device has a specific auto-adjustment capability, it should have a corresponding feature
allowing the necessary enumerations.
2012-10-25 Page 189 of 366

9.1 AnalogControl
Name AnalogControl
Category Root
Level Optional
Interface ICategory
Access Read
Unit -
Visibility Beginner
Values -
Category that contains the Analog control features.
9.2 GainSelector
Name GainSelector
Category AnalogControl
Level Optional
Access Read/Write
Unit -
Visibility Beginner
Values All
Red
Green
Blue
Y
U
V
Tap1, Tap2, …
AnalogAll
AnalogRed
AnalogGreen
AnalogBlue
AnalogY
AnalogU
AnalogV
AnalogTap1, AnalogTap2, …
2012-10-25 Page 190 of 366

DigitalAll
DigitalRed
DigitalGreen
DigitalBlue
DigitalY
DigitalU
DigitalV
DigitalTap1, DigitalTap2, …
Selects which Gain is controlled by the various Gain features.

In general, there are 2 types of gain that can exist in a camera, analog or digital. Some camera
will implement one or other or both. This is why there are 3 possible sets of gain.
The first one, without the Analog or Digital prefix, is to be used when only one type of gain is
implemented. This permits to have an implementation independent way to set the gain.
The second and the third, with the Analog and Digital prefix, is to be used when both types of
gain are implemented. This permits to have independent control over each one.
The All gain are intended to be a pre or post stage amplification across all channels or taps, rather
than a convenient way to set all the channels or tap gains in a single step.
All G
Figure 9-1: Gain All pre amplification

or
2012-10-25 Page 191 of 366

G All
Figure 9-2: Gain All post amplification
By following this rule, the value read for the All gains remains valid even when the channel/tap
gains are not all equal.
• All: Gain will be applied to all channels or taps.
• Red: Gain will be applied to the red channel.
• Green: Gain will be applied to the green channel.
• Blue: Gain will be applied to the blue channel.
• Y: Gain will be applied to Y channel.
• U: Gain will be applied to U channel.
• V: Gain will be applied to V channel.
• Tap1: Gain will be applied to Tap 1.
• …
• AnalogAll: Gain will be applied to all analog channels or taps.
• AnalogRed: Gain will be applied to the red analog channel.
• AnalogGreen: Gain will be applied to the green analog channel.
• AnalogBlue: Gain will be applied to the blue analog channel.
• AnalogY: Gain will be applied to Y analog channel.
• AnalogU: Gain will be applied to U analog channel.
• AnalogV: Gain will be applied to V analog channel.
• AnalogTap1: Analog gain will be applied to Tap 1.
2012-10-25 Page 192 of 366


• …
• DigitalAll: Gain will be applied to all digital channels or taps.
• DigitalRed: Gain will be applied to the red digital channel.
• DigitalGreen: Gain will be applied to the green digital channel.
• DigitalBlue: Gain will be applied to the blue digital channel.
• DigitalY: Gain will be applied to Y digital channel.
• DigitalU: Gain will be applied to U digital channel.
• DigitalV: Gain will be applied to V digital channel.
• DigitalTap1: Digital gain will be applied to Tap 1.
• …
9.3 Gain
Name Gain[GainSelector]
Level Optional
Interface IFloat
Access Read/Write
Unit -
Visibility Beginner
Controls the selected gain as an absolute physical value. This is an amplification factor applied to
the video signal.
The unit and values of this feature are specific to the device and must be defined in the GenICam
XML device description file.
For color or multi-tap cameras, GainSelector indicates the color channel or tap to control.
9.4 GainAuto
Name GainAuto[GainSelector]
2012-10-25 Page 193 of 366

Level Optional
Access Read/Write
Unit -
Visibility Beginner
Values Off
Once
Continuous
Device-specific
Sets the automatic gain control (AGC) mode. The exact algorithm used to implement AGC is
device-specific.
• Off: Gain is User controlled using Gain.
• Once: Gain is automatically adjusted once by the device. Once it has converged, it
automatically returns to the Off state.
• Continuous: Gain is constantly adjusted by the device.
9.5 GainAutoBalance
Name GainAutoBalance
Level Optional
Access Read/Write
Unit -
Visibility Beginner
Values Off
Once
Continuous
2012-10-25 Page 194 of 366

Device-specific
Sets the mode for automatic gain balancing between the sensor color channels or taps. The gain
coefficients of each channel or tap are adjusted so they are matched.
• Off: Gain tap balancing is user controlled using Gain .
• Once: Gain tap balancing is automatically adjusted once by the device. Once it has
converged, it automatically returns to the Off state.
• Continuous: Gain tap balancing is constantly adjusted by the device.
9.6 BlackLevelSelector
Name BlackLevelSelector
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values All
Red
Green
Blue
Y
U
V
Tap1, Tap2, …
Selects which Black Level is controlled by the various Black Level features.
The All Black Level selection is intended to be across all channels or taps, rather than a
convenient way to set all the individual channels or taps black levels in a single step. By
following this rule, the value read for the All black level remains valid even when the channel/tap
black levels are not all equal.
• All: Black Level will be applied to all channels or taps.
2012-10-25 Page 195 of 366

• Red: Black Level will be applied to the red channel.

• Green: Black Level will be applied to the green channel.
• Blue: Black Level will be applied to the blue channel.
• Y: Black Level will be applied to Y channel.
• U: Black Level will be applied to U channel.
• V: Black Level will be applied to V channel.
• Tap1: Black Level will be applied to Tap 1.
• …
9.7 BlackLevel
Name BlackLevel[BlackLevelSelector]
Level Optional
Interface IFloat
Access Read/Write
Unit -
Visibility Expert
Controls the analog black level as an absolute physical value. This represents a DC offset applied
to the video signal.
For color or multi-tap cameras, BlackLevelSelector indicates which channel access.
9.8 BlackLevelAuto
Name BlackLevelAuto[BlackLevelSelector]
Level Optional
Access Read/Write
2012-10-25 Page 196 of 366

Unit -
Visibility Expert
Values Off
Once
Continuous
Device-specific
Controls the mode for automatic black level adjustment. The exact algorithm used to implement
this adjustment is device-specific.
• Off: Analog black level is user controlled using BlackLevel.
• Once: Analog black level is automatically adjusted once by the device. Once it has
• Continuous: Analog black level is constantly adjusted by the device.
9.9 BlackLevelAutoBalance
Name BlackLevelAutoBalance
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values Off
Once
Continuous
Device-specific
Controls the mode for automatic black level balancing between the sensor color channels or taps.
The black level coefficients of each channel are adjusted so they are matched.
2012-10-25 Page 197 of 366


• Off: Black level tap balancing is user controlled using BlackLevel.
• Once: Black level tap balancing is automatically adjusted once by the device. Once it has
• Continuous: Black level tap balancing is constantly adjusted by the device.
9.10 WhiteClipSelector
Name WhiteClipSelector
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values All
Red
Green
Blue
Y
U
V
Tap1, Tap2, …
Selects which White Clip to control.

The All White Clip selection is intended to be across all channels or taps, rather than a convenient
way to set all the individual channels or tap white clip in a single step. By following this rule, the
value read for the All white clip remains valid even when the channel/tap white clips are not all
equal.
• All: White Clip will be applied to all channels or taps.
• Red: White Clip will be applied to the red channel.
• Green: White Clip will be applied to the green channel.
• Blue: White Clip will be applied to the blue channel.
• Y: White Clip will be applied to Y channel.
2012-10-25 Page 198 of 366
• U: White Clip will be applied to U channel.

• V: White Clip will be applied to V channel.
• Tap1: White Clip will be applied to Tap 1.
• Tap2: White Clip will be applied to Tap 2.
• …
9.11 WhiteClip
Name WhiteClip[WhiteClipSelector]
Level Optional
Interface IFloat
Access Read/Write
Unit -
Visibility Expert
Controls the maximal intensity taken by the video signal before being clipped as an absolute
physical value. The video signal will never exceed the white clipping point: it will saturate at that
level.
For color or multi-tap cameras, WhiteClipTapSelector indicates the channel to control.
9.12 BalanceRatioSelector
Name BalanceRatioSelector
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values Red
Green
Blue
2012-10-25 Page 199 of 366
Y
U
V
Tap1, Tap2, …
Selects which Balance ratio to control.

• All: White Clip will be applied to all channels or taps.
• Red: Balance Ratio will be applied to the red channel.
• Green: Balance Ratio will be applied to the green channel.
• Blue: Balance Ratio will be applied to the blue channel.
• Y: Balance Ratio will be applied to Y channel.
• U: Balance Ratio will be applied to U channel.
• V: Balance Ratio will be applied to V channel.
• Tap1: Balance Ratio will be applied to Tap 1.
• Tap2: Balance Ratio will be applied to Tap 2.
• …
9.13 BalanceRatio
Name BalanceRatio[BalanceRatioSelector]
Level Optional
Interface IFloat
Access Read/Write
Unit -
Visibility Expert
Values >0.0
Controls ratio of the selected color component to a reference color component. It is used for
white balancing.
For example, the Color balance is realized by the following formula:
2012-10-25 Page 200 of 366

Cw = BalanceRatio x C
where
Cw is the intensity of selected color component after white balancing.
BalanceRatio is the white balance coefficient.
C is the intensity of the color component before white balancing.
9.14 BalanceWhiteAuto
Name BalanceWhiteAuto
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values Off
Once
Continuous
Device-specific
Controls the mode for automatic white balancing between the color channels. The white
balancing ratios are automatically adjusted.
• Off: White balancing is user controlled using BalanceRatioSelector and BalanceRatio.
• Once: White balancing is automatically adjusted once by the device. Once it has
• Continuous: White balancing is constantly adjusted by the device.
9.15 Gamma
Name Gamma
2012-10-25 Page 201 of 366

Level Optional
Interface IFloat
Access Read/Write
Unit -
Visibility Beginner
Values >0.0
Controls the gamma correction of pixel intensity. This is typically used to compensate for non-
linearity of the display system (such as CRT).
Gamma correction is realized by the following formula:
Y` = YGamma
where
Y` is the new pixel intensity
Y is the original pixel intensity
Gamma is the correction factor
The realization of the gamma correction can be implemented using a LUT. Therefore, it is
possible that some LUT functionality is not available when gamma correction is activated.
2012-10-25 Page 202 of 366

10 LUT Control
Features in this chapter describe the Look-up table (LUT) realated features.
10.1 LUTControl
Name LUTControl
Category Root
Level Optional
Interface ICategory
Access Read
Unit -
Visibility Expert
Values -
Category that includes the LUT control features.
10.2 LUTSelector
Name LUTSelector
Category LUTControl
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values Luminance
Red
Green
Blue
Device-specific
Selects which LUT to control.

• Luminance: Selects the Luminace LUT.
• Red: Selects the Red LUT.
2012-10-25 Page 203 of 366
• Green: Selects the Green LUT.

• Blue: Selects the Blue LUT.
This feature is typically not available when only a single LUT is supported.
10.3 LUTEnable
Name LUTEnable[LUTSelector]
Category LUTControl
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values True
False
Activates the selected LUT.
10.4 LUTIndex
Name LUTIndex[LUTSelector]
Category LUTControl
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Values ≥0
Control the index (offset) of the coefficient to access in the selected LUT.
10.5 LUTValue
Name LUTValue[LUTSelector][LUTIndex]
Category LUTControl
Level Optional
2012-10-25 Page 204 of 366

Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Returns the Value at entry LUTIndex of the LUT selected by LUTSelector.
10.6 LUTValueAll
Name LUTValueAll[LUTSelector]
Category LUTControl
Level Optional
Interface IRegister
Access Read/Write
Unit -
Visibility Guru
Accesses all the LUT coefficients in a single access without using individual LUTIndex.
2012-10-25 Page 205 of 366

11 GenICam Control
This chapter provides the necessary features to use the GenICam feature tree.
Note: In case of discrepancy between the features described in this chapter and the "GenICam
Standard text" the SFNC document prevail.
11.1 Root
Name Root
Category None
Level Mandatory
Interface ICategory
Access Read
Unit -
Mandatory Beginner
Visibility
Values -
Provides the Root of the GenICam features tree.
11.2 Device
Name Device
Category None
Level Mandatory
Interface IPort
Access Read/Write
Unit -
Values -
Provides the default GenICam port of the Device.

Note: Device is the name of the standard port that is used to connect the node map to the
transport layer and access the control port of the device. Device is a port node (not a feature
node) and is generally not accessed by the end user directly. Device must not be included in the
root feature tree.
2012-10-25 Page 206 of 366

11.3 TLParamsLocked
Name TLParamsLocked
Category None
Level Mandatory
Interface IInteger
Access Read/Write
Unit -
Values -
Used by the Transport Layer to prevent critical features changes during acquisition.

• 0 : No features are locked.
• 1 : Transport Layer and Device critical features are locked and cannot be changed.
2012-10-25 Page 207 of 366

12 Transport Layer Control

This chapter provides the Transport Layer control features.
The TransportLayerControl category:
The generic features are under the TransportLayerControl category. Other Transport Layer
specific features are under their respective sub category.
The GigEVision category:

This category lists the features necessary to access GigE Vision bootstrap registers and other
information related to the GigE Vision transport medium. Note most of these registers are
mapped according to GigE Vision specification.
In most situations, these registers are directly handled by the framework managing the transport
layer on the PC and are not directly visible to user (for example, deciding which UDP port
number to use for a stream channel).
More information about exact meaning of these features is found in the GigE Vision
specification. The GigE Vision specification shall have precedence over this list in case of
discrepancy.
Note: If the user has configured the camera front end, he can read from the back end which
PayloadSize will be transferred for each image. This number covers all kind of data coming with
the image, e.g. timestamps etc. If the user allocates PayloadSize for each buffer he is insured that
each frame will fit into his target buffers.
The CameraLink category:

This category lists the features necessary to access Camera Link devices and other information
related to the camera Link transport medium.
2012-10-25 Page 208 of 366

12.1 Transport Layer features

This section describes the general transport layer features.
12.1.1 TransportLayerControl
Name TransportLayerControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Beginner
Values -
Category that contains the transport Layer control features.
12.1.2 PayloadSize
Name PayloadSize
Category TransportLayerControl
Level Recommended
Interface IInteger
Access Read
Unit B
Visibility Expert
Values >0
Provides 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. This is the total size of data
payload for a data block.
For the devices supporting multiple Stream Channels, the DeviceStreamChannelSelector feature
should be used to select PayloadSize. This permits to inquire the payload size of each Stream
channel individually.
This feature is mainly used by the application software to determine size of image buffers to
allocate (largest buffer possible for current mode of operation).
2012-10-25 Page 209 of 366

For example, an image with no statistics or timestamp data has typically a PayloadSize equals to
(width x height x pixel size) in bytes. But it is strongly recommended to retrieve PayloadSize
from the camera instead of relying on the above formula.
Note that for GigE vision devices, the UDP and GVSP headers are not considered in the
PayloadSize value. Data leader and data trailer are not included either.
12.1.3 DeviceTapGeometry
Name DeviceTapGeometry
Level Recommended
Access Read/(Write)
Unit -
Visibility Expert
Values Geometry_1X_1Y
Geometry_1X2_1Y
Geometry_2X_1Y
Geometry_2XE_1Y
Geometry_2XM_1Y
Geometry_1X_1Y2
Geometry_1X_2YE
Geometry_1X3_1Y
Geometry_3X_1Y
Geometry_1X
Geometry_1X2
Geometry_2X
Geometry_2XE
Geometry_2XM
Geometry_1X3
Geometry_3X
Geometry_1X4_1Y
Geometry_4X_1Y
Geometry_2X2_1Y
Geometry_2X2E_1Y
Geometry_2X2M_1Y
Geometry_1X2_2YE
Geometry_2X_2YE
Geometry_2XE_2YE
Geometry_2XM_2YE
2012-10-25 Page 210 of 366

Geometry_1X4
Geometry_4X
Geometry_2X2
Geometry_2X2E
Geometry_2X2M
Geometry_1X8_1Y
Geometry_8X_1Y
Geometry_4X2_1Y
Geometry_2X2E_2YE
Geometry_1X8
Geometry_8X
Geometry_4X2
Geometry_1X10_1Y
Geometry_10X_1Y
Geometry_1X10
Geometry_10X
…
This device tap geometry feature describes the geometrical properties characterizing the taps of a
camera as presented at the output of the device.
Possibles values are:
Geometry_1X_1Y: 1 X 1Y tap geometry.
Geometry_1X2_1Y: 1 X2 1Y tap geometry.
Geometry_2XE_1Y: 2 XE 1Y tap geometry.
Geometry_2XM_1Y: 2 XM 1Y tap geometry.
Geometry_1X_1Y2: 1 X 1Y2 tap geometry.
Geometry_1X_2YE: 1 X 2YE tap geometry.
Geometry_1X: 1 X tap geometry.
Geometry_1X2: 1 X2 tap geometry.
Geometry_2XE: 2 XE tap geometry.
Geometry_2XM: 2 XM tap geometry.
2012-10-25 Page 211 of 366


Geometry_2X2E_1Y: 2 X2E 1Y tap geometry.
Geometry_2X2M_1Y: 2 X2M 1Y tap geometry.
Geometry_1X2_2YE: 1 X2 2YE tap geometry.
Geometry_2X_2YE: 2 X 2YE tap geometry.
Geometry_2XE_2YE: 2 XE 2YE tap geometry.
Geometry_2XM_2YE: 2 XM 2YE tap geometry.
Geometry_4X: 4X tap geometry.
Geometry_2X2E: 2 X2E tap geometry.
Geometry_2X2M: 2 X2M tap geometry.
Geometry_8X_1Y: X8 1Y tap geometry.
Geometry_2X2E_2YE: 2 X2E 2YE tap geometry.
Geometry_8X: 8X tap geometry.
Geometry_10X_1Y: 10X 1Y tap geometry.
Geometry_10X: X10 1Y tap geometry.
More detailed explanation, including graphical representation for every single Tap configuration
is provided in the Tap Geometry Appendix of this document.
2012-10-25 Page 212 of 366

12.2 GigE Vision features

This section describes the GigE Vision specific transport layer features.
12.2.1 GigEVision
Name GigEVision
Level Optional
Interface ICategory
Access Read
Unit -
Visibility Beginner
Values -
Category that contains the features pertaining to the GigE Vision transport layer of the device.
12.2.2 GevVersionMajor
Name GevVersionMajor
Category GigEVision
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values >0
Major version of the specification.

For instance, GigE Vision version 1.0 would have the major version set to 1.
12.2.3 GevVersionMinor
Name GevVersionMinor
Category GigEVision
Level Recommended
Interface IInteger
2012-10-25 Page 213 of 366

Access Read
Unit -
Visibility Expert
Values ≥0
Minor version of the specification.

For instance, GigE Vision version 1.0 would have the minor version set to 0.
12.2.4 GevDeviceModeIsBigEndian
Name GevDeviceModeIsBigEndian
Category GigEVision
Level Optional
Interface IBoolean
Access Read
Unit -
Visibility Guru
Values True
False
Endianess of the device registers.

It might be used to interpret multi-byte data for READMEM and WRITEMEM commands. Note
this bit has no effect on the endianess of the GigE Vision protocol headers: they are always big-
endian.
12.2.5 GevDeviceClass
Name GevDeviceClass
Category GigEVision
Level Optional
Access Read
Unit -
Visibility Guru
Values Transmitter
2012-10-25 Page 214 of 366

Receiver
Transceiver
Peripheral
Returns the class of the device.

Note: The GevDeviceClass feature returns Transmitter for cameras.
12.2.6 GevDeviceModeCharacterSet
Name GevDeviceModeCharacterSet
Category GigEVision
Level Optional
Access Read
Unit -
Visibility Guru
Values UTF8
Character set used by all the strings of the bootstrap registers.
12.2.7 GevPhysicalLinkConfiguration
Name GevPhysicalLinkConfiguration
Category GigEVision
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values SingleLink
MultiLink
StaticLAG
DynamicLAG
Controls the principal physical link configuration to use on next restart/power-up of the device.
2012-10-25 Page 215 of 366

12.2.8 GevCurrentPhysicalLinkConfiguration
Name GevCurrentPhysicalLinkConfiguration
Category GigEVision
Level Optional
Access Read
Unit -
Visibility Expert
Values SingleLink
MultiLink
StaticLAG
DynamicLAG
Indicates the current physical link configuration of the device.

Note: When Multi-Link and LAG configurations are used concurrently, the device shall report
the LAG configuration.
12.2.9 GevActiveLinkCount
Name GevActiveLinkCount
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Expert
Values >0
Indicates the current number of active logical links.
12.2.10 GevInterfaceSelector
Name GevInterfaceSelector
Category GigEVision
Level Optional
2012-10-25 Page 216 of 366

Interface IInteger
Access Read/Write
Unit -
Visibility Beginner
Values ≥0
Selects which logical link to control.

Note: The number of physical network interfaces may be greater than the value reported by
GevInterfaceSelector. This is generally the case when link aggregation is activated.
12.2.11 GevLinkSpeed
Name GevLinkSpeed[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit Mbs
Visibility Expert
Values >0
Indicates the speed of transmission negotiated by the given logical link.
12.2.12 GevMACAddress
Name GevMACAddress[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values ≥0
2012-10-25 Page 217 of 366

MAC address of the logical link.

This feature must return a 64-bit value representing the full MAC address of the device i.e. the
high and low parts.
12.2.13 GevSupportedOptionSelector
Name GevSupportedOptionSelector
Category GigEVision
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values SingleLink
MultiLink
StaticLAG
DynamicLAG
PAUSEFrameReception
PAUSEFrameGeneration
IPConfigurationLLA
IPConfigurationDHCP
IPConfigurationPersistentIP
StreamChannelSourceSocket
StandardIDMode
MessageChannelSourceSocket
CommandsConcatenation
WriteMem
PacketResend
Event
EventData
PendingAck
IEEE1588
Action
UnconditionalAction
ScheduledAction
PrimaryApplicationSwitchover
ExtendedStatusCodes
ExtendedStatusCodesVersion2_0
DiscoveryAckDelay
DiscoveryAckDelayWritable
TestData
ManifestTable
2012-10-25 Page 218 of 366
CCPApplicationSocket
LinkSpeed
HeartbeatDisable
SerialNumber
UserDefinedName
StreamChannel0BigAndLittleEndian
StreamChannel0IPReassembly
StreamChannel0MultiZone
StreamChannel0PacketResendDestination
StreamChannel0AllInTransmission
StreamChannel0UnconditionalStreaming
StreamChannel0ExtendedChunkData
…
Selects the GEV option to interrogate for existing support.

Note: The IP reassembly options (StreamChannel0IPReassembly,
StreamChannel1IPReassembly, …) are only applicable to GVSP receiver stream channels.
12.2.14 GevSupportedOption
Name GevSupportedOption[GevSupportedOptionSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read
Unit -
Visibility Expert
2012-10-25 Page 219 of 366

Values True
False
Returns if the selected GEV option is supported.
12.2.15 GevPAUSEFrameReception
Name GevPAUSEFrameReception[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/(Write)
Unit -
Visibility Expert
Values True
False
Controls whether incoming PAUSE Frames are handled on the given logical link.
12.2.16 GevPAUSEFrameTransmission
Name GevPAUSEFrameTransmission[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/(Write)
Unit -
Visibility Expert
Values True
False
Controls whether PAUSE Frames can be generated on the given logical link.
12.2.17 GevCurrentIPConfigurationLLA
Name GevCurrentIPConfigurationLLA[GevInterfaceSelector]
2012-10-25 Page 220 of 366

Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Beginner
Values True
Controls whether the Link Local Address IP configuration scheme is activated on the given
logical link.
12.2.18 GevCurrentIPConfigurationDHCP
Name GevCurrentIPConfigurationDHCP[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Beginner
Values True
False
Controls whether the DHCP IP configuration scheme is activated on the given logical link.
12.2.19 GevCurrentIPConfigurationPersistentIP
Name GevCurrentIPConfigurationPersistentIP[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Beginner
2012-10-25 Page 221 of 366

Values True
False
Controls whether the PersistentIP configuration scheme is activated on the given logical link.
12.2.20 GevCurrentIPAddress
Name GevCurrentIPAddress[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values ≥0
Reports the IP address for the given locical link.
12.2.21 GevCurrentSubnetMask
Name GevCurrentSubnetMask[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Beginner
Values ≥0
Reports the subnet mask of the given logical link.
12.2.22 GevCurrentDefaultGateway
Name GevCurrentDefaultGateway[GevInterfaceSelector]
Category GigEVision
Level Optional
2012-10-25 Page 222 of 366

Interface IInteger
Access Read
Unit -
Visibility Beginner
Values ≥0
Reports the default gateway IP address to be used on the given logical link.
12.2.23 GevIPConfigurationStatus
Name GevIPConfigurationStatus[GevInterfaceSelector]
Category GigEVision
Level Optional
Access Read
Unit -
Visibility Beginner
Values None
PersistentIP
DHCP
LLA
ForceIP
Reports the current IP configuration status.
12.2.24 GevFirstURL
Name GevFirstURL
Category GigEVision
Level Optional
Interface IString
Access Read
Unit -
Visibility Guru
Values -
2012-10-25 Page 223 of 366

Indicates the first URL to the GenICam XML device description file. The First URL is used as
the first choice by the application to retrieve the GenICam XML device description file.
12.2.25 GevSecondURL
Name GevSecondURL
Category GigEVision
Level Optional
Interface IString
Access Read
Unit -
Visibility Guru
Values -
Indicates the second URL to the GenICam XML device description file. This URL is an
alternative if the application was unsuccessful to retrieve the device description file using the first
URL.
12.2.26 GevNumberOfInterfaces
Name GevNumberOfInterfaces
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Expert
Values >0
Indicates the number of logical links supported by this device.
12.2.27 GevPersistentIPAddress
Name GevPersistentIPAddress[GevInterfaceSelector]
Category GigEVision
Level Optional
2012-10-25 Page 224 of 366
Interface IInteger
Access Read/Write
Unit -
Visibility Beginner
Values ≥0
Controls the Persistent IP address for this logical link. It is only used when the device boots with
the Persistent IP configuration scheme.
12.2.28 GevPersistentSubnetMask
Name GevPersistentSubnetMask[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Beginner
Values ≥0
Controls the Persistent subnet mask associated with the Persistent IP address on this logical link.
It is only used when the device boots with the Persistent IP configuration scheme.
12.2.29 GevPersistentDefaultGateway
Name GevPersistentDefaultGateway[GevInterfaceSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Beginner
Values ≥0
2012-10-25 Page 225 of 366

Controls the persistent default gateway for this logical link. It is only used when the device boots
with the Persistent IP configuration scheme.Visibility
12.2.30 GevMessageChannelCount
Name GevMessageChannelCount
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Expert
Values 0 or 1
Indicates the number of message channels supported by this device.
12.2.31 GevStreamChannelCount
Name GevStreamChannelCount
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Expert
Values 0 to 512
Indicates the number of stream channels supported by this device.
12.2.32 GevHeartbeatTimeout
Name GevHeartbeatTimeout
Category GigEVision
Level Optional
Interface IInteger
Access Read/Write
2012-10-25 Page 226 of 366

Unit ms
Visibility Guru
Values >0
Controls the current heartbeat timeout in milliseconds.
12.2.33 GevTimestampTickFrequency
Name GevTimestampTickFrequency
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit Hz
Visibility Expert
Values ≥0
Indicates the number of timestamp ticks in 1 second (frequency in Hz). If IEEE 1588 is used, this
feature must return 1,000,000,000 (1 GHz).
This is a 64 bits number.
12.2.34 GevTimestampControlLatch
Name GevTimestampControlLatch
Category GigEVision
Level Optional
Interface ICommand
Access Write
Unit -
Visibility Expert
Values -
Latches the current timestamp counter into GevTimestampValue.
2012-10-25 Page 227 of 366

12.2.35 GevTimestampControlReset
Name GevTimestampControlReset
Category GigEVision
Level Optional
Interface ICommand
Access Write
Unit -
Visibility Expert
Values -
Resets the timestamp counter to 0. This feature is not available or as no effect when IEEE 1588 is
used.
12.2.36 GevTimestampValue
Name GevTimestampValue
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit
Visibility Expert
Values ≥0
Returns the latched 64-bit value of the timestamp counter.

It is necessary to latch the 64-bit timestamp value to guaranty its integrity when performing the
two 32-bit read accesses to retrieve the higher and lower 32-bit portions.
12.2.37 GevDiscoveryAckDelay
Name GevDiscoveryAckDelay
Category GigEVision
Level Optional
Interface IInteger
2012-10-25 Page 228 of 366

Access Read/(Write)
Unit ms
Visibility Expert
Values ≥0 and < 1000
Indicates the maximum randomized delay the device will wait to acknowledge a discovery
command.
12.2.38 GevIEEE1588
Name GevIEEE1588
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values True
False
Enables the IEEE 1588 Precision Time Protocol to control the timestamp register.
12.2.39 GevIEEE1588ClockAccuracy
Name GevIEEE1588ClockAccuracy
Category GigEVision
Level Optional
Access Read/(Write)
Unit -
Visibility Expert
Values Within25ns
Within100ns
Within250ns
Within1us
Within2p5u
2012-10-25 Page 229 of 366

Within10us
Within25us
Within100us
Within250us
Within1ms
Within2p5ms
Within10ms
Within25ms
Within100ms
Within250ms
Within1s
Within10s
GreaterThan10s
AlternatePTPProfile
Unknown
Reserved
Indicates the expected accuracy of the device clock when it is the grandmaster, or in the event it
becomes the grandmaster.
This feature maps to the IEEE 1588 clockAccuracy attribute.
12.2.40 GevIEEE1588Status
Name GevIEEE1588Status
Category GigEVision
Level Optional
Access Read
Unit -
Visibility Expert
Values Initializing
Faulty
Disabled
Listening
PreMaster
Master
Passive
Uncalibrated
Slave
2012-10-25 Page 230 of 366

Provides the state of the IEEE 1588 clock.
12.2.41 GevGVCPExtendedStatusCodesSelector
Name GevGVCPExtendedStatusCodesSelector
Category GigEVision
Level Optional
Access Read/Write
Unit -
Visibility Guru
Values Version1_1
Version2_0
Selects the GigE Vision version to control extended status codes for.
12.2.42 GevGVCPExtendedStatusCodes
Name GevGVCPExtendedStatusCodes[GevGVCPExtendedStatusCodesSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Guru
Values True
False
Enables the generation of extended status codes.
12.2.43 GevGVCPPendingAck
Name GevGVCPPendingAck
Category GigEVision
Level Optional
2012-10-25 Page 231 of 366

Interface IBoolean
Access Read/Write
Unit -
Visibility Guru
Values True
False
Enables the generation of PENDING_ACK.
12.2.44 GevGVCPHeartbeatDisable
Name GevGVCPHeartbeatDisable
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values True
False
Disables the GVCP heartbeat.
12.2.45 GevGVCPPendingTimeout
Name GevGVCPPendingTimeout
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
Indicates the longest GVCP command execution time before a device returns a PENDING_ACK.
2012-10-25 Page 232 of 366
12.2.46 GevPrimaryApplicationSwitchoverKey
Name GevPrimaryApplicationSwitchoverKey
Category GigEVision
Level Optional
Interface IInteger
Access Write-Only
Unit -
Visibility Guru
Values ≥0
Controls the key to use to authenticate primary application switchover requests.
12.2.47 GevGVSPExtendedIDMode
Name GevGVSPExtendedIDMode
Category GigEVision
Level Optional
Access Read/(Write)
Unit -
Visibility Expert
Values Off
On
Enables the extended IDs mode.

If the standard IDs mode is not supported, this feature should return On and be read only.
This feature is not applicable for GigE Vision 1.x devices.
12.2.48 GevCCP
Name GevCCP
Category GigEVision
Level Optional
2012-10-25 Page 233 of 366

Access Read/Write
Unit -
Visibility Guru
Values OpenAccess
ExclusiveAccess
ControlAccess
ControlAccessSwitchoverActive
Controls the device access privilege of an application.

Only one application is allowed to control the device. This application is able to write into
device`s registers. Other applications can read device`s register only if the controlling application
does not have the exclusive privilege.
12.2.49 GevPrimaryApplicationSocket
Name GevPrimaryApplicationSocket
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
Returns the UDP source port of the primary application.
12.2.50 GevPrimaryApplicationIPAddress
Name GevPrimaryApplicationIPAddress
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
2012-10-25 Page 234 of 366

Values ≥0
Returns the address of the primary application.
12.2.51 GevMCPHostPort
Name GevMCPHostPort
Category GigEVision
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Values ≥0
Controls the port to which the device must send messages. Setting this value to 0 closes the
message channel.
12.2.52 GevMCDA
Name GevMCDA
Category GigEVision
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Values ≥0
Controls the destination IP address for the message channel.
12.2.53 GevMCTT
Name GevMCTT
Category GigEVision
Level Optional
2012-10-25 Page 235 of 366

Interface IInteger
Access Read/Write
Unit ms
Visibility Guru
Values >0
Provides the transmission timeout value in milliseconds.
12.2.54 GevMCRC
Name GevMCRC
Category GigEVision
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Values ≥0
Controls the number of retransmissions allowed when a message channel message times out.
12.2.55 GevMCSP
Name GevMCSP
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
This feature indicates the source port for the message channel.
2012-10-25 Page 236 of 366

12.2.56 GevStreamChannelSelector
Name GevStreamChannelSelector
Category GigEVision
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Values ≥0
Selects the stream channel to control.
12.2.57 GevSCCFGPacketResendDestination
Name GevSCCFGPacketResendDestination[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Guru
Values True
False
Enables the alternate IP destination for stream packets resent due to a packet resend request.
When True, the source IP address provided in the packet resend command packet is used. When
False, the value set in the GevSCDA[GevStreamChannelSelector] feature is used.
This feature is only valid for GVSP transmitters.
12.2.58 GevSCCFGAllInTransmission
Name GevSCCFGAllInTransmission[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IBoolean
2012-10-25 Page 237 of 366

Access Read/Write
Unit -
Visibility Guru
Values True
False
Enables the selected GVSP transmitter to use the single packet per data block All-in
Transmission mode.
12.2.59 GevSCCFGUnconditionalStreaming
Name GevSCCFGUnconditionalStreaming[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Guru
Values True
False
Enables the camera to continue to stream, for this stream channel, if its control channel is closed
or regardless of the reception of any ICMP messages (such as destination unreachable messages).
12.2.60 GevSCCFGExtendedChunkData
Name GevSCCFGExtendedChunkData[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Guru
Values True
False
2012-10-25 Page 238 of 366

Enables cameras to use the extended chunk data payload type for this stream channel.
12.2.61 GevSCPDirection
Name GevSCPDirection[GevStreamChannelSelector]
Category GigEVision
Level Optional
Access Read
Unit -
Visibility Guru
Values Transmitter
Receiver
Reports the direction of the stream channel.
12.2.62 GevSCPInterfaceIndex
Name GevSCPInterfaceIndex[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read/(Write)
Unit -
Visibility Guru
Values 0 to 3
Index of the logical link to use.

Specific streams might be hard-coded to specific logical links. Therefore this field might be read-
only on certain devices.
12.2.63 GevSCPHostPort
Name GevSCPHostPort[GevStreamChannelSelector]
Category GigEVision
Level Optional
2012-10-25 Page 239 of 366

Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Values ≥0
Controls the port of the selected channel to which a GVSP transmitter must send data stream or
the port from which a GVSP receiver may receive data stream. Setting this value to 0 closes the
stream channel.
12.2.64 GevSCPSFireTestPacket
Name GevSCPSFireTestPacket[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Guru
Values True
False
Sends a test packet. When this feature is set, the device will fire one test packet.
The "don`t fragment" bit of IP header must be set for this test packet.
12.2.65 GevSCPSDoNotFragment
Name GevSCPSDoNotFragment[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Guru
Values True
2012-10-25 Page 240 of 366

False
The state of this feature is copied into the "do not fragment" bit of IP header of each stream
packet. It can be used by the application to prevent IP fragmentation of packets on the stream
channel.
12.2.66 GevSCPSBigEndian
Name GevSCPSBigEndian[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Guru
Values True
False
Endianess of multi-byte pixel data for this stream.

This is an optional feature. A device that does not support this feature must support little-endian
and always leave that bit clear.
12.2.67 GevSCPSPacketSize
Name GevSCPSPacketSize[GevStreamChannelSelector]
Category GigEVision
Level Recommended
Interface IInteger
Access Read/(Write)
Unit B
Visibility Expert
Values >0
Specifies the stream packet size, in bytes, to send on the selected channel for a GVSP transmitter
or specifies the maximum packet size supported by a GVSP receiver.
2012-10-25 Page 241 of 366

This does not include data leader and data trailer and the last data packet which might be of
smaller size (since packet size is not necessarily a multiple of block size for stream channel).
If a device cannot support the requested packet size, then it must not fire a test packet when
requested to do so.
12.2.68 GevSCPD
Name GevSCPD[GevStreamChannelSelector]
Category GigEVision
Level Recommended
Interface IInteger
Access Read/Write
Unit
Visibility Expert
Values ≥0
Controls the delay (in timestamp counter unit) to insert between each packet for this stream
channel. This can be used as a crude flow-control mechanism if the application or the network
infrastructure cannot keep up with the packets coming from the device.
12.2.69 GevSCDA
Name GevSCDA[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Values ≥0
Controls the destination IP address of the selected stream channel to which a GVSP transmitter
must send data stream or the destination IP address from which a GVSP receiver may receive
data stream.
2012-10-25 Page 242 of 366

12.2.70 GevSCSP
Name GevSCSP[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
Indicates the source port of the stream channel.
12.2.71 GevSCZoneCount
Name GevSCZoneCount[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values 1 to 32
Reports the number of zones per block transmitted on the selected stream channel.
12.2.72 GevSCZoneDirectionAll
Name GevSCZoneDirectionAll[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
2012-10-25 Page 243 of 366

Values 00000000h to FFFFFFFFh
Reports the transmission direction of each zone transmitted on the selected stream channel.
This feature is represented as an unsigned integer. The most significant bit of the range of valid
values reports the direction of the first zone (Zone ID 0) while the least significant bit represents
the direction of the last zone (Zone ID 1).
12.2.73 GevSCZoneConfigurationLock
Name GevSCZoneConfigurationLock[GevStreamChannelSelector]
Category GigEVision
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Guru
Values True
False
Controls whether the selected stream channel multi-zone configuration is locked. When locked,
the GVSP transmitter is not allowed to change the number of zones and their direction during
block acquisition and transmission.
12.3 Network Statistics features
This section describes the network statistics specific features.
12.3.1 NetworkStatistics
Name NetworkStatistics
Level Optional
Interface ICategory
Access Read
Unit -
2012-10-25 Page 244 of 366

Visibility Guru
Values -
Category that contains statistics pertaining to various modules of the GigE Vision transport layer.
12.3.2 oMACControlFunctionEntity
Name oMACControlFunctionEntity
Category NetworkStatistics
Level Optional
Interface ICategory
Access Read
Unit -
Visibility Guru
Values -
Category that contains statistics pertaining to the MAC control PAUSE function of the device.
When multiple links are aggregated together, this category represents the aggregated statistics of
all associated MACs. This is because it is not possible to select each physical network interface in
this case.
The counters in this section are defined by the IEEE 802.3 standard. They are generally
nonresetable. Rollover behavior and maximum value are device-specific.
12.3.3 aPAUSEMACCtrlFramesTransmitted
Name aPAUSEMACCtrlFramesTransmitted[GevInterfaceSelector]
Category oMACControlFunctionEntity
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
Reports the number of transmitted PAUSE frames.
2012-10-25 Page 245 of 366

12.3.4 aPAUSEMACCtrlFramesReceived
Name aPAUSEMACCtrlFramesReceived[GevInterfaceSelector]
Category oMACControlFunctionEntity
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Guru
Values ≥0
Reports the number of received PAUSE frames.
12.4 Camera Link features
This section describes the Camera Link specific features.
12.4.1 CameraLink
Name CameraLink
Level Optional
Interface ICategory
Access Read
Unit -
Visibility Beginner
Values -
Category that contains the features pertaining to the Camera Link transport layer of the device.
This category is optional especially if the device supports only one transport layer.
12.4.2 ClConfiguration
Name ClConfiguration
2012-10-25 Page 246 of 366

Category CameraLink
Level Recommended
Access Read/(Write)
Unit -
Visibility Beginner
Values Base
Medium
Full
DualBase
EightyBit
Deca (Deprecated)
This Camera Link specific feature describes the configuration used by the camera. It helps
especially when a camera is capable of operation in a non-standard configuration, and when the
features PixelSize, SensorDigitizationTaps, and DeviceTapGeometry do not provide enough
information for interpretation of the image data provided by the camera.
• Base: Standard base configuration described by the Camera Link standard.
• Medium: Standard medium configuration described by the Camera Link standard.
• Full: Standard full configuration described by the Camera Link standard.
• DualBase: The camera streams the data from multiple taps (that do not fit in the standard
base configuration) through two Camera Link base ports. It is responsibility of the
application or frame grabber to reconstruct the full image. Only one of the ports (fixed)
serves as the "master" for serial communication and triggering.
• EightyBit: Standard 80-bit configuration with 10 taps of 8 bits or 8 taps of 10 bits, as
described by the Camera Link standard.
• Deca (Deprecated): This enumeration entry is deprecated. It was used for Deca
configuration with 10 taps of 8-bit. Use EightyBit instead.
If the feature is omitted, one of the standard configurations (Base-Medium-Full) is expected. In
that case the configuration can be unequivocally deduced from the SensorDigitizationTaps and
PixelSize values.
12.4.3 ClTimeSlotsCount
Name ClTimeSlotsCount
Category CameraLink
2012-10-25 Page 247 of 366

Level Optional
Access Read/(Write)
Unit -
Visibility Expert
Values One
Two
Three
This Camera Link specific feature describes the time multiplexing of the camera link connection
to transfer more than the configuration allows, in one single clock.
• One: One time slot.
• Two: Two time slots.
• One: Three time slots.
It indicates the number of consecutive time slots required to transfer one data of each tap.
12.5 CoaXPress features

This section describes the CoaXPress specific features.
12.5.1 CoaXPress
Name CoaXPress
Level Optional
Interface ICategory
Access Read
Unit -
Visibility Beginner
Values -
Category that contains the features pertaining to the CoaXPress transport layer of the device.
2012-10-25 Page 248 of 366

12.5.2 CxpLinkConfigurationStatus
Name CxpLinkConfigurationStatus
Category CoaXPress
Level Recommended
Access Read
Unit -
Visibility Beginner
Values None
Pending
CXP1_X1
CXP2_X1
CXP3_X1
CXP5_X1
CXP6_X1
CXP1_X2
CXP2_X2
CXP3_X2
CXP5_X2
CXP6_X2
CXP1_X3
CXP2_X3
CXP3_X3
CXP5_X3
CXP6_X3
CXP1_X4
CXP2_X4
CXP3_X4
CXP5_X4
CXP6_X4
CXP1_X5
CXP2_X5
CXP3_X5
CXP5_X5
CXP6_X5
CXP1_X6
CXP2_X6
CXP3_X6
CXP5_X6
CXP6_X6
2012-10-25 Page 249 of 366

This feature indicates the current and active Link configuration used by the Device.
Note that the configuration used for a Link between a Transmitter and a Receiver Device can be
controlled by the CxpLinkConfiguration feature of the Receiver Device and
CxpLinkConfigurationStatus can be read back after CxpLinkConfiguration is changed to know
when the required configuration is really active on the Link and ready to be used.
This feature returns the link configuration as the combination of the connection speed and the
number of active connections. For example "CXP6_X4" means each connection is operating at
CXP-6 speed (6.25 Gbps) and there are four connections in use, so the total speed on the virtual
single link is 25 Gbps.
12.5.3 CxpLinkConfigurationPreferred
Name CxpLinkConfigurationPreferred
Category CoaXPress
Level Recommended
Access Read
Unit -
Visibility Expert
Values CXP1_X1
CXP2_X1
CXP3_X1
CXP5_X1
CXP6_X1
CXP1_X2
CXP2_X2
CXP3_X2
CXP5_X2
CXP6_X2
CXP1_X3
CXP2_X3
CXP3_X3
CXP5_X3
CXP6_X3
CXP1_X4
CXP2_X4
CXP3_X4
CXP5_X4
CXP6_X4
CXP1_X5
CXP2_X5
2012-10-25 Page 250 of 366

CXP3_X5
CXP5_X5
CXP6_X5
CXP1_X6
CXP2_X6
CXP3_X6
CXP5_X6
CXP6_X6
Returns the preferred Link configuration of the Transmitter Device.
The application may attempt to set the CxpConnectionConfiguration feature of the Receiver
Device to the value this feature has.
12.5.4 CxpLinkConfiguration
Name CxpLinkConfiguration
Category CoaXPress
Level Recommended
Access Read/(Write)
Unit -
Visibility Beginner
Values CXP1_X1
CXP2_X1
CXP3_X1
CXP5_X1
CXP6_X1
CXP1_X2
CXP2_X2
CXP3_X2
CXP5_X2
CXP6_X2
CXP1_X3
CXP2_X3
CXP3_X3
CXP5_X3
CXP6_X3
CXP1_X4
CXP2_X4
CXP3_X4
CXP5_X4
CXP6_X4
CXP1_X5
2012-10-25 Page 251 of 366
CXP2_X5
CXP3_X5
CXP5_X5
CXP6_X5
CXP1_X6
CXP2_X6
CXP3_X6
CXP5_X6
CXP6_X6
This feature can be used to set the Link configuration for the communication between the
Receiver and Transmitter Device. If included, it should be read only on Transmitter Devices.
In most cases this feature does not need to be written because automatic discovery will set
configuration correctly.
Note the activation of a new configuration may take hundreds of milliseconds to complete.
So the requested configuration might not be active for a while. CxpLinkConfigurationStatus can
read back after CxpLinkConfiguration is changed to know when the required configuration is
really active on the Link and ready to be used.
The link configuration is specified as the combination of the connection speed and the number of
active connections. For example "CXP6_X4" means each connection is operating at CXP-6 speed
(6.25 Gbps) and there are four connections in use, so the total speed on a virtual single link is 25
Gbps.
12.5.5 CxpConnectionSelector
Name CxpConnectionSelector
Category CoaXPress
Level Recommended
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Values ≥0
Selects the CoaXPress physical connection to control.
2012-10-25 Page 252 of 366

Note that this selector should be set to 0, or omitted, when controlling features relating to the
CoaXPress uplink from the Receiver Device to the Transmitter Device, because only one
connection 0 is used for this purpose.
12.5.6 CxpConnectionTestMode
Name CxpConnectionTestMode[CxpConnectionSelector]
Category CoaXPress
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Off
Mode1
Enables the test mode for an individual physical connection of the Device.

• Off: Test mode is disabled.
• Mode1: Test mode is one.
This can be used to test communication errors of the system cabling between devices.
When enabled, this feature results in special test packets being sent continuously by the Device
on the connection specified by CxpConnectionSelector.
The Device receiving the test packet on the other end of the connection can check for errors by
reading its own corresponding CxpConnectionTestErrorCount and
CxpConnectionTestPacketCount features.
Typically, the test will need to be run for some time (e.g. minutes) to get a meaningful error rate.
12.5.7 CxpConnectionTestErrorCount
Name CxpConnectionTestErrorCount[CxpConnectionSelector]
Category CoaXPress
Level Recommended
Interface IInteger
Access Read/Write
2012-10-25 Page 253 of 366

Unit -
Visibility Expert
Values ≥0
Reports the current connection error count for test packets recieved by the device on the
connection selected by CxpConnectionSelector.
The transmission of those test packets is enabled by the CxpConnectionTestMode feature of the
Device on the other end of the connection under test.
This feature can be read at any time while a test is running. It can be written to zero when a test
is not running to reset the counter between tests.
12.5.8 CxpConnectionTestPacketCount
Name CxpConnectionTestPacketCount[CxpConnectionSelector]
Category CoaXPress
Level Recommended
Interface IInteger
Access Read/Write
Unit -
Visibility Expert
Values ≥0
Reports the current count for test packets recieved by the device on the connection selected by
CxpConnectionSelector.
The transmission of those test packets is enabled by the CxpConnectionTestMode feature of the
Device on the other end of the connection under test.
This feature can be read at any time while a test is running. It can be written to zero when the test
is not running to reset the counter between tests.
12.5.9 CxpPoCxpAuto
Name CxpPoCxpAuto
Category CoaXPress
Level Optional
Interface ICommand
2012-10-25 Page 254 of 366

Access Write
Unit -
Visibility Expert
Values -
Activate automatic control of the Power over CoaXPress (PoCXP) for the Link.
This feature shall be present only on receiver Device that controls the PoCXP.
12.5.10 CxpPoCxpTurnOff
Name CxpPoCxpTurnOff
Category CoaXPress
Level Optional
Interface ICommand
Access Write
Unit -
Visibility Expert
Values -
Disable Power over CoaXPress (PoCXP) for the Link.
This feature shall be present only on receiver Device that controls the PoCXP.
12.5.11 CxpPoCxpTripReset
Name CxpPoCxpTripReset
Category CoaXPress
Level Optional
Interface ICommand
Access Write
Unit -
Visibility Expert
Values -
Reset the Power over CoaXPress (PoCXP) Link after an over-current trip on the Device
connection(s).
2012-10-25 Page 255 of 366
This feature shall be present only on receiver device that controls the PoCXP.
12.5.12 CxpPoCxpStatus
Name CxpPoCxpStatus
Category CoaXPress
Level Optional
Access Read
Unit -
Visibility Expert
Values Auto
Off
Tripped
Returns the Power over CoaXPress (PoCXP) status of the Device.

• Auto: Normal automatic PoCXP operation.
• Off: PoCXP is forced off.
• Tripped: The Link has shut down because of an over-current trip.
This feature shall be present only on Receiver Device that controls the PoCXP.
2012-10-25 Page 256 of 366

13 User Set Control

This chapter describes the features for global control of the device settings. It allows loading or
saving factory or user-defined settings.
Loading the factory default User Set guarantees a state where a continuous acquisition can be
started using only the mandatory features.
13.1 UserSetControl
Name UserSetControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Beginner
Values -
Category that contains the User Set control features.
13.2 UserSetSelector
Name UserSetSelector
Category UserSetControl
Level Recommended
Access Read/Write
Unit -
Visibility Beginner
Values Default
UserSet0 (if 0 based), UserSet1,
…
Selects the feature User Set to load, save or configure.

• Default: Selects the factory setting user set.
2012-10-25 Page 257 of 366

• UserSet0: Selects the user set 0.

• UserSet1: Selects the user set 1.
• …
When Default User Set is selected and loaded using UserSetLoad, the device must be in default
factory settings state and must make sure the continuous acquisition use case works directly.
Default User Set is read-only and cannot be modified.
13.3 UserSetLoad
Name UserSetLoad[UserSetSelector]
Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Beginner
Values -
Loads the User Set specified by UserSetSelector to the device and makes it active.
13.4 UserSetSave
Name UserSetSave[UserSetSelector]
Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Beginner
Values -
Save the User Set specified by UserSetSelector to the non-volatile memory of the device.
13.5 UserSetDefault
Name UserSetDefault
2012-10-25 Page 258 of 366

Level Optional
Access Read/Write
Unit -
Visibility Beginner
Values Default
…
Selects the feature User Set to load and make active by default when the device is reset.
• Default: Select the factory setting user set.
• UserSet0: Select the user set 0.
• …
If Default is selected, the device will boot with the default factory settings and makes sure the
continuous acquisition use case is ready to be used.
13.6 UserSetDefaultSelector (Deprecated)

Name UserSetDefaultSelector
Level Optional
Access Read/Write
Unit -
Visibility Beginner
Values Default
…
This feature is deprecated (See UserSetDefault). Selects the feature User Set to load and make
active when the device is reset.
2012-10-25 Page 259 of 366

• Default: Select the factory setting user set.
• …
If Default is selected, the device will boot with the default factory settings and makes sure the
continuous acquisition use case works directly.
2012-10-25 Page 260 of 366

14 Chunk Data Control

Chunks are tagged blocks of data. The tags allow a chunk parser to dissect the data payload into
its elements and to identify the content.
The length of a frame varies depending on the number of activated chunks, but the user can
always expect a frame with the maximum size of PayloadSize.
With chunks disabled by setting ChunkModeActive to False the camera streams frames
consisting only of the image.
PayloadSize data
Image
Figure 14-1: Frame with chunks disabled
With chunks enabled by setting ChunkModeActive to True the camera streams frames
consisting of chunks. In this mode the image is a chunk too.
data
PayloadSize +
tag
Image Pixel I/O ...
Format
Figure 14-2: Frame with chunks enabled
Each chunk can be enabled or disabled using the ChunkSelector and ChunkEnable feature.
This allows controlling the embedding of different information in the payload.
The data in the chunks is exposed via the chunk parser. The naming scheme to access the data of
the chunk name is Chunkname.
14.1 ChunkDataControl
Name ChunkDataControl
2012-10-25 Page 261 of 366

Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Expert
Values -
Category that contains the Chunk Data control features.
14.2 ChunkModeActive
Name ChunkModeActive
Category ChunkDataControl
Level Recommended
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values True
False
Activates the inclusion of Chunk data in the payload of the image.
14.3 ChunkSelector
Name ChunkSelector
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Image
OffsetX
2012-10-25 Page 262 of 366
OffsetY
Width
Height
PixelFormat
PixelDynamicRangeMax
PixelDynamicRangeMin
Timestamp
LineStatusAll
CounterValue
TimerValue
ExposureTime
Gain
BlackLevel
LinePitchFrameID
SourceID
RegionID
TransferBlockID
TransferStreamID
TransferQueueCurrentBlockCount
StreamChannelID
Selects which Chunk to enable or control.
14.4 ChunkEnable
Name ChunkEnable[ChunkSelector]
Level Recommended
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values True
False
Enables the inclusion of the selected Chunk data in the payload of the image.
14.5 ChunkImage
Name ChunkImage
2012-10-25 Page 263 of 366

Level Recommended
Interface IRegister
Access Read
Unit -
Visibility Guru
Returns the entire image data included in the payload.
14.6 ChunkOffsetX
Name ChunkOffsetX
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Returns the OffsetX of the image included in the payload.
14.7 ChunkOffsetY
Name ChunkOffsetY
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
2012-10-25 Page 264 of 366

Returns the OffsetY of the image included in the payload.
14.8 ChunkWidth
Name ChunkWidth
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values >0
Returns the Width of the image included in the payload.
14.9 ChunkHeight
Name ChunkHeight
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values >0
Returns the Height of the image included in the payload.
14.10 ChunkPixelFormat
Name ChunkPixelFormat
Level Recommended
Access Read
Unit -
2012-10-25 Page 265 of 366
Visibility Expert
Values Mono1p
Mono2p
Mono4p
Mono8
Mono8s
Mono10
Mono10c3a64
Mono10c3p32
Mono10g12
Mono10msb
Mono10p
Mono10pmsb
Mono10s
Mono12
Mono12g
Mono12msb
Mono14
Mono16
R8
G8
B8
RGB8
RGB8_Planar
RGB8a32
RGBa8
RGB10
RGB10_Planar
RGB10g32
RGB10g32msb
RGB10p32
RGB10p32msb
RGB12
RGB12_Planar
RGB16
RGB16_Planar
RGB565p
BGR10
BGR12
BGR16
2012-10-25 Page 266 of 366
BGR565p
BGR8
BGRa8
YUV411_8
YUV422_8
YUV8
YCbCr411_8
YCbCr422_8
YCbCr601_411_8
YCbCr601_422_8
YCbCr601_8
YCbCr709_411_8
YCbCr709_422_8
YCbCr709_8
YCbCr8
BayerBG8
BayerGB8
BayerGR8
BayerRG8
BayerBG10
BayerBG10g12
BayerGB10
BayerGB10g12
BayerGR10
BayerGR10g12
BayerRG10
BayerRG10g12
BayerBG12
BayerBG12g
BayerGB12
BayerGB12g
BayerGR12
BayerGR12g
BayerRG12
BayerRG12g
BayerBG16
BayerGB16
BayerGR16
BayerRG16
Raw16
2012-10-25 Page 267 of 366
Raw8
Device-specific
Mono12Packed
BayerGR10Packed
BayerRG10Packed
BayerGB10Packed
BayerBG10Packed
BayerGR12Packed
BayerRG12Packed
BayerGB12Packed
BayerBG12Packed
RGB10V1Packed
BGR10V1Packed
RGB12V1Packed
- Deprecated:
Mono8Signed (Deprecated, use

Mono10Packed
RGBA8Packed (Deprecated, use RGBa8)
BGRA8Packed (Deprecated, use BGRa8)
RGB10V2Packed (Deprecated, use
RGB10p32)
BGR10V2Packed (Deprecated, use
BGR10p32)
RGB565Packed (Deprecated, use RGB565p)
BGR565Packed (Deprecated, use BGR565p)
YUV411Packed (Deprecated, use
YUV411_8_UYYVYY)
YUV422_8_UYVY)
2012-10-25 Page 268 of 366

YUV8_UYV)
YUYVPacked (Deprecated, use YUV422_8)
RGB8Planar (Deprecated, use
RGB8_Planar)
RGB10_Planar)
RGB12_Planar)
RGB16Planar (Deprecated) use
RGB16_Planar)
Returns the PixelFormat of the image included in the payload.

• Mono10c3a64: Mono 10 bit in 64 bit.
• Mono10c3p32: Mono 10 bit in 32bit.
• Mono10g12: Mono 10 bit grouped in 12 bit.
• Mono10msb: Mono 10 bit packed aligned on Msb.
• Mono10pmsb: Mono 10 bit packed aligned on Msb.
• Mono12g: Mono 12 bit grouped.
• Mono12msb: Mono 12 bit aligned on Msb.
• R8: Red 8 bit.
• G8: Green 8 bit.
2012-10-25 Page 269 of 366

• B8: Blue 8 bit.

• RGB8: Red, Green, Blue 8 bit
• RGB8a32: Red, Green, Blue 8 bit aligned in 32 bit pixel
• RGBa8: Red, Green, Blue 8 bit aligned on 8 bit
• RGB10g32: Red, Green, Blue 8 bit grouped in 32 bit pixel.
• RGB10g32msb: Red, Green, Blue 10 bit grouped in 32 bit pixel aligned on Msb.
• RGB10p32: Red, Green, Blue 10 bit packed in 32 bit pixel.
• RGB10p32msb: Red, Green, Blue 10 bit packed in 32 bit pixel.
• RGB565p: Red, Green, Blue 16 bit packet in 5, 6, 5 bits.
• BGR10: Blue, Green, Red 10 bit.
• BGR565p: Blue, Green, Red 16 bit packet in 5, 6, 5 bits.
• BGRa8: Blue, Green, Red, Alpha 8 bit.
• YUV411_8: YUV 411, 8 bit.
• YUV422_8: YUV 422 8 bit.
• YUV8: YUV 8 bit.
• YCbCr601_411_8: YCrCb 601 411 8 bit.
• YCbCr601_422_8: YCrCb 601 422 8 bit.
2012-10-25 Page 270 of 366

• YCbCr709_411_8: YCrCb 709 411 8 bit.

• YCbCr709_422_8: YCrCb 709 422 8 bit.
• YCbCr8: YCbCr 8 bit.
• BayerBG10g12: Bayer Blue Green 8 bit grouped on 12 bit.
• BayerGB10g12: Bayer Green Blue 10 bit grouped on 12 bit.
• BayerGR10g12: Bayer Green Red 10 bit grouped on 12 bit.
• BayerRG10g12: Bayer Red Green 10 bit grouped on 12 bit.
• BayerBG12: Bayer Blue Green 12 bit
• BayerBG12g: Bayer Blue Green 12 bit grouped.
• BayerGB12: Bayer Green Blue 12 bit
• BayerGB12g: Bayer Green Blue 12 bit grouped on 12 bit.
• BayerGR12g: Bayer Green Red 12 bit grouped on 12 bit.
• BayerRG12g: Bayer Red Green 12 bit grouped on 12 bit.
• Raw16: Raw 16 bit.
• Raw8: Raw bit.
2012-10-25 Page 271 of 366

• Mono12Packed: Mono 12 bit packed (GigE Vision Specific).

• BGR10V1Packed: BGR 10 bit packed (GigE Vision Specific).
Note that only a subset of the possible pixel formats is listed here.
See the PixelFormat feature for more details.
14.11 ChunkPixelDynamicRangeMin
Name ChunkPixelDynamicRangeMin
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Returns the minimum value of dynamic range of the image included in the payload.
14.12 ChunkPixelDynamicRangeMax
Name ChunkPixelDynamicRangeMax
Level Recommended
2012-10-25 Page 272 of 366

Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Returns the maximum value of dynamic range of the image included in the payload.
14.13 ChunkTimestamp
Name ChunkTimestamp
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Returns the Timestamp of the image included in the payload at the time of the FrameStart internal
event.
See Figure 5-3 for more details on FrameStart.
14.14 ChunkLineStatusAll
Name ChunkLineStatusAll
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
2012-10-25 Page 273 of 366

Returns the status of all the I/O lines at the time of the FrameStart internal event.
14.15 ChunkCounterSelector
Name ChunkCounterSelector
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Counter0 (If 0 based), Counter1,
Counter2,…
Selects which counter to retrieve data from.

• …
14.16 ChunkCounterValue
Name ChunkCounterValue[ChunkCounterSele
ctor]
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Returns the value of the selected Chunk counter at the time of the FrameStart event.
2012-10-25 Page 274 of 366
14.17 ChunkTimerSelector
Name ChunkTimerSelector
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values Timer0 (If 0 based), Timer1,
Timer2, …
Selects which Timer to retrieve data from.

• Timer0: Selects the first Timer.
• Timer1: Selects the first Timer.
• Timer2: Selects the second Timer.
• …
14.18 ChunkTimerValue
Name ChunkTimerValue[ChunkTimerSel
ector]
Level Recommended
Interface IFloat
Access Read
Unit us
Visibility Expert
Values >0
Returns the value of the selected Timer at the time of the FrameStart internal event.
2012-10-25 Page 275 of 366

14.19 ChunkExposureTime
Name ChunkExposureTime
Level Recommended
Interface IFloat
Access Read
Unit us
Visibility Expert
Values ≥0
Returns the exposure time used to capture the image.
14.20 ChunkGainSelector
Name ChunkGainSelector
Level Recommended
Access Read/Write
Unit -
Visibility Expert
Values All
Red
Green
Blue
Y
U
V
Tap1, Tap2, …
AnalogAll
AnalogRed
AnalogGreen
AnalogBlue
AnalogY
AnalogU
AnalogV
AnalogTap1, AnalogTap2, …
2012-10-25 Page 276 of 366

DigitalAll
DigitalRed
DigitalGreen
DigitalBlue
DigitalY
DigitalU
DigitalV
DigitalTap1, DigitalTap2, …
Selects which Gain to retrieve data from.

In general, there are 2 types of gain that can exist in a camera, analog or digital. Some camera
will implement one or other or both. This is why there are 3 possible sets of gain.
The first one, without the Analog or Digital prefix, is to be used when only one type of gain is
implemented. This permits to have an implementation independent way to set the gain.
The second and the third, with the Analog and Digital prefix, is to be used when both types of
gain are implemented. This permits to have independent control over each one.
• All: Gain will be applied to all channels or taps.
• Red: Gain will be applied to the red channel.
• Green: Gain will be applied to the green channel.
• Blue: Gain will be applied to the blue channel.
• Y: Gain will be applied to Y channel.
• U: Gain will be applied to U channel.
• V: Gain will be applied to V channel.
• …
• AnalogAll: Gain will be applied to all analog channels or taps.
• AnalogRed: Gain will be applied to the red analog channel.
• AnalogGreen: Gain will be applied to the green analog channel.
• AnalogBlue: Gain will be applied to the blue analog channel.
• AnalogY: Gain will be applied to Y analog channel.
• AnalogU: Gain will be applied to U analog channel.
• AnalogV: Gain will be applied to V analog channel.
2012-10-25 Page 277 of 366

• …
• DigitalAll: Gain will be applied to all digital channels or taps.
• DigitalRed: Gain will be applied to the red digital channel.
• DigitalGreen: Gain will be applied to the green digital channel.
• DigitalBlue: Gain will be applied to the blue digital channel.
• DigitalY: Gain will be applied to Y digital channel.
• DigitalU: Gain will be applied to U digital channel.
• DigitalV: Gain will be applied to V digital channel.
• …
14.21 ChunkGain
Name ChunkGain[ChunkGainSelector]
Level Recommended
Interface IFloat
Access Read
Unit -
Visibility Expert
Returns the gain used to capture the image.
14.22 ChunkBlackLevelSelector
Name ChunkBlackLevelSelector
Level Recommended
Access Read/Write
2012-10-25 Page 278 of 366
Unit -
Visibility Expert
Values All
Red
Green
Blue
Y
U
V
Tap1, Tap2, …
Selects which Black Level to retrieve data from.

• All: Black Level will be applied to all channels or taps.
• Red: Black Level will be applied to the red channel.
• Green: Black Level will be applied to the green channel.
• Blue: Black Level will be applied to the blue channel.
• Y: Black Level will be applied to Y channel.
• U: Black Level will be applied to U channel.
• V: Black Level will be applied to V channel.
• …
14.23 ChunkBlackLevel
Name ChunkBlackLevel[ChunkBlackLevelSelector]
Level Recommended
Interface IFloat
Access Read
Unit -
Visibility Expert
2012-10-25 Page 279 of 366

Returns the black level used to capture the image included in the payload.
14.24 ChunkLinePitch
Name ChunkLinePitch
Level Recommended
Interface IInteger
Access Read
Unit B
Visibility Expert
Values >0
Returns the LinePitch of the image included in the payload.
14.25 ChunkFrameID
Name ChunkFrameID
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Returns the unique Identifier of the frame (or image) included in the payload.
Recommended behavior of the identifier: It should start at a certain minimum value and keep
incrementing by one for each frame up to a maximum, then it wraps to the minimum again. Each
streaming channel should maintain the Frame ID separately.
Note: For GigE Vision, this chunk is not necessarly the block_id field included in the GVSP
headers but can be equal to it.
14.26 ChunkSourceID
Name ChunkSourceID
2012-10-25 Page 280 of 366

Level Optional
Access Read
Unit -
Visibility Expert
Values Source0 (if 0 based)
Source1
Source2
…
Returns the identifier of Source that the image comes from.

• Source0: Image comes from the Source 0.
• …
14.27 ChunkRegionID
Name ChunkRegionID
Level Optional
Access Read
Unit -
Visibility Expert
Values Region0 (if 0 based)
Region1
Region2
…
Returns the identifier of Region that the image comes from.

2012-10-25 Page 281 of 366
• Region0: Image comes from the Region 0.

• …
14.28 ChunkTransferBlockID
Name ChunkTransferBlockID
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Returns the unique identifier of the transfer block used to transport the payload.
The block ID is usually defined by the transport layer and repeated in the chunk for convenience.
14.29 ChunkTransferStreamID
Name ChunkTransferStreamID
Level Recommended
Access Read
Unit -
Visibility Expert
Values Stream0 (if 0 based)
Stream1
Stream2
Stream3
…
Returns identifier of the stream that generates this block.

2012-10-25 Page 282 of 366

• Stream0: Data comes from Stream0.
14.30 ChunkTransferQueueCurrentBlockCount
Name ChunkTransferQueueCurrentBlockCount
Level Optional
Interface IInteger
Access Read
Unit -
Visibility Expert
Values ≥0
Returns the current number of blocks in the transfer queue.
14.31 ChunkStreamChannelID
Name ChunkStreamChannelID
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Expert
Values >0
Returns identifier of the stream channel used to carry the block.
2012-10-25 Page 283 of 366

15 File Access Control
The File Access Controls chapter describes all features related to accessing files in the device.
It contains the definition of a generic file access schema for GenICam compliant devices. It is
based on a set of standard features that are controlled from adapter code which resides in the
GenICam reference implementation. The adapter code presents its services through an interface
inherited from std::iostream.
The model, on which the controls are based, is depicted in the following diagram::
IDevFileStream
IDevFileStreamBuf ODevFileStreamBuf
FileAccessAdapter File Protocol Adapter
Status Result Buffer Offset Length Operation File Select OpenMode
File Access Controls
File System code
(Persistent)
Storage
Device
Figure 15-1: File Access Model
2012-10-25 Page 284 of 366

It assumes that all operations, which can be done on the persistent storage, could be executed by
using operations with the semantic of fopen/fclose/fread/fwrite. The operations and their
parameters are mapped onto the features of the list of File Access Controls.
To provide a generic API on top of the File Access Controls, a FileAccessAdapter is defined in
the GenApi. T he Adapter provides two iostream interfaces to the device files:
• IDevFileStream Read from the device
• ODevFileStream Write to the device
The File Protocol Adapter is responsible for the mapping of the (I/O) DevFileStreamBuf actions
Open, Close, UnderFlow, Overflow on File Access Controls
Example Code for the streaminterface:
//GenApi::INodeMap * pInterface
ODevFileStream usersetWrite;
usersetWrite.open(pInterface, "UserSet1");
if( ! usersetWrite.fail() ){
usersetWrite << "Hello World\n";
}
usersetWrite.close();
IDevFileStream usersetRead;
usersetRead.open(pInterface, "UserSet1");
if( ! usersetRead.fail() ){
cout << usersetRead.rdbuf();
}
usersetRead.close();
2012-10-25 Page 285 of 366

File Access Control:
The FileSelector feature selects the target file in the device for the Operation. The entries of this
enumeration define the names of all files in the device that can be accessed via the File Access.
FileOperationSelector specifies the operation to execute on the file.
FileOperationExecute command starts the selected operation execution.
FileOpenMode is a parameter for the Open operation and controls the access mode (Read, Write,
ReadWrite) in which the file is opened.
FileOperationStatus returns the status of the last operation executed on the file. This feature
must return Success if the operation is executed as requested.
FileOperationResult returns the number of bytes successfully read/written bytes during the
previous Read or Write operations.
FileSize returns the size of the file in bytes.
The data, that is read from or written to the device, is exchanged between the application and the
device through the FileAccessBuffer feature. This register mapped FileAccessBuffer must be
written with the target data before executing the Write operation using FileOperationExecute.
For Read operation, the data can be read from the FileAccessBuffer after the Read operation has
been executed.
FileAccessOffset controls the starting position of the access in the file.
FileAccessLength controls the number of bytes to transfer to or from the FileAccessBuffer
during the following Read or Write operation.
Altogether, the features FileSelector, FileAccessOffset and FileAccessLength control the
mapping between the device file storage and the FileAccessBuffer.
FileSelector =FileA FileAccessBuffer
FileAccessOffset FileAccessLength
ODevFileStream
File A File B
Figure 15-2: Layout of File Access Buffer.
2012-10-25 Page 286 of 366

15.1 FileAccessControl
Name FileAccessControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Guru
Values -
Category that contains the File Access control features.
15.2 FileSelector
Name FileSelector
Category FileAccessControl
Level Recommended
Access Read/(Write)
Unit -
Visibility Guru
Values UserSetDefault
UserSet1
UserSet2
UserSet3
…
LUTLuminance
LUTRed
LUTGreen
LUTBlue
…
Selects the target file in the device.
2012-10-25 Page 287 of 366

The entries of this enumeration define the names of all files in the device that can be accessed via
the File access.
• UserSetDefault: The default user set of the device.
• UserSet1: The first user set of the device.
• UserSet2: The second user set of the device.
• UserSet3: The third user set of the device.
• …
• LUTLuminance: The Luminance LUT of the camera.
• LUTRed: The Red LUT of the camera.
• LUTGreen: The Green LUT of the camera.
• LUTBlue: The Blue LUT of the camera.
• …
15.3 FileOperationSelector
Name FileOperationSelector[FileSelector]
Level Recommended
Access Read/Write
Unit -
Visibility Guru
Values Open
Close
Read
Write
Delete
Selects the target operation for the selected file in the device. This Operation is executed when
the FileOperationExecute feature is called.
2012-10-25 Page 288 of 366

• Open: Opens the file selected by FileSelector in the device. The access mode in which
the file is opened is selected by FileOpenMode.
• Close: Closes the file selected by FileSelector in the device.
• Read: Reads FileAccessLength bytes from the device storage at the file relative offset
FileAccessOffset into FileAccessBuffer.
• Write: Writes FileAccessLength bytes taken from the FileAccessBuffer into the device
storage at the file relative offset FileAccessOffset.
• Delete: Deletes the file selected by FileSelector in the device. Note that deleting a device
file should not remove the associated FileSelector entry to allow future operation on this
file.
15.4 FileOperationExecute
Name FileOperationExecute[FileSelector][FileOperationSelector]
Level Recommended
Interface ICommand
Access (Read)/Write
Unit -
Visibility Guru
Values -
Executes the operation selected by FileOperationSelector on the selected file.
15.5 FileOpenMode
Name FileOpenMode[FileSelector]
Level Recommended
Access Read/(Write)
Unit -
Visibility Guru
Values Read
Write
ReadWrite
2012-10-25 Page 289 of 366

Selects the access mode in which a file is opened in the device.

• Read: This mode selects read-only open mode.
• Write: This mode selects write-only open mode.
• ReadWrite: This mode selects read and write open mode.
15.6 FileAccessBuffer
Name FileAccessBuffer
Level Recommended
Interface IRegister
Access Read/(Write)
Unit -
Visibility Guru
Defines the intermediate access buffer that allows the exchange of data between the device file
storage and the application.
This register mapped FileAccessBuffer must be written with the target data before executing a
Write operation. For Read Operation, the data can be read from the FileAccessBuffer after the
Read operation has been executed. The effective data transfer is done upon
FileOperationExecute execution (See Figure 14-2).
15.7 FileAccessOffset
Name FileAccessOffset[FileSelector][FileOperationSelector]
Level Recommended
Interface IInteger
Access Read/(Write)
Unit B
Visibility Guru
2012-10-25 Page 290 of 366

Values ≥0
Controls the Offset of the mapping between the device file storage and the FileAccessBuffer.
The FileAccessOffset defines the offset in bytes of the FileAccessBuffer relative to the
beginning of the selected File (See Figure 14-2). This feature is available only when
FileOperationSelector is set to Read or Write.
15.8 FileAccessLength
Name FileAccessLength[FileSelector][FileOperationSelector]
Level Recommended
Interface IInteger
Access Read/Write
Unit B
Visibility Guru
Values ≥0
Controls the Length of the mapping between the device file storage and the FileAccessBuffer.
The FileAccessLength defines the number of bytes to transfer to or from the FileAccessBuffer
(See Figure 14-2). This feature is available only when FileOperationSelector is set to Read or
Write.
15.9 FileOperationStatus
Name FileOperationStatus[FileSelector][FileOperationSelector]
Level Recommended
Access Read
Unit -
Visibility Guru
Values Success
Failure
…
2012-10-25 Page 291 of 366

Represents the file operation execution status.

Upon execution of a successful file operation, it must return Success. In case of complete or
partial failure of the operation, other return values can be defined to indicate the nature of the
error that happened. If only one fail status is defined, it should be defined as Failure.
• Success: File Operation was sucessful.
• Failure: File Operation failed.
15.10 FileOperationResult
Name FileOperationResult[FileSelector][FileOperationSelector]
Level Recommended
Interface IInteger
Access Read
Unit -
Visibility Guru
Values -
Represents the file operation result. For Read or Write operations, the number of successfully
read/written bytes is returned.
15.11 FileSize
Name FileSize[FileSelector]
Level Recommended
Interface IInteger
Access Read
Unit B
Visibility Guru
Values ≥0
Represents the size of the selected file in bytes.
2012-10-25 Page 292 of 366

2012-10-25 Page 293 of 366

16 Color Transformation Control
The Color Transformation chapter describes all features related to color Transformations in the
device.
The Color Transformation is a linear operation taking as input a triplet of Components (C0, C1,
C2) for a color pixel (Typicaly: Rin, Gin, Bin representing a RGB color pixel). This triplet is first
multiplied by a 3x3 matrix and then added to an offset triplet.
The equation is given by:
 C 0out   Gain00 Gain01 Gain02  C 0in   Offset 0 

R

G      
 C1out  =  Gain10 Gain11 Gain12  C1in  +  Offset1 
B
 C 2   Gain 20 Gain 21 Gain 22  C 2   Offset 2 
 out    in   
 Rout   RR RG RB  Rin   Roffset 

      
Equivalent:  Gout  =  GR GG GB  Gin  +  Goffset 
 B   BR BG BB  B   B 
 out    in   offset 
The descriptions below assume RGB to RGB transformation:

Where C0in is the first component of the incoming pixel
C1in is the second component of the incoming pixel
C2in is the third component of the incoming pixel
Gain00 is the red contribution to the red pixel (multiplicative factor)
Gain01 is the green contribution to the red pixel (multiplicative factor)
Gain02 is the blue contribution to the red pixel (multiplicative factor)
Gain10 is the red contribution to the green pixel (multiplicative factor)
Gain11 is the green contribution to the green pixel (multiplicative factor)
Gain12 is the blue contribution to the blue pixel (multiplicative factor)
Gain20 is the red contribution to the blue pixel (multiplicative factor)
Gain21 is the green contribution to the blue pixel (multiplicative factor)
Gain22 is the blue contribution to the blue pixel (multiplicative factor)
Offset0 is the red offset
Offset1 is the green offset
2012-10-25 Page 294 of 366

Offset2 is the blue offset

C0out is the first resulting component of the pixel after the transformation
C1out is the second resulting component of the pixel after the transformation
C2out is the third resulting component of the pixel after the transformation
Example for YUV convertion:

The Color Transformation can also be used outside of the simple scope of color correction on
RGB pixels. For instance, it can be used as a color convert to convert RGB to YUV.
Here is the example of this conversion for 8-bit pixels:
 Y   0.299 0.587 0.114  Rin   0 
      
U  =  − 0.147 − 0.289 0.436  Gin  + 128 
 V   0.615 − 0.515 − 0.100  Bin  128 
  
16.1 ColorTransformationControl
Name ColorTransformationControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Expert
Values -
Category that contains the Color Transformation control features.
16.2 ColorTransformationSelector
Name ColorTransformationSelector
Category ColorTransformationControl
Level Optional
Access Read/Write
2012-10-25 Page 295 of 366

Unit -
Visibility Expert
Values RGBtoRGB
RGBtoYUV
Device-specific
Selects which Color Transformation module is controlled by the various Color Transformation
features.
• RGBtoRGB: RGB to RGB color transformation.
• RGBtoYUV: RGB to YUV color transformation.
It is typically not available when a single Color Transformation module is supported.
16.3 ColorTransformationEnable
Name ColorTransformationEnable[ColorTransformationSelector]
Level Optional
Interface IBoolean
Access Read/Write
Unit -
Visibility Expert
Values True
False
Activates the selected Color Transformation module.
16.4 ColorTransformationValueSelector
Name ColorTransformationValueSelector[ColorTransformationSelector]
Level Optional
Access Read/Write
2012-10-25 Page 296 of 366

Unit -
Visibility Expert
Values Gain00
Gain01
Gain02
Gain10
Gain11
Gain12
Gain20
Gain21
Gain22
Offset0
Offset1
Offset2
Selects the Gain factor or Offset of the Transformation matrix to access in the selected Color
Transformation module.
• Gain00: Gain 0,0 of the transformation matrix.
• Offset0: Offset 0 of the transformation matrix.
16.5 ColorTransformationValue
Name ColorTransformationValue[ColorTransformationSelector]
[ColorTransformationValueSelector]
2012-10-25 Page 297 of 366

Level Optional
Interface IFloat
Access Read/Write
Unit -
Visibility Expert
Values Device-Specific
Represents the value of the selected Gain factor or Offset inside the Transformation matrix.
2012-10-25 Page 298 of 366

17 Action Control
The Action chapter describes all features related to Action Signals in the device.
Action Signals are a method to trigger actions in multiple devices at the same time (depending on
the specific transport layer). Action Signals are used in the device in the same way as e.g. digital
input lines.
One possible use for action signals is to raise a FrameStart trigger in multiple devices at the same
time.
On most transport layers Action Signals are implemented using broadcast protocol messages. To
allow a finegrained control which devices are allowed to react on the broadcasted action protocol
message, the features ActionDeviceKey, ActionGroupKey and ActionGroupMask define filter
conditions.
Each action protocol message contains an action device key, action group key and an action
group mask. If the device detects a match between this protocol information and one of the
actions selected by ActionSelector it raises the corresponding Action Signal.
See chapter 20.4 "Action Signal Examples" for typical uses cases.
17.1 ActionControl
Name ActionControl
Category Root
Level Recommended
Interface ICategory
Access Read
Unit -
Visibility Guru
Values -
Category that contains the Action control features.
17.2 ActionUnconditionalMode
Name ActionUnconditionalMode
Category ActionControl
Level Optional
2012-10-25 Page 299 of 366

Access Read/Write
Unit -
Visibility Guru
Values Off
On
Enables the unconditional action command mode where action commands are processed even
when the primary control channel is closed.
• Off: Unconditional mode is disabled.
• On: Unconditional mode is enabled.
17.3 ActionDeviceKey
Name ActionDeviceKey
Level Optional
Interface IInteger
Access Write-Only
Unit -
Visibility Guru
Values ≥0
Provides the device key that allows the device to check the validity of action commands. 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.
17.4 ActionQueueSize
Name ActionQueueSize
Level Optional
Interface IInteger
Access Read
2012-10-25 Page 300 of 366

Unit -
Visibility Guru
Values ≥0
Indicates the size of the scheduled action commands queue. This number represents the
maximum number of scheduled action commands that can be pending at a given point in time.
17.5 ActionSelector
Name ActionSelector
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Values >0
Selects to which Action Signal further Action settings apply.
17.6 ActionGroupMask
Name ActionGroupMask[ActionSelector]
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Values ≥0
Provides the mask that the device will use to validate the action on reception of the action
protocol message.
The device asserts the selected Action signal only if:
2012-10-25 Page 301 of 366

• The selected ActionDeviceKey is equal to the action device key in the action protocol
message.
• The logical AND-wise operation of the action group mask in the action protocol message
against the selected ActionGroupMask is non-zero.
• The selected ActionGroupKey is equal to the action group key in the action protocol
message.
17.7 ActionGroupKey
Name ActionGroupKey[ActionSelector]
Level Optional
Interface IInteger
Access Read/Write
Unit -
Visibility Guru
Values ≥0
Provides the key that the device will use to validate the action on reception of the action protocol
message.
The device asserts the selected Action signal only if :
• The selected ActionDeviceKey is equal to the action device key in the action protocol
message.
• The logical AND-wise operation of the action group mask in the action protocol message
against the selected ActionGroupMask is non-zero.
• The selected ActionGroupKey is equal to the action group key in the action protocol
message.
2012-10-25 Page 302 of 366

18 Source Control
The Source Control chapter describes the features related to multi-source acquisition devices. An
example of such a multi-source device would be a camera with 2 independent sensors (visible and
infra red light) that would transmit their data on a single camera`s physical connector but would
have independent controllable features.
18.1 Sources Control model with Multi-Regions and Transfer
This section explains the general model for control of the acquisition on multi-source devices.
The section also presents the relation of the sources with other elements such as the region of
interest and the data transfer control module that can be found in more sophisticated multi-source
devices.
2012-10-25 Page 303 of 366

Source1 Region1
Width and Height

features Transfer Control Stream0
Source1 Stream0 Sent to Stream
Channel 0
Source1 Region2
Width and Height

features

Stream1 Sent to Stream Link
Width and Height Channel 1
features
Source2

Stream2 Sent to Stream
Width and Height
Channel 2
features
Device
2012-10-25 Page 304 of 366

Figure 18-1: Multi-Source multi-Region Device with data stream Transfer control.
Multi-Source Features setting example
Figure 18-1 above presents an example of a relatively complex device supporting multi-sources,
multi-regions with data stream transfer control. This device features two regions of interest for each
video source. In this particular example, both regions of interest from Source1 are streamed on the
same output stream channel, while a separate stream channel is used for each region of interest of
Source2. The three stream channels are transmitted out of the device using the same external Link
to the target Host System.
The features setting for this use case is presented below. The detailed description of the feature to
control the Sources can be found in section 18.2: "Source Control features below. The features for
Region of interest and image format and handling are documented in chapter 4: "Image Format
Control" and chapter 19: "Transfer Control" presents the features for explicit control of data
Transfer.
So for the particular use case illustrated in Figure 18-1 above, the features would be set to:
Source 1, Region 1:
SourceSelector = Source1
RegionSelector[SourceSelector] = Region1
RegionMode[SourceSelector][RegionSelector] = On
RegionDestination[SourceSelector][RegionSelector] = Stream0
Width[SourceSelector] [RegionSelector] = 320
Height[SourceSelector][RegionSelector] = 240
Source 1, Region 2:
Source 1, Region 1 and 2, Transfer and Acquisition control:
TransferSelector = Stream0
TransferControlMode[TransferSelector] = UserControlled
TransferStreamChannel[TransferSelector] = 0
TransferStart[TransferSelector]
AcquisitionStart[SourceSelector]
…
AcquisitionStop[SourceSelector]
2012-10-25 Page 305 of 366

TransferStop[TransferSelector]
Source 2 Region 1:
Source 2 Region 2:
Source 1, Region 1 and 2, Transfer and Acquisition control:

…
2012-10-25 Page 306 of 366

18.2 Source Control features
This section describes the features related to the devices that support multiple video sources that
are transmitted over a single link. The virtual Stream channels of a Link are used to transport the
different video sources over a common physical connection.
The main feature in this section is the source selector feature (SourceSelector). This feature
enables the features associated to a given video source to be controlled on a per video source
basis even if they pertain to different feature categories. For instance, it can enable a user to
independently set the Width feature (Image Format Control category) and the Gain feature
(Analog Control category) for the two sources supported by a given device.
An example of independent features setting for a dual source device would be:
Width[SourceSelector] = 320
Gain[SourceSelector] = 60
…
Width[SourceSelector] = 240
Gain[SourceSelector] = 90
…
Features selected by the Source Selector Feature

The source selector feature can be an optional selector to a number of features defined in this
document based on the specificity of product it represents.
In order to simplify the standard text and feature descriptions, the optional source selector is not
propagated to all the features of the SFNC that it can potentially select. Table 9 summarizes
which features could potentially be selected by the source selector.
Table 9: Source Selector Potential Selectees

Categories Potential Selectees
Device Control The DeviceScanType feature can potentially be selected by the
source selector feature.
Note:
The DeviceTemperatureSelector, DeviceClockSelector and
DeviceSerialPortSelector features may have more enumeration
2012-10-25 Page 307 of 366
Categories Potential Selectees

entries.
Image Format Control All features of these categories could potentially be selected by
the source selector based on the product specificities.
Acquisition Control
Analog Control
LUT Control
Color Transformation Control
Digital I/O Control The features of these categories are likely not selected by the
Counter and Timer Control source selector but could be depending on the particular device
implementation.
Note:
The LineSelector, LineSource, CounterEventSource,
CounterResetSource, CounterTriggerSource and
TimerTriggerSource features may have more enumeration entries.
Event Control The EventSelector feature could have more enumeration entries.
In this case, the name of the source would be prepended to an
existing enumeration entry name. For instance, the
Source1AcquisitionStart and Source2AcquisitionStart
enumeration entries can be added to enable the generation of
events upon acquisition start for Source1 and Source2
respectively.
GenICam Control The TLParamsLocked feature could potentially be selected by the
Transport Layer Control The ClConfiguration, ClTimeSlotsCount and
DeviceTapGeometry feature could potentially be selected by the
User Set Control The features of this category are likely not selected by the source
selector feature.
Chunk Data Control The ChunkSelector feature could have more enumeration entries.
File Access Control The FileSelector feature could have more enumeration entries.
Action Control No features can be selected by the source selector feature.
18.3 SourceControl
Name SourceControl
Category Root
2012-10-25 Page 308 of 366
Level Optional
Interface ICategory
Access Read
Unit -
Visibility Expert
Values -
Category that contains the source control features.
18.4 SourceCount
Name SourceCount
Category SourceControl
Level Optional
Interface IInteger
Access Read/(Write)
Unit -
Visibility Expert
Values >= 1
Controls or returns the number of sources supported by the device.

This feature is generally read-only but can be writable if the number of sources supported by the
device is run-time programmable.
18.5 SourceSelector
Name SourceSelector
Category SourceControl
Level Optional
Access Read/Write
Unit -
Visibility Expert
Values Source0 (If 0 based)
Source1
2012-10-25 Page 309 of 366
Source2
…
All
Device-specific
Selects the source to control.

• Source0: Selects the data source 0.
• …
• All: Selects all the data sources.
The "All" value can be used to change the features of all the sources at the same time. For
example, this can be useful to simultaneously start and stop multiple acquisitions.
2012-10-25 Page 310 of 366

19 Transfer Control
The Transfer Control chapter describes the model and features related to the explicit control of
the transfer of the data acquired by a device.
A general model of the acquisition of images by a device and the role of the Transfer Control
module was already presented in the section 1.6 "Device Acquisition Model" and illustared in
detail in the section 18.1 "Sources Control model with Multi-Regions and Transfer".
So this chapter will concentrates only on describing the Transfer mechanism itself.
2012-10-25 Page 311 of 366

19.1 Transfer Control Model
The Transfer Control Model section describes the features related to the transfer of data by the
device. It describes the basic Transfer model and the typical behavior of the device when sending
data to the outside.
An acquisition typically generates images (or frames). Those images can be preprocessed (Ex:
Bayer conversion) before transferrimg them out by the Device. In certain cases, those images can
also be transformed in other type of data (such as an intensity histogram) by an internal image
processing module. So it is possible that in addition to the original image acquired, a transformed
image or some related data also need to be transferred out of the device. In the following model,
it is considered that the captured images are transformed in different data blocks by an optional
image processing module. Those data blocks are then sent to a transfer module on different data
streams. The Transfer module will then transmit those data blocks externally on one or many
streaming channels. This typical acquisition data flow is represented in Figure 19-1: Acquisition
and Transfer data flow.
Figure 19-1: Acquisition and Transfer data flow.
Acquisition
Images
Image
Processing
Blocks
Transfer
Block Queue Block Queue
Block n+1
Block n
Block n+1
Block n

Streaming Control Streaming Control
Streaming
channels
2012-10-25 Page 312 of 366

In summary, a transfer is the action of streaming data blocks to another device. Data blocks are
complex data structures that can represent images, image processing results or even files. The
transfer module is composed of one or many block Queue(s) and Streaming Controls section(s)
(see Figure 19-2.).
Figure 19-2: Transfer control section.
Data Blocks
Coming on a Stream
Transfer
Block Queue
Block n+1
Block n
Streaming Control
Streaming
Channel
Block Queue
A Block Queue is used to store data blocks for the time interval between its generation and its
transmission.
Streaming Control
The streaming control regulates the outgoing flow of data. The streaming can be in one of the
following states: Stopped, Stopping, Streaming and Paused. The transfer module always accepts
the new blocks of data from the image processing module regardless of the streaming state. The
transfer control features TransferStart, TransferStop, TransferAbort, TransferPause and
TransferResume allow the user to change the state of the streaming.
2012-10-25 Page 313 of 366

Figure 19-3: Transfer control state.
TransferStop or
TransferAbort or
TransferPause or TransferStart or
TransferResume TransferPause
TransferAbort
Stopped TransferStart or Paused

TransferResume
TransferStart TransferPause
TransferAbort or TransferResume
Transfer reach
TransferItemCount
Streaming
Transfer Abort or TransferStop TransferStop

The current item
transfer ended
TransferStop or
TransferStart or
Stopping TransferPause or
TransferResume
Streaming: Data blocks will be transmitted when enough data is available.

Stopping: Data blocks transmission is stopping. The current block transmission will be
completed and the transfer state will change to Stopped.
Stopped: Data blocks transmission is stopped.
Paused: Data blocks transmission is suspended immediately.
2012-10-25 Page 314 of 366

19.1 Transfer Control features
This section describes in detail the features related to the Transfer Control.
A detailed example of the usage of the Transfer Control features is presented in the section 18.1
"Sources Control model with Multi-Regions and Transfer".
19.2 TransferControl
Name TransferControl
Category Root
Level Recommended
Interface ICategory
Access ---
Visibility Expert
Unit -
Values -
Category for the data Transfer Control features.
19.3 TransferSelector
Name TransferSelector
Category TransferControl
Level Optional
Access Read/(Write)
Visibility Expert
Unit -
Values Stream0 (if 0 based),
Stream1,
Stream2,
…
All
Selects which stream transfers are currently controlled by the selected Transfer features.
2012-10-25 Page 315 of 366

• Stream0: The transfer features control the data stream 0.

• …
• All: The transfer features control all the data streams simulateneously.
19.4 TransferControlMode
Name TransferControlMode[TransferSelector]
Level Recommended
Access Read/(Write)
Visibility Expert
Unit -
Values Basic
Automatic
UserControlled
Selects the control method for the transfers.

• Basic: Transfer flow control mechanism is disabled. The TransferStart, TransferPause,

TransferResume, TransferStop and TransferAbort features are not available to the
user. This transfer mode is used to ensure compatibility with devices not aware of the
transfer flow control mechanism.
• Automatic: Transfer flow control mechanism is controlled automatically. The Transfer
features are controlled transparently by the acquisition features.
o TransferStart is called during the AcquisitionStart.
o TransferStop is never called.
o TransferAbort is called during the AcquisitionAbort.
o TransferOperationMode is read only and set to "Continuous".
If available, the TransferPause and TransferResume features are controlled by the user.
2012-10-25 Page 316 of 366

• UserControlled: Transfer flow control mechanism is controlled by the user. The

TransferMode, TransferStart, TransferStop, TransferAbort, TransferPause and
TransferResume features are used to control manually the flow of data. In this mode, the
features TransferOperationMode, TransferStart and TransferStop must be available.
If this feature is not present, the transfer control is assumed to be "Basic".
Note that the Transfers can also be controlled using external trigger signals (See
TransferTriggerSelector).
19.5 TransferOperationMode
Name TransferOperationMode[TransferSelector]
Level Optional
Access Read/(Write)
Visibility Expert
Unit -
Values Continuous
MultiBlock
Selects the operation mode of the transfer.

• Continuous: Blocks of data are transferred continuously until stopped with the
TransferStop command.
• MultiBlock: The transfer of the blocks of data terminates automatically after the
transmission of TransferBlockCount or when an explicit TransferStop command is
received.
If this feature is not present, the transfer mode is assumed to be "Continuous".
19.6 TransferBlockCount
Name TransferBlockCount[TransferSelector]
Level Optional
Interface IInteger
Access Read/(Write)
2012-10-25 Page 317 of 366

Visibility Expert
Unit -
Values >0
Specifies the number of data Blocks that the device should stream before stopping. This feature is
only active if the TransferOperationMode is set to MultiBlock.
19.7 TransferBurstCount
Name TransferBurstCount
Level Optional
Interface IInteger
Access Read/Write
Visibility Expert
Unit -
Values ≥1
Number of Block(s) to transfer for each TransferBurstStart trigger.

This feature is used only if the TransferBurstStart trigger is enabled and the TransferBurstEnd
trigger is disabled.
19.8 TransferQueueMaxBlockCount
Name TransferQueueMaxBlockCount[TransferSelector]
Level Optional
Interface IInteger
Access Read/(Write)
Visibility Expert
Unit -
Values >0
Controls the maximum number of data blocks that can be stored in the block queue of the
selected stream.
2012-10-25 Page 318 of 366

19.9 TransferQueueCurrentBlockCount
Name TransferQueueCurrentBlockCount[TransferSelector
]
Level Optional
Interface IInteger
Access Read
Visibility Expert
Unit -
Values -
Returns the number of Block(s) currently in the transfer queue.
19.10 TransferQueueMode
Name TransferQueueMode[TransferSelector]
Level Optional
Access Read/(Write)
Visibility Expert
Unit -
Values FirstInFirstOut
…
Specifies the operation mode of the transfer queue.

• FirstInFirstOut: Blocks first In are transferred Out first.
• …
19.11 TransferStart
Name TransferStart[TransferSelector]
2012-10-25 Page 319 of 366

Level Optional
Interface ICommand
Access (Read)/Write
Visibility Expert
Unit -
Values -
Starts the streaming of data blocks out of the device. This feature must be available when the
TransferControlMode is set to "UserControled". If the TransferStart feature is not writable
(locked), the application should not start the transfer and should avoid using the feature until it
becomes writable again.
19.12 TransferStop
Name TransferStop[TransferSelector]
Level Optional
Interface ICommand
Access (Read)/Write
Visibility Expert
Unit -
Values -
Stops the streaming of data Block(s). The current block transmission will be completed. This
feature must be available when the TransferControlMode is set to "UserControlled".
19.13 TransferAbort
Name TransferAbort[TransferSelector]
Level Optional
Interface ICommand
Access (Read)/Write
Visibility Expert
2012-10-25 Page 320 of 366

Unit -
Values -
Aborts immediately the streaming of data block(s). Aborting the transfer will result in the lost of
the data that is present or currently entering in the block queue. However, the next new block
received will be stored in the queue and transferred to the host when the streaming is restarted. If
implemented, this feature should be available when the TransferControlMode is set to
"UserControlled".
19.14 TransferPause
Name TransferPause[TransferSelector]
Level Optional
Interface ICommand
Access (Read)/Write
Visibility Guru
Unit -
Values -
Pauses the streaming of data Block(s). Pausing the streaming will immediately suspend the
ongoing data transfer even if a block is partially transfered. The device will resume its
transmission at the reception of a TransferResume command.
19.15 TransferResume
Name TransferResume[TransferSelector]
Level Optional
Interface ICommand
Access (Read)/Write
Visibility Guru
Unit -
Values -
Resumes a data Blocks streaming that was previously paused by a TransferPause command.
2012-10-25 Page 321 of 366

19.16 TransferTriggerSelector
Name TransferTriggerSelector[TransferSelector]
Level Optional
Access Read/Write
Visibility Guru
Unit -
Values TransferStart
TransferStop
TransferAbort
TransferPause
TransferResume
TransferActive
TransferBurstStart
TransferBurstStop
Selects the type of transfer trigger to configure.

• TransferStart: Selects a trigger to start the transfers.
• TransferStop: Selects a trigger to stop the transfers.
• TransferAbort: Selects a trigger to abort the transfers.
• TransferPause: Selects a trigger to pause the transfers.
• TransferResume: Selects a trigger to Resume the transfers.
• TransferActive: Selects a trigger to Activate the transfers. This trigger type is used when
TriggerActivation is set LevelHigh or levelLow.
• TransferBurstStart: Selects a trigger to start the transfer of a burst of frames specified
by TransferBurstCount.
• TransferBurstStop: Selects a trigger to end the transfer of a burst of frames.
19.17 TransferTriggerMode
Name TransferTriggerMode[TransferSelector][TransferTriggerSelector]
Level Recommended
2012-10-25 Page 322 of 366

Access Read/Write
Visibility Guru
Unit -
Values Off
On
Controls if the selected trigger is active.

• Off: Disables the selected trigger.
• On: Enable the selected trigger.
19.18 TransferTriggerSource
Name TransferTriggerSource[
Level Optional
Access Read/Write
Visibility Guru
Unit -
Values Line0 (If 0 based), Line1, Line2, …
Counter0Start (If 0 based),
Counter1Start, Counter2Start, …
Timer0Start (If 0 based),
Timer1Start, Timer2Start, …
Timer1End, Timer2End, …
Action2, …
Specifies the signal to use as the trigger source for transfers.

2012-10-25 Page 323 of 366

• Line0 (If 0 based), Line1, Line2, …: Specifies which physical line (or pin) and
associated I/O control block to use as external source for the transfer control trigger
signal.
• Counter0Start, Counter1Start, Counter2Start, …, Counter0End, Counter1End,
Counter2End, …: Specifies which of the Counter signal to use as internal source for the
selected trigger.
• Timer0Start, Timer1Start, Timer2Start, …, Timer0End, Timer1End, Timer2End,
…: Specifies which Timer signal to use as internal source for the selected trigger.
• Action0, Action1, Action2, …: Specifies which Action command to use as internal
source for the selected trigger.
19.19 TransferTriggerActivation
Name TransferTriggerActivation [
Level Optional
Access Read/Write
Visibility Guru
Unit -
Values RisingEdge
FallingEdge
AnyEdge
LevelHigh
LevelLow
Specifies the activation mode of the transfer control trigger.

• RisingEdge: Specifies that the trigger is considered valid on the rising edge of the source
signal.
• FallingEdge: Specifies that the trigger is considered valid on the falling edge of the
source signal.
• AnyEdge: Specifies that the trigger is considered valid on the falling or rising edge of the
source signal.
• LevelHigh: Specifies that the trigger is considered valid as long as the level of the source
signal is high. This can apply to TransferActive and TransferPause trigger.
2012-10-25 Page 324 of 366

• LevelLow: Specifies that the trigger is considered valid as long as the level of the source
signal is low. This can apply to TransferActive and TransferPause trigger.
19.20 TransferStatusSelector
Name TransferStatusSelector[TransferSelector]
Level Recommended
Access Read/Write
Visibility Guru
Unit -
Values Streaming
Paused
Stopping
Stopped
QueueOverflow
Selects which state of the transfer module to read.

• Streaming: Data blocks are transmitted when enough data is available.
• Stopping: Data blocks transmission is stopping. The current block transmission will be
completed and the transfer state will stop.
• Stopped: Data blocks transmission is stopped.
• Paused: Data blocks transmission is suspended immediately.
• QueueOverflow: Data blocks queue is in overflow state.
19.21 TransferStatus
Name TransferStatus[TransferStatusSelector]
Level Recommended
Interface IBool
Access Read
Visibility Guru
Unit -
2012-10-25 Page 325 of 366
Values True
False
Reads the state of the Transfer module signal selected by TransferStatusSelector.
19.22 TransferComponentSelector
Name TransferComponentSelector[TransferSelector]
Level Optional
Access Read/Write
Visibility Guru
Unit -
Values Red
Green
Blue
All
Selects the color component for the control of the TransferStreamChannel feature.
• Red: The TransferStreamChannel feature controls the index of the stream channel for
the streaming of the red plane of the planar pixel formats.
• Green: The TransferStreamChannel feature controls the index of the stream channel for
the streaming of the green plane of the planar pixel formats.
• Blue: The TransferStreamChannel feature controls the index of the stream channel for
the streaming of blue plane of the planar pixel formats.
• All: The TransferStreamChannel feature controls the index of the stream channel for
the streaming of all the planes of the planar pixel formats simultaneously or non planar
pixel formats.
This feature is only needed if the device supports planar pixel formats.
19.23 TransferStreamChannel
Name TransferStreamChannel[TransferSelector][Transfer
ComponentSelector]
2012-10-25 Page 326 of 366

Level Optional
Interface IInteger
Access Read/Write
Visibility Guru
Unit -
Values >0
Selects the streaming channel that will be used to transfer the selected stream of data. In general,
this feature can be omitted and the default streaming channel will be used.
2012-10-25 Page 327 of 366

20 Typical Standard Feature Usage Examples

This chapter shows examples of typical use cases of the standard acquisition and control of the
SFNC features in C/C++ pseudo-code.
For simplicity, the object name is omitted (e.g., AcquisitionStart() instead of
Camera.AcquisitionStart()) and the default state of the camera is assumed (e.g. Ready for a
continuous acquisition start without trigger).
20.1 Acquisition and Trigger Examples
/* Continuous acquisition when the camera is in its reset state. */

AcquisitionStart();
…
AcquisitionStop();
/* Single Frame acquisition in Hardware trigger mode using the external I/O Line 3. */
TriggerMode = On;
TriggerActivation = RisingEdge;
AcquisitionStart();
2012-10-25 Page 328 of 366

/* Multi-Frame acquisition started by a single Software trigger delayed by 1 millisecond.

The Trigger starts the whole sequence acquisition. The Exposure time for each frame is
set to 500 us.
*/
TriggerMode = On;
TriggerSource = Software;
TriggerDelay = 1000;
ExposureTime = 500;
AcquisitionStart();
TriggerSoftware();
/* Continuous acquisition in Hardware trigger mode. The Frame triggers are Rising Edge signals
coming from the physical Line 2. The Exposure time is 500us. An exposure end event is also
sent to the Host application after the exposure of each frame to signal that the inspected part
can be moved. The timestamp of the event is also read.
*/
TriggerMode = On;
ExposureTime = 500;
Register(Camera.EventExposureEnd, CallbackDataObject, CallbackFunctionPtr)
EventSelector = ExposureEnd;
EventNotification = On;
AcquisitionStart();
…
// In the callback of the ExposureEnd event, get the event timestamp:
Timestamp = EventExposureEndTimestamp;
…
AcquisitionStop();
2012-10-25 Page 329 of 366

/* Multi-Frame acquisition with each frame triggered by a Hardware trigger on Line 1.

A negative pulse of the exposure signal duration (500us) is also sent to the physical
output line 2 to activate a light during the exposure time of each frame. The end of
the sequence capture is signalled to the host with an acquisition end event.
*/
TriggerMode = On;
ExposureTime = 500;
LineMode = Output;
LineSource = ExposureActive
Register(Camera.EventAcquisitionEnd,CallbackDataObject,CallbackFunctionPtr)
EventSelector = AcquisitionEnd;
AcquisitionStart();
2012-10-25 Page 330 of 366

/* Continuous Acquisition of frames in bursts of 10 frames. Each burst is triggered by a

Hardware trigger on Line 1. The end of each burst capture is signalled to the host with a
FrameBurstEnd event.
*/
TriggerMode = On;
Register(Camera.EventFrameBurstEnd,CallbackDataObject,CallbackFunctionPtr)
EventSelector = FrameBurstEnd;
AcquisitionStart();
…
// In the callback of the end of burst event, get the event timestamp:
Timestamp = EventExposureEndTimestamp;
…
AcquisitionStop();
/* Multi-Frame Acquisition of 50 frames in 5 bursts of 10 frames. Each burst is triggered by a

Hardware trigger on Line 1.
*/
TriggerMode = On;
AcquisitionStart();
2012-10-25 Page 331 of 366

/* Line Scan continuous acquisition with Hardware Frame and Line trigger. */
TriggerMode = On;
TriggerSelector = LineStart;
TriggerMode = On;
AcquisitionStart();
...
AcquisitionStop();
/* Frame Scan continuous acquisition with Hardware Frame trigger and the
Exposure duration controlled by the Trigger pulse width.
*/
TriggerMode = On;
ExposureMode = TriggerWidth;
AcquisitionStart();
...
AcquisitionStop();
2012-10-25 Page 332 of 366

/* Frame Scan continuous acquisition with 1 Hardware trigger controlling

the start of the acquisition and 2 others harware triggers to start and stop
the exposure of each frame.
*/
TriggerMode = On;
ExposureMode = TriggerControlled;
TriggerSelector = ExposureStart;
TriggerMode = On;
TriggerSelector = ExposureStop;
TriggerMode = On;
AcquisitionStart();
...
AcquisitionStop();
2012-10-25 Page 333 of 366

20.2 Counter and Timer Examples
/* Counts the number of rising edge triggers signals received on Line1 and the number of
Frame Start events in Hardware triggered Continuous acquisition to verify that no trigger
were missed.
*/
TriggerMode = On;
CounterSelector = Counter1;
CounterEventSource = Line1;
CounterEventActivation = RisingEdge;
CounterReset();
CounterEventSource = FrameStart;
CounterReset();
AcquisitionStart();
…
AcquisitionStop();
NbTrigger = CounterValue;
NbFrameStart = CounterValue;
if (NbTrigger != NbFrameStart)
printf("Error ! Trigger missed.");
2012-10-25 Page 334 of 366

/* Use a counter to generate an event at line 200 of each captured Frame

in a continuous acquisition.
*/
CounterEventSource = LineStart;
CounterDuration = 200;
CounterTriggerSource = FrameStart;
CounterResetSource = CounterTrigger;
Register(Camera.EventCounter1End,CallbackDataObject,CallbackFunctionPtr)
EventSelector = Counter1End;
AcquisitionStart();
…
AcquisitionStop();
/* Generate a 200us Timer pulse (Strobe) delayed by 100 us on the physical output Line 2.
The Timer pulse is started using a trigger coming from physical input Line 1.
*/
TimerDelay = 100;
TimerTriggerSource = Line1;
TimerTriggerActivation = RisingEdge;
LineMode = Output;
2012-10-25 Page 335 of 366

/* Use of a Timer to measure the length in microseconds of a negative pulse on the

physical input Line1. An Event is also generated to the host application to signal
the end of the pulse.
*/
TimerTrigger = Line1;
TimerTriggerActivation = LevelLow;
Register(Camera.EventLine1RisingEdge,CallbackDataObject,CallbackFunctionPtr)
EventSelector = Line1RisingEdge;
EventNotifications = On;
/* Wait for the event on the host to read the time. */
…
PulseDuration = TimerValue;
2012-10-25 Page 336 of 366

20.3 I/O Examples
/* Read the inverted Status of the physical Line 1. */

LineMode = Input;
CurrentState = LineStatus;
/* Output of the Exposure signal of each frame on the physical Line 2. */

LineMode = Output;
LineSource = ExposureActive;
/* User Output of a positive TTL signal on physical Line 2. */

LineMode = Output;
LineFormat = TTL;
LineSource = UserOutput2;
UserOutputSelector = UserOutput2;
UserOutputValue = True;
2012-10-25 Page 337 of 366

20.4 Action Signal Examples
/* Triggered Single Frame acquisition using the Action Signal 1. */

TriggerMode = On;
TriggerSource = Action1;
ActionDeviceKey = 0x12345678;
ActionSelector = 1
ActionGroupKey = 0x1
ActionGroupMask = 0x1
AcquisitionStart();
/* Generate a 200us Timer pulse (Strobe) on the physical output Line 2.

The Timer pulse is started using a trigger coming from Action Signal 3.
*/
TimerTriggerSource = Action3;
LineMode = Output;
ActionDeviceKey = 0x12345678;
ActionSelector = Action3
ActionGroupKey = 0x1
ActionGroupMask = 0x7
2012-10-25 Page 338 of 366

21 Acknowledgements
The following companies have participated in the elaboration of the Standard Features Naming
Convention:
Company Represented by
Teledyne DALSA Eric Carey, Eric Bourbonnais, Peifang Zhou
SVS-Vistek Gerd Reichle
Stemmer Imaging Sascha Dorenbeck, Rupert Stelz, Martin Kersting
SICK IVP Mattias Johannesson
Pleora Technologies Francois Gobeil, Vincent Rowley
National Instruments Chris Graf, Tony Iglesias, Johann Scholtz, Eric Gross
MVTec Software Christoph Zierl
Matrox Imaging Stéphane Maurice
MathWorks Mark Jones
Leutron Vision Jan Becvar, Stefan Thommen
JAI Tue Moerk, Michael Krag, Ole Krogh Joergensen, Karsten Ingeman
Christensen
Euresys Jean-Michel Wintgens, Yves Joskin
e2v semiconductors Frédéric Mathieu
Basler Fritz Dierks, Alex Happe, Andreas Gaer, Thies Möller, Sven Seeger
AIA Jeff Fryman
2012-10-25 Page 339 of 366

22 Tap Geometry Appendix
22.1 Motivations
This appendix defines standard names to uniquely identify the geometrical properties of
most device`s sensor taps.
For example, the initial release of the Camera Link® standard didn`t include any
information about the geometrical properties of taps.
Frame grabbers are able to reconstruct on-the-fly the image from multi-tap cameras.
Camera manufacturer should clearly specify what geometry(ies) is (are) required. Frame
grabber manufacturer should also clearly specify what geometry(ies) is (are) supported.
The customer can then check the compatibility, and select the appropriate geometry for the
camera and the frame grabber.
Considering the limited amount of cases, a unique name is assigned for each geometry.
22.2 Identifying the Geometrical Properties

22.2.1 Image Geometrical Properties
The relevant geometrical properties required for reconstructing the image:
• Vantage point: an enumerated type of parameter that specifies the
position of the pixel with coordinate X=1, Y=1 in the scene.
{Top-Left, Top-Right, Bottom-Left, Bottom-Right}
Default is Top-Left.
• ImageWidth: an integer type of parameter declaring the image width
expressed in pixels.
• ImageHeight: an integer type of parameter declaring the image height
expressed in pixels. This parameter is irrelevant in case of line-scan or
tdi cameras.
• TapGeometry: an enumerated type of parameter that summarize
following properties for each tap:
o XStart : X-coordinate of the first pixel column
o YStart : Y-coordinate if the first pixel row
o XEnd : X-coordinate of the last pixel column
o YEnd : Y-coordinate of the last pixel row
2012-10-25 Page 340 of 366

o XStep : difference of X-coordinates between consecutive pixel

columns; X-step is positive when X-coordinates are increasing
along a row; it is negative otherwise.
o YStep : difference of Y-coordinates between consecutive pixel rows;
Y-step is positive when Y-coordinates is increasing at the end of a
line; it is negative otherwise.
o Allocation of taps to ports. The camera taps are indexed using following
conventional sorting rule:
First by increasing values of YStart then by increasing value of
XStart. The tap T1 is the camera tap that exhibits the smallest
XStart for the smallest YStart.
22.2.1.1 Restrictions
All zones have the same size.
Zones are not overlapping.
All zones have the same number of taps.
All taps are carrying the same amount of pixels.
22.2.1.2 Tap Naming Convention

A tap configuration for area-scan camera is designated by:
<TapGeometryX>-<TapGeometryY>
A tap configuration for line-scan or tdi-line-scan camera is designated by:
<TapGeometryX>
TapGeometryX is designated by <ZoneX>X(<TapX>)(<ExtX)>)
<ZoneX>: an integer in range {1, 2, 3, 4, 8, 10} declaring number
of zones encountered across horizontal direction.
<TapX>: an integer in range {∅, 2, 3, 4, 8, 10} declaring the
number of consecutive pixels across horizontal direction that are
output simultaneously from a zone. This field is omitted when all
pixels are in the same column.
<ExtX>: a letter in range {∅, E, M} declaring the location of the
pixels extractors across horizontal direction. Value E indicates
that pixel extractors are at both ends of the line. Value M indicates
that pixel extractors are at middle of the line. This field is omitted
when all pixel extractors are all at the left of each zone.
2012-10-25 Page 341 of 366

TapGeometryY is designated by <ZoneY>Y(<TapY>)(<ExtY)>)

<ZoneY>: an integer in range {1, 2} declaring number of zones
encountered across vertical direction.
<TapY>: an integer in range {∅, 2} declaring the number of
consecutive pixels across vertical direction that are output
simultaneously from a zone. This field is omitted when all pixels
are in the same line.
<ExtY>: a letter in range {∅, E} declaring the location of the
pixels extractors across vertical direction. Value E indicates that
pixel extractors are at both top and bottom lines. This field is
omitted when all pixel extractors are at all the top line.
22.2.1.3 Tap Geometrical Properties

The following tables provide description of all the tap geometry configurations. For every
configuration the first and last pixel belonging to that tap, as well as the pixel increment
corresponding to the given tap is listed.
This table enumerates the standard tap geometries. The table is sorted by increasing
number of taps. It displays the values of the 6 geometrical properties for each tap.
Table 23-1 Tap geometrical properties – One, two and three taps
Geometry name Tap geometrical properties
Area- Line- Tap
X Start X End Step X Y Start Y End Step Y
scan scan
1X-1Y 1X Tap1 1 W 1 1 H 1
Tap1 1 W-1 2 1 H 1
1X2-1Y 1X2
Tap2 2 W 2 1 H 1
Tap1 1 W/2 1 1 H 1
2X-1Y 2X
Tap2 W/2+1 W 1 1 H 1
Tap1 1 W/2 1 1 H 1
2XE-1Y 2XE
Tap2 W W/2+1 -1 1 H 1
Tap1 W/2 1 -1 1 H 1
2XM-1Y 2XM
Tap2 W/2+1 W 1 1 H 1
Tap1 1 W 1 1 H-1 2
1X-1Y2
Tap2 1 W 1 2 H 2
Tap1 1 W 1 1 H/2 1
1X-2YE
Tap2 1 W 1 H H/2+1 -1
Tap1 1 W-2 3 1 H 1
1X3-1Y 1X3 Tap2 2 W-1 3 1 H 1
Tap3 3 W 3 1 H 1
2012-10-25 Page 342 of 366

Area- Line- Tap
scan scan
Tap1 1 W/3 1 1 H 1
3X-1Y 3X Tap2 W/3+1 2W/3 1 1 H 1
Tap3 2W/3+1 W 1 1 H 1
2012-10-25 Page 343 of 366

Table 23-2 Tap geometrical properties – Four taps

Area- Line- Tap
scan scan
Tap1 1 W-3 4 1 H 1
Tap2 2 W-2 4 1 H 1
1X4-1Y 1X4
Tap3 3 W-1 4 1 H 1
Tap4 4 W 4 1 H 1
Tap1 1 W/4 1 1 H 1
Tap2 W/4+1 W/2 1 1 H 1
4X-1Y 4X
Tap3 W/2+1 3W/4 1 1 H 1
Tap4 3W/4+1 W 1 1 H 1
Tap1 1 W/2-1 2 1 H 1
Tap2 2 W/2 2 1 H 1
2X2-1Y 2X2
Tap3 W/2+1 W-1 2 1 H 1
Tap4 W/2+2 W 2 1 H 1
Tap1 1 W/2-1 2 1 H 1
Tap2 2 W/2 2 1 H 1
2X2E-1Y 2X2E
Tap3 W-1 W/2+1 -2 1 H 1
Tap4 W W/2+2 -2 1 H 1
Tap1 W/2-1 1 -2 1 H 1
Tap2 W/2 2 -2 1 H 1
2X2M-1Y 2X2M
Tap3 W/2+1 W-1 2 1 H 1
Tap4 W/2+2 W 2 1 H 1
Tap1 1 W-1 2 1 H/2 1
Tap2 2 W 2 1 H/2 1
1X2-2YE
Tap3 1 W-1 2 H H/2+1 -1
Tap4 2 W 2 H H/2+1 -1
Tap1 1 W/2 1 1 H/2 1
Tap2 W/2+1 W 1 1 H/2 1
2X-2YE
Tap3 1 W/2 1 H H/2+1 -1
Tap4 W/2+1 W 1 H H/2+1 -1
Tap1 1 W/2 1 1 H/2 1
Tap2 W W/2+1 -1 1 H/2 1
2XE-2YE
Tap3 1 W/2 1 H H/2+1 -1
Tap4 W W/2+1 -1 H H/2+1 -1
Tap1 W/2 1 -1 1 H/2 1
Tap2 W/2+1 W 1 1 H/2 1
2XM-2YE
Tap3 W/2 1 -1 H H/2+1 -1
Tap4 W/2+1 W 1 H H/2+1 -1
2012-10-25 Page 344 of 366

Table 23-3 Tap geometrical properties –Eight taps

Area- Line- Tap Step
X Start X End Step X Y Start Y End
scan scan Y
Tap1 1 W-7 8 1 H 1
Tap2 2 W-6 8 1 H 1
Tap3 3 W-5 8 1 H 1
Tap4 4 W-4 8 1 H 1
1X8-1Y 1X8
Tap5 5 W-3 8 1 H 1
Tap6 6 W-2 8 1 H 1
Tap7 7 W-1 8 1 H 1
Tap8 8 W 8 1 H 1
Tap1 1 W/8 1 1 H 1
Tap2 W/8+1 2W/8 1 1 H 1
Tap3 2W/8+1 3W/8 1 1 H 1
Tap4 3W/8+1 4W/8 1 1 H 1
8X-1Y 8X
Tap5 4W/8+1 5W/8 1 1 H 1
Tap6 5W/8+1 6W/8 1 1 H 1
Tap7 6W/8+1 7W/8 1 1 H 1
Tap8 7W/8+1 W 1 1 H 1
Tap1 1 W/4-1 2 1 H 1
Tap2 2 W/4 2 1 H 1
Tap3 W/4+1 W/2-1 2 1 H 1
Tap4 W/4+1 W/2 2 1 H 1
4X2-1Y 4X2
Tap5 W/2+1 3W/4-1 2 1 H 1
Tap6 W/2+2 3W/4 2 1 H 1
Tap7 3W/4+1 W-1 2 1 H 1
Tap8 3W/4+2 W 2 1 H 1
Tap1 1 W/2-1 2 1 H/2 1
Tap2 2 W/2 2 1 H/2 1
Tap3 W-1 W/2+1 -2 1 H/2 1
Tap4 W W/2+2 -2 1 H/2 1
2X2E-2YE
Tap5 1 W/2-1 2 H H/2+1 -1
Tap6 2 W/2 2 H H/2+1 -1
Tap7 W-1 W/2+1 -2 H H/2+1 -1
Tap8 W W/2+2 -2 H H/2+1 -1
2012-10-25 Page 345 of 366

Table 23-4 Tap geometrical properties –Ten taps

Area- Line- Tap Step
X Start X End Step X Y Start Y End
scan scan Y
Tap1 1 W-9 10 1 H 1
Tap2 2 W-8 10 1 H 1
Tap3 3 W-7 10 1 H 1
Tap4 4 W-6 10 1 H 1
Tap5 5 W-5 10 1 H 1
1X10-1Y 1X10
Tap6 6 W-4 10 1 H 1
Tap7 7 W-3 10 1 H 1
Tap8 8 W-2 10 1 H 1
Tap9 9 W-1 10 1 H 1
Tap10 10 W 10 1 H 1
Tap1 1 W/10 1 1 H 1
Tap2 W/10+1 2W/10 1 1 H 1
Tap3 2W/10+1 3W/10 1 1 H 1
Tap4 3W/10+1 4W/10 1 1 H 1
Tap5 4W/10+1 5W/10 1 1 H 1
10X-1Y 10X
Tap6 5W/10+1 6W/10 1 1 H 1
Tap7 6W/10+1 7W/10 1 1 H 1
Tap8 7W/10+1 8W/10 1 1 H 1
Tap9 8W/10+1 9W/10 1 1 H 1
Tap10 9W/10+1 W 1 1 H 1
2012-10-25 Page 346 of 366

22.3 Tap Geometry Drawings
22.3.1 Single Tap Geometry

1X-1Y (area-scan)
1 zone in X, 1 zone in Y.
Step X = 1
Tap 1
X1 X2 XW-1 XW
Y1 Y1 Y1 Y1
X1 X2 XW-1
Y2 Y2 Y2
Step Y = 1
X1 X2 XW-1 XW
YH-1 YH-1 YH-1 YH-1
X1 X2 XW-1 XW
YH YH YH YH
Figure 23-1 Geometry 1X-1Y (area-scan)

1X (line-scan)
1 zone in X.
Step X = 1
Tap 1
1 2 W-1 W
Figure 23-2 Geometry 1X (line-scan)
2012-10-25 Page 347 of 366

22.3.2 Dual Tap Geometries

1X2-1Y (area-scan)
1 zone in X with 2 taps, 1 zone in Y.
Step X = 2
Tap 1
Tap 2
X1 X2 XW-1 XW
Y1 Y1 Y1 Y1
X1 X2 XW-1 XW
Y2 Y2 Y2 Y2
Step Y = 1
X1 X2 XW-1 XW
YH-1 YH-1 YH-1 YH-1
X1 X2 XW-1 XW
YH YH YH YH
Figure 23-3 Geometry 1X2-1Y (area-scan)

1X2 (line-scan)
1 zone in X with 2 taps.
Step X = 2
Tap 1
Tap 2
1 2 W-1 W
Figure 23-4 Geometry 1X2 (line-scan)
2012-10-25 Page 348 of 366

2X-1Y (area-scan)
2 zones in X, 1 zone in Y.
Step X =
Tap 1
Step X =
Tap 2
XW/2+1
X1 X2 XW/2 Y1
XW-1 XW
Y1 Y1 Y1 Y1 Y1
X1 X2 XW-1 XW
Y2 Y2 Y2 Y2
Step Y =
X1 X2 XW-1 XW
YH 1 YH 1 YH 1 YH 1
XW/2+1
X1 X2 X W/2 YH
XW-1 XW
YH YH YH YH YH

2X (line-scan)
2 zones in X.
Step X = 1
Tap 1
Step X = 1
Tap 2
1 2 W/2 W/2+1 W-1 W
2012-10-25 Page 349 of 366

2XE-1Y (area-scan)
2 zones in X with end extraction, 1 zone in Y.
Step X = 1 Step X = -1
Tap 1 Tap 2
X1 X2 XW/2 XW/2+1 XW-1 XW

Y1 Y1 Y1 Y1 Y1 Y1
X1 X2 XW-1 XW
Y2 Y2 Y2 Y2
Step Y = 1
X1 X2 XW-1 XW
YH-1 YH-1 YH-1 YH-1
X1 X2 X W/2 XW/2+1 XW-1 XW
YH YH YH YH YH YH
Figure 23-7 Geometry 2XE-1Y (area-scan)

2XE (line-scan)
2 zones in X with end extraction.
Step X = 1 Step X = -1
Tap 1 Tap 2
1 2 W/2 W/2+1 W-1 W
Figure 23-8 Geometry 2XE (line-scan)
2012-10-25 Page 350 of 366

2XM-1Y (area-scan)
2 zones in X with middle extraction, 1 zone in Y.
Step X = -1
Tap 1
Step X = 1
Tap 2
X1 X2 XW/2 XW/2+1 X W-1 XW

Y1 Y1 Y1 Y1 Y1 Y1
X1 X2 X W-1 XW
Y2 Y2 Y2 Y2
Step Y = 1
X1 X2 X W-1 XW
YH-1 YH-1 YH-1 YH-1
X1 X2 X W/2 XW/2+1 XW-1 XW
YH YH YH YH YH YH
Figure 23-9 Geometry 2XM-1Y (area-scan)

2XM (line-scan)
2 zones in X with middle extraction.
Step X = -
= Tap 1
Step X =
Tap 2
W/2+1
1 2 W/ W- W
2 1
Figure 23-10 Geometry 2XM (line-scan)
2012-10-25 Page 351 of 366

1X-1Y2 (area-scan)
1 zone in X, 1 zone in Y with 2 taps.
Step X = 1
Tap 1
Tap 2
X1 X2 XW-1 XW
Y1 Y1 Y1 Y1
X1 X2 XW-1 XW
Y2 Y2 Y2 Y2
Step Y = 2
X1 X2 XW-1 XW
YH-1 YH-1 YH-1 YH-1
X1 X2 XW-1 XW
YH YH YH YH
Figure 23-11 Geometry 1X-1Y2 (area-scan)

1X-2YE (area-scan)
1 zone in X, 2 zones in Y with end extraction.
Step X =
Tap 1
X1 X2 XW-1 XW
Step Y =
Y1 Y1 Y1 Y1
X1 X2 XW-1 XW
YH/2 YH/2 YH/2 YH/2
Step Y = -
X1 X2 XW-1 XW
YH/2+1 YH/2+1 YH/2+1 YH/2+1
X1 X2 XW-1 XW
YH YH YH YH
Tap 2
Step X =
Figure 23-12 Geometry 1X-2YE (area-scan)
2012-10-25 Page 352 of 366

22.4 Triple Tap Geometries

1X3-1Y (area-scan)
Step X =
Tap 1
Tap 2
Tap 3
X1 X2 X3 XW-2 XW-1 XW
Y Y Y Y1 Y1 Y1
Y2 Y2 Y2 Y Y2 Y2
Step Y =
Y 1 Y 1 Y 1 Y 1 Y 1 Y 1
Y Y Y Y Y Y

1X3 (line-scan)
Step X =
Tap 1
Tap 2
Tap 3
1 2 3 W- W- W
2 1
2012-10-25 Page 353 of 366

3X-1Y (area-scan)
Step X =
Tap 1
Step X =
Tap 2
Step X =
Tap 3
XW/3+1 X2W/3+1
X1 XW/3 Y1
X2W/ Y1
XW
Y Y 3 Y1
X1 XW/3 X W/3+ X2W/ X 2W/3+ XW
Y Y 1 1 Y2
Step Y =
X1 XW/3 X W/3+ X2W/ X 2W/3+ XW

Y 1 Y 1 1 3 1 Y 1
X1 XW/3 X W/3+ X2W/ X 2W/3+ XW

Y Y 1 1 Y

3X (line-scan)
3 zones in X.
Step X =
Tap 1
Step X =
Tap 2
Step X =
Tap 3
1 W/ W/3+1 2W 2W/3+1 W
3 /3
2012-10-25 Page 354 of 366

22.5 Quad Tap Geometries

1X4-1Y (area-scan)
Step X =
Tap 1
Tap 2
Tap 3
Tap 4
X1 X2 X3 X4 XW-3 XW-2 XW-1 XW

Y1 Y1 Y1 Y1 Y1 Y1 Y1 Y1
Y2 Y2 Y2 Y2 Y2 Y2 Y2 Y2
Step Y =

Y 1 Y 1 Y 1 Y 1 Y 1 Y 1 Y 1 Y 1

Y Y Y Y Y Y Y Y

1X4 (line-scan)
Step X =
Tap 1
Tap 2
Tap 3
Tap 4
1 2 3 W-3 W-2 W-1

4 W
2012-10-25 Page 355 of 366

4X-1Y (area-scan)
Step X =
Tap 1
Step X =
Tap 2 Step X =
Tap 3 Step X =
Tap 4
X1 XW/4 X W/4+ XW/2 X W/2+ X3W/ X 3W/4+ XW

Y1 Y1 1 Y1 1 4 1 Y1
Y2 Y2 1 Y 1 4 1 Y2
Step Y =

Y 1 Y 1 1 Y 1 1 4 1 Y 1
X1 XW/4 X W/4+ XXW/22 X W/2+ X3W/ X 3W/4+ XW

Y Y 1 Y
Y 1 4 1 Y

4X (line-scan)
4 zones in X.
Step X = 1
Tap 1
Step X = 1
Tap 2 Step X = 1
Tap 3 Step X = 1
Tap 4
1 W/4 W/4+1 W/2 W/2+1 3W/4+1

3W/4 W
2012-10-25 Page 356 of 366

2X2-1Y (area-scan)
2 zones in X with 2 taps, 1 zone in Y.
Step X =
Tap 1
Tap 2 Step X =
Tap 3
Tap 4
X1 X2 X W/2- XXW/22 X W/2+ XW/2+ XW-1 XW

Y1 Y1 1 Y
Y11 1 2 Y1 Y1
Y2 Y 1 Y
Y 1 2 Y Y2
Step Y =

YH 1 Y 1 1 Y
Y 11 1 2 Y 1 YH 1
Y YH 1 Y
YHH 1 2 YH Y

2X2 (line-scan)
2 zones in X with 2 taps.
Step X =
Tap 1
Tap 2 Step X =
Tap 3
Tap 4
1 2 W/2-1 W/2 W/2+1 W/2+2 W-1

W
2012-10-25 Page 357 of 366

2X2E-1Y (area-scan)
2 zones in X with 2 taps and end extraction, 1 zone in Y.
Step X = Step X =
Tap 1 Tap 3
Step X Tap 4
X1 X2 X W/2- XXW/22 X W/2+ X

W/2+ XW-1 XW
Y1 Y1 1 Y
Y11 1 2 Y1 Y1
X1 X2 X W/2- XXW/22 X W/2+ X
W/2+ XW-1 XW
Y2 Y2 1 Y
Y22 1 2 Y2 Y2
Step Y =
X1 X2 X W/2- XXW/22 X W/2+ X

W/2+ XW-1 XW
YH 1 YH 1 1 Y
YHH 11 1 2 YH 1 YH 1
X1 X2 X W/2- XXW/22 X W/2+ X
W/2+ XW-1 XW
YH YH 1 Y
YHH 1 2 YH YH
Figure 23-23 Geometry 2X2E-1Y (area-scan)

2X2E (line-scan)
2 zones in X with 2 taps and end extraction.
See similar geometries for building a drawing.
Step X = Step X =
Tap 1 Tap 3
Tap 2 Tap 4
1 W/4 W/4+1 W/2 W/2+1 3W/4+1

3 W
W/
Figure 23-24 Geometry 2X2E (line-scan)
2012-10-25 Page 358 of 366

2X2M-1Y (area-scan)
2 zones in X with 2 taps and middle extraction, 1 zone in Y.
Step X =
Tap 1
Tap 2
Step X =
Tap 3
Tap 4

Y1 Y1 1 Y
Y11 1 2 Y1 Y1
Y2 Y2 1 Y
Y22 1 2 Y2 Y2
Step Y =

YH 1 YH 1 1 Y
YHH 11 1 2 YH 1 YH 1
YH YH 1 Y
YHH 1 2 YH YH
Figure 23-25 Geometry 2X2M-1Y (area-scan)

2X2M (line-scan)
2 zones in X with 2 taps and middle extraction.
Step X =
Tap 1
Tap 2
Step X =
Tap 3
Tap 4
1 2 W/2-1 W/2 W/2+1 W/2+2 W-1
W
Figure 23-26 Geometry 2X2M (line-scan)
2012-10-25 Page 359 of 366

1X2-2YE (area-scan)
1 zone in X with 2 taps, 2 zones in Y with end extraction.
Step X = 2
Tap 1
Tap 2
X1 X2 XW-1 XW
Y1 Y1 Y1 Y1
Step Y = 1
X1 X2 XW-1 XW
YH/2 YH/2 YH/2 YH/2
Step Y = -1
X1 X2 XW-1 XW
YH/2+1 YH/2+1 YH/2+1 YH/2+1
X1 X2 XW-1 XW
YH YH YH YH
Tap 3
Tap 4
Step X = 2
Figure 23-27 Geometry 1X2-2YE (area-scan)
2012-10-25 Page 360 of 366

2X-2YE (area-scan)
2 zones in X, 2 zones in Y with end extraction.
Step X = 1
Tap 1
Step X = 1
Tap 2
X1 XW/2 XW/2+1 XW
Y1 Y1 Y1 Y1
Step Y = 1
X1 XW/2 XW/2+1 XW
YH/2 YH/2 YH/2 YH/2
Step Y = -1
X1 XW/2 XW/2+1 XW
YH/2+1 YH/2+1 YH/2+1 YH/2+1
X1 XW/2 XW/2+1 XW
YH YH YH YH
Tap 3
Step X = 1
Tap 4
Step X = 1
Figure 23-28 Geometry 1X2-2YE (area-scan)
2012-10-25 Page 361 of 366

2XE-2YE (area-scan)
2 zones in X with end extraction, 2 zones in Y with end extraction.
Step X = Step X = -
Tap 1 Tap 2
X1 XW/2 X W/2+ XW
Step Y = Step Y =
Y1 Y1 1 Y1
X1 XW/2 X W/2+ XW
YH/2 YH/2 1 YH/2
X1 XW/2 X W/2+ XW
YH/2 1 Y / 1 YH/2 1
X1 XW/2 X W/2+ XW
Y YH 1 YH
Tap 3 Tap 4
Step X = Step X = -
Figure 23-29 Geometry 2XE-2YE (area-scan)
2012-10-25 Page 362 of 366

2XM-2YE (area-scan)
2 zones in X with middle extraction, 2 zones in Y with end extraction.
Step X = -1
Tap 1
Step X = 1
Tap 2
X1 XW/2 XW/2+1 XW
Y1 Y1 Y1 Y1
Step Y = 1
X1 XW/2 XW/2+1 XW
YH/2 YH/2 YH/2 YH/2
Step Y = -1
X1 XW/2 XW/2+1 XW
YH/2+1 YH/2+1 YH/2+1 YH/2+1
X1 XW/2 XW/2+1 XW
YH YH YH YH
Tap 3
Step X = -1
Tap 4
Step X = 1
Figure 23-30 Geometry 2XM-2YE (area-scan)
2012-10-25 Page 363 of 366

22.6 Octal Tap Geometries
1X8-1Y (area-scan)
1X8 (line-scan)
8X-1Y (area-scan)
8X (line-scan)
8 zones in X.
4X2-1Y (area-scan)
4 zones in X with 2 taps, 1 zone in Y.
4X2 (line-scan)
4 zones in X with 2 taps.
2012-10-25 Page 364 of 366

2X2E-2YE (area-scan)
2 zones in X with 2 taps, 2 zones in Y with 2 taps.
Step X = Step X =
Tap 1 Tap 3
Tap 2 Tap 4
X1 X2 X W/2- XXW/22 X W/2+ X

W/2+ XW-1 XW
Y Y Y
Y Y Y
X1 X2 X W/2- XXW/22 X W/2+ X
W/2+ XW-1 XW
Y Y 1 Y
Y 1 2 Y Y
Step Y = Step Y
X2
Y
X1 X2 XW
Y Y Y
X1 X2 X2 XW
Y Y Y YH/2+1
X1 X2 X W/2- XXW/22 X
W/2+ X
W/2+ XW-1 XW
Y Y 1 Y
Y 1 2 Y Y
X1 X2 X W/2- XXW/22 X
W/2+ X
W/2+ XW-1 XW
Y Y Y
Y Y Y
Tap 5 Tap 7
Tap 6 Tap 8
Step X = Step X =
Figure 23-31 Geometry 2X2E-2YE (area-scan)
2012-10-25 Page 365 of 366

22.7 Deca Tap Geometries
1X10-1Y (area-scan)
1X10 (line-scan)
10X-1Y (area-scan)
10X (line-scan)
10 zones in X.
2012-10-25 Page 366 of 366

GenICam SFNC 2 0 0 PDF

Uploaded by

Copyright:

Available Formats

GenICam SFNC 2 0 0 PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

GenICam SFNC 2 0 0 PDF

Uploaded by

Copyright:

Available Formats

Version 2.

0 Standard Features Naming Convention

2012-10-25 Page 1 of 366

TABLE OF FIGURES .............................................................................................................. 14

1.1 CONVENTIONS ............................................................................................................. 27

2.1 DEVICE CONTROL ........................................................................................................ 35

3 DEVICE CONTROL ......................................................................................................... 62

3.1 DEVICECONTROL ......................................................................................................... 62

2012-10-25 Page 2 of 366

3.8 DEVICEVERSION .......................................................................................................... 64

3.45 DEVICEREGISTERSSTREAMINGSTART ......................................................................... 81

4 IMAGE FORMAT CONTROL ........................................................................................ 88

4.32 DEINTERLACING ........................................................................................................ 111

5 ACQUISITION CONTROL ............................................................................................ 115

5.1 ACQUISITION RELATED VOCABULARY AND SIGNALS.................................................. 115

6 DIGITAL I/O CONTROL ............................................................................................... 150

6.1 DIGITALIOCONTROL ................................................................................................. 151

2012-10-25 Page 5 of 366

6.4 LINEINVERTER ...........................................................................................................153

7 COUNTER AND TIMER CONTROL ........................................................................... 160

7.1 COUNTERANDTIMERCONTROL.................................................................................. 160

8 EVENT CONTROL ......................................................................................................... 176

8.1 EVENTCONTROL ........................................................................................................ 178

2012-10-25 Page 6 of 366

8.5.2 EVENTEXPOSUREEND ................................................................................................ 185

9 ANALOG CONTROL ..................................................................................................... 189

9.1 ANALOGCONTROL ..................................................................................................... 190

10 LUT CONTROL ............................................................................................................... 203

10.1 LUTCONTROL ...........................................................................................................203

11 GENICAM CONTROL ................................................................................................... 206

11.1 ROOT ......................................................................................................................... 206

12 TRANSPORT LAYER CONTROL ............................................................................... 208

12.1 TRANSPORT LAYER FEATURES ...................................................................................209

12.1.2 PAYLOADSIZE ............................................................................................................ 209

12.2.44 GEVGVCPHEARTBEATDISABLE ............................................................................... 232

12.5.7 CXPCONNECTIONTESTERRORCOUNT ........................................................................ 253

13 USER SET CONTROL .................................................................................................... 257

13.1 USERSETCONTROL .................................................................................................... 257

14 CHUNK DATA CONTROL ............................................................................................ 261

14.1 CHUNKDATACONTROL .............................................................................................. 261

2012-10-25 Page 10 of 366

14.29 CHUNKTRANSFERSTREAMID .................................................................................... 282

15 FILE ACCESS CONTROL ............................................................................................. 284

15.1 FILEACCESSCONTROL ............................................................................................... 287

16 COLOR TRANSFORMATION CONTROL ................................................................ 294

16.1 COLORTRANSFORMATIONCONTROL .......................................................................... 295

17 ACTION CONTROL ....................................................................................................... 299

17.1 ACTIONCONTROL ...................................................................................................... 299

18 SOURCE CONTROL ...................................................................................................... 303

19 TRANSFER CONTROL ................................................................................................. 311

19.1 TRANSFER CONTROL MODEL.....................................................................................312

19.1 TRANSFER CONTROL FEATURES .................................................................................315

20 TYPICAL STANDARD FEATURE USAGE EXAMPLES ......................................... 328

20.1 ACQUISITION AND TRIGGER EXAMPLES .....................................................................328

21 ACKNOWLEDGEMENTS ............................................................................................. 339

22 TAP GEOMETRY APPENDIX ...................................................................................... 340

22.1 MOTIVATIONS ............................................................................................................ 340

2012-10-25 Page 12 of 366

1X2-1Y (area-scan)............................................................................................................. 348