Auto brightness control

Topics
	Auto exposure
	Auto gain
	Auto gain analog
	Auto gain digital
	Auto gain combined
	Auto gain host

Data Structures
struct	peak_double_limit
	peak Double Limit More...

Functions
peak_status	peak_IPL_AutoBrightness_Target_GetRange (peak_camera_handle hCam, uint32_t *minAutoBrightnessTarget, uint32_t *maxAutoBrightnessTarget, uint32_t *incAutoBrightnessTarget)
	Get the current range of valid host auto brightness target values.
peak_status	peak_IPL_AutoBrightness_Target_Set (peak_camera_handle hCam, uint32_t autoBrightnessTarget)
	Set the host auto brightness target value.
peak_status	peak_IPL_AutoBrightness_Target_Get (peak_camera_handle hCam, uint32_t *autoBrightnessTarget)
	Get the host auto brightness target value.
peak_status	peak_IPL_AutoBrightness_TargetTolerance_GetRange (peak_camera_handle hCam, uint32_t *minAutoBrightnessTargetTolerance, uint32_t *maxAutoBrightnessTargetTolerance, uint32_t *incAutoBrightnessTargetTolerance)
	Get the current range of valid host auto brightness target tolerance values.
peak_status	peak_IPL_AutoBrightness_TargetTolerance_Set (peak_camera_handle hCam, uint32_t autoBrightnessTargetTolerance)
	Set the host auto brightness target tolerance value.
peak_status	peak_IPL_AutoBrightness_TargetTolerance_Get (peak_camera_handle hCam, uint32_t *autoBrightnessTargetTolerance)
	Get the host auto brightness target tolerance value.
peak_status	peak_IPL_AutoBrightness_TargetPercentile_GetRange (peak_camera_handle hCam, double *minAutoBrightnessTargetPercentile, double *maxAutoBrightnessTargetPercentile, double *incAutoBrightnessTargetPercentile)
	Get the current range of valid host auto brightness target percentile values.
peak_status	peak_IPL_AutoBrightness_TargetPercentile_Set (peak_camera_handle hCam, double autoBrightnessTargetPercentile)
	Set the host auto brightness target percentile value.
peak_status	peak_IPL_AutoBrightness_TargetPercentile_Get (peak_camera_handle hCam, double *autoBrightnessTargetPercentile)
	Get the host auto brightness target percentile value.
peak_status	peak_IPL_AutoBrightness_ROI_Mode_Set (peak_camera_handle hCam, peak_auto_feature_roi_mode autoBrightnessROIMode)
	Set the host auto brightness ROI mode.
peak_status	peak_IPL_AutoBrightness_ROI_Mode_Get (peak_camera_handle hCam, peak_auto_feature_roi_mode *autoBrightnessROIMode)
	Get the host auto brightness ROI mode.
peak_status	peak_IPL_AutoBrightness_ROI_Offset_GetRange (peak_camera_handle hCam, peak_position *minAutoBrightnessROIOffset, peak_position *maxAutoBrightnessROIOffset, peak_position *incAutoBrightnessROIOffset)
	Get the current range of valid host auto brightness ROI offsets.
peak_status	peak_IPL_AutoBrightness_ROI_Size_GetRange (peak_camera_handle hCam, peak_size *minAutoBrightnessROISize, peak_size *maxAutoBrightnessROISize, peak_size *incAutoBrightnessROISize)
	Get the current range of valid host auto brightness ROI sizes.
peak_status	peak_IPL_AutoBrightness_ROI_Set (peak_camera_handle hCam, peak_roi autoBrightnessROI)
	Set the host auto brightness ROI.
peak_status	peak_IPL_AutoBrightness_ROI_Get (peak_camera_handle hCam, peak_roi *autoBrightnessROI)
	Get the host auto brightness ROI.
peak_status	peak_IPL_AutoBrightness_Algorithm_Set (peak_camera_handle hCam, peak_auto_feature_brightness_algorithm algorithm)
	Set the host auto brightness control algorithm.
peak_status	peak_IPL_AutoBrightness_Algorithm_Get (peak_camera_handle hCam, peak_auto_feature_brightness_algorithm *algorithm)
	Get the host auto brightness control algorithm.
peak_status	peak_IPL_AutoBrightness_AverageLast_Get (peak_camera_handle hCam, uint32_t *lastAverage)
	Get the last calculated brightness average value.
peak_status	peak_IPL_AutoBrightness_SkipFrames_Set (peak_camera_handle hCam, uint32_t skipFrames)
	Set the skip frames for the auto brightness controller.
