Group cuvis_calib

Public Functions

Type	Name
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_calib_copy_handle (CUVIS_CALIB i_calibration, CUVIS_CALIB * o_pCalibration) Creates an additional calibration handle.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_calib_create_from_path (const CUVIS_CHAR * i_factoryDir, CUVIS_CALIB * o_pCalibration) Create a calibration from factory path.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_calib_create_from_session_file (const CUVIS_SESSION_FILE i_sess, CUVIS_CALIB * o_pCalibration) Create a calibration from session file.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_calib_free (CUVIS_CALIB * io_pCalibration) Clear a loaded calibration by it's handle.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_calib_get_component_count (CUVIS_CALIB i_calib, CUVIS_INT * o_pCount) Get the number of components.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_calib_get_component_info (CUVIS_CALIB i_calib, CUVIS_INT i_id, CUVIS_COMPONENT_INFO * o_pCompInfo) Get components general info.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_calib_get_id (CUVIS_CALIB i_calib, CUVIS_CHAR * o_pCalibId) Get the unique id of a calibration.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_calib_get_info (CUVIS_CALIB i_calib, CUVIS_CALIBRATION_INFO * o_pCalibInfo) Get info of a calibration.

Detailed Description

Functions to interact with a calibration object of the SDK.

There are two ways to create a calibration object. One way is by loading it specifically from a factory directory (see cuvis_calib_create_from_path). The other one is by loading it from a session file. The Calibration object is needed to load other parts of the SDK like the Acquisition Context and the Processing Context.

Public Functions Documentation

function cuvis_calib_copy_handle

Creates an additional calibration handle.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_calib_copy_handle (
    CUVIS_CALIB i_calibration,
    CUVIS_CALIB * o_pCalibration
)

Creates an additional handle that points to the same instance as the supplied handle

Parameters:

i_calibration The handle of the calibration to copy
o_pCalibration The new handle of the calibration.

Returns:

status_ok if the calibration handle could be doubled

function cuvis_calib_create_from_path

Create a calibration from factory path.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_calib_create_from_path (
    const CUVIS_CHAR * i_factoryDir,
    CUVIS_CALIB * o_pCalibration
)

The calibration is created from a factory path, containing the license and calibration file "init.daq" as well as further calibration files (e.g. SpRad.cu3).

The calibration is lazy-loading, i.e. the AcquisitionContext and the ProcessingContext will only be initialized, when explicitly called.

Note:

do not load multiple calibration instances of the same camera

Parameters:

i_factoryDir The path to the factory directory
o_pCalibration the handle of the calibration

Returns:

status_ok if the calibration could be loaded

function cuvis_calib_create_from_session_file

Create a calibration from session file.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_calib_create_from_session_file (
    const CUVIS_SESSION_FILE i_sess,
    CUVIS_CALIB * o_pCalibration
)

Create a calibration from an existion session file.

The calibration is lazy-loading, i.e. the AcquisitionContext and the ProcessingContext will only be initialized, when explicitly called.

When you create a processing context from the calibration cerated with this function, you won't have the references from the session file set. Use cuvis_proc_cont_create_from_session_file to load a processing context where the referenecs are taken from the session file.

Note:

do not load multiple calibration instances of the same camera

Parameters:

i_sess The session file
o_pCalibration the handle of the calibration

Returns:

status_ok if the calibration could be loaded

function cuvis_calib_free

Clear a loaded calibration by it's handle.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_calib_free (
    CUVIS_CALIB * io_pCalibration
)

The internal memory is freed.

Parameters:

io_pCalibration The handle of the calibration. The handle number will be invalidated.

Returns:

status_ok if the calibration could be released

function cuvis_calib_get_component_count

Get the number of components.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_calib_get_component_count (
    CUVIS_CALIB i_calib,
    CUVIS_INT * o_pCount
)

The acquisition hardware is build from one or more components. Get the component count.

Parameters:

i_calib the calibration
o_pCount the number of components is written here

Returns:

cuvis_ok if the number of components could be set

function cuvis_calib_get_component_info

Get components general info.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_calib_get_component_info (
    CUVIS_CALIB i_calib,
    CUVIS_INT i_id,
    CUVIS_COMPONENT_INFO * o_pCompInfo
)

Return general component information about a component build into the acquisition hardware the calibration is made for. This helps identifying the correct component for settings specific component settings (e.g. gain)

Parameters:

i_calib the calibration
i_id the device id (value between 0 and below cuvis_acq_cont_get_component_count)
o_pCompInfo the component info to be filled

Returns:

cuvis_ok if the info fields could be filled.

function cuvis_calib_get_id

Get the unique id of a calibration.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_calib_get_id (
    CUVIS_CALIB i_calib,
    CUVIS_CHAR * o_pCalibId
)

Parameters:

i_calib the calibration
o_pCalibId the unique id output string

function cuvis_calib_get_info

Get info of a calibration.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_calib_get_info (
    CUVIS_CALIB i_calib,
    CUVIS_CALIBRATION_INFO * o_pCalibInfo
)

Parameters:

i_calib the calibration
o_pCalibInfo the info data struct