Getting Started in C++

Table of Contents

• Create a new workspace
• Create a new project
• Generate your environment development workspace

This page describe first steps that user should follow to use IPSDK as C++ third party.

Create a new workspace

Once license registration proceeded, you will be able to create a new workspace to use IPSDK Library :

• run IPSDK Library wizard IPSDKComponentWizard_4_1_0_2_x64 (in $InstallDir/bin/Release_linux_x64 directory).
• Double-click on "Create a Workspace" item
• Select an empty directory as workspace root directory (we will refer to it as cmake_workspace_root_dir throughout the rest of the document).
• Fill the New Workspace Wizard settings pages :
  • Fields with red background when empty or with a label ending with a red star are mandatory
  • On first time, user can check 'Include IPSDK sample applications projects" to populate its workspace and to get started with library usage (provided samples have been installed). - Click on "Finish" button. A summary window should appear, indicating that the workspace was successfully created.

Create a new project

Once the root directory of a valid existing workspace has been selected in IPSDK Library wizard (corresponding field appears in green in the UI, see snapshot below), new features are available. The first one that should interest you is the "New Project" one; let's consider that we want to create a project that will generate an executable file:

• Double-click on "Create a standard Exe project"
• Select the parent directory that will contain the new project directory (here, in this example, we put it directly in cmake_workspace_root_dir/src directory), and click "Next"
• Fill the different fields in the new displayed window:
  • "Project name": name of the new C++ project
  • "Author name" and "Company name": name of the author and of the company that will appear in the header comments of the source code files
  • "Accessibility": choose "Public" if you intend to give access to the header files for the user of your product, choose "Private" otherwise
  • "Namespace(s)": default namespace(s) associated to the C++ project
  • "Use Qt library": check this box if you plan to link your project to Qt libraries
  • "Use boost libraries": select the boost libraries to which you want your project to link
    - "Use IPSDK libraries": select the IPSDK libraries to which you want your project to link
• Click "Finish"; then the wizard generates the new project in a dedicated folder, named with the name of the project. This project will contain, among others, a file CMakeLists.txt describing the C++ project for CMake, a file main.cpp and other source and header utility files.

Generate your environment development workspace

Once you have generated a new CMake workspace containing IPSDK sample projects and your first own project, it's time to generate the workspace dedicated to your environment development. For that:

• make sure that CMake 3.0 or later is installed on your machine
• create a new directory (this new directory must not be contained in cmake_workspace_root_dir mentioned in section create a new workspace) , for instance "$HOME/TestIPSDK_tmp". This directory will contain the files and directories generated by CMake for the selected compiler. Note: we will refer to this new directory with the name cmake_workspace_tmp_output_directory throughout the rest of the document
• run application cmake-gui (on Windows, it's usually located in directory <CMake_install_dir>/bin)
• fill the edit box "Where is the source code" with the path cmake_workspace_root_directory
  • configure your workspace for debug configuration as follows:
    • fill the edit box "Where to build the binaries" with path cmake_workspace_tmp_output_directory/Debug
    • press button "Configure". If this is the first time you configure the workspace for Debug configuration, you will be asked to select the targeted compiler. Choose for example "Eclipse CDT4 - Unix Makefiles". Once the workspace is configured for the first time, update the field "CMAKE_BUILD_TYPE" with the value "Debug" and press button "Configure" again
      - press button "Generate"
      
  • configure your workspace for release configuration as follows:
    • fill the edit box "Where to build the binaries" with path cmake_workspace_tmp_output_directory/Release
    • press button "Configure". If this is the first time you configure the workspace for Release configuration, you will be asked to select the targeted compiler. Choose for example "Eclipse CDT4 - Unix Makefiles". Once the workspace is configured for the first time, update the field "CMAKE_BUILD_TYPE" with the value "Release" and press button "Configure" again
    • press button "Generate"
• once this is done, you can find the workspace file generated for your environment development in the folders cmake_workspace_tmp_output_directory/Debug or cmake_workspace_tmp_output_directory/Release, depending on the wanted configuration.
• for instance, here is what you should observe by opening the generated cmake_workspace_tmp_output_directory/Debug project if you generated your workspace for Eclipse:

As you can see, inside the new generated solution, there are sub projects associated to each IPSDK sample and to your own first application project. You can now easily build associated binaries in your environment development. First build INSTALL project, so that all the external libraries on which your projects depend are correctly installed.

Now you are ready to enrich your first program based on IPSDK. We recommend you to start by reproducing the code of the IPSDK sample projects in your own first project, and to read in parallel the associated IPSDK c++ sample applications documentation.

You should then consult the Image processing algorithms documentation to start with other algorithms.