Installation

Table of Contents

• Package installation
• License registration
• Installation for C++ usage
  • Requirements
• Installation for Python usage
  • Requirements
  • Manual installation
    • With administrative privileges
    • Without administrative privileges
    • Handling multiple python versions
• Work with IPSDK within Avizo
  • Installation for usage within Avizo
  • Use IPSDK within Avizo
• Work with IPSDK within DragonFly
• Installation for usage within DragonFly
  • Use IPSDK within DragonFly

Package installation

Installation process will require the following data :

• the IPSDK library installer IPSDK_ToolKit_4_1_0_2_gcc_linux_x64.tar.gz
• a IPSDK license file (file with extent '.rlf')

Please extract the archive file IPSDK_ToolKit_4_1_0_2_gcc_linux_x64.tar.gz.
Once done you will have to process to licence file registration (see next section).

License registration

Once IPSDK Library installed, you will have to register your license in order to use the library.

License file can be registred for :

• all users and so allows all users to work with IPSDK library. This will requires administrator rights.
• only current user. In this case no administrator rights are requested but only current user will be allowed to work with IPSDK library.

Steps for license registration :

• Start IPSDK Library license registration tool by running RegisterIPSDKLicense_4_1_0_2_x64 (in $InstallDir/bin/Release_linux_x64 directory).
  (This application requires administrative privileges if you wish to register library for all users)
• Fill the path of license file provided with your purchase order or with your evaluation request.
• Select your installation option ("all users" or "current user only")
• Click the "OK" button
  

If you encounter any problem during this step, please contact our support team (see Information requests and support).

Installation for C++ usage

Requirements

To deal with IPSDK Library, you will need the following software installed on your computer :

• CMake 3.13.0 or later
• gcc 5.1 or later
• Optionally Eclipse platform (this is not a requirement)

Installation for Python usage

Requirements

To be able to execute IPSDK Python scripts, you will have to install python (version 3.8, 3.9, 3.10) on your computer. Python package can be downloaded from :

• Anaconda package which is a complete python package including numerous popular Python packages (this is our recommanded package).
• Python official web site which provides basic Python installers.

Manual installation

If needed you can proceed to manual IPSDK python wrapping installation.

Note that this is a lightweight installation since it only creates a directory which contains links to IPSDK library installation location.

With administrative privileges

This registration process will hold for python executable with which script has been executed.

To do this you just have to execute python script included in your IPSDK installation : '$IPSDKInstallDir/python/install/setup.py' :

python $IPSDKInstallDir/python/install/setup.py

Warning

Please verify that you have administrative rights before executing this command.

Without administrative privileges

If you do not have administrative privileges or if you want a user local installation you can specify a custom installation directory, $PyIPSDKCustomInstallDir in the following, as first argument when calling installation script :

python $IPSDKInstallDir/python/install/setup.py $PyIPSDKCustomInstallDir

Note that in this case, you will have to setup environment variable PYTHONPATH before trying to execute python code using PyIPSDK :

export PYTHONPATH=$PyIPSDKCustomInstallDir
python my_script_using_PyIPSDK.py

Handling multiple python versions

If you have multiple python installation, such as multiple python versions or additional specific products with embedded python (see Installation for usage within Avizo or Installation for usage within DragonFly), you can simply repeat previous process for each python executable.

Work with IPSDK within Avizo

Installation for usage within Avizo

Installation of IPSDK bridge with Avizo software can simply be done executing installation script '$IPSDKInstallDir/python/install/setup.py' (see Manual installation) using python embedded executable which can be found in python subdirectory of your Avizo installation directory.

This operation can be done via a terminal with following command :

'$AvizoInstallDir/python/python' '$IPSDKInstallDir/python/install/setup.py'

If you need to install IPSDK bridge without administrative privileges, please see Without administrative privileges.

Use IPSDK within Avizo

Once the installation done, simply start Avizo software and then open the Main Python Console (from 'Window' menu).

Importing IPSDK Library will be done using the following :

import PyIPSDK

Given an already opened input Avizo image named for example 'grain.am', associated IPSDK image can be retrieve doing :

ipsdkInputImage = PyIPSDK.fromAvizo("grain.am")

Once the IPSDK image retrieved, the user can process it using Image processing algorithms and then add a new Avizo image doing :

PyIPSDK.toAvizo(ipsdkOutputImage, "ipsdk_image")

The following code illustrates the computation of X gradient from an input Avizo image :

# import of IPSDK library
import PyIPSDK
import PyIPSDK.IPSDKIPLFiltering as filter

# retrieve input image from Avizo
ipsdkInputImage = PyIPSDK.fromAvizo("grain.am")

# compute X gradient of input image
ipsdkOutputImage = filter.gaussianXGradient2dImg(ipsdkInputImage, 1.5)

# add filtered image to Avizo
PyIPSDK.toAvizo(ipsdkOutputImage, "ipsdk_image")

Note

Avizo is a trademark of VSG, Visualization Sciences Group

Work with IPSDK within DragonFly

Installation for usage within DragonFly

Installation of IPSDK bridge with DragonFly software can simply be done executing installation script '$IPSDKInstallDir/python/install/setup.py' (see Manual installation) using python embedded executable which can be found in Anaconda3/bin subdirectory of your DragonFly installation directory.

This operation can be done via a terminal with following command :

'$DragonFlyInstallDir/python/python' '$IPSDKInstallDir/python/install/setup.py'

If you need to install IPSDK bridge without administrative privileges, please see Without administrative privileges.

Use IPSDK within DragonFly

Once installation done, simply start DragonFly software and then open the Python Console (from 'Tools' menu).

Importing IPSDK Library will be done using the following :

import PyIPSDK

Given an already opened input DragonFly image named for example 'walnut', associated IPSDK image can be retrieve doing :

ipsdkInputImage = PyIPSDK.fromDragonFly("walnut")

Once IPSDK image retrieved user can process it using Image processing algorithms and then publish a new DragonFly image doing :

PyIPSDK.toDragonFly(ipsdkOutputImage, "ipsdk_image")

The following code illustrate the computation of X gradient from an input DragonFly image :

# import of IPSDK library
import PyIPSDK
import PyIPSDK.IPSDKIPLFiltering as filter

# retrieve input image from DragonFly
ipsdkInputImage = PyIPSDK.fromDragonFly("walnut")

# compute X gradient of input image
ipsdkOutputImage = filter.gaussianXGradient2dImg(ipsdkInputImage, 1.5)

# add filtered image to DragonFly
PyIPSDK.toDragonFly(ipsdkOutputImage, "ipsdk_image")

Note

DragonFly is a trademark of ORS, Object Research Systems