Click or drag to resize

Getting started with the SDK

This topic contains the following sections:

This page shows how to start using the Lyncée Tec Software Development Kit (SDK)

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. In the future, we want to switch to Serilog. Therefore, we recommend that you use Serilog and our help classes in your project, to produce a Serilog log which also includes our legacy log4net log to help debug your work with the API.

See How to redirect log4net log to Serilog for details on how to redirect log4net logs to Serilog

Both log4net and Serilog libraries are available as a NuGet package, which are automatically installed by the main Lyncée Tec packages.

Coding with the SDK

SDK construction and some useful classes

1...

2...

3...

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:

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

  • SimpleExample: basic usage of the libraries, both online (with a connected DHM) and offline (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 package, 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).

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

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

  • LiveReconstructionExampleV2: implementation of a camera live reconstruction flow.