Migration guides on CamiTK

Migration guide from CamiTK 3.x to CamiTK 4.0

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

This page explains how to modify your CamiTK 3.x code to work on the 4.x version. The CamiTK team tried to do its best to make sure that there are not a lot of changes to make to your CEP source code. Here it a complete step by step.

Prerequisite

First of all, make sure you have compiled and installed CamiTK 4.0 or up on your computer. Please follow the setup guide of this wiki.

Migration guide from CamiTK 4.0 to CamiTK 4.1

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

The main objective of the CamiTK 4.0 was to ensure that CamiTK will stay up to date with its basic dependencies. Qt4, VTK5 and CMake version 2 became obsolete. CamiTK 4.0 had therefore to ensure compatibility with Qt5, VTK6 and CMake version 3.

CamiTK 4.1 is the first stable release of the 4.x family. It removes all the 3.x deprecated methods and clean up a lot of obsolete Core library API methods.

Migration guide from CamiTK 4.1 to CamiTK 5.0

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

CamiTK 5 fixes a lot of bugs (see the Release Notes) and introduces one big new feature: the viewer extension (ability to define plugins that provides new viewers, see the viewer extension documentation for more information). Viewer extensions are now a first class type of extension, and are as easy to create and integrate as action and component extensions. They also makes applications easier to build and test.

The methods in the Component class that used a pointer to a Viewer in the previous versions of CamiTK are now using a QString to name the required viewer. This ensures safety and modularity to access a specific viewer (e.g., to manage the case where the corresponding viewer extension is not currently loaded).

Migration guide from CamiTK 5.0 to CamiTK 5.2

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

CamiTK 5.2 fixes a lot of bugs (see the Release Notes) and introduces one big new feature: the viewer extension (ability to define plugins that provides new viewers, see the viewer extension documentation for more information). Viewer extensions are now a first class type of extension, and are as easy to create and integrate as action and component extensions. They also makes applications easier to build and test.

Migration guide from CamiTK 5.2 to CamiTK 6.0

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

Frames and geometrical Transformations

If your extension manages frames of components and geometrical transformations between them, you will need to port your code to the new framework.

Here is a short preview:

Previously, components had a Component::get/setParentFrame() and a transformation to it that you could set using Component::setTransform() and other helper functions.
Now Frames and Transformations are managed by the TransformationManager (see API), so that multiple components can use the same frame.
When you load or create a MeshComponent, a new Frame is created for it.
When you load an ImageComponent, it comes with three frames: the Data Frame (were the voxels are defined), the main Frame (which is usually the coordinates system of the imaging machine, e.g. CT scanner) and an arbitrary frame to manage the position and orientation of the arbitrary slice that CamiTK can display.
Ownership: you need to be careful about the ownership of Frames and Transformations: When you use frames and transformation to process coordinates, you do not need to own the Frames and Transformations. This is why Component::getFrame(), ImageComponent::getDataFrame() return raw, non owning pointer.
If you really need ownership of a Frame, usually because you want to set the Frame of a new Component, you can either use myNewMesh->setFrameFrom(myOldMesh), or the more explicit myNewMesh->setFrame( TransformationManager::getFrameOwnership(myOldMesh->getFrame()) )
If your extension creates a new Component, please set its Frame in a logical way: if the data is expressed in the same Frame as the input component, just set the Frame of your output component to the Frame of the input Component
If you know the transformation between two Components, you can add a Transformation between their Frames using TransformationManager::addTransformation

New extensions

You should use DevStudio to create new extensions instead of the wizard. The code will be simpler, and Python extensions are supported as well.