libirimager
IR Imager Direct-SDK
direct_binding.h File Reference

Provides Easy API C-Library Interface. More...

#include "irdirectsdk_defs.h"
#include "EvoIRFrameMetadata.h"
Include dependency graph for direct_binding.h:

Go to the source code of this file.

Functions

__IRDIRECTSDK_API__ int evo_irimager_usb_init (const char *xml_config, const char *formats_def, const char *log_file)
 Initializes an IRImager instance connected to this computer via USB. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_usb_init (unsigned int *outCamId, const char *xml_config, const char *formats_def, const char *log_file)
 Initializes an IRImager instance connected to this computer via USB for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_tcp_init (const char *ip, int port)
 Initializes the TCP connection to the daemon process (non-blocking) More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_tcp_init (unsigned int *outCamId, const char *ip, int port)
 Initializes the TCP connection to the daemon process (non-blocking) for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_terminate ()
 Disconnects the camera, either connected via USB or TCP. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_terminate (const unsigned int camId)
 Disconnects the camera, either connected via USB or TCP for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_serial (unsigned long *serial)
 Get the serial number of the connected camera. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_serial (const unsigned int camId, unsigned long *serial)
 Get the serial number of the connected camera for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_thermal_image_size (int *w, int *h)
 Accessor to image width and height. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_image_size (const unsigned int camId, int *w, int *h)
 Accessor to image width and height for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_palette_image_size (int *w, int *h)
 Accessor to width and height of false color coded palette image. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_palette_image_size (const unsigned int camId, int *w, int *h)
 Accessor to width and height of false color coded palette image for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_thermal_image (int *w, int *h, unsigned short *data)
 Accessor to thermal image by reference Conversion to temperature values are to be performed as follows: t = ((double)data[x] - 1000.0) / 10.0;. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_image (const unsigned int camId, int *w, int *h, unsigned short *data)
 Accessor to thermal image by reference for multiple cameras Conversion to temperature values are to be performed as follows: t = ((double)data[x] - 1000.0) / 10.0;. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_thermal_image_metadata (int *w, int *h, unsigned short *data, EvoIRFrameMetadata *metadata)
 Accessor to thermal image and frame metadata by reference Conversion to temperature values are to be performed as follows: t = ((double)data[x] - 1000.0) / 10.0;. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_image_metadata (const unsigned int camId, int *w, int *h, unsigned short *data, EvoIRFrameMetadata *metadata)
 Accessor to thermal image and frame metadata by reference for multiple cameras Conversion to temperature values are to be performed as follows: t = ((double)data[x] - 1000.0) / 10.0;. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_palette_image (int *w, int *h, unsigned char *data)
 Accessor to an RGB palette image by reference data format: unsigned char array (size 3 * w * h) r,g,b. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_palette_image (const unsigned int camId, int *w, int *h, unsigned char *data)
 Accessor to an RGB palette image by reference for multiple cameras data format: unsigned char array (size 3 * w * h) r,g,b. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_palette_image_metadata (int *w, int *h, unsigned char *data, EvoIRFrameMetadata *metadata)
 Accessor to an RGB palette image and frame metadata by reference data format: unsigned char array (size 3 * w * h) r,g,b. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_palette_image_metadata (const unsigned int camId, int *w, int *h, unsigned char *data, EvoIRFrameMetadata *metadata)
 Accessor to an RGB palette image and frame metadata by reference for multiple cameras data format: unsigned char array (size 3 * w * h) r,g,b. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_thermal_palette_image (int w_t, int h_t, unsigned short *data_t, int w_p, int h_p, unsigned char *data_p)
 Accessor to an RGB palette image and a thermal image by reference. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_palette_image (const unsigned int camId, int w_t, int h_t, unsigned short *data_t, int w_p, int h_p, unsigned char *data_p)
 Accessor to an RGB palette image and a thermal image by reference for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_thermal_palette_image_metadata (int w_t, int h_t, unsigned short *data_t, int w_p, int h_p, unsigned char *data_p, EvoIRFrameMetadata *metadata)
 Accessor to an RGB palette image, thermal imagea and frame metadat by reference. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_palette_image_metadata (const unsigned int camId, int w_t, int h_t, unsigned short *data_t, int w_p, int h_p, unsigned char *data_p, EvoIRFrameMetadata *metadata)
 Accessor to an RGB palette image, thermal image and frame metadata by reference for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_set_palette (int paletteId)
 sets palette format. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_set_palette (const unsigned int camId, int paletteId)
 sets palette format for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_set_palette_scale (int scale)
 sets palette scaling method Defined in IRImager Direct-SDK, see enum EnumOptrisPaletteScalingMethod{eManual = 1, eMinMax = 2, eSigma1 = 3, eSigma3 = 4 }; More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_set_palette_scale (const unsigned int camId, int scale)
 sets palette scaling method for multiple cameras Defined in IRImager Direct-SDK, see enum EnumOptrisPaletteScalingMethod{eManual = 1, eMinMax = 2, eSigma1 = 3, eSigma3 = 4 }; More...
 
