Difference between revisions of "Documentation/4.0/Modules/PETStandardUptakeValueComputation"

From Slicer Wiki
Jump to: navigation, search
Line 9: Line 9:
 
This work is part of the National Alliance for Medical Image Computing (NA-MIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on NA-MIC can be obtained from the [http://www.na-mic.org/ NA-MIC website].<br>
 
This work is part of the National Alliance for Medical Image Computing (NA-MIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on NA-MIC can be obtained from the [http://www.na-mic.org/ NA-MIC website].<br>
 
Author: Wendy Plesniak, SPL<br>
 
Author: Wendy Plesniak, SPL<br>
Contributor1: FIRSTNAME LASTNAME, AFFILIATION<br>
+
Contributor1: Ron Kikinis, SPL<br>
Contributor2: FIRSTNAME LASTNAME, AFFILIATION<br>
+
Contributor2: Nicole Aucoin, SPL<br>
 
Contact: Wendy Plesniak, <email>wjp@bwh.harvard.edu</email><br>
 
Contact: Wendy Plesniak, <email>wjp@bwh.harvard.edu</email><br>
 
{{documentation/{{documentation/version}}/module-introduction-row}}
 
{{documentation/{{documentation/version}}/module-introduction-row}}
Line 21: Line 21:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
 
{{documentation/{{documentation/version}}/module-section|Module Description}}
Here comes a description what the module is good for. Explain briefly how it works and point to the [[documentation/{{documentation/version}}/Modules/{{documentation/modulename}}#References|references]] giving more details on the algorithm.
+
Computes the standardized uptake value based on body weight.  
 +
[[documentation/{{documentation/version}}/Modules/{{documentation/modulename}}#References|references]] gives more details on the algorithm.
  
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
 
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
If you are documenting a CLI, the description should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-description|xmlurl=http://path/to/YOURMODULE.xml }}</pre>
+
{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|18730}} }}
 
 
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
 
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
 
 
 
Using this later template, the final syntax would be:
 
<pre>{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
Line 41: Line 36:
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
  
This command line module was developed for a special use case in which many different VOIs were specified on the fused structural and PET images; SUVmax, SUVin were computed for each of these labels and the resulting quanitative measures were output to a comma-separated value (csv) file of the user's choosing.  
+
This command line module was developed for a special use case in which many different VOIs were specified on the fused structural and PET images; SUV maximum, SUV minimum, SUV mean were computed for each of these labels and the resulting quanitative measures were output to a comma-separated value (csv) file of the user's choosing.  
  
Since various study parameters for the datasets are required for these measurements, a parameter file is also provided to the computation. This parameter file contains information either previously extracted from the DICOM header or from other study records.
+
Since various study parameters for the datasets are required for these measurements, a pointer to the DICOM directory is also provided to the computation.  
  
This module does not visualize the functional and structural dataset, nor does it show resulting quantitative measures in Slicer's interface. Instead, it saves all measurements to the csv file.
+
This module does not visualize the functional and structural dataset. Instead, it saves all measurements to the csv file as well as showing the following quantitative measures in Slicer's interface: label name, label value, SUV max, SUV mean, SUV minimum.
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
Line 56: Line 51:
 
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
 
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
  
 +
<!--
 
{|style="width: 100%"
 
{|style="width: 100%"
 
|
 
|
Line 73: Line 69:
 
|
 
|
 
}
 
}
 +
-->
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
* Point to other modules that have similar functionality
+
* The Slicer3 PETCTFusion module formed the basis of this module.
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|References}}
 
{{documentation/{{documentation/version}}/module-section|References}}
Publications related to this module go here. Links to pdfs would be useful.
+
Publications related to this module:
For extensions: link to the source code repository and additional documentation
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
+
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=CLI|category=Quantification}}
 
 
 
 
<!-- ----------------------------------------------------------------- -->
 
<!-- THE FOLLOWING SHOULD BE REMOVED FOR YOUR OWN MODULE DOCUMENTATION -->
 
<!-- ----------------------------------------------------------------- -->
 
{{note}}The section above is generated using the following wiki code:
 
<pre>
 
{{documentation/{{documentation/version}}/module-section|Information for Developers}}
 
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}
 
</pre>
 
 
 
If you are documenting a CLI, the category should be extracted from the corresponding XML description. This could be done automatically using the following wiki template:<pre>{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}</pre>
 
 
 
If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:
 
<pre>{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}</pre>
 
  
Using this later template, the final syntax would be:
+
{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation modulename}}|18730}} }}
<pre>{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}</pre>
 
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
 
<!-- ----------------------------------------------------------------- -->
Line 110: Line 90:
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-footer|category=Example}}
+
{{documentation/{{documentation/version}}/module-footer|category=Quantification}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Revision as of 22:58, 22 November 2011

Home < Documentation < 4.0 < Modules < PETStandardUptakeValueComputation


Introduction and Acknowledgements

This work is part of the National Alliance for Medical Image Computing (NA-MIC), funded by the National Institutes of Health through the NIH Roadmap for Medical Research, Grant U54 EB005149. Information on NA-MIC can be obtained from the NA-MIC website.
Author: Wendy Plesniak, SPL
Contributor1: Ron Kikinis, SPL
Contributor2: Nicole Aucoin, SPL
Contact: Wendy Plesniak, <email>wjp@bwh.harvard.edu</email>

Surgical Planning Laboratory  
NA-MIC  

Module Description

Computes the standardized uptake value based on body weight. references gives more details on the algorithm.

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.


Use Cases

This command line module was developed for a special use case in which many different VOIs were specified on the fused structural and PET images; SUV maximum, SUV minimum, SUV mean were computed for each of these labels and the resulting quanitative measures were output to a comma-separated value (csv) file of the user's choosing.

Since various study parameters for the datasets are required for these measurements, a pointer to the DICOM directory is also provided to the computation.

This module does not visualize the functional and structural dataset. Instead, it saves all measurements to the csv file as well as showing the following quantitative measures in Slicer's interface: label name, label value, SUV max, SUV mean, SUV minimum.

Tutorials

Links to tutorials that use this module

Panels and their use

A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:


Similar Modules

  • The Slicer3 PETCTFusion module formed the basis of this module.

References

Publications related to this module:

Information for Developers

Quantification