Image Calibration Control

Name

ImageCalibrationMode

Custom

Description

Sets internal camera parameter for calibration DSNU or PRNU or even directly perform internal calibration .

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Off

Availability

ALL

Notes

Mode = ImageCalibrationModeDSNU / ImageCalibrationModePRNU:
Features are set internally, so that raw, un-scaled and un-transformed image data is generated. With that image data DRNU or PRNU references can be generated.

If an affected feature is read, the modified value is returned.

While ImageCalibrationMode is active, the internally changed features cannot be modified.

When ImageCalibrationMode is set to Off, features are restored to their previous values.

The following features are read-only when ImageCalibrationMode is enabled:

• ColorTransformationSelector
• ColorTransformationEnable
• BrightnessContrastEnable
• DarkSignalNonUniformityReferenceOutput
• PhotoResponseNonUniformityReferenceOutput
• DecimationHorizontalFloat
• BinningHorizontal
• ReverseX
• LutEnable
• GainControlRegionVisible
• UserSetLoad

The Image Calibration Mode for DSNU-creation will additionally disable digital gain. This is not reflected by the features.

Mode = CalibrateDSNUInternal / CalibratePRNUInternal:
Internal DSNU or PRNU calibration is done. All internal parameters are adapted automatically.

Calibration data is written to LUT selected by
Dark Signal Non-Uniformity (DSNU) Selector or
Photo Response Non-Uniformity (PRNU) Selector.

CalibrateDSNUInternal or CalibratePRNUInternal can directly be started from Mode=Off.
ImageCalibrationModeDSNU or ImageCalibrationModePRNU is not required to be set before.

After calibration has finished ImageCalibrationMode returns to previous state.

The ImageCalibrationMode feature should be polled to check the status of reference generation. Once the feature value changes from Calibrate<DSNU|PRNU>Internal to the previous state e.g., Off the process has finished. To cancel the current process set the value to Off.

Error behavior

See the device error code documentation.

Name

Description

Off

ImageCalibrationModeDSNU

Image from camera is prepared for DSNU calibration.
Former CalibrateDarkSignalNonUniformity

ImageCalibrationModePRNU

Image from camera is prepared for PRNU calibration
Former CalibratePhotoResponseNonUniformity

CalibrateDSNUInternal

Camera performs internal DSNU calibration (This feature is deprecated, use FlatFieldCorrectionStartCalibration. It will be removed from package 3.0.0)

CalibratePRNUInternal

Camera performs internal PRNU calibration (This feature is deprecated, use FlatFieldCorrectionStartCalibration. It will be removed from package 3.0.0)

Name

DarkSignalNonUniformitySelector

Custom

Description

Selects a DSNU LUT.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

LUT1

Availability

ALL

Notes

This feature is deprecated, use FlatFieldCorrectionSelector
It will be removed from package 3.0.0

Error behavior

See the device error code documentation.

Name

Description

LUT1

Look-Up-Table 1

LUT2

Look-Up-Table 2

Name

DarkSignalNonUniformityDataSetInformation
[DarkSignalNonUniformitySelector]

Custom

Description

Gives information of the selected DSNU LUT state.

Interface

Enumeration

Access mode

Read only

Adjustable

while grabbing

-

Value range

See enum entries table below.

Default value

-

Availability

ALL

Notes

This feature is deprecated.

It will be removed from package 3.0.0

Error behavior

-

Name

Description

InactiveUnconfigured

The selected DSNU correction dataset is not used in the image processing pipeline of the camera and does not contain valid DSNU correction values.

InactiveConfigured

The selected DSNU correction dataset is not used in the image processing pipeline of the camera but contains valid DSNU correction values.

ActiveConfigured

The selected DSNU correction dataset is used in the image processing pipeline of the camera and contains valid DSNU correction values.

Name

DarkSignalNonUniformityAvailablePlains

Custom

Description

Indicates which color planes are available.

Interface

Enumeration

Access mode

Read Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

Red

Availability

ALL

Notes

This feature is deprecated, use FlatFieldCorrectionAvailablePlanes
It will be removed from package 3.0.0

Error behavior

See the device error code documentation.

Name

Description

Red

