Lyncée Tec SDK Documentation

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

For development

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

• .NET 4.5.2

• Windows 10, 64-bit

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 is distributed via 10 nuget packages listed here. For most application, the SDK user will only interact with the first 3 of the list (DHM, Processing and Interfaces).

• LynceeTec.DHM: All classes related to hardware control

• LynceeTec.Processing: Classes for hologram reconstruction, post-processing and result analysis

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

• LynceeTec.Sequence.IO

• LynceeTec.ToolBox

• LynceeTec.Epos

• LynceeTec.USBDevices

• LynceeTec.DigitizerInterface

• LynceeTec.StageInterface

• LynceeTec.Utils.Video

In addition, some third party native libraries are distributed as a download on our server.

• 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 .zip with the native libraries can be downloaded from the documentation main page: http://scrat.lynceetec.com/documentation.

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

To setup a new project:

• Add the packages LynceeTec.DHM, LynceeTec.Sequence.IO and LynceeTec.Processing to your project. The other required Lyncée Tec and third party packages will be referenced automatically.

• Make sure you copy the native dependencies from the build folder of each package in your output directory.

• Make sure you copy the additional third party native libraries in your output directory.

• Remove the unnecessary references to the following libraries from your project:

  • EntityFramework.SqlServer (correct your app.config accordingly)

  • Mono.CSharp

Tip
Lyncée Tec libraries use log4net for logging. We recommend that you set up a log4net log in your project to help debug your work with the SDK. The log4net library is available as a nuget package, which is automatically installed by the main Lyncée Tec packages.

Lyncée Tec provides sample programs to show how to use the SDK.

• SimpleExample: basic usage of the libraries.

• ProcessingExample: parametrization of the hologram reconstruction.

• ReferenceHologramExample: usage of user-defined reference holograms.

• Other application-specific programs, if available.

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.