$wgGroupPermissions['user']['read'] = true; $wgGroupPermissions['*']['read'] = true; Starts here - Forge Wiki
SCM

Starts here

From Forge Wiki

Jump to: navigation, search
CEP Logo

Contents

Welcome to the CamiTK wiki!

Here you will find all the information you need about CamiTK : how to install it, use it, developp with it and get support.

As a contributor, feel free to edit any page you may want, to update it or simply creating new ones to share your knowledge. For this, you only need to log in (or register if not done yet) on the forge and check our some wiki syntax advises. This site remains your site, and any contribution will help a lot, saving a lot of time to the CamiTK community !

Enjoy!


CamiTK installation

First of all, you need to install the CamiTK framework on your computer. Please select the operating system you are willing to install CamiTK on :

Windows installation
Mac installation
Linux installation


Developers quick starting guide

The bases

CamiTK architecture

CamiTK is a C++ framework composed of a library the core on which are plugged several extensions. Each extension, thanks to the core is interfaced to the others and brings a specific functionnality to the core. 4 types of extensions exist :

  • Components : Represent data in CamiTK on which you work. These data can be an image (volumic or 3D), a specific device (ex : kinect), a robot, a sensor etc.
  • Actions : They stand for one or several Algorithms that you will apply on one or several components
  • Viewers : Are frontend user interfaces that display information of components. For instance, a viewer can be a 3D openGL window to represent a 3D image or a text box which displays DICOM tags.
  • Applications : As in C++, they are the main entry point of your program. Applications provides high level CamiTK funcitonnalities with the Core. Applications mostly feature graphical user interfaces composed of viewers.

When you install CamiTK on your computer, you get the CamiTK core library and also some nice opensource extensions :

  • some components to handle basic image display,
  • some actions to apply basic algorithms on them,
  • some nice viewers to display basic information on them,
  • some nice applications, featuring the different viewers to display components information in graphical user interface, allowing you to interact with your data.

The CamiTK core and all the CamiTK extensions are stored as dynamic libraries fies.

To conclude, using CamiTK is simply the fact of loading the CamiTK core library into your computer memory thanks to a CamiTK application. Then, you load a bunch of extensions (actions and components) to allow you handling data (components) and applying algorithms on them (actions). Those extensions are loaded at runtime (as they are stored as dynamic libraries files).


First steps

When first using CamiTK, you will like to manipulate some extensions (components and actions) through an application. If you did not have yet taken a look at the IMP application discoverty, please do it.

How to develop with CamiTK

Developping with CamiTK will allow you to developp your own extension(s) and work with them. Also, if you wish, you may modify the CamiTK core to feat your needs.

CamITK architecture

CamiTK project organization

Working on my own project

Support

You have an issue regarding using or developping with CamiTK ? Here are the steps to help you solve it :

  • Regarding technical concepts, take a look at the API documentation
  • Check out your problem has not yet been reported (and solved) in the FAQ or by the tips and tricks section. You may use the search engine of the Wiki, in the bottom left hand corner of this page.
  • If you encounter a problem, do not hesitate to ask for help
  • If your issue is a bug, please report it!
  • If you wish a new feature in the future version of CamiTK, please make a request, we'll consider it for the next release!
Powered By FusionForge