peak_status	peak_IPL_AutoBrightness_SkipFrames_Get (peak_camera_handle hCam, uint32_t *skipFrames)
	Get the skip frames for the auto brightness controller.
peak_status	peak_IPL_AutoBrightness_SkipFrames_GetRange (peak_camera_handle hCam, uint32_t *skipFramesMin, uint32_t *skipFramesMax, uint32_t *skipFramesInc)
	Get the skip frames range for the auto brightness controller.

Detailed Description

Auto brightness control related functions and types.

This feature is applied in the host.
There is also a camera implementation. See Auto brightness control.

Auto brightness

Auto exposure

The control of the average brightness is preferably achieved by adjusting the exposure, i.e. you set the highest possible exposure time before gain is controlled. The auto exposure feature always uses the current exposure range within the active frame time. You can set separate control range limits for exposure.

Auto gain

The auto gain feature controls the supported camera gains and host gain. In digital imaging, a voltage proportional to the amount of incident light is output by the sensor. To increase image brightness and contrast, this signal can be amplified by an analog gain and offset before the digitizing process. The results of analog signal processing are usually better than the results of digital postprocessing. Digital gain is applied after the digitizing process. Analog, Digital, and Combined gain are applied by the camera while Host gain is applied by the host. You can set separate control range limits for every supported gain. There are two different possibilities to control the gains.

The Auto Gain Mode automatically selects the first available gain from a list of supported gains.

With the second mode, the supported gains can be enabled individually. Also it is possible to set limits for every individual gain.

The supported or activated gains will be chosen and controlled in the following order:

1. Analog
2. Digital
3. Host

or

1. Combined
2. Host

It is only possible to run one mode. Enabling a mode automatically disables the previous one.

Enabling and automatically disabling the control function

For ongoing brightness adaptations the Continuous mode has to be used so that it responds to deviations from the target value. To disable the control functionality automatically once the target value has been reached (approximately) with the Once mode.

Configuring the control functions

Brightness calculation algorithm

Sets the algorithm which will be used for the auto brightness calculation. With mean the average value is found by adding all pixel values and dividing by the number of pixel. With median the middle number is found by ordering all pixel and picking the middle.

Target value

Sets the target value for auto brightness control. The percentage of pixels, that must be brighter than the target value, is defined in target Percentile. The value of target value does not relate to the current PixelFormat and can be specified in the range from 0 to 255.

Note

Increasing the target value results in brighter images, decreasing its value results in darker images. If the target value is set to a high value and percentile is set to its minimum, it behaves similar to a peak white algorithm. It is not recommended to push target value to its limits. Keep distance from the limits, i.e. use "250" instead of "255", or "5" instead of "0".

Target tolerance

The automatic control feature uses a tolerance function for stabilization. Automatic control is stopped when the actual value is within a range between (setpoint - tolerance value) and (setpoint + tolerance value). The control algorithm continues if the actual brightness value drops below (setpoint - tolerance value) or exceeds the desired target value (setpoint + tolerance value). If the tolerance value is increased, the control function will stop sooner. This can be useful in some situations.

Percentile

Defines the percentage of pixels that must be brighter than the target value. The percentile value is only used for the Median brightness calculation algorithm.

Skip frames

The Skip Frames setting selects how many frames should be skipped. This parameter strongly influences the control speed. Choosing small values can destabilize the automatic control.

Note

For higher frame rates, a larger value for the Skip frames parameter should be used. This reduces the number of automatic adjustments that must be done by the camera.

Restricting the control range

With this feature it is possible to precisely define the allowed range of the exposure time or gains for automatic adjustments, when auto brightness is enabled.

Examples

Note

For the automatic host control to work, the frames must be transferred to the IPL pipeline. To reduce and simplify the sample code, the examples do not check the return values.

Auto exposure with auto gain

// enable exposure and gain auto controller
peak_IPL_AutoBrightness_Exposure_Mode_Set(hCam, PEAK_AUTO_FEATURE_MODE_CONTINUOUS);
peak_IPL_AutoBrightness_Gain_Mode_Set(hCam, PEAK_AUTO_FEATURE_MODE_CONTINUOUS);
 
// run acquisition and auto brightness control loop
while(acquisition_running)
{
    peak_Acquisition_WaitForFrame(hCam, 5000, &hFrame);
 
    // forward frame to auto controller pipeline
    peak_IPL_ProcessFrameInplace(hCam, hFrame);
 
    // retrieve last calculated brightness average value
    peak_IPL_AutoBrightness_AverageLast_Get(hCam, &lastAverage);
}

Auto exposure and individual auto gain control

