Click or drag to resize

Lyncée Tec SDK Documentation - v8.2.x

This topic contains the following sections:

This is the documentation for the Lyncée Tec Software Development Kit

Version compatibility

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

SDK Requirements

For development

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

  • .NET 4.5.2

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

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 Content

The Lyncée Tec SDK is distributed via 13 nuget packages listed here.

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

  • LynceeTec.DHM: All classes related to hardware control

  • 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.ThirdPartyLibraries: External dependencies needed in the reconstruction process

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

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

  • LynceeTec.Sequence.IO

  • LynceeTec.ToolBox

  • LynceeTec.InterfaceEpos

  • LynceeTec.USBDevices

  • LynceeTec.InterfaceDigitizer

  • LynceeTec.InterfaceStage

  • LynceeTec.Utils.Video

Where to find the SDK and other resources
Using the SDK

To setup a new project:

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

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

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

    • Mono.CSharp

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

SDK Examples

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

Examples using the classic reconstruction method with InterfaceProcessing

Examples using the standard reconstruction method (InterfaceProcessing package), as in the current version of Koala:

  • SimpleExample: basic usage of the libraries, both online (with a connected DHM) and offline (using previously recorded holograms).

  • SimpleExampleOffline: basic usage of the libraries, showing the streamlined initialization for offline use only (using previously recorded holograms).

  • ProcessingExample: parametrization of the hologram reconstruction.

  • ReferenceHologramExample: usage of user-defined reference holograms.

  • NonMeasuredPointsDetectionExample: usage of the non-measured points detection tools.

  • TemporalAverageExamples: usage of the temporal phase average tool.

  • Other application-specific programs, if available.

Examples using the new reconstruction method with InterfaceProcessingV2

The new InterfaceProcessingV2 library must be used in a totally different manner than the original one. The following examples are provided to guide the developer.

Caution note Caution

The InterfaceProcessingV2, which implements the new reconstruction, is still in development and must be considered a beta.

(See also the What changed? Version 8.1 to 8.2 page of this documentation for details).

  • SimpleExampleV2: basic usage of the libraries, both online (with a connected DHM) and offline (using previously recorded holograms).

  • SimpleExampleOfflineV2: basic usage of the libraries, for reconstruction only (offline, no DHM connected).

  • LiveReconstructionExampleV2: implementation of a camera live reconstruction flow.

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.