Enumerations
enum	peak_test_pattern { PEAK_TEST_PATTERN_INVALID , PEAK_TEST_PATTERN_OFF , PEAK_TEST_PATTERN_BLACK , PEAK_TEST_PATTERN_CHESSPATTERN , PEAK_TEST_PATTERN_COLORBAR , PEAK_TEST_PATTERN_FPGABLACK , PEAK_TEST_PATTERN_FPGACHESSBOARD , PEAK_TEST_PATTERN_FPGACOLORSTRIPE , PEAK_TEST_PATTERN_FPGAFRAMECOUNT , PEAK_TEST_PATTERN_FPGAGRAYSCALE , PEAK_TEST_PATTERN_FPGAVERTICALGRAYSCALE , PEAK_TEST_PATTERN_FPGAWHITE , PEAK_TEST_PATTERN_GREYDIAGONALRAMP , PEAK_TEST_PATTERN_GREYDIAGONALRAMPMOVING , PEAK_TEST_PATTERN_GREYHORIZONTALRAMP , PEAK_TEST_PATTERN_GREYVERTICALRAMP , PEAK_TEST_PATTERN_GREYWEDGEMOVINGSENSOR , PEAK_TEST_PATTERN_GREYWEDGESENSOR , PEAK_TEST_PATTERN_RAMPINGPATTERN , PEAK_TEST_PATTERN_SEQUENCEPATTERN1 , PEAK_TEST_PATTERN_SEQUENCEPATTERN2 , PEAK_TEST_PATTERN_WHITE }
	peak test pattern More...

Functions
peak_access_status	peak_TestPattern_GetAccessStatus (peak_camera_handle hCam)
	Query the test pattern access status.

peak_status	peak_TestPattern_Set (peak_camera_handle hCam, peak_test_pattern pattern)
	Set the test pattern.

peak_status	peak_TestPattern_Get (peak_camera_handle hCam, peak_test_pattern *pattern)
	Get the test pattern.

peak_status	peak_TestPattern_GetList (peak_camera_handle hCam, peak_test_pattern testPatternList, size_t testPatternCount)
	Get the list of currently usable test pattern.

Detailed Description

Test pattern related functions and types.

Enumeration Type Documentation

◆ peak_test_pattern

enum peak_test_pattern

peak test pattern

Type of test pattern that is generated by the device as image source.

Enumerator
PEAK_TEST_PATTERN_INVALID	Invalid test pattern. Use this value for the initialization of variables of type peak_test_pattern.
PEAK_TEST_PATTERN_OFF	Image is coming from the sensor.
PEAK_TEST_PATTERN_BLACK	Image is filled with the darkest possible image.
PEAK_TEST_PATTERN_CHESSPATTERN	Chessboard pattern.
PEAK_TEST_PATTERN_COLORBAR	Image is filled with stripes of color including White, Black, Red, Green, Blue, Cyan, Magenta and Yellow.
PEAK_TEST_PATTERN_FPGABLACK	Black generated by FPGA.
PEAK_TEST_PATTERN_FPGACHESSBOARD	Chessboard generated by FPGA.
PEAK_TEST_PATTERN_FPGACOLORSTRIPE	ColorStripe generated by FPGA.
PEAK_TEST_PATTERN_FPGAFRAMECOUNT	Framecount generated by FPGA.
PEAK_TEST_PATTERN_FPGAGRAYSCALE	Grayscale generated by FPGA.
PEAK_TEST_PATTERN_FPGAVERTICALGRAYSCALE	VerticalGrayscale generated by FPGA.
PEAK_TEST_PATTERN_FPGAWHITE	White generated by FPGA.
PEAK_TEST_PATTERN_GREYDIAGONALRAMP	GreyDiagonalRamp: Diagonal ramp with grey values from black to white.
PEAK_TEST_PATTERN_GREYDIAGONALRAMPMOVING	GreyDiagonalRampMoving: Moving diagonal ramp with grey values from black to white.
PEAK_TEST_PATTERN_GREYHORIZONTALRAMP	GreyHorizontalRamp: Image is filled horizontally with an image that goes from the darkest possible value to the brightest.
PEAK_TEST_PATTERN_GREYVERTICALRAMP	GreyVerticalRamp: Vertical ramp with grey values from black to white.
PEAK_TEST_PATTERN_GREYWEDGEMOVINGSENSOR	GreyWedgeMovingSensor: Moving grey wedges generated by the image sensor.
PEAK_TEST_PATTERN_GREYWEDGESENSOR	GreyWedgeSensor: Grey wedges generated by the image sensor.
PEAK_TEST_PATTERN_RAMPINGPATTERN	RampingPattern: Diagonal color pattern.
PEAK_TEST_PATTERN_SEQUENCEPATTERN1	SequencePattern1: SequencePattern1.
PEAK_TEST_PATTERN_SEQUENCEPATTERN2	SequencePattern2: SequencePattern2.
PEAK_TEST_PATTERN_WHITE	White: Image is filled with the brightest possible image.

