Difference between revisions of "Documentation/Nightly/Modules/SUVFactorCalculator"
Tag: 2017 source edit |
Tag: 2017 source edit |
||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | <noinclude>{{documentation/versioncheck}}</noinclude> | + | <noinclude>{{documentation/versioncheck}} |
+ | </noinclude> | ||
<!-- ---------------------------- --> | <!-- ---------------------------- --> | ||
{{documentation/{{documentation/version}}/module-header}} | {{documentation/{{documentation/version}}/module-header}} | ||
Line 10: | Line 11: | ||
Acknowledgments: | Acknowledgments: | ||
The UIowa [http://imaging.cancer.gov/programsandresources/specializedinitiatives/qin QIN] PET DICOM Extension was funded in part by [http://imaging.cancer.gov/programsandresources/specializedinitiatives/qin/iowa Quantitative Imaging to Assess Response in Cancer Therapy Trials] NIH grant U01-CA140206 and [http://qiicr.org Quantitative Image Informatics for Cancer Research (QIICR)] NIH grant U24 CA180918. <br> | The UIowa [http://imaging.cancer.gov/programsandresources/specializedinitiatives/qin QIN] PET DICOM Extension was funded in part by [http://imaging.cancer.gov/programsandresources/specializedinitiatives/qin/iowa Quantitative Imaging to Assess Response in Cancer Therapy Trials] NIH grant U01-CA140206 and [http://qiicr.org Quantitative Image Informatics for Cancer Research (QIICR)] NIH grant U24 CA180918. <br> | ||
− | Authors: Andrey Fedorov ({{collaborator|name|spl}}), Ethan Ulrich (University of Iowa), Markus van Tol (University of Iowa) | + | Authors: Andrey Fedorov ({{collaborator|name|spl}}), Ethan Ulrich (University of Iowa), Markus van Tol (University of Iowa), Christian Bauer (University of Iowa)<br> |
− | + | Contributors: Reinhard Beichel (University of Iowa), John Buatti (University of Iowa), Hans Johnson (University of Iowa), Wendy Plesniak (SPL, BWH), Nicole Aucoin (SPL, BWH), Ron Kikinis (SPL, BWH)<br> | |
Contact: <email>qin@iibi.uiowa.edu</email><br> | Contact: <email>qin@iibi.uiowa.edu</email><br> | ||
Line 24: | Line 25: | ||
{{documentation/{{documentation/version}}/module-introduction-end}} | {{documentation/{{documentation/version}}/module-introduction-end}} | ||
− | == General Information == | + | ==General Information== |
+ | The '''SUVFactorCalculator''' Command Line Interface (CLI) takes a PET DICOM series and computes Standardized Uptake Value conversion factors (SUVbw, SUBlbm, SUVbs, SUVibw). Those SUV factors can be stored in a DICOM Real World Value Mapping (RWVM) file and SUV normalized image volumes can be generated. | ||
− | + | Depending on the information stored in the PET DICOM header, 4 types of SUV factors can be calculated as summarized here, where weight is in kilograms and height is in centimeters. | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
*SUVbw: | *SUVbw: | ||
**males & females: weight | **males & females: weight | ||
Line 57: | Line 40: | ||
**males: 48.0 + 1.06 * (height - 152) | **males: 48.0 + 1.06 * (height - 152) | ||
**females: 45.5 + 0.91 * (height - 152) | **females: 45.5 + 0.91 * (height - 152) | ||
− | |||
− | |||
− | |||
− | A list of | + | ==Use cases== |
+ | The CLI can be used directly as shown below, but its functionality also integrates into Slicer's DICOM browser GUI via the Sicer [[Documentation/Nightly/Extensions/PETDICOM|PET DICOM Extension]]'s [[Documentation/{{documentation/version}}/Modules/DICOMRWVMPlugin|DICOM Real World Value Mapping Plugin]] and [[Documentation/{{documentation/version}}/Modules/DICOMPETSUVPlugin|DICOM PET SUV Plugin]]. | ||
+ | |||
+ | Example command line usage:<syntaxhighlight lang="bash"> | ||
+ | # list program options | ||
+ | > SUVFactorCalculator --help | ||
+ | |||
+ | # read PET DICOM image series from folder and calculate SUV normalization factors | ||
+ | > SUVFactorCalculator -p pet_dicom_folder | ||
+ | |||
+ | # create RWVM DICOM file with calculated SUV normalization factors | ||
+ | > SUVFactorCalculator -p pet_dicom_folder -f rwvm.dcm | ||
+ | |||
+ | # create SUVbw normalized volume | ||
+ | > SUVFactorCalculator -p pet_dicom_folder --SUVbw SUVbw.nrrd | ||
+ | </syntaxhighlight>A complete list of all parameters is provided in the Module Panel description below. | ||
+ | |||
+ | ==Module Panel== | ||
+ | Parameters: | ||
{| | {| | ||
| | | | ||
− | * <span style="color:blue">'''''Input Image'''''</span>: | + | *<span style="color:blue">'''''Input Image'''''</span>: |
− | ** <span style="color:green">'''PET DICOM volume path'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''PET DICOM volume path'''</span> [<span style="color:orange">--petDICOMPath</span>] [<span style="color:pink">-p</span>]: Input path to a directory containing a PET DICOM series with header information for SUV computation |
− | ** <span style="color:green">'''Instance UID of PET series'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''Instance UID of PET series'''</span> [<span style="color:orange">--petSeriesInstanceUID</span>]: Instance UID of PET series (if multiple series in PET dicom path) |
− | * <span style="color:blue">'''''SUV Factor Information'''''</span>: | + | *<span style="color:blue">'''''SUV Factor Information'''''</span>: |
− | ** <span style="color:green">'''Radioactivity Units'''</span>: DICOM Tag (0054,1001) - Radioactivity Units | + | **<span style="color:green">'''Radioactivity Units'''</span>: DICOM Tag (0054,1001) - Radioactivity Units |
− | ** <span style="color:green">'''Weight Units'''</span>: Patient weight units (always assumed to be kg) | + | **<span style="color:green">'''Weight Units'''</span>: Patient weight units (always assumed to be kg) |
− | ** <span style="color:green">'''Height Units'''</span>: Patient weight units (always assumed to be meters) | + | **<span style="color:green">'''Height Units'''</span>: Patient weight units (always assumed to be meters) |
− | ** <span style="color:green">'''Volume Units'''</span>: Volume units for concentration (always assumed to be mL) | + | **<span style="color:green">'''Volume Units'''</span>: Volume units for concentration (always assumed to be mL) |
− | ** <span style="color:green">'''Injected Dose'''</span>: DICOM Tag (0018,1074) - Radionuclide Total Dose | + | **<span style="color:green">'''Injected Dose'''</span>: DICOM Tag (0018,1074) - Radionuclide Total Dose |
− | ** <span style="color:green">'''Patient Weight'''</span>: DICOM Tag (0010,1030) - Patient Weight | + | **<span style="color:green">'''Patient Weight'''</span>: DICOM Tag (0010,1030) - Patient Weight |
− | ** <span style="color:green">'''Patient Height'''</span>: DICOM Tag (0010,1020) - Patient Size | + | **<span style="color:green">'''Patient Height'''</span>: DICOM Tag (0010,1020) - Patient Size |
− | ** <span style="color:green">'''Patient Sex'''</span>: DICOM Tag (0010,0040) - Patient Sex | + | **<span style="color:green">'''Patient Sex'''</span>: DICOM Tag (0010,0040) - Patient Sex |
− | ** <span style="color:green">'''Series Reference Time'''</span>: DICOM Tag (0008,0031) - Series Time | + | **<span style="color:green">'''Series Reference Time'''</span>: DICOM Tag (0008,0031) - Series Time |
− | ** <span style="color:green">'''Injection Time'''</span>: DICOM Tag (0018,1072) - Radiopharmaceutical Start Time | + | **<span style="color:green">'''Injection Time'''</span>: DICOM Tag (0018,1072) - Radiopharmaceutical Start Time |
− | ** <span style="color:green">'''Decay Correction'''</span>: DICOM Tag (0054,1102) - Decay Correction | + | **<span style="color:green">'''Decay Correction'''</span>: DICOM Tag (0054,1102) - Decay Correction |
− | ** <span style="color:green">'''Decay Factor'''</span>: DICOM Tag (0054,1321) - Decay Factor | + | **<span style="color:green">'''Decay Factor'''</span>: DICOM Tag (0054,1321) - Decay Factor |
− | ** <span style="color:green">'''Radionuclide Half-life'''</span>: DICOM Tag (0018,1075) - Radionuclide Half-Life | + | **<span style="color:green">'''Radionuclide Half-life'''</span>: DICOM Tag (0018,1075) - Radionuclide Half-Life |
− | ** <span style="color:green">'''Frame Reference Time'''</span>: DICOM Tag (0054,1300) - Frame Reference Time | + | **<span style="color:green">'''Frame Reference Time'''</span>: DICOM Tag (0054,1300) - Frame Reference Time |
− | ** <span style="color:green">'''SUVbw Conversion Factor'''</span>: Standardized Uptake Value (body weight) Conversion Factor | + | **<span style="color:green">'''SUVbw Conversion Factor'''</span>: Standardized Uptake Value (body weight) Conversion Factor |
− | ** <span style="color:green">'''SUVlbm Conversion Factor'''</span>: Standardized Uptake Value (lean body mass) Conversion Factor | + | **<span style="color:green">'''SUVlbm Conversion Factor'''</span>: Standardized Uptake Value (lean body mass) Conversion Factor |
− | ** <span style="color:green">'''SUVbsa Conversion Factor'''</span>: Standardized Uptake Value (body surface area) Conversion Factor | + | **<span style="color:green">'''SUVbsa Conversion Factor'''</span>: Standardized Uptake Value (body surface area) Conversion Factor |
− | ** <span style="color:green">'''SUVibw Conversion Factor'''</span>: Standardized Uptake Value (ideal body weight) Conversion Factor | + | **<span style="color:green">'''SUVibw Conversion Factor'''</span>: Standardized Uptake Value (ideal body weight) Conversion Factor |
− | * <span style="color:blue">'''''Real World Value Mapping'''''</span>: | + | *<span style="color:blue">'''''Real World Value Mapping'''''</span>: |
− | ** <span style="color:green">'''RWV mapping object DICOM volume path'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''RWV mapping object DICOM volume path'''</span> [<span style="color:orange">--rwvmDICOMPath</span>] [<span style="color:pink">-r</span>]: Output path to a directory to store the RWV object with the SUV computation result. Only used if no file name is provided. |
− | ** <span style="color:green">'''RWVM DICOM object file'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''RWVM DICOM object file'''</span> [<span style="color:orange">--rwvmDICOMFile</span>] [<span style="color:pink">-f</span>]: File name of the RWV object with the SUV computation result. Not required, default is the the DICOM instance UID. |
− | ** <span style="color:green">'''Series description'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''Series description'''</span> [<span style="color:orange">--seriesDescription</span>]: Description for the generated RVW object. |
− | ** <span style="color:green">'''Series Number'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''Series Number'''</span> [<span style="color:orange">--seriesNumber</span>]: Series number for the generated RVW object. |
− | ** <span style="color:green">'''Instance number'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''Instance number'''</span> [<span style="color:orange">--instanceNumber</span>]: Instance number for the generated RVW object. |
− | * <span style="color:blue">'''''SUV Normalized Images'''''</span>: | + | *<span style="color:blue">'''''SUV Normalized Images'''''</span>: |
− | ** <span style="color:green">'''SUVbw Volume<'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''SUVbw Volume<'''</span> [<span style="color:orange">--SUVbw</span>]: Output file path for SUVbw normalized volume. |
− | ** <span style="color:green">'''SUVlbm Volume<'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''SUVlbm Volume<'''</span> [<span style="color:orange">--SUVlbm</span>]: Output file path for SUVlbm normalized volume. |
− | ** <span style="color:green">'''SUVbsa Volume<'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''SUVbsa Volume<'''</span> [<span style="color:orange">--SUVbsa</span>]: Output file path for SUVbsa normalized volume. |
− | ** <span style="color:green">'''SUVibw Volume<'''</span> [<span style="color:orange"> | + | **<span style="color:green">'''SUVibw Volume<'''</span> [<span style="color:orange">--SUVibw</span>]: Output file path for SUVibw normalized volume. |
|[[File:SUV_Factor_Calculator_GUI_2022.png|thumb|400px|User Interface]] | |[[File:SUV_Factor_Calculator_GUI_2022.png|thumb|400px|User Interface]] | ||
|} | |} | ||
+ | ==SUV normalization factor calculation - Required metadata== | ||
+ | |||
+ | {| | ||
+ | |[[File:PET_DICOM_metadata.png|thumb|500px|DICOM metadata required for SUV normalization. Green: required for all SUV normalization factors. Orange: only required for SUVlbm, SUVbsa, and SUVibw.]] | ||
+ | |||
+ | |||
+ | SUV normalization factor computation is based on the vendor-neutral "happy path only" calculation described on the Quantitative Imaging Biomarkers Alliance (QIBA) wiki page [https://qhttps://qibawiki.rsna.org/index.php/Standardized_Uptake_Value_(SUV)#SUV_Calculation Standardized Uptake Value (SUV)]. | ||
+ | The following set of '''DICOM tags with proper values are required''' in the PET DICOM files to calculate SUV normalization factors: | ||
− | + | *(0008,0021) SeriesDate | |
− | + | *(0008,0022) AcquisitionDate | |
+ | *(0008,0031) SeriesTime | ||
+ | *(0008,0032) AcquisitionTime | ||
+ | *(0008,0060) '''Modality must be PT''' | ||
+ | *(0010,1030) '''PatientWeight >0''' | ||
+ | *(0028,0051) '''CorrectedImage must contain ATTN and DECAY or DECY''' | ||
+ | *(0054,0016) '''RadiopharmaceuticalInformationSequence''' | ||
+ | **(0018,1072) RadiopharmaceuticalStartTime or (0018,1078) RadiopharmaceuticalStartDateTime | ||
+ | **(0018,1074) RadionuclideTotalDose | ||
+ | **(0018,1075) RadionuclideHalfLife | ||
+ | *(0054,1001) '''Units must be BQML, *Bq, or *Ci''' | ||
+ | *(0054,1002) '''DecayCorrection must be START''' | ||
+ | *(0054,1300) FrameReferenceTime | ||
+ | *(0054,1321) DecayFactor | ||
− | + | For calculation of SUVlbm, SUVbsa, and SUVibw in addition: | |
+ | |||
+ | *(0010,0040) PatientSex in (M,F) | ||
+ | *(0010,1020) PatientSize >0 | ||
+ | |||
+ | One can check the existence and values of these DICOM tags, using Slicer's DICOM browser, by selecting "View DICOM metadata" from the PET series' context menu: | ||
+ | |||
+ | {| | ||
+ | |[[File:DICOM_metadata_contextmenu.png|thumb|400px|To display a PET scans DICOM metadata, select "View DICOM metadata" from the series' context menu in the DICOM browser.]] | ||
+ | |} | ||
+ | |||
+ | ==Information for Developers== | ||
*Source code: https://github.com/QIICR/Slicer-PETDICOMExtension/tree/master/SUVFactorCalculatorCLI | *Source code: https://github.com/QIICR/Slicer-PETDICOMExtension/tree/master/SUVFactorCalculatorCLI | ||
− | + | ==References== | |
Sugawara et al. "Reevaluation of the Standardized Uptake Value for FDG: Variation with Body Weight and Methods for Correction." Radiology. 1999.<br> | Sugawara et al. "Reevaluation of the Standardized Uptake Value for FDG: Variation with Body Weight and Methods for Correction." Radiology. 1999.<br> | ||
http://pubs.rsna.org/doi/pdf/10.1148/radiology.213.2.r99nv37521 | http://pubs.rsna.org/doi/pdf/10.1148/radiology.213.2.r99nv37521 | ||
+ | |} |
Latest revision as of 21:03, 8 April 2022
Home < Documentation < Nightly < Modules < SUVFactorCalculator
For the latest Slicer documentation, visit the read-the-docs. |
Introduction and Acknowledgements
Acknowledgments:
The UIowa QIN PET DICOM Extension was funded in part by Quantitative Imaging to Assess Response in Cancer Therapy Trials NIH grant U01-CA140206 and Quantitative Image Informatics for Cancer Research (QIICR) NIH grant U24 CA180918. License: Slicer License | |||||||
|
General Information
The SUVFactorCalculator Command Line Interface (CLI) takes a PET DICOM series and computes Standardized Uptake Value conversion factors (SUVbw, SUBlbm, SUVbs, SUVibw). Those SUV factors can be stored in a DICOM Real World Value Mapping (RWVM) file and SUV normalized image volumes can be generated.
Depending on the information stored in the PET DICOM header, 4 types of SUV factors can be calculated as summarized here, where weight is in kilograms and height is in centimeters.
- SUVbw:
- males & females: weight
- SUVlbm:
- males: 1.10 * weight - 128 * (weight/height)^2
- females: 1.07 * weight - 148 * (weight/height)^2
- SUVbsa:
- males & females: weight^0.425 * height^0.725 * 0.007184
- SUVibw:
- males: 48.0 + 1.06 * (height - 152)
- females: 45.5 + 0.91 * (height - 152)
Use cases
The CLI can be used directly as shown below, but its functionality also integrates into Slicer's DICOM browser GUI via the Sicer PET DICOM Extension's DICOM Real World Value Mapping Plugin and DICOM PET SUV Plugin.
Example command line usage:
# list program options
> SUVFactorCalculator --help
# read PET DICOM image series from folder and calculate SUV normalization factors
> SUVFactorCalculator -p pet_dicom_folder
# create RWVM DICOM file with calculated SUV normalization factors
> SUVFactorCalculator -p pet_dicom_folder -f rwvm.dcm
# create SUVbw normalized volume
> SUVFactorCalculator -p pet_dicom_folder --SUVbw SUVbw.nrrd
A complete list of all parameters is provided in the Module Panel description below.
Module Panel
Parameters:
|
SUV normalization factor calculation - Required metadata
For calculation of SUVlbm, SUVbsa, and SUVibw in addition:
One can check the existence and values of these DICOM tags, using Slicer's DICOM browser, by selecting "View DICOM metadata" from the PET series' context menu: Information for DevelopersReferencesSugawara et al. "Reevaluation of the Standardized Uptake Value for FDG: Variation with Body Weight and Methods for Correction." Radiology. 1999. |