Python Extensions

Mon, 01 Jan 0001 00:00:00 +0000

Develop Python Extensions for CamiTK

Use Python to create Actions, Components, or Viewers with CamiTK’s Python API.

Getting Started with Python Extensions

Python extensions are ideal for rapid prototyping, machine learning integration, and scripting. DevStudio generates a Python file for each action for you to complete.

Steps to Create a Python Extension:

Open DevStudio from the CamiTK menu.
Define your extension's name, package requirements (if any), parameters, and input components.
DevStudio generates the boilerplate code: a .py for each action for you to edit and a .camitk containing the metadata of your extension.
As shown in the devstudio video click on Initialize to generate the boilerplate code for first time and then on Register to integrate it in CamiTK (it will then be automatically available in the corresponding Action menu).
Complete the process function in the generated Python file.

Python Action code template

When DevStudio generates the template code of an action, you will find four functions in the corresponding Python file. Some Python code is generated when DevStudio creates your action to show you an example of what is expected (see devstudio video). It is now up to you to modify the four functions/methods:

C++ Extensions

Mon, 01 Jan 0001 00:00:00 +0000

Develop C++ Extensions for CamiTK

Use C++ for high-performance extensions, such as computationally intensive tasks.

Getting Started with C++ Extensions

C++ extensions are ideal for performance-critical tasks. DevStudio generates all the files required to add your extension into CamiTK.

Steps to Create a C++ Extension:

Open DevStudio from the CamiTK menu.
Define your extension's name, parameters, and input components.
Choose between Hotplug or Standard extension types.
DevStudio generates the boilerplate code: one C++ files per action for you to complete, a .camitk file containing the metadata of your extension, and a CMakeLists.txt ready to build your code.
As shown in the devstudio video click on Initialize to automatically build your extension for the first time and then on Register to integrate it in CamiTK (it will then be automatically available in the corresponding Action menu).
Complete the generated C++ classes and rebuild to modify your extension.

C++ Action code template

When DevStudio generates the template code of an action, it generates a class derived from CamiTK Action in the corresponding .cpp files (the header file is generated, if you need to add fields to your class use the DevStudio UI or edit the .camitk directly). There are four methods you will need to complete. Some C++ code is generated when DevStudio creates your action for the first time to show you an example of what is expected. It is now up to you to modify the four methods:

Extension Developer Guide on CamiTK