// enable exposure and individual gain auto controller
peak_IPL_AutoBrightness_Exposure_Mode_Set(hCam, PEAK_AUTO_FEATURE_MODE_CONTINUOUS);
 
peak_IPL_AutoBrightness_GainAnalog_Mode_Set(hCam, PEAK_AUTO_FEATURE_MODE_CONTINUOUS);
peak_IPL_AutoBrightness_GainHost_Mode_Set(hCam, PEAK_AUTO_FEATURE_MODE_ONCE);
 
// allow full range for analog but limit the host auto gain
peak_double_limit limit = { .min = 4.0, .max = 6.0 };
peak_IPL_AutoBrightness_GainHostLimit_Set(hCam, limit);
 
// run acquisition and auto brightness control loop
// ...

Change auto brightness configuration settings

peak_IPL_AutoBrightness_Algorithm_Set(hCam, PEAK_AUTO_FEATURE_BRIGHTNESS_ALGORITHM_MEAN);
peak_IPL_AutoBrightness_Target_Set(hCam, 128);
peak_IPL_AutoBrightness_SkipFrames_Set(hCam, 4);
 
// run acquisition and auto brightness control loop
// ...

Enable message for auto exposure controller

peak_MessageQueue_EnableMessage(hQueue, hCam, PEAK_MESSAGE_TYPE_AUTO_BRIGHTNESS_EXPOSURE_ONCE_FINISHED);
 
// the message will only fire if mode is set to once and the target is reached
peak_IPL_AutoBrightness_Exposure_Mode_Set(hCam, PEAK_AUTO_FEATURE_MODE_ONCE);
 
// run acquisition and auto brightness control loop
// also wait for message to occur with peak_MessageQueue_WaitForMessage
// ...

Function Documentation

peak_IPL_AutoBrightness_Algorithm_Get()

peak_status peak_IPL_AutoBrightness_Algorithm_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_brightness_algorithm *	algorithm )

Get the host auto brightness control algorithm.

Reads the current host auto brightness control algorithm.

Parameters

[in]	hCam	The camera handle.
[out]	algorithm	The current auto brightness control algorithm.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER algorithm is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.9

peak_IPL_AutoBrightness_Algorithm_Set()

peak_status peak_IPL_AutoBrightness_Algorithm_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_brightness_algorithm	algorithm )

Set the host auto brightness control algorithm.

Writes the desired host auto brightness control algorithm.

Parameters

[in]	hCam	The camera handle.
[in]	algorithm	The auto brightness control algorithm to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER algorithm is an invalid auto feature algorithm. Check peak_auto_feature_brightness_algorithm.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.9

peak_IPL_AutoBrightness_AverageLast_Get()

peak_status peak_IPL_AutoBrightness_AverageLast_Get	(	peak_camera_handle	hCam,
		uint32_t *	lastAverage )

Get the last calculated brightness average value.

Reads the last calculated brightness average value.

Parameters

[in]	hCam	The camera handle.
[out]	lastAverage	The current calculated average value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER lastAverage is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.9

peak_IPL_AutoBrightness_ROI_Get()

peak_status peak_IPL_AutoBrightness_ROI_Get	(	peak_camera_handle	hCam,
		peak_roi *	autoBrightnessROI )

Get the host auto brightness ROI.

Reads the current host auto brightness ROI.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessROI	The auto brightness ROI.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER autoBrightnessROI is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_ROI_Mode_Get()

peak_status peak_IPL_AutoBrightness_ROI_Mode_Get	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode *	autoBrightnessROIMode )

Get the host auto brightness ROI mode.

Reads the current host auto brightness ROI mode.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessROIMode	The current auto brightness ROI mode.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER autoBrightnessROIMode is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_ROI_Mode_Set()

peak_status peak_IPL_AutoBrightness_ROI_Mode_Set	(	peak_camera_handle	hCam,
		peak_auto_feature_roi_mode	autoBrightnessROIMode )

Set the host auto brightness ROI mode.

Writes the desired host auto brightness ROI mode.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessROIMode	The auto brightness ROI mode to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER autoBrightnessROIMode is an invalid auto feature ROI mode. Check peak_auto_feature_roi_mode.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_ROI_Offset_GetRange()

peak_status peak_IPL_AutoBrightness_ROI_Offset_GetRange	(	peak_camera_handle	hCam,
		peak_position *	minAutoBrightnessROIOffset,
		peak_position *	maxAutoBrightnessROIOffset,
		peak_position *	incAutoBrightnessROIOffset )

Get the current range of valid host auto brightness ROI offsets.

Queries the current range of valid values for the host auto brightness ROI offset.