Selects red channel to read the first and last valid pixel values.

Green

Selects green channel to read the first and last valid pixel values.

Blue

Selects blue channel to read the first and last valid pixel values.

White

Selects white channel to read the first and last valid pixel values.

Infrared

Selects Infrared channel to read the first and last valid pixel values.

Name

DarkSignalNonUniformityFirstPixelReg
[DarkSignalNonUniformityAvailablePlains]

Custom

Description

Indicates first valid pixel.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

≥0

Default value

-

Availability

ALL

Notes

This feature is deprecated, use FlatFieldCorrectionFirstPixel
It will be removed from package 3.0.0

Error behavior

-

Name

DarkSignalNonUniformityLastPixelReg
[DarkSignalNonUniformityAvailablePlains]

Custom

Description

Indicates last valid pixel.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

≥0

Default value

This feature is deprecated, use FlatFieldCorrectionLastPixel
It will be removed from package 3.0.0

Availability

ALL

Notes

-

Error behavior

-

Name

DarkSignalNonUniformityReferenceOutput

Custom

Description

Displays the DSNU reference as a static output video.

Interface

Boolean

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

True – Displays the DSNU reference values

False – Does not display the DSNU reference values

Default value

False

Availability

ALL

Notes

This feature is deprecated, use FlatFieldCorrectionDisplayReference
It will be removed from package 3.0.0

This feature is available only if DSNU LUT is active and configured.
This parameter is not stored in user set.

Error behavior

See the device error code documentation.

Name

PhotoResponseNonUniformitySelector

Custom

Description

Selects a PRNU LUT.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

LUT1

Availability

ALL

Notes

This feature is deprecated, use FlatFieldCorrectionSelector
It will be removed from package 3.0.0

Error behavior

See the device error code documentation.

Name

Description

LUT1

Look-Up-Table 1

LUT2

Look-Up-Table 2

Name

PhotoResponseNonUniformityDataSetInformation
[PhotoResponseNonUniformitySelector]

Custom

Description

Gives information of the selected PRNU LUT state.

Interface

Enumeration

Access mode

Read only

Adjustable

while grabbing

-

Value range

See enum entries table below.

Default value

-

Availability

ALL

Notes

This feature is deprecated.
It will be removed from package 3.0.0

Error behavior

-

Name

Description

InactiveUnconfigured

The selected PRNU correction dataset is not used in the image processing pipeline of the camera and does not contain valid PRNU correction values.

InactiveConfigured

The selected PRNU correction dataset is not used in the image processing pipeline of the camera but contains valid PRNU correction values.

ActiveConfigured

The selected PRNU correction dataset is used in the image processing pipeline of the camera and contains valid PRNU correction values.

Name

PhotoResponseNonUniformityAvailablePlains

Custom

Description

Indicates first valid pixel.

Interface

Enumeration

Access mode

Read only

Adjustable

while grabbing

-

Value range

Default value

Red

Availability

ALL

Notes

This feature is deprecated, use FlatFieldCorrectionAvailablePlanes
It will be removed from package 3.0.0

Error behavior

See the device error code documentation.

Name

Description

Red

Selects red channel to read the first and last valid pixel values.

Green

Selects green channel to read the first and last valid pixel values.

Blue

Selects blue channel to read the first and last valid pixel values.

White

Selects red channel to read the first and last valid pixel values.

Infrared

Selects Infrared channel to read the first and last valid pixel values.

Name

PhotoResponseNonUniformityFirstPixelReg
[PhotoResponseNonUniformityAvailablePlains]

Custom

Description

Indicates first valid pixel.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

≥0

Default value

-

Availability

ALL

Notes

This feature is deprecated, use FlatFieldCorrectionFirstPixel
It will be removed from package 3.0.0

Error behavior

-

Name

PhotoResponseNonUniformityLastPixelReg

[PhotoResponseNonUniformityAvailablePlains]

Custom

Description

Indicates last valid pixel.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

≥0

Default value

-

Availability

ALL

Notes

This feature is deprecated, use FlatFieldCorrectionLastPixel
It will be removed from package 3.0.0

Error behavior

-

Name

PhotoResponseNonUniformityReferenceOutput

