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

From SlicerWiki
Jump to: navigation, search
(Created page with '<!-- ---------------------------- --> {{documentation/{{documentation/version}}/module-header}} <!-- ---------------------------- --> <!-- ---------------------------- --> {{doc…')
 
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(23 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-header}}
 
{{documentation/{{documentation/version}}/module-header}}
Line 5: Line 6:
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
{{documentation/{{documentation/version}}/module-introduction-start|<CreateaDicomSeries>|image=screenshotBlankNotOptional.png}}
+
{{documentation/{{documentation/version}}/module-introduction-start|{{documentation/modulename}}}}
* This work is part of Bill Lorensens volunteering effort.
+
{{documentation/{{documentation/version}}/module-introduction-row}}
* Author: <Bill> <Lorensen>, <Bills Basement>
+
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>
* Contact: {{documentation/{{documentation/version}}/contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
+
Author: Jim Miller, GE<br>
{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}}
+
Contact: Jim Miller <email>millerjv@ge.com</email><br>
{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}}
+
{{documentation/{{documentation/version}}/module-introduction-row}}
 +
{{documentation/{{documentation/version}}/module-introduction-logo-gallery
 +
|Image:GE-logo.png|GE
 +
|Image:Itk-logo.jpg|Itk
 +
|Image:NAMIC 380x463.jpg|NA-MIC
 +
}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
{{note}}The section above is generated using the following wiki code:
 
<pre>
 
{{documentation/{{documentation/version}}/module-section|Introduction and Acknowledgements}}
 
{{documentation/{{documentation/version}}/module-introduction-start|<Put the name of the module here>|image=screenshotBlankNotOptional.png}}
 
* 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].
 
* Author: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
 
* Contributor1: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
 
* Contributor2: <FIRSTNAME> <LASTNAME>, <AFFILIATION>
 
* Contact: {{documentation/{{documentation/version}}/contact|name=<FIRSTNAME> <LASTNAME>|email=EmailIsRequired}}
 
{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-isomics.png|caption=Replace this logo with yours}}
 
{{documentation/{{documentation/version}}/module-introduction-logo|image=Logo-splnew.jpg|caption=Replace this logo with yours}}
 
{{documentation/{{documentation/version}}/module-introduction-end}}
 
</pre>
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{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/YOURMODULENAME#References|references]] giving more details on the algorithm.
+
{{documentation/{{documentation/version}}/module-description}}
 
 
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-cli-description|xmlurl=http://path/to/YOURMODULE.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|YOURMODULENAME|SVNREVISION}}</pre>
 
 
 
Using this later template, the final syntax would be:
 
<pre>{{documentation/{{documentation/version}}/module-cli-description|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|YOURMODULENAME|SVNREVISION}} }}</pre>
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
 
{{documentation/{{documentation/version}}/module-section|Use Cases}}
Most frequently used for these scenarios:
+
Slicer writes out data in a number of different formats. This behavior is controlled through the Save function in the File pull down in the top left of the Main GUI. In the case of a user of Slicer needing a volume in Dicom format, this module can be used to accomplish this.
 
 
* Use Case 1:
 
* Use Case 2:
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
 
{{documentation/{{documentation/version}}/module-section|Tutorials}}
Links to tutorials that use this module
+
N/A
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
{{documentation/{{documentation/version}}/module-section|Panels and their use}}
 
+
{{documentation/{{documentation/version}}/module-parametersdescription}}
A list of all the panels in the interface, their features, what they mean, and how to use them. For instance:
 
 
 
{|style="width: 100%"
 
|
 
* Input panel1:
 
** First input
 
** Second input
 
* Parameters panel:
 
** First parameter
 
** Second parameter
 
* Output panel:
 
** First output
 
** Second output
 
* Viewing panel:
 
| align="right" |
 
[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 1]]
 
|-
 
|
 
* Input panel2:
 
** First input
 
** Second input
 
* Parameters panel:
 