__IRDIRECTSDK_API__ int evo_irimager_set_palette_manual_temp_range (float min, float max)
 Only available in eManual palette scale mode. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_set_palette_manual_temp_range (const unsigned int camId, float min, float max)
 Only available in eManual palette scale mode. More...
 
__IRDIRECTSDK_API__ int evo_irimager_set_shutter_mode (int mode)
 sets shutter flag control mode More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_set_shutter_mode (const unsigned int camId, int mode)
 sets shutter flag control mode for multiple cameras More...
 
__IRDIRECTSDK_API__ int evo_irimager_trigger_shutter_flag ()
 forces a shutter flag cycle More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_trigger_shutter_flag (const unsigned int camId)
 forces a shutter flag cycle for multiple cameras More...
 
__IRDIRECTSDK_API__ int evo_irimager_set_temperature_range (int t_min, int t_max)
 sets the minimum and maximum remperature range to the camera. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_set_temperature_range (const unsigned int camId, int t_min, int t_max)
 sets the minimum and maximum remperature range to the camera. More...
 
__IRDIRECTSDK_API__ int evo_irimager_set_radiation_parameters (float emissivity, float transmissivity, float tAmbient)
 sets radiation properties, i.e. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_set_radiation_parameters (const unsigned int camId, float emissivity, float transmissivity, float tAmbient)
 sets radiation properties, i.e. More...
 
__IRDIRECTSDK_API__ int evo_irimager_set_focusmotor_pos (float pos)
 Set the position of the focusmotor. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_set_focusmotor_pos (const unsigned int camId, float pos)
 Set the position of the focusmotor for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_get_focusmotor_pos (float *posOut)
 Get the position of the focusmotor. More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_get_focusmotor_pos (const unsigned int camId, float *posOut)
 Get the position of the focusmotor for multiple cameras. More...
 
__IRDIRECTSDK_API__ int evo_irimager_set_pif_framesync_output (const unsigned int aoChannelId, unsigned int analogOutputMode, float analogValue)
 sets the framesync output More...
 
__IRDIRECTSDK_API__ int evo_irimager_multi_set_pif_framesync_output (const unsigned int camId, const unsigned int aoChannelId, unsigned int analogOutputMode, float analogValue)
 sets the framesync output for multiple cameras More...
 
__IRDIRECTSDK_API__ int evo_irimager_daemon_launch ()
 Launch TCP daemon. More...
 
__IRDIRECTSDK_API__ int evo_irimager_daemon_is_running ()
 Check whether daemon is already running. More...
 
__IRDIRECTSDK_API__ int evo_irimager_daemon_kill ()
 Kill TCP daemon. More...
 

Detailed Description

Provides Easy API C-Library Interface.

This header defines the function of the Easy API, which can be also used from other programming languages supporting C-Library calls like LabView, Matlab, Python etc.

Function Documentation

◆ evo_irimager_daemon_is_running()

__IRDIRECTSDK_API__ int evo_irimager_daemon_is_running ( )

Check whether daemon is already running.

Returns
error code: 0 daemon is already active, -1 daemon is not started yet
Examples:
examples/linux/directbinding/direct_binding_tcp_show.cpp.

◆ evo_irimager_daemon_kill()

__IRDIRECTSDK_API__ int evo_irimager_daemon_kill ( )

Kill TCP daemon.

Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)
Examples:
examples/linux/directbinding/direct_binding_tcp_show.cpp.

◆ evo_irimager_daemon_launch()

__IRDIRECTSDK_API__ int evo_irimager_daemon_launch ( )

