~ubuntu-branches/debian/sid/simpleitk/sid

« back to all changes in this revision

Viewing changes to Code/BasicFilters/json/LevelSetMotionRegistrationFilter.json

  • Committer: Package Import Robot
  • Author(s): Ghislain Antony Vaillant
  • Date: 2017-11-02 08:49:18 UTC
  • Revision ID: package-import@ubuntu.com-20171102084918-7hs09ih668xq87ej
Tags: upstream-1.0.1
ImportĀ upstreamĀ versionĀ 1.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
{
 
2
  "name" : "LevelSetMotionRegistrationFilter",
 
3
  "template_code_filename" : "ImageFilter",
 
4
  "template_test_filename" : "ImageFilter",
 
5
  "no_procedure" : "1",
 
6
  "number_of_inputs" : 0,
 
7
  "pixel_types" : "BasicPixelIDTypeList",
 
8
  "filter_type" : "itk::LevelSetMotionRegistrationFilter<InputImageType, InputImageType, itk::Image< Vector<double, InputImageType::ImageDimension>, InputImageType::ImageDimension > >",
 
9
  "inputs" : [
 
10
    {
 
11
      "name" : "FixedImage",
 
12
      "type" : "Image",
 
13
      "custom_itk_cast" : "filter->SetFixedImage( this->CastImageToITK<typename FilterType::FixedImageType>(*inFixedImage) );"
 
14
    },
 
15
    {
 
16
      "name" : "MovingImage",
 
17
      "type" : "Image"
 
18
    }
 
19
  ],
 
20
  "members" : [
 
21
    {
 
22
      "name" : "GradientSmoothingStandardDeviations",
 
23
      "type" : "double",
 
24
      "default" : "1.0",
 
25
      "briefdescriptionSet" : "",
 
26
      "detaileddescriptionSet" : "Set/Get the standard deviation used for smoothing the moving image prior to calculating gradients. The standard deviation is measured in physical units (for instance mm). Note that this smoothing value is not to be confused with the PDEDeformableRegistrationFilter::SetStandardDeviations() method. The method in PDEDeformableRegistrationFilter is for setting the smoothing parameters for regularizing the deformation field between interations. Those smoothing parameters are set in pixel units not physical units. Deformation field smoothing is not done by default in LevelSetMotionRegistration. This smoothing parameter is to condition the gradient calculation and parameter is specified in physical units.",
 
27
      "briefdescriptionGet" : "",
 
28
      "detaileddescriptionGet" : ""
 
29
    },
 
30
    {
 
31
      "name" : "NumberOfIterations",
 
32
      "type" : "uint32_t",
 
33
      "default" : "10u",
 
34
      "doc" : "Number of iterations to run"
 
35
    },
 
36
    {
 
37
      "name" : "MaximumRMSError",
 
38
      "type" : "double",
 
39
      "default" : 0.02,
 
40
      "doc" : "Value of RMS change below which the filter should stop. This is a convergence criterion."
 
41
    },
 
42
    {
 
43
      "name" : "StandardDeviations",
 
44
      "type" : "double",
 
45
      "dim_vec" : 1,
 
46
      "set_as_scalar" : 1,
 
47
      "default" : "std::vector<double>(3, 1.0)",
 
48
      "itk_type" : "typename FilterType::StandardDeviationsType",
 
49
      "detaileddescriptionSet" : "Set/Get the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates.",
 
50
      "detaileddescriptionGet" : "Set/Get the Gaussian smoothing standard deviations for the displacement field. The values are set with respect to pixel coordinates."
 
51
    },
 
52
    {
 
53
      "name" : "SmoothDisplacementField",
 
54
      "type" : "bool",
 
55
      "default" : false,
 
56
      "detaileddescriptionSet" : "Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations()",
 
57
      "detaileddescriptionGet" : "Set/Get whether the displacement field is smoothed (regularized). Smoothing the displacement yields a solution elastic in nature. If SmoothDisplacementField is on, then the displacement field is smoothed with a Gaussian whose standard deviations are specified with SetStandardDeviations()"
 
58
    },
 
59
    {
 
60
      "name" : "UpdateFieldStandardDeviations",
 
61
      "type" : "double",
 
62
      "dim_vec" : 1,
 
63
      "set_as_scalar" : 1,
 
64
      "default" : "std::vector<double>(3, 1.0)",
 
65
      "itk_type" : "typename FilterType::StandardDeviationsType",
 
66
      "detaileddescriptionSet" : "Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates.",
 
67
      "detaileddescriptionGet" : "Set the Gaussian smoothing standard deviations for the update field. The values are set with respect to pixel coordinates."
 
68
    },
 
69
    {
 
70
      "name" : "SmoothUpdateField",
 
71
      "type" : "bool",
 
72
      "default" : false,
 
73
      "detaileddescriptionSet" : "Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations()",
 
74
      "detaileddescriptionGet" : "Set/Get whether the update field is smoothed (regularized). Smoothing the update field yields a solution viscous in nature. If SmoothUpdateField is on, then the update field is smoothed with a Gaussian whose standard deviations are specified with SetUpdateFieldStandardDeviations()"
 
75
    },
 
76
    {
 
77
      "name" : "MaximumKernelWidth",
 
78
      "type" : "unsigned int",
 
79
      "default" : "30u",
 
80
      "detaileddescriptionSet" : "Set/Get the desired limits of the Gaussian kernel width.",
 
81
      "detaileddescriptionGet" : "Set/Get the desired limits of the Gaussian kernel width."
 
82
    },
 
83
    {
 
84
      "name" : "MaximumError",
 
85
      "type" : "double",
 
86
      "default" : "0.1",
 
87
      "detaileddescriptionSet" : "Set/Get the desired maximum error of the Guassian kernel approximate.",
 
88
      "detaileddescriptionGet" : "Set/Get the desired maximum error of the Guassian kernel approximate."
 
89
    },
 
90
    {
 
91
      "name" : "Alpha",
 
92
      "type" : "double",
 
93
      "default" : "0.1",
 
94
      "briefdescriptionSet" : "",
 
95
      "detaileddescriptionSet" : "Set/Get the parameter alpha. Alpha is added to the calculated gradient magnitude prior to normalizing the gradient to protect against numerical instability as the gradient magnitude approaches zero. This should be set as a small fraction of the intensity dynamic range, for instance 0.04%. Default is the absolute (not percentage) value of 0.1.",
 
96
      "briefdescriptionGet" : "",
 
97
      "detaileddescriptionGet" : ""
 
98
    },
 
99
    {
 
100
      "name" : "IntensityDifferenceThreshold",
 
101
      "type" : "double",
 
102
      "default" : "0.001",
 
103
      "briefdescriptionSet" : "",
 
104
      "detaileddescriptionSet" : "Set/Get the threshold below which the absolute difference of intensity yields a match. When the intensities match between a moving and fixed image pixel, the update vector (for that iteration) will be the zero vector. Default is 0.001.",
 
105
      "briefdescriptionGet" : "",
 
106
      "detaileddescriptionGet" : ""
 
107
    },
 
108
    {
 
109
      "name" : "GradientMagnitudeThreshold",
 
110
      "type" : "double",
 
111
      "default" : "1e-9",
 
112
      "briefdescriptionSet" : "",
 
113
      "detaileddescriptionSet" : "Set/Get the threshold below which the gradient magnitude is considered the zero vector. Default is 1e-9.",
 
114
      "briefdescriptionGet" : "",
 
115
      "detaileddescriptionGet" : ""
 
116
    },
 
117
    {
 
118
      "name" : "UseImageSpacing",
 
119
      "type" : "bool",
 
120
      "default" : true
 
121
    }
 
122
  ],
 
123
  "measurements" : [
 
124
    {
 
125
      "name" : "ElapsedIterations",
 
126
      "type" : "uint32_t",
 
127
      "default" : 0,
 
128
      "briefdescriptionGet" : "Number of iterations run."
 
129
    },
 
130
    {
 
131
      "name" : "RMSChange",
 
132
      "type" : "double",
 
133
      "default" : 0.0,
 
134
      "briefdescriptionGet" : "The Root Mean Square of the levelset upon termination."
 
135
    },
 
136
    {
 
137
      "name" : "Metric",
 
138
      "type" : "double",
 
139
      "default" : 0.0,
 
140
      "briefdescriptionGet" : "",
 
141
      "detaileddescriptionGet" : "Get the metric value. The metric value is the mean square difference in intensity between the fixed image and transforming moving image computed over the the overlapping region between the two images. This is value is only available for the previous iteration and NOT the current iteration."
 
142
    }
 
143
  ],
 
144
  "tests" : [
 
145
    {
 
146
      "tag" : "2d",
 
147
      "description" : "2D",
 
148
      "settings" : [],
 
149
      "tolerance" : "1e-8",
 
150
      "inputs" : [
 
151
        "Input/BrainProtonDensitySliceBorder20.png",
 
152
        "Input/BrainProtonDensitySliceBSplined10.png"
 
153
      ],
 
154
      "measurements_results" : [
 
155
        {
 
156
          "name" : "ElapsedIterations",
 
157
          "value" : "10u"
 
158
        },
 
159
        {
 
160
          "name" : "RMSChange",
 
161
          "value" : 10.422647280222545,
 
162
          "tolerance" : 1e-06
 
163
        },
 
164
        {
 
165
          "name" : "Metric",
 
166
          "value" : 298.5606776524018,
 
167
          "tolerance" : 0.0001
 
168
        }
 
169
      ]
 
170
    }
 
171
  ],
 
172
  "briefdescription" : "Deformably register two images using level set motion.",
 
173
  "detaileddescription" : "LevelSetMotionFilter implements a deformable registration algorithm that aligns a fixed and a moving image under level set motion. The equations of motion are similar to those of the DemonsRegistrationFilter . The main differences are: (1) Gradients of the moving image are calculated on a smoothed image while intensity difference are measured on the original images (2) Magnitude of the motion vector is a function of the differences in intensity between the fixed and moving pixel. An adaptive timestep is calculated based on the maximum motion vector over the entire field to ensure stability. The timestep also implictly converts the motion vector measured in units of intensity to a vector measured in physical units. Demons, on the other hand, defines its motion vectors as function of both the intensity differences and gradient magnitude at each respective pixel. Consider two separate pixels with the same intensity differences between the corresponding fixed and moving pixel pairs. In demons, the motion vector of the pixel over a low gradient region will be larger than the motion vector of the pixel over a large gradient region. This leads to an unstable vector field. In the levelset approach, the motion vectors will be proportional to the gradients, scaled by the maximum gradient over the entire field. The pixel with at the lower gradient position will more less than the pixel at the higher gradient position. (3) Gradients are calculated using minmod finite difference instead of using central differences.\n\nA deformation field is represented as a image whose pixel type is some vector type with at least N elements, where N is the dimension of the fixed image. The vector type must support element access via operator []. It is assumed that the vector elements behave like floating point scalars.\n\nThis class is templated over the fixed image type, moving image type and the deformation field type.\n\nThe input fixed and moving images are set via methods SetFixedImage and SetMovingImage respectively. An initial deformation field maybe set via SetInitialDisplacementField or SetInput. If no initial field is set, a zero field is used as the initial condition.\n\nThe algorithm has one parameters: the number of iteration to be performed.\n\nThe output deformation field can be obtained via methods GetOutput or GetDisplacementField.\n\nThis class make use of the finite difference solver hierarchy. Update for each iteration is computed in LevelSetMotionFunction.\n\n\\warning This filter assumes that the fixed image type, moving image type and deformation field type all have the same number of dimensions.\n\nRef: B.C. Vemuri, J. Ye, Y. Chen, C.M. Leonard. \"Image registration via level-set motion: applications to atlas-based segmentation\". Medical Image Analysis. Vol. 7. pp. 1-20. 2003.\n\n\\see LevelSetMotionRegistrationFunction \n\n\\see DemonsRegistrationFilter",
 
174
  "itk_module" : "ITKPDEDeformableRegistration",
 
175
  "itk_group" : "PDEDeformable"
 
176
}
 
 
b'\\ No newline at end of file'