RTK/Users: Difference between revisions

From Openrtk
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:


== What is RTK? ==
== What is RTK? ==
RTK is an open source C++ library, not an executable. This means that you must write code that uses RTK and compile it before you will obtain something that you can run and get a result from. It also means that you can adapt or extend RTK to address your problem at hand. To facilitate this over multiple operating systems, compilers, and system configurations, RTK itself must be built from its source code. The three steps to starting to work with RTK are therefore:
RTK is an open source C++ library, not an executable. This means that you must write code that uses RTK and compile it before you will obtain something that you can run and get a result from. It also means that you can adapt or extend RTK to address your problem at hand. To facilitate this over multiple operating systems, compilers, and system configurations, RTK itself must be built from its source code. RTK is based on [http://www.itk.org The Insight Toolkit], therefore you would need to get, configure and compile The Insight Toolkit first.


The three steps to starting to work with RTK are therefore:
#Download and Build the ITK source
#Download/Obtain/Get the RTK source
#Download/Obtain/Get the RTK source
#Build the RTK library
#Build the RTK library
Line 16: Line 19:
* C/C++ compiler
* C/C++ compiler


== Getting RTK ==
== Step 0 - Getting ITK ==
We recommend to look into the [http://www.itk.org/Wiki/ITK ITK wiki] in order to compile ITK for your system. The documentation for ITK should be fairly straight forward. Moreover, the concepts for building ITK are very similar to those for RTK.
 
== Step 1 - Getting RTK ==
 
== Step 2 - Building RTK ==
 
== Step 3 - Building an example application with RTK ==

Revision as of 06:34, 27 August 2012

User's guide

What is RTK?

RTK is an open source C++ library, not an executable. This means that you must write code that uses RTK and compile it before you will obtain something that you can run and get a result from. It also means that you can adapt or extend RTK to address your problem at hand. To facilitate this over multiple operating systems, compilers, and system configurations, RTK itself must be built from its source code. RTK is based on The Insight Toolkit, therefore you would need to get, configure and compile The Insight Toolkit first.

The three steps to starting to work with RTK are therefore:

  1. Download and Build the ITK source
  2. Download/Obtain/Get the RTK source
  3. Build the RTK library
  4. Write your own code that uses RTK and build it, linking to the RTK library.

In the next sections we describe each of this steps.

Requirements

In order to compile RTK you will need the following:

  • GIT (in order to get the software)
  • CMake (in order to configure RTK)
  • C/C++ compiler

Step 0 - Getting ITK

We recommend to look into the ITK wiki in order to compile ITK for your system. The documentation for ITK should be fairly straight forward. Moreover, the concepts for building ITK are very similar to those for RTK.

Step 1 - Getting RTK

Step 2 - Building RTK

Step 3 - Building an example application with RTK