Modules:CheckerBoardFilter-Documentation-3.6
Return to Slicer 3.6 Documentation
Module Name
Checkerboard Filter
Module Type & Category
Type: CLI
Category: Filtering
Authors, Collaborators & Contact
- Author: Bill Lorensen
- Contact: bill.lorensen at gmail.com
Module 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.
While this is currently a Command Line Module, in future versions of Slicer this capability will be provided as an interactive visualization technique.
Usage
CheckerBoard [--returnparameterfile
<std::string>] [--processinformationaddress <std::string>] [--xml] [--echo] [--checkerPattern <std::vector<int>>] [--] [--version] [-h] <std::string> <std::string> <std::string>
Where:
--returnparameterfile <std::string> Filename in which to write simple return parameters (int, float, int-vector, etc.) as opposed to bulk return parameters (image, geometry, transform, measurement, table).
--processinformationaddress <std::string> Address of a structure to store process information (progress, abort, etc.). (default: 0)
--xml Produce xml description of command line arguments (default: 0)
--echo Echo the command line arguments (default: 0)
--checkerPattern <std::vector<int>> 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. (default: 2,2,2)
--, --ignore_rest Ignores the rest of the labeled arguments following this flag.
--version Displays version information and exits.
-h, --help Displays usage information and exits.
<std::string> (required) First Input volume
<std::string> (required) Second Input volume
<std::string> (required) Output filtered
Source code & documentation
Source Code: CheckerboardFilter.cxx
XML Description: CheckerboardFilter.xml
Documentation:
More Information
Acknowledgment
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. Information on the National Centers for Biomedical Computing can be obtained from National Centers for Biomedical Computing.