Please enable JavaScript to view this site.

IDS Software Suite 4.96.1

Navigation: Appendix

uEye parameter file (ini file)

Scroll Previous Top Next More

Using the is_ParameterSet() function, you can save the currently set uEye camera parameters to a file in the ini format (*.ini) or load an ini file.

Only camera-specific ini files can be loaded.

The ini file you want to load has to match the paired camera model.

When loading an ini file, make sure that the image size (AOI) and color depth parameters in the ini file match those in the allocated memory. Otherwise, display errors may occur.

uEye parameter files can also be created and edited manually. The following tables show the structure of the parameter file. The single parts are divided in sections by square brackets [] ([Versions]…[Sensor]…etc.). If a section does not exist in the ini file, the corresponding camera parameters will not be modified when you load the file.

hint_info

Note that depending on the camera model, not all settings can be saved in the parameter file like e. g. the settings for HDR with knee points.

You can use wildcards in the ini file: If you specify * as first character, then the highlighted characters will be interpreted in the camera name only, e.g. *UI124xSE-C. Thus this string applies for UI-124xSE-C, UI-324xCP-C, UI-524xRE-C etc.

"Versions" section

Parameter

Description

Value range

Example

ueye_api.dll/ueye_api_64.dll

File version of the uEye API

-

4.70.0000

ueye_eth.sys/ueye_eth_64.sys

File version of the GigE uEye driver

-

4.70.0000

ueye_usb.sys/ueye_usb_64.sys

File version of the USB uEye driver

-

4.70.0000

ueye_boot.sys/ueye_boot_64.sys

File version of the USB uEye boot loader

-

4.70.0000

"Sensor" section

Parameter

Description

Value range

Example

Sensor

Full name of the camera model

-

UI358xCP-C

Sensor bit depth

Bit depth of the sensor

Sensor-dependent*

0

Sensor source gain

Analog sensor source gain

Sensor-dependent*

0

FPN correction mode

Fixed pattern noise correction

Sensor-dependent*

0 = FPN correction off

1 = FPN correction on

0

Black reference mode

Display of the reference columns of the black level correction

Sensor-dependent*

0 = Reference columns off

1 = Reference columns on

0

Sensor digital gain

USB uEye XS only: digital gain of the sensor

Sensor-dependent*

 

* This information is provided in Camera and sensor data chapter.

"Image size" section

Parameter

Description

Value range

Example

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_AOI())

0, 1

1

Start Y absolute

Activate absolute AOI positioning in the memory (see is_AOI())

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

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

"Scaler" section

The internal image scaling is only supported from sensors of the UI-149x/UI-549x, UI-124x/UI-324x/UI-524x and UI-125x/UI-325x/UI-525x series.

Parameter

Description

Value range

Example

Mode

Enable/disable scaling

0 = Scaling off

1 = Scaling on

0

Factor

Scaling factor

Sensor-dependent*

 

* This information is provided in Camera and sensor data chapter.

"Multi AOI" section

hint_info

Saving the parameter for the multi AOI function is currently supported by the following sensor models:

UI-124x/UI-324x/UI-524x

UI-125x/UI-325x/UI-525x

UI-336x/UI-536x

UI-337x/UI-537x

Parameter

Description

Value range

Example

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

1 = IS_AOI_MULTI_MODE_X_Y_AXES

2 = IS_AOI_MULTI_MODE_Y_AXES

2

x1…x4, y1…y4

Axis for multi AOI mode

Sensor-dependent

 

"Shutter" section

Parameter

Description

Value range

Example

Mode

Shutter mode

Sensor-dependent*

1 = Rolling shutter

2 = Global shutter

4 = Fast linescan

64 = Rolling shutter with global start

128 = Global shutter (alternative timing)

1

Linescan number

Line which is used in the line scan mode. The maximum possible line number depends on the height of the selected AOI.

Sensor-dependent*

512

* This information is provided in Camera and sensor data chapter.

"Log Mode" section

Parameter

Description

Value range

Example

Mode

Log mode

Sensor-dependent*

0 = Factory-default for Log mode

1 = Log mode off

2 = Manual Log mode

3 = Automatic Log mode

3

Manual value

Log mode value

Only in combination with manual Log mode

0

Manual gain

Log mode gain

0

* This information is provided in Camera and sensor data chapter.

"Timing" section

Parameter

Description

Value range

Example

Pixelclock

Current pixel clock of the camera

Sensor-dependent*

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.

Sensor-dependent*

1 = on

0 = off

0

Dual exposure ratio

Exposure ratio in dual exposure mode

Sensor-dependent*

50

* This information is provided in Camera and sensor data chapter.

"Selected converter" section

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.

"Parameters" section

Parameter

Description

Value range

Example

Colormode

Sets the current color mode

see is_SetColorMode()

6

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

Adaptive hotpixel correction enable

Activates the adaptive hot pixel correction

1 = on

0 = off

1

Adaptive hotpixel correction mode

Sets the mode of the adaptive hot pixel correction

