Click or drag to resize

Lyncée Tec SDK and API Documentation - v10.0.x

This topic contains the following sections:

This is the documentation for the Lyncée Tec Software Development Kit (SDK) and Application Programming Interface (API)

Version compatibility

This documentation refers to the version 10.0.x of the Lyncée Tec SDK NuGet packages, which work with a Koala database version 108.

Requirements

For development

  • Microsoft Visual Studio 2022 with NuGet Package Manager extension, version 4.5 or above

  • .NET Framework 4.8 or .NET 5.0 (on Windows 10) or .NET 6.0 (on Windows 11)

  • Windows 10 or 11, 64-bit

  • NVIDIA GTX 780 and higher (recommended NVIDIA GeForce GTX 1650) - oldest supported architecture is Kepler with compute capability 3.5

For execution

  • Execution is supported on the computer provided with the DHM, and requires a Koala dongle.

Prior knowledge Requirements

  • Programming in a .NET managed language with Visual Studio and the NuGet Package Manager extension.

  • Using the Lyncée Tec Koala Software and making measures with the Digital Holographic Microscope (DHM).

  • Understanding of the full processing stack to reconstruct a hologram.

SDK and API Content

The Lyncée Tec SDK and API are distributed via 25 nuget packages listed here. The packages without a description aren't directly interesting for the SDK or API user. Please refer to Getting started with the API and Getting started with the SDK for more details on the packages to reference in your project.

  • LynceeTec.API: Entry point for the Lyncée Tec API, with the main functionalities. Setting up the sofware environment and reconstruction work.

  • LynceeTec.API.Cycle: Provides all the functionalities to read and save data using stage automation.

  • LynceeTec.API.Hardware: Provides all hardware-related functionalities, for "online" work (i.e. with a DHM)

  • LynceeTec.API.Sequence: Provides all the functionalities to read and save sequences of holograms (including single holograms, considered as a sequence of one).

  • LynceeTec.API.View3D

  • LynceeTec.CuBlas: Contains 3rd party native libraries necessary for the LynceeTec.Imaging NuGet

  • LynceeTec.CuFFT: Contains 3rd party native libraries necessary for the LynceeTec.Imaging NuGet

  • LynceeTec.CuSolver: Contains 3rd party native libraries necessary for the LynceeTec.Imaging NuGet

  • LynceeTec.DHM: All classes related to hardware control

  • LynceeTec.Eucalyptus: All classes related to database access and management

  • LynceeTec.FilmetricsF40Controller

  • LynceeTec.Imaging: All classes related to images

  • LynceeTec.InterfaceDigitizer: Classes related to the direct control of cameras. SDK users should access the cameras via the LynceeTec.DHM library and DHM objects, API users should access the cameras via the LynceeTec.API.Hardware library.

  • LynceeTec.InterfaceEpos

  • LynceeTec.InterfaceProcessing: Classes for hologram reconstruction, post-processing and result analysis. (Classic version, used by the current version of Koala)

  • LynceeTec.InterfaceProcessingV2: Classes for new hologram reconstruction, post-processing and result analysis. (Will be integrated in our future new software for DHM control)

  • LynceeTec.Interfaces: Interface and other definitions common to all packages

  • LynceeTec.InterfaceStage: Classes related to the direct control of stages (XYZ tables). SDK users should access the stages via the LynceeTec.DHM library and DHM objects, API users should access the stages via the LynceeTec.API.Hardware library.

  • LynceeTec.LogTools: Helper classes for logging and exception messages extraction

  • LynceeTec.StateMachines.IO: Helper classes for the definition and usage of state machines based on the Stateless library

  • LynceeTec.StroboscopicUnits

  • LynceeTec.ToolBox

  • LynceeTec.USBDevices

  • LynceeTec.Utils.Video

  • LynceeTec.WPFTools: Helper classes for programming WPF applications

Where to find the Lyncée Tec NuGet packages and other resources
Other resources

In addition to this documentation and the Software Examples, you can find useful information in:

  • The Lyncée Tec Wiki: http://wiki.lynceetec.com.

  • The Koala Manual which contains an introduction presenting the basics of holography.