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

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

For development

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

• .NET Framework 4.8 or .NET 5.0

• Windows 10, 64-bit

• NVIDIA GTX 645 and higher (recommended NVIDIA GeForce GTX 1050 Ti, 4GB) - oldest supported architecture is Kepler

For execution

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

• 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.

The Lyncée Tec SDK and API are distributed via 19 nuget packages listed here.

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

• 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.DHM: All classes related to hardware control

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

• LynceeTec.Imaging: All classes related to images

• LynceeTec.InterfaceDigitizer

• 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

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

• LynceeTec.Sequence.IO

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

• LynceeTec.ToolBox

• LynceeTec.USBDevices

• LynceeTec.Utils.Video

• LynceeTec.WPFTools: Helper classes for programming WPF applications

• The nuget packages are hosted on a server requiring authentification:

  • Direct link https://scrat.lynceetec.com/feeds/lynceetec,

  • NuGet Package Manager link https://scrat.lynceetec.com/nuget/lynceetec/.

  Please contact sdk-support@lynceetec.com for any question regarding access to this server.

• This documentation is available online: http://scrat.lynceetec.com/documentation.

• The main software examples are distributed at the purchase of the SDK/API.

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.