This page provides the documentation of the HALCON uEye image acquisition interface ... the image acquisition uses a ring buffer with three image buffers.
Documentation
ImageAcquisitionInterfaceforIDSuEyeCameras
Interface:
uEye
Revision:
13.0.2
Date:
2016-12-22
HALCONVersion:
13.0
General
SystemRequirements
Installation
Features
UsingMultipleCameras
UsingMultipleThreads
ImageTimestamp
ReachingFullFrameRatesWithUSBCameras
FALCON/EAGLECompatibilityMode
Parametersforinfo_framegrabber
Parametersforopen_framegrabber
Parametersforset_framegrabber_param
Parametersforget_framegrabber_param
DeprecatedParameters
DeprecatedParameters
Operatorset_framegrabber_lut
Operatorget_framegrabber_lut
Operatorset_framegrabber_callback
Operatorget_framegrabber_callback
Operatorgrab_image_start
Operatorgrab_image
Operatorgrab_image_async
Operatorgrab_data
Operatorgrab_data_async
Operatorclose_framegrabber
HDevelopExamples
ReleaseNotes
GeneralThispageprovidesthedocumentationoftheHALCONuEyeimageacquisitioninterfaceforaccessingtheUSBuEye,USB3uEyeand
GigEuEyecamerasfrom
IDSImagingDevelopmentSystemsGmbH.
Registeredcustomerscandownloadthe
latestrevisionofthisinterfacefromthe
MVTecWWWserver.
SystemRequirements
IntelcompatiblePCwithWindows7(32-bitor64-bit)
ornewerthatisalsosupportedbythevendor-specificSDK,
orLinuxwithkernel2.6.9(orhigher),andUSB
interfaceorGigabitEthernetnetworkadapter,respectively.
Windows32bit:uEyedriver(version3.70.0000or
higher)uEye_usb.sysoruEye_eth.sys.Typically,these
filesresideinthedirectory%WINDIR%\system32\drivers.
Windows64bit:uEyedriver(version3.70.0000or
higher)uEye_usb_64.sysoruEye_eth_64.sys.Typically,
thesefilesresideinthedirectory
%WINDIR%\system32\drivers.
Linux:uEyedriver(version3.70.0000orhigher)
ueyeusbdorueyeethd.Typically,thesefilesresideinthe
directories/usr/local/share/ueye/ueyeethdor
/usr/local/share/ueye/ueyeusbd.
Ifyoudonothavethisdriver,pleasecontactIDSImagingDevelopment
SystemsGmbHorthevendorfromwhichyouboughtthecamera.
Windows32bit:uEyeDLLuEye_api.dllversion
3.70.0000orhigher.ThisDLLmustbewithinyoursearchpath%PATH%
(typically,itresidesinthedirectory%WINDIR%\system32).
Windows64bit:uEyeDLLuEye_api_64.dll
version3.70.0000orhigher.ThisDLLmustbewithinyoursearchpath
%PATH%(typically,itresidesinthedirectory
%WINDIR%\system32).
Linux:uEyesharedlibrarylibueye_api.so
version3.70.0000orhigher.Typically,thesharedlibraryresidesin
thedirectory/usr/lib/.Ifyoudonothavethisfile,please
contactIDSImagingDevelopmentSystemsGmbHorthevendorfromwhich
youboughtthecamera.Pleasenote,thatyouhavetoinstallahigher
APIversionthan3.70tousethefullfunctionalityofnewercamera
models.PleasehavealookatIDSImagingDownloadPage.
Windows:HALCONimageacquisitioninterfacehAcquEye.dll
orhAcquEyexl.dll,respectively.
Ifyouhaveproperlyinstalledtheinterface,bothDLLsshould
resideinbin\%HALCONARCH%withinthe
HALCONbasedirectory%HALCONROOT%youhavechosenduringthe
installationofHALCON.
Linux:HALCONimageacquisitioninterfacehAcquEye.so
orhAcquEyexl.so,respectively.
Bothfilesshouldresideinthedirectorylib/$HALCONARCH
withintheHALCONbasedirectory%HALCONROOT%.
InstallationOnlywheninstallingorupdatingtheinterfacemanuallyfollowthesesteps:
Windows:Extractthearchivecontainingtheinterfacefilestothe
HALCONbasedirectory%HALCONROOT%(Note:Administratorprivilegesmaybe
requiredforthisstep).Additionally,youhavetomovetheinterface
examplestothedirectory%HALCONEXAMPLES%manually.
Linux:Extractthearchivecontainingtheinterfacefilestothe
HALCONbasedirectory$HALCONROOT.
Features
Multiplecameras.
Synchronousandasynchronousgrabbing.
Imagecropping.
Externaltriggerwithadjustabletriggerdelay.
SupportsuEyetimestamp(timeofimagecreation).
Softwarecontrolofframerate,exposure,andpixelclocksettings.
Softwarecontrolofbrightness,contrast,andedgeenhancement.
Softwarecontrolofgain,gammacorrection,andwhitebalancing.
Softwarecontrolofthestrobeparameters.
Softwarecontrolofthedigitalinputandoutputport.
Supportoflookuptables.
Supportofuser-specificcallbackfunction.
FALCON/EAGLEcompatibilitymode.
UsingMultipleCamerasIfusingmultipleuEyecameras,pleasemakesurethateachcamerahasanuniquedeviceID.YoucanmanuallysetthesedeviceIDsby
useoftheauxiliaryprogramIDSCameraManager
underWindows(orueyesetidunderLinux,respectively),whichis
partoftheuEyedriverinstallation.Notethatyoucan
requestallactuallyaccessibledevicesandvalidportsbycallingthe
operatorinfo_framegrabber(...'info_boards'...).
UsingMultipleThreadsIfusingmultiplethreads,callopen_framegrabberandthecorrespondingclose_framegrabberalwaysinthesamethreadtoavoidunpredictable
behaviorofyourapplication.
ImageTimestampTheoperatorget_image_timetypicallyreturnsthecreationtimeoftheHALCONimageobject.Sincerevision4.6
oftheuEyeinterface,thesystemscreationtimeofthecameraimage
isreturned(seeUEYEIMAGEINFO::UEYETIMEunderis_GetImageInfo()intheuEyemanual).
ReachingFullFrameRatesWithUSBCamerasModernprocessorsandoperatingsystemsaredesignedtobeenergyefficient.Thiscanalsohaveunwantedeffects.InthemodernCore
i3/i5/i7Intelprocessors,theUSBbusisalsooptimizedtooperateina
power-saving,energy-efficientmanner.
Asaresult,USBuEyecamerascannotbeoperatedusingthe
maximumavailableframerateinthismode.UseIDSCameraManager'sCPU
Idle-Statessettings(accessiblevia'Additionalfunctions'button)to
ensurethefullperformanceoftheUSBbusinconnectionwitha
uEyeindustrialcamera.
FALCON/EAGLECompatibilityModeIfyouwanttoportanexistingFALCON/EAGLEapplicationtoanuEyeapplication,youcanenabletheFALCON/EAGLEcompatibilitymode
tousetheexistingFALCON/EAGLEparameterswithoutfurtherchanges.
It'snotpossibletoopenaFALCON/EAGLEdevicewiththeuEyeImage
AcquisitionInterface.YoucanenabletheFALCON/EAGLEcompatibility
modeeitherbyspecifyingoneofthepossiblecameratypevalues'auto',
'pal','ntsc','secam','s-auto','s-pal','s-ntsc'or's-secam'during
open_framegrabber,orbycalling
set_framegrabber_param(...,'compatibility_mode','enable')
explicitly.
IftheFALCON/EAGLEcompatibilitymodehasbeenenabledyoucanalsouse
alltheparametersoftheFALCON/EAGLEinterface(suchas'hue'or
'synclevel').However,thesesettingswillhavenoeffectonthe
uEyecameras.Furthermore,thereexistthefollowing
limitations:
Sincetheframeratedependsonthesystemperformancetheactualframe
ratecanbedifferent.
TheuEyecameraprovidesonlyonevideoport,thusport
switchingisnotpossible.
IfyouusetheCameraTypevalues'(s-)pal'and'(s-)secam'the
actualsensorsizeoftheuEyecameramustbeatleast
[768,576].
Parametersforinfo_framegrabber
Parameter
ValueList
Type
Kind
Description
'bits_per_channel'
[5,8,10,12,16]
integer
pre-defined
Valuesforbitsperchannel.
'camera_type'
['CAMFILE:','ini','.','default','/cam/set1','/cam/set2','']or
['auto','ntsc','pal','secam','s-auto','s-ntsc','s-pal','s-secam',
'falcon']incompatibilitymode
string
pre-defined
Syntaxforcameraconfigurationfileand/orpre-definedlistofpossiblevaluesforcameratype.
'color_space'
['default','raw','gray','rgb','rgby','rgb555']
string
pre-defined
Valuesforcolorspace.
'defaults'
[1,1,0,0,0,0,'defaultorinterlaced',8,'default',-1.0,'false','default','0',0,0]
mixed
pre-defined
Defaultvaluesforopen_framegrabber.
'device'
['0','1',...,'254']
string
dynamic
Pre-definedlistofpossibledevicenumbers.
'external_trigger'
['false','true']
string
pre-defined
Valuesfortheexternaltrigger.
'field'
[]
Unused.
'general'
[]
string
pre-defined
InformationabouttheHALCONuEyeinterface.
'generic'
['','num_buffers=']
string
pre-defined
ValuelistfortheGenericparameter.
'horizontal_resolution'
[1,2,3,4,5,6,8,16]
integer
pre-defined
Valuelistforhorizontalresolution.
'image_height'
[]
Unsupportedquery.
'image_width'
[]
Unsupportedquery.
'info_boards'
['device:']
string
dynamic
Alistoftheavailabledevices.
'parameters'
['']
string
pre-defined
Pre-definedparametersoftheHALCONinterface.
'parameters_readonly'
['']
string
pre-defined
Pre-definedread-onlyparametersoftheHALCONinterface.
'parameters_writeonly'
['']
string
pre-defined
Pre-definedwrite-onlyparametersoftheHALCONinterface.
'port'
[]
Unused.
'revision'
''
string
pre-defined
RevisionnumberoftheuEyeinterface.
'start_column'
[]
Unsupportedquery.
'start_row'
[]
Unsupportedquery.
'vertical_resolution'
[1,2,3,4,5,6,8,16]
integer
pre-defined
Valuelistforverticalresolution.
Parametersforopen_framegrabber
Parameter
Values
Default
Type
Description
Name
'uEye'
string
NameoftheHALCONinterface.
HorizontalResolution
1,2,3,4,5,6,8,16
1
integer
Desiredhorizontalresolutionofthecameraimage:
1:Usefullresolution.
2...16:Subsamplingorbinning(dependsonthedevice)byfactor2...16
Notethatthesetvalueistheminimumpossiblehorizontalresolution
factorforthisinstance.NotethatnotalluEyemodelssupport
subsamplingorbinning.Ifbothissupported,subsamplingischosen
becauseofframerateadvantages.
VerticalResolution
1,2,3,4,5,6,8,16
1
integer
Desiredverticalresolutionofthecameraimage:
1:Usefullresolution.
2...16:Subsamplingorbinning(dependsonthedevice)byfactor2...16
Notethatthesetvalueistheminimumpossibleverticalresolution
factorforthisinstanceNotethatnotalluEyemodelssupportsubsampling
orbinning.Ifbothissupported,subsamplingischosenbecauseofframe
rateadvantages.
ImageWidth
0,
0
integer
Widthofthedesiredimagepart('0'standsforthecompleteimage).NotethatImageWidthmustbeamultipleof4(specificmodelsmay
havefurtherlimits).Notethatthesetvalueisthemaximumpossible
widthforthisinstance!
ImageHeight
0,
0
integer
Heightofthedesiredimagepart('0'standsforthecompleteimage).NotethatImageHeightmustbeamultipleof2(specificmodelsmay
havefurtherlimits).Notethatthesetvalueisthemaximumpossible
heightforthisinstance!
StartRow
0,
0
integer
Rowcoordinateoftheupperleftpixelwithinthedesiredimagepart.ThestepsizeofStartRowdependsontheusedcameramodel.If
ImageHeightissetto0,thenboththefirstANDlast
StartRowrowsoftheimagematrixarediscarded.
StartColumn
0,
0
integer
Columncoordinateoftheupperleftpixelwithinthedesiredimagepart.ThestepsizeofStartColumndependsontheusedcameramodel.
IfImageWidthissetto0,thenboththefirstANDlast
StartColumncolumnsoftheimagematrixarediscarded.
Field
---
Ignored.
BitsPerChannel
5,8,10,12,16
8
integer
Numberofbitsperimagechannel:Grayscale(8,10,12,and16bits)orcolor(5,8,10,and12bit).Specifying5bitsperchannelisonlyallowed
incombinationwithColorSpace='rgb'.Youwillgetan8-8-8
threechannelRGBHALCONimageinthiscase,too.Notethatnotallmodels
supportmorethan8bitsperchannel.Avalueof5enablesthe5-6-5bit
encodedRGBrawdatatransfer.Avalueof5incombinationwithColorSpace='rgb555'
enablesthe5-5-5bitencodedRGBdatatransfer.
ColorSpace
'default','raw','gray','rgb','rgby','rgb555'
'default'
string
SpecifythedesiredcolorspaceandthusthenumberofimagechannelsoftheresultingHALCONimage.IfColorSpaceissetto'default',the
colorspaceissetto'rgb'incaseofcolorcameras,andto'gray'
otherwise.The'raw'colorspacecausesacolorcameratoproducetheraw
Bayerpatternimageasoutput.If'rgby'isspecified,a8-8-8-8four
channelHALCONimagewithbrightnessinformationinthefourthchannelis
returned(ifthisformatissupportedbyyourcamera).
If'rgb555'isspecified,the5-5-5threechannelHALCONimageisset.
Generic
'','num_buffers=',-1
-1
mixed
WiththeGenericparametersomeimportantvaluescanbesetbeforethecameraisinitialized.Notethattheparameternames
includingthevaluesmustbestrings,e.g.,
'num_buffers=5'setsthenumberofbuffersto5.
Thefollowingparametersareavailable:
num_buffers:
TosetthemaximumnumberofbuffersusedintheHALCONacquisition
interfaceavaluegreaterthan2hastobeused.Ahighernumberofbuffers
isusefuliftheprocessingoftheacquiredimagestakeslongertoprocess,
thentheimageacquisition.Especiallyforsmallsizedroiahighernumberofbuffers
couldpreventabufferunderrun.
Notethatdependingontheimagesizeoftheusedcameraahighnumberof
bufferscanexceedtheavailablememorysizeofyourcomputerandthe
programmaycrash.
Default:3.
ExternalTrigger
'false','true'
'false'
string
Statusoftheexternaltrigger.
CameraType
'default','falcon','/cam/set1','/cam/set2','',''
'default'
string
Thecameratypewillbedetectedautomatically('default').IfCameraTypeissetto'falcon'(oroneoftheallowedcameratypes
oftheFALCON/EAGLEframegrabberboards)the
'FALCON/EAGLEcompatibilitymode'is
enabled.
IfCameraTypespecifiesanEEPROMuserset(by'/cam/set1'
or'/cam/set2')orapathtoaninifilesuitablefortheselectedcamera
thepropertiesarerestoredfromthisfileoruserset.Tostoresucha
fileseeparameter'do_save_parameters'.Notethattheproperties
specifiedinthisfilewilloverwriteallotherparameterssuppliedwith
open_framegrabberexceptDevice.
Device
'0','',''
'0'
string
TheIDofthedesiredcamera(passedasastring!),seealso'UsingMultipleCameras'above.
IfDevicespecifiesaserialnumber,thecamerawiththespecified
serialnumberwillbeopened.
Notethat,ifavaliddeviceIDorserialnumberisgiven,alwaysthe
matchingdevicewillbeopened,ignoringifthespecifiedCameraType
doesnotmatchthisdevice.
Port
---
Ignored.
LineIn
---
Ignored.
Parametersforset_framegrabber_param
Parameter
Values
Default
Type
Description
'agc'
'disable','enable'
'disable'
string
Autogaincontrolofthecameratoachieveanaveragebrightnessvaluespecifiedwiththeparameter
'auto_brightness_reference'.
'allow_raw_with_lut'
'enable','disable'
'disable'
string
ThecameraLUTcanalsobeusedwithRAWformats(ETHandUSB3.0cameras).
'anti_flicker_mode'
'disable','enable','fixed_50','fixed_60'
string
ControlstheantiflickermodefortheUI-3013XCcameramodel.
'api_timeout'
0,4...429496729
0(=uEyeAPI'sdefaulttimeoutof60seconds)
integer
InternaltimeoutusedbyuEyeAPIfunctionsinstepsof10ms(4=40ms).Thetimeoutstartsinasynchronousmodewiththecallofgrab_image_start
andinsynchronousmodewiththecallofgrab_image.Notethatthistimeout
maybedifferentfromthetimeoutsetwiththeparameter'grab_timeout'and
willinfluenceonlyuEye'sinternalbehaviour.
'auto_blacklevel_comp'
'disable','enable'
string
Automaticblacklevelcompensation.Agivenblackleveloffset(seeparameter'offset'.)willbeaddedtothecompensationvalue.
'auto_brightness_max_exp'
0.0,
float
Upperlimitoftheexposuretimewhenusedtocontroltheimagebrightnessautomatically.
'auto_brightness_max_gain'
float
Upperlimitofgainwhenusedtocontroltheimagebrightnessautomatically.
'auto_brightness_reference'
0...255
128
integer
Brightnessreferencevaluewhichshouldbeachievedbyautogainandautoexposure.
'auto_brightness_roi'
[,,,]
currentimageroi
integer
Specifiestheareaofinterestinwhichtheaveragebrightnessvalueusedforautogainandautoexposureshouldbeevaluated.Notethatchangesto
theimageroiresettheautobrightnessroitothesamecoordinates.
'auto_brightness_speed'
0...100
integer
Controlsspeed(percentageofexaminedimages)oftheautomaticbrightnesscontrolunit.
'auto_contrast_correction'
-2.0...0.0...2.0
float
ControlstheautocontrastcorrectionfortheUI-3013XCcameramodel.0.0disablestheautocontrastcorrection.
'auto_whitebalance_max_gain'
...100
integer
Limitsthemaximumgainforred,greenandbluechannels,whenusedbytheautomaticwhitebalancecontrolunit.Notethatthisparameterisonly
availableforcolorcameras.
'auto_whitebalance_min_gain'
0...
integer
Limitstheminimumgainforred,greenandbluechannels,whenusedbytheautomaticwhitebalancecontrolunit.Notethatthisparameterisonly
availableforcolorcameras.
'auto_whitebalance_offset_b'
float
Offsetforthebluegainchannelrelativetothegreenonewhenusedbytheautomaticwhitebalancecontrolunit.Notethatthis
parameterisonlyavailableforcolorcameras.
'auto_whitebalance_offset_r'
float
Offsetfortheredgainchannelrelativetothegreenonewhenusedbytheautomaticwhitebalancecontrolunit.Notethatthis
parameterisonlyavailableforcolorcameras.
'auto_whitebalance_roi'
[,,,]
currentimageroi
integer
Areaofinterestwhichinwhichtheautowhitebalancefunctionshouldwork.Notethatthisparameterisonlyavailableforcolor
cameras.Notethatchangestotheimageroiresettheautowhitebalanceroi
tothesamecoordinates.
'auto_whitebalance_speed'
0...100
integer
Controlsspeed(percentageofexaminedimages)oftheautomaticwhitebalancecontrolunit.Notethatthisparameterisonlyavailablefor
colorcameras.
'backlight_compensation'
'disable','enable'
string
ConfiguresthebacklightcompensationmodeforcameramodelsUI-3013XCandXS.
'bad_pixel_correction'
'disable','enable'
'disable'
string
Correctionofhotpixelsoftheimagesensor.
'black_level_mode'
['auto','manual']
string
Setstheblacklevelmode.
'black_level_offset'
0...255
integer
Setstheblackleveloffset.
'black_reference'
'columns_left','disable'
string
Displaysblackcolumnsintheimagewhichcanbeusedtocalibratetheblacklevel(UI-337xonly).
'burst_size'
1...429496729
integer
Inbursttriggermode,thecameracapturesaseriesofimagesinrapidsuccessiononreceiptofasingletriggersignal.
'capture_status_do_reset'
Resetsthecapturestatusinformation.
'color_conversion'
'3x3','5x5','hw'
'3x3'
string
SelectstheBayerconversionmask,andthusthequalityandperformanceoftheimagecolorconversion.Ifsetto'hw'thecameraitselfoutputsthe
desiredcolorformatwhichmayresultinincreasedbandwidth.
'color_correction'
'bg40','disable','enable','hq'
'enable'
string
Colorcorrectionmode.Notethatthisparameterisonlyavailableforcolorcameras.
'bg40':EnablecolorcorrectionforcameraswithopticalIRfilter
glassesoftheBG40type.
'disable':Disablecolorcorrection.
'enable':Enablesimplecolorcorrection.
'hq':EnablecolorcorrectionforcameraswithopticalIRfilterglasses
oftheHQtype.
'color_temperature'
integer
Colortemperatureforautowhitebalance.Youcanfixasetting(inKelvin)forthecolortemperatureofanimagewhenyouareusingacolor
camera.Thefunctionwillusethesensor'shardwaregaincontrolsforthe
setting,asfaraspossible.
Usingrgb_color_modelyoucanchoosebetweendifferentcolorspaces.A
specificcolortemperaturewillresultinslightlydifferingRGBvalues,
dependingontheselectedcolorspace.
Notethatthisfunctioncannotbeusedsimultaneouslywiththeautomatic
whitebalancefunction.
'compatibility_mode'
'disable','enable'
'disable'
string
FALCON/EAGLEcompatibilitymode,seeparagraphabove.
'configuration_openmp'
'disable','enable'
string
Enables/disablesmulticoreprocessingforimagedebayering.
'continuous_grabbing'
'disable','enable'
'disable'
string
Ifthecontinuousgrabbingmodeisenabled,thecameragrabsallthetime.Inthismodetheoperatorgrab_imagedoesnotgrabsynchronously,
butbehavessimilartograb_image_async.Usingthismode,youcanachieve
fullframerate.Ifthecontinuousgrabbingmodeisdisabled,thecamera
issettosingleframecaptureandtheimagequeueisnotused.
Notethatthismodecannotbeusedwhile'memory_module'isenabled.
Notethatforusingthesnapshotmode(UI-3013XC)thecontinuousgrabbing
hastobedisabled.Pleasealsonotethattheusageofgrab_imagedisables
thecontinuousmode.
'convert_to_gray'
'disable','enable'
string
Enables/disablesconversiontograyscaleimageusingcamera'scapabilities.NotethatthisfeaturewillonlybeavailableifacameraLUT
isenabled(GigEHEcamerasonly).
'digital_io_direction'
integer
Individualdirectionoftheadditionaldigital(generalpurpose)I/Oportpins.Asinglepinisconfiguredtoactasoutputbywritinga1to
thecorrespondentbitposition.Whichpinsarecapableofactingasinput
oroutputcanbequeriedusing'digital_io_capabilities'.
'digital_io_port'
integer
DigitalI/Oport.Notethatonlyoutputpinscanbeset.Theamountandconnectionofavailable(generalpurpose)I/Opinsis
modeldependent.Theavailablepinscanbequeriedusing
'digital_io_capabilities'anditsdirectioncanbesetwith
'digital_io_direction'.
'digital_io_pwm_duty_cycle'
0.0...1.0
float
Specifiesthedutycycleofthepulse-widthmodulation.(1.0correspondsto100%)
'digital_io_pwm_frequency'
1.0...10000.0
float
Specifiesthefrequencyofthepulse-widthmodulationinHz.
'digital_io_pwm_mode'
'disable','flash','gpio1','gpio2'
string
SetsthecurrentPWMmode.
'digital_output'
0,1
0
integer
Digitaloutput.Notethatthedigitaloutputpinissharedwiththestrobesignal(thestrobesignalusesthedigitaloutput)andmay
influencethestrobesettings,thus,don'tmixthemup!
'do_abort_grab'
---
Cancelsapendingasynchronousorsynchronousgrabandclearstheimagememories.Notethatcancellingagrabmaytakeupto12s,especially
wheninsynchronousacquisitionwithcontinuous_grabbingdisabled.
'do_force_trigger'
---
Forcesaneventtriggerwhenusingtheexternaltrigger.Thismightbeusefulfortestingpurposes.
'do_load_parameters'
''
string
LoadsparametersetoftheusedcamerafromthecameraEEPROMorfromaninifile.Toloadtheparametersfromoneoftwousersets,specify
'/cam/set1'or'/cam/set2',respectively.
'do_save_parameters'
''
string
StoresthecurrentparametersetoftheusedcameraintothecameraEEPROMorintoaninifile.Tostoretheparametersasoneoftwousersets,
specify'/cam/set1'or'/cam/set2',respectively.Thisfilecanbeusedto
restorethisparametersbycallingopen_framegrabberwiththefilenamein
theparameterCameraTypeorcalling
set_framegrabber_param(...,'do_load_parameters',...).
IfthebuttonintheHDevelopImageAcquisitionAssistantisused,anini
filewiththenameoftheusedcameramodelwillbesavedtothecurrent
%HALCONROOT%directory.
'edge_enhancement'
'disable','strong','weak'
'disable'
string
Edgeenhancementmode.
'exposure'
0.0,,'auto','manual'
mixed
Exposuretime(inmilliseconds)ofthecamera.Notethatthevaluerangedependsonthecurrentpixelclockandframerate
settings.Itcanbequeriedby
get_framegrabber_param(...,'exposure_range',...).Ifthevalue
isequalto0.0,theexposuretimewillbesetto1/
(frame_rate).Thisvaluemaybelargerthanmax.Youcan
leavethe'auto'modebysettingthevalueto'manual'orsimplyentera
validfloatvalue.Pleasenotethatifautoexposureisenabled,youcan
notchangethepixelclocksetting.
Note,thatanymodificationoftheexposuretimewillonlyaffectimages
whicharenotalreadygrabbedandnotpre-existinginsidetheinternal
bufferqueue.
'exposure_longterm'
'enable','disable'
string
Controlsthelongtermexposurefeature.Dependingonthecameramodellongtermexposureisonlysupportedintriggermodebutnotinfreerunmode.
'extended_pixelclock'
'disable','enable'
'disable'
string
Enables/disablestheextendedpixelclockrange(UI-324xonly).
'external_trigger'
'false','true'
string
Enables/disablesthetriggermode.Beawareofthesettingsthatyourcamerasupplies.
Notethatdisablingthetriggermodedisablesthesnapshotmode(UI-3013XC).
'face_detection'
'disable','enable'
string
ControlsthefacedetectionmodeforUI-3013XC.ForUI-3013XC,thefacedetectionisonlyactiveinlivemodebutnotinsnapshotmode.
'face_detection_line_width'
integer
Configuresthelinewidthsetfortheoverlayboxesthatindicatethedetectedfacesintheliveimage.
'face_detection_max_num_overlays'
integer
Configuresthemaximumavailableoverlaysforfacedetection.
'face_detection_search_angle'
0,90,270
integer
Setsasearchangle(facialorientationangle)forfacedetection.
'face_detection_search_angle_mode'
'disable','enable'
string
Enablesordisablesthesearchangleforfacedetection.
'flip_horizontal'
'false','true'
'false'
string
Horizontalimageflipping(supportedbyalluEyemodels).
'flip_vertical'
'false','true'
'false'
string
Verticalimageflipping.IfthespecificuEyecameradoesnotsupportverticalflipping,theimagewillbeflippedinthesoftware.
'focus'
...,'manual','auto','once'
integer,string
ControlsthefocusoftheobjectivelensifsupportedbytheuEyemodel.ThisfunctioniscurrentlyonlysupportedbytheUSBuEye
XSandUI-3013XCcameramodel.
'focus_zone_aoi_preset'
'center','upper_left','bottom_left','upper_right','bottom_right','upper_center','bottom_center','center_left'
string
SpecifiesthezoneinthefocusmeasuringareatobefocusedforUI-3013XCcameramodel.Notethatfocusingonthepreviouslyspecifiedzonewillonlyworksnapshotmode.
Infreerunmode,thecameraalwaysfocusesontheimagecenter.
'fpn_correction_mode'
'disable','hardware'
'disable'
string
Fixedpatternnoisecorrection(UI-337xonly).
'frame_rate'
,'auto','manual'
mixed
Framerateofthecamerainframespersecond.Notethatthevaluerangedependsonthecurrentpixelclockandexposuresettings.Itcanbequeried
byget_framegrabber_param(...,'frame_rate_range',...).Youcan
leavethe'auto'modebysettingthevalueto'manual'orsimplyentera
validfloatvalue.The'auto'valuecanonlybesetifautoexposureis
enabledand'gain_master'isnotsetto'auto'.
'gain_b'
0...100
integer
Bluegainmultiplierofthecamerainpercent.Notethatthisparameterisonlyavailableforcolorcameras.
'gain_boost'
'disable','enable'
'disable'
string
AdditionalgainboostfeatureofsomeuEyemodels.
'gain_factor_b'
100...
integer
Linearbluegainmultiplierofthecamera.Avalueof357meansafactorof3.57.Themaximumvaluecanbequeriedby
get_framegrabber_param(...,'gain_factor_b_range',...).Note
thatthisparameterisonlyavailableforcolorcameras.
'gain_factor_g'
100...
integer
Lineargreengainmultiplierofthecamera.Avalueof357meansafactorof3.57.Themaximumvaluecanbequeriedby
get_framegrabber_param(...,'gain_factor_g_range',...).Notethat
thisparameterisonlyavailableforcolorcameras.
'gain_factor_master'
100...
integer
Linearmastergainmultiplierofthecamera.Avalueof357meansafactorof3.57.Themaximumvaluecanbequeriedby
get_framegrabber_param(...,'gain_factor_master_range',...).
'gain_factor_r'
100...
integer
Linearredgainmultiplierofthecamera.Avalueof357meansafactorof3.57.Themaximumvaluecanbequeriedby
get_framegrabber_param(...,'gain_factor_r_range',...).Notethat
thisparameterisonlyavailableforcolorcameras.
'gain_g'
0...100
integer
Greengainmultiplierofthecamerainpercent.Notethatthisparameterisonlyavailableforcolorcameras.
'gain_master'
0...100,'auto','manual'
mixed
Mastergainmultiplierofthecamerainpercent.Youcanleavethe'auto'modebysettingthevalueto'manual'.
'gain_r'
0...100
integer
Redgainmultiplierofthecamerainpercent.Notethatthisparameterisonlyavailableforcolorcameras.
'gamma'
0.01...10.0
1.0
float
Gammacorrectionvalueofthecamera.
'global_shutter'
'disable','enable'
string
Enablesordisablestheglobal(start)shuttermodeofsomemodels.Notethatsuchmodelsarealwaysoperatinginrollingshuttermodewhenin
free-run.
'gpio_configuration'
'gpio_input','gpio_output','gpio_flash','gpio_pwm','gpio_comport_rx','gpio_comport_rt','gpio_mim','gpio_trigger',0,1
string,integer
Specifieshowtheselectedgpioshouldbeused.Theparameternamewithappendedgpionumberhastobespecifiede.g.'gpio_configuration_1'forthefirstgpio,'gpio_configuration_2'
forthesecondgpio.Theparameterreturnsatuplewithgpioconfigurationasfirstelementand
thegpiostateassecondelement.Toqueryqueryallsupportedvalues,the'_values'modifier
hastobeusedaftertheappendedgpionumber.Pleasenotethatanstate(0or1)
couldbepassedassecondtupleelemente.g.['gpio_output',1].
'grab_timeout'
100...214748360
5000
integer
Specifiesthedesiredtimeout(millisecondspassedasaninteger)forabortingapendinggrabcommand.Thegrab_timeoutwillbeusedifno
api_timeoutoccursbeforehand.Notethatthistimeoutmaybedifferentfrom
thetimeoutsetwiththeparameter'api_timeout'andwillinfluenceonly
interfacebehaviour.
'hdr_kneepoints'
[,,,,...]
float
Thexvalueofakneepointindicatesthefirstphaseofthecurrentlysetexposuretime(in%).Theyvalueindicatestheproportionofmaximumpixel
intensityinpercent.Iftwokneepointsareused,youcansettwophases
inwhichtheimageswillnotbeexposed.Thismeansthattwocorresponding
timeswillbesetonthex-axis.
Forinstance,theeffectsofsettingx=60,y=80wouldbeasfollows:The
firstexposurephasetakesup60%ofthesetexposuretime.Inthisfirst
exposurephase,allpixelsareexposeduptoamaximumof80%ofthe
maximumpixelintensityandremainat80%untilthisphaseisover.In
thesecondexposurephase,theyareexposedagainandmayreachthefull
pixelintensity.
Note:n=numberofhdrkneepoints.
'hdr_kneepoints_mode'
'disable','enable'
string
Enables/disablesHDRmode.
'horizontal_resolution'
1,2,3,4,5,6,8,16
integer
Changesthehorizontalresolutionbysubsamplingthesensorimagebythegivenfactor.Thepossiblefactorsvarywiththecameramodel.The
parameter'subsampling_method'determinestheappliedmethodtoachieve
thatresolution.Notethatbychangingthisvalueinasynchronousmode
allimagesintheimagequeue,whicharenotalreadygrabbed,willbe
discarded.
'image_delay'
0...2147483647
integer
Setstheinternalcameradelayoftheimagetransferinmicroseconds(µs).
'image_effect'
'disable','monochrome','negative','sepia'
'disable'
string
Setstheimageeffect.OnlysupportedbytheUSBuEyeXScameramodel.
'image_format'
string
Severalcommonimageformatscanbeset.ThedriverthensetstheselectedformatusingeitherROI,binning/subsampling,orscaler,sothatitachieves
thebestimagequality.Notethatchanginganyoftheseparametersmayresultin
an'undefined'imageformat.
Notethatsomeimageformatsareonlyavailableinsnapshotmode(UI-3013XC).
Snapshotmodeisconfiguredbydisablingcontinuous_grabbingandenabling
thesoftwaretriggermode.
'image_height'
0
integer
Altersthecapturedimagepartbychangingtheheightcomponent.Notethatimageheightcannotbegreaterthanspecifiedwithopen_framegrabbercall.
Notethatbychangingthisvalueinasynchronousmodeallimagesinthe
imagequeue,whicharenotalreadygrabbed,willbediscarded.
'image_memory_compatibility_mode'
'enable','disable'
string
Enables/Disablestheimagememorycompatibilitymode.Thismodemustbeenabledinordertomodifythememorymode.Administrativepermissions
arerequiredforthisparameter.Seealsoexampleueye_memory_mode.
'image_part'
[,,,]
integer
Specifiestheupperleft(row1,col1)andlowerrightcorner(row2,col2)ofthedesiredrectangularimagepartwhich
willbeactuallyacquiredbythecamera.Notethattherearemodel
dependantgridsforrow1andcol1aswellasforresulting
widthandheight.Thefunctionautomaticallyalignsthevaluesiftheyare
withinthevalidrange.
'image_part_origin'
[,]
integer
Allowschangingtheroipositionveryquicklybyusingtheupperleftcorner(row1,col1)ofthedesiredrectangularimagepart,
whichwillbeactuallyacquiredbythecamera.Thecommandiscurrently
notsupportedbyalluEyecameras.'bad_pixel_correction'correctionhasto
bedisabled.
'image_width'
0
integer
Altersthecapturedimagepartbychangingthewidthcomponent.Notethatimagewidthcannotbegreaterthanspecifiedwithopen_framegrabbercall.
Notethatbychangingthisvalueinasynchronousmodeallimagesinthe
imagequeue,whicharenotalreadygrabbed,willbediscarded.
'led'
'enable','disable','state1','state2','blink_enable','blink_disable','blink_5_times','toggle'
string
YoucantogglethecoloroftheLEDonthebackoftheUSBuEyeSE/REcamerahousing.ForUSB3.0orUSBSERev.2camerasyoucanenable/disableLEDorenable
blinkingtoidentifythedevice.Notethatthesefeaturesarenotsupportedbyall
cameras.'state1'willsetthecamerasLEDcolortoorange,'state2'togreenif
supported.
'level_controlled_trigger'
'enable','disable'
string
Byusingthelevel-controlledtrigger,theexposuretimeisdirectlycontrolledviathedurationofthetriggersignal.
'linescan_row'
integer
Allowstosetupthescanlineusedforthelinescanmode.Thelinescanmodecanbeactivatedviathe'shutter_mode'parametervalue'linescan'.Only
supportedif'shutter_mode'issetto'linescan'andby
UI-124x/UI-324x/UI-524xmonochromemodels.
'log_mode'
'auto','manual','off'
'auto'
string
ControlstheLogmode.OnlysupportedbyUI-124x/UI-324x/UI-524xandUI-125x/UI-325x/UI-525xmodels.
'log_mode_gain'
...
integer
SetsthemanualgainoftheLogmode.Onlyif'log_mode'issetto'manual'.
'log_mode_value'
...
integer
SetsthemanualvalueoftheLogmode.Onlyif'log_mode'issetto'manual'.
'lut'
'astro1','cold_hot','disable','enable','glow1','glow2','identity','map1','negative','only_blue','only_green','only_red','rainbow1',
'sepic'
string
Enables,disablesthelookuptable,oractivatesoneofthepresets.Youhavetouseahardwarecolorprocessingmodeinordertouselookuptables.
(Useparameter'color_conversion'withvalue'hw').Notethatsettinga
lookuptablewiththeoperatorset_framegrabber_lutthelookuptableis
implicitlyenabled.
'memory_mode'
'enable','disable'
'enable'
string
EnablesordisablestheimagememoryoftheUSB3uEyeCPRev.2camera.Caution!Ifyouoperatethecamerawithactivatedimagememory,thecamera
canbecomeveryhotdependingonthesensormodelandtheambientconditions.
Toavoidburnswhenhandlingthecameraoroverheating,
youmustprovidesufficientheatdissipation.Sinceversion4.81oftheuEyeSDK
thefeatureisenabledbydefault.Inordertodisableityouhavetoenable
thecompatibilitymodeusingparameter'image_memory_compatibility_mode'.
Changestothisparameteronlytakeeffectafterclosingthecamera.
'mim'
'disable','gpio1','gpio2','software'
string
ControlsthemultiintegrationmodeforUI-325xcameramodel.Notethatthetriggermodehastobeenabledtousethemultiintegrationmode.
'mim_cycles'
[,,,,,,...]
float
Configuresthemultiintegrationmodecyclesasalistoffloatspairswithupto64integration/durationpairs.Theoddvaluespecifiestheintegration
duration(ms),theevenvaluespecifiesthepauseduration(ms).
'multi_roi_axes'
[,,,,,,,]
integer
ChangesthemultiroiandsetsthemultiroiaxesforthefourROIs.OnlysupportedbyUI-124x/UI-324x/UI-524xmodels.
'multi_roi_mode'
'disable'
string
ConfiguresthemultiROI(Note:Forenablingseeparameter'multi_roi_axes').OnlysupportedbyUI-124x/UI-324x/UI-524xmodels.
'multi_roi_row_axes'
[]
integer
MultiROImodesupportedbyUI-337xmodelswithupto8ROIs(16y-axis).
'multi_roi_row_mode'
'disable'
string
ConfiguresthemultirowROI(Note:Forenablingseeparameter'multi_roi_row_axes').OnlysupportedbyUI-337xmodels.
'packet_interval'
0...2147483647
integer
Setsthepacketintervalfortheimagetransferinmicroseconds(µs).
'persistent_memory'
string
Accessesthecamerasinternalusermemory.Whenreadingorwritingmemorytheparameters'persistent_memory_config_type','persistent_memory_config_offset',
'persistent_memory_config_termination'and'persistent_memory_config_size'specify
howthememoryisbeeingwritten/readfrom.
'persistent_memory_config_do_reset'
Resetsthepersistentmemoryconfigurationparameterstotheirdefaultvalue.
'persistent_memory_config_offset'
[0,,]
0
integer
Specifiestheoffsetfromwheretoread/writethememoryblock.Whenthesumofthegivenoffsetandsizespecifiedby'persistent_memory_config_size'exceeds
thememorysizegivenbythecamera,thesizewillbesettomaxSize-offset.
Achangetothesizeisonlymadeifthesizesettingisnotinautomaticmode.
'persistent_memory_config_size'
[0,,]
0
integer
Specifiestheamountofmemorytoread.Themaximumamountisdefinedbythecurrentmemorysizeminusthespecifiedoffsetoftheparameter
'persistent_memory_config_offset'.
'persistent_memory_config_termination'
'enable','disable'
'enable'
string
Enables/disablesnullterminationwriting.Whenthismodeisenabledanullterminationcharacterwillbeappendedattheendofthedata.Thesizeof
thedatawhenreadingislimitedbythesizesetby
'persistent_memory_config_size'oruntilanullterminationcharacteroccures.
'persistent_memory_config_type'
'user','extended'
'user'
string
Specifiesthememorysectiontoaccessusingthe'persistent_memory'parameter.Differentmemorysectionsdependonthecameramodel.Alistofwhatacamera
supportsisavailableintheuEyeSDKManual.,
'photometry_shutter'
'center_average','center_spot','center_weighted'
string
SetsthephotometrymodeforautoshutterforthecameramodelUI-3013XC.
'pixel_clock'
integer
Pixelclockofthecamera(MHzpassedasaninteger).Notethatthevaluerangedependsontheembeddedsensorandcanbequeriedby
get_framegrabber_param(...,'pixel_clock_range',...).
'rgb_color_model'
'AdobeRGB6500K','CIE-RGBNormE','ECI-RGB5000K','sRGB5000K','sRGB6500K'
'sRGB5000K'
string
Selectsbetweendifferentcolorspaces.AspecificcolortemperaturewillresultinslightlydifferingRGBvalues,dependingontheselectedcolor
space.
Usingcolor_temperatureyoucanfixasetting(inKelvin)forthecolor
temperatureofanimagewhenyouareusingacolorcamera.
'AdobeRGB6500K':AdobeRGBcolorspacewithawhitepointof6500
Kelvin(middaylight).TheAdobeRGBcolorspaceis
largerthanthesRGBcolorspace,butnotalldevices
canrenderit.
'CIE-RGBNormE':CIE-RGBcolorspacewithstandardilluminationE
'ECI-RGB5000K':ECI-RGBcolorspacewithawhitepointof5000Kelvin
(warmlight).
'sRGB5000K':sRGB(standardRGB)colorspacewithawhitepointof5000
Kelvin(warmlight).
'sRGB6500K':sRGB(standardRGB)colorspacewithawhitepointof6500
Kelvin(middaylight).
'roi'
[]
integer
Seeparameter'image_part'.
'sensor_bit_depth'
10,12,-1
integer
Setsthebitdepthofthesensor.Withthe-1settingthesoftwareselectstheappropriatesensorbitdepthtothechosenimageformat.
Thebitdepthcanalsobeselectedindependentfromtheimageformat.
Attention:Asyoucanchoosecombinationsthatdonotfit,thisfunction
shouldbeusedbyexpertsonly.Inmostcasestheautocontrolissufficient.
OnlysupportedbyUI-337xmodels.
'sensor_scaler_factor'
1.0...
float
Specifiesthescalingfactorfactor.InternalimagescalingisonlysupportedbyUI-149x/UI-549x,UI-124x/UI-324x/UI-524xand
UI-125x/UI-325x/UI-525xseriessensors.Notethatthesensorscalermode
hastobeenabledtoapplyanewsensorscalerfactor.Pleasealsonote
thatdisablingthesensorscalermode,thesensorscalerfactorisset
backtothedefaultvalue.
'sensor_scaler_mode'
'disable','enable','enable_antialiasing'
string
Configuresinternalimagescalingforsomesensors.Thisallowstoreducetheimageresolutionbyadjustablefactors.Thus,theamountofdatafrom
highresolutionsensorscanbereduced.Internalimagescalingisonly
supportedbyUI-149x/UI-549x,UI-124x/UI-324x/UI-524xand
UI-125x/UI-325x/UI-525xseriessensors.
'sensor_source_gain'
-10...4
0
integer
Mastersourcegainofthesensor(UI-337xonly).
'sequence_roi_mode'
'ROI1','ROI1|2','ROI1|2|3','ROI1|2|3|4'
string
SetsoneofthefourpossiblesequenceROImodes(Note:ROI1isthenormalROI).OnlysupportedbyUI-124x/UI-324x/UI-524xmodels.SeeuEye
documentationforfurtherdetails.
'sequence_roi_parameter'
[(integer),(string),(integer,float)]
integer
SetsthesequenceROIparametersforeachROI.OnlysupportedbyUI-124x/UI-324x/UI-524xmodels.TheROIsaretransferredtogetherasone
image.PossiblevaluesforROIindexare2,3or4.Theparameterhasto
bespecifiedasfollowed.Pleasenote,thattheparametersvalueisalwaysan
integertype,exceptthetwoparameters'exposure'and'scalerFactor',thatare
ofthetypefloat.
'numberOfCycleRepetitions':Numberofreadoutcycles.
'posX':xpositionoftheROI.
'posY':ypositionoftheROI.
'exposure':Exposuretime.
'gain':Gain
'binning':Binningmode(notsupportedyet).
'subsampling':Subsamplingmode(notsupportedyet).
'detachImageParameters':0=Everychangeoftheexposuretimeandthe
mastergainiscopiedfromROI1tothe
additionalROIs(default).AsachangeofROI1
alsoresetstheexposuretime,thischangeis
alsotransferredtoROI2,3,and4.
1=Achangeofexposuretime,gainorposition
ofROI1doesnotaffecttheparametersofROI
2,3,and4.
'scalerFactor':Scalingfactor(notsupportedyet).
'sequencer_configuration_enabled'
'true','false'
string
Enables/Disablessequencerconfigurationmode.Thesequencermodemustbedisabledfirstandatriggersignalmustbeset.
'sequencer_configuration_load'
string
Loadasequencerconfiguration.Thesequencerconfigurationmodemustbeenabledfirst.
'sequencer_configuration_save'
string
Saveasequencerconfiguration.Thesequencerconfigurationmodemustbeenabledfirst.
'sequencer_do_reset'
Resetsthesequenceranditscurrentconfiguration.
'sequencer_feature_enabled'
'true','false'
string
Enables/Disablestheselectedsequencerfeature.Thesequencerconfigurationmodemustbeenabledandasequencersetmustbeselected.
'sequencer_feature_selected'
'exposure','gain','aoi_offset_x','aoi_offset_y'
string
Setstheselectedsequencerfeature.Thesequencerconfigurationmodemustbeenabledfirst.
'sequencer_mode_enabled'
'true','false'
string
Enables/Disablesthesequencermode.Thesequencerconfigurationmodemustbedisabledfirst.
'sequencer_set_do_save'
Savestheselectedsequencerset.Thesequencerconfigurationmodemustbeenabledandasequencersetmustbeselected.
'sequencer_set_path'
[0..1,0..31,,'']
string,integer,float
Setsthesequencerpathoftheselectedset.Afterthespecifiedtriggersourcegetstriggered,thesequencerwillsteptothesequencersetindexspecifiedby
thesecondtuplevalue.Withtrigger_source_offspecifiedastriggersourcethe
sequencerwillnotsteptothenextset.Thelastparameteriscurrentlyunused.
'sequencer_set_selected'
0..31
integer
Setstheselectedsequencerset.Thesequencerconfigurationmodemustbeenabledfirst.
'sequencer_set_start'
0..31
Setsthefirstsequencersetinthesequence.Thesequencerconfigurationmodemustbeenabledfirst.
'show_internal_errors'
'false','true'
string
EnableserrormessagessentbyuEyedriver.Errorswillbedisplayedinaseparatemessagebox.
'shutter_mode'
'global_alternative_timing','global_shutter','global_start_shutter_disable','global_start_shutter_enable',
'linescan','rolling_global_start','rolling_shutter'
string
Setsthespecifiedshuttermode.NotethatnotalluEyemodelssupportthisparameter.
'global_start_shutter_enable','global_start_shutter_disable':The
globalstartshutterfunctionisonlysupportedintriggermode.
OnlysupportedbyUI-148x/UI-348x/UI-548xandUI-158x/UI-358x/UI-558xmodels.
'linescan','global_alternative_timing','global_shutter',
'rolling_global_start','rolling_shutter':Onlysupportedby
UI-124x/UI-324x/UI-524xmodels.(Seeparameter'linescan_row').
'standby'
'disable','enable'
'disable'
string
Standbyparameterturnsthecameraintoapowersavingmode.ThisparametercanonlybesetwithuEyedriverversion3.10
orhigher.
'start_async_after_grab_async'
'disable','enable'
'enable'
string
Bydefaultanewasynchronousgrabcommandisautomaticallygiventotheacquisitiondeviceattheendofgrab_image_async.Iftheparameter
'start_async_after_grab_async'issetto'disable',thisnewgrabcommand
isomitted.
'start_column'
0...
integer
Alteringthecapturedimagepartbymovingthestartcolumnhorizontally.
'start_row'
0...
integer
Alteringthecapturedimagepartbymovingthestartrowvertically.
'strobe_delay'
0
integer
Delayinmicrosecondsoftheflashsignalonthedigitaloutput.Ifsetto0flashdelayisdeactivated.
'strobe_duration'
0
integer
Durationinmicrosecondsoftheflashsignalonthedigitaloutput.Ifsetto0theflashsignalisenabledaslongasthesensorexposures.
'strobe_invert'
'false','true'
'false'
string
Ifsetto'true',thestrobesignalisinverted.
'strobe_io_port'
integer
AllowstosetthedigitalI/Oportstoactasstrobeoutputbywriting1tothecorrespondingbitposition.'digital_io_capabilities'canbeused
toquerywhichpinsareabletoactasstrobeout.
'strobe_mode'
'disable','enable','enable_freerun','simulate_global_shutter'
'disable'
string
Strobemode:
'enable_freerun'activatesthestrobeoutputduringfree-runmode.
'enable'activatesfortriggeredoperationsonly.
'simulate_global_shutter'setstheparameters'strobe_delay'and
'strobe_duration'tohittheglobalexposuretimesliceonarolling
shuttercamera,thuschanginganyofthemmaycausetheactive
strobesignaltomisstheglobalexposurewindow.Notethattriggermust
beactivated.
Notethatareturnvalueof'disable(output)'indicatesthatflashportis
orwasusedasdigitaloutputport(seeparameter'digital_output').
'subsampling_method'
'binning','prefer_binning','prefer_skipping','skipping'
'prefer_skipping'
string
Choosesthemodeusedwhenhorizontaland/orverticalresolutionissettoavaluegreaterthanone.Ifyouchooseoneofthe'prefer_*'modesthe
desiredresolutionistriedtobeachievedusingthespecifiedmethod
first.Avaluewithouta'prefer_'prefixwillrefuseanyresolutionsthat
cannotbeachievedbytheselectedmethod.
'test_image'
,
'none'
string,integer
Setsasensortestimage.Thesupportedtestimagescanbequeriedbyusing'test_image_values'.NotethatthisparameterisnotsupportedbytheXCand
XSmodels.Aparametervalueshouldonlybegivenwhenthetestimagesupports
additionalparameters.
'timestamp_do_reset'
---
Setsoncethecameratimestampto0.
'timestamp_edge'
'falling','rising'
string
Thetimestampissetbyrisingorfallingedge.
'timestamp_pin'
'gpio1','gpio2','ignore','trigger'
string
Pinforsettingthetimestamp.
'transfer_image_destination'
'device_memory','user_memory'
string
ConfiguresthememorymodeforGigEuEyecameras.Afterthe'device_memory'isenabled,thecontinuoustriggermodehastobestartedvia
grab_image_start.Thecameracapturesanewiterationcycle(singleimage
ifburst_sizeis1)oranimagesequence(burstsize>1)forevery
triggersignal,untilthememorylimitisreached.Theoldestimageis
transferredfromthecamerawithgrab_image_async.Aftertheimagewas
transferred,itisdiscardedinthecameramemory.Thetrigger
modi('falling','rising')andtheburstsizecanalsobespecified.After
settingthetransfer_image_destinationparameteragain,thedevicememory
isclearedandtheimageaquisitionhastoberestarted.Notethatacall
tograb_image_startalsoclearsthedevicememory.Pleasenotethatacall
tograb_imagewillleavememorymode.PleasealsonotethattheGigEmemory
modewillonlyworkinhardwaretriggermode.
'trigger_debouncing_delay'
integer
SuppressesdisturbancesatthedigitalinputifyouarerunningaGigEuEyecameraintriggermode.Thesignalatthedigitalinput
isonlyrecognizedasatriggerifthesignallevelremainsconstantatthe
targetlevelforauser-selectabledelaytime.Thesignaledgecanbeset
usingparameter'trigger_debouncing_mode'.
NotethatthisfunctioniscurrentlyonlysupportedbytheGigE
uEyecameraseries.
'trigger_debouncing_mode'
'automatic','bothedges','disable','fallingedge','risingedge'
'disable'
string
Thesignaledgeusedforthetriggerdebouncefunction.Thedelaycanbesetusing'trigger_debouncing_delay'.Itisrecommendtouseautomatic
signaledgeselection.
NotethatthisfunctioniscurrentlyonlysupportedbytheGigE
uEyecameraseries.
'automatic':debouncesthedigitalinputwithautomaticedgeselection.
Theedgeisselectedbasedonthesettriggeredge(see
parameter'trigger_signal').
'bothedges':debouncesthedigitalinputforrisingorfallingedge
signals.
'disable':disablesdebouncingthedigitalinput.
'fallingedge':debouncesthedigitalinputforfallingedgesignals.
'risingedge':debouncesthedigitalinputforrisingedgesignals.
'trigger_delay'
0
integer
Adjustabletimeinmicrosecondstowaitafterthetriggeredgebeforetheacquisitionbegins.Ifsetto0triggerdelayisdeactivated.
'trigger_signal'
'falling','rising','software','sync_falling','sync_rising'
string
Typeofthetriggersignal.Modelswhichsupporttriggersynchronisationenableyoutosynchronizeseveralcamerasin
free-runmode.
Notethatsettingatriggersignalenablestriggermode(seeparameter
'external_trigger'=true).
Notethatforusingthesnapshotmode(UI-3013XC)thesoftwaretriggerhastobeenabled.
Pleasealsonotethat'falling'and'rising'areonlyusableforGigEmemorymode.
'vertical_resolution'
1,2,3,4,5,6,8,16
integer
Changestheverticalresolutionbysubsamplingthesensorimagebythegivenfactor.Thepossiblefactorsvarywiththecameramodel.The
parameter'subsampling_method'determinestheappliedmethodtoachieve
thatresolution.Notethatbychangingthisvalueinasynchronousmode
allimagesintheimagequeue,whicharenotalreadygrabbed,willbe
discarded.
'vertical_roi_merge_height'
...
0
integer
SetstheheightofeachverticalROIintheverticalROImergemode(UI-337x,UI-336xonly).Notethatthisparameterisonlyavailableif'vertical_roi_merge_mode'isnotdisabled.
'vertical_roi_merge_mode'
'disable','freerun','triggered_software','triggered_hardware_falling_GPIO1','triggered_hardware_rising_GPIO1','triggered_hardware_falling_GPIO2','triggered_hardware_rising_GPIO2'
'disable'
integer
TheverticalROImergemodeisaspecialmodewhichimitatesthebehaviorofalinescancamera(UI-306xCP,UI-324xCP/LE/ML,UI-326xCP,UI-336xCP,UI-337xCP,UI-325xCP/LE/ML,
UI-524xCP/SE,UI-526xCP,UI-536xCP,UI-537xCPonly).TheverticalROImergemodecombines
thelinesofanROItoanewimage.ForexampleamonochromesensorisoperatedwithanROI
heightof1andanimageheight1000pixels.So1000ROIaremergedtoanimagewithaheightof1000pixels.
NotethatthesetimageheightmustbeamultipleoftheROIheight.ForcolorsensorstheROI
heightmustbe2atleastfortransmittingthecolorinformation.
Notethat'continuous_grabbing'hastobeenabledtousetheverticalroimergemode.
Alsotheimagesshouldbeacquiredusing'grab_image_async'.
AftertheverticalROImergemodewasset,theimageheightshouldbeadjusted.
Themaximumimageheightis8000forcolormodelsand4000formonochromemodels.
NotealsoifusingtheextendedverticalROImergemode(vertical_roi_merge_position_2):
TheheightofeachsingleROIishalfoftheheightinnormalROImergemode.Therefore,only
evenROIheightsarepossible.
ThesettingrangeoftheadditionalpositiondependsonthetotalROIheightandthefirstposition.
Thesettingrangeofthesecondpositionchangeswhenthefirstpositionischanged.
'disable':DisablesROImergemode.
'freerun':EnablestheROImergemodeinfreerunmode.(ThesingleROIs
areacquiredinfreerunmodewithmaximumspeed.)
'triggered_software':EnablestheROImergemode.ThesingleROIsaretriggered
viasoftware.
'triggered_hardware_falling_GPIO1':Triggeredlinescanmodewithframeandlinetrigger.
ThesingleROIistriggeredonGPIO1(fallingedge).
'triggered_hardware_rising_GPIO1':Triggeredlinescanmodewithframeandlinetrigger.
ThesingleROIistriggeredonGPIO1(risingedge).
'triggered_hardware_falling_GPIO2':Triggeredlinescanmodewithframeandlinetrigger.
ThesingleROIistriggeredonGPIO2(fallingedge).
'triggered_hardware_rising_GPIO2':Triggeredlinescanmodewithframeandlinetrigger.
ThesingleROIistriggeredonGPIO2(risingedge).
'vertical_roi_merge_position'
0...
0
integer
SetsthelinepositionfortheROIoftheROImergemode.Notethatthisparameterisonlyavailableifvertical_roi_merge_modeisnotdisabled.
(UI-337x,UI-336xonly).
'vertical_roi_merge_position_2'
...
0
integer
SetsthelinepositionforthesecondROIfortheextendedROImergemode.Notethatthisparameterisonlyavailableifvertical_roi_merge_modeisnotdisabled.
(UI-337x,UI-336xonly).
'volatile'
'disable','enable'
'disable'
string
Grayscaleonly.InthevolatilemodetheimageacquisitioninterfacebuffersareuseddirectlytostoreHALCONimages.Thisisthefastestmode
avoidingtocopyrawimagesinmemory.However,beawarethatolderimages
areoverwrittenagainandagainasaside-effect.Thus,youcanonly
processoneimagewhileyougrabanotherimage.Olderimagesareinvalid!
Notethatduetodifferentlinepitchandalignment,thevolatilemodeis
onlypossiblewithfullresolutionforthissession(theonespecifiedin
open_framegrabber.
PleasealsonotethatthisparametercannotbesetiftheGenericparameter
'num_buffers'isusedwithavaluedifferentfromthedefaultvalue.
'wdr_mode'
'disable','enable'
string
Usingthisspecialmode,youcancaptureimageswithahigherdynamicrangeforUI-3013XCcameramodel.
'white_balance'
'auto','auto_once','disable','user'
string
Whitebalancemode:
'auto':Automaticwhitebalanceusingthergbgainifthecamerahasone
'auto_once':Useautomaticwhitebalanceonlyonce.
'disable':Disablewhitebalancing.
'user':Enablemanualwhitebalancing,see
set_framegrabber_param(...,'white_balance_X',...).
'zoom'
...
1.0
float
Controlsthezoomfunctionofthelensorsensor(digitalzoom)ifsupportedbythecamera.ThisfunctioniscurrentlyonlysupportedbytheUSBuEye
XSandtheUSB3uEyeUI-3013XCcameramodel.Thefunctionalwayszoomsinontheimagecenter.
PleasenotethattheXScameramodelsupportsthe'_range'parameterextension
andtheUI-3013XCsupportsthe'_values'parameterextension.
Parametersforget_framegrabber_paramTheremayexistadditionalread-onlyparameterswiththefollowingpostfixes:
'_description':Theseparametersprovidethetool-tipofthe
correspondingparameterasastring.
'_range':Theseparametersprovidetheminimum,maximum,
stepwidth,anddefaultvaluesforthecorrespondingintegerorfloat
parameterasatuplewith4elements,e.g.,
get_framegrabber_param(..,'Shutter_range',..)willreturn
theoutputtuple[min,max,step,default].
'_values':Theseparametersprovidethevalidvaluelistfor
thecorrespondingparameterasatuple,e.g.,
get_framegrabber_param(..,'volatile_values',..)willreturn
theoutputtuple['enable','disable'].
Allthesepostfixedparameternamesarenotreturnedwhencalling
info_framegrabber(..,'parameters',..)andareused
toenabletheeasyparameterizationviaagenericgraphicaluser
interface,particularlytheHDevelopImageAcquisitionAssistant.
Parameter
Values
Default
Type
Kind
Description
'agc'
'disable','enable'
'disable'
string
dynamic
Autogaincontrolofthecameratoachieveanaveragebrightnessvaluespecifiedwiththeparameter
'auto_brightness_reference'.
'allow_raw_with_lut'
'enable','disable'
'disable'
string
pre-defined
ThecameraLUTcanalsobeusedwithRAWformats(ETHandUSB3.0cameras).
'anti_flicker_mode'
'disable','enable','fixed_50','fixed_60'
string
dynamic
ControlstheantiflickermodefortheUI-3013XCcameramodel.
'api_timeout'
0,4...429496729
0(=uEyeAPI'sdefaulttimeoutof60seconds)
integer
dynamic
InternaltimeoutusedbyuEyeAPIfunctionsinstepsof10ms(4=40ms).Thetimeoutstartsinasynchronousmodewiththecallofgrab_image_start
andinsynchronousmodewiththecallofgrab_image.Notethatthistimeout
maybedifferentfromthetimeoutsetwiththeparameter'grab_timeout'and
willinfluenceonlyuEye'sinternalbehaviour.
'auto_blacklevel_comp'
'disable','enable'
string
pre-defined
Automaticblacklevelcompensation.Agivenblackleveloffset(seeparameter'offset'.)willbeaddedtothecompensationvalue.
'auto_brightness_max_exp'
0.0,
float
dynamic
Upperlimitoftheexposuretimewhenusedtocontroltheimagebrightnessautomatically.
'auto_brightness_max_gain'
float
dynamic
Upperlimitofgainwhenusedtocontroltheimagebrightnessautomatically.
'auto_brightness_reference'
0...255
128
integer
dynamic
Brightnessreferencevaluewhichshouldbeachievedbyautogainandautoexposure.
'auto_brightness_roi'
[,,,]
currentimageroi
integer
dynamic
Specifiestheareaofinterestinwhichtheaveragebrightnessvalueusedforautogainandautoexposureshouldbeevaluated.Notethatchangesto
theimageroiresettheautobrightnessroitothesamecoordinates.
'auto_brightness_speed'
0...100
integer
dynamic
Controlsspeed(percentageofexaminedimages)oftheautomaticbrightnesscontrolunit.
'auto_contrast_correction'
-2.0...0.0...2.0
float
dynamic
ControlstheautocontrastcorrectionfortheUI-3013XCcameramodel.0.0disablestheautocontrastcorrection.
'auto_whitebalance_max_gain'
...100
integer
dynamic
Limitsthemaximumgainforred,greenandbluechannels,whenusedbytheautomaticwhitebalancecontrolunit.Notethatthisparameterisonly
availableforcolorcameras.
'auto_whitebalance_min_gain'
0...
integer
dynamic
Limitstheminimumgainforred,greenandbluechannels,whenusedbytheautomaticwhitebalancecontrolunit.Notethatthisparameterisonly
availableforcolorcameras.
'auto_whitebalance_offset_b'
float
dynamic
Offsetforthebluegainchannelrelativetothegreenonewhenusedbytheautomaticwhitebalancecontrolunit.Notethatthis
parameterisonlyavailableforcolorcameras.
'auto_whitebalance_offset_r'
float
dynamic
Offsetfortheredgainchannelrelativetothegreenonewhenusedbytheautomaticwhitebalancecontrolunit.Notethatthis
parameterisonlyavailableforcolorcameras.
'auto_whitebalance_roi'
[,,,]
currentimageroi
integer
dynamic
Areaofinterestwhichinwhichtheautowhitebalancefunctionshouldwork.Notethatthisparameterisonlyavailableforcolor
cameras.Notethatchangestotheimageroiresettheautowhitebalanceroi
tothesamecoordinates.
'auto_whitebalance_speed'
0...100
integer
dynamic
Controlsspeed(percentageofexaminedimages)oftheautomaticwhitebalancecontrolunit.Notethatthisparameterisonlyavailablefor
colorcameras.
'available_callback_types'
'frame_ready','ready_for_trigger','first_packet_received','query_capture_status','device_removed','device_reconnected'
string
dynamic
Getstheavailablecallbacktypes.
'backlight_compensation'
'disable','enable'
string
dynamic
ConfiguresthebacklightcompensationmodeforcameramodelsUI-3013XCandXS.
'bad_pixel_correction'
'disable','enable'
'disable'
string
pre-defined
Correctionofhotpixelsoftheimagesensor.
'bits_per_channel'
5,8,10,12,16
8
integer
pre-defined
NumberofbitsperchanneloftheresultingHALCONimage.Incaseof-1thecurrentbitdepthofthecameraisused.Byspecifyingavaluegreaterthan8the
grabbedimagesaredeliveredasuint2images.
'black_level_mode'
['auto','manual']
string
dynamic
Setstheblacklevelmode.
'black_level_offset'
0...255
integer
dynamic
Setstheblackleveloffset.
'black_reference'
'columns_left','disable'
string
pre-defined
Displaysblackcolumnsintheimagewhichcanbeusedtocalibratetheblacklevel(UI-337xonly).
'burst_size'
1...429496729
integer
dynamic
Inbursttriggermode,thecameracapturesaseriesofimagesinrapidsuccessiononreceiptofasingletriggersignal.
'camera_id'
1...255
integer
dynamic
ReturnsthecameraIDoftheuEyedevice.
'camera_info'
''
string
dynamic
Serialnumber,type,version,anddateofQCofthecamera.
'camera_type'
'falcon','/cam/set1','/cam/set2','',''
'default'
string
pre-defined
Currentcameratype.
'capture_status'
[,,,,,,,,
]
integer
dynamic
Returnsinformationsonerrorsthatoccurredduringanimagecapture.Allerrorsarelistedthatoccurredsincethelastcapture_status_do_resetcommand.
NotethatonlyuEyeAPIcaptureerrorswillshowupinthecapture_statuslist.
Pleasenotethatoperatortimeouts(setwithgrab_timeout)willnotshowupinthe
capturestatuslist.
API_CONVERSION_FAILED:Thecurrentimagecouldnotbeprocessedcorrectly.
API_IMAGE_LOCKED:Thedestinationbuffersarelockedandcouldnotbewrittento.
API_NO_DEST_MEM:Thereisnodestinationmemoryforcopyingthefinishedimage.
DEV_TIMEOUT:Themaximumallowabletimeforimagecapturinginthecamerawasexceeded.(setbyapi_timeout)
DRV_DEVICE_NOT_READY:Thecameraisnolongeravailable.Itisnotpossibletoaccessimagesthathavealreadybeentransferred.
DRV_OUT_OF_BUFFERS:Nofreeinternalimagememoryisavailabletothedriver.Theimagewasdiscarded.
ETH_BUFFER_OVERRUN:ThesensortransfersmoredatathantheinternalcameramemoryoftheGigEuEyecameracanaccommodate.
ETH_MISSED_IMAGES:Freerunmode:TheGigEuEyecameracouldneitherprocessnoroutputanimagecapturedbythesensor.
USB_TRANSFER_FAILED:TheimagewasnottransferredovertheUSBbus.
'color_conversion'
'3x3','5x5','hw'
'3x3'
string
dynamic
SelectstheBayerconversionmask,andthusthequalityandperformanceoftheimagecolorconversion.Ifsetto'hw'thecameraitselfoutputsthe
desiredcolorformatwhichmayresultinincreasedbandwidth.
'color_correction'
'bg40','disable','enable','hq'
'enable'
string
pre-defined
Colorcorrectionmode.Notethatthisparameterisonlyavailableforcolorcameras.
'bg40':EnablecolorcorrectionforcameraswithopticalIRfilter
glassesoftheBG40type.
'disable':Disablecolorcorrection.
'enable':Enablesimplecolorcorrection.
'hq':EnablecolorcorrectionforcameraswithopticalIRfilterglasses
oftheHQtype.
'color_space'
'raw','gray','rgb','rgby','rgb555'
'default'
string
pre-defined
DesiredcolorspaceandthusthenumberofimagechannelsoftheresultingHALCONimage.
'color_temperature'
integer
dynamic
Colortemperatureforautowhitebalance.Youcanfixasetting(inKelvin)forthecolortemperatureofanimagewhenyouareusingacolor
camera.Thefunctionwillusethesensor'shardwaregaincontrolsforthe
setting,asfaraspossible.
Usingrgb_color_modelyoucanchoosebetweendifferentcolorspaces.A
specificcolortemperaturewillresultinslightlydifferingRGBvalues,
dependingontheselectedcolorspace.
Notethatthisfunctioncannotbeusedsimultaneouslywiththeautomatic
whitebalancefunction.
'compatibility_mode'
'disable','enable'
'disable'
string
pre-defined
FALCON/EAGLEcompatibilitymode,seeparagraphabove.
'configuration_openmp'
'disable','enable'
string
pre-defined
Enables/disablesmulticoreprocessingforimagedebayering.
'continuous_grabbing'
'disable','enable'
'disable'
string
pre-defined
Ifthecontinuousgrabbingmodeisenabled,thecameragrabsallthetime.Inthismodetheoperatorgrab_imagedoesnotgrabsynchronously,
butbehavessimilartograb_image_async.Usingthismode,youcanachieve
fullframerate.Ifthecontinuousgrabbingmodeisdisabled,thecamera
issettosingleframecaptureandtheimagequeueisnotused.
Notethatthismodecannotbeusedwhile'memory_module'isenabled.
Notethatforusingthesnapshotmode(UI-3013XC)thecontinuousgrabbing
hastobedisabled.Pleasealsonotethattheusageofgrab_imagedisables
thecontinuousmode.
'convert_to_gray'
'disable','enable'
string
dynamic
Enables/disablesconversiontograyscaleimageusingcamera'scapabilities.NotethatthisfeaturewillonlybeavailableifacameraLUT
isenabled(GigEHEcamerasonly).
'device'
'',''
'0'
string
dynamic
CurrentdeviceID.
'digital_input'
0,1
integer
dynamic
ReadthedigitalinputoftheuEyecamera.Notethatthedigitalinputisphysicallysharedwiththetriggerinputpin.
'digital_io_capabilities'
[,,
ids api