Launch TCP daemon.

Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)
Examples:
examples/linux/directbinding/direct_binding_tcp_show.cpp.

◆ evo_irimager_get_focusmotor_pos()

__IRDIRECTSDK_API__ int evo_irimager_get_focusmotor_pos ( float *  posOut)

Get the position of the focusmotor.

Parameters
[out]posOutData pointer to float for current fucos motor position in % (< 0 if no focusmotor available)
Returns
error code: 0 on success, -1 on error

◆ evo_irimager_get_palette_image()

__IRDIRECTSDK_API__ int evo_irimager_get_palette_image ( int *  w,
int *  h,
unsigned char *  data 
)

Accessor to an RGB palette image by reference data format: unsigned char array (size 3 * w * h) r,g,b.

Parameters
[in]wimage width
[in]himage height
[out]datapointer to unsigned char array allocate by the user (size of 3 * w * h)
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)
Examples:
/platform/windows/examples/directbinding/irDirectBindingTCPShow.cpp, /platform/windows/examples/directbinding/irDirectBindingUSBShow.cpp, and examples/linux/directbinding/direct_binding_tcp_show.cpp.

◆ evo_irimager_get_palette_image_metadata()

__IRDIRECTSDK_API__ int evo_irimager_get_palette_image_metadata ( int *  w,
int *  h,
unsigned char *  data,
EvoIRFrameMetadata metadata 
)

Accessor to an RGB palette image and frame metadata by reference data format: unsigned char array (size 3 * w * h) r,g,b.

Parameters
[in]wimage width
[in]himage height
[out]datapointer to unsigned char array allocate by the user (size of 3 * w * h)
[out]metadatapointer to EvoIRFrameMetadata allocate by the user
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_get_palette_image_size()

__IRDIRECTSDK_API__ int evo_irimager_get_palette_image_size ( int *  w,
int *  h 
)

◆ evo_irimager_get_serial()

__IRDIRECTSDK_API__ int evo_irimager_get_serial ( unsigned long *  serial)

Get the serial number of the connected camera.

Parameters
[out]serialnumber of camera
Returns
0 on success, -1 on error

◆ evo_irimager_get_thermal_image()

__IRDIRECTSDK_API__ int evo_irimager_get_thermal_image ( int *  w,
int *  h,
unsigned short *  data 
)

Accessor to thermal image by reference Conversion to temperature values are to be performed as follows: t = ((double)data[x] - 1000.0) / 10.0;.

Parameters
[in]wimage width
[in]himage height
[out]datapointer to unsigned short array allocate by the user (size of w * h)
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_get_thermal_image_metadata()

__IRDIRECTSDK_API__ int evo_irimager_get_thermal_image_metadata ( int *  w,
int *  h,
unsigned short *  data,
EvoIRFrameMetadata metadata 
)

Accessor to thermal image and frame metadata by reference Conversion to temperature values are to be performed as follows: t = ((double)data[x] - 1000.0) / 10.0;.

Parameters
[in]wimage width
[in]himage height
[out]datapointer to unsigned short array allocate by the user (size of w * h)
[out]metadatapointer to EvoIRFrameMetadata allocate by the user
Returns
error code: 0 on success, -1 on error

◆ evo_irimager_get_thermal_image_size()

__IRDIRECTSDK_API__ int evo_irimager_get_thermal_image_size ( int *  w,
int *  h 
)

Accessor to image width and height.

Parameters
[out]wwidth
[out]hheight
Returns
0 on success, -1 on error
Examples:
examples/linux/directbinding/direct_binding_usb_show.cpp.

◆ evo_irimager_get_thermal_palette_image()

__IRDIRECTSDK_API__ int evo_irimager_get_thermal_palette_image ( int  w_t,
int  h_t,
unsigned short *  data_t,
int  w_p,
int  h_p,
unsigned char *  data_p 
)

Accessor to an RGB palette image and a thermal image by reference.

Parameters
[in]w_twidth of thermal image
[in]h_theight of thermal image
[out]data_tdata pointer to unsigned short array allocate by the user (size of w * h)
[in]w_pwidth of palette image (can differ from thermal image width due to striding)
[in]h_pheight of palette image (can differ from thermal image height due to striding)
[out]data_pdata pointer to unsigned char array allocate by the user (size of 3 * w * h)
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)
Examples:
examples/linux/directbinding/direct_binding_usb_show.cpp.

