AxsunCommonEnums.h File Reference

This header file contains enums and other definitions for integrating AxsunOCTCapture.dll and AxsunOCTControl_LW.dll into a client application. More...

#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	axtimeval_t
	Structure for packet time stamp with platform-independent size. More...
struct	window_func_t
	Parameters for calculating a complex-valued window function with phase described using a Taylor series expansion. More...

Typedefs
typedef struct axtimeval_t	axtimeval_t
	Structure for packet time stamp with platform-independent size.
typedef enum AxErr	AxErr
	Error codes returned from AxsunOCTCapture or AxsunOCTControl_LW functions. Use axGetErrorString() in AxsunOCTCapture or axGetErrorExplained() in AxsunOCTControl_LW for descriptions.
typedef enum AxPipelineMode	AxPipelineMode
	DAQ pipeline modes.
typedef enum AxChannelMode	AxChannelMode
	DAQ channel selection modes.
typedef enum AxDataType	AxDataType
	Integer data types which may be generated by the Axsun DAQ depending on selected pipeline bypass mode.
typedef enum AxEdgeSource	AxEdgeSource
	DAQ sample clock and trigger sources (incl. Sweep, Image_sync, and Burst Record triggers.)
typedef enum AxRcrdTrigBehavior	AxRcrdTrigBehavior
	DAQ Burst Record trigger behavior. Applies to "External" trigger sources as described in AxEdgeSource.
typedef enum AxSwpTrgMode	AxSwpTrgMode
	DAQ sweep trigger edge modes.
typedef enum AxWindowFuncType	AxWindowFuncType
	Window function types ("type_modifier" refers to member of associated window_func_t struct).
typedef struct window_func_t	window_func_t
	Parameters for calculating a complex-valued window function with phase described using a Taylor series expansion.

Enumerations
enum	AxErr
	Error codes returned from AxsunOCTCapture or AxsunOCTControl_LW functions. Use axGetErrorString() in AxsunOCTCapture or axGetErrorExplained() in AxsunOCTControl_LW for descriptions.
enum	AxPipelineMode {   UNKNOWN = 0 , RAW_ADC = 1 , WINDOWED = 2 , IFFT = 3 ,   MOD_SQUARED = 4 , SQRT = 5 , LOG = 6 , EIGHT_BIT = 7 ,   JPEG_COMP = 8 , PIPELINEMODE_RFU = 9 }
	DAQ pipeline modes. More...
enum	AxChannelMode {   CHAN_1 = 0 , CHAN_2 = 1 , SUM_CHANNELS = 2 , INTERLEAVE_CHANNELS = 3 ,   CHANNELMODE_RFU = 4 }
	DAQ channel selection modes. More...
enum	AxDataType {   U8 , U16 , U32 , CMPLX ,   I16 , U16_le , U32_le , CMPLX_le ,   I16_le , I32_le , AXDATATYPE_RFU }
	Integer data types which may be generated by the Axsun DAQ depending on selected pipeline bypass mode. More...
enum	AxEdgeSource {   EXTERNAL = 0 , INTERNAL = 1 , LVDS = 2 , LVCMOS = 3 ,   INTERNAL_SYNC = 4 , LVDS_FRONT = 5 , LVCMOS_FRONT = 6 , LVCMOS2_REAR = 7 }
	DAQ sample clock and trigger sources (incl. Sweep, Image_sync, and Burst Record triggers.) More...
enum	AxRcrdTrigBehavior {   STARTRISING_STOPCOUNT = 0 , STARTFALLING_STOPCOUNT = 1 , STARTRISING_STOPRISING = 2 , STARTFALLING_STOPFALLING = 3 ,   STARTRISING_STOPFALLING = 4 , STARTFALLING_STOPRISING = 5 , REC_TRIG_BEHAVIOR_RFU = 6 }
	DAQ Burst Record trigger behavior. Applies to "External" trigger sources as described in AxEdgeSource. More...
enum	AxSwpTrgMode { SWPTRIG_RISING = 0 , SWPTRIG_FALLING = 1 , SWPTRIG_DUALEDGE = 2 , SWPTRIG_RFU = 3 }
	DAQ sweep trigger edge modes. More...
enum	AxWindowFuncType {   WINFUNCTYPE_RFU = 0 , HANN = 1 , HAMMING = 2 , BLACKMAN_HARRIS = 3 ,   GAUSSIAN = 4 , TUKEY = 5 , ONES = 6 , ZEROS = 7 }
	Window function types ("type_modifier" refers to member of associated window_func_t struct). More...

Detailed Description

This header file contains enums and other definitions for integrating AxsunOCTCapture.dll and AxsunOCTControl_LW.dll into a client application.

Enumeration Type Documentation

AxChannelMode

enum AxChannelMode

DAQ channel selection modes.

