bta_frame.h File Reference

This header file contains enums and structs dor the representation of a BTA_Frame. More...

#include <bta_status.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	BTA_Channel
	BTA_Channel holds a two-dimensional array of data (A part of BTA_Frame) More...
struct	BTA_Frame
	BTA_Frame holds all the data gathered from one frame (one or more channels) More...

Typedefs
typedef enum BTA_FrameMode	BTA_FrameMode
	Enumerator with valid frame modes to be passed with BTAsetFrameMode.
typedef enum BTA_ChannelId	BTA_ChannelId
	Enumerator with channel IDs. They allow the identification of the various channels in a BTA_Frame.
typedef enum BTA_DataFormat	BTA_DataFormat
	Enumerator with data formats which allows the parsing of the data in BTA_Channel. The lowbyte stands for width (number of bytes). The highbyte stands for unsigned/signed/floating-point (continuous numbering).
typedef enum BTA_Unit	BTA_Unit
	Enumerator with units which allows the interpretation of the data in a channel.
typedef struct BTA_Channel	BTA_Channel
	BTA_Channel holds a two-dimensional array of data (A part of BTA_Frame)
typedef struct BTA_Frame	BTA_Frame
	BTA_Frame holds all the data gathered from one frame (one or more channels)

Enumerations
enum	BTA_FrameMode {   BTA_FrameModeCurrentConfig = 0, BTA_FrameModeDistAmp, BTA_FrameModeDistAmpFlags, BTA_FrameModeXYZ,   BTA_FrameModeXYZAmp, BTA_FrameModeDistAmpColor, BTA_FrameModeXYZAmpFlags, BTA_FrameModeRawPhases,   BTA_FrameModeIntensities, BTA_FrameModeDistColor }
	Enumerator with valid frame modes to be passed with BTAsetFrameMode. More...
enum	BTA_ChannelId {   BTA_ChannelIdUnknown = 0x0, BTA_ChannelIdDistance = 0x1, BTA_ChannelIdAmplitude = 0x2, BTA_ChannelIdX = 0x4,   BTA_ChannelIdY = 0x8, BTA_ChannelIdZ = 0x10, BTA_ChannelIdConfidence = 0x20, BTA_ChannelIdFlags = 0x40,   BTA_ChannelIdPhase0 = 0x80, BTA_ChannelIdPhase90 = 0x100, BTA_ChannelIdPhase180 = 0x200, BTA_ChannelIdPhase270 = 0x400,   BTA_ChannelIdTest = 0x800, BTA_ChannelIdColor = 0x1000, BTA_ChannelIdAmbient = 0x2000, BTA_ChannelIdPhase = 0x4000,   BTA_ChannelIdGrayScale = 0x8000 }
	Enumerator with channel IDs. They allow the identification of the various channels in a BTA_Frame. More...
enum	BTA_DataFormat {   BTA_DataFormatUnknown = 0x0, BTA_DataFormatUInt8 = 0x11, BTA_DataFormatUInt16 = 0x12, BTA_DataFormatUInt32 = 0x14,   BTA_DataFormatSInt8 = 0x21, BTA_DataFormatSInt16 = 0x22, BTA_DataFormatSInt32 = 0x24, BTA_DataFormatFloat32 = 0x34,   BTA_DataFormatRgb565 = 0x42, BTA_DataFormatRgb24 = 0x43, BTA_DataFormatJpeg = 0x50 }
	Enumerator with data formats which allows the parsing of the data in BTA_Channel. The lowbyte stands for width (number of bytes). The highbyte stands for unsigned/signed/floating-point (continuous numbering).
enum	BTA_Unit {   BTA_UnitUnitLess = 0, BTA_UnitMeter, BTA_UnitCentimeter, BTA_UnitMillimeter,   BTA_UnitPercent }
	Enumerator with units which allows the interpretation of the data in a channel.

Detailed Description

This header file contains enums and structs dor the representation of a BTA_Frame.

Version

2.1.0

Copyright Bluetechnix 2016

Author

Alex Falkensteiner

Enumeration Type Documentation

enum BTA_ChannelId

Enumerator with channel IDs. They allow the identification of the various channels in a BTA_Frame.

Enumerator
BTA_ChannelIdConfidence	in percent
BTA_ChannelIdFlags	additional pixel-wise sensor specific information

enum BTA_FrameMode

Enumerator with valid frame modes to be passed with BTAsetFrameMode.

Enumerator
BTA_FrameModeCurrentConfig	The sensors settings are not changed and data is passed through (according to device's current calculation/image mode settings)