In special the current setting of the image ROI and the current setting of the host auto brightness ROI size has an impact on the range of valid host auto brightness ROI offset values.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessROIOffset	The minimum auto brightness ROI offset values.
[out]	maxAutoBrightnessROIOffset	The maximum auto brightness ROI offset values.
[out]	incAutoBrightnessROIOffset	The auto brightness ROI offset values increments.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER At least one of minAutoBrightnessROIOffset, maxAutoBrightnessROIOffset and incAutoBrightnessROIOffset is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_ROI_Set()

peak_status peak_IPL_AutoBrightness_ROI_Set	(	peak_camera_handle	hCam,
		peak_roi	autoBrightnessROI )

Set the host auto brightness ROI.

Writes the desired host auto brightness ROI.

Note

Setting the auto brightness ROI is only possible if PEAK_AUTO_FEATURE_ROI_MODE_MANUAL is set for the auto brightness ROI mode.

The range of valid ROIs for the auto brightness feature is the range of valid image ROIs. It can be queried via peak_IPL_AutoBrightness_ROI_Offset_GetRange and peak_IPL_AutoBrightness_ROI_Size_GetRange.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessROI	The auto brightness ROI to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE autoBrightnessROI value is out of range. Check the range of valid values via peak_IPL_AutoBrightness_ROI_Offset_GetRange and peak_IPL_AutoBrightness_ROI_Size_GetRange.

PEAK_STATUS_ACCESS_DENIED The auto brightness ROI mode is not set to PEAK_AUTO_FEATURE_ROI_MODE_MANUAL. Check the auto brightness ROI mode via peak_IPL_AutoBrightness_ROI_Mode_Get.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_ROI_Size_GetRange()

peak_status peak_IPL_AutoBrightness_ROI_Size_GetRange	(	peak_camera_handle	hCam,
		peak_size *	minAutoBrightnessROISize,
		peak_size *	maxAutoBrightnessROISize,
		peak_size *	incAutoBrightnessROISize )

Get the current range of valid host auto brightness ROI sizes.

Queries the current range of valid values for the host auto brightness ROI dimensions.

In special the current setting of the image ROI and the current setting of the host auto brightness ROI offset has an impact on the range of valid host auto brightness ROI size values.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessROISize	The minimum auto brightness ROI size values.
[out]	maxAutoBrightnessROISize	The maximum auto brightness ROI size values.
[out]	incAutoBrightnessROISize	The auto brightness ROI size values increments.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER At least one of minAutoBrightnessROISize, maxAutoBrightnessROISize and incAutoBrightnessROISize is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_SkipFrames_Get()

peak_status peak_IPL_AutoBrightness_SkipFrames_Get	(	peak_camera_handle	hCam,
		uint32_t *	skipFrames )

Get the skip frames for the auto brightness controller.

Parameters

[in]	hCam	The camera handle.
[out]	skipFrames	Number of frames to skip.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER skipFrames is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.7

peak_IPL_AutoBrightness_SkipFrames_GetRange()

peak_status peak_IPL_AutoBrightness_SkipFrames_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	skipFramesMin,
		uint32_t *	skipFramesMax,
		uint32_t *	skipFramesInc )

Get the skip frames range for the auto brightness controller.

Parameters

[in]	hCam	The camera handle.
[out]	skipFramesMin	The minimum value for the skip frames auto brightness feature.
[out]	skipFramesMax	The maximum value for the skip frames auto brightness feature.
[out]	skipFramesInc	The increment value for the skip frames auto brightness feature.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER At least one of skipFramesMin, skipFramesMax and skipFramesInc is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.7

peak_IPL_AutoBrightness_SkipFrames_Set()

peak_status peak_IPL_AutoBrightness_SkipFrames_Set	(	peak_camera_handle	hCam,
		uint32_t	skipFrames )

Set the skip frames for the auto brightness controller.

Parameters

[in]	hCam	The camera handle.
[in]	skipFrames	Number of frames to skip.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.7

peak_IPL_AutoBrightness_Target_Get()

peak_status peak_IPL_AutoBrightness_Target_Get	(	peak_camera_handle	hCam,
		uint32_t *	autoBrightnessTarget )

Get the host auto brightness target value.

Reads the current host auto brightness target value.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessTarget	The auto brightness target value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER autoBrightnessTarget is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_Target_GetRange()

peak_status peak_IPL_AutoBrightness_Target_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	minAutoBrightnessTarget,
		uint32_t *	maxAutoBrightnessTarget,
		uint32_t *	incAutoBrightnessTarget )

Get the current range of valid host auto brightness target values.

