 |
AxsunOCTCapture
3.6.0.0
Captures and buffers streamed imaged data from the Axsun Ethernet/PCIe DAQ and displays or retrieves images to a client application on request.
|
|
AxsunOCTCapture
3.6.0.0
Captures and buffers streamed imaged data from the Axsun Ethernet/PCIe DAQ and displays or retrieves images to a client application on request.
|
This header file contains all exported function prototypes, structures, and enums necessary for integrating AxsunOCTCapture.dll into a client application. More...
#include "AxsunCommonEnums.h"Go to the source code of this file.
Data Structures | |
| struct | scan_params_t |
| Structure for passing raster scan pattern parameters to axScanCmd(SET_RECT_PATTERN, ...). More... | |
| struct | ext_pattern_t |
| Structure for passing a user-generated scan pattern to axScanCmd(LOAD_EXT_PATTERN, ...). More... | |
| struct | request_prefs_t |
| Structure for image request preferences. More... | |
| struct | export_prefs_t |
| Structure for image export preferences (movie functionality requires installation of OpenCV). More... | |
| struct | axpacket_t |
| Structure for packet metadata (for internal use.) More... | |
| struct | image_info_t |
| Structure for conveying metadata information about an image. More... | |
| struct | new_image_callback_data_t |
| Structure for data made available to user in a new image callback event via registered AxNewImageCallbackFunction_t. More... | |
Macros | |
| #define | MOST_RECENT_IMAGE 0 |
Typedefs | |
| typedef struct CaptureSession * | AOChandle |
| Axsun OCT Capture handle - a pointer to the opaque structure used to manage created capture sessions. | |
| typedef enum AxDimension | AxDimension |
| Dimension for sectioning data cube with axRequestCutPlane(). | |
| typedef enum AxColormap | AxColormap |
| Available colormaps to select using axSelectColormap(). | |
| typedef enum AxFileType | AxFileType |
| Available file types to export using axExportImages() and axExportImagesAdv(). | |
| typedef enum AxRequestMode | AxRequestMode |
| Available request modes to define behavior of axRequestImageAdv(). | |
| typedef enum AxDAQEvent | AxDAQEvent |
| Types of transitions in DAQ's operational mode, conveyed via user callback function. See axRegisterDAQCallback() for usage. | |
| typedef enum AxInterface | AxInterface |
| Available capture interfaces to be selected by axSelectInterface(). | |
| typedef enum AxScannerCommand | AxScannerCommand |
| Available scanner command types to be executed by axScanCmd(). | |
| typedef struct scan_params_t | scan_params_t |
| Structure for passing raster scan pattern parameters to axScanCmd(SET_RECT_PATTERN, ...). | |
| typedef struct ext_pattern_t | ext_pattern_t |
| Structure for passing a user-generated scan pattern to axScanCmd(LOAD_EXT_PATTERN, ...). | |
| typedef struct request_prefs_t | request_prefs_t |
| Structure for image request preferences. | |
| typedef struct export_prefs_t | export_prefs_t |
| Structure for image export preferences (movie functionality requires installation of OpenCV). | |
| typedef struct axpacket_t | axpacket_t |
| Structure for packet metadata (for internal use.) | |
| typedef struct image_info_t | image_info_t |
| Structure for conveying metadata information about an image. | |
| typedef struct new_image_callback_data_t | new_image_callback_data_t |
| Structure for data made available to user in a new image callback event via registered AxNewImageCallbackFunction_t. | |
| typedef void(__cdecl * | AxNewImageCallbackFunction_t) (new_image_callback_data_t, void *) |
| A user-provided function to be called when a new image is enqueued in the Main Image Buffer. See axRegisterNewImageCallback() for usage. | |
| typedef void(__cdecl * | AxConnectScannerCallbackFunction_t) (void *) |
| A user-provided function to be called upon connection or disconnection of a NI-DAQmx device. See axRegisterScannerConnectCallback() for usage. | |
| typedef void(__cdecl * | AxCallbackFunction_t) (uint32_t, void *) |
| A generic user-provided callback function with an unsigned int and void* argument. See axRegisterExportCallback(), or axRegisterDAQCallback() for usage. | |
Functions | |
| AxErr | axStartSession (AOChandle *session, float capacity_MB) |
| Start an Axsun DAQ imaging session by allocating memory for the Main Image Buffer. More... | |
| AxErr | axSelectInterface (AOChandle session, AxInterface which_interface) |
| Select the data interface (Ethernet, PCIe, or none) for the capture session. More... | |
| AxErr | axStopSession (AOChandle session) |
| Stop a capture session and deallocate all resources, including Main Image Buffer and interfaces. More... | |
| void | axGetErrorString (AxErr errorcode, char *message_out) |
| Get a description of a specific AxErr error code. More... | |
| AxErr | axGetMessage (AOChandle session, char *message_out) |
| Get a description of the capture session's interface status. More... | |
| AxErr | axGetStatus (AOChandle session, uint32_t *imaging, uint32_t *last_packet_in, uint32_t *last_frame_in, uint32_t *last_image_in, uint32_t *dropped_packets, uint32_t *frames_since_sync) |
| Get imaging mode status and Main Image Buffer statistics. More... | |
| AxErr | axGetDataRate (AOChandle session, double *datarate_Mbps) |
| Get data transfer rate on the active interface. More... | |
| AxErr | axGetImageRate (AOChandle session, int32_t *images_per_second) |
| Get the rate of new images being enqueued in the main image buffer. More... | |
| AxErr | axGetImageInfo (AOChandle session, uint32_t requested_image, image_info_t *image_info) |
| Get information on an image in the Main Image Buffer. More... | |
| AxErr | axGetImageInfoAdv (AOChandle session, int64_t requested_image_number, uint32_t *returned_image_number, int32_t *height, int32_t *width, AxDataType *data_type_out, uint32_t *required_buffer_size, uint8_t *force_trig, uint8_t *trig_too_fast) |
| (DEPRECATED in v3.4.0) Advanced function for getting information on an image in the Main Image Buffer. More... | |
| AxErr | axRequestImage (AOChandle session, uint32_t requested_image, request_prefs_t prefs, uint32_t output_buf_len, uint8_t *image_data_out, image_info_t *image_info) |
| Retrieve and/or display an image from the Main Image Buffer. More... | |
| AxErr | axRequestImageAdv (AOChandle session, int64_t requested_image_number, uint8_t *image_data_out, axpacket_t *metadata_out, int32_t *height, int32_t *width, AxDataType *data_type_out, uint32_t output_buf_len, request_prefs_t prefs, uint8_t *force_trig, uint8_t *trig_too_fast) |
| (DEPRECATED in v3.4.0) Advanced function for retrieving and/or displaying an image from the Main Image Buffer. More... | |
| AxErr | axGetFrameInfoAdv (AOChandle session, int64_t requested_frame_number, uint32_t *returned_frame_number, int32_t *height, int32_t *width, AxDataType *data_type_out, uint32_t *required_buffer_size) |
| Get information on a frame in the Main Image Buffer (A frame is 256 A-scans, unsynchronized with Image_sync signal). More... | |
| AxErr | axRequestFrameAdv (AOChandle session, int64_t requested_frame_number, uint8_t *frame_data_out, axpacket_t *metadata_out, int32_t *height, int32_t *width, AxDataType *data_type_out, uint32_t output_buf_len) |
| Retrieve a frame from the Main Image Buffer (A frame is 256 A-scans, unsynchronized with Image_sync signal). More... | |
| AxErr | axGetCompressedJPEGInfo (AOChandle session, int64_t requested_frame_number, uint32_t *returned_frame_number, uint32_t *required_buffer_size) |
| Get un-decompressed size information on a compressed JPEG frame in the Main Image Buffer (A frame is 256 A-scans, unsynchronized with Image_sync signal). More... | |
| AxErr | axRequestCompressedJPEG (AOChandle session, int64_t requested_frame_number, uint8_t *JPEG_data_out, axpacket_t *metadata_out, uint32_t output_buf_len) |
| Retrieve an un-decompressed JPEG frame from the Main Image Buffer (A frame is 256 A-scans, unsynchronized with Image_sync signal). More... | |
| AxErr | axSetupDisplay (AOChandle session, uint8_t window_style, int32_t w_left, int32_t w_top, int32_t w_width, int32_t w_height, uintptr_t parent_window_handle) |
| Setup an OpenGL display window for direct rendering of image data. (WINDOWS ONLY) More... | |
| AxErr | axCountWindows (AOChandle session, int32_t *num_of_windows) |
| Count the number of OpenGL display windows currently created. (WINDOWS ONLY) More... | |
| AxErr | axUpdateWindowStyle (AOChandle session, int32_t which_window, uint8_t window_style) |
| Change the OpenGL display window style. (WINDOWS ONLY) More... | |
| AxErr | axSelectInterpolation (AOChandle session, int32_t which_window, uint8_t interpolation) |
| Change the OpenGL display interpolation mode. (WINDOWS ONLY) More... | |
| AxErr | axDisplayImage (AOChandle session, int64_t requested_image_number, uint32_t *returned_image_number, int32_t *height, int32_t *width) |
| (DEPRECATED in v3.4.0) Display an image from the Main Image Buffer directly to an OpenGL window (8-bit image data only). (WINDOWS ONLY) More... | |
| AxErr | axSelectColormap (AOChandle session, int32_t which_window, AxColormap colors) |
| Select the color scheme of images displayed in an OpenGL window. (WINDOWS ONLY) More... | |
| AxErr | axLoadUserColormap (AOChandle session, int32_t which_window, uint8_t *user_colormap_in) |
| Load a user-defined AxColormap for images displayed in an OpenGL window. (WINDOWS ONLY) More... | |
| AxErr | axScanConvert (AOChandle session, int32_t which_window, uint8_t convert, float inner_radius, float outer_radius, float crop_inner, float crop_outer) |
| Change the polar -> rectangular scan conversion behavior of images displayed in an OpenGL window. (WINDOWS ONLY) More... | |
| AxErr | axUpdateView (AOChandle session, int32_t which_window, int32_t w_left, int32_t w_top, int32_t w_width, int32_t w_height) |
| Change the OpenGL window size and position. (WINDOWS ONLY) More... | |
| AxErr | axCropRect (AOChandle session, int32_t which_window, float crop_left, float crop_top, float crop_bottom, float crop_right) |
| Change the rectangular cropping behavior of images displayed in an OpenGL window. (WINDOWS ONLY) More... | |
| AxErr | axAdjustBrightnessContrast (AOChandle session, int32_t which_window, float brightness, float contrast) |
| Change the brightness and contrast of images displayed in an OpenGL window. (WINDOWS ONLY) More... | |
| AxErr | axHideWindow (AOChandle session, int32_t which_window, uint32_t hidden) |
| Hide or unhide the OpenGL image display window. (WINDOWS ONLY) More... | |
| AxErr | axSetTrigTimeout (AOChandle session, uint32_t framesUntilForceTrig) |
| Control the behavior of Force Trigger mode. More... | |
| AxErr | axSaveFile (AOChandle session, const char *path_file, uint8_t full_buffer, int32_t *packets_written) |
| Save contents of Main Image Buffer to disk. More... | |
| AxErr | axLoadFile (AOChandle session, const char *path_file, int32_t *packets_read) |
| Load contents from file on disk into Main Image Buffer. More... | |
| AxErr | axResizeBuffer (AOChandle session, float capacity_MB) |
| Clears and resets the Main Image Buffer, optionally with a new buffer size. More... | |
| AxErr | axImagingCntrlPCIe (AOChandle session, int16_t number_of_images) |
| Control the image streaming behavior of the Axsun PCIe DAQ between Live Imaging, Burst Recording, and Imaging Off states. (WINDOWS ONLY) More... | |
| AxErr | axWriteFPGAreg (AOChandle session, uint16_t regnum, uint16_t regval) |
| Write a FPGA register on the Axsun DAQ via the PCIe interface. (WINDOWS ONLY) More... | |
| AxErr | axWriteFPGAregBIT (AOChandle session, uint16_t regnum, uint8_t bitnum, uint8_t bitval) |
| Write a single bit in an FPGA register on the Axsun DAQ via the PCIe interface. (WINDOWS ONLY) More... | |
| AxErr | axPipelineMode (AOChandle session, AxPipelineMode mode, AxChannelMode channels) |
| Configures FPGA registers to output the desired data type & location from the processing pipeline via the PCIe interface. (WINDOWS ONLY) More... | |
| AxErr | axReadFPGAreg (AOChandle session, uint16_t regnum, uint16_t *regval) |
| Read a FPGA register on the Axsun DAQ via the PCIe interface. (WINDOWS ONLY) More... | |
| AxErr | axExportImages (AOChandle session, const char *path_directory, int32_t *images_exported, AxFileType file_type) |
| Export images from the Main Image Buffer into individual binary or graphics files. More... | |
| AxErr | axExportImagesAdv (AOChandle session, const char *path_directory, int32_t *images_exported, AxFileType file_type, uint32_t start_image, uint32_t end_image, request_prefs_t request_prefs, export_prefs_t export_prefs) |
| Export images from the Main Image Buffer into individual graphics and movie files, with dimensional (cropping and scaling), intensity (brightness and contrast), and colormap adjustments. More... | |
| AxErr | axScanCmd (AxScannerCommand scan_command, double misc_scalar, scan_params_t *scan_parameters, ext_pattern_t *external_scan_pattern, void *RFU) |
| Control analog output waveform generation for 2 channel (X-Y) scanners. (WINDOWS ONLY) More... | |
| AxErr | axRegisterScannerConnectCallback (AxConnectScannerCallbackFunction_t callback_function, void *userData) |
| Registers a callback function to be executed following a scanner (DAQmx) device connection or disconnection event. (WINDOWS ONLY) More... | |
| AxErr | axRegisterDAQCallback (AOChandle session, AxCallbackFunction_t callback_function, void *user_data) |
| Registers a callback function to be executed upon a change in the DAQ imaging state (e.g. transition to live, record, idle). More... | |
| AxErr | axReportImagingState (AOChandle session) |
| Programmatically executes the pre-registered callback function to indicate the current DAQ imaging state. More... | |
| AxErr | axRegisterExportCallback (AOChandle session, AxCallbackFunction_t callback_function, void *user_data) |
| Registers a callback function to be executed each time an image is exported using axExportImages() or axExportImagesAdv(). More... | |
| AxErr | axRegisterNewImageCallback (AOChandle session, AxNewImageCallbackFunction_t callback_function, void *user_data) |
| Registers a callback function to be executed each time a new image is enqueued in the Main Image Buffer, whether captured from DAQ hardware or loaded from disk. More... | |
| int32_t | axGetLibBuildCfg (void) |
| Get the build configuration of the library. More... | |
| int32_t | axGetLibBuildDateTime (char *datetime_str) |
| Get a string describing the time and date that the library was built. More... | |
| void | axGetLibVersion (int32_t *major, int32_t *minor, int32_t *patch, int32_t *build, char *version_str) |
| Get the library version. More... | |
This header file contains all exported function prototypes, structures, and enums necessary for integrating AxsunOCTCapture.dll into a client application.
Please note that SIGNIFICANT API CHANGES have been made in this version 3.x relative to previous 2.x versions of the library:
General Functionality:
DAQmx Scanner Control Functionality:
GET_DEVICE_SERIALNO and SELECT_DEVICE commandsOpenGL Display Functionality:
DETAILED RELEASE NOTES
Version 3.0.0.0
Version 3.1.0.0
Version 3.2.0.0
Version 3.3.0.0
Version 3.3.1.0
Version 3.4.0.0
Version 3.4.1.0
Version 3.4.2.0
Version 3.4.3.0
Version 3.4.4.0
Version 3.4.5.0
Version 3.5.0.0
Version 3.5.1.0
Version 3.5.2.0
Version 3.5.3.0
Version 3.5.4.0
Version 3.6.0.0
| enum AxDAQEvent |
Types of transitions in DAQ's operational mode, conveyed via user callback function. See axRegisterDAQCallback() for usage.
| enum AxDimension |
| enum AxFileType |
Available file types to export using axExportImages() and axExportImagesAdv().
| Enumerator | |
|---|---|
| BINARY | Individual raw binary files. |
| JPEG | Individual JPEG files. |
| BMP | Individual Windows Bitmap (.bmp) files. |
| PNG | Individual PNG files (requires OpenCV). |
| RAW3D | 3D raw binary file (raw 3D file can be imported into '3DView' available from http://www.rmrsystems.co.uk/volume_rendering.htm if all three dimensions are less than or equal to 512). |
| FILETYPE_RFU | (reserved for future use). |
| enum AxInterface |
Available capture interfaces to be selected by axSelectInterface().
| Enumerator | |
|---|---|
| GIGABIT_ETHERNET | Gigabit Ethernet interface. |
| PCI_EXPRESS | PCI Express x8 interface. (WINDOWS ONLY) |
| NO_INTERFACE | No interface selected. |
| INTERFACE_RFU | (reserved for future use). |
| enum AxRequestMode |
Available request modes to define behavior of axRequestImageAdv().
| enum AxScannerCommand |
Available scanner command types to be executed by axScanCmd().
| AxErr axAdjustBrightnessContrast | ( | AOChandle | session, |
| int32_t | which_window, | ||
| float | brightness, | ||
| float | contrast | ||
| ) |
Change the brightness and contrast of images displayed in an OpenGL window. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| which_window | Selects which OpenGL window is targeted for this behavior change. |
| brightness | The desired brightness. Typical values are in the range [-0.5, 0.5]. |
| contrast | The desired contrast. Typical values are in the range [0.5, 1.5]. |
Count the number of OpenGL display windows currently created. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| num_of_windows | Will be populated with the number of OpenGL display windows currently created. This will correspond to the number of times axSetupDisplay() has been successfully called since session creation. |
| AxErr axCropRect | ( | AOChandle | session, |
| int32_t | which_window, | ||
| float | crop_left, | ||
| float | crop_top, | ||
| float | crop_bottom, | ||
| float | crop_right | ||
| ) |
Change the rectangular cropping behavior of images displayed in an OpenGL window. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| which_window | Selects which OpenGL window is targeted for this behavior change. |
| crop_left | Fraction of total image width cropped from left (0 = no cropping, 0.5 = half of image cropped, etc.). |
| crop_top | Fraction of total image height cropped from top. |
| crop_bottom | Fraction of total image height cropped from bottom. |
| crop_right | Fraction of total image width cropped from right. |
| AxErr axDisplayImage | ( | AOChandle | session, |
| int64_t | requested_image_number, | ||
| uint32_t * | returned_image_number, | ||
| int32_t * | height, | ||
| int32_t * | width | ||
| ) |
(DEPRECATED in v3.4.0) Display an image from the Main Image Buffer directly to an OpenGL window (8-bit image data only). (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| requested_image_number | The image number requested for display. This can be a unique image number or it can be set < 1 to request the most recently enqueued image in the buffer. |
| returned_image_number | Will be populated with the unique image number displayed. This will be equal to the "requested_image_number" parameter unless that parameter is set < 1 to request the most recent image. |
| height | Will be populated with the height of the requested image (in pixels). |
| width | Will be populated with the width of the requested image (in pixels). |
| AxErr axExportImages | ( | AOChandle | session, |
| const char * | path_directory, | ||
| int32_t * | images_exported, | ||
| AxFileType | file_type | ||
| ) |
Export images from the Main Image Buffer into individual binary or graphics files.
| session | The opaque handle to the session created with axStartSession(). |
| path_directory | Nul-terminated path to directory in which to export files (must be less than 200 characters). |
| images_exported | Will be populated with the number of images successfully exported. |
| file_type | The desired file type (.bin, .jpg, .bmp, .png) |
| AxErr axExportImagesAdv | ( | AOChandle | session, |
| const char * | path_directory, | ||
| int32_t * | images_exported, | ||
| AxFileType | file_type, | ||
| uint32_t | start_image, | ||
| uint32_t | end_image, | ||
| request_prefs_t | request_prefs, | ||
| export_prefs_t | export_prefs | ||
| ) |
Export images from the Main Image Buffer into individual graphics and movie files, with dimensional (cropping and scaling), intensity (brightness and contrast), and colormap adjustments.
| session | The opaque handle to the session created with axStartSession(). |
| path_directory | Nul-terminated path to directory in which to export binary files (must be less than 200 characters). |
| images_exported | Will be populated with the number of images successfully exported. |
| file_type | The desired file type. Raw Binary files can be exported for any data type. PNG files can be exported for U8 and U16 data types. JPEG and BMP files can be exported only for U8 data type. |
| start_image | The unique image number of the image at which to start exporting. If = 0, all images will be exported. |
| end_image | The unique image number of the image at which to stop exporting. If = 0, all images will be exported. |
| request_prefs | Preferences related to image averaging, cropping, and other behaviors (same scheme used in axRequestImage()). |
| export_prefs | Controls properties such as size, colormap, contrast, and brightness of the exported images. |
| AxErr axGetCompressedJPEGInfo | ( | AOChandle | session, |
| int64_t | requested_frame_number, | ||
| uint32_t * | returned_frame_number, | ||
| uint32_t * | required_buffer_size | ||
| ) |
Get un-decompressed size information on a compressed JPEG frame in the Main Image Buffer (A frame is 256 A-scans, unsynchronized with Image_sync signal).
| session | The opaque handle to the session created with axStartSession(). |
| requested_frame_number | The frame number for which information is desired. This can be a unique frame number or it can be set to -1 to get info on the most recently enqueued frame in the buffer. |
| returned_frame_number | Will be populated with the unique frame number. This will be equal to the "requested_frame_number" parameter unless that parameter is set to -1 to get info on the most recent frame. |
| required_buffer_size | Will be populated with the required size (in bytes) of a user buffer that must be allocated before JPEG retrieval using axRequestCompressedJPEG. |
Get data transfer rate on the active interface.
| session | The opaque handle to the session created with axStartSession(). |
| datarate_Mbps | The estimated data transfer rate for the most recently enqueued image data in in megabits/second. |
| void axGetErrorString | ( | AxErr | errorcode, |
| char * | message_out | ||
| ) |
Get a description of a specific AxErr error code.
| errorcode | An AxErr error code returned from another function in the AxsunOCTCapture API. |
| message_out | A pointer to a pre-allocated output buffer of characters with size at least 512 bytes into which a nul-terminated description for errorcode will be copied. axGetErrorString() can be called at any time; creation of a valid capture session is not required. It is unsafe to pass a message_out output buffer allocated with fewer than 512 bytes. |
| AxErr axGetFrameInfoAdv | ( | AOChandle | session, |
| int64_t | requested_frame_number, | ||
| uint32_t * | returned_frame_number, | ||
| int32_t * | height, | ||
| int32_t * | width, | ||
| AxDataType * | data_type_out, | ||
| uint32_t * | required_buffer_size | ||
| ) |
Get information on a frame in the Main Image Buffer (A frame is 256 A-scans, unsynchronized with Image_sync signal).
| session | The opaque handle to the session created with axStartSession(). |
| requested_frame_number | The frame number for which information is desired. This can be a unique frame number or it can be set to -1 to get info on the most recently enqueued frame in the buffer. |
| returned_frame_number | Will be populated with the unique frame number. This will be equal to the "requested_frame_number" parameter unless that parameter is set to -1 to get info on the most recent frame. |
| height | Will be populated with the height of the requested frame (in pixels). |
| width | Will be populated with the width of the requested frame (in pixels). |
| data_type_out | Will be populated with the data type of the requested frame (see AxDataType enum definition) |
| required_buffer_size | Will be populated with the required size (in bytes) of a user buffer that must be allocated before frame retrieval using axRequestFrameAdv. |
| AxErr axGetImageInfo | ( | AOChandle | session, |
| uint32_t | requested_image, | ||
| image_info_t * | image_info | ||
| ) |
Get information on an image in the Main Image Buffer.
| session | The opaque handle to the session created with axStartSession(). |
| requested_image | The image number for which information is desired. This can be a unique image number > 1, or it can be 0 to get info on the most recently enqueued image in the buffer. |
| image_info | A image_info_t struct which will be populated with information about the requested image. |
| AxErr axGetImageInfoAdv | ( | AOChandle | session, |
| int64_t | requested_image_number, | ||
| uint32_t * | returned_image_number, | ||
| int32_t * | height, | ||
| int32_t * | width, | ||
| AxDataType * | data_type_out, | ||
| uint32_t * | required_buffer_size, | ||
| uint8_t * | force_trig, | ||
| uint8_t * | trig_too_fast | ||
| ) |
(DEPRECATED in v3.4.0) Advanced function for getting information on an image in the Main Image Buffer.
| session | The opaque handle to the session created with axStartSession(). |
| requested_image_number | The image number for which information is desired. This can be a unique image number > 1, or it can be set < 1 to get info on the most recently enqueued image in the buffer. |
| returned_image_number | Will be populated with the unique image number. This will be equal to the "requested_image_number" parameter unless that parameter is set < 1 to get info on the most recent image. |
| height | Will be populated with the height of the requested image (in pixels). |
| width | Will be populated with the width of the requested image (in pixels). |
| data_type_out | Will be populated with the data type of the requested image (see AxDataType enum definition) |
| required_buffer_size | Will be populated with the required size (in bytes) of a user buffer that must be allocated before image retrieval using axRequestImageAdv or axRequestImage. |
| force_trig | Will be populated with 1 if requested image was acquired in Force Trigger mode, or 0 otherwise. See description associated with axSetTrigTimeout function. |
| trig_too_fast | Will be populated with 1 if Image_sync trigger period is too short, or 0 otherwise. |
Get the rate of new images being enqueued in the main image buffer.
| session | The opaque handle to the session created with axStartSession(). |
| images_per_second | The estimated rate for the most recently enqueued image data in images/second. |
| int32_t axGetLibBuildCfg | ( | void | ) |
Get the build configuration of the library.
| int32_t axGetLibBuildDateTime | ( | char * | datetime_str | ) |
Get a string describing the time and date that the library was built.
| datetime_str | A pointer to a pre-allocated output buffer of characters with size at least 100 bytes into which a nul-terminated date & time string will be copied. |
| void axGetLibVersion | ( | int32_t * | major, |
| int32_t * | minor, | ||
| int32_t * | patch, | ||
| int32_t * | build, | ||
| char * | version_str | ||
| ) |
Get the library version.
| major | Version number major element. |
| minor | Version number minor element. |
| patch | Version number patch element. |
| build | Version number build element. |
| version_str | A pointer to a pre-allocated output buffer of characters with size at least 16 bytes into which a nul-terminated version string will be copied. It is unsafe to pass a version_str output buffer allocated with fewer than 16 bytes. |
Get a description of the capture session's interface status.
| session | The opaque handle to the session created with axStartSession(). |
| message_out | A pointer to a pre-allocated buffer of characters with size at least 256 bytes into which a nul-terminated message string will be copied. |
| AxErr axGetStatus | ( | AOChandle | session, |
| uint32_t * | imaging, | ||
| uint32_t * | last_packet_in, | ||
| uint32_t * | last_frame_in, | ||
| uint32_t * | last_image_in, | ||
| uint32_t * | dropped_packets, | ||
| uint32_t * | frames_since_sync | ||
| ) |
Get imaging mode status and Main Image Buffer statistics.
| session | The opaque handle to the session created with axStartSession(). |
| imaging | Interpreted as a bit-field: bit 0 set indicates imaging is active, bit 1 set indicates burst recording is active, bit 2 set indicates loading from disk is active. |
| last_packet_in | Will be populated with the unique packet number most recently enqueued into the Main Image Buffer. |
| last_frame_in | Will be populated with the unique frame number most recently enqueued into the Main Image Buffer. |
| last_image_in | Will be populated with the unique image number most recently enqueued into the Main Image Buffer. |
| droppedPackets | Will be populated with the number of packets dropped since the last imaging mode reset. |
| frames_since_sync | Will be populated with the number of frames enqueued since the last Image_sync pulse was received. When this number reaches the configured trigger timeout, the driver will transition to Force Trigger mode. |
Hide or unhide the OpenGL image display window. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| which_window | Selects which OpenGL window is targeted for this state change. |
| hidden | The desired window visibility state (visible = 0, hidden = 1). |
Control the image streaming behavior of the Axsun PCIe DAQ between Live Imaging, Burst Recording, and Imaging Off states. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| number_of_images | Set this argument to zero (0) for Imaging Off; set it to (-1) for Live Imaging (no record), or set it to any positive value between 1 and 32767 to request the desired number of images in a Burst Record operation. |
Load contents from file on disk into Main Image Buffer.
| session | The opaque handle to the session created with axStartSession(). |
| path_file | Full directory and filename from which to load data. |
| packets_read | Will be populated with the number of packets successfully loaded from disk. |
Load a user-defined AxColormap for images displayed in an OpenGL window. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| user_colormap_in | The colormap array to be loaded. |
| AxErr axPipelineMode | ( | AOChandle | session, |
| AxPipelineMode | mode, | ||
| AxChannelMode | channels | ||
| ) |
Configures FPGA registers to output the desired data type & location from the processing pipeline via the PCIe interface. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| mode | The desired pipeline mode according to the numbered pipeline diagram shown as in the Operator's Manual. |
| channels | The desired channel selection mode (see AxChannelMode enum) |
Read a FPGA register on the Axsun DAQ via the PCIe interface. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| regnum | The unique register number to which the read operation is directed. |
| regval | Will be populated with the register value fetched from the FPGA. |
| AxErr axRegisterDAQCallback | ( | AOChandle | session, |
| AxCallbackFunction_t | callback_function, | ||
| void * | user_data | ||
| ) |
Registers a callback function to be executed upon a change in the DAQ imaging state (e.g. transition to live, record, idle).
| session | The opaque handle to the session created with axStartSession(). |
| callback_function | A user-supplied function to be called. Pass NULL to un-register a callback function. |
| user_data | An arbitrary structure to be made available inside the callback function (or NULL if unused). |
| AxErr axRegisterExportCallback | ( | AOChandle | session, |
| AxCallbackFunction_t | callback_function, | ||
| void * | user_data | ||
| ) |
Registers a callback function to be executed each time an image is exported using axExportImages() or axExportImagesAdv().
| session | The opaque handle to the session created with axStartSession(). |
| callback_function | A user-supplied function to be called. Pass NULL to un-register a callback function. |
| user_data | An arbitrary structure to be made available inside the callback function (or NULL if unused). |
| AxErr axRegisterNewImageCallback | ( | AOChandle | session, |
| AxNewImageCallbackFunction_t | callback_function, | ||
| void * | user_data | ||
| ) |
Registers a callback function to be executed each time a new image is enqueued in the Main Image Buffer, whether captured from DAQ hardware or loaded from disk.
| session | The opaque handle to the session created with axStartSession(). |
| callback_function | A user-supplied function to be called. Pass NULL to un-register a callback function. |
| user_data | An arbitrary structure to be made available inside the callback function (or NULL if unused). |
| AxErr axRegisterScannerConnectCallback | ( | AxConnectScannerCallbackFunction_t | callback_function, |
| void * | userData | ||
| ) |
Registers a callback function to be executed following a scanner (DAQmx) device connection or disconnection event. (WINDOWS ONLY)
| callback_function | A user-supplied function to be called. Pass NULL to un-register a callback function. |
| userData | An arbitrary structure to be made available inside the callback function (or NULL if unused). |
Programmatically executes the pre-registered callback function to indicate the current DAQ imaging state.
| session | The opaque handle to the session created with axStartSession(). |
| AxErr axRequestCompressedJPEG | ( | AOChandle | session, |
| int64_t | requested_frame_number, | ||
| uint8_t * | JPEG_data_out, | ||
| axpacket_t * | metadata_out, | ||
| uint32_t | output_buf_len | ||
| ) |
Retrieve an un-decompressed JPEG frame from the Main Image Buffer (A frame is 256 A-scans, unsynchronized with Image_sync signal).
| session | The opaque handle to the session created with axStartSession(). |
| requested_frame_number | The frame number requested for retrieval. This can be a unique image number or it can be set to -1 to request the most recently enqueued frame in the buffer. |
| JPEG_data_out | A pre-allocated buffer into which the retrieved JPEG frame is copied for subsequent user interaction. Buffer size must be at least as large as indicated by a preceding call to axGetCompressedJPEGInfo ("required_buffer_size"). |
| metadata_out | A pre-allocated buffer of sizeof(axpacket_t) bytes into which frame metadata is copied. |
| output_buf_len | The pre-allocated length in bytes of the JPEG_data_out buffer. |
| AxErr axRequestFrameAdv | ( | AOChandle | session, |
| int64_t | requested_frame_number, | ||
| uint8_t * | frame_data_out, | ||
| axpacket_t * | metadata_out, | ||
| int32_t * | height, | ||
| int32_t * | width, | ||
| AxDataType * | data_type_out, | ||
| uint32_t | output_buf_len | ||
| ) |
Retrieve a frame from the Main Image Buffer (A frame is 256 A-scans, unsynchronized with Image_sync signal).
| session | The opaque handle to the session created with axStartSession(). |
| requested_frame_number | The frame number requested for retrieval. This can be a unique image number or it can be set to -1 to request the most recently enqueued frame in the buffer. |
| frame_data_out | A pre-allocated buffer into which the retrieved frame is copied for subsequent user interaction. Buffer size must be at least as large as indicated by a preceding call to axGetFrameInfoAdv ("required_buffer_size"). |
| metadata_out | A pre-allocated buffer of sizeof(axpacket_t) bytes into which metadata is copied. |
| height | Will be populated with the height of the requested frame (in pixels). |
| width | Will be populated with the width of the requested frame (in pixels). |
| data_type_out | Will be populated with the data type of the requested frame (see AxDataType enum definition) |
| output_buf_len | The pre-allocated length in bytes of the frame_data_out buffer. |
| AxErr axRequestImage | ( | AOChandle | session, |
| uint32_t | requested_image, | ||
| request_prefs_t | prefs, | ||
| uint32_t | output_buf_len, | ||
| uint8_t * | image_data_out, | ||
| image_info_t * | image_info | ||
| ) |
Retrieve and/or display an image from the Main Image Buffer.
| session | The opaque handle to the session created with axStartSession(). |
| requested_image | The image number requested for retrieval or display. This must be a unique image number returned from a prior call to axGetImageInfo(). For the most recently enqueued image in the buffer, use a value < 1 as the requested_image argument in axGetImageInfo(). |
| prefs | A structure containing preferences related to image averaging, request mode, image cropping, and other behaviors. |
| output_buf_len | The size in bytes of the pre-allocated image_data_out buffer. Don't lie, or crashes could ensue. |
| image_data_out | A pre-allocated buffer into which the retrieved image is copied for subsequent user interaction. Buffer size must be at least as large as indicated by a preceding call to axGetImageInfo() or axGetImageInfoAdv() (i.e. the required_buffer_size) unless accomodations are made manually for image cropping or downsampling in the request prefs. |
| image_info | An image_info_t struct which will be populated with information about the retreived and/or displayed image. NOTE: height, width, and size_bytes values may be different from prior call to axGetImageInfo() if the request prefs include cropping or downsampling. |
| AxErr axRequestImageAdv | ( | AOChandle | session, |
| int64_t | requested_image_number, | ||
| uint8_t * | image_data_out, | ||
| axpacket_t * | metadata_out, | ||
| int32_t * | height, | ||
| int32_t * | width, | ||
| AxDataType * | data_type_out, | ||
| uint32_t | output_buf_len, | ||
| request_prefs_t | prefs, | ||
| uint8_t * | force_trig, | ||
| uint8_t * | trig_too_fast | ||
| ) |
(DEPRECATED in v3.4.0) Advanced function for retrieving and/or displaying an image from the Main Image Buffer.
| session | The opaque handle to the session created with axStartSession(). |
| requested_image_number | The image number requested for retrieval and/or display. This can be a unique image number > 1 or it can be set to -1 to request the most recently enqueued image in the buffer. |
| image_data_out | A pre-allocated buffer into which the retrieved image is copied for subsequent user interaction. Buffer size must be at least as large as indicated by a preceding call to axGetImageInfo or axGetImageInfoAdv ("required_buffer_size"). Can be NULL if req_mode parameter is set to DISPLAY_ONLY. |
| metadata_out | A pre-allocated buffer of sizeof(axpacket_t) bytes into which pertinent image metadata is copied. |
| height | Will be populated with the height of the requested image (in pixels). |
| width | Will be populated with the width of the requested image (in pixels). |
| data_type_out | Will be populated with the data type of the requested image (see AxDataType enum definition) |
| output_buf_len | The pre-allocated length in bytes of the image_data_out buffer. Can be 0 if req_mode parameter is set to DISPLAY_ONLY. |
| prefs | A structure containing preferences related to image averaging, request mode, image cropping, and other behaviors. |
| force_trig | Will be populated with 1 if requested image was acquired in Force Trigger mode, or 0 otherwise. See description associated with axSetTrigTimeout function. |
| trig_too_fast | Will be populated with 1 if Image_sync trigger period is too short, or 0 otherwise. |
Clears and resets the Main Image Buffer, optionally with a new buffer size.
| session | The opaque handle to the session created with axStartSession(). |
| capacity_MB | The desired size of the new buffer in MB. A value of 0 resets (clears) the buffer using the previously configured size. |
| AxErr axSaveFile | ( | AOChandle | session, |
| const char * | path_file, | ||
| uint8_t | full_buffer, | ||
| int32_t * | packets_written | ||
| ) |
Save contents of Main Image Buffer to disk.
| session | The opaque handle to the session created with axStartSession(). |
| path_file | Full directory and filename at which to create new save file. |
| full_buffer | Set to 0 for saving only data captured during the most recent imaging sequence (e.g. a burst record) or set to 1 to save the full buffer. |
| packets_written | Will be populated with the number of packets successfully saved to disk. |
| AxErr axScanCmd | ( | AxScannerCommand | scan_command, |
| double | misc_scalar, | ||
| scan_params_t * | scan_parameters, | ||
| ext_pattern_t * | external_scan_pattern, | ||
| void * | RFU | ||
| ) |
Control analog output waveform generation for 2 channel (X-Y) scanners. (WINDOWS ONLY)
| scan_command | The desired scanner function selected from available commands in the AxScannerCommand enum. See below for notes on available scanner commands. |
| misc_scalar | A general purpose scalar value. Valid when scan_command = WAIT_BURST, SET_SAMPLE_CLOCK, GET_DEVICE_SERIALNO, or SELECT_DEVICE. See below for usage. |
| scan_parameters | A structure defining the basic geometry of a rectangular raster scan pattern generated by the library (parameter valid when scan_command = SET_RECT_PATTERN or STOP_AT_POSITION, otherwise set to NULL). |
| external_scan_pattern | A structure defining the user-generated scan pattern and associated arrays to be loaded (parameter valid when scan_command = LOAD_EXT_PATTERN, otherwise set to NULL). |
| RFU | Reserved for future use, set to NULL. |
SETUP and HARDWARE CONNECTIONS:
| FUNCTION | USB-6211 | USB-6343 | USB-6001/6008 | GROUND TYPE |
|---|---|---|---|---|
| X scan waveform output | AO 0 | AO 0 | <n/a> | A GND |
| Y scan waveform output | AO 1 | AO 1 | <n/a> | A GND |
| Auxiliary analog DC output | <n/a> | AO 2 | AO 0 | A GND |
| Image_sync pulse output | PFI 5 | PFI 13 | <n/a> | D GND |
| Ext. sample clock input | PFI 0 | PFI 8 | <n/a> | D GND |
| Square wave output | PFI 4 | PFI 12 | <n/a> | D GND |
| Auxiliary digital output | PFI 6 | PFI 2 | P 1.2 | D GND |
AVAILABLE SCANNER COMMANDS:
axScanCmd(INIT_SCAN, ...) Initialize hardware and allocate scanner control resources. (DEPRECATED)
Scanner control resources are lazy-initialized automatically on the first call to any axScanCmd() command type, so this INIT_SCAN command is no longer needed. Hardware resources are initialized automatically when a supported device is detected (may take up to 10 seconds for device to be recognized after connecting). Use SET_MAX_VOLTAGE command once a device is connected in order to set its maximum voltage limits for analog output waveforms.
axScanCmd(DESTROY_SCAN, ...) Destroy and deallocate scanner control resources.
Resources previously allocated with other axScanCmd(...) function calls are automatically deallocated by axStopSession() when terminating a main Axsun OCT Capture session. Call this command to explicitly deallocate scanner resources if a main capture session was not used.
axScanCmd(SET_RECT_PATTERN, ..., scan_parameters, ...) Use scan_parameters to configure a rectangular raster scan pattern.
The basic geometry defined in the scan_parameters structure is used to generate the active 1D (line) and 2D (raster) scan patterns for subsequent analog output generation, overwriting active scan patterns previously generated with this command or loaded with axScanCmd(LOAD_EXT_PATTERN,...). Contents of the scan_parameters structure are copied internally and the pointer to this structure need not remain valid following return from this command.
axScanCmd(LOAD_EXT_PATTERN, ..., external_scan_pattern, ...) Use external_scan_pattern to load an externally generated scan pattern.
An arbitrary user-generated scan pattern can be loaded for subsequent analog output generation, overwriting active scan patterns previously loaded with this command or generated with axScanCmd(SET_RECT_PATTERN,...). Contents of the external_scan_pattern structure and associated arrays are copied internally and the pointer to this structure and its associated arrays need not remain valid following return from this command.
axScanCmd(CONTINUOUS_LINE_SCAN, ...) Start continuous line scanning based on configured scan pattern.
Starts the analog output generation for the active 1D linear scan, repeating it continuously until commanded otherwise. The Image_sync pulse frequency is derived from the X_increment configured when the active scan pattern was set or loaded.
axScanCmd(CONTINUOUS_RASTER_SCAN, ...) Start continuous raster scanning based on configured scan pattern.
Starts the analog output generation for the active 2D raster scan, repeating it continuously until commanded otherwise. The Image_sync pulse frequency is derived from the X_increment configured when the active scan pattern was set or loaded..
axScanCmd(STOP_AT_POSITION, ..., scan_parameters, ...) Move to a configured position and stop scanning.
Stops the Image_sync pulse and sets a constant (non-scanning) analog output at the voltages given in the X_shift and Y_shift fields of the scan_parameters argument. This command does not alter or overwrite the active scan parameters or patterns previously configured using axScanCmd(SET_RECT_PATTERN,...).
axScanCmd(SETUP_BURST_RASTER, ...) Prepare a burst raster scan by pre-loading buffers and waiting at the start position.
Uploads the active raster scan pattern to device memory and sets a constant analog output at the pattern's initial voltage, but waits to start scanning until a subsequent call to axScanCmd(START_BURST_RASTER,...).
axScanCmd(START_BURST_RASTER, ...) Start a burst raster scan with minimum latency.
Starts analog output and Image_sync pulse generation for a burst raster scan. Must be preceded by a call to axScanCmd(SETUP_BURST_RASTER,...). The raster scan starts with minimal latency and is executed once.
axScanCmd(WAIT_BURST, misc_scalar, ...) Wait for a burst raster scan to complete.
Waits for a burst raster scan operation to compete. The misc_scalar parameter sets the timeout (in seconds) to wait before returning an error. A timeout of -1 waits indefinitely, a timeout of 0 returns immediately with an error if the raster scan is still active or no error if it is complete.
axScanCmd(SET_SAMPLE_CLOCK, misc_scalar, ...) Changes between external and internal sample clock.
The misc_scalar parameter sets the desired sample clock for subsequent analog output generation. The default value of 0 uses the external sample clock from the pin according to the table above, a non-zero value uses a 100 kHz sample clock generated internally by the device. Active scanning operations must be restarted for changes to take effect.
axScanCmd(GET_DEVICE_SERIALNO, misc_scalar, ...) Returns a device serial number (if AxErr return value > 0, type-cast it to int).
A list of N connected devices is maintained internally by the library. The misc_scalar parameter sets the device index (from 0 to N-1) on which to query the device serial number. If the index is higher than N-1, function will return AxErr::DAQMX_DEVICE_NOT_FOUND.
axScanCmd(SELECT_DEVICE, misc_scalar, ...) Selects the active device.
A list of N connected devices is maintained internally by the library. The device occupying the first position (index 0) is considered the "active device" to which other axScanCmd() commands are directed. A positive-valued misc_scalar parameter sets the new "active device" (indexed from 0 to N-1) to be moved into the first position in the list. A negative-valued misc_scalar parameter is interpreted as a device serial number. If a matching device is found, it is set as the "active device" and moved into the first position in the list. If the misc_scalar is higher than N-1, function will return AxErr::DAQMX_DEVICE_NOT_FOUND. If the misc_scalar is less than 0 and the requested device serial number is not found, function will return AxErr::DAQMX_DEVICE_NOT_FOUND.
axScanCmd(COUNT_DEVICES, ...) Returns the number of connected DAQmx devices (if AxErr return value > 0, type-cast it to int).
Counts the number of DAQmx devices currently connected, including both supported and unsupported devices.
axScanCmd(SET_MAX_VOLTAGE, ...) Sets the maximum analog waveform voltage a device is allowed to output.
A device's maximum analog waveform output is set to +/- 10.0 V by default. Use the misc_scalar parameter to set a new maximum value from 0.0 V to 10.0 V on the active device. The minimum voltage will be set to -misc_scalar. This feature is a safeguard against unintentional over-driving of connected scanners; subsequent commands to start scanning will return an error if the programmed scan pattern exceeds the configured voltage limit. This command does not apply to the general purpose DC analog output functionality provided by some devices.
axScanCmd(SET_DIGITAL_OUTPUT, misc_scalar, ...) Controls the general purpose digital output.
Sets the device's general purpose digital output to low/false if misc_scalar = 0 or high/true if misc_scalar = 1.
axScanCmd(SET_SQUAREWAVE_OUTPUT, misc_scalar, ...) Controls the general purpose square wave synthesizer.
Sets the device's general purpose square wave synthesizer to output at a frequency given by misc_scalar in Hz. Use misc_scalar = 0 to turn the squarewave output off.
axScanCmd(SET_XSINE_YRAMP_PATTERN, ..., scan_parameters, ...) Configures a raster scan pattern with sinusoidal waveform on the X dimension and linear ramp waveform on the Y dimension.
Usage is similar to axScanCmd(SET_RECT_PATTERN, ...).
axScanCmd(SET_AUX_DC_ANALOG_OUTPUT, misc_scalar, ...) Controls the general purpose DC analog output voltage.
Sets the device's general purpose DC analog output to a voltage given by misc_scalar in Volts.
axScanCmd(SET_AUX_DC_ANALOG_MAX, misc_scalar, ...) Controls the general purpose DC analog output voltage maximum limit.
Sets the device's maximum general purpose DC analog output to a voltage given by misc_scalar in Volts. This feature is a safeguard against unintentional over-driving of this output terminal; subsequent commands to SET_AUX_DC_ANALOG_OUTPUT will return an error if the requested voltage exceeds the configured limit.
axScanCmd(SET_AUX_DC_ANALOG_MIN, misc_scalar, ...) Controls the general purpose DC analog output voltage minimum limit.
Sets the device's minimum general purpose DC analog output to a voltage given by misc_scalar in Volts. This feature is a safeguard against unintentional over-driving of this output terminal; subsequent commands to SET_AUX_DC_ANALOG_OUTPUT will return an error if the requested voltage exceeds the configured limit.
axScanCmd(GET_DEVICE_MODEL_NUMBER, misc_scalar, ...) Returns a device's numeric model number (if AxErr return value > 0, type-cast it to int).
A list of N connected devices is maintained internally by the library. The misc_scalar parameter sets the device index (from 0 to N-1) on which to query the device model number. If the index is higher than N-1, function will return AxErr::DAQMX_DEVICE_NOT_FOUND.
axScanCmd(SET_XSINE_YSINE_PATTERN, ..., scan_parameters, ...) Configures a raster scan pattern with sinusoidal waveforms on the X and Y dimensions.
Usage is similar to axScanCmd(SET_RECT_PATTERN, ...).
| AxErr axScanConvert | ( | AOChandle | session, |
| int32_t | which_window, | ||
| uint8_t | convert, | ||
| float | inner_radius, | ||
| float | outer_radius, | ||
| float | crop_inner, | ||
| float | crop_outer | ||
| ) |
Change the polar -> rectangular scan conversion behavior of images displayed in an OpenGL window. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| which_window | Selects which OpenGL window is targeted for this behavior change. |
| convert | The desired scan conversion behavior (disabled = 0, enabled = 1). |
| inner_radius | A value on the interval [0..1] which defines the inner edge of the annulus onto which an image's r = 0 data is rendered. (0 = center, 1 = outer edge of uncropped display window) |
| outer_radius | A value on the interval [0..1] which defines the outer edge of the annulus onto which an image's r = Rmax data is rendered. (0 = center, 1 = outer edge of uncropped display window) |
| crop_inner | A value on the interval [-1..1] which defines the fraction of total image cropped prior to scan conversion in the radial direction from r = 0 outward. |
| crop_outer | A value on the interval [0..2] which defines the fraction of total image cropped prior to scan conversion in the radial direction from r = Rmax inward. |
| AxErr axSelectColormap | ( | AOChandle | session, |
| int32_t | which_window, | ||
| AxColormap | colors | ||
| ) |
Select the color scheme of images displayed in an OpenGL window. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| which_window | Selects which OpenGL window is targeted for this style change. |
| colors | The desired color scheme can be SEPIA, grayscale, inverted GREYSCALE, or a user-defined scheme loaded using axLoadUserColormap (see AxColormap enum). |
| AxErr axSelectInterface | ( | AOChandle | session, |
| AxInterface | which_interface | ||
| ) |
Select the data interface (Ethernet, PCIe, or none) for the capture session.
| session | The opaque handle to the session created with axStartSession(). |
| which_interface | The desired interface type to initialize for this session. |
Change the OpenGL display interpolation mode. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| which_window | Selects which OpenGL window is targeted for this mode change. |
| interpolation | The desired interpolation mode (bilinear = 0, nearest neighbor = 1). |
Control the behavior of Force Trigger mode.
| session | The opaque handle to the session created with axStartSession(). |
| framesUntilForceTrig | The number of frames for which the driver will wait for a Image_sync signal before timing out and entering Force Trigger mode. Defaults to 24 frames at session creation. Values outside the range of [2,100] will be automatically coerced into this range. |
| AxErr axSetupDisplay | ( | AOChandle | session, |
| uint8_t | window_style, | ||
| int32_t | w_left, | ||
| int32_t | w_top, | ||
| int32_t | w_width, | ||
| int32_t | w_height, | ||
| uintptr_t | parent_window_handle | ||
| ) |
Setup an OpenGL display window for direct rendering of image data. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| window_style | The window style: either a floating window with border (=0) or a fixed borderless window (=1). |
| w_left | The initial left edge of the window in display coordinates. Also see axUpdateView(). |
| w_top | The initial top edge of the window in display coordinates. Also see axUpdateView(). |
| w_width | The initial width of the window. Also see axUpdateView(). |
| w_height | The initial height of the window. Also see axUpdateView(). |
| parent_window_handle | The window handle (HWND) of an existing window of which the OpenGL window is created as a child window. Set this to 0 for creating an OpenGL window with no parent. |
Start an Axsun DAQ imaging session by allocating memory for the Main Image Buffer.
| session | Pointer to session's opaque handle which will be created by this function and used as an argument for all subsequent function calls specific to this session. |
| capacity_MB | The desired size (in megabytes) to allocate for the Main Image Buffer. |
Stop a capture session and deallocate all resources, including Main Image Buffer and interfaces.
| session | The opaque handle to the session created with axStartSession(). |
| AxErr axUpdateView | ( | AOChandle | session, |
| int32_t | which_window, | ||
| int32_t | w_left, | ||
| int32_t | w_top, | ||
| int32_t | w_width, | ||
| int32_t | w_height | ||
| ) |
Change the OpenGL window size and position. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| which_window | Selects which OpenGL window is targeted for this style change. |
| w_left | The left edge of the window in display coordinates (fixed borderless window only). |
| w_top | The top edge of the window in display coordinates (fixed borderless window only). |
| w_width | The width of the window in pixels. |
| w_height | The height of the window in pixels. |
Change the OpenGL display window style. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| which_window | Selects which OpenGL window is targeted for this style change. |
| window_style | The window style: either a floating window with border(= 0) or a fixed borderless window(= 1). |
Write a FPGA register on the Axsun DAQ via the PCIe interface. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| regnum | The unique register number to which the write operation is directed. |
| regval | The desired 16-bit value to write. |
Write a single bit in an FPGA register on the Axsun DAQ via the PCIe interface. (WINDOWS ONLY)
| session | The opaque handle to the session created with axStartSession(). |
| regnum | The unique register number to which the write operation is directed. |
| bitnum | The bit number within the desired register. The 16 bits in the register are indexed from 0 (LSB) to 15 (MSB). |
| bitval | The value to write (0 = clear bit, 1 = set bit) |
1.8.20