← Back to branch summary

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

« back to all changes in this revision

Viewing changes to Code/BasicFilters/json/TikhonovDeconvolutionImageFilter.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:
Code/BasicFilters/json/TikhonovDeconvolutionImageFilter.json
 
1
{
 
2
  "name" : "TikhonovDeconvolutionImageFilter",
 
3
  "template_code_filename" : "ImageFilter",
 
4
  "template_test_filename" : "ImageFilter",
 
5
  "number_of_inputs" : 2,
 
6
  "doc" : "Some global documentation",
 
7
  "pixel_types" : "BasicPixelIDTypeList",
 
8
  "include_files" : [
 
9
    "sitkBoundaryConditions.hxx"
 
10
  ],
 
11
  "custom_set_input" : "filter->SetInput( image1 ); filter->SetKernelImage( image2 );",
 
12
  "members" : [
 
13
    {
 
14
      "name" : "RegularizationConstant",
 
15
      "type" : "double",
 
16
      "default" : "0.0",
 
17
      "briefdescriptionSet" : "",
 
18
      "detaileddescriptionSet" : "The regularization factor. Larger values reduce the dominance of noise in the solution, but results in higher approximation error in the deblurred image. Default value is 0.0, yielding the same results as the InverseDeconvolutionImageFilter .",
 
19
      "briefdescriptionGet" : "",
 
20
      "detaileddescriptionGet" : "The regularization factor. Larger values reduce the dominance of noise in the solution, but results in higher approximation error in the deblurred image. Default value is 0.0, yielding the same results as the InverseDeconvolutionImageFilter ."
 
21
    },
 
22
    {
 
23
      "name" : "Normalize",
 
24
      "type" : "bool",
 
25
      "default" : "false",
 
26
      "doc" : "",
 
27
      "briefdescriptionSet" : "",
 
28
      "detaileddescriptionSet" : "Normalize the output image by the sum of the kernel components\n",
 
29
      "briefdescriptionGet" : "",
 
30
      "detaileddescriptionGet" : ""
 
31
    },
 
32
    {
 
33
      "name" : "BoundaryCondition",
 
34
      "enum" : [
 
35
        "ZERO_PAD",
 
36
        "ZERO_FLUX_NEUMANN_PAD",
 
37
        "PERIODIC_PAD"
 
38
      ],
 
39
      "default" : "itk::simple::TikhonovDeconvolutionImageFilter::ZERO_FLUX_NEUMANN_PAD",
 
40
      "custom_itk_cast" : "nsstd::auto_ptr< ImageBoundaryCondition< InputImageType > > bc( CreateNewBoundaryConditionInstance< Self, FilterType >( m_BoundaryCondition ) ); filter->SetBoundaryCondition( bc.get() );\n"
 
41
    },
 
42
    {
 
43
      "name" : "OutputRegionMode",
 
44
      "enum" : [
 
45
        "SAME",
 
46
        "VALID"
 
47
      ],
 
48
      "default" : "itk::simple::TikhonovDeconvolutionImageFilter::SAME",
 
49
      "itk_type" : "typename FilterType::OutputRegionModeType"
 
50
    }
 
51
  ],
 
52
  "tests" : [
 
53
    {
 
54
      "tag" : "defaults",
 
55
      "description" : "Tikhonov deconvolution of image blurred with a Gaussian kernel",
 
56
      "settings" : [
 
57
        {
 
58
          "parameter" : "Normalize",
 
59
          "value" : "true",
 
60
          "python_value" : "True",
 
61
          "R_value" : "TRUE"
 
62
        }
 
63
      ],
 
64
      "tolerance" : "0.0001",
 
65
      "inputs" : [
 
66
        "Input/DeconvolutionInput.nrrd",
 
67
        "Input/DeconvolutionKernel.nrrd"
 
68
      ]
 
69
    }
 
70
  ],
 
71
  "briefdescription" : "An inverse deconvolution filter regularized in the Tikhonov sense.",
 
72
  "detaileddescription" : "The Tikhonov deconvolution filter is the inverse deconvolution filter with a regularization term added to the denominator. The filter minimizes the equation \\f[ ||\\hat{f} \\otimes h - g||_{L_2}^2 + \\mu||\\hat{f}||^2 \\f] where \\f$\\hat{f}\\f$ is the estimate of the unblurred image, \\f$h\\f$ is the blurring kernel, \\f$g\\f$ is the blurred image, and \\f$\\mu\\f$ is a non-negative real regularization function.\n\nThe filter applies a kernel described in the Fourier domain as \\f$H^*(\\omega) / (|H(\\omega)|^2 + \\mu)\\f$ where \\f$H(\\omega)\\f$ is the Fourier transform of \\f$h\\f$ . The term \\f$\\mu\\f$ is called RegularizationConstant in this filter. If \\f$\\mu\\f$ is set to zero, this filter is equivalent to the InverseDeconvolutionImageFilter .\n\n\\author Gaetan Lehmann, Biologie du Developpement et de la Reproduction, INRA de Jouy-en-Josas, France \n\nCory Quammen, The University of North Carolina at Chapel Hill",
 
73
  "itk_module" : "ITKDeconvolution",
 
74
  "itk_group" : "Deconvolution"
 
75
}
 
 
b'\\ No newline at end of file'