Skip to content

Group cuvis_handle

Modules > cuvis_handle

The SDK is handle-based, i.e to access an internal data object you will require a handle. More...

Detailed Description

The main concepts of the SDK which use handles are the Measurement, the Calibration, the Session File, the Acquisition Context, the Processing Context, the Viewer, the Export API and the Worker. On how to obtain a handle of the individual components of the SDK, see the respective Pages for the individual components.

For example, a handle wich represents a Measurement can be obtained by either loading (cuvis_measurement_load) or by recording (cuvis_acq_cont_capture or cuvis_acq_cont_get_next_measurement) a measurement. A measurement is equivalent to a data-cube and would be called a frame in a traditional Camera-Setup. The handle then refers to measurement in the SDK context.

Each handle should be freed after it is no longer needed. This can be done via the respective free function. Calling the free-function does not necessarily free up the used memory immediately, because there could be multiple handles referring to the same object.