Custom

Description

Displays the PRNU reference as a static output video.

Interface

Boolean

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

True – Display the PRNU reference values

False – Do not display the PRNU reference values

Default value

False

Availability

ALL

Notes

This feature is deprecated, use FlatFieldCorrectionDisplayReference
It will be removed from package 3.0.0

This feature is valid and available only if PRNU LUT is active and configured.

This parameter is not stored in user set.

Error behavior

See the device error code documentation.

Name

FlatFieldCorrectionCalibrationMode

Custom

Description

Sets camera into mode for calibration of DSNU or PRNU..

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Off

Availability

ALL

Notes

Mode = DSNU / PRNU:
Features are set internally, so that raw, un-scaled and un-transformed image data is generated. With that image data DRNU or PRNU references can be generated.

If an affected feature is read, the modified value is returned.

While FlatFieldCorrectionCalibrationMode is active, the internally changed features cannot be modified.

When FlatFieldCorrectionCalibrationMode is set to Off, features are restored to their previous values.

The following features are read-only when FlatFieldCorrectionCalibrationMode is enabled:

• ColorTransformationSelector
• ColorTransformationEnable
• BrightnessContrastEnable
• DarkSignalNonUniformityReferenceOutput
• PhotoResponseNonUniformityReferenceOutput
• DecimationHorizontalFloat
• BinningHorizontal
• ReverseX
• LutEnable
• GainControlRegionVisible
• UserSetLoad

The Flat Field Correction Calibration Mode for DSNU-creation will additionally disable digital gain. This is not reflected by the features.

DSNU or PRNU is not required to be set before.

After calibration has finished FlatFieldCorrectionCalibrationMode returns to previous state.

The FlatFieldCorrectionCalibrationMode feature should be polled to check the status of reference generation. To cancel the current process set the value to Off.

Error behavior

See the device error code documentation.

Name

Description

Off

DSNU

Image from camera is prepared for DSNU calibration.
Former ImageCalibrationModeDSNU

PRNU

Image from camera is prepared for PRNU calibration
Former ImageCalibrationModePRNUy

Name

FlatFieldCorrectionSelector

Custom

Description

Specifies the flat field correction type DSNU or PRNU data set.

Interface

Enumeration

Access mode

Read/Write

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

DSNU DataSet 1

Availability

ALL

Notes

Error behavior

See the device error code documentation.

Name

Description

DSNU DataSet 1

Selects the DSNU DataSet1

DSNU DataSet 2

Selects the DSNU DataSet 2

PRNU DataSet 1

Selects the PRNU DataSet 1

PRNU DataSet 2

Selects the PRNU DataSet 2

Name

FlatFieldCorrectionEnable[FlatFieldCorrectionSelector]

Custom

Description

Enable/Disable the selected DataSet.

Interface

Boolean

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

True – Activates the selected DataSet

False – Deactivates the selected DataSet

Default value

False

Availability

ALL

Notes

For some camera variants Dual PRNU is supported for LED-Flashing. This means two PRNU Data Sets can be enabled and used for two pattern LED-Flash control.

The PRNU1 Data set will be used for Pattern1 and the PRNU2 Data Set for Pattern two.

Error behavior

See the device error code documentation.

Name

FlatFieldCorrectionDataSetDescription[FlatFieldCorrectionSelector]

Custom

Description

Leave the description to describe the chosen flat field correction selector.

Interface

String

String length

32

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

-

Default value

-

Availability

ALL

Notes

-

Error behavior

-

Name

FlatFieldCorrectionAvailablePlanes

[FlatFieldCorrectionSelector]

Custom

Description

Indicates which color planes are available.

Interface

Enumeration

Access mode

Read Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

Red

Availability

ALL

Notes

-

Error behavior

See the device error code documentation.

Name

Description

Red

Selects red channel to read the first and last valid pixel values.

Green

Selects green channel to read the first and last valid pixel values.

Blue

Selects blue channel to read the first and last valid pixel values.

White

Selects white channel to read the first and last valid pixel values.

Infrared

Selects Infrared channel to read the first and last valid pixel values.

Name

FlatFieldCorrectionFirstPixel
[FlatFieldCorrectionSelector] [FFCAvailablePlains]

