IPO

Controls the thread for performance optimization at image acquisition. More...

Functions
peak_access_status	peak_IPO_GetAccessStatus (peak_interface_technology interfaceTech)
	Query the IPO access status.
peak_bool	peak_IPO_IsEnabled (peak_interface_technology interfaceTech)
	Indicates whether the IPO performance thread is enabled or disabled for the specified specified interface technology.
peak_status	peak_IPO_Enable (peak_interface_technology interfaceTech, peak_bool enabled)
	Control whether the IPO thread is enabled or disabled.

Detailed Description

Controls the thread for performance optimization at image acquisition.

The IPO thread seems to increase the CPU load to prevent all CPU cores from entering a sleep state (C-state) at the same time. The IPO thread guarantees that at least one CPU core is immediately available to process incoming stream data.

Note

The IPO is currently only supported for PEAK_INTERFACE_TECHNOLOGY_U3V under Windows.

Function Documentation

peak_IPO_Enable()

peak_status peak_IPO_Enable	(	peak_interface_technology	interfaceTech,
		peak_bool	enabled )

Control whether the IPO thread is enabled or disabled.

Parameters

[in]	interfaceTech	Interface technology to which the setting refers.
[in]	enabled	The desired enabled status. PEAK_TRUE for enabled, PEAK_FALSE for disabled.

Returns

PEAK_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_STATUS_ACCESS_DENIED The IPO thread feature is not accessible for read. Check the access status via peak_IPO_GetAccessStatus.

PEAK_STATUS_INVALID_PARAMETER interfaceTech is an invalid interface technology.

PEAK_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_STATUS_ERROR An unexpected internal error occurred.

peak_IPO_GetAccessStatus()

peak_access_status peak_IPO_GetAccessStatus

(

peak_interface_technology

interfaceTech

)

Query the IPO access status.

This function implements the Access Status Query principle.

Parameters

[in]

interfaceTech

interface technology to which the setting refers.

Returns

PEAK_ACCESS_READWRITE The feature is available for read access and for write access.

PEAK_ACCESS_READONLY The feature is supported but not available for change.

PEAK_ACCESS_NOT_SUPPORTED The feature is not supported.

PEAK_ACCESS_NONE The feature is not available.

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_NOT_INITIALIZED The library is not initialized.
• PEAK_STATUS_ERROR An unexpected internal error occurred.

Since

1.11

peak_IPO_IsEnabled()

peak_bool peak_IPO_IsEnabled

(

peak_interface_technology

interfaceTech

)

Indicates whether the IPO performance thread is enabled or disabled for the specified specified interface technology.

The IPO Thread will start as soon as any image acquisition on the peak_interface_technology is active.

Parameters

[in]

interfaceTech

interface technology to which the setting refers.

Returns

PEAK_TRUE The IPO thread is currently enabled.

PEAK_FALSE The IPO thread is currently disabled or the query failed.

Since

1.11