nipype.interfaces.slicer.quantification.petstandarduptakevaluecomputation module

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

PETStandardUptakeValueComputation

Link to code

Bases: SEMLikeCommandLine

Wrapped executable: PETStandardUptakeValueComputation.

title: PET Standard Uptake Value Computation

category: Quantification

description: Computes the standardized uptake value based on body weight. Takes an input PET image in DICOM and NRRD format (DICOM header must contain Radiopharmaceutical parameters). Produces a CSV file that contains patientID, studyDate, dose, labelID, suvmin, suvmax, suvmean, labelName for each volume of interest. It also displays some of the information as output strings in the GUI, the CSV file is optional in that case. The CSV file is appended to on each execution of the CLI.

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

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

contributor: Wendy Plesniak (SPL, BWH), Nicole Aucoin (SPL, BWH), Ron Kikinis (SPL, BWH)

acknowledgements: This work is funded by the Harvard Catalyst, and 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:
  • OutputLabel (a string) – List of labels for which SUV values were computed. Maps to a command-line argument: --OutputLabel %s.

  • OutputLabelValue (a string) – List of label values for which SUV values were computed. Maps to a command-line argument: --OutputLabelValue %s.

  • SUVMax (a string) – SUV max for each label. Maps to a command-line argument: --SUVMax %s.

  • SUVMean (a string) – SUV mean for each label. Maps to a command-line argument: --SUVMean %s.

  • SUVMin (a string) – SUV minimum for each label. Maps to a command-line argument: --SUVMin %s.

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

  • color (a pathlike object or string representing an existing file) – Color table to to map labels to colors and names. Maps to a command-line argument: --color %s.

  • csvFile (a boolean or a pathlike object or string representing a file) – A file holding the output SUV values in comma separated lines, one per label. Optional. Maps to a command-line argument: --csvFile %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: {})

  • labelMap (a pathlike object or string representing an existing file) – Input label volume containing the volumes of interest. Maps to a command-line argument: --labelMap %s.

  • petDICOMPath (a pathlike object or string representing an existing directory) – Input path to a directory containing a PET volume containing DICOM header information for SUV computation. Maps to a command-line argument: --petDICOMPath %s.

  • petVolume (a pathlike object or string representing an existing file) – Input PET volume for SUVbw computation (must be the same volume as pointed to by the DICOM path!). Maps to a command-line argument: --petVolume %s.

Outputs:

csvFile (a pathlike object or string representing an existing file) – A file holding the output SUV values in comma separated lines, one per label. Optional.