◆ evo_irimager_get_thermal_palette_image_metadata()

__IRDIRECTSDK_API__ int evo_irimager_get_thermal_palette_image_metadata ( int  w_t,
int  h_t,
unsigned short *  data_t,
int  w_p,
int  h_p,
unsigned char *  data_p,
EvoIRFrameMetadata metadata 
)

Accessor to an RGB palette image, thermal imagea and frame metadat by reference.

Parameters
[in]w_twidth of thermal image
[in]h_theight of thermal image
[out]data_tdata pointer to unsigned short array allocate by the user (size of w * h)
[in]w_pwidth of palette image (can differ from thermal image width due to striding)
[in]h_pheight of palette image (can differ from thermal image height due to striding)
[out]data_pdata pointer to unsigned char array allocate by the user (size of 3 * w * h)
[out]metadatapointer to EvoIRFrameMetadata allocate by the user
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_get_focusmotor_pos()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_focusmotor_pos ( const unsigned int  camId,
float *  posOut 
)

Get the position of the focusmotor for multiple cameras.

Parameters
[in]camIdCamera instance id from init to apply this function
[out]posOutData pointer to float for current fucos motor position in % (< 0 if no focusmotor available)
Returns
error code: 0 on success, -1 on error

◆ evo_irimager_multi_get_palette_image()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_palette_image ( const unsigned int  camId,
int *  w,
int *  h,
unsigned char *  data 
)

Accessor to an RGB palette image by reference for multiple cameras data format: unsigned char array (size 3 * w * h) r,g,b.

Parameters
[in]camIdCamera instance id from init to apply this function
[in]wimage width
[in]himage height
[out]datapointer to unsigned char array allocate by the user (size of 3 * w * h)
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_get_palette_image_metadata()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_palette_image_metadata ( const unsigned int  camId,
int *  w,
int *  h,
unsigned char *  data,
EvoIRFrameMetadata metadata 
)

Accessor to an RGB palette image and frame metadata by reference for multiple cameras data format: unsigned char array (size 3 * w * h) r,g,b.

Parameters
[in]camIdCamera instance id from init to apply this function
[in]wimage width
[in]himage height
[out]datapointer to unsigned char array allocate by the user (size of 3 * w * h)
[out]metadatapointer to EvoIRFrameMetadata allocate by the user
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_get_palette_image_size()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_palette_image_size ( const unsigned int  camId,
int *  w,
int *  h 
)

Accessor to width and height of false color coded palette image for multiple cameras.

Parameters
[in]camIdCamera instance id from init to apply this function
[out]wwidth
[out]hheight
Returns
0 on success, -1 on error

◆ evo_irimager_multi_get_serial()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_serial ( const unsigned int  camId,
unsigned long *  serial 
)

Get the serial number of the connected camera for multiple cameras.

Parameters
[in]camIdCamera instance id from init to apply this function
[out]serialnumber of camera
Returns
0 on success, -1 on error

◆ evo_irimager_multi_get_thermal_image()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_image ( const unsigned int  camId,
int *  w,
int *  h,
unsigned short *  data 
)

Accessor to thermal image by reference for multiple cameras Conversion to temperature values are to be performed as follows: t = ((double)data[x] - 1000.0) / 10.0;.

Parameters
[in]camIdCamera instance id from init to apply this function
[in]wimage width
[in]himage height
[out]datapointer to unsigned short array allocate by the user (size of w * h)
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_get_thermal_image_metadata()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_image_metadata ( const unsigned int  camId,
int *  w,
int *  h,
unsigned short *  data,
EvoIRFrameMetadata metadata 
)

Accessor to thermal image and frame metadata by reference for multiple cameras Conversion to temperature values are to be performed as follows: t = ((double)data[x] - 1000.0) / 10.0;.

Parameters
[in]camIdCamera instance id from init to apply this function
[in]wimage width
[in]himage height
[out]datapointer to unsigned short array allocate by the user (size of w * h)
[out]metadatapointer to EvoIRFrameMetadata allocate by the user
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_get_thermal_image_size()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_image_size ( const unsigned int  camId,
int *  w,
int *  h 
)

Accessor to image width and height for multiple cameras.

