Skip to content

File cuvis.h

FileList > _api_sources > cuvis.h

Go to the source code of this file

More...

  • #include <stddef.h>
  • #include <stdint.h>

Classes

Type Name
struct cuvis_calibration_info_t
struct cuvis_component_info_t
struct cuvis_event_acquisition_data_t
struct cuvis_event_base_data_t
struct cuvis_event_component_data_t
struct cuvis_event_processing_event_t
struct cuvis_event_quality_event_t
struct cuvis_export_general_settings_t
general export settings
struct cuvis_export_tiff_settings_t
Additional settings for exporting tiff. See also cuvis_export_general_settings_t .
struct cuvis_export_view_settings_t
Additional settings for exporting to a userplugin view. See also cuvis_export_general_settings_t .
struct cuvis_gps_t
The gps data structure.
struct cuvis_imbuffer_t
image buffer data structure with meta-data
struct cuvis_mesu_metadata_t
The measurement meta structure.
struct cuvis_pansharpening_settings_t
general export settings
struct cuvis_proc_args_t
processing arguments
struct cuvis_save_args_t
options for saving as cu3/cu3s files
struct cuvis_sensor_info_t
struct cuvis_session_info_t
struct cuvis_view_data_t
The view meta structure.
struct cuvis_viewer_settings_t
viewer settings
struct cuvis_worker_settings_t
struct cuvis_worker_state_t
Collection of worker stats.

Public Types