Function Documentation

◆ peak_TestPattern_Get()

peak_status peak_TestPattern_Get	(	peak_camera_handle	hCam,
		peak_test_pattern *	pattern )

Get the test pattern.

Reads the current test pattern.

Parameters

[in]	hCam	The camera handle.
[out]	pattern	The test pattern.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The test pattern property is not available for read access. Check the access status of the test pattern via peak_TestPattern_GetAccessStatus.; PEAK_STATUS_INVALID_PARAMETER pattern 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_TestPattern_GetAccessStatus()

peak_access_status peak_TestPattern_GetAccessStatus ( peak_camera_handle hCam )

Query the test pattern access status.

Provides the current access status for the test pattern control.

This function implements the Access Status Query principle.

Parameters

[in] hCam The camera handle.

Returns: PEAK_ACCESS_READWRITE The test pattern control is readable and writeable.; PEAK_ACCESS_READONLY The test pattern control is readable only.; PEAK_ACCESS_GFA_LOCK The test pattern control is not accessible because the GFA write access is enabled.; PEAK_ACCESS_NONE The test pattern control is not accessible.; PEAK_ACCESS_NOT_SUPPORTED The test pattern control is not supported.; PEAK_ACCESS_INVALID The function failed. Call peak_Library_GetLastError to get the error code and description.

If the function indicates an error by returning PEAK_ACCESS_INVALID, these are the possible errors:

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

peak_status peak_TestPattern_GetList	(	peak_camera_handle	hCam,
		peak_test_pattern *	testPatternList,
		size_t *	testPatternCount )

Get the list of currently usable test pattern.

Queries the list of currently selectable test pattern.

The list of usable parameter sets may depend on the camera configuration and the camera status.

This function implements the Two Staged Data Query principle.

Parameters

[in]	hCam	The camera handle.
[out]	testPatternList	Pointer to a user allocated array buffer to receive the parameter set list. If this parameter is NULL, `testPatternCount` will contain the current number of parameter sets. The required size of `testPatternList` in bytes is `testPatternCount` x sizeof(peak_test_pattern).
[in,out]	testPatternCount	`testPatternList` equal NULL: out: minimal number of test patterns `testPatternList` must be large enough to hold `testPatternList` unequal NULL: in: number of test patterns `testPatternList` can hold out: number of test patterns filled by the function

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_BUFFER_TOO_SMALL testPatternList is not NULL and the value of *testPatternCount is too small to receive the expected amount of data.; PEAK_STATUS_ACCESS_DENIED The test pattern feature is not supported or the GFA write mode is enabled.; PEAK_STATUS_INVALID_PARAMETER testPatternCount 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_TestPattern_Set()

peak_status peak_TestPattern_Set	(	peak_camera_handle	hCam,
		peak_test_pattern	pattern )

Set the test pattern.

Writes the desired test pattern.

Parameters

[in]	hCam	The camera handle.
[in]	pattern	The test pattern.

Returns: PEAK_STATUS_SUCCESS Operation was successful; no error occurred.; PEAK_STATUS_ACCESS_DENIED The test pattern property is not available for write access. Check the access status of the test pattern via peak_TestPattern_GetAccessStatus.; PEAK_STATUS_OUT_OF_RANGE pattern is out of range. Check the range of valid values via peak_TestPattern_GetList.; PEAK_STATUS_INVALID_PARAMETER pattern is an invalid test pattern . Check peak_test_pattern.; 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

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ peak_test_pattern

Function Documentation

◆ peak_TestPattern_Get()

◆ peak_TestPattern_GetAccessStatus()

◆ peak_TestPattern_GetList()

◆ peak_TestPattern_Set()