/**

\page tutorial-install-win10-msvc15 Tutorial: Installation from source for Windows 10 with Visual C++ 2017 (vc15)
\tableofcontents

In this tutorial you will learn how to install ViSP from source on Windows 10 with Visual C++. These steps have
 been tested on Windows 10 (64 bit), with CMake 3.19.4 and Visual Studio Community 2017.

\note Concerning ViSP installation, we provide also other \ref tutorial.

\section install_win10_msvc15_required Install prerequisites

\subsection install_win10_msvc15_3rd_msvc Visual Studio

Visual Studio Community 2017 could be downloaded from https://www.visualstudio.com/downloads/. During a fresh
installation enable "Desktop development with C++" workload to get "Windows 10 SDK". This SDK allows usage of the
Graphical Device Interface (GDI) useful to display images in a window thanks to vpDisplayGDI class. After a fresh
installation, start Visual Studio and create an empty C++ project to install the common tools for Visual C++ 2017.

If you already have Visual Studio Community 2017, you can check if "Desktop Development with C++" workload is
activated and if "Windows 10 SDK" is enabled following instructions given
<a href="https://docs.microsoft.com/en-us/visualstudio/install/modify-visual-studio?view=vs-2017">here</a> that we resume:

1. Find the Visual Studio Installer on your computer.
Select Start, and then scroll to the letter V, where it's listed as Visual Studio Installer
2. Click or tap to start the installer, and then choose "Modify"
3. From the Workloads screen, check if "Desktop Development with C++" workload is activated and if "Windows 10 SDK"
is enabled like in the following image
\image html img-msvc15-config.png
4. Choose Modify again.
5. After the new workloads and components are installed, choose Launch.

\subsection install_win10_msvc15_3rd_cmake CMake

CMake could be download from http://www.cmake.org. Download the latest release for Windows win64-x64 platform
(at the time this tuto was written it was the file `cmake-3.19.4-win64-x64.msi`). To install just double click
on the msi file.

\subsection install_win10_msvc15_3rd_git Git

Install Git for Windows from https://git-for-windows.github.io/. This installation allows then to use git in a
`cmd` Command Prompt.

\section install_win10_msvc15_ws Create a workspace

If not already done, create a workspace that will contain all ViSP source, build, data set and optional 3rd parties.
This workspace is here set to `C:\visp-ws` folder, but it could be set to any other location.

To create the workspace, open a `cmd` Command Prompt (a fast way to launch this window is to press the Win + R keys
on your keyboard. Then, type `cmd` or `cmd.exe` and press Enter or click/tap OK) and run the following to create
a workspace environment var named `VISP_WS`:
\verbatim
C:\> setx VISP_WS "C:\visp-ws"
C:\> exit
\endverbatim
Open a new `cmd` Command Prompt and create the corresponding folder
\verbatim
C:\> mkdir %VISP_WS%
C:\> exit
\endverbatim

\section install_win10_msvc15_quick Quick ViSP installation

In this section, we give minimal instructions to build ViSP from source just to try ViSP without entering in
\ref install_win10_msvc15_advanced.

- Open a new `cmd` Command Prompt and get ViSP source code in the workspace
\verbatim
C:\> cd %VISP_WS%
C:\> git clone https://github.com/lagadic/visp.git
\endverbatim
- Create a build directory
\verbatim
C:\> mkdir visp-build-vc15
C:\> cd visp-build-vc15
\endverbatim
- Run CMake in build directory (here the generator is chosen for Visual Studio 15 2017 and 64 bits hardware):
\verbatim
C:\> cmake -G "Visual Studio 15 2017" -A "x64" ..\visp
\endverbatim
- Build and install ViSP (installation doesn't need administrator privileges)
\verbatim
C:\> cmake --build . --config Release --target install
\endverbatim
- ViSP is now installed in `%%VISP_WS%\visp-build-vc15\install` folder
- Modify the `Path` var to add `%%VISP_WS%\visp-build-vc15\install\x64\vc15\bin` corresponding to the path to
ViSP libraries. To modify `Path` environment variable do the following:
  - Open the Start Search, type in "env", and choose "Edit environment variables for your account"
  - Click the "Environment Variables..." button
  - Under the "User Variables" section (the upper half), find the row with "Path" in the first column, and click edit
  - The "Edit environment variable" UI will appear.
  - Click "New" button to add a new line with `%%VISP_WS%\visp-build-vc15\install\x64\vc15\bin`

- Set `VISP_DIR` var to help CMake to find ViSP as a 3rd party
\verbatim
C:\> setx VISP_DIR "%VISP_WS%\visp-build-vc15\install"
C:\> exit
\endverbatim

To have a trial, just jump to \ref install_win10_msvc15_dataset before running some binaries that you just build
or jump to \ref install_win10_msvc15_next. You can later come back to the \ref install_win10_msvc15_advanced.

\section install_win10_msvc15_advanced Advanced ViSP installation

\subsection install_win10_msvc15_3rdparty Install 3rd parties

ViSP is interfaced with several 3rd party libraries.
Follow the link to see the complete list of \ref supported-third-parties.
To use optimized matrix operations you may install \ref install_win10_msvc15_3rdparty_eigen.
We recommend also to install \ref install_win10_msvc15_3rdparty_opencv in the workspace. If you have an Intel Realsense
depth camera you may also install \ref install_win10_msvc15_3rdparty_realsense. If your camera is a PointGrey you
may install \ref install_win10_msvc15_3rdparty_flycapture, while if your camera is a Basler, you may rather install
\ref install_win10_msvc15_3rdparty_pylon. If you want to be able to detect a QR code you may install
\ref install_win10_msvc15_3rdparty_zbar. Other 3rd parties are optional and should be considered only by expert developers.

\subsubsection install_win10_msvc15_3rdparty_eigen Eigen3 3rd party

Even if Eigen3 is designed as a template we recommend to install the library with Visual Studio.

<b>1. Get Eigen3</b>

- Download the latest Eigen3 release from http://eigen.tuxfamily.org. At the time this tutorial was
written we downloaded `eigen-3.3.9.zip` archive corresponding to Eigen 3.3.9.
- Extract the content of the archive in `%%VISP_WS%\3rdparty`.
- Once unzipped, you should have Eigen in `%%VISP_WS%\3rdparty\eigen-3.3.9`

<b>2. Build and install Eigen3 from source</b>

- Create a build directory
\verbatim
C:\> cd %VISP_WS%\3rdparty\eigen-3.3.9
C:\> mkdir build-vc15
C:\> cd build-vc15
\endverbatim
- Run CMake in build directory (here the generator is chosen for Visual Studio 15 2017 and 64 bits hardware
and installation folder is set to `%%VISP_WS%\3rdparty\eigen-3.3.9\build-vc15\install` folder):
\verbatim
C:\> cmake -G "Visual Studio 15 2017" -A "x64" .. -DCMAKE_INSTALL_PREFIX=%VISP_WS%\3rdparty\eigen-3.3.9\build-vc15\install
\endverbatim
- Build and install Eigen3 (installation doesn't need administrator privileges)
\verbatim
C:\> cmake --build . --config Release --target install
\endverbatim
- eigen is now installed in `%%VISP_WS%\3rdparty\eigen-3.3.9\build-vc15\install` folder

<b>3. Complete Eigen3 installation</b>

Now you have to complete Eigen3 installation setting some environment vars:
- In order that ViSP detects Eigen3 you have to set `EIGEN_DIR` environment variable. Start up a `cmd` Command Prompt
and enter:
\verbatim
C:\> setx Eigen3_DIR "%VISP_WS%\3rdparty\eigen-3.3.9\build-vc15\install\share\eigen3\cmake"
C:\> exit
\endverbatim
where `%%VISP_WS%\3rdparty\eigen-3.3.9\build-vc15\install` is where you have installed Eigen3. Inside the folder
`%%VISP_WS%\3rdparty\eigen-3.3.9\build-vc15\install\share\eigen3\cmake` you should have a file named `Eigen3Config.cmake`.
- There is no need to set `Path` environment var since Eigen3 is a template that has no library.

\subsubsection install_win10_msvc15_3rdparty_opencv OpenCV 3rd party

<b>1. Get OpenCV</b>

First you have to get OpenCV:
- From https://opencv.org/releases/ download the latest OpenCV for Windows. In our case we got
`opencv-4.5.1-vc14_vc15.exe` Win pack installer. The same procedure could be applied with all the previous
OpenCV releases starting from 3.4.0 version.
- Extract the content of the archive in your workspace `%%VISP_WS%`.
\image html img-win-extract-opencv.jpg
- The installer extract all the material in `%%VISP_WS%\opencv`.
- We strongly recommend to rename this folder to a name that contain OpenCV version like `%%VISP_WS%\3rdparty\opencv-4.5.1`.

\note OpenCV 4.5.1 win pack installer contains prebuild OpenCV libraries build with Visual Studio 14 2015 (vc14)
and Visual Studio 15 2017 (vc15). These libraries are located in `%%VISP_WS%\3rdparty\opencv-4.5.1\build\x64\vc14` and
`%%VISP_WS%\3rdparty\opencv-4.5.1\build\x64\vc15` respectively.

<b>2. Complete OpenCV installation</b>

Now you have to complete OpenCV installation setting some environment vars:
- In order that ViSP detects OpenCV you have to set `OpenCV_DIR` environment variable. Start up a `cmd` Command Prompt
and enter:
\verbatim
C:\> setx OpenCV_DIR "%VISP_WS%\3rdparty\opencv-4.5.1\build"
C:\> exit
\endverbatim
where `%%VISP_WS%\3rdparty\opencv-4.5.1\build` is where you have installed OpenCV. Inside this folder you should have a
file named `OpenCVConfig.cmake`.

- You have also to add the location of OpenCV libraries corresponding to Visual Studio 15 2017 usage in the
`Path` environment variable. Open the "Edit environment variable" UI, and modify `Path` to add a new line with
`%%VISP_WS%\3rdparty\opencv-4.5.1\build\x64\vc15\bin`.

\subsubsection install_win10_msvc15_3rdparty_realsense librealsense 3rd party

I you have an Intel RealSense Depth camera (SR300 or D400 series), you may install librealsense 2.x in order to
use vpRealSense2 class. Otherwise you can skip this section.

<b>1. Install Intel Realsense SDK 2.0</b>

Intel Realsense SDK 2.0 contains librealsense. To install this SDK:
- Go to https://github.com/IntelRealSense/librealsense/releases
- Download `Intel.RealSense.SDK-WIN10-<version>.exe` corresponding to the last Intel Realsense SDK 2.0 release.
At the time this tutorial was written, we downloaded `Intel.RealSense.SDK-WIN10-2.42.0.2845.exe`.
- Execute `Intel.RealSense.SDK-WIN10-<version>.exe` and follow default installation steps.

<b>2. Complete Intel Realsense SDK 2.0 installation</b>

To finalize the installation, add the location of `realsense2.dll` library in the `Path` environment variable.
Open the "Edit environment variable" UI, and modify `Path` to add a new line with
`C:\Program Files (x86)\Intel RealSense SDK 2.0\bin\x64`.

<b>3. Known issue with a CPU that has an old architecture</b>

At the end of the installation process or when running `Intel Realsense Viewer`, if you get the following error message:
\verbatim
Program terminated due to an unrecoverable SEH exception:
Illegal CPU instruction!
Possibly newer CPU architecture is required
\endverbatim

it means that your CPU is too old to support a recent version of the Intel Realsense SDK.
A workaround is to install an older version. In our case installing
`Intel.RealSense.SDK-WIN10-2.32.1.1297.exe` does the trick.

\subsubsection install_win10_msvc15_3rdparty_pcl PCL 3rd party

PCL library could be installed to extend vpRealSense2 capabilities to acquire a point cloud. It could be also used
to consider a point cloud as depth feature in the generic model-based tracker when using vpMbGenericTracker class.
If you don't have an Intel Realsense Depth camera (SR300 or D400 series) or if you are not interested in model-based
tracking using depth as feature you can skip this section.

<b>1. Install PCL from all-in-one installer</b>

There exists in https://github.com/PointCloudLibrary/pcl/releases all-in-one installer that allows to install PCL
and third-parties easily. Be careful to use the version that match your compiler.
For Visual Studio 15 2017:
- Go to https://github.com/PointCloudLibrary/pcl/releases
- From the Assets section, download `PCL-1.9.1-AllInOne-msvc2017-win64.exe`
- Execute `PCL-1.9.1-AllInOne-msvc2017-win64.exe`, add PCL to the system path for all users and follow default
installation steps.
\image html img-pcl-path.png

<b>2. Complete PCL installation</b>

If you experience the following error during installation you need to complete PCL installation. Otherwise you
can skip next instructions.
\image html img-pcl-error-path-to-long.png

To complete PCL installation, add the location of `pcl_common_<debug|release>.dll` and `OpenNI2.dll` libraries
in the `Path` environment variable.
Open the "Edit environment variable" UI, and modify by hand `Path` to add respectively:
- a new line with `C:\Program Files\PCL 1.9.1\bin`
- a new line with `C:\Program Files\OpenNI2\Redist`

<b>3. Known issue with PCL 1.9.1</b>

There is this known issue \ref install_win10_msvc15_issue_pcl_1_9_1. Following the link you will find a workaround.

\subsubsection install_win10_msvc15_3rdparty_flycapture FlyCapture 3rd party

I you have a PointGrey or FLIR USB 2.0, USB 3.0, GigE or FireWire camera (DragonFly2, Flea3...), you may install
FlyCapture. Otherwise you can skip this section.

Complete installation instructions are given [here](https://www.ptgrey.com/KB/10020). We recap hereafter the main
instructions to install FlyCapture SDK under Windows:

- Download the latest FlyCapture2 Full SDK for your camera from Point Grey’s
[download site](https://eu.ptgrey.com/support/downloads). On the download page, select your product family and
"Windows 10 64 bit" as operating system. At the time this tutorial we written we selected
"FlyCapture 2.11.3.164 SDK - Windows (64 bit)" to download `FlyCapture_2.11.3.164_x64.exe` file.
- Double-click the downloaded software executable and follow the installation instructions.
- Select the correct driver for the camera when prompted by the installation instructions.
- Reboot the system.

\subsubsection install_win10_msvc15_3rdparty_pylon Pylon 3rd party

If you have a Basler FireWire, Camera Link, GigE or USB3.0 camera, you may install Pylon SDK. Otherwise you can
skip this section.

To install Pylon:
- Visit [Basler Software Download page](https://www.baslerweb.com/en/support/downloads/software-downloads/)
to download and install the SDK corresponding to your platform. At the time
this tutorial was written, we downloaded "Pylon 6.1.1 Camera Software Suite Windows".
\note If during the SDK installation you retrieve an installation error like the following:
\verbatim
We're sorry, but the installation could not be completed.
The following error has occurred:
Error code: 0x800700005, Refused Access
\endverbatim
it means certainly that there is an application that needs access to Internet that is not closed. Typically,
we encounter this issue with our Anti-Virus Kaspersky tool. Once Kaspersky was paused, installation succeed.
- Be careful to select "Developer" profile during the installation in order to install Pylon SDK headers (.h)
besides the dll.
\image html img-win10-pylon-developer.png
- Click then on "Next" button.
- Select how your Basler camera is connected to the computer (USB, GigE, FireWire, Camera Link), then click on
"Next" button.
- Keep the default destination folder as `C:\Program Files\Basler\pylon 5\` and click on "Next" button
- In the "Ready to install" panel, click on the "Install" button
- Reboot the system.

\subsubsection install_win10_msvc15_3rdparty_ueye IDS uEye 3rd party

If you have an [IDS](https://en.ids-imaging.com/) camera you may install IDS Software Suite for uEye cameras. To this end:
- enter the [download area](https://en.ids-imaging.com/downloads.html)
- select `"uEye industrial cameras"`
- in the `"Firmware"` tab, select `"uEye (IDS Software Suite)"` and press `"SHOW"` button
- in the `"Operating system"` tab select `"Windows"` and press the search button
- in the `"Software package"` section you should see the last `"IDS Software Suite - Full installer"` version you may download.
  At the time this tutorial was written, we downloaded `"ids-software-suite-full-64-49400.zip"` file.

Once downloaded, you may extract the archive.

Open the README file `readme-ids-software-suite-win-*.html` and check compatibility list
\verbatim
IDS Software Suite has been tested with the following Windows 10 version:
- Edition: Windows 10 Pro
    Version: 1909
    Version: 2004
\endverbatim

If the Software Suite is compatible with your OS, proceed to the installation:
- Double-click on the extracted file (in our case `uEye64_49400_WHQL.exe` to start the installation.
  The uEye driver installation is menu-driven.
- Keep default configuration and proceed to the installation.

To test the Software Suite installation, plug a camera, enter `"Start"` menu and run `"IDS > uEyeDirectShow Demo"` binary.

IDS uEye Camera Software Suite installation enables vpUeyeGrabber class usage.

\subsubsection install_win10_msvc15_3rdparty_zbar zbar 3rd party

If you want to work with QR codes (see \ref tutorial-detection-barcode), we recommend to install zbar 3rd party.
Otherwise you can skip this section.
\note Since ViSP 3.1.0 we provide also AprilTag detection capabilities that are available without 3rd party
installation (see \ref tutorial-detection-apriltag).

To install zbar you need to build the library from source. There is a fork of the library available from GitHub
(<a href="https://github.com/dani4/ZBarWin64">https://github.com/dani4/ZBarWin64</a>) and adapted for compiling
under Visual following the steps:

<b>1. Get zbar</b>

- Get ZBarWin64 source code from <a href="https://github.com/dani4/ZBarWin64">Github repository</a>. To this
end open a `cmd` Command Prompt and hit:
\verbatim
C:\> cd %VISP_WS%
C:\> git clone https://github.com/dani4/ZBarWin64
\endverbatim

<b>2. Build zbar from source</b>
- Then open `%%VISP_WS%\ZBarWin64\zbar64.sln` solution file with Visual Studio C++
- Select `"Release"` and `"x64"` configuration. Then to build zbar library enter menu `"Build > Build Solution"`
or hit "Ctrl+Shift+B".
\image html img-win10-msvc15-zbar-build.png

<b>3. Complete zbar installation</b>
- To complete the installation, set `ZBAR_DIR` environment variable:
\verbatim
C:\> setx ZBAR_DIR "%VISP_WS%\ZBarWin64"
C:\> exit
\endverbatim
- You have also to add the location of zbar and iconv libraries in the `Path` environment variable. Open the
"Edit environment variable" UI, and modify `Path` to add 2 new lines, one with `%%VISP_WS%\ZBarWin64\x64\Release`,
another with `%%VISP_WS%\ZBarWin64\zbar\libiconv\dll_x64`.

\subsubsection install_win10_msvc15_3rdparty_jaco Kinova Jaco 3rd party

If you have a
[Kinova Jaco](https://www.kinovarobotics.com/en/products/assistive-technologies/kinova-jaco-assistive-robotic-arm)
assistive robotic arm, it could be useful to install the corresponding SDK to be able to use vpRobotKinova class.
This class is an interface over Kinova Jaco SDK and allows to control
Gen2 4, 6 and 7 DoF [arm](https://www.kinovarobotics.com/en/resources/gen2-technical-resources).

<b>1. Install Kinova Jaco SDK</b>

- [Download](https://www.kinovarobotics.com/en/resources/gen2-technical-resources) the SDK.
At the time this tutorial was written, we downloaded SDK 1.5.1 that comes in `PS 0000 0009_1.5.1.zip` (254M).
- Extract the zip content in a temporary folder like `C:\temp\kinova-jaco`
- At this step you should have the following
\verbatim
C:\> dir C:\temp\kinova-jaco\windows
17/12/2018  21:48         6 234 383 Kinova-Jaco-Usb-Driver-(usblib)-Installer.exe
30/01/2019  00:02               207 ReadMe.txt
29/01/2019  23:58        64 658 780 SDK_GEN2_1_5_1_x86.exe
09/08/2017  21:38        13 767 776 vc_redist_x86.exe
\endverbatim
- Install the SDK executing `SDK_GEN2_1_5_1_x86.exe`. Keep default installation options.
- After installation, the SDK is available in `C:\Program Files (x86)\JACO-SDK`

There is no need to complete installation process as for previous 3rd parties.

\subsection install_win10_msvc15_get_source Get ViSP source code

There are different ways to get ViSP source code.

- You can download the <a href="https://visp.inria.fr/download">latest release</a> as a zip or a tarball.
Once `visp-x.y.z.tar.gz` or `visp-x.y.z.zip` is downloaded, uncompress the file in `%%VISP_WS%\visp\visp-x.y.z`
using for example <a href="http://www.win-rar.com">WinRAR</a>.

- You can also download a <a href="https://visp.inria.fr/download#snapshot">daily snapshot</a>. Once
`visp-snapshot-yyyy-mm-dd.tar.gz` is downloaded, uncompress the file in `%%VISP_WS%\visp\visp-x.y.z`
using for example <a href="http://www.win-rar.com">WinRAR</a>.

- Or you get the cutting-edge ViSP from <a href="https://github.com/lagadic/visp">GitHub repository</a>
using the `git` command line tool:
\verbatim
C:\> cd %VISP_WS%
C:\> git clone https://github.com/lagadic/visp.git
\endverbatim

We suppose now that ViSP source is in `%%VISP_WS%\visp`.

\subsection install_win10_msvc15_config Configure ViSP from source

The goal of the configuration step is now to use CMake to produce a Visual Studio C++ solution file that
will be located in `%%VISP_WS%/visp-build-vc15`.

- Launch CMake (cmake-gui) and complete the source code and binaries location as in the next image.
\image html img-cmake-win10-msvc15-visp-launch.png
- Click then on "Configure" button.
\image html img-cmake-win10-msvc15-visp-create-folder.png
- Click on "Yes" to create the `%%VISP_WS%/visp-build-vc15` folder.
- Select then your compiler "Visual Studio 15 2017", select "x64" as optional platform for generator and
click on "Finish" button.
\image html img-cmake-win10-msvc15-msvc-version.png
- This will start CMake configuration. As shown in the next image, Eigen3, Flycapture, GDI (Graphical Device Interface),
OpenCV,  OpenMP, Pylon, Realsense2 and Zbar 3rd parties are automatically detected.
\image html img-cmake-win10-msvc15-visp-config.png
\note Installation folder is set to `%%VISP_WS%/visp-build-vc15/install`. If you want to change the installation
folder to `C:\Program Files (x86)\ViSP`, make sure that you have administrator privileges to write in that folder
before modifying `CMAKE_INSTALL_PREFIX`.
\warning If you forgot to set `Eigen3_DIR` environment var, you will get the following warning in `cmake_gui`:
\verbatim
CMake Warning at CMakeLists.txt:1156 (message):
  Eigen3 config file is detected in C:/visp-ws/eigen-3.3.9/build-vc15.  Using
  C:/visp-ws/eigen-3.3.9/build-vc15/Eigen3Config.cmake doesn't allow to use a
  valid Eigen3 include dir: C://include/eigen3.  Modify Eigen3_DIR to point
  to Eigen3Config.cmake file located in Eigen3 installation folder or turn
  USE_EIGEN3 OFF.
\endverbatim We strongly recommend to fix this warning. To this end:
    - close `cmake-gui`
    - set `Eigen3_DIR` environment var running `setx Eigen3_DIR "%VISP_WS%\3rdparty\eigen-3.3.9\build-vc15\install\share\eigen3\cmake"`
    - open again `cmake-gui`
    - delete the cache using menu `File > Delete Cache`
    - and configure again ViSP.
	.
    At this point, you should no more see the warning.

- Click then on "Configure" button. All the red lines should disappear.
\image html img-cmake-win10-msvc15-visp-config2.png
\note The default configuration lead to the creation of a shared library (with `.dll` extension). This is the default
configuration that is recommended. If you want to create rather a static library (with `.lib` extension) you have
to uncheck the `BUILD_SHARED_LIBS` option to disable DLL creation.

- To finish the configuration, click on "Generate" button.
\image html img-cmake-win10-msvc15-visp-generate.png

- Once the generation is done, in `%%VISP_WS%/visp-build-vc15` folder you have the Visual Studio `VISP.sln`
generated solution file.

\subsection install_win10_msvc15_build Build and install ViSP libraries

- To build ViSP just double click on `%%VISP_WS%/visp-build-vc15/VISP.sln` solution file. This action will
open ViSP project in Visual Studio C++. By default, Visual Studio opens the solution in `Debug` configuration.
Modify the configuration to `"Release"`.
\image html img-win10-msvc15-visp-open.png

- Enter menu `"Build > Build Solution"` to build ViSP or hit "Ctrl+Shift+B".

- At the end of the build process you should have the following indicating that all the build succeeded.
\image html img-win10-msvc15-visp-build-end.png

- Now to install ViSP, build `"INSTALL"` project. To this end, apply a left click on `"INSTALL"` to select the
project, then a right click to enter in the "Build" menu.
\image html img-win10-msvc15-visp-install.png

- At the end of the installation, you should have the following.
\image html img-win10-msvc15-visp-install-end.png

- As shown in the previous image, all the headers but also the generated libraries are copied in
`%%VISP_WS\visp-build-vc15\install` folder; headers and libraries in `include` and `x64/vc15` subfolders respectively.

- This ends ViSP installation in `"Release"` configuration. Now in `%%VISP_WS%/visp-build-vc15/install/x64/vc15/bin`
folder you have ViSP DLL libraries corresponding to ViSP modules.
\image html img-win10-msvc15-visp-explorer-install.png

- Note that you can also build ViSP in `Debug` configuration. In that case, all the library names are suffixed by
"d" character (`libvisp_core320d.dll`...).

\subsection install_win10_msvc15_build_visp_doc Build ViSP documentation

To build ViSP documentation, you have first to install [Doxygen](http://www.doxygen.nl):
- [Download](http://www.doxygen.nl/download.html) binary distribution for Windows. At the time this tutorial
was written, we downloaded `doxygen-1.8.20-setup.exe`
- Run the installer following default options
- Open a new `cmd` Command Prompt and enter build directory
\verbatim
C:\> cd %VISP_WS%\visp-build-vc15
\endverbatim
- Run CMake in build directory:
\verbatim
C:\> cmake -G "Visual Studio 15 2017" -A "x64" %VISP_WS%\visp
\endverbatim
- Build documentation using:
\verbatim
C:\> cmake --build . --config Release --target visp_doc
\endverbatim

The generated documentation is then available in `$VISP_WS/visp-build-vc16/doc/html/index.html`

\note
- To speed up generating online doc, particularly around formula rendering, you can use
[MatJax](https://www.mathjax.org). To this end, install first `npm` LTS version following these
[instructions](https://www.npmjs.com/get-npm), then install MathJax and build doc using:
\verbatim
C:\> npm install mathjax
C:\> cmake -G "Visual Studio 15 2017" -A "x64" %VISP_WS%\visp -DUSE_MATHJAX=ON
C:\> cmake --build . --config Release --target visp_doc
\endverbatim

- It is also possible to generate a more complete documentation that includes also all the
internal classes. This could be achieved setting CMake var `ENABLE_FULL_DOC` to `ON` like:
\verbatim
C:\> cmake -G "Visual Studio 15 2017" -A "x64" %VISP_WS%\visp -DENABLE_FULL_DOC=ON
C:\> cmake --build . --config Release --target visp_doc
\endverbatim

\subsection install_win10_msvc15_env_var Set Path environment var

Modify the `Path` var to add the path to ViSP dll libraries. To this end open the "Edit environment variable" UI,
and modify `Path` to add a new line with `%%VISP_WS%\visp-build-vc15\install\x64\vc15\bin`.

\subsection install_win10_msvc15_visp_dir Set VISP_DIR environment var

In order to ease ViSP detection by CMake when ViSP is used as a 3rd party in an external project, like the one
described in the \ref tutorial-getting-started, you may set `VISP_DIR` environment variable with the path to
the `VISPConfig.cmake` file:
\verbatim
C:\> setx VISP_DIR "%VISP_WS%\visp-build-vc15\install"
C:\> exit
\endverbatim

\section install_win10_msvc15_dataset Install ViSP data set

Some ViSP examples and tests require a data set that contains images, video, models that is not part of ViSP
source code. This data set is available in Github (https://github.com/lagadic/visp-images) or as a release in
a separate archive named `visp-images-x.y.z.zip`. This archive could be downloaded from
 https://visp.inria.fr/download page. Note that ViSP tutorials are not using ViSP data set.

We give hereafter the two ways to get this data set:

<b>1. Get data set release</b>

- Download `visp-images-3.6.0.zip` from https://visp.inria.fr/download and uncompress it in your workspace `%%VISP_WS%`.
\image html  img-win-visp-images-git.jpg
- Once downloaded, you need to set `VISP_INPUT_IMAGE_PATH` environment variable to help ViSP examples and tests
to detect automatically the location of the requested data. In our case, this variable should be set to
`%%VISP_WS%\visp-images-3.6.0`. Open a `cmd` Command Prompt and run
\verbatim
C:\> setx VISP_INPUT_IMAGE_PATH %VISP_WS%\visp-images-3.6.0
C:\> exit
\endverbatim

<b>2. Get data set from github</b>

- Use git to get the data set latest version:
\verbatim
C:\> cd %VISP_WS%
C:\> git clone https://github.com/lagadic/visp-images.git
\endverbatim
\image html img-win-visp-images-last-release.jpg
- Once cloned, you need to set `VISP_INPUT_IMAGE_PATH` environment variable to help ViSP examples and tests
to detect automatically the location of the requested data. In our case, this variable should be set to
`%%VISP_WS%\visp-images`. Open a `cmd` Command Prompt and run
\verbatim
C:\> setx VISP_INPUT_IMAGE_PATH %VISP_WS%\visp-images
C:\> exit
\endverbatim

<b>Test data set usage</b>

From now, you can try to run ViSP examples and tests. For example, if you want to run
`%%VISP_WS%\visp-build-vc15\example\device\display\Release\displayGDI.exe`, open a `cmd` Command Prompt,
enter in the right folder and run:
\verbatim
C:\> cd %VISP_WS%\visp-build-vc15\example\device\display\Release
C:\> displayGDI.exe

A click to close the windows...

A click to display a cross...
Cross position: 392, 306

A click to exit the program...
Bye
\endverbatim

\section install_msvc15_tips Tips and tricks

\subsection install_msvc15_tips_new_3rdparty How to take into account a newly installed 3rd party

Since all 3rd parties are optional you may have started to install only some of them. Imagine that you just
installed a new third-party, or that you upgraded the version of this 3rd party. The next step is to go back
to the build folder, configure ViSP with CMake to detect the newly installed third-party library and build
again ViSP. This could be achieved with:
\verbatim
$ cd $VISP_WS/visp-build-msvc15
$ cmake ../visp
\endverbatim

Here you can check the content of the `ViSP-third-party.txt` file and see if the newly installed 3rd party is well detected.

Finally, you need to rebuild and install ViSP with:
\verbatim
$ cmake --build . --config Release --target install
\endverbatim

\subsection install_msvc15_tips_uninstall How to uninstall ViSP
After ViSP installation, you can remove installed material using:
\verbatim
$ cd $VISP_WS/visp-build-msvc15
$ cmake --build . --config Release --target uninstall
\endverbatim

\subsection install_msvc15_tips_modules How to build only ViSP libraries

If you want to build only ViSP modules libraries, nor the examples, tutorials and tests:
\verbatim
$ cd $VISP_WS/visp-build-msvc15
$ cmake --build . --config Release --target visp_modules
\endverbatim

\subsection install_msvc15_tips_module_once How to build a ViSP specific module

If you want to build a given module and all the dependencies:
\verbatim
$ cd $VISP_WS/visp-build-msvc15
$ cmake --build . --config Release --target visp_<module_name>
\endverbatim

For example to build the model-based tracker module named mbt, run:
\verbatim
$ cd $VISP_WS/visp-build-msvc15
$ cmake --build . --config Release --target visp_mbt
\endverbatim

\subsection install_msvc15_tips_3rd_party Which are the 3rd party libraries that are used in ViSP ?

To see which are the optional 3rd parties that are found during the configuration stage and that will be
used by ViSP during the build you can have a look to the text file named `ViSP-third-party.txt` and located
in `$VISP_WS/visp-build`. We provide hereafter an example of a possible content of this file that contains
also build info.
\verbatim
$ type $VISP_WS/visp-build-vc15/ViSP-third-party.txt
==========================================================
General configuration information for ViSP 3.3.1

  Version control:               3.2.0-1384-ge2d49ab-dirty

  Platform:
    Timestamp:                   2021-02-16T07:42:21Z
    Host:                        Windows 10.0.17134 AMD64
    CMake:                       3.19.4
    CMake generator:             Visual Studio 15 2017
    CMake build tool:            C:/Program Files (x86)/Microsoft Visual Studio/2017/Community/MSBuild/15.0/Bin/MSBuild.exe
    MSVC:                        1910

  C/C++:
    Built as dynamic libs?:      yes
    C++ Compiler:                C:/Program Files (x86)/Microsoft Visual Studio/2017/Community/VC/Tools/MSVC/14.10.25017/bin/HostX86/x64/cl.exe  (ver 19.10.25017.0)
    C++ flags (Release):         /DWIN32 /D_WINDOWS /W3 /GR /EHsc  /MP4   /EHa -openmp -std=c++11 /Gy /bigobj /MD /O2 /Ob2 /DNDEBUG
    C++ flags (Debug):           /DWIN32 /D_WINDOWS /W3 /GR /EHsc  /MP4   /EHa -openmp -std=c++11 /Gy /bigobj /MDd /Zi /Ob0 /Od /RTC1
    C Compiler:                  C:/Program Files (x86)/Microsoft Visual Studio/2017/Community/VC/Tools/MSVC/14.10.25017/bin/HostX86/x64/cl.exe
    C flags (Release):           /DWIN32 /D_WINDOWS /W3    /MP4   /EHa -openmp -std=c++11 /MD /O2 /Ob2 /DNDEBUG
    C flags (Debug):             /DWIN32 /D_WINDOWS /W3    /MP4   /EHa -openmp -std=c++11 /MDd /Zi /Ob0 /Od /RTC1
    Linker flags (Release):      /machine:x64  /INCREMENTAL:NO
    Linker flags (Debug):        /machine:x64  /debug /INCREMENTAL /ignore:4099

  ViSP modules:
    To be built:                 core gui imgproc io java_bindings_generator klt me sensor ar blob robot visual_features vs vision detection mbt tt tt_mi
    Disabled:                    -
    Disabled by dependency:      -
    Unavailable:                 java

  Windows RT support:            no

  Python (for build):            C:/Users/fspindle/AppData/Local/Programs/Python/Python37-32/python.exe

  Java:
    ant:                         NO
    JNI:                         C:/Program Files/Java/jdk-11.0.4/include C:/Program Files/Java/jdk-11.0.4/include/win32 C:/Program Files/Java/jdk-11.0.4/include

  Build options:
    Build deprecated:            yes
    Build with moment combine:   no

  Mathematics:
    Blas/Lapack:                 yes
    \- Use MKL:                  no
    \- Use OpenBLAS:             no
    \- Use Atlas:                no
    \- Use Netlib:               no
    \- Use GSL:                  no
    \- Use Lapack (built-in):    yes (ver 3.2.1)
    Use Eigen3:                  yes (ver 3.3.9)
    Use OpenCV:                  yes (ver 4.5.1)

  Simulator:
    Ogre simulator:
    \- Use Ogre3D:               no
    \- Use OIS:                  no
    Coin simulator:
    \- Use Coin3D:               no
    \- Use SoWin:                no
    \- Use SoXt:                 no
    \- Use SoQt:                 no
    \- Use Qt5:                  no
    \- Use Qt4:                  no
    \- Use Qt3:                  no

  Media I/O:
    Use JPEG:                    no
    Use PNG:                     no
    \- Use ZLIB:                 no
    Use OpenCV:                  yes (ver 4.5.1)
    Use stb_image (built-in):    no

  Real robots:
    Use Afma4:                   no
    Use Afma6:                   no
    Use Franka:                  no
    Use Viper650:                no
    Use Viper850:                no
    Use Kinova Jaco:             yes
    Use aria (Pioneer):          no
    Use PTU46:                   no
    Use Biclops PTU:             no
    Use Flir PTU SDK:            no
    Use Parrot ARSDK:            no
    \-Use ffmpeg:                no
    Use Virtuose:                no
    Use qbdevice (built-in):     yes (ver 2.6.0)
    Use takktile2 (built-in):    no

  GUI:
    Use X11:                     no
    Use GTK:                     no
    Use OpenCV:                  yes (ver 4.5.1)
    Use GDI:                     yes
    Use Direct3D:                no

  Cameras:
    Use DC1394-2.x:              no
    Use CMU 1394:                no
    Use V4L2:                    no
    Use directshow:              no
    Use OpenCV:                  yes (ver 4.5.1)
    Use FLIR Flycapture:         yes
    Use Basler Pylon:            no
    Use IDS uEye:                yes (ver 4.94.0)

  RGB-D sensors:
    Use Realsense:               no
    Use Realsense2:              yes (ver 2.32.1)
    Use Kinect:                  no
    \- Use libfreenect:          no
    \- Use libusb-1:             no
    \- Use pthread:              no
    Use PCL:                     yes (ver 1.9.1)
    \- Use VTK:                  yes (ver 8.1.2)

  F/T sensors:
    Use atidaq (built-in):       no
    Use comedi:                  no
    Use IIT SDK:                 no

  Detection:
    Use zbar:                    yes (ver 0.10.1)
    Use dmtx:                    no
    Use AprilTag (built-in):     yes (ver 3.1.1)
    \- Use AprilTag big family:  no

  Misc:
    Use Clipper (built-in):      yes (ver 6.4.2)
    Use pugixml (built-in):      yes (ver 1.9.0)
    Use libxml2:                 no

  Optimization:
    Use OpenMP:                  yes
    Use pthread:                 no
    Use pthread (built-in):      yes (ver 3.0.1)
    Use cxx standard:            11

  Documentation:
    Use doxygen:                 yes

  Tests and samples:
    Use catch2 (built-in):       yes (ver 2.9.2)
    Tests:                       yes
    Demos:                       yes
    Examples:                    yes
    Tutorials:                   yes

  Install path:                  C:/visp-ws/visp-build-vc15/install

==========================================================
\endverbatim

\subsection install_win10_msvc15_issue_pcl_1_9_1 CMake configuration fails with PCL 1.9.1-AllInOne-msvc2017-win64

If you install PCL 1.9.1, you may encounter the following issue when configuring ViSP with cmake:

\verbatim
CMake Error at C:/Program Files/PCL 1.9.1/cmake/PCLConfig.cmake:359 (pcl_report_not_found):
  cmake_policy POP without matching PUSH
Call Stack (most recent call first):
  C:/Program Files/PCL 1.9.1/cmake/PCLConfig.cmake:539 (find_external_library)
  cmake/VISPUtils.cmake:527 (find_package)
  CMakeLists.txt:605 (VP_OPTION)


CMake Error in C:/Program Files/PCL 1.9.1/cmake/PCLConfig.cmake:
  cmake_policy PUSH without matching POP
Call Stack (most recent call first):
  cmake/VISPUtils.cmake:527 (find_package)
  CMakeLists.txt:605 (VP_OPTION)
\endverbatim

A workaround is to modify `C:/Program Files/PCL 1.9.1/cmake/PCLConfig.cmake` by removing
policy push/pop as described in this PCL [PR #3431](https://github.com/PointCloudLibrary/pcl/pull/3431/files).

\subsection install_win10_msvc15_issue_librealsense_cpu_too_old librealsense installer returns an unrecoverable SEH exception

At the end of the `Intel Realsense SDK` installation process or when running `Intel Realsense Viewer`,
if you get the following error message:
\verbatim
Program terminated due to an unrecoverable SEH exception:
Illegal CPU instruction!
Possibly newer CPU architecture is required
\endverbatim

it means that your CPU is too old to support a recent version of the Intel Realsense SDK.
A workaround is to install an older version. In our case installing
`Intel.RealSense.SDK-WIN10-2.32.1.1297.exe` does the trick.

\section install_win10_msvc15_next Next tutorial

You are now ready to see the next \ref tutorial-getting-started that will show you how to use ViSP as a 3rd party
to build your own project.

*/