nipype.interfaces.slicer.filtering.resamplescalarvectordwivolume module

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

ResampleScalarVectorDWIVolume

Link to code

Bases: SEMLikeCommandLine

Wrapped executable: ResampleScalarVectorDWIVolume.

title: Resample Scalar/Vector/DWI Volume

category: Filtering

description: This module implements image and vector-image resampling through the use of itk Transforms.It can also handle diffusion weighted MRI image resampling. “Resampling” is performed in space coordinates, not pixel/grid coordinates. It is quite important to ensure that image spacing is properly set on the images involved. The interpolator is required since the mapping from one space to the other will often require evaluation of the intensity of the image at non-grid positions.

Warning: To resample DWMR Images, use nrrd input and output files.

Warning: Do not use to resample Diffusion Tensor Images, tensors would not be reoriented

version: 0.1

documentation-url: http://www.slicer.org/slicerWiki/index.php/Documentation/4.1/Modules/ResampleScalarVectorDWIVolume

contributor: Francois Budin (UNC)

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. Information on the National Centers for Biomedical Computing can be obtained from http://nihroadmap.nih.gov/bioinformatics

Optional Inputs:
  • Inverse_ITK_Transformation (a boolean) – Inverse the transformation before applying it from output image to input image. Maps to a command-line argument: --Inverse_ITK_Transformation.

  • Reference (a pathlike object or string representing an existing file) – Reference Volume (spacing,size,orientation,origin). Maps to a command-line argument: --Reference %s.

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

  • centered_transform (a boolean) – Set the center of the transformation to the center of the input image. Maps to a command-line argument: --centered_transform.

  • defField (a pathlike object or string representing an existing file) – File containing the deformation field (3D vector image containing vectors with 3 components). Maps to a command-line argument: --defField %s.

  • default_pixel_value (a float) – Default pixel value for samples falling outside of the input region. Maps to a command-line argument: --default_pixel_value %f.

  • direction_matrix (a list of items which are a float) – 9 parameters of the direction matrix by rows (ijk to LPS if LPS transform, ijk to RAS if RAS transform). Maps to a command-line argument: --direction_matrix %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: {})

  • hfieldtype (‘displacement’ or ‘h-Field’) – Set if the deformation field is an h-Field. Maps to a command-line argument: --hfieldtype %s.

  • image_center (‘input’ or ‘output’) – Image to use to center the transform (used only if ‘Centered Transform’ is selected). Maps to a command-line argument: --image_center %s.

  • inputVolume (a pathlike object or string representing an existing file) – Input Volume to be resampled. Maps to a command-line argument: %s (position: -2).

  • interpolation (‘linear’ or ‘nn’ or ‘ws’ or ‘bs’) – Sampling algorithm (linear or nn (nearest neighbor), ws (WindowedSinc), bs (BSpline) ). Maps to a command-line argument: --interpolation %s.

  • notbulk (a boolean) – The transform following the BSpline transform is not set as a bulk transform for the BSpline transform. Maps to a command-line argument: --notbulk.

  • number_of_thread (an integer) – Number of thread used to compute the output image. Maps to a command-line argument: --number_of_thread %d.

  • origin (a list of items which are any value) – Origin of the output Image. Maps to a command-line argument: --origin %s.

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

  • rotation_point (a list of items which are any value) – Rotation Point in case of rotation around a point (otherwise useless). Maps to a command-line argument: --rotation_point %s.

  • size (a list of items which are a float) – Size along each dimension (0 means use input size). Maps to a command-line argument: --size %s.

  • spaceChange (a boolean) – Space Orientation between transform and image is different (RAS/LPS) (warning: if the transform is a Transform Node in Slicer3, do not select). Maps to a command-line argument: --spaceChange.

  • spacing (a list of items which are a float) – Spacing along each dimension (0 means use input spacing). Maps to a command-line argument: --spacing %s.

  • spline_order (an integer) – Spline Order. Maps to a command-line argument: --spline_order %d.

  • transform (‘rt’ or ‘a’) – Transform algorithm, rt = Rigid Transform, a = Affine Transform. Maps to a command-line argument: --transform %s.

  • transform_matrix (a list of items which are a float) – 12 parameters of the transform matrix by rows ( –last 3 being translation– ). Maps to a command-line argument: --transform_matrix %s.

  • transform_order (‘input-to-output’ or ‘output-to-input’) – Select in what order the transforms are read. Maps to a command-line argument: --transform_order %s.

  • transformationFile (a pathlike object or string representing an existing file) – Maps to a command-line argument: --transformationFile %s.

  • window_function (‘h’ or ‘c’ or ‘w’ or ‘l’ or ‘b’) – Window Function , h = Hamming , c = Cosine , w = Welch , l = Lanczos , b = Blackman. Maps to a command-line argument: --window_function %s.

Outputs:

outputVolume (a pathlike object or string representing an existing file) – Resampled Volume.