Parameters
[in]camIdCamera instance id from init to apply this function
[out]wwidth
[out]hheight
Returns
0 on success, -1 on error

◆ evo_irimager_multi_get_thermal_palette_image()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_palette_image ( const unsigned int  camId,
int  w_t,
int  h_t,
unsigned short *  data_t,
int  w_p,
int  h_p,
unsigned char *  data_p 
)

Accessor to an RGB palette image and a thermal image by reference for multiple cameras.

Parameters
[in]camIdCamera instance id from init to apply this function
[in]w_twidth of thermal image
[in]h_theight of thermal image
[out]data_tdata pointer to unsigned short array allocate by the user (size of w * h)
[in]w_pwidth of palette image (can differ from thermal image width due to striding)
[in]h_pheight of palette image (can differ from thermal image height due to striding)
[out]data_pdata pointer to unsigned char array allocate by the user (size of 3 * w * h)
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_get_thermal_palette_image_metadata()

__IRDIRECTSDK_API__ int evo_irimager_multi_get_thermal_palette_image_metadata ( const unsigned int  camId,
int  w_t,
int  h_t,
unsigned short *  data_t,
int  w_p,
int  h_p,
unsigned char *  data_p,
EvoIRFrameMetadata metadata 
)

Accessor to an RGB palette image, thermal image and frame metadata by reference for multiple cameras.

Parameters
[in]camIdCamera instance id from init to apply this function
[in]w_twidth of thermal image
[in]h_theight of thermal image
[out]data_tdata pointer to unsigned short array allocate by the user (size of w * h)
[in]w_pwidth of palette image (can differ from thermal image width due to striding)
[in]h_pheight of palette image (can differ from thermal image height due to striding)
[out]data_pdata pointer to unsigned char array allocate by the user (size of 3 * w * h)
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_set_focusmotor_pos()

__IRDIRECTSDK_API__ int evo_irimager_multi_set_focusmotor_pos ( const unsigned int  camId,
float  pos 
)

Set the position of the focusmotor for multiple cameras.

Parameters
[in]camIdCamera instance id from init to apply this function
[in]posfucos motor position in %
Returns
error code: 0 on success, -1 on error or if no focusmotor is available

◆ evo_irimager_multi_set_palette()

__IRDIRECTSDK_API__ int evo_irimager_multi_set_palette ( const unsigned int  camId,
int  paletteId 
)

sets palette format for multiple cameras.

Defined in IRImager Direct-SDK, see enum EnumOptrisColoringPalette{eAlarmBlue = 1, eAlarmBlueHi = 2, eGrayBW = 3, eGrayWB = 4, eAlarmGreen = 5, eIron = 6, eIronHi = 7, eMedical = 8, eRainbow = 9, eRainbowHi = 10, eAlarmRed = 11 };

Parameters
[in]camIdCamera instance id from init to apply this function
paletteIdpalette id
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_set_palette_manual_temp_range()

__IRDIRECTSDK_API__ int evo_irimager_multi_set_palette_manual_temp_range ( const unsigned int  camId,
float  min,
float  max 
)

Only available in eManual palette scale mode.

Sets palette manual scaling temperature range for multiple cameras.

Parameters
[in]camIdCamera instance id from init to apply this function
minMinimum temperature
maxMaximum temperature
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_set_palette_scale()

__IRDIRECTSDK_API__ int evo_irimager_multi_set_palette_scale ( const unsigned int  camId,
int  scale 
)

sets palette scaling method for multiple cameras Defined in IRImager Direct-SDK, see enum EnumOptrisPaletteScalingMethod{eManual = 1, eMinMax = 2, eSigma1 = 3, eSigma3 = 4 };

Parameters
[in]camIdCamera instance id from init to apply this function
scalescaling method id
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_set_pif_framesync_output()

__IRDIRECTSDK_API__ int evo_irimager_multi_set_pif_framesync_output ( const unsigned int  camId,
const unsigned int  aoChannelId,
unsigned int  analogOutputMode,
float  analogValue 
)

sets the framesync output for multiple cameras