Type Name
enum cuvis_capabilities_t
enum cuvis_component_type_t
enum cuvis_data_type_t
the data field's type
enum cuvis_hardware_state_t
enum cuvis_imbuffer_format_t
supported image buffer formats
enum cuvis_pan_sharpening_algorithm_t
the pan-sharpening algorithm for calculating the pan image's weights
enum cuvis_pan_sharpening_interpolation_type_t
the pan sharpening interpolation type for scaling up the cube before applying the pan image's weights
enum cuvis_processing_mode_t
The processing mode (a.k.a. capture mode) of a measurement.
enum cuvis_reference_type_t
The type of a reference.
enum cuvis_session_item_type_t
enum cuvis_session_merge_mode_t
merge mode for the cube exporter
enum cuvis_tiff_compression_mode_t
the tiff compression options
enum cuvis_tiff_format_t
the tiff export format.
enum cuvis_view_category_t
typedef void(SDK_CCALL * external_event_callback

Public Functions

Type Name
ALLOCATE_AND_FREE (CUVIS_IMBUFFER, imbuffer)
ALLOCATE_AND_FREE (CUVIS_GPS, gps)
ALLOCATE_AND_FREE (CUVIS_SENSOR_INFO, sensor_info)
ALLOCATE_AND_FREE (CUVIS_SESSION_INFO, session_info)
ALLOCATE_AND_FREE (CUVIS_MESU_METADATA, mesu_metadata)
ALLOCATE_AND_FREE (CUVIS_SAVE_ARGS, save_args)
ALLOCATE_AND_FREE (CUVIS_PROC_ARGS, proc_args)
ALLOCATE_AND_FREE (CUVIS_EXPORT_GENERAL_SETTINGS, export_general_settings)
ALLOCATE_AND_FREE (CUVIS_EXPORT_CUBE_SETTINGS, export_cube_settings)
ALLOCATE_AND_FREE (CUVIS_EXPORT_VIEW_SETTINGS, export_view_settings)
ALLOCATE_AND_FREE (CUVIS_EXPORT_TIFF_SETTINGS, export_tiff_settings)
ALLOCATE_AND_FREE (CUVIS_VIEWER_SETTINGS, viewer_settings)
ALLOCATE_AND_FREE (CUVIS_VIEW_DATA, view_data)
ALLOCATE_AND_FREE (CUVIS_COMPONENT_INFO, component_info)
ALLOCATE_AND_FREE (CUVIS_WORKER_SETTINGS, worker_settings)
ALLOCATE_AND_FREE (CUVIS_WORKER_STATE, worker_state)
ALLOCATE_AND_FREE (CUVIS_CALIBRATION_INFO, calibration_info)
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_async_capture_get (CUVIS_ASYNC_CAPTURE_RESULT * io_pAsyncResult, CUVIS_INT timeout_ms, CUVIS_MESU * o_pMesu)
get the result of a async capture.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_calib_get_capabilities (CUVIS_CALIB i_calibration, CUVIS_OPERATION_MODE i_mode, CUVIS_INT * o_pCapabilities)
Get the capabilites of a given mode.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_event_get_acquisition_data (CUVIS_EVENT i_event, CUVIS_EVENT_ACQUISITION_DATA * o_p_acquisition_data)
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_measurement_get_calib_id (CUVIS_MESU i_mesu, CUVIS_CHAR * o_pCalibId)
Get the unique calibration id of a measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_measurement_get_capabilities (CUVIS_MESU i_mesu, CUVIS_INT * o_pCapabilities)
Get the capabilites of the measurement which were present in the calibration during capture. This doesn't indicate which capabilities are currently available for the measurement. See cuvis_proc_cont_is_capable .
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_proc_cont_get_calib_id (CUVIS_PROC_CONT i_procCont, CUVIS_CHAR * o_pCalibId)
Get the unique calibration id of a processing context.
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_register_external_event_callback (external_event_callback i_callback, CUVIS_INT i_type, CUVIS_INT * o_p_handler_id)
SDK_CAPI CUVIS_STATUS SDK_CCALL cuvis_unregister_event_callback (CUVIS_INT i_handler_id)

Macros

Type Name
define ACQ_GET_SINGLE_VALUE (NAME, TYPE, COMMENT) /* multi line expression */
define ACQ_SET_SINGLE_VALUE (NAME, TYPE, UNIT_STR) /* multi line expression */
define ALLOCATE_AND_FREE (DATATYPE, NAME) /* multi line expression */
define COMP_GET_SINGLE_VALUE (NAME, TYPE, COMMENT) /* multi line expression */
define COMP_SET_SINGLE_VALUE (NAME, TYPE, UNIT_STR) /* multi line expression */
define CUVIS_ACQ_CONT [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_ASYNC_CALL_RESULT [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
handle to an async function call result.
define CUVIS_ASYNC_CAPTURE_RESULT [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
handle to an async capture result.
define CUVIS_CALIB [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_CALIBRATION_INFO struct [**cuvis\_calibration\_info\_t**](structcuvis__calibration__info__t.md)
define CUVIS_CHAR char
define CUVIS_CHECK (code) /* multi line expression */
define CUVIS_COMPONENT_INFO struct [**cuvis\_component\_info\_t**](structcuvis__component__info__t.md)
define CUVIS_COMPONENT_TYPE enum [**cuvis\_component\_type\_t**](cuvis_8h.md#enum-cuvis_component_type_t)
define CUVIS_DATA_TYPE enum [**cuvis\_data\_type\_t**](cuvis_8h.md#enum-cuvis_data_type_t)
define CUVIS_EVENT [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_EVENT_ACQUISITION_DATA struct [**cuvis\_event\_acquisition\_data\_t**](structcuvis__event__acquisition__data__t.md)
define CUVIS_EVENT_ACQUISTION (1 &lt;&lt; 8)
define CUVIS_EVENT_BASE_DATA struct [**cuvis\_event\_base\_data\_t**](structcuvis__event__base__data__t.md)
define CUVIS_EVENT_COMPONENT ([**CUVIS\_EVENT\_ACQUISTION**](cuvis_8h.md#define-cuvis_event_acquistion) \| (1 &lt;&lt; 4))
define CUVIS_EVENT_COMPONENT_DATA struct [**cuvis\_event\_component\_data\_t**](structcuvis__event__component__data__t.md)
define CUVIS_EVENT_PROCESSING (2 &lt;&lt; 8)
define CUVIS_EVENT_PROCESSING_DATA struct [**cuvis\_event\_processing\_event\_t**](structcuvis__event__processing__event__t.md)
define CUVIS_EVENT_QUALITY_DATA struct [**cuvis\_event\_quality\_event\_t**](structcuvis__event__quality__event__t.md)
define CUVIS_EVENT_TRIGGER_SKIPPED ([**CUVIS\_EVENT\_COMPONENT**](cuvis_8h.md#define-cuvis_event_component) \| 1)
define CUVIS_EXPORTER [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_EXPORT_CUBE_SETTINGS struct [**cuvis\_save\_args\_t**](structcuvis__save__args__t.md)
define CUVIS_EXPORT_GENERAL_SETTINGS struct [**cuvis\_export\_general\_settings\_t**](structcuvis__export__general__settings__t.md)
define CUVIS_EXPORT_TIFF_SETTINGS struct [**cuvis\_export\_tiff\_settings\_t**](structcuvis__export__tiff__settings__t.md)
define CUVIS_EXPORT_VIEW_SETTINGS struct [**cuvis\_export\_view\_settings\_t**](structcuvis__export__view__settings__t.md)
define CUVIS_FLAGS uint32\_t
define CUVIS_GPS struct [**cuvis\_gps\_t**](structcuvis__gps__t.md)
define CUVIS_HANDLE [**CUVIS\_INT**](cuvis_8h.md#define-cuvis_int)
define CUVIS_HANDLE_NULL [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)(0)
define CUVIS_HARDWARE_STATE enum [**cuvis\_hardware\_state\_t**](cuvis_8h.md#enum-cuvis_hardware_state_t)
define CUVIS_IMBUFFER struct [**cuvis\_imbuffer\_t**](structcuvis__imbuffer__t.md)
define CUVIS_IMBUFFER_FORMAT enum [**cuvis\_imbuffer\_format\_t**](cuvis_8h.md#enum-cuvis_imbuffer_format_t)
define CUVIS_INT int32\_t
define CUVIS_LOGLEVEL enum [**cuvis\_loglevel\_t**](group__cuvis__log.md#enum-cuvis_loglevel_t)
define CUVIS_MAXBUF 256
define CUVIS_MESU [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_MESU_FLAG_DARK_INTTIME 8
define CUVIS_MESU_FLAG_DARK_TEMP 16
define CUVIS_MESU_FLAG_OVERILLUMINATED 1
the measurement was over-illuminated
define CUVIS_MESU_FLAG_PAN_OVERILLUMINATED 512
the measurements pan image was over-illuminated
define CUVIS_MESU_FLAG_POOR_REFERENCE 2
A reference measurement used has poor quality.
define CUVIS_MESU_FLAG_POOR_WHITE_BALANCING 4
the white balancing detected bad data
define CUVIS_MESU_FLAG_WHITEDARK_INTTIME 128
define CUVIS_MESU_FLAG_WHITEDARK_TEMP 256
define CUVIS_MESU_FLAG_WHITE_INTTIME 32
define CUVIS_MESU_FLAG_WHITE_TEMP 64
define CUVIS_MESU_METADATA struct [**cuvis\_mesu\_metadata\_t**](structcuvis__mesu__metadata__t.md)
define CUVIS_MISC_PTR void\*
define CUVIS_MODE_CAPABILITIES [**CUVIS\_INT**](cuvis_8h.md#define-cuvis_int)
holds capabilities for operation mode as flags
define CUVIS_MODE_CAPABILITY_ACQUISITION_AVERAGING 64
define CUVIS_MODE_CAPABILITY_ACQUISITION_CAPTURE 1
define CUVIS_MODE_CAPABILITY_ACQUISITION_CONTINUOUS 4
define CUVIS_MODE_CAPABILITY_ACQUISITION_SETGAIN 32
define CUVIS_MODE_CAPABILITY_ACQUISITION_SETINTEGRATIONTIME 16
define CUVIS_MODE_CAPABILITY_ACQUISITION_SNAPSHOT 8
define CUVIS_MODE_CAPABILITY_ACQUISITION_TIMELAPSE 2
define CUVIS_MODE_CAPABILITY_PROCESSING_AUTOEXPOSURE 65536
define CUVIS_MODE_CAPABILITY_PROCESSING_CALC_LIVE 32768
define CUVIS_MODE_CAPABILITY_PROCESSING_CLEAR_RAW 16384
define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_DARKSUBTRACT 1024
define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_FLATFIELDING 2048
define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_RAW 256
define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_REF 512
define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_SPECTRALRADIANCE 4096
define CUVIS_MODE_CAPABILITY_PROCESSING_ORIENTATION 131072
define CUVIS_MODE_CAPABILITY_PROCESSING_REQUIRE_WHITEDARK_REFLECTANCE 33554432
define CUVIS_MODE_CAPABILITY_PROCESSING_SAVE_FILE 8192
define CUVIS_MODE_CAPABILITY_PROCESSING_SENSOR_RAW 128
define CUVIS_MODE_CAPABILITY_PROCESSING_SET_DARK 524288
define CUVIS_MODE_CAPABILITY_PROCESSING_SET_DISTANCECALIB 2097152
define CUVIS_MODE_CAPABILITY_PROCESSING_SET_DISTANCE_VALUE 4194304
define CUVIS_MODE_CAPABILITY_PROCESSING_SET_SPRADCALIB 1048576
define CUVIS_MODE_CAPABILITY_PROCESSING_SET_WHITE 262144
define CUVIS_MODE_CAPABILITY_PROCESSING_USE_DARK_SPRADCALIB 8388608
define CUVIS_MODE_CAPABILITY_PROCESSING_USE_WHITE_SPRADCALIB 16777216
define CUVIS_OPERATION_MODE enum [**cuvis\_operation\_mode\_t**](group__cuvis__acq.md#enum-cuvis_operation_mode_t)
define CUVIS_PANSHARPENING_SETTINGS struct [**cuvis\_pansharpening\_settings\_t**](structcuvis__pansharpening__settings__t.md)
define CUVIS_PAN_SHAPRENING_ALGORITHM_TYPE enum [**cuvis\_pan\_sharpening\_algorithm\_t**](cuvis_8h.md#enum-cuvis_pan_sharpening_algorithm_t)
define CUVIS_PAN_SHAPRENING_INTERPOLATION_TYPE enum [**cuvis\_pan\_sharpening\_interpolation\_type\_t**](cuvis_8h.md#enum-cuvis_pan_sharpening_interpolation_type_t)
define CUVIS_PROCESSING_MODE enum [**cuvis\_processing\_mode\_t**](cuvis_8h.md#enum-cuvis_processing_mode_t)
define CUVIS_PROC_ARGS struct [**cuvis\_proc\_args\_t**](structcuvis__proc__args__t.md)
define CUVIS_PROC_CONT [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_REFERENCE_TYPE enum [**cuvis\_reference\_type\_t**](cuvis_8h.md#enum-cuvis_reference_type_t)
define CUVIS_SAVE_ARGS struct [**cuvis\_save\_args\_t**](structcuvis__save__args__t.md)
define CUVIS_SENSOR_INFO struct [**cuvis\_sensor\_info\_t**](structcuvis__sensor__info__t.md)
define CUVIS_SESSION_FILE [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_SESSION_INFO struct [**cuvis\_session\_info\_t**](structcuvis__session__info__t.md)
define CUVIS_SESSION_ITEM_TYPE enum [**cuvis\_session\_item\_type\_t**](cuvis_8h.md#enum-cuvis_session_item_type_t)
define CUVIS_SESSION_MERGE_MODE enum [**cuvis\_session\_merge\_mode\_t**](cuvis_8h.md#enum-cuvis_session_merge_mode_t)
define CUVIS_SIZE uint64\_t
define CUVIS_STATUS enum [**cuvis\_status\_t**](group__cuvis__returns.md#enum-cuvis_status_t)
define CUVIS_STRING [**CUVIS\_CHAR**](cuvis_8h.md#define-cuvis_char)[[**CUVIS\_MAXBUF**](cuvis_8h.md#define-cuvis_maxbuf)]
define CUVIS_TIFF_COMPRESSION_MODE enum [**cuvis\_tiff\_compression\_mode\_t**](cuvis_8h.md#enum-cuvis_tiff_compression_mode_t)
define CUVIS_TIFF_FORMAT enum [**cuvis\_tiff\_format\_t**](cuvis_8h.md#enum-cuvis_tiff_format_t)
define CUVIS_TIMESTAMP uint64\_t
define CUVIS_VIEW [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_VIEWER [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_VIEWER_SETTINGS struct [**cuvis\_viewer\_settings\_t**](structcuvis__viewer__settings__t.md)
define CUVIS_VIEW_CATEGORY enum [**cuvis\_view\_category\_t**](cuvis_8h.md#enum-cuvis_view_category_t)
define CUVIS_VIEW_DATA struct [**cuvis\_view\_data\_t**](structcuvis__view__data__t.md)
define CUVIS_WCHAR wchar\_t
define CUVIS_WORKER [**CUVIS\_HANDLE**](cuvis_8h.md#define-cuvis_handle)
define CUVIS_WORKER_SETTINGS struct [**cuvis\_worker\_settings\_t**](structcuvis__worker__settings__t.md)
define CUVIS_WORKER_STATE struct [**cuvis\_worker\_state\_t**](structcuvis__worker__state__t.md)
define IMBUFFER_GET (ptr, x, y, chn, imbuf) ptr[((y) \* (imbuf).width + (x)) \* (imbuf).channels + (chn)]
define SDK_CAPI
define SDK_CCALL
define _CRT_SECURE_NO_WARNINGS

Detailed Description

SDK calls for cuvis C SDK. This header defines all public C SDK functions and data types

Public Types Documentation

enum cuvis_capabilities_t

enum cuvis_capabilities_t {
    AcquisitionCapture = 1,
    AcquisitionTimelapse = 2,
    AcquisitionContinuous = 4,
    AcquisitionSnapshot = 8,
    AcquisitionSetIntegrationtime = 16,
    AcquisitionSetGain = 32,
    AcquisitionAveraging = 64,
    ProcessingSensorRaw = 128,
    ProcessingCubeRaw = 256,
    ProcessingCubeRef = 512,
    ProcessingCubeDarkSubtract = 1024,
    ProcessingCubeFlatFielding = 2048,
    ProcessingCubeSpectralRadiance = 4096,
    ProcessingSaveFile = 8192,
    ProcessingClearRaw = 16384,
    ProcessingCalcLive = 32768,
    ProcessingAutoExposure = 65536,
    ProcessingOrientation = 131072,
    ProcessingSetWhite = 262144,
    ProcessingSetDark = 524288,
    ProcessingSetSprad = 1048576,
    ProcessingSetDistanceCalib = 2097152,
    ProcessingSetDistanceValue = 4194304,
    ProcessingUseDarkSpradcalib = 8388608,
    ProcessingUseWhiteSpradCalib = 16777216,
    ProcessingRequireWhiteDarkReflectance = 33554432
};

enum cuvis_component_type_t

enum cuvis_component_type_t {
    component_type_image_sensor = 0,
    component_type_misc_sensor = 1
};

the component types

enum cuvis_data_type_t

the data field's type 

enum cuvis_data_type_t {
    data_type_unsupported = 0,
    data_type_image = 1,
    data_type_gps = 2,
    data_type_string = 3,
    data_type_sensor_info = 4
};

enum cuvis_hardware_state_t

enum cuvis_hardware_state_t {
    hardware_state_offline = 0,
    hardware_state_partially_online = 1,
    hardware_state_online = 2
};

the state of the hardware

enum cuvis_imbuffer_format_t

supported image buffer formats 

enum cuvis_imbuffer_format_t {
    imbuffer_format_uint8 = 1,
    imbuffer_format_uint16 = 2,
    imbuffer_format_uint32 = 3,
    imbuffer_format_float = 4
};

enum cuvis_pan_sharpening_algorithm_t

the pan-sharpening algorithm for calculating the pan image's weights 

enum cuvis_pan_sharpening_algorithm_t {
    pan_sharpening_algorithm_Noop = 0,
    pan_sharpening_algorithm_CubertMacroPixel = 1,
    pan_sharpening_algorithm_CubertPanRatio = 2,
    pan_sharpening_algorithm_PCAFusion = 3
};

enum cuvis_pan_sharpening_interpolation_type_t

the pan sharpening interpolation type for scaling up the cube before applying the pan image's weights 

enum cuvis_pan_sharpening_interpolation_type_t {
    pan_sharpening_interpolation_type_NearestNeighbor = 0,
    pan_sharpening_interpolation_type_Linear = 1,
    pan_sharpening_interpolation_type_Cubic = 2,
    pan_sharpening_interpolation_type_Lanczos = 4
};

enum cuvis_processing_mode_t

The processing mode (a.k.a. capture mode) of a measurement. 

enum cuvis_processing_mode_t {
    Cube_Raw = 0,
    Cube_DarkSubtract = 1,
    Cube_Reflectance = 2,
    Cube_SpectralRadiance = 3,
    Preview = 5
};

enum cuvis_reference_type_t

The type of a reference. 

enum cuvis_reference_type_t {
    Reference_Dark = 0,
    Reference_White = 1,
    Reference_WhiteDark = 2,
    Reference_SpRad = 3,
    Reference_Distance = 4
};

enum cuvis_session_item_type_t

enum cuvis_session_item_type_t {
    session_item_type_frames = 0,
    session_item_type_frames_no_gaps = 1,
    session_item_type_references = 2
};

The session file item type

enum cuvis_session_merge_mode_t

merge mode for the cube exporter 

enum cuvis_session_merge_mode_t {
    session_merge_mode_Default = 0,
    session_merge_mode_Fragmentation = 1,
    session_merge_mode_Merge = 2
};

enum cuvis_tiff_compression_mode_t

the tiff compression options 

enum cuvis_tiff_compression_mode_t {
    tiff_compression_mode_None = 0,
    tiff_compression_mode_LZW = 1
};

enum cuvis_tiff_format_t

the tiff export format. 

enum cuvis_tiff_format_t {
    tiff_format_Single = 0,
    tiff_format_MultiChannel = 1,
    tiff_format_MultiPage = 2
};

enum cuvis_view_category_t

enum cuvis_view_category_t {
    view_category_image = 0,
    view_category_data = 1
};

image data types for view data

typedef external_event_callback

typedef void(SDK_CCALL * external_event_callback) (CUVIS_INT i_handler_id, CUVIS_EVENT i_event);

event callback type

Public Functions Documentation

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_IMBUFFER,
    imbuffer
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_GPS,
    gps
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_SENSOR_INFO,
    sensor_info
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_SESSION_INFO,
    session_info
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_MESU_METADATA,
    mesu_metadata
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_SAVE_ARGS,
    save_args
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_PROC_ARGS,
    proc_args
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_EXPORT_GENERAL_SETTINGS,
    export_general_settings
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_EXPORT_CUBE_SETTINGS,
    export_cube_settings
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_EXPORT_VIEW_SETTINGS,
    export_view_settings
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_EXPORT_TIFF_SETTINGS,
    export_tiff_settings
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_VIEWER_SETTINGS,
    viewer_settings
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_VIEW_DATA,
    view_data
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_COMPONENT_INFO,
    component_info
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_WORKER_SETTINGS,
    worker_settings
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_WORKER_STATE,
    worker_state
)

function ALLOCATE_AND_FREE

ALLOCATE_AND_FREE (
    CUVIS_CALIBRATION_INFO,
    calibration_info
)

function cuvis_async_capture_get

get the result of a async capture. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_async_capture_get (
    CUVIS_ASYNC_CAPTURE_RESULT * io_pAsyncResult,
    CUVIS_INT timeout_ms,
    CUVIS_MESU * o_pMesu
)

Get the return code (and error message, if applicable) of an async capture, that has been called. If result is not status_ok use the cuvis_get_last_error_msg function to get details.

If the timeout is used (value above 0ms), status_timeout or status_deferred will be returned, if the function is not yet finished. In that case, the asyncResult handle is still valid and can be used again. If the result is status_ok the function has finished. For both status_ok and status_error, the handle is now invalid.

Parameters:

  • io_pAsyncResult the async handle obtained by calling cuvis_acq_cont_capture_async. If the call finished, the handle will be invalidated
  • timeout_ms the timeout in ms. Give 0 to wait for ever.
  • o_pMesu write the measurement handle to this variable, if the call was successful. Else write CUVIS_HANDLE_NULL

Returns:

status_ok if the async function finished successfully. status_timeout or status_deferred will be returned, if the function is not yet finished. If it failed for other reasons, the this function returns status_error.

function cuvis_calib_get_capabilities

Get the capabilites of a given mode. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_calib_get_capabilities (
    CUVIS_CALIB i_calibration,
    CUVIS_OPERATION_MODE i_mode,
    CUVIS_INT * o_pCapabilities
)

Use this function to evaluate which functions are available for a camera calibration.

Parameters:

  • i_calibration The calibration
  • i_mode The mode to check the capabiliets
  • o_pCapabilities write the capabilites here. See CUVIS_MODE_CAPABILITIES_x flags.

function cuvis_event_get_acquisition_data

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_event_get_acquisition_data (
    CUVIS_EVENT i_event,
    CUVIS_EVENT_ACQUISITION_DATA * o_p_acquisition_data
)

function cuvis_measurement_get_calib_id

Get the unique calibration id of a measurement. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_calib_id (
    CUVIS_MESU i_mesu,
    CUVIS_CHAR * o_pCalibId
)

The id unique to a calibration is stored into everything created from it, as such a measurement also contains this id.

Parameters:

  • i_mesu the measurement
  • o_pCalibId the output string

function cuvis_measurement_get_capabilities

Get the capabilites of the measurement which were present in the calibration during capture. This doesn't indicate which capabilities are currently available for the measurement. See cuvis_proc_cont_is_capable . 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_capabilities (
    CUVIS_MESU i_mesu,
    CUVIS_INT * o_pCapabilities
)

Use this function to evaluate which functions are available for a given measurement.

Parameters:

  • i_mesu The measurement
  • o_pCapabilities write the capabilites here. See CUVIS_MODE_CAPABILITIES_x flags.

function cuvis_proc_cont_get_calib_id

Get the unique calibration id of a processing context. 

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_proc_cont_get_calib_id (
    CUVIS_PROC_CONT i_procCont,
    CUVIS_CHAR * o_pCalibId
)

The id unique to a calibration is stored into everything created from it, as such a processing context also contains this id.

Parameters:

  • i_procCont the processing context
  • o_pCalibId the output string

function cuvis_register_external_event_callback

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_register_external_event_callback (
    external_event_callback i_callback,
    CUVIS_INT i_type,
    CUVIS_INT * o_p_handler_id
)

Register an event handler. The event handler will be called on all events which satisfy the supplied event handler type. Returns an id for the event handler to allow unregistering of the specific event handler only valid during the runtime of the callback.

Parameters:

  • i_callback the event handler function callback
  • i_type the type of the event handler which is registered
  • o_p_handler_id a pointer where the handler id will be written to

function cuvis_unregister_event_callback

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_unregister_event_callback (
    CUVIS_INT i_handler_id
)

Unregisters an event handler. Supply a valid handler id to specific the correct callback which is going to be unregistered

Macro Definition Documentation

define ACQ_GET_SINGLE_VALUE

#define ACQ_GET_SINGLE_VALUE (
    NAME,
    TYPE,
    COMMENT
) `/** Get NAME function. Details: COMMENT\n Result is written to o_pvalue */ \ SDK_CAPI  CUVIS_STATUS  SDK_CCALL NAME##_get( CUVIS_ACQ_CONT i_acqCont, TYPE* o_pvalue);`

macro for creating acquisition getter functions

define ACQ_SET_SINGLE_VALUE

#define ACQ_SET_SINGLE_VALUE (
    NAME,
    TYPE,
    UNIT_STR
) `/* multi line expression */`

macro for creating stubs of sync and async acquisition setter functions

define ALLOCATE_AND_FREE

#define ALLOCATE_AND_FREE (
    DATATYPE,
    NAME
) `/* multi line expression */`

macro for creating allocate and free functions for c data structures

define COMP_GET_SINGLE_VALUE

#define COMP_GET_SINGLE_VALUE (
    NAME,
    TYPE,
    COMMENT
) `/** Get NAME function. Details: COMMENT\n Result is written to o_pvalue */ \ SDK_CAPI  CUVIS_STATUS  SDK_CCALL NAME##_get( CUVIS_ACQ_CONT i_acqCont, CUVIS_INT i_id, TYPE* o_pvalue);`

macro for creating acquisition-component getter functions

define COMP_SET_SINGLE_VALUE

#define COMP_SET_SINGLE_VALUE (
    NAME,
    TYPE,
    UNIT_STR
) `/* multi line expression */`

macro for creating stubs of sync and async acquisition-component setter functions

define CUVIS_ACQ_CONT

#define CUVIS_ACQ_CONT `CUVIS_HANDLE`

acquisition context handle

define CUVIS_ASYNC_CALL_RESULT

handle to an async function call result. 

#define CUVIS_ASYNC_CALL_RESULT `CUVIS_HANDLE`

A handle can be checked by the function cuvis_async_call_get

define CUVIS_ASYNC_CAPTURE_RESULT

handle to an async capture result. 

#define CUVIS_ASYNC_CAPTURE_RESULT `CUVIS_HANDLE`

A handle can be checked by the function cuvis_async_capture_get

define CUVIS_CALIB

#define CUVIS_CALIB `CUVIS_HANDLE`

calibration handle

define CUVIS_CALIBRATION_INFO

#define CUVIS_CALIBRATION_INFO `struct cuvis_calibration_info_t`

define CUVIS_CHAR

#define CUVIS_CHAR `char`

define CUVIS_CHECK

#define CUVIS_CHECK (
    code
) `/* multi line expression */`

simple check function for error code

define CUVIS_COMPONENT_INFO

#define CUVIS_COMPONENT_INFO `struct cuvis_component_info_t`

define CUVIS_COMPONENT_TYPE

#define CUVIS_COMPONENT_TYPE `enum cuvis_component_type_t`

define CUVIS_DATA_TYPE

#define CUVIS_DATA_TYPE `enum cuvis_data_type_t`

define CUVIS_EVENT

#define CUVIS_EVENT `CUVIS_HANDLE`

define CUVIS_EVENT_ACQUISITION_DATA

#define CUVIS_EVENT_ACQUISITION_DATA `struct cuvis_event_acquisition_data_t`

define CUVIS_EVENT_ACQUISTION

#define CUVIS_EVENT_ACQUISTION `(1 << 8)`

define CUVIS_EVENT_BASE_DATA

#define CUVIS_EVENT_BASE_DATA `struct cuvis_event_base_data_t`

define CUVIS_EVENT_COMPONENT

#define CUVIS_EVENT_COMPONENT `( CUVIS_EVENT_ACQUISTION | (1 << 4))`

define CUVIS_EVENT_COMPONENT_DATA

#define CUVIS_EVENT_COMPONENT_DATA `struct cuvis_event_component_data_t`

define CUVIS_EVENT_PROCESSING

#define CUVIS_EVENT_PROCESSING `(2 << 8)`

define CUVIS_EVENT_PROCESSING_DATA

#define CUVIS_EVENT_PROCESSING_DATA `struct cuvis_event_processing_event_t`

define CUVIS_EVENT_QUALITY_DATA

#define CUVIS_EVENT_QUALITY_DATA `struct cuvis_event_quality_event_t`

define CUVIS_EVENT_TRIGGER_SKIPPED

#define CUVIS_EVENT_TRIGGER_SKIPPED `( CUVIS_EVENT_COMPONENT | 1)`

define CUVIS_EXPORTER

#define CUVIS_EXPORTER `CUVIS_HANDLE`

exporter handle (all exporter types)

define CUVIS_EXPORT_CUBE_SETTINGS

#define CUVIS_EXPORT_CUBE_SETTINGS `struct cuvis_save_args_t`

define CUVIS_EXPORT_GENERAL_SETTINGS

#define CUVIS_EXPORT_GENERAL_SETTINGS `struct cuvis_export_general_settings_t`

define CUVIS_EXPORT_TIFF_SETTINGS

#define CUVIS_EXPORT_TIFF_SETTINGS `struct cuvis_export_tiff_settings_t`

define CUVIS_EXPORT_VIEW_SETTINGS

#define CUVIS_EXPORT_VIEW_SETTINGS `struct cuvis_export_view_settings_t`

define CUVIS_FLAGS

#define CUVIS_FLAGS `uint32_t`

field for binary flags

define CUVIS_GPS

#define CUVIS_GPS `struct cuvis_gps_t`

define CUVIS_HANDLE

#define CUVIS_HANDLE `CUVIS_INT`

handle

define CUVIS_HANDLE_NULL

#define CUVIS_HANDLE_NULL `CUVIS_HANDLE (0)`

handle value of 0 is reserved for invalid handles

define CUVIS_HARDWARE_STATE

#define CUVIS_HARDWARE_STATE `enum cuvis_hardware_state_t`

define CUVIS_IMBUFFER

#define CUVIS_IMBUFFER `struct cuvis_imbuffer_t`

define CUVIS_IMBUFFER_FORMAT

#define CUVIS_IMBUFFER_FORMAT `enum cuvis_imbuffer_format_t`

define CUVIS_INT

#define CUVIS_INT `int32_t`

define CUVIS_LOGLEVEL

#define CUVIS_LOGLEVEL `enum cuvis_loglevel_t`

define CUVIS_MAXBUF

#define CUVIS_MAXBUF `256`

max string buffer length (e.g. for paths)

define CUVIS_MESU

#define CUVIS_MESU `CUVIS_HANDLE`

measurement handle

define CUVIS_MESU_FLAG_DARK_INTTIME

#define CUVIS_MESU_FLAG_DARK_INTTIME `8`

the dark's integration time does not match the measurement

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_DARK_INTTIME_KEY

define CUVIS_MESU_FLAG_DARK_TEMP

#define CUVIS_MESU_FLAG_DARK_TEMP `16`

the sensor temperature at dark's recording does not match measurement's recording device temperature

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_DARK_TEMP_KEY

define CUVIS_MESU_FLAG_OVERILLUMINATED

the measurement was over-illuminated 

#define CUVIS_MESU_FLAG_OVERILLUMINATED `1`

One of the devices sensor data points were over-saturated while recording This may not be directly visible in the data cube, as the sensor data needs extensive processing.

Note:

only the spectral data is checked. The pan image's saturation is not checked.

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_OVERILLUMINATED_KEY

define CUVIS_MESU_FLAG_PAN_OVERILLUMINATED

the measurements pan image was over-illuminated 

#define CUVIS_MESU_FLAG_PAN_OVERILLUMINATED `512`

One of the devices pan sensor data points were over-saturated while recording This may not be directly visible in the data cube, as the sensor data needs extensive processing.

Note:

only the pan data is checked. The spectral image's saturation is not checked.

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_PAN_OVERILLUMINATED_KEY

define CUVIS_MESU_FLAG_POOR_REFERENCE

A reference measurement used has poor quality. 

#define CUVIS_MESU_FLAG_POOR_REFERENCE `2`

One or more of the reference measurements used had a poor data quality. This may lead to invalid results.

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_POOR_REFERENCE_KEY

define CUVIS_MESU_FLAG_POOR_WHITE_BALANCING

the white balancing detected bad data 

#define CUVIS_MESU_FLAG_POOR_WHITE_BALANCING `4`

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_POOR_WHITE_BALANCING_KEY

define CUVIS_MESU_FLAG_WHITEDARK_INTTIME

#define CUVIS_MESU_FLAG_WHITEDARK_INTTIME `128`

the white's dark integration time does not match the measurement

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_WHITEDARK_INTTIME_KEY

define CUVIS_MESU_FLAG_WHITEDARK_TEMP

#define CUVIS_MESU_FLAG_WHITEDARK_TEMP `256`

the sensor temperature at white's dark recording does not match measurement's recording device temperature

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_WHITEDARK_TEMP_KEY

define CUVIS_MESU_FLAG_WHITE_INTTIME

#define CUVIS_MESU_FLAG_WHITE_INTTIME `32`

the white's integration time does not match the measurement

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_WHITE_INTTIME_KEY

define CUVIS_MESU_FLAG_WHITE_TEMP

#define CUVIS_MESU_FLAG_WHITE_TEMP `64`

the sensor temperature at white's recording does not match measurement's recording device temperature

If this flag is set, additional information can retrieved by calling cuvis_measurement_get_data_sensor_info with the key CUVIS_MESU_FLAG_WHITE_TEMP_KEY

define CUVIS_MESU_METADATA

#define CUVIS_MESU_METADATA `struct cuvis_mesu_metadata_t`

define CUVIS_MISC_PTR

#define CUVIS_MISC_PTR `void*`

placeholder data type

define CUVIS_MODE_CAPABILITIES

holds capabilities for operation mode as flags 

#define CUVIS_MODE_CAPABILITIES `CUVIS_INT`

define CUVIS_MODE_CAPABILITY_ACQUISITION_AVERAGING

#define CUVIS_MODE_CAPABILITY_ACQUISITION_AVERAGING `64`

define CUVIS_MODE_CAPABILITY_ACQUISITION_CAPTURE

#define CUVIS_MODE_CAPABILITY_ACQUISITION_CAPTURE `1`

define CUVIS_MODE_CAPABILITY_ACQUISITION_CONTINUOUS

#define CUVIS_MODE_CAPABILITY_ACQUISITION_CONTINUOUS `4`

define CUVIS_MODE_CAPABILITY_ACQUISITION_SETGAIN

#define CUVIS_MODE_CAPABILITY_ACQUISITION_SETGAIN `32`

define CUVIS_MODE_CAPABILITY_ACQUISITION_SETINTEGRATIONTIME

#define CUVIS_MODE_CAPABILITY_ACQUISITION_SETINTEGRATIONTIME `16`

define CUVIS_MODE_CAPABILITY_ACQUISITION_SNAPSHOT

#define CUVIS_MODE_CAPABILITY_ACQUISITION_SNAPSHOT `8`

define CUVIS_MODE_CAPABILITY_ACQUISITION_TIMELAPSE

#define CUVIS_MODE_CAPABILITY_ACQUISITION_TIMELAPSE `2`

define CUVIS_MODE_CAPABILITY_PROCESSING_AUTOEXPOSURE

#define CUVIS_MODE_CAPABILITY_PROCESSING_AUTOEXPOSURE `65536`

define CUVIS_MODE_CAPABILITY_PROCESSING_CALC_LIVE

#define CUVIS_MODE_CAPABILITY_PROCESSING_CALC_LIVE `32768`

define CUVIS_MODE_CAPABILITY_PROCESSING_CLEAR_RAW

#define CUVIS_MODE_CAPABILITY_PROCESSING_CLEAR_RAW `16384`

define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_DARKSUBTRACT

#define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_DARKSUBTRACT `1024`

define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_FLATFIELDING

#define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_FLATFIELDING `2048`

define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_RAW

#define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_RAW `256`

define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_REF

#define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_REF `512`

define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_SPECTRALRADIANCE

#define CUVIS_MODE_CAPABILITY_PROCESSING_CUBE_SPECTRALRADIANCE `4096`

define CUVIS_MODE_CAPABILITY_PROCESSING_ORIENTATION

#define CUVIS_MODE_CAPABILITY_PROCESSING_ORIENTATION `131072`

define CUVIS_MODE_CAPABILITY_PROCESSING_REQUIRE_WHITEDARK_REFLECTANCE

#define CUVIS_MODE_CAPABILITY_PROCESSING_REQUIRE_WHITEDARK_REFLECTANCE `33554432`

define CUVIS_MODE_CAPABILITY_PROCESSING_SAVE_FILE

#define CUVIS_MODE_CAPABILITY_PROCESSING_SAVE_FILE `8192`

define CUVIS_MODE_CAPABILITY_PROCESSING_SENSOR_RAW

#define CUVIS_MODE_CAPABILITY_PROCESSING_SENSOR_RAW `128`

define CUVIS_MODE_CAPABILITY_PROCESSING_SET_DARK

#define CUVIS_MODE_CAPABILITY_PROCESSING_SET_DARK `524288`

define CUVIS_MODE_CAPABILITY_PROCESSING_SET_DISTANCECALIB

#define CUVIS_MODE_CAPABILITY_PROCESSING_SET_DISTANCECALIB `2097152`

define CUVIS_MODE_CAPABILITY_PROCESSING_SET_DISTANCE_VALUE

#define CUVIS_MODE_CAPABILITY_PROCESSING_SET_DISTANCE_VALUE `4194304`

define CUVIS_MODE_CAPABILITY_PROCESSING_SET_SPRADCALIB

#define CUVIS_MODE_CAPABILITY_PROCESSING_SET_SPRADCALIB `1048576`

define CUVIS_MODE_CAPABILITY_PROCESSING_SET_WHITE

#define CUVIS_MODE_CAPABILITY_PROCESSING_SET_WHITE `262144`

define CUVIS_MODE_CAPABILITY_PROCESSING_USE_DARK_SPRADCALIB

#define CUVIS_MODE_CAPABILITY_PROCESSING_USE_DARK_SPRADCALIB `8388608`

define CUVIS_MODE_CAPABILITY_PROCESSING_USE_WHITE_SPRADCALIB

#define CUVIS_MODE_CAPABILITY_PROCESSING_USE_WHITE_SPRADCALIB `16777216`

define CUVIS_OPERATION_MODE

#define CUVIS_OPERATION_MODE `enum cuvis_operation_mode_t`

define CUVIS_PANSHARPENING_SETTINGS

#define CUVIS_PANSHARPENING_SETTINGS `struct cuvis_pansharpening_settings_t`

define CUVIS_PAN_SHAPRENING_ALGORITHM_TYPE

#define CUVIS_PAN_SHAPRENING_ALGORITHM_TYPE `enum cuvis_pan_sharpening_algorithm_t`

define CUVIS_PAN_SHAPRENING_INTERPOLATION_TYPE

#define CUVIS_PAN_SHAPRENING_INTERPOLATION_TYPE `enum cuvis_pan_sharpening_interpolation_type_t`

define CUVIS_PROCESSING_MODE

#define CUVIS_PROCESSING_MODE `enum cuvis_processing_mode_t`

define CUVIS_PROC_ARGS

#define CUVIS_PROC_ARGS `struct cuvis_proc_args_t`

define CUVIS_PROC_CONT

#define CUVIS_PROC_CONT `CUVIS_HANDLE`

processing context handle

define CUVIS_REFERENCE_TYPE

#define CUVIS_REFERENCE_TYPE `enum cuvis_reference_type_t`

define CUVIS_SAVE_ARGS

#define CUVIS_SAVE_ARGS `struct cuvis_save_args_t`

define CUVIS_SENSOR_INFO

#define CUVIS_SENSOR_INFO `struct cuvis_sensor_info_t`

define CUVIS_SESSION_FILE

#define CUVIS_SESSION_FILE `CUVIS_HANDLE`

measurement session_info file handle

define CUVIS_SESSION_INFO

#define CUVIS_SESSION_INFO `struct cuvis_session_info_t`

define CUVIS_SESSION_ITEM_TYPE

#define CUVIS_SESSION_ITEM_TYPE `enum cuvis_session_item_type_t`

define CUVIS_SESSION_MERGE_MODE

#define CUVIS_SESSION_MERGE_MODE `enum cuvis_session_merge_mode_t`

define CUVIS_SIZE

#define CUVIS_SIZE `uint64_t`

define CUVIS_STATUS

#define CUVIS_STATUS `enum cuvis_status_t`

define CUVIS_STRING

#define CUVIS_STRING `CUVIS_CHAR [ CUVIS_MAXBUF ]`

cstring data type definition

define CUVIS_TIFF_COMPRESSION_MODE

#define CUVIS_TIFF_COMPRESSION_MODE `enum cuvis_tiff_compression_mode_t`

define CUVIS_TIFF_FORMAT

#define CUVIS_TIFF_FORMAT `enum cuvis_tiff_format_t`

define CUVIS_TIMESTAMP

#define CUVIS_TIMESTAMP `uint64_t`

time since epoch in millisecond steps

define CUVIS_VIEW

#define CUVIS_VIEW `CUVIS_HANDLE`

data viewer result handle (view)

define CUVIS_VIEWER

#define CUVIS_VIEWER `CUVIS_HANDLE`

data viewer handle

define CUVIS_VIEWER_SETTINGS

#define CUVIS_VIEWER_SETTINGS `struct cuvis_viewer_settings_t`

define CUVIS_VIEW_CATEGORY

#define CUVIS_VIEW_CATEGORY `enum cuvis_view_category_t`

define CUVIS_VIEW_DATA

#define CUVIS_VIEW_DATA `struct cuvis_view_data_t`

define CUVIS_WCHAR

#define CUVIS_WCHAR `wchar_t`

define CUVIS_WORKER

#define CUVIS_WORKER `CUVIS_HANDLE`

worker handle

define CUVIS_WORKER_SETTINGS

#define CUVIS_WORKER_SETTINGS `struct cuvis_worker_settings_t`

define CUVIS_WORKER_STATE

#define CUVIS_WORKER_STATE `struct cuvis_worker_state_t`

define IMBUFFER_GET

#define IMBUFFER_GET (
    ptr,
    x,
    y,
    chn,
    imbuf
) `ptr[((y) * (imbuf).width + (x)) * (imbuf).channels + (chn)]`

helper macro for obtaining a pixel position from an imbuffer pointer

define SDK_CAPI

#define SDK_CAPI

define SDK_CCALL

#define SDK_CCALL

define _CRT_SECURE_NO_WARNINGS

#define _CRT_SECURE_NO_WARNINGS

The documentation for this class was generated from the following file docs/_api_sources/cuvis.h