nipype.interfaces.slicer.filtering.checkerboardfilter module

Autogenerated file - DO NOT EDIT If you spot a bug, please report it on the mailing list and/or change the generator.

CheckerBoardFilter

Link to code

Bases: SEMLikeCommandLine

Wrapped executable: CheckerBoardFilter.

title: CheckerBoard Filter

category: Filtering

description: Create a checkerboard volume of two volumes. The output volume will show the two inputs alternating according to the user supplied checkerPattern. This filter is often used to compare the results of image registration. Note that the second input is resampled to the same origin, spacing and direction before it is composed with the first input. The scalar type of the output volume will be the same as the input image scalar type.

version: 0.1.0.$Revision: 19608 $(alpha)

documentation-url: http://wiki.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/CheckerBoard

contributor: Bill Lorensen (GE)

acknowledgements: This work is part of the National Alliance for Medical Image Computing (NAMIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149.

Optional Inputs:

  • args (a string) – Additional parameters to the command. Maps to a command-line argument: %s.

  • checkerPattern (a list of items which are an integer) – The pattern of input 1 and input 2 in the output image. The user can specify the number of checkers in each dimension. A checkerPattern of 2,2,1 means that images will alternate in every other checker in the first two dimensions. The same pattern will be used in the 3rd dimension. Maps to a command-line argument: --checkerPattern %s.

  • environ (a dictionary with keys which are a bytes or None or a value of class ‘str’ and with values which are a bytes or None or a value of class ‘str’) – Environment variables. (Nipype default value: {})

  • inputVolume1 (a pathlike object or string representing an existing file) – First Input volume. Maps to a command-line argument: %s (position: -3).

  • inputVolume2 (a pathlike object or string representing an existing file) – Second Input volume. Maps to a command-line argument: %s (position: -2).

  • outputVolume (a boolean or a pathlike object or string representing a file) – Output filtered. Maps to a command-line argument: %s (position: -1).

Outputs:

outputVolume (a pathlike object or string representing an existing file) – Output filtered.