Group cuvis_exporter

Classes

Type	Name
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_pansharpening_settings_t general export settings
struct	cuvis_save_args_t options for saving as cu3/cu3s files

Public Functions

Type	Name
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_exporter_apply (CUVIS_EXPORTER i_exporter, CUVIS_MESU i_mesu) Export a measurement with an exporter.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_exporter_create_cube (CUVIS_EXPORTER * o_pExporter, CUVIS_EXPORT_GENERAL_SETTINGS generalSettings, CUVIS_EXPORT_CUBE_SETTINGS formatSettings) Create a cube exporter.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_exporter_create_envi (CUVIS_EXPORTER * o_pExporter, CUVIS_EXPORT_GENERAL_SETTINGS generalSettings) Create a ENVI exporter.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_exporter_create_tiff (CUVIS_EXPORTER * o_pExporter, CUVIS_EXPORT_GENERAL_SETTINGS generalSettings, CUVIS_EXPORT_TIFF_SETTINGS formatSettings) Create a tiff exporter.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_exporter_create_view (CUVIS_EXPORTER * o_pExporter, CUVIS_EXPORT_GENERAL_SETTINGS generalSettings, CUVIS_EXPORT_VIEW_SETTINGS formatSettings) Create a VIEW exporter.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_exporter_flush (CUVIS_EXPORTER i_exporter) Flush an exporter.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_exporter_free (CUVIS_EXPORTER * io_pExporter) Release an exporter.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_exporter_get_queue_used (CUVIS_EXPORTER i_exporter, CUVIS_INT * o_pQueueUsed)

Detailed Description

How to export Measurement captured with the SDK.

A handle for each of the exporter can be obtainend by calling either cuvis_exporter_create_cube, cuvis_exporter_create_envi, cuvis_exporter_create_tiff or cuvis_exporter_create_view. Each of the so created exporter can then export a Measurement to the respective format by calling cuvis_exporter_apply. Each exporter takes options in form of cuvis_export_general_settings_t and one of the following format specific structs cuvis_save_args_t, cuvis_export_view_settings_t, cuvis_export_tiff_settings_t

See the respective struct documentations for more information on the individual options

Public Functions Documentation

function cuvis_exporter_apply

Export a measurement with an exporter.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_exporter_apply (
    CUVIS_EXPORTER i_exporter,
    CUVIS_MESU i_mesu
)

Parameters:

i_exporter The exporter
i_mesu the measurement

Returns:

status_ok if the measurement was exported successfully. status_not_stored if the measurement could not be stored.

function cuvis_exporter_create_cube

Create a cube exporter.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_exporter_create_cube (
    CUVIS_EXPORTER * o_pExporter,
    CUVIS_EXPORT_GENERAL_SETTINGS generalSettings,
    CUVIS_EXPORT_CUBE_SETTINGS formatSettings
)

Parameters:

o_pExporter The handle of the exporter
generalSettings General export settings
formatSettings Additional Cube export settings

Returns:

status_ok if the exporter was created successfully

function cuvis_exporter_create_envi

Create a ENVI exporter.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_exporter_create_envi (
    CUVIS_EXPORTER * o_pExporter,
    CUVIS_EXPORT_GENERAL_SETTINGS generalSettings
)

Parameters:

o_pExporter The handle of the exporter
generalSettings General export settings

Returns:

status_ok if the exporter was created successfully

function cuvis_exporter_create_tiff

Create a tiff exporter.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_exporter_create_tiff (
    CUVIS_EXPORTER * o_pExporter,
    CUVIS_EXPORT_GENERAL_SETTINGS generalSettings,
    CUVIS_EXPORT_TIFF_SETTINGS formatSettings
)

Parameters:

o_pExporter The handle of the exporter
generalSettings General export settings
formatSettings Additional TIF export settings

Returns:

status_ok if the exporter was created successfully

function cuvis_exporter_create_view

Create a VIEW exporter.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_exporter_create_view (
    CUVIS_EXPORTER * o_pExporter,
    CUVIS_EXPORT_GENERAL_SETTINGS generalSettings,
    CUVIS_EXPORT_VIEW_SETTINGS formatSettings
)

Not to be confused with the VIEWER. The view exporter saves views to disk.

Parameters:

o_pExporter The handle of the exporter
generalSettings General export settings
formatSettings Additional view export settings

Returns:

status_ok if the exporter was created successfully

function cuvis_exporter_flush

Flush an exporter.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_exporter_flush (
    CUVIS_EXPORTER i_exporter
)

Parameters:

i_exporter The exporter to flush

Returns:

status_ok if the exporter was flushed successfully.

function cuvis_exporter_free

Release an exporter.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_exporter_free (
    CUVIS_EXPORTER * io_pExporter
)

Parameters:

io_pExporter Exporter to be released. If successfully, handle will be invalidated

Returns:

status_ok if the exporter was cleared.

function cuvis_exporter_get_queue_used

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_exporter_get_queue_used (
    CUVIS_EXPORTER i_exporter,
    CUVIS_INT * o_pQueueUsed
)