.. AUTO-GENERATED FILE -- DO NOT EDIT!

interfaces.slicer.quantification.petstandarduptakevaluecomputation
==================================================================


.. _nipype.interfaces.slicer.quantification.petstandarduptakevaluecomputation.PETStandardUptakeValueComputation:


.. index:: PETStandardUptakeValueComputation

PETStandardUptakeValueComputation
---------------------------------

`Link to code <file:///build/nipype-fj7ofr/nipype-1.0.0+git69-gdb2670326/nipype/interfaces/slicer/quantification/petstandarduptakevaluecomputation.py#L55>`__

Wraps command **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.

Inputs::

        [Mandatory]

        [Optional]
        OutputLabel: (a unicode string)
                List of labels for which SUV values were computed
                flag: --OutputLabel %s
        OutputLabelValue: (a unicode string)
                List of label values for which SUV values were computed
                flag: --OutputLabelValue %s
        SUVMax: (a unicode string)
                SUV max for each label
                flag: --SUVMax %s
        SUVMean: (a unicode string)
                SUV mean for each label
                flag: --SUVMean %s
        SUVMin: (a unicode string)
                SUV minimum for each label
                flag: --SUVMin %s
        args: (a unicode string)
                Additional parameters to the command
                flag: %s
        color: (an existing file name)
                Color table to to map labels to colors and names
                flag: --color %s
        csvFile: (a boolean or a file name)
                A file holding the output SUV values in comma separated lines, one
                per label. Optional.
                flag: --csvFile %s
        environ: (a dictionary with keys which are a newbytes or None or a
                 newstr or None and with values which are a newbytes or None or a
                 newstr or None, nipype default value: {})
                Environment variables
        ignore_exception: (a boolean, nipype default value: False)
                Print an error message instead of throwing an exception in case the
                interface fails to run
        labelMap: (an existing file name)
                Input label volume containing the volumes of interest
                flag: --labelMap %s
        petDICOMPath: (an existing directory name)
                Input path to a directory containing a PET volume containing DICOM
                header information for SUV computation
                flag: --petDICOMPath %s
        petVolume: (an existing file name)
                Input PET volume for SUVbw computation (must be the same volume as
                pointed to by the DICOM path!).
                flag: --petVolume %s
        terminal_output: (u'stream' or u'allatonce' or u'file' or u'none')
                Control terminal output: `stream` - displays to terminal immediately
                (default), `allatonce` - waits till command is finished to display
                output, `file` - writes output to file, `none` - output is ignored

Outputs::

        csvFile: (an existing file name)
                A file holding the output SUV values in comma separated lines, one
                per label. Optional.
