Using the is_SaveParameters() function, you can save the currently set uEye camera parameters to a file in INI format (*.ini). To load the saved settings, use is_LoadParameters().
|
|
uEye parameter files can also be created and edited manually. The following table shows the structure of the parameter file. The entries in square brackets [] indicate sections. If a section does not exist in the ini file, the corresponding camera parameters will not be modified when you load the file.
Structure of a uEye parameter file
Parameter |
Description |
Value range |
Example |
|---|---|---|---|
[Versions] |
|
|
|
ueye_api.dll |
File version of the uEye API |
- |
3.32.0000 |
ueye_eth.sys |
File version of the GigE uEye driver |
- |
3.32.0000 |
ueye_usb.sys |
File version of the USB uEye driver |
- |
3.32.0000 |
ueye_boot.sys |
File version of the USB uEye boot loader |
- |
3.32.0000 |
[Sensor] |
|
|
|
Sensor |
Full name of the camera model |
- |
UI548xHE-C |
[Image size] |
Image size settings |
||
Start X |
Start point (X coordinate) in AOI mode |
0...(max. width*1-Width) |
100 |
Start Y |
Start point (Y coordinate) in AOI mode |
0...(max. height*1-Height) |
100 |
Start X absolute |
Activate absolute AOI positioning in the memory (see is_SetImagePos()) |
0, 1 |
1 |
Start Y absolute |
Activate absolute AOI positioning in the memory (see is_SetImagePos()) |
0, 1 |
1 |
Width |
Width of the AOI |
Sensor-dependent*1 |
2460 |
Height |
Height of the AOI |
Sensor-dependent*1 |
1820 |
Binning |
Activate binning mode and select factor |
Sensor-dependent*2 |
0 |
Subsampling |
Activate subsampling mode and select factor |
Sensor-dependent*2 |
0 |
[Scaler] |
The internal image scaling is only supported from sensors of the UI-149x/UI-549x and UI-124x/UI-524x series. |
||
Mode |
Enable/disable scaling |
0 = Scaling off 1 = Scaling on |
0 |
Factor |
Scaling factor |
|
|
[Multi AOI] |
|
||
Enabled |
Activate/deactivate multi AOI |
0 = Multi AOI off 1 = Multi AOI on |
0 |
Mode |
Mode of multi AOI Currently only IS_AOI_MULTI_MODE_AXES is supported |
|
|
x1…x4, y1…y4 |
Axis for multi AOI mode |
|
|
[Shutter] |
|
||
Mode |
Shutter mode |
Sensor-dependent (only supported from UI-124x models) 1 = Rolling shutter 2 = Global shutter |
1 |
Linscan number |
Line which is used in the linescan mode. The maximum possible line number depends on the height of the selected AOI. |
Sensor-dependent (only supported from UI-124x models) |
512 |
[Timing] |
Timing parameter settings |
||
Pixelclock |
Current pixel clock of the camera |
Sensor-dependent*1 |
103 |
Framerate |
Current frame rate |
Depends on Pixelclock and image geometry |
15.104458 |
Exposure |
Current exposure time |
Depends on Framerate |
0.334059 |
Long exposure |
Activates long exposure If the long exposure is active, then the range of exposure changes. |
UI-214x/UI-614x and UI-228x/UI-628x models only 1 = on 0 = off |
0 |
[Selected Converter] |
Sets the type of Bayer conversion for the specified color format when using color cameras (see is_SetColorConverter()). For a description of all color formats, see the Color and memory formats section. |
||
IS_SET_CM_RGB32 |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_SET_CM_RGB24 |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_SET_CM_RGB16 |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_SET_CM_RGB15 |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_SET_CM_Y8 |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_SET_CM_RGB8 |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_SET_CM_BAYER |
Color format |
0, 1, 2, 4, (8*3) |
8 |
IS_SET_CM_UYVY |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_SET_CM_UYVY_MONO |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_SET_CM_UYVY_BAYER |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_CM_CBYCRY_PACKED |
Color format |
0, 1, 2, 4, (8*3) |
8 |
IS_SET_CM_RGBY |
Color format |
0, 1, 2, 4, (8*3) |
8 |
IS_SET_CM_RGB30 |
Color format |
0, 1, 2, 4, (8*3) |
8 |
IS_SET_CM_Y12 |
Color format |
0, 1, 2, 4, (8*3) |
8 |
IS_SET_CM_BAYER12 |
Color format |
0, 1, 2, 4, (8*3) |
8 |
IS_SET_CM_Y16 |
Color format |
0, 1, 2, 4, (8*3) |
8 |
IS_SET_CM_BAYER16 |
Color format |
0, 1, 2, 4, (8*3) |
8 |
IS_CM_RGBA8_PACKED |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_CM_RGB8_PACKED |
Color format |
0, 1, 2, 4, (8*3) |
2 |
IS_CM_RGBY8_PACKED |
Color format |
0, 1, 2, 4, (8*3) |
8 |
IS_CM_RGB10V2_PACKED |
Color format |
0, 1, 2, 4, (8*3) |
8 |
[Parameters] |
Additional image parameter settings |
||
Colormode |
Sets the current color mode |
11 |
|
Brightness |
Software correction of image brightness*4 |
0...255 |
100 |
Contrast |
Software correction of image contrast*4 |
0...511 |
215 |
Gamma |
Software correction of the gamma value |
0.01...10.0 |
1.000000 |
Hardware Gamma |
Sensor-based hardware correction of the gamma value |
0, 1 |
0 |
Blacklevel Mode |
Mode for black level correction of the sensor |
0, 1, 32*2 |
1 |
Blacklevel Offset |
Manual offset for black level correction of the sensor |
0...255 |
0 |
Hotpixel Mode |
Mode for hot pixel correction |
0, 1, 2, 4*2 |
2 |
Hotpixel Threshold |
Not used |
- |
0 |
Sensor Hotpixel |
Activates the sensor-internal hot pixel correction |
Sensor-dependent*1 1 = on 0 = off |
0 |
GlobalShutter |
Enables the Global Start shutter of the sensor |
0, 1 UI-148x and UI-149x models only. Other models return "7" (not supported). |
0 |
[Gain] |
Sets the sensor gain control for image brightness |
||
Master |
Master gain |
0...100 |
0 |
Red |
Red gain |
0...100 |
6 |
Green |
Green gain |
0...100 |
0 |
Blue |
Blue gain |
0...100 |
6 |
GainBoost |
Activate gain boost |
0, 1 |
0 |
[Processing] |
Parameters for image pre-processing in the driver |
||
EdgeEnhancement |
Enable edge enhancement |
0...2 |
0 |
RopEffect |
Image geometry change (Rop = raster operation), e.g. mirroring |
0, 8, 16, 32, 64*2 |
0 |
Whitebalance |
Enable software white balance |
0, 1, 2, 4*2 |
0 |
Whitebalance Red |
Red factor for software white balance |
double value |
1.000000 |
Whitebalance Green |
Green factor for software white balance |
double value |
1.000000 |
Whitebalance Blue |
Blue factor for software white balance |
double value |
1.000000 |
Color correction |
Enable color correction |
0, 1, 2, 4, 80*2 |
1 |
Color_correction_factor |
Set the color correction factor |
0.0...1.0 |
1.000000 |
Color_correction_satU |
Saturation-U (see also is_SetSaturation()) |
0…200 100 = Saturation 1.0 200 = Saturation 2.0 |
0 |
Color_correction_satV |
Saturation-V (see also is_SetSaturation()) |
0…200 100 = Saturation 1.0 200 = Saturation 2.0 |
0 |
Bayer Conversion |
Sets the size of the Bayer conversion mask for the current color format when using color cameras |
1, 2*2 |
1 |
[Auto features] |
Sets the parameters for automatic image control |
||
Auto Framerate control |
Enable frame rate control |
0, 1 |
0 |
Brightness exposure control |
Enable exposure time control |
0, 1 |
0 |
Brightness gain control |
Enable sensor gain control |
0, 1 |
0 |
Auto Framerate Sensor control |
Enable the senor-internal control for frame rates (see also is_SetAutoParameter()) |
0 = off 1 = on |
0 |
Brightness exposure Sensor control |
Enable the sensor-internal brightness control |
0 = off 1 = on |
0 |
Brightness gain Sensor control |
Enable the sensor-internal gain control |
0 = off 1 = on |
0 |
Brightness exposure Sensor control photometry |
Only USB uEye XS |
|
|
Brightness gain Sensor control photometry |
Only USB uEye XS |
|
|
Brightness control once |
Carry out brightness control once |
0, 1 |
0 |
Brightness reference |
Reference value for brightness control |
0...255 |
128 |
Brightness speed |
Brightness control speed |
0...100 |
50 |
Brightness max gain |
Maximum gain for brightness control |
0...100 |
100 |
Brightness max exposure |
Maximum exposure time for brightness control |
Depends on Pixelclock and image geometry |
66.082816 |
Brightness Aoi Left |
X start point of reference AOI for brightness control |
0...(max. width*1-Aoi Width) |
0 |
Brightness Aoi Top |
Y start point of reference AOI for brightness control |
0...(max. height*1-Aoi Height) |
0 |
Brightness Aoi Width |
Width of reference AOI for brightness control |
Sensor-dependent*1 |
2560 |
Brightness Aoi Height |
Height of reference AOI for brightness control |
Sensor-dependent*1 |
1920 |
Brightness Hysteresis |
Hysteresis value for auto exposure and gain (see IS_SET_AUTO_HYSTERESIS) |
0…10 |
2 |
Brightness Skip Frames |
Number of images that will be not analyzed for the control (see IS_SET_AUTO_SKIPFRAMES) |
0…1000 |
4 |
Auto WB control |
Enable white balance control |
0, 1 |
0 |
Auto WB offsetR |
Red offset for white balance control |
0...100 |
0 |
Auto WB offsetB |
Blue offset for white balance control |
0...100 |
0 |
Auto WB gainMin |
Minimum gain for white balance control |
0 <= gainMin <= gainMax <= 100 |
0 |
Auto WB gainMax |
Maximum gain for white balance control |
0 <= gainMin <= gainMax <= 100 |
100 |
Auto WB speed |
White balance control speed |
0...100 |
50 |
Auto WB Aoi Left |
X start point of reference AOI for white balance control |
0...(max. width*1-Aoi Width) |
0 |
Auto WB Aoi Top |
Y start point of reference AOI for white balance control |
0...(max. height*1-Aoi Height) |
0 |
Auto WB Aoi Width |
Width of reference AOI for white balance control |
Sensor-dependent*1 |
2560 |
Auto WB Aoi Height |
Height of reference AOI for white balance control |
Sensor-dependent*1 |
1920 |
Auto WB Once |
Carry out white balance control once |
0, 1 |
0 |
Auto WB Hysteresis |
Hysteresis value for auto white balance (see IS_SET_AUTO_WB_HYSTERESIS) |
0…10 |
2 |
Auto WB Skip Frames |
Number of images that will not be analyzed for control (see IS_SET_AUTO_WB_SKIPFRAMES) |
0…1000 |
4 |
[Trigger and Flash] |
Sets the digital inputs/outputs |
||
Trigger delay |
Delay of triggered image capture in µs |
Sensor-dependent*1 |
15 |
Trigger debounce mode |
Setting for the debouncing of the digital input |
Only GigE uEye cameras |
|
Trigger debounce delay time |
Delay time (see is_TriggerDebounce()) |
Only GigE uEye cameras 1…16000 μs |
10 |
Trigger burst size |
Burst size (see is_Trigger()) |
1…[max. Value of the 32 bit variable] |
|
Flash strobe |
Activate flash output |
0...6*2 |
0 |
Flash delay |
Delay of the flash signal in µs |
Depends on sensor setting, can be queried using is_IO() |
0 |
Flash duration |
Duration of the flash signal in µs |
Depends on sensor setting, can be queried using is_IO() |
200 |
*1 This information is provided in Camera and sensor data chapter.
*2 For the parameters, please refer to the uEye.h header file provided in the \Develop\include folder of the uEye installation directory (see also Programming notes).
*3 Only for GigE uEye HE cameras.
*4 Function ist obsolete, see chapter Obsolete functions.
Suggestion for improvement? Send us your short Feedback on this chapter.
Thank you very much!