Parameters
[in]camIdCamera instance id from init to apply this function
[in]aoChannelIdAnalog Output Channel for framesync starting with 0
[in]analogOutputModeDetermines the output range and voltage or current mode (depends on used PIF-Device) enum IRChannelAnalogOutputMode { Range_0V_10V = 0, ///< Set output range to 0V..10V Range_0mA_20mA = 1, ///< Set output range to 0mA..20mA Range_4mA_20mA = 2, ///< Set output range to 4mA..20mA };
[in]analogValueAnalog Output Voltage/Milliampere on Frame for syncing

◆ evo_irimager_multi_set_radiation_parameters()

__IRDIRECTSDK_API__ int evo_irimager_multi_set_radiation_parameters ( const unsigned int  camId,
float  emissivity,
float  transmissivity,
float  tAmbient 
)

sets radiation properties, i.e.

emissivity and transmissivity parameters (not implemented for TCP connection, usb mode only) for multiple cameras

Parameters
[in]camIdCamera instance id from init to apply this function
[in]emissivityemissivity of observed object [0;1]
[in]transmissivitytransmissivity of observed object [0;1]
[in]tAmbientambient temperature, setting invalid values (below -273,15 degrees) forces the library to take its own measurement values.
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_set_shutter_mode()

__IRDIRECTSDK_API__ int evo_irimager_multi_set_shutter_mode ( const unsigned int  camId,
int  mode 
)

sets shutter flag control mode for multiple cameras

Parameters
[in]camIdCamera instance id from init to apply this function
[in]mode0 means manual control, 1 means automode
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_set_temperature_range()

__IRDIRECTSDK_API__ int evo_irimager_multi_set_temperature_range ( const unsigned int  camId,
int  t_min,
int  t_max 
)

sets the minimum and maximum remperature range to the camera.

Only values which are defined in teh optris cali files are supported. (also configurable in xml-config) for multiple cameras

Parameters
[in]camIdCamera instance id from init to apply this function
[in]t_minMinimal temperature (has to be defined in the optris cali files)
[in]t_minMaximal temperature (has to be defined in the optris cali files)
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_tcp_init()

__IRDIRECTSDK_API__ int evo_irimager_multi_tcp_init ( unsigned int *  outCamId,
const char *  ip,
int  port 
)

Initializes the TCP connection to the daemon process (non-blocking) for multiple cameras.

Parameters
[out]camerainstance id for reference
[in]IPaddress of the machine where the daemon process is running ("localhost" can be resolved)
portPort of daemon, default 1337
Returns
error code: 0 on success, -1 on host not found (wrong IP, daemon not running), -2 on fatal error

◆ evo_irimager_multi_terminate()

__IRDIRECTSDK_API__ int evo_irimager_multi_terminate ( const unsigned int  camId)

Disconnects the camera, either connected via USB or TCP for multiple cameras.

Parameters
[in]camIdCamera instance id from init to apply this function
Returns
0 on success, -1 on error

◆ evo_irimager_multi_trigger_shutter_flag()

__IRDIRECTSDK_API__ int evo_irimager_multi_trigger_shutter_flag ( const unsigned int  camId)

forces a shutter flag cycle for multiple cameras

Parameters
[in]camIdCamera instance id from init to apply this function
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_multi_usb_init()

__IRDIRECTSDK_API__ int evo_irimager_multi_usb_init ( unsigned int *  outCamId,
const char *  xml_config,
const char *  formats_def,
const char *  log_file 
)

Initializes an IRImager instance connected to this computer via USB for multiple cameras.

Parameters
[out]camerainstance id for reference
[in]xml_configpath to xml config
[in]formats_defpath to Formats.def file. Set zero for standard value.
[in]log_filepath to log file. Set zero for standard value.
Returns
0 on success, -1 on error

◆ evo_irimager_set_focusmotor_pos()

__IRDIRECTSDK_API__ int evo_irimager_set_focusmotor_pos ( float  pos)

Set the position of the focusmotor.

Parameters
[in]posfucos motor position in %
Returns
error code: 0 on success, -1 on error or if no focusmotor is available

◆ evo_irimager_set_palette()

__IRDIRECTSDK_API__ int evo_irimager_set_palette ( int  paletteId)

sets palette format.

Defined in IRImager Direct-SDK, see enum EnumOptrisColoringPalette{eAlarmBlue = 1, eAlarmBlueHi = 2, eGrayBW = 3, eGrayWB = 4, eAlarmGreen = 5, eIron = 6, eIronHi = 7, eMedical = 8, eRainbow = 9, eRainbowHi = 10, eAlarmRed = 11 };

Parameters
idpalette id
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_set_palette_manual_temp_range()

__IRDIRECTSDK_API__ int evo_irimager_set_palette_manual_temp_range ( float  min,
float  max 
)

Only available in eManual palette scale mode.

Sets palette manual scaling temperature range.

Parameters
minMinimum temperature
maxMaximum temperature
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_set_palette_scale()

__IRDIRECTSDK_API__ int evo_irimager_set_palette_scale ( int  scale)

sets palette scaling method Defined in IRImager Direct-SDK, see enum EnumOptrisPaletteScalingMethod{eManual = 1, eMinMax = 2, eSigma1 = 3, eSigma3 = 4 };

Parameters
scalescaling method id
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_set_pif_framesync_output()

__IRDIRECTSDK_API__ int evo_irimager_set_pif_framesync_output ( const unsigned int  aoChannelId,
unsigned int  analogOutputMode,
float  analogValue 
)

sets the framesync output

Parameters
[in]aoChannelIdAnalog Output Channel for framesync starting with 0
[in]analogOutputModeDetermines the output range and voltage or current mode (depends on used PIF-Device) enum IRChannelAnalogOutputMode { Range_0V_10V = 0, ///< Set output range to 0V..10V Range_0mA_20mA = 1, ///< Set output range to 0mA..20mA Range_4mA_20mA = 2, ///< Set output range to 4mA..20mA };
[in]analogValueAnalog Output Voltage/Milliampere on Frame for syncing

◆ evo_irimager_set_radiation_parameters()

__IRDIRECTSDK_API__ int evo_irimager_set_radiation_parameters ( float  emissivity,
float  transmissivity,
float  tAmbient 
)

sets radiation properties, i.e.

emissivity and transmissivity parameters (not implemented for TCP connection, usb mode only)

Parameters
[in]emissivityemissivity of observed object [0;1]
[in]transmissivitytransmissivity of observed object [0;1]
[in]tAmbientambient temperature, setting invalid values (below -273,15 degrees) forces the library to take its own measurement values.
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_set_shutter_mode()

__IRDIRECTSDK_API__ int evo_irimager_set_shutter_mode ( int  mode)

sets shutter flag control mode

Parameters
mode0 means manual control, 1 means automode
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_set_temperature_range()

__IRDIRECTSDK_API__ int evo_irimager_set_temperature_range ( int  t_min,
int  t_max 
)

sets the minimum and maximum remperature range to the camera.

Only values which are defined in teh optris cali files are supported. (also configurable in xml-config)

Parameters
[in]t_minMinimal temperature (has to be defined in the optris cali files)
[in]t_minMaximal temperature (has to be defined in the optris cali files)
Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_tcp_init()

__IRDIRECTSDK_API__ int evo_irimager_tcp_init ( const char *  ip,
int  port 
)

Initializes the TCP connection to the daemon process (non-blocking)

Parameters
[in]IPaddress of the machine where the daemon process is running ("localhost" can be resolved)
portPort of daemon, default 1337
Returns
error code: 0 on success, -1 on host not found (wrong IP, daemon not running), -2 on fatal error
Examples:
/platform/windows/examples/directbinding/irDirectBindingTCPShow.cpp, and examples/linux/directbinding/direct_binding_tcp_show.cpp.

◆ evo_irimager_terminate()

__IRDIRECTSDK_API__ int evo_irimager_terminate ( )

◆ evo_irimager_trigger_shutter_flag()

__IRDIRECTSDK_API__ int evo_irimager_trigger_shutter_flag ( )

forces a shutter flag cycle

Returns
error code: 0 on success, -1 on error, -2 on fatal error (only TCP connection)

◆ evo_irimager_usb_init()

__IRDIRECTSDK_API__ int evo_irimager_usb_init ( const char *  xml_config,
const char *  formats_def,
const char *  log_file 
)

Initializes an IRImager instance connected to this computer via USB.

Parameters
[in]xml_configpath to xml config
[in]formats_defpath to Formats.def file. Set zero for standard value.
[in]log_filepath to log file. Set zero for standard value.
Returns
0 on success, -1 on error
Examples:
/platform/windows/examples/directbinding/irDirectBindingUSBShow.cpp, and examples/linux/directbinding/direct_binding_usb_show.cpp.