Enumerator
CHAN_1	Channel 1 only.
CHAN_2	Channel 2 only.
SUM_CHANNELS	Channels 1 and 2 mixed using vector sum (e.g. polarization diverse).
INTERLEAVE_CHANNELS	Channels 1 and 2 interleaved.
CHANNELMODE_RFU	Reserved for future use.

AxDataType

enum AxDataType

Integer data types which may be generated by the Axsun DAQ depending on selected pipeline bypass mode.

Enumerator
U8	Unsigned 8-bit.
U16	Unsigned 16-bit, big endian.
U32	Unsigned 32-bit, big endian.
CMPLX	32-bit complex (Signed 16-bit imaginary, Signed 16-bit real), big endian.
I16	Signed 16-bit, big endian.
U16_le	Unsigned 16-bit, little endian.
U32_le	Unsigned 32-bit, little endian.
CMPLX_le	32-bit complex (Signed 16-bit imaginary, Signed 16-bit real), little endian.
I16_le	Signed 16-bit, little endian.
I32_le	Signed 32-bit, little endian.
AXDATATYPE_RFU	(reserved for future use).

AxEdgeSource

enum AxEdgeSource

DAQ sample clock and trigger sources (incl. Sweep, Image_sync, and Burst Record triggers.)

Enumerator
EXTERNAL	External source (i.e. for laser engine sweep trigger and k-clock, SATA connector).
INTERNAL	Internally-generated source (e.g. for simulation purposes). Also sets Software Burst Record trigger.
LVDS	External LVDS on rear of board (for Image_sync trigger and Burst Record trigger only).
LVCMOS	External LVCMOS on rear of board (for Image_sync trigger and Burst Record trigger only).
INTERNAL_SYNC	Internally-generated synchronous Image_sync trigger source (e.g. for simulation purposes).
LVDS_FRONT	External LVDS on front of board, if available (for Image_sync trigger and Burst Record trigger only).
LVCMOS_FRONT	External LVCMOS on front of board, if available (for Image_sync trigger and Burst Record trigger only).
LVCMOS2_REAR	External LVCMOS2 on rear of board (for Burst Record trigger only).

AxPipelineMode

enum AxPipelineMode

DAQ pipeline modes.

Enumerator
UNKNOWN	Undefined mode (invalid value in FPGA Register 61?).
RAW_ADC	Sampled data directly from ADC (unprocessed).
WINDOWED	After windowing and zero-padding.
IFFT	After calculation of Fourier transformation and negative frequency truncation.
MOD_SQUARED	After calculation of complex modulus squared.
SQRT	After calculation of square root and background subtraction.
LOG	After logarithmic compression.
EIGHT_BIT	After dynamic-range compression to 8-bits.
JPEG_COMP	After JPEG compression (Ethernet interface only).
PIPELINEMODE_RFU	Reserved for future use.

AxRcrdTrigBehavior

enum AxRcrdTrigBehavior

DAQ Burst Record trigger behavior. Applies to "External" trigger sources as described in AxEdgeSource.

Enumerator
STARTRISING_STOPCOUNT	Start Burst Record operation on rising edge; stop when COUNT reached.
STARTFALLING_STOPCOUNT	Start Burst Record operation on falling edge; stop when COUNT reached.
STARTRISING_STOPRISING	Start and then stop Burst Record operation on consecutive rising edges.
STARTFALLING_STOPFALLING	Start and then stop Burst Record operation on consecutive falling edges.
STARTRISING_STOPFALLING	Start Burst Record operation on rising edge; stop on subsequent falling edge.
STARTFALLING_STOPRISING	Start Burst Record operation on falling edge; stop on subsequent rising edge.
REC_TRIG_BEHAVIOR_RFU	(reserved for future use).

AxSwpTrgMode

enum AxSwpTrgMode

DAQ sweep trigger edge modes.

Enumerator
SWPTRIG_RISING	Rising trigger edge only.
SWPTRIG_FALLING	Falling trigger edge only.
SWPTRIG_DUALEDGE	Both rising and falling trigger edges.
SWPTRIG_RFU	(reserved for future use).

AxWindowFuncType

enum AxWindowFuncType

Window function types ("type_modifier" refers to member of associated window_func_t struct).

Enumerator
WINFUNCTYPE_RFU	(reserved for future use).
HANN	Hann window.
HAMMING	Hamming window.
BLACKMAN_HARRIS	Blackman-Harris window; use type_modifier <= 3.0 to set 3-term or type_modifier > 3.0 to set 4-term.
GAUSSIAN	Gaussian window; use type_modifier as sigma.
TUKEY	Tukey aka cosine-tapered window; use type_modifier as alpha.
ONES	Unity window (no magnitude modification).
ZEROS	Data blocked (all values zeroed-out).