]> Creatis software - clitk.git/blob - tools/clitkRigidRegistration.ggo
hide inputselector option
[clitk.git] / tools / clitkRigidRegistration.ggo
1 # file clitkRigidRegistration.ggo
2 Package "clitkRigidRegistration"
3 version "1.0"
4 purpose "Compute a rigid registration between two images." 
5
6 option "config"         -       "Config file"                           string  no
7 option "verbose"        v       "Verbose"                               flag    off
8 option "gradient"       -       "If verbose, show gradient at each iteration"   flag    off
9
10 section "Input (Both images have to be of the same dimension (2 or 3D). For 2D-3D registrations, give the 2D image a third dimension of 1 and set it to the reference image.)"
11 option "reference"      i       "Reference or fixed image filename"             string  yes
12 option "object"         j       "Object or moving image filename"               string  yes
13 option "mask"           m       "Mask to placed over the reference image"       string   no     
14
15 section "Output"
16 option "output"         o       "Transformed object image filename"                                                     string  no
17 option "checker_after"  -       "Checherboard representation of the transformed object image and reference image"       string  no
18 option "checker_before"  -      "Checherboard representation of the object image and reference image"                   string  no
19 option "after"          -       "Difference between the reference image and the transformed object"                     string  no
20 option "before"         -       "Difference between the reference image and the original object image"                  string  no
21 option "matrix"         -       "Affine matrix (reference to object space) filename "                                   string  no
22
23 section "Interpolator"
24 option "interp"         -       "Interpolator used during registration: 0=nearestneighbor, 1=linear, 2=bspline"         int     no      default="1"
25
26 section "Transform (Input and Output transformation parameters map the physical space of the fixed or reference image into the physical space of the moving or object image. Positive rotations result in a counter-clockwise rotation for the moving image. Positive translations result in shift along the negative axis for the moving image.)"
27 option "transX"         x       "Initial translation in mm along the X axis"    float   no      default="0.0"
28 option "transY"         y       "Initial translation in mm along the Y axis"    float   no      default="0.0"
29 option "transZ"         z       "Initial translation in mm along the Z axis"    float   no      default="0.0"
30 option "rotX"           X       "Initial rotation in rad along the X axis"      float   no      default="0.0"
31 option "rotY"           Y       "Initial rotation in rad along the Y axis"      float   no      default="0.0"
32 option "rotZ"           Z       "Initial rotation in rad along the Z axis"      float   no      default="0.0"
33
34 section "Optimizer"
35 option "levels"         l       "Number of multiresolution levels"                                                              int      no     default="1"
36 option "Istep"          -       "Initial stepsize in mm in the first level(to be multiplied with the gradient)"                 float   no      default="2.0"
37 option "Fstep"          -       "Final  stepsize in mm in the first level (to be multiplied with the gradient)"                 float   no      default="0.1"
38 option "relax"          -       "Relaxation of the stepsize (multiplied each time the gradient changes sign)"                   float   no      default="0.7"
39 option "inc"            -       "Increment factor x  previous stepsize = new stepsize when going to next level"         float   no      default="1.2"
40 option "dec"            -       "Decrement factor(:) previous stepsize = new final stepsize when going to next level" float     no      default="4.0"
41 option "iter"           -       "Maximum number of iterations at each level"                                            int     no      default="200"
42 option "Rweight"        -       "Weight of 1° of rotation during optimisation (high weight, less change)"                      float   no      default="50.0"
43 option "Tweight"        -       "Weight of 1mm of translation  during optimisation (high weight, less change)"                  float   no      default="1.0"
44
45 section "Metric (Use a high fraction of samples for detailed images (eg. 0.2, 0.5). For smooth images 0.01 might be enough. Use enough bins to cover the dynamique range. Randomizing the samples will make each execution different.)"
46 option "metric"         -       "Metric used during registration: 0=MS, 1=MI, 2=Mattes' MI, 3=CR"                                       int     no      default="0"
47 option "samples"        -       "If using MI or Mattes' MI, specify fraction [0, 1] of samples of the reference image"                          float   no      default="0.2"
48 option "bins"           -       "If using Mattes' MI, specify the number of histogram bins for the PDF estimation of the reference image"       int     no      default="50"
49 option "random"         -       "If using Mattes' MI and MI, specify if the set of samples should be taken randomly"                            flag    off     
50 option "stdDev"         -       "If using MI, specify the standard deviation in mm of the gaussian kernels for both PDF estimations"                    float   no      default="0.4"   
51
52 section "Preprocessing"
53 option "normalize"      -       "Normalize images before registration (not necessary for Mattes' MI)"                   flag    off     
54 option "blur"           -       "Blur images before registration, use Gaussian with std dev (none by default) "         float   no  default="0.0"       
55 option "zero_origin"    -       "Reset the input images' origins to zero, to avoid additional shifts according to jef"  flag    off