Structure for image request preferences. More...

#include <AxsunOCTCapture.h>

Data Fields
AxRequestMode	request_mode

int32_t	which_window

uint32_t	average_number

int32_t	crop_width_offset

int32_t	crop_width_total

int32_t	crop_height_offset

int32_t	crop_height_total

int16_t	to8bit_shift

uint16_t	to8Bit_min

uint8_t	downsample

uint8_t	dezipper

Detailed Description

Structure for image request preferences.

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

Field Documentation

◆ average_number

uint32_t average_number

Consecutive images to average (mean) up to maximum of 10. Set to 1 for no image averaging. Image width must be <= 5000 A-scans. Averaging is not available in Force Trigger mode (i.e. when no Image_sync is detected).

Examples: AxsunOCTCapture_Cpp_linux_example.cpp.

◆ crop_height_offset

int32_t crop_height_offset

The first depth pixel to be retrieved, a positive-valued offset from the top of the image. If the offset exceeds the available pixels in an image, the requested image will be retrieved/displayed starting at offset = 0.

◆ crop_height_total

int32_t crop_height_total

The total number of depth pixels to be retrieved. Set to 0 to retrieve the full image depth. If the value exceeds the remaining pixels available following crop_height_offset, the remaining available pixels in the image depth will be retrieved/displayed.

◆ crop_width_offset

int32_t crop_width_offset

Cropping an image avoids inefficiency associated with retrieving unwanted pixels which would subsequently be discarded by the calling application before display (e.g. galvo fly-back portion).

Note that the cropping behavior based on these settings is applied prior to the OpenGL display window cropping behavior configured using axCropRect().

The first A-scan to be retrieved, a positive-valued offset from the Image_sync pulse defining the start of an image. If the offset exceeds the available A-scans in an image, the requested image will be retrieved/displayed starting at offset = 0.

◆ crop_width_total

int32_t crop_width_total

The total number of A-scans to be retrieved. Set to 0 to retrieve the full image width. If the value exceeds the remaining A-scans available following crop_width_offset, the remaining available A-scans in the image will be retrieved/displayed.

◆ dezipper

uint8_t dezipper

Placeholder for future functionality.

◆ downsample

uint8_t downsample

The desired 2x downsampling behavior (disabled = 0, enabled = 1). Downsampling speeds up JPEG decompression but halves the width and height of retrieved and/or displayed images. The original full-resolution images persist in the Main Image Buffer. Downsampling is helpful to keep frame rates high during display of images that have very high numbers of a-scans per image and are thus larger than the display's pixel dimensions.

◆ request_mode

AxRequestMode request_mode

Indicate if requested image is to be retrieved to the caller, displayed directly via OpenGL, or both.

Examples: AxsunOCTCapture_C_example.c, AxsunOCTCapture_Cpp_example_NewImageCallback.cpp, and AxsunOCTCapture_Cpp_linux_example.cpp.

◆ to8Bit_min

uint16_t to8Bit_min

Placeholder for future functionality. Controls 16-bit to 8-bit dynamic range compression behavior.

◆ to8bit_shift

int16_t to8bit_shift