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

From Slicer Wiki
Jump to: navigation, search
Line 40: Line 40:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
Most frequently used for these scenarios:
 
  
 
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; 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.  

Revision as of 21:48, 19 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: FIRSTNAME LASTNAME, AFFILIATION
Contributor2: FIRSTNAME LASTNAME, AFFILIATION
Contact: Wendy Plesniak, <email>wjp@bwh.harvard.edu</email>

Surgical Planning Laboratory  
NA-MIC  

Module Description

Here comes a description what the module is good for. Explain briefly how it works and point to the references giving more details on the algorithm.

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:

{{documentation/{{documentation/version}}/module-description|xmlurl=http://path/to/YOURMODULE.xml }}

If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:

{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}

Using this later template, the final syntax would be:

{{documentation/{{documentation/version}}/module-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}


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.

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.

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.

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:

  • Input panel1:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 1
  • Input panel2:
    • First input
    • Second input
  • Parameters panel:
    • First parameter
    • Second parameter
  • Output panel:
    • First output
    • Second output
  • Viewing panel:
Name of panel 2

Similar Modules

  • Point to other modules that have similar functionality

References

Publications related to this module go here. Links to pdfs would be useful. For extensions: link to the source code repository and additional documentation

Information for Developers


Note The section above is generated using the following wiki code:

{{documentation/{{documentation/version}}/module-section|Information for Developers}}
{{documentation/{{documentation/version}}/module-developerinfo|ModuleTemplate|type=Interactive|category=Example}}

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:

{{documentation/{{documentation/version}}/module-category|xmlurl=http://path/to/YOURMODULENAME.xml }}

If your module is available in Slicer repository, the following template could be useful to obtain the corresponding URL:

{{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}}

Using this later template, the final syntax would be:

{{documentation/{{documentation/version}}/module-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|{{documentation/modulename}}|SVNREVISION}} }}