image_info_t Struct Reference

Structure for conveying metadata information about an image. More...

#include <AxsunOCTCapture.h>

Data Fields
uint32_t	image_number
int32_t	height
int32_t	width
uint32_t	size_bytes
AxDataType	data_type
AxPipelineMode	pipeline_mode
AxChannelMode	channel_mode
struct axtimeval_t	time_stamp
uint8_t	subsampling_factor
uint8_t	shift_adj
uint8_t	force_trig
uint8_t	trig_too_fast
uint8_t	burst_recorded
uint8_t	test_vector_data
axpacket_t	last_packet_metadata

Detailed Description

Structure for conveying metadata information about an image.

Examples

AxsunOCTCapture_C_example.c, AxsunOCTCapture_Cpp_example.cpp, AxsunOCTCapture_Cpp_example_NewImageCallback.cpp, and AxsunOCTCapture_Cpp_linux_example.cpp.

Field Documentation

burst_recorded

uint8_t burst_recorded

If non-zero, this image was captured during a Burst Record operation.

channel_mode

AxChannelMode channel_mode

Channel selected (single channel, vector sum, interleaved channels.

data_type

AxDataType data_type

Data type (signed or unsigned, 8-, 16-, or 32-bits, big endian or little endian, etc.

force_trig

uint8_t force_trig

If non-zero, image_sync trigger is too slow; image was force-triggered.

Examples

AxsunOCTCapture_C_example.c.

height

int32_t height

Height (pixels).

image_number

uint32_t image_number

Unique image number. A value of zero indicates a force-triggered image.

Examples

AxsunOCTCapture_C_example.c.

last_packet_metadata

axpacket_t last_packet_metadata

Packet metadata for the last packet in this image (for internal use).

pipeline_mode

AxPipelineMode pipeline_mode

Pipeline mode (raw data, windowed, log compressed, JPEG compressed, etc.

shift_adj

uint8_t shift_adj

Dynamic range adjustment for conversion of pixel values into physical units (e.g. volts).

size_bytes

uint32_t size_bytes

Total image size (bytes): the required size of a buffer allocated by the user for image retrieval using axRequestImageAdv() or axRequestImage(), assuming no cropping or JPEG downsampling is requested.

subsampling_factor

uint8_t subsampling_factor

The subsampling factor used during capture of this image.

test_vector_data

uint8_t test_vector_data

If non-zero, this image's data source is FPGA test vectors, not sampled ADC data.

time_stamp

struct axtimeval_t time_stamp

Image acquisition time stamp in UNIX Epoch time (seconds since 00:00:00 UTC on 1 Jan 1970).

trig_too_fast

uint8_t trig_too_fast

If non-zero, image_sync trigger is too fast; image width possibly affected by missed trigger.

Examples

AxsunOCTCapture_C_example.c.

width

int32_t width

Width (pixels).

Examples

AxsunOCTCapture_C_example.c.

---

The documentation for this struct was generated from the following file:

• AxsunOCTCapture.h