Quick Guide

Install with Zip Package

1. Extract the lpv_sdk_x.x.x.x.zip file to any directory.
2. [Optional] If you don't have Visual C++ Redistributable Package 14 or higher installed on your machine, you may have to download then install one from Microsoft's official website(https://support.microsoft.com/en-us/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0), or our link.
3. You should then manually register the LPV dlls.

Manual Registration

1. RMC the reg_run_as_admin.bat file under the root runner folder, click Run as administrator. It will then register all licensed LPV modules of all platforms(both x86 and x64).
2. Double click to run the check_lpv_module_path.bat file under the root runner folder, it will print out the path of all well-registered LPV modules.

Use the Installer

Download the lpv_x.x.x.x_installer.exe. It's a self-installing archive that includes the LPV binaries and documents. It also helps installing the VC++ Redistributable Package and registering the LPV dlls.

Licensing

Full Version: Use Dongle

1. For Sense dongle, download then install the driver software from the official site or our download link here.
2. Plug in the dongle of LPV. Make sure the key lights up.
3. Open lpvAssistant application under the installed folder or from the start menu shortcut.
4. In Dongles group, switch to View Licenses panel, review license status of all modules.

Trial Version: Use License File

Note: This approach is only for short-term evaluation, you'll be notified when the trial period expired, please contact us or your LPV SDK Tech Support.

1. Open lpvAssistant application under the installed folder or from the start menu shortcut.
2. In Licenses Files group, switch to Activate Licenses panel then click Generate Key File button. It generates a lpv.key file under your selected directory.
3. Send the generated lpv.key file to us or your LPV SDK Tech Support. We will send you back a .lic license file.
4. Click Activate button in the same panel and choose the correct license file.
5. The assistant will test the licenses and pop up "Successfully licensed!" message box if everything works fine.
6. You may review license status of all modules in View Licenses panel.

Legacy

1. Run lpvKeyTool.exe under the installed folder. It generates a lpv.key file on your desktop.
2. Send the generated lpv.key file to us or your LPV SDK Tech Support. We will send you back a .lic license file.
3. You may use any of the following approach to deploy the license file:

• Put the license file under the root runner folder(./runner).
• Put the license file under the user folder(AppData%/LPV).
• Open any demo application, it will pop up the unlicensed warning dialog, click RETRY and upload the license file, we will copy it for you to the right folder.

---

Integration

Add LPV Libraries to Visual Studio Projects

C#

1. RMC your C# project, click "Add Reference"
2. Under COM -> Type Libraries panel, search and find LPVCoreLib (must-have), LPVGeomLib (must-have) and other LPVXXXLibs according to your application, then click OK to add reference (and Interop) to them in your project.
3. In your code, add the line using LPVXXXLib; to start using the LPV classes.
   The following code show a short example:

   // add using.
   using LPVCoreLib;
   using LPVGeomLib;
   using LPVPatLib;
    
   // add definition of @projectname class.
   LMatch m_lmatch = new LMatch();
    
   // call @projectname functions, such as set pattern matching's maximum count, or angle tolerance.
   m_lmatch.MaxCount = 1;
   m_lmatch.AngleTolerance = 180;
    
   // call @projectname functions and handle the returned error code, such as do pattern matching.
   LPVErrorCode errCode = m_lmatch.Match(m_source_img, (LRegion)m_roi, out m_match_results);
   if (errCode != LPVErrorCode.LPVNoError) {}

C++

It's recommended to use Compiler COM Support to directly read LPV modules out and convert it to C++ headers. Then you can use the COM interfaces as classes.

1. Call CoInitializeEx when your program starts and CoUnitialize when it terminates. If you create and host LPV classes in threads, you should also call the two functions when the thread start and finish its job. You should do it before create and initialize LPV classes. For example, for a MFC application, the best place to do this is in InitInstance and ExitInstance, as following:

   BOOL CMFCApp::InitInstance()
   {
       // You may use COINIT_MULTITHREADED or COINIT_APARTMENTTHREADED based on the requirement of your application.
       // For example, use COINIT_APARTMENTTHREADED for MFC application, COINIT_MULTITHREADED for other cases.
       // If you are not sure, read more in https://docs.microsoft.com/en-us/windows/win32/learnwin32/initializing-the-com-library
       CoInitializeEx(NULL, COINIT_APARTMENTTHREADED);
       // etc.
       CWinApp::InitInstance();
   }
   INT CMFCApp::ExitInstance()
   {
       CoUninitialize();
       return CWinApp::ExitInstance();
   }

   Note: For Qt applications which uses QApplication or QGuiApplication, you may omit the CoInitializeEx call since they will initialize COM as STA in their constructor. But for QCoreApplication, it's still required.
2. Use #import directive to incorporate information from LPV libraries, including LPVCoreLib (must-have), LPVGeomLib (must-have) and other required LPVXXXLibs.
   For example, to import LPVCore library:

   // use the include file under "demo/include" folder
   // You may firstly copy "demo/include" folder to your project folder, or add the folder to your project's include path
   #include "LPVCore.h"

   -or-

   // use the file path of the library
   #import "Y:\\runner\\x86\\lpvCore.dll"

   -or-

   // use the progid of one class in the library
   #import "progid:LPV.LImage"

   -or-

   // use the uuid of the library, you can find the id via OLE/COM Object Viewer.
   #import "libid:c34b3e9e-6dea-4aa9-b500-0266f90dc15f"

3. Start using the LPV classes.
   The following code show a short example:

   // import libraries
   #include "LPVCore.h"
   #include "LPVGeom.h"
   #include "LPVPat.h"
    
   // add definition of @projectname class and create the instance
   // the following code defined an ILMatch interface of a LMatch object,
   ILMatchPtr m_lmatch(__uuidof(LMatch));
   // or you can call CreateInstance, as following:
   // ILMatchPtr m_lmatch;
   // do something like initialization of other data members, and later create the instance
   // ...
   // m_lmatch.CreateInstance(__uuidof(LMatch));
    
   // set properties, such as set pattern matching's maximum count, or angle tolerance.
   m_lmatch->MaxCount = 1;
   m_lmatch->AngleTolerance = 180;
       
   // call functions and handle the returned error code, such as do pattern matching.
   LPVErrorCode errCode = m_lmatch->Match(m_source_img, m_roi, &m_match_results);
   if (errCode != LPVErrorCode::LPVNoError) {
       // handle error
   }

Alternatively for Qt applications, you could use Active Qt to generate QAxObject wrappers for LPV classes, please follow the QT's official guide.