1 = IS_HOTPIXEL_ADAPTIVE_CORRECTION_DETECT_DYNAMIC

0 = IS_HOTPIXEL_ADAPTIVE_CORRECTION_DETECT_ONCE

0

Adaptive hotpixel correction sensitivity

Sets the value for the sensitivity of the adaptive hot pixel correction

See is_HotPixel()

2

GlobalShutter

Enables the Global Start shutter of the sensor

0, 1

UI-148x, UI-149x and UI-158x models only. Other models return "7" (not supported).

0

AllowRawWithLUT

Indicates whether the LUT can also be enabled in combination with a RAW format (see is_DeviceFeature())

Default value: 0 = disabled

1 = enabled

0

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

"Gain" section

Sets the sensor gain control for image brightness.

Parameter

Description

Value range

Example

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" section

Parameters for image pre-processing in the driver

Parameter

Description

Value range

Example

EdgeEnhancementFactor

Enable edge enhancement

0...2

0

RopEffect

Image geometry change (Rop = raster operation), e.g. mirroring

0, 8, 16, 32, 64*

0

Whitebalance

Enable software white balance

0, 1, 2, 4*

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*

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*

1

JpegCompression

USB uEye XS: Sets the compression for JPEG mode

1…9 (the higher the value, the more the image is compressed)

0

ImageEffect

USB uEye XS: sets an image effect

see is_DeviceFeature()

0

LscModel

USB uEye XS: sets the color space for lens correction

see is_ColorTemperature()

0

Saturation

USB uEye XS: sets the color saturation

see is_Saturation()

0

Sharpness

USB uEye XS: activates the sensor-side edge anhancement

see is_Sharpness()

0

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

"Auto features" section

Sets the parameters for automatic image control.

Parameter

Description

Value range

Example

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 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*-Aoi Width)

0

Brightness Aoi Top

Y start point of reference AOI for brightness control

0...(max. height*-Aoi Height)

0

Brightness Aoi Width

Width of reference AOI for brightness control

Sensor-dependent*

2560

Brightness Aoi Height

Height of reference AOI for brightness control

Sensor-dependent*

1920

Brightness Hysteresis

Hysteresis value for auto exposure and gain (see IS_SET_AUTO_HYSTERESIS)

0…10

2

AutoImageControlMode

Settings for auto control

see is_AutoParameter()

2

AutoImageControlPeakWhiteChannel

Channel which is used for peak white control

see is_AutoParameter()

0

AutoImageControlExposureMinimum

Minimum exposure time

 

 

Auto WB control

Enable white balance control

see is_AutoParameter()

0

Auto WB type

White balance mode

see is_AutoParameter()

 

Auto WB RGB color model

Color space of white balance

see is_AutoParameter()

 

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*-Aoi Width)

0

Auto WB Aoi Top

Y start point of reference AOI for white balance control

0...(max. height*-Aoi Height)

0

Auto WB Aoi Width

Width of reference AOI for white balance control

Sensor-dependent*

2560

Auto WB Aoi Height

Height of reference AOI for white balance control

Sensor-dependent*

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

Brightness Skip Frames Trigger Mode

Number of images that will be not analyzed for the control in trigger mode (see IS_SET_AUTO_SKIPFRAMES)

0…1000

4

Brightness Skip Frames Freerun Mode

Number of images that will be not analyzed for the control in freerun mode (see IS_SET_AUTO_SKIPFRAMES)

0…1000

4

Auto WB Skip Frames Trigger Mode

Number of images that will not be analyzed for control in trigger mode (see IS_SET_AUTO_WB_SKIPFRAMES)

0…1000

4

Auto WB Skip Frames Freerun Mode

Number of images that will not be analyzed for control in freerun mode (see IS_SET_AUTO_WB_SKIPFRAMES)

0…1000

4

* This information is provided in Camera and sensor data chapter.

"Trigger and Flash" section

Sets the trigger input, flash output and the GPIOs.

Parameter

Description

Value range

Example

Trigger mode

Trigger mode

 

 

Trigger timeout

Timeout value for triggered image capture in 10 ms steps

 

 

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

see is_TriggerDebounce()

 

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]

 

Trigger prescaler frame

Set trigger prescaler for frame captures

see is_Trigger()

1

Trigger prescaler line

Set trigger prescaler for line captures

see is_Trigger()

1

Trigger input

USB 3 uEye CP/ML/LE and GigE uEye LE/RE POE only: Use GPIO as trigger

see is_IO()

1

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

Flash auto freerun

Auto flash mode in freerun

0 = off

1 = on

0

PWM mode

PWM mode

see is_IO()

 

PWM frequency

Frequency of the pulse-width modulation

 

 

PWM duytcycle

Duty cycle of the pulse-width modulation

0.0…1.0 (1.0 corresponds to 100 %)

 

GPIO state

State of the GPIO

see is_IO()

 

GPIO direction

Direction of the GPIO

see is_IO()

 

GPIO1 Config

Configuration of GPIO 1

see is_IO()

2

GPIO2 Config

Configuration of GPIO 2

see is_IO()

1

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

