Group cuvis_mesu

Public Functions

Type	Name
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_clear_cube (CUVIS_PROC_CONT i_mesu) Clears the cube from a measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_clear_implicit_reference (CUVIS_PROC_CONT i_mesu, CUVIS_REFERENCE_TYPE i_type) Clears an implicit reference measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_copy_handle (CUVIS_MESU i_mesu, CUVIS_MESU * o_pMesu) Creates an additional measurement handle.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_deep_copy (CUVIS_MESU i_mesu, CUVIS_MESU * o_pMesu)
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_free (CUVIS_MESU * io_pMesu) Release a measurement handle.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_get_data_count (CUVIS_MESU i_mesu, CUVIS_INT * o_pCount) Retrieve the number of data elements.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_get_data_gps (CUVIS_MESU i_mesu, const CUVIS_CHAR * i_key, CUVIS_GPS * o_pGps) Get GPS data from measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_get_data_image (CUVIS_MESU i_mesu, const CUVIS_CHAR * i_key, CUVIS_IMBUFFER * o_pBuf) Get image data from measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_get_data_info (CUVIS_MESU i_mesu, CUVIS_CHAR * o_pKey, CUVIS_DATA_TYPE * o_pType, CUVIS_INT i_id) get meta-information of a data element
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_get_data_sensor_info (CUVIS_MESU i_mesu, const CUVIS_CHAR * i_key, CUVIS_SENSOR_INFO * o_pValue) Get image info data from measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_get_data_string (CUVIS_MESU i_mesu, const CUVIS_CHAR * i_key, CUVIS_SIZE i_outBufferlength, CUVIS_CHAR * o_pValue) Get string data from measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_get_data_string_length (CUVIS_MESU i_mesu, const CUVIS_CHAR * i_key, CUVIS_SIZE * o_pLength) Get the length of string data from measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_get_metadata (CUVIS_MESU i_mesu, CUVIS_MESU_METADATA * o_pMetaData) Obtain metadata from measurement.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_load (const CUVIS_CHAR * i_path, CUVIS_MESU * o_pMesu) Load a measurement from disk.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_save (CUVIS_MESU const i_mesu, const CUVIS_CHAR * i_path, CUVIS_SAVE_ARGS args) Save a measurement to disk.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_set_comment (CUVIS_MESU const i_mesu, const CUVIS_CHAR * i_comment) Set the comment of the measurement in memory.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_measurement_set_name (CUVIS_MESU const i_mesu, const CUVIS_CHAR * i_name) Set the name of the measurement in memory.

Detailed Description

How to interact with the Measurements taken by the SDK.

Public Functions Documentation

function cuvis_measurement_clear_cube

Clears the cube from a measurement.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_clear_cube (
    CUVIS_PROC_CONT i_mesu
)

Clears the proceessing result, i. e. the cube, from the measurement. This returns the measurement the state before applying the processing. This can be usefull for reduced data usage.

Parameters:

i_mesu The measurement

function cuvis_measurement_clear_implicit_reference

Clears an implicit reference measurement.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_clear_implicit_reference (
    CUVIS_PROC_CONT i_mesu,
    CUVIS_REFERENCE_TYPE i_type
)

Implict measurements are created, when a measurement is processed with a processing context, where explicit references are set. Then, these references are remebemred by the measurement. When changing the processing context, the references are implicitly available, still. Clearing them may be interesing if the references set are wrong/invalid or if disk space is a concearn.

Parameters:

i_mesu The measurement
i_type The type of the reference to be cleard

function cuvis_measurement_copy_handle

Creates an additional measurement handle.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_copy_handle (
    CUVIS_MESU i_mesu,
    CUVIS_MESU * o_pMesu
)

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

Parameters:

i_mesu The handle of the measurement to copy
o_pMesu The new handle of the measurement.

Returns:

status_ok if the measurement handle could be doubled

function cuvis_measurement_deep_copy

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_deep_copy (
    CUVIS_MESU i_mesu,
    CUVIS_MESU * o_pMesu
)