** First parameter
 
** Second parameter
 
* Output panel:
 
** First output
 
** Second output
 
* Viewing panel:
 
| align="right" |
 
[[Image:screenshotBlankNotOptional.png|thumb|280px|Name of panel 2]]
 
|}
 
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
 
{{documentation/{{documentation/version}}/module-section|Similar Modules}}
* Point to other modules that have similar functionality
+
* See the [[Documentation/{{documentation/version}}/Modules/DICOM|DICOM Module]] for a user interface that allows you to associate your output DICOM files with an existing DICOM Study.
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
 
{{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.
+
N/A
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}}
 
 
 
 
{{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-cli-category|xmlurl=http://path/to/YOURMODULE.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|YOURMODULENAME|SVNREVISION}}</pre>
 
 
 
Using this later template, the final syntax would be:
 
<pre>{{documentation/{{documentation/version}}/module-cli-category|xmlurl={{documentation/{{documentation/version}}/module-cli-xmlurl|YOURMODULENAME|SVNREVISION}} }}</pre>
 
  
  
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->
{{documentation/{{documentation/version}}/module-footer|category=Example}}
+
{{documentation/{{documentation/version}}/module-footer}}
 
<!-- ---------------------------- -->
 
<!-- ---------------------------- -->

Latest revision as of 02:33, 14 June 2013

Home < Documentation < 4.0 < Modules < CreateDICOMSeries

For the latest Slicer documentation, visit the 4.10 page.


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: Jim Miller, GE
Contact: Jim Miller

GE  
Itk  
NA-MIC  

Module Description

Create a DICOM Series from a Slicer volume. User can specify values for selected DICOM tags in the UI. Given the number of tags DICOM series have, it is impossible to expose all tags in UI. So only important tags can be set by the user.


Use Cases

Slicer writes out data in a number of different formats. This behavior is controlled through the Save function in the File pull down in the top left of the Main GUI. In the case of a user of Slicer needing a volume in Dicom format, this module can be used to accomplish this.

Tutorials

N/A

Panels and their use

Parameters:

  • Patient Parameters
    • Patient Name: The name of the patient [0010-0010]
    • Patient ID: The patient ID [0010-0020]
    • Patient Comments: Patient comments [0010-4000]
  • Study Parameters
    • Study ID: The study ID [0020-0010]
    • Study Date: The date of the study [0008-0020]
    • Study Comments: Study comments[0032-4000]
    • Study Descriptions: Study description[0008-1030]
    • Modality: Modality [0008-0060]
    • Manufacturer: Manufacturer [0008-0070]
    • Model: model [0008-1090]
  • Series Parameters
    • Series Number: The series number [0020-0011]
    • Series Description: Series description [0008-103E]
  • Image Parameters
    • Rescale intercept: Rescale interscept [0028-1052]. Converts pixel values on disk to pixel values in memory. (Pixel value in memory) = (Pixel value on disk) * rescaleSlope + rescaleIntercept. Default is 0.0. Data values are converted on write (the data is scaled and shifted so that the slope and interscept will bring it back to the current intensity range).
    • Rescale slope: Rescale slope [0028-1053]. Converts pixel values on disk to pixel values in memory. (Pixel value in memory) = (Pixel value on disk) * rescaleSlope + rescaleInterscept. Default is 1.0. Data values are converted on write (the data is scaled and shifted so that the slope and interscept will bring it back to the current intensity range).
  • Input
    • Input Volume: Input volume to be resampled
  • Output
    • DICOM Directory: The directory to contain the DICOM series.
    • DICOM filename prefix: The prefix of the DICOM filename.
    • DICOM file number format: The printf-style format to be used when creating the per-slice DICOM filename.
    • Reverse Slices: Reverse the slices.
    • Use Compression: Compress the output pixel data.


Similar Modules

  • See the DICOM Module for a user interface that allows you to associate your output DICOM files with an existing DICOM Study.

References

N/A

Information for Developers