"Sequence AOI" section

The sequence AOI is supported by the UI-124x/UI-324x/UI-524x and UI-125x/UI-325x/UI-525x models.

Parameter

Description

Value range

Example

NumberUsedAOI

Number of used AOIs

see is_AOI()

 

StartX1…StartX3

X position of AOI 1-3

Sensor-dependent*

 

StartY1…StartY3

Y position of AOI 1-3

Sensor-dependent*

 

Gain1…Gain3

Gain of AOI 1-3

Sensor-dependent*

 

Exposure1…Exposure3

Exposure of AOI 1-3

Sensor-dependent*

 

ReadoutCycle1…ReadoutCycle3

Number of read-out cycles of AOI 1-3

Sensor-dependent*

 

BinningMode1…BinningMode3

Binning mode of AOI 1-3

Sensor-dependent*

 

SubsamplingMode1…SubsamplingMode3

Subsampling mode of AOI 1-3

Sensor-dependent*

 

ScalerFactor1…ScalerFactor3

Scaling factor of AOI 1-3

Sensor-dependent*

 

DetachImageParameter1… DetachImageParameter3

Changes of exposure time and gain are transferred to AOI 1-3

0 = Every change is transferred

1 = Changes are not transferred

see also is_AOI()

 

* This information is provided in Camera and sensor data chapter.

"Transfer" section

GigE uEye cameras only

Parameter

Description

Value range

Example

ImageDelay_us

Image transfer delay in µs

see is_Transfer()

0

PacketInterval_us

Packet interval during image transfer in µs

0

"Vertical AOI Merge Mode" section

Information on the IDS line scan ("AOI merge mode") and its configuration can be found in the chapters uEye Cockpit: Vertical AOI merge mode and Configuring the AOI merge mode.

hint_info

The IDS line scan ("AOI merge mode") is currently supported by the following models:

UI-300xSE

UI-304xCP Rev. 2/UI-304xSE/UI-504xCP Rev. 2/UI-504xFA/UI-504xSE Rev. 4

UI-306xCP Rev. 2/UI-306xSE

UI-307xCP Rev. 2/UI-307xSE

UI-308xCP Rev. 2/UI-308xSE

UI-309xSE

UI-313xCP Rev. 2/UI-513xCP Rev. 2/UI-513xFA/UI-513xSE Rev. 4

UI-314xCP Rev. 2/UI-514xCP Rev. 2/UI-514xFA/UI-514xSE Rev. 4

UI-316xCP Rev. 2.1

UI-318xCP Rev. 2.1

UI-320xSE

UI-520xFA/UI-520xSE Rev. 4 (max. 7000 lines)

UI-324xCP Rev. 2/UI-324xLE/UI-324xML/UI-524xCP Rev. 2/UI-524xFA/UI-524xSE Rev. 4

UI-325xCP Rev. 2/UI-325xLE/UI-325xML/UI-525xCP Rev. 2/UI-525xFA/UI-525xSE Rev. 4

UI-326xCP Rev. 2/UI-326xSE/UI-526xCP Rev. 2/UI-526xFA/UI-526xSE Rev. 4

UI-327xCP Rev. 2/UI-527xCP Rev. 2/UI-527xFA/UI-527xSE Rev. 4

UI-328xCP Rev. 2/UI-328xSE/UI-528xCP Rev. 2/UI-528xFA/UI-528xSE Rev. 4

UI-329xSE

UI-529xFA/UI-529xSE Rev. 4 (max. 7000 lines)

UI-336xCP Rev. 2

UI-337xCP Rev. 2/UI-337xSE/UI-537xCP Rev. 2

UI-386xCP Rev. 2/UI-386xSE/UI-586xCP Rev. 2/UI-586xFA/UI-586xSE Rev. 4

UI-388xCP Rev. 2/UI-388xSE/UI-588xCP Rev. 2/UI-588xFA/UI-588xSE Rev. 4

UI-524xCP/UI-524xSE (in freerun mode only)

UI-526xCP (in freerun or software trigger mode only)

UI-536xCP (in freerun or software trigger mode only)

UI-537xCP (in freerun or software trigger mode only)

Parameter

Description

Value range

Example

Mode

Mode of the AOI merge mode

0…6

Depending on camera and sensor model

2

Position

Line position of the AOI merge mode

Sensor-dependent

1270

Additional Position

Optional second line position of the AOI merge mode

Sensor-dependent

0

Height

AOI merge mode height

Sensor-dependent

16

"Lens Focus" section

Controlling the lens focus is only supported by the models USB uEye XS, and uEye LE USB 3.1 Gen 1 with active focus.

Parameter

Description

Value range

Example

Focus manual value

Sets the manual focus point

Sensor-dependent

120

Focus AF enable

Activates the autofocus

0 = off

1 = on

1

"Zoom" section

The zoom function is only supported by USB uEye XS.

Parameter

Description

Value range

Example

Digital zoom factor

Sets the factor for zooming, see is_Zoom()

Sensor-dependent

1.00

© 2022 IDS Imaging Development Systems GmbH