Types

Classes
struct	LepTelemetryDataLineA
struct	OwDateTime

Macros
#define	OWHE_OK   0

Typedefs
typedef struct _OwDev *	OwDev
typedef INT32	OwHostErrorCode_t
typedef unsigned char	OwFirmwareErrorCode_t
typedef void(*	OwLibCaptureProc) (OwDev dev, BYTE *buf, UINT32 bufLen, void *userData)
typedef void(*	OwLibNotifyProc) (OwDev dev, void *userData)

Enumerations
enum	OwStatus_t {   OWST_OK = 0, OWST_INTERNAL_ERROR = 1, OWST_NO_MEMORY = 2, OWST_DEVICE_NOT_FOUND = 3,   OWST_DEVICE_NOT_READY = 4, OWST_DEVICE_UNSUPPORTED = 5, OWST_NOT_ENOUGH_SIZE = 6, OWST_NOT_YET = 7,   OWST_FIRMWARE_ERROR = 10, OWST_SENSOR_ERROR = 11, OWST_DIRECTSHOW_ERROR = 12, OWST_NULL_POINTER = 20,   OWST_INVALID_VALUE = 21, OWST_INVALID_STATE = 22, OWST_FILE_IO_ERROR = 23, OWST_INVALID_FILE_FORMAT = 24,   OWST_END_OF_FILE = 25, OWST_INCOMPATIBLE = 26 }
enum	OwSensorErrorCode_t { OW_SENSOR_ERROR_NONE = 0 }
enum	OwFrameRate_t { OWFRAMERATE_DEFAULT = 0, OWFRAMERATE_8P6 = 0, OWFRAMERATE_25P9 = 1 }
enum	OwDecodeType_t {   OWDECODETYPE_UNKNOWN = -1, OWDECODETYPE_RAW_14 = 0, OWDECODETYPE_TEMPERATURE_16 = 1, OWDECODETYPE_GRAY_8 = 10,   OWDECODETYPE_NON_LINEAR_AGC_GRAY_8 = 11, OWDECODETYPE_AGC_GRAY_8 = 11, OWDECODETYPE_LINEAR_AGC_GRAY_8 = 12, OWDECODETYPE_BLUE_ORANGE_24 = 20,   OWDECODETYPE_AGC_BLUE_ORANGE_24 = 21, OWDECODETYPE_NON_LINEAR_AGC_BLUE_ORANGE_24 = 21, OWDECODETYPE_LINEAR_AGC_BLUE_ORANGE_24 = 22, OWDECODETYPE_BLUE_ORANGE_32 = 30,   OWDECODETYPE_AGC_BLUE_ORANGE_32 = 31, OWDECODETYPE_NON_LINEAR_AGC_BLUE_ORANGE_32 = 31, OWDECODETYPE_LINEAR_AGC_BLUE_ORANGE_32 = 32, OWDECODETYPE_RAINBOW_24 = 40,   OWDECODETYPE_AGC_RAINBOW_24 = 41, OWDECODETYPE_NON_LINEAR_AGC_RAINBOW_24 = 41, OWDECODETYPE_LINEAR_AGC_RAINBOW_24 = 42, OWDECODETYPE_RAINBOW_32 = 50,   OWDECODETYPE_AGC_RAINBOW_32 = 51, OWDECODETYPE_NON_LINEAR_AGC_RAINBOW_32 = 51, OWDECODETYPE_LINEAR_AGC_RAINBOW_32 = 52, OWDECODETYPE_GRAY_16 = 60,   OWDECODETYPE_NON_LINEAR_AGC_GRAY_16 = 61, OWDECODETYPE_LINEAR_AGC_GRAY_16 = 62, OWDECODETYPE_BLUE_ORANGE_16 = 70, OWDECODETYPE_NON_LINEAR_AGC_BLUE_ORANGE_16 = 71,   OWDECODETYPE_LINEAR_AGC_BLUE_ORANGE_16 = 72, OWDECODETYPE_RAINBOW_16 = 80, OWDECODETYPE_NON_LINEAR_AGC_RAINBOW_16 = 81, OWDECODETYPE_LINEAR_AGC_RAINBOW_16 = 82 }
enum	OwWindowCorrectionType { OW_WINDOW_CORRECTION_TYPE_NONE, OW_WINDOW_CORRECTION_TYPE_GAT05_STD_HOUSING }

Detailed Description

