Architecture & Interface Background
Hardware-Software Interfaces
The Ethernet/PCIe DAQ board (EDAQ) has multiple hardware-software interface options to provide system architecture flexibility for the integrator.
Two distinct software interfaces between the EDAQ hardware and the host PC software are utilized, generally referred to as the Control interface and the Capture interface:
Control Interface
The Control interface is low-bandwidth, bidirectional, and consists of command & control, diagnostics, configuration, and status messaging between the EDAQ hardware and host software. It is also used for updating firmware on the EDAQ board. The Control Interface is also used for command & control messaging with the Laser Engine board and Camera Link DAQ board.
Capture Interface
The Capture interface is high-bandwidth, unidirectional* (from EDAQ to host only), and consists of the OCT image data stream generated by the EDAQ and transmitted to the host software for subsequent display, analysis, and archival by the user. The Capture Interface is relevant to the Ethernet/PCIe DAQ only (not the Laser Engine or Camera Link DAQ).
* NOTE: the Capture interface does also provide some low-bandwidth bidirectional control functionality (i.e. register R/W) for DAQs connected via PCIe.
Physical Interfaces
There are also several physical interfaces supported between the EDAQ hardware and host PC, including USB 2.0, Gigabit Ethernet, USB 3.0 [1], and PCI-Express (PCIe). For the Axsun Integrated Engine configuration, a RS-232 interface directly between the EDAQ and the Laser Engine board provides a convenient pass-thru of laser messages via this serial connection when the EDAQ is connected to the host via Ethernet/USB 3.0.
The Control and Capture software interfaces are supported on the EDAQ’s physical interfaces according to the following matrix:
USB 2.0
Gigabit Ethernet
(USB 3.0 via dongle)
PCIe
Capture Interface
(image stream from DAQ)
NO
YES
YES
Capture Interface
(DAQ commands & status)
NO
NO
YES
(Register R/W)
Control Interface
(DAQ commands & status)
YES
YES
NO
Control Interface
(to Laser via DAQ pass-thru)
NO
(need USB to Laser)
YES
NO
[1] All Ethernet functionality described in this manual is also supported over USB 3.0 via a separate Ethernet-to-USB 3.0 converter based on the Realtek RTL8153 chipset. For example: https://www.amazon.com/Anker-Portable-Aluminum-Ethernet-Supporting/dp/B00PC0H9IE
Software Libraries
The Capture and Control software interfaces are decomposed into separate Windows OS dynamic link libraries: AxsunOCTControl.dll , AxsunOCTControl_LW.dll and AxsunOCTCapture.dll (or *.so for corresponding Linux OS shared object or *.dylib for corresponding MacOS shared object).
Axsun provides basic GUI tools for exercising the functionality provided in the Capture and Control libraries, as well as APIs and sample code for each of the libraries for system integrators to develop custom client applications based on these libraries.
This multi-library software architecture is convenient in the API integration phase of custom software development because it allows the integrator to debug new code based on one library while relying on an Axsun-provided GUI tool to exercise functionality in the other library. Once new code has been developed at the module level for both libraries separately, final integration of these modules into a single application can be achieved with more confidence and less debugging complexity.
A summary of the Capture and Control library characteristics is provided in the following table:
Primary Functionality
Capture image stream from EDAQ, enqueue in host RAM, return to user on request for display or archival, PCIe imaging control
Control DAQ imaging mode and settings, control laser emission on/off
Control DAQ imaging mode and settings, control laser emission on/off
Secondary Functionality
OpenGL rendering of images including polar scan conversion (Windows only), save/load images to disk, galvo scanner waveform programming
Update firmware, perform diagnostics, control optional motorized variable delay line (VDL)
Control optional motorized variable delay line (VDL)
3rd-Party Dependencies
(free, open-source)
pcap (Ethernet only),
TurboJPEG, OpenCV (optional), PCIe Device Drivers (PCIe only)
Microsoft .NET,
LibUSBDotNet
libusb
Library Interface
ANSI C
Managed C#
(or C++ via COM)
ANSI C
OS Support
Windows 10/11, Linux
Windows 7 or 10/11
Windows 10/11, Linux
Axsun GUI Tools
Sample Code Available
LabVIEW, C/C++
LabVIEW, C#, C++
LabVIEW, C/C++
Supported Physical Interfaces
Ethernet / USB 3.0,
PCIe
Ethernet / USB 3.0,
USB 2.0,
RS-232 (to laser)
Ethernet / USB 3.0, USB 2.0,
RS-232 (to laser)
Architecture
64-bit x86
32- or 64-bit x86
64-bit x86
Library Name
AxsunOCTCapture (.dll, .so)
AxsunOCTControl.dll
AxsunOCTControl_LW (.dll, .so)
*** WARNING: Do not open multiple instances of AxsunOCTControl or AxsunOCTControl_LW at the same time, either via the Axsun-supplied GUI tools or via custom applications interfaced with these libraries.
Hardware Architecture
The Axsun EDAQ employs both a small microcontroller and a large FPGA processor. The microcontroller is responsible for managing bidirectional communications with the host PC via the AxsunOCTControl/Control_LW interface and with a connected Laser Engine board, for loading its own program and the FPGA program at power-on, for managing non-volatile configuration settings, and for providing USB 2.0 I/O. The FPGA is responsible for computationally intensive tasks such as OCT image formation (Fourier transformation, compression, etc.) and also provides the Gigabit Ethernet and PCIe I/O.
The integration strategy for systems based on the EDAQ will likely depend on whether Ethernet or PCIe is the preferred method for transmitting high-bandwidth image data for the specific application. The Ethernet-based implementation is more straightforward from the perspective of cable interconnects and is easier to achieve a high degree of portability, especially if physical separation between the DAQ and the host PC is required and if JPEG image compression is tolerable. The PCIe-based implementation requires close proximity between the DAQ and the host PC (unless optical Thunderbolt cables are used), but supports data transfer of raw, partially-processed, or fully-processed data without lossy compression at full A-line rates.
The following block diagrams show basic Ethernet, USB, and PCIe interconnections for the EDAQ and associated Laser Engine board in the Axsun Integrated Engine, along with the software libraries which utilize these interfaces:
For a PC with USB 3.0 but without RJ-45 connectivity and a built-in network adapter, use a GigE-to-USB 3.0 converter dongle instead.
GUI Tools
The AxsunOCTCapture and AxsunOCTControl/Control_LW APIs enable users to integrate library functionality in custom executables for application-specific workflows and requirements. Axsun also provides several Windows-based GUI Tools for exercising basic library functionality without the need for custom software development.
NOTE: The GUI Tools provided by Axsun are not intended to be fully-featured or to support complex workflows for all OCT imaging applications, but are helpful for engineering tasks such as:
optical integration and OCT image optimization,
understanding the features and capabilities of the Axsun hardware,
exercising API functions using simple button presses,
verifying successful installation of software dependencies,
debugging during custom software development,
configuration of power-on defaults, and
firmware upgrades, diagnostics, or other field service maintenance.
NOTE: Representations and descriptions of the user interfaces shown in this reference manual and other online documentation may not match precisely with the specific GUI Tool version installed on your system. However, the basic functionality available through these tools is consistent across all versions.
NOTE: LabVIEW-based GUI Tools are displayed correctly when the Windows text size is set at 100%, otherwise button labels and other text may not be properly rendered on all systems:
Image Capture Tool
The Image Capture Tool (AxsunImageCaptureTool.exe) or "ICT" is a LabVIEW-based application which exemplifies the core functionality provided by the AxsunOCTCapture library, including live image display, on-demand image retrieval by unique image number, indication of the EDAQ’s imaging mode, Image_sync trigger status, and main image buffer statistics.
Secondary functionality includes controls for the direct OpenGL rendering features, real-time image averaging, image cropping, saving & loading, and some FPGA register access (PCIe interface only).
Hardware Control Tool
The Hardware Control Tool (AxsunHardwareControlTool.exe) or "HWCT" is a LabVIEW-based application that provides push-button operation for many of the basic functions of the EDAQ and laser via the AxsunOCTControl/Control_LW libraries, including the indication of hardware connectivity, toggling laser emission on/off, toggling Ethernet DAQ imaging mode on/off, starting a burst record operation, adjusting the K-clock delay, and controlling a motorized variable delay line or aiming laser (if installed).
High-level DAQ functionality (achieved via scripted low-level FPGA register writes) is provided on separate tabs and includes setting power-on defaults, programming a user-defined windowing function, polarization channel selection, dispersion compensation, background subtraction, and raw data / bypass mode configuration.
OCT Host
OCT Host (OCTHost.exe) is a Windows Forms-based GUI that provides a subset of the features of the Hardware Control Tool (also via the AxsunOCTControl library), including toggling laser emission on/off, indicating hardware connectivity state, adjusting the K-clock delay, and controlling a motorized variable delay line (if installed). OCT Host also provides more advanced laser diagnostics, maintenance, and debugging information, as well as system firmware upgrade capabilities. EDAQ functionally in OCT Host is limited to low-level operations such as FPGA register reading/writing and setting power-on defaults in non-volatile RAM.
WARNING: The OCT Host and Hardware Control Tool applications must not both be running concurrently; the EDAQ microprocessor will not support Ethernet communication with multiple instances of the AxsunOCTControl/Control_LW library at the same time. If multiple instances are accidentally established, a full application and EDAQ hardware restart is recommended for deterministic communication.
Summary of GUI Tools
The following table summarizes some of the characteristics and functionality of the Axsun-provided GUI Tools:
Axsun API Library Dependency
Other Dependencies
MS .NET
LabVIEW Run-Time
LabVIEW Run-Time
Physical Interfaces
USB 2.0, Ethernet,
RS-232
USB 2.0, Ethernet,
RS-232
Ethernet, PCIe
Capture & Display OCT Images
-
-
YES
Save & Load Captured Images
-
-
YES
Control & Query Laser Emission
YES
YES
-
Adjust K-clock Delay
YES
YES
-
Update Firmware
YES
-
-
Diagnostic Readout
(Field Service & Debug)
YES
-
-
FPGA Register R/W
YES
YES
via PCIe only
High-Level DAQ Functions
-
YES
limited; via PCIe only
Set Power-On Defaults
YES
YES
-
Control Motorized VDL
YES
YES
-
FPGA Image Processing Pipeline
Analog-to-Digital Conversion
Windowing and Zero-Padding
Fourier Transformation, Complex Modulus, and Polarization Mixer
Logarithmic Compression and Dynamic Range Reduction
For dynamic-range reduction (16- to 8-bit), a user-configurable GAIN and OFFSET is applied to scale and shift the output values appropriately prior to truncation of the lowest byte. This is analogous to a Brightness/Contrast or White-level/Black-level adjustment. The result is an 8-bit power spectrum appropriate for display:
JPEG Compression (Ethernet interface only)
JPEG compression with a quality factor of 30 results in average bandwidth reduction of approximately 3x on the transmitted OCT intensity image. Although JPEG compression is lossy, this compression ratio provides qualitatively equivalent images as the non-compressed mode and is typically sufficient for image analysis by the naked-eye. Users applying advanced quantitative image processing algorithms such as automated classification or texture analysis should investigate the effects of logarithmic, dynamic range, and JPEG compression on an individual basis and consider using the PCIe interface if access to non-compressed data is required.
Last updated