Queries the current range of valid values for the host auto brightness target property.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessTarget	The minimum auto brightness target value.
[out]	maxAutoBrightnessTarget	The maximum auto brightness target value.
[out]	incAutoBrightnessTarget	The auto brightness target value increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER At least one of minAutoBrightnessTarget, maxAutoBrightnessTarget, and incAutoBrightnessTarget is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_Target_Set()

peak_status peak_IPL_AutoBrightness_Target_Set	(	peak_camera_handle	hCam,
		uint32_t	autoBrightnessTarget )

Set the host auto brightness target value.

Writes the desired host auto brightness target value.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessTarget	The auto brightness target value to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE autoBrightnessTarget value is out of range. Check the range of valid values via peak_IPL_AutoBrightness_Target_GetRange.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_TargetPercentile_Get()

peak_status peak_IPL_AutoBrightness_TargetPercentile_Get	(	peak_camera_handle	hCam,
		double *	autoBrightnessTargetPercentile )

Get the host auto brightness target percentile value.

Reads the current host auto brightness target percentile value.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessTargetPercentile	The auto brightness target percentile value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER autoBrightnessTargetPercentile is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_TargetPercentile_GetRange()

peak_status peak_IPL_AutoBrightness_TargetPercentile_GetRange	(	peak_camera_handle	hCam,
		double *	minAutoBrightnessTargetPercentile,
		double *	maxAutoBrightnessTargetPercentile,
		double *	incAutoBrightnessTargetPercentile )

Get the current range of valid host auto brightness target percentile values.

Queries the current range of valid values for the host auto brightness target percentile property.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessTargetPercentile	The minimum auto brightness target percentile value.
[out]	maxAutoBrightnessTargetPercentile	The maximum auto brightness target percentile value.
[out]	incAutoBrightnessTargetPercentile	The auto brightness target percentile value increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER At least one of minAutoBrightnessTargetPercentile, maxAutoBrightnessTargetPercentile, and incAutoBrightnessTargetPercentile is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_TargetPercentile_Set()

peak_status peak_IPL_AutoBrightness_TargetPercentile_Set	(	peak_camera_handle	hCam,
		double	autoBrightnessTargetPercentile )

Set the host auto brightness target percentile value.

Writes the desired host auto brightness target percentile value.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessTargetPercentile	The auto brightness target percentile value to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE autoBrightnessTargetPercentile value is out of range. Check the range of valid values via peak_IPL_AutoBrightness_TargetPercentile_GetRange.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_TargetTolerance_Get()

peak_status peak_IPL_AutoBrightness_TargetTolerance_Get	(	peak_camera_handle	hCam,
		uint32_t *	autoBrightnessTargetTolerance )

Get the host auto brightness target tolerance value.

Reads the current host auto brightness target tolerance value.

Parameters

[in]	hCam	The camera handle.
[out]	autoBrightnessTargetTolerance	The auto brightness target tolerance value.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER autoBrightnessTargetTolerance is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_TargetTolerance_GetRange()

peak_status peak_IPL_AutoBrightness_TargetTolerance_GetRange	(	peak_camera_handle	hCam,
		uint32_t *	minAutoBrightnessTargetTolerance,
		uint32_t *	maxAutoBrightnessTargetTolerance,
		uint32_t *	incAutoBrightnessTargetTolerance )

Get the current range of valid host auto brightness target tolerance values.

Queries the current range of valid values for the host auto brightness target tolerance property.

Parameters

[in]	hCam	The camera handle.
[out]	minAutoBrightnessTargetTolerance	The minimum auto brightness target tolerance value.
[out]	maxAutoBrightnessTargetTolerance	The maximum auto brightness target tolerance value.
[out]	incAutoBrightnessTargetTolerance	The auto brightness target tolerance value increment.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_INVALID_PARAMETER At least one of minAutoBrightnessTargetTolerance, maxAutoBrightnessTargetTolerance, and incAutoBrightnessTargetTolerance is an invalid pointer.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_IPL_AutoBrightness_TargetTolerance_Set()

peak_status peak_IPL_AutoBrightness_TargetTolerance_Set	(	peak_camera_handle	hCam,
		uint32_t	autoBrightnessTargetTolerance )

Set the host auto brightness target tolerance value.

Writes the desired host auto brightness target tolerance value.

Parameters

[in]	hCam	The camera handle.
[in]	autoBrightnessTargetTolerance	The auto brightness target tolerance value to set.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_OUT_OF_RANGE autoBrightnessTargetTolerance value is out of range. Check the range of valid values via peak_IPL_AutoBrightness_TargetTolerance_GetRange.

PEAK_STATUS_INVALID_HANDLE hCam is an invalid camera handle.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.0