Custom

Description

Indicates first valid pixel.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

≥0

Default value

-

Availability

ALL

Notes

-

Error behavior

-

Name

FlatFieldCorrectionLastPixel
[FlatFieldCorrectionSelector] [FFCAvailablePlains]

Custom

Description

Indicates last valid pixel.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

≥0

Default value

-

Availability

ALL

Notes

-

Error behavior

-

Name

FlatFieldCorrectionDisplayReference[FlatFieldCorrectionSelector]

Custom

Description

Displays the selected flat field correction reference as a static output video.

Interface

Boolean

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

True – Displays the selected flat field correction selector reference values

False – Does not display the selected flat field correction selector reference values

Default value

False

Availability

ALL

Notes

This feature is available only if the selected data set is active and configured.
This parameter is not stored in user set.

Error behavior

See the device error code documentation.

Name

FlatFieldCorrectionStartCalibration[FlatFieldCorrectionSelector]

Custom

Description

Camera performs internal calibration for the selected flat field correction.

Interface

Command

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

1

When command is executed, 0 is returned

Default value

1

Availability

ALL

Notes

When command is executed, Internal selected flat field correction calibration is done. All internal parameters are adapted automatically. Calibration data is written to the selected FlatFieldCorrectionSelector.

Error behavior

See the device error code documentation.

Name

FlatFieldCorrectionStopCalibration[FlatFieldCorrectionSelector]

Custom

Description

Camera stops performing internal calibration for the selected flat field correction.

Interface

Command

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

1

When command is executed, 0 is returned

Default value

1

Availability

ALL

Notes

Error behavior

See the device error code documentation.

Name

FlatFieldCorrectionCalibrationStatus[FlatFieldCorrectionSelector]

Custom

Description

Displayes the calibration status.

Interface

Enumeration

Access mode

Read Only

Adjustable

while grabbing

No

Value range

See enum entries table below.

Default value

Off

Availability

ALL

Notes

Error behavior

See the device error code documentation.

Name

Description

Off

No Calibration is performed

Success

Internal flat field correction calibration success

DSNUWarning

Enable DSNU to perform internal flat field correction calibration (PRNU)

Error

Internal flat field correction calibration error

CalibrationInProgress

Internal flat field correction calibration in progress

Name

ImageCalibrationLineDistance

Custom

Description

This feature is used to compensate the line distance of the sensors color channels.

Interface

Float

Access mode

Read/Write

Adjustable

while grabbing

Yes

Value range

Package

Min Value

Max Value

Up to 2.3.0

0.0

3.0

2.4.0 and above

0.0

3.0 – For 4 channel pixel format

6.0 – For 3 or 1 channel pixel format

Default value

2.0

Availability

ALL

Notes

-

Error behavior

See the device error code documentation.

Name

ScanDirectionSource

Custom

Description

Selects the scan direction source.

Interface

Enumeration

Access mode

Read Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

Internal

Availability

ALL

Notes

This feature is not available if MasterSlaveMode is configured as Slave.

Error behavior

See the device error code documentation.

Name

Description

Internal

Specifies internal scanning direction source

Line3

Specifies scanning direction source by the level of Line3

Encoder0

Specifies scanning direction source by Encoder0
Currently only for EncoderSourceB=Line2

Name

ImageCalibrationScanDirection[ScanDirectionSource]

Custom

Description

Controls scan direction processing.

Interface

Enumeration

Access mode

Read Write

Adjustable

while grabbing

Yes

Value range

See enum entries table below.

Default value

Forward

Availability

ALL

Notes

This feature is not available if MasterSlaveMode is configured as Slave.

This feature is writable only if ScanDirectionSource is Internal otherwise Read only.

Error behavior

See the device error code documentation.

Name

Description

Forward

Specifies forward scanning direction of the camera (RGB).

Backward

Specifies backward scanning direction of the camera (BGR).

Name

ImageCenterOffset

Custom

Description

Displays the pixel offset between sensor center and scan target center.

Interface

Integer

Access mode

Read only

Adjustable

while grabbing

-

Value range

≥-15000

Default value

-

Notes

-

Error behavior

-