Macro Definition Documentation

OWHE_OK

#define OWHE_OK   0

Represents success with OwHostErrorCode_t.

Typedef Documentation

OwDev

typedef struct _OwDev* OwDev

Represents a device handle.

OwFirmwareErrorCode_t

typedef unsigned char OwFirmwareErrorCode_t

Represents a device error code.

OwHostErrorCode_t

typedef INT32 OwHostErrorCode_t

Represents a host error code (HRESULT). See the documents of MSDN (Microsoft Developer Network) about HRESULT type.

OwLibCaptureProc

typedef void(* OwLibCaptureProc) (OwDev dev, BYTE *buf, UINT32 bufLen, void *userData)

Represents a callback function type that is called while capturing.

Parameters

dev	[in] The device handle.
buf	[in] The frame buffer. This is raw data of sensor output of which format is in big-endian. The pointer to Telemetry Data can be gotten by passing this value to OwLib_GetTelemetryData().
bufLen	[in] The size of the area where 'buf' points in bytes.
userData	[in] 'userData' passed to OwLib_CaptureSetup().

OwLibNotifyProc

typedef void(* OwLibNotifyProc) (OwDev dev, void *userData)

Represents a callback function type that is called for notifications of events.

Parameters

dev	[in] The device handle.
userData	[in] 'userData' passed with the callback function at registering.

Enumeration Type Documentation

OwDecodeType_t

enum OwDecodeType_t

Represents the image decoding type.

Enumerator
OWDECODETYPE_UNKNOWN	Not specified.
OWDECODETYPE_RAW_14	Converts byte order of raw data to host endian. The format of raw data is 2 bytes per pixel, 14 effective bits, big-endian.
OWDECODETYPE_TEMPERATURE_16	Converts raw data to 16-bit temperature data.
OWDECODETYPE_GRAY_8	Converts raw data to 8bit gray scale data with Manual Gain Control.
OWDECODETYPE_NON_LINEAR_AGC_GRAY_8	Converts raw data to 8bit gray scale data with Nonlinear Auto Gain Control.
OWDECODETYPE_AGC_GRAY_8	Same as OWDECODETYPE_NON_LINEAR_AGC_GRAY_8.
OWDECODETYPE_LINEAR_AGC_GRAY_8	Converts raw data to 8bit gray scale data with Linear Auto Gain Control.
OWDECODETYPE_BLUE_ORANGE_24	Converts raw data to 24-bit RGB data with "Blue Orange" color table and Manual Gain Control.
OWDECODETYPE_AGC_BLUE_ORANGE_24	Same as OWDECODETYPE_AGC_NON_LINEAR_BLUE_ORANGE_24.
OWDECODETYPE_NON_LINEAR_AGC_BLUE_ORANGE_24	Converts raw data to 24-bit RGB data with "Blue Orange" color table and Nonlinear Auto Gain Control.
OWDECODETYPE_LINEAR_AGC_BLUE_ORANGE_24	Converts raw data to 24-bit RGB data with "Blue Orange" color table and Linear Auto Gain Control.
OWDECODETYPE_BLUE_ORANGE_32	Converts raw data to 32-bit RGB data with "Blue Orange" color table and Manual Gain Control.
OWDECODETYPE_AGC_BLUE_ORANGE_32	Same as OWDECODETYPE_NON_LINEAR_AGC_BLUE_ORANGE_32.
OWDECODETYPE_NON_LINEAR_AGC_BLUE_ORANGE_32	Converts raw data to 32-bit RGB data with "Blue Orange" color table and Nonlinear Auto Gain Control.
OWDECODETYPE_LINEAR_AGC_BLUE_ORANGE_32	Converts raw data to 32-bit RGB data with "Blue Orange" color table and Linear Auto Gain Control.
OWDECODETYPE_RAINBOW_24	Converts raw data to 24-bit RGB data with "Rainbow" color table and Manual Gain Control.
OWDECODETYPE_AGC_RAINBOW_24	Same as OWDECODETYPE_NON_LINEAR_AGC_RAINBOW_24.
OWDECODETYPE_NON_LINEAR_AGC_RAINBOW_24	Converts raw data to 24-bit RGB data with "Rainbow" color table and Nonlinear Gain Control.
OWDECODETYPE_LINEAR_AGC_RAINBOW_24	Converts raw data to 24-bit RGB data with "Rainbow" color table and Linear Gain Control.
OWDECODETYPE_RAINBOW_32	Converts raw data to 32-bit RGB data with "Rainbow" color table and Manual Gain Control.
OWDECODETYPE_AGC_RAINBOW_32	Same as OWDECODETYPE_NON_LINEAR_AGC_RAINBOW_32.
OWDECODETYPE_NON_LINEAR_AGC_RAINBOW_32	Converts raw data to 32-bit RGB data with "Rainbow" color table and Nonlinear Gain Control.
OWDECODETYPE_LINEAR_AGC_RAINBOW_32	Converts raw data to 32-bit RGB data with "Rainbow" color table and Linear Gain Control.
OWDECODETYPE_GRAY_16	Converts raw data to gray scale data as RGB565 with Manual Gain Control.
OWDECODETYPE_NON_LINEAR_AGC_GRAY_16	Converts raw data to gray scale data as RGB565 with Nonlinear Auto Gain Control.
OWDECODETYPE_LINEAR_AGC_GRAY_16	Converts raw data to gray scale data as RGB565 with Linear Auto Gain Control.
OWDECODETYPE_BLUE_ORANGE_16	Converts raw data to RGB565 data with "Blue Orange" color table and Manual Gain Control.
OWDECODETYPE_NON_LINEAR_AGC_BLUE_ORANGE_16	Converts raw data to RGB565 data with "Blue Orange" color table and Nonlinear Auto Gain Control.
OWDECODETYPE_LINEAR_AGC_BLUE_ORANGE_16	Converts raw data to RGB565 data with "Blue Orange" color table and Linear Auto Gain Control.
OWDECODETYPE_RAINBOW_16	Converts raw data to RGB565 data with "Rainbow" color table and Manual Gain Control.
OWDECODETYPE_NON_LINEAR_AGC_RAINBOW_16	Converts raw data to RGB565 data with "Rainbow" color table and Nonlinear Gain Control.
OWDECODETYPE_LINEAR_AGC_RAINBOW_16	Converts raw data to RGB565 data with "Rainbow" color table and Linear Gain Control.

