Examples

F.r.e.e. comes along with some examples that should help to understand its basics and to learn how to work with the tools. If you build f.r.e.e. yourself, please set the option "FREE_BuildExamples" to "on" when generating the project with cmake. The examples can be found in the examples sub directory of your binary/installation path.
To view or execute an example simply start the associated executable file in the examples sub directory. You should build the whole project before if you don't have a pre built version.

These examples are only the first ones. They should provide a good start and further examples will be added with time.

Detailed information

Detailed information about the examples can be found in document free_examples.pdf. The file should be located in the documentation sub directory and can be downloaded at the f.r.e.e. project web site. Additionally, every example offers a short explanation that will be viewed when the example is executed.

Examples

You can execute the examples in any order but it is recommended to process them in the following order.

• Demo_helloFREE
  This is the "Hello World" example and introduces the very basics of f.r.e.e. and the usage of the tool freeCL. It is a setup with one input image, one threshold filter processing that image and the output of the resulting image. This setup should, amongst other things, demonstrate a basic processing chain.
• Demo_itkImageRegistration1
  This example introduces registration in f.r.e.e. on a basic level. It is the scripted equivalence to the itk demo ImageRegistration1. Thus this demo also shows how to use itk registration with f.r.e.e..
• Demo_itkImageRegistration2
  This is the scripted equivalence to the itk demo ImageRegistration2. It is a more complex processing chain (pre processing and registration) and demonstrates, amongst other things, a different view on the registration log that shows the whole sequence of processing.
• Demo_itkImageRegistration4
  This is the scripted equivalence to the itk demo ImageRegistration4. Amongst others, it shows how registration/process observation comes for free with f.r.e.e. ;).
• Demo_itkImageRegistration6
  This is the scripted equivalence to the itk demo ImageRegistration6.
• Demo_itkMultiResImageRegistration1
  This is the scripted equivalence to the itk demo MultiResImageRegistration1. It demonstrates, amongst other things, how f.r.e.e. manages multi resolution registration.
• Demo_DeformableRegistration4
  This is the scripted equivalence to the itk demo DeformableRegistration4. It demonstrates non rigid registration using bsplines.
• Demo_adaptedRegistration1
  This example introduces generic setups and adaptation lists. It shows how both can be used by freeCL to process different cases with one setup in one execution. In this example a translation registration is used to register 3 test cases.
• Demo_adaptedRegistration2
  Another example demonstrating the usage of freeCL with generic setups and adaptation lists. In this example a centered rigid registration is used to register 3 test cases.
• Demo_evalRegistration1
  This example introduces the tool freeEval. The setup of Demo_adaptedRegistation1 is evaluated against the test cases. The quality of registration is measured by the absolute difference of result image and reference image. The evaluation results will be saved in a protocol.
• Demo_evalRegistration2
  Another example with freeEval. Here the setup of Demo_adaptedRegistation2 is evaluated against the test cases. The quality of registration is measured by the absolute difference of result image and reference image. The evaluation results will be saved in a protocol.
• Demo_optimizeRegistration1
  This example introduces the tool freeSO. It will be used to optimize the setup "itkImageRegistration4.fre". The aims of optimization will be to accelerate the registration process while ensuring sufficient high accuracy.
• Demo_optimizeRegistration2
  Another optimization of "itkImageRegistration4.fre". In this demo some points are discussed that should be regarded when optimizing setups.

---