create a deep copy of a measurement

All operations on a measurement are performed on the same object. If different processing needs to be perfomed on a measurement It should be deep-copied. The copied meausrement's name will be changed to end with "_copy"

Parameters:

i_mesu The measurement copy source.
o_pMesu The copy will be linked to the handle given.

function cuvis_measurement_free

Release a measurement handle.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_free (
    CUVIS_MESU * io_pMesu
)

Release a measurement by it's handle. The handle will be overwritten to CUVIS_HANDLE_NULL This will not affect any measurements on disk.

Parameters:

io_pMesu The handle to the measurement to be deleted

Returns:

status_ok if the measurement was released.

function cuvis_measurement_get_data_count

Retrieve the number of data elements.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_data_count (
    CUVIS_MESU i_mesu,
    CUVIS_INT * o_pCount
)

Parameters:

i_mesu The measurement handle
o_pCount The number of data elements

Returns:

status_ok if the data element count could be retrieved

function cuvis_measurement_get_data_gps

Get GPS data from measurement.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_data_gps (
    CUVIS_MESU i_mesu,
    const CUVIS_CHAR * i_key,
    CUVIS_GPS * o_pGps
)

Return gps data from a measurement.

This function can only be called, if he data type is data_type_gps. This can be checked by the function cuvis_measurement_get_data_info.

see also: Reserved Keys

Parameters:

i_mesu The measurement handle
i_key the data frame identification key (see cuvis_measurement_get_data_info or Reserved Keys)
o_pGps The gps buffer to be filled.

Returns:

status_ok if the buffer could be filled with the gps data set.

function cuvis_measurement_get_data_image

Get image data from measurement.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_data_image (
    CUVIS_MESU i_mesu,
    const CUVIS_CHAR * i_key,
    CUVIS_IMBUFFER * o_pBuf
)

Return image data from a measurement. The image data is valid as long as the measurement handle is not released and the measurement is not re-processed.

This function can only be called, if he data type is data_type_image. This can be checked by the function cuvis_measurement_get_data_info.

see also: Reserved Keys

Parameters:

i_mesu The measurement handle
i_key The data frame identification key (see cuvis_measurement_get_data_info or Reserved Keys)
o_pBuf The image buffer to be filled

Returns:

status_ok if the buffer could be filled with the image element. status_not_available if the requested data was empty, or the key could not be found

function cuvis_measurement_get_data_info

get meta-information of a data element

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_data_info (
    CUVIS_MESU i_mesu,
    CUVIS_CHAR * o_pKey,
    CUVIS_DATA_TYPE * o_pType,
    CUVIS_INT i_id
)

Retrieve the meta-informations of a data element identified by it's positional number. A measurement has N data elements (obtain N with the functions cuvis_measurement_get_data_count) Thus, the meta-data of element 0 to N-1 can be obtained. The o_pType defined the data type: If it is data_type_image, retrieve it with cuvis_measurement_get_data_image.

If it is data type is data_type_gps, retrieve it with cuvis_measurement_get_data_gps. If it is data_type_string, retrieve with cuvis_measurement_get_data_string If it is data_type_unsupported, the data cannot be retrieved.

To retrieve the data, you will require the o_pKey wich you can obtain by using this function. The key is the name of the data channel.

Some keys are reserved, see Reserved Keys

Parameters:

i_mesu The measurement handle
o_pKey Output the data key
o_pType The data type
i_id The number of the data element

Returns:

status_ok if the data information could be obtained

function cuvis_measurement_get_data_sensor_info

Get image info data from measurement.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_data_sensor_info (
    CUVIS_MESU i_mesu,
    const CUVIS_CHAR * i_key,
    CUVIS_SENSOR_INFO * o_pValue
)

Return image data from a measurement. Tis

This function can only be called, if he data type is data_type_string. This can be checked by the function cuvis_measurement_get_data_info.

see also: Reserved Keys

Parameters:

i_mesu The measurement handle
i_key the data frame identification key (see cuvis_measurement_get_data_info or Reserved Keys)
o_pValue The string buffer to be filled. The provided array must have the length of CUVIS_MAXBUF

Returns:

status_ok if the buffer could be filled with the string.

function cuvis_measurement_get_data_string

Get string data from measurement.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_data_string (
    CUVIS_MESU i_mesu,
    const CUVIS_CHAR * i_key,
    CUVIS_SIZE i_outBufferlength,
    CUVIS_CHAR * o_pValue
)

Return string data from a measurement.

This function can only be called, if he data type is data_type_string. This can be checked by the function cuvis_measurement_get_data_info.

see also: Reserved Keys

Parameters:

i_mesu The measurement handle
i_key the data frame identification key (see cuvis_measurement_get_data_info or Reserved Keys)
i_outBufferlength the maximal possible length of the string that is going to be copied (see cuvis_measurement_get_data_info or Reserved Keys)
o_pValue The string buffer to be filled. The provided array must have the length of i_length

Returns:

status_ok if the buffer could be filled with the string.

function cuvis_measurement_get_data_string_length

Get the length of string data from measurement.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_data_string_length (
    CUVIS_MESU i_mesu,
    const CUVIS_CHAR * i_key,
    CUVIS_SIZE * o_pLength
)

Return the length of a string data from a measurement.

This function can only be called, if he data type is data_type_string. This can be checked by the function cuvis_measurement_get_data_info.

see also: Reserved Keys

Parameters:

i_mesu The measurement handle
i_key the data frame identification key (see cuvis_measurement_get_data_info or Reserved Keys)
o_pLength The length of the string data

Returns:

status_ok if the length could be returned

function cuvis_measurement_get_metadata

Obtain metadata from measurement.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_get_metadata (
    CUVIS_MESU i_mesu,
    CUVIS_MESU_METADATA * o_pMetaData
)

The meta-data from the measurement contains information about the measurement when it was recorded: when and how. Meta-Data do not contain the actual recorded data.

Parameters:

i_mesu The measurement's handle
o_pMetaData The meta structure to be filled

Returns:

status_ok, if the meta-data could be loaded without errors

function cuvis_measurement_load

Load a measurement from disk.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_load (
    const CUVIS_CHAR * i_path,
    CUVIS_MESU * o_pMesu
)

The measurement is a cu3 file - and if fragmented some additional tiff files with a postfix, e.g. _cube.tiff To load the file, all fragmented parts must be in the same directory. Fragmented files must not be renamed.

Parameters:

i_path the file path of the measurement
o_pMesu the handle of the measurement.

Returns:

status_ok, if the measurement could be loaded.

function cuvis_measurement_save

Save a measurement to disk.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_save (
    CUVIS_MESU const i_mesu,
    const CUVIS_CHAR * i_path,
    CUVIS_SAVE_ARGS args
)

Saves a single measurement to the disk in cu3 format. The file name is given by the measurement's name (see cuvis_measurement_set_name)

Parameters:

i_path The file directory
i_mesu The handle of the measurement to be saved
args The saving options

Returns:

status_ok, if the measurement was save successfully.

function cuvis_measurement_set_comment

Set the comment of the measurement in memory.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_set_comment (
    CUVIS_MESU const i_mesu,
    const CUVIS_CHAR * i_comment
)

Parameters:

i_mesu The measurements to be changed
i_comment The new measurement's comment

Returns:

status_ok, if the measurement's name was set successfully.

function cuvis_measurement_set_name

Set the name of the measurement in memory.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_measurement_set_name (
    CUVIS_MESU const i_mesu,
    const CUVIS_CHAR * i_name
)

By default, a newly aquired measurement has the name <SESSIONNAME>_<session_no>_<sequence_no> (see CUVIS_SESSION_INFO). This will also be the name of the file while saving it. This can be changed by this function.

Parameters:

i_mesu The measurements to be changed
i_name The new measurement's name

Returns:

status_ok, if the measurement's name was set successfully.