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

« back to all changes in this revision

Viewing changes to Code/BasicFilters/json/GradientImageFilter.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" : "GradientImageFilter",
 
3
  "template_code_filename" : "ImageFilter",
 
4
  "template_test_filename" : "ImageFilter",
 
5
  "number_of_inputs" : 1,
 
6
  "doc" : "",
 
7
  "pixel_types" : "BasicPixelIDTypeList",
 
8
  "output_image_type" : "itk::VectorImage<float, InputImageType::ImageDimension>",
 
9
  "filter_type" : "itk::GradientImageFilter<InputImageType, float, float, OutputImageType>",
 
10
  "members" : [
 
11
    {
 
12
      "name" : "UseImageSpacing",
 
13
      "type" : "bool",
 
14
      "default" : "true",
 
15
      "briefdescriptionSet" : "",
 
16
      "detaileddescriptionSet" : "Set/Get whether or not the filter will use the spacing of the input image in its calculations",
 
17
      "briefdescriptionGet" : "",
 
18
      "detaileddescriptionGet" : ""
 
19
    },
 
20
    {
 
21
      "name" : "UseImageDirection",
 
22
      "type" : "bool",
 
23
      "default" : "false",
 
24
      "briefdescriptionSet" : "",
 
25
      "detaileddescriptionSet" : "The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On.",
 
26
      "briefdescriptionGet" : "",
 
27
      "detaileddescriptionGet" : "The UseImageDirection flag determines whether image derivatives are computed with respect to the image grid or with respect to the physical space. When this flag is ON the derivatives are computed with respect to the coordinate system of physical space. The difference is whether we take into account the image Direction or not. The flag ON will take into account the image direction and will result in an extra matrix multiplication compared to the amount of computation performed when the flag is OFF. The default value of this flag is On."
 
28
    }
 
29
  ],
 
30
  "tests" : [
 
31
    {
 
32
      "tag" : "default",
 
33
      "description" : "Simply run with default settings from 2d image",
 
34
      "settings" : [],
 
35
      "tolerance" : 1e-05,
 
36
      "inputs" : [
 
37
        "Input/cthead1.png"
 
38
      ]
 
39
    },
 
40
    {
 
41
      "tag" : "default_float",
 
42
      "description" : "Simply run with default settings from float image",
 
43
      "settings" : [],
 
44
      "tolerance" : 1e-05,
 
45
      "inputs" : [
 
46
        "Input/RA-Float.nrrd"
 
47
      ]
 
48
    }
 
49
  ],
 
50
  "briefdescription" : "Computes the gradient of an image using directional derivatives.",
 
51
  "detaileddescription" : "Computes the gradient of an image using directional derivatives. The directional derivative at each pixel location is computed by convolution with a first-order derivative operator.\n\nThe second template parameter defines the value type used in the derivative operator (defaults to float). The third template parameter defines the value type used for output image (defaults to float). The output image is defined as a covariant vector image whose value type is specified as this third template parameter.\n\n\\see Image \n\n\\see Neighborhood \n\n\\see NeighborhoodOperator \n\n\\see NeighborhoodIterator",
 
52
  "itk_module" : "ITKImageGradient",
 
53
  "itk_group" : "ImageGradient"
 
54
}
 
 
b'\\ No newline at end of file'