OwFrameRate_t

enum OwFrameRate_t

Represents a frame rate for image output.

Enumerator
OWFRAMERATE_DEFAULT	Default value (8.6fps)
OWFRAMERATE_8P6	8.6fps
OWFRAMERATE_25P9	25.9fps As the sensor's performance is 8.6 fps, 3 continuous frames are same data if 25.9 fps is specified. That is substantially 8.6 fps. However Telemetry Data is updated in every frame. This value works only for OWLIFT Type-A/B.

OwSensorErrorCode_t

enum OwSensorErrorCode_t

Represents an IR sensor error code. This type defines only one consntant that means no-error, but if an error occurred this type means "Response Error Code" in "CCI/TWI Status Register". See this document for detail.

Enumerator
OW_SENSOR_ERROR_NONE	No error.

OwStatus_t

enum OwStatus_t

Represents a library error code.

Enumerator
OWST_OK	Success.
OWST_INTERNAL_ERROR	Library's internal error.
OWST_NO_MEMORY	Not enough memory.
OWST_DEVICE_NOT_FOUND	No device was found.
OWST_DEVICE_NOT_READY	Device is not ready.
OWST_DEVICE_UNSUPPORTED	Unsupported device.
OWST_NOT_ENOUGH_SIZE	Not enough size of the area.
OWST_NOT_YET	Processing is not completed.
OWST_FIRMWARE_ERROR	Error occurred in device firmware.
OWST_SENSOR_ERROR	Error occurred in device sensor.
OWST_DIRECTSHOW_ERROR	Error occurred in DirectShow.
OWST_NULL_POINTER	Argument as a pointer type is NULL.
OWST_INVALID_VALUE	Value of argument is invalid.
OWST_INVALID_STATE	Function is called in invalid state.
OWST_FILE_IO_ERROR	File I/O error occurred.
OWST_INVALID_FILE_FORMAT	Invalid file format.
OWST_END_OF_FILE	End of file.
OWST_INCOMPATIBLE	Incompatible.

OwWindowCorrectionType

enum OwWindowCorrectionType

Represents a correction type for protection windows.

Enumerator
OW_WINDOW_CORRECTION_TYPE_NONE	No protection window.
OW_WINDOW_CORRECTION_TYPE_GAT05_STD_HOUSING	Standard housing / GAT-05