Difference between revisions of "Modules:CreateaDicomSeries-Documentation-3.4"

From Slicer Wiki
Jump to: navigation, search
Line 1: Line 1:
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
+
[[Documentation-3.4|Return to Slicer 3.4 Documentation]]
 
__NOTOC__
 
__NOTOC__
 
===Module Name===
 
===Module Name===
Line 59: Line 59:
 
Source Code: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/ImageReadDicomWrite.cxx?view=annotate  Create a DICOM Series]
 
Source Code: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/ImageReadDicomWrite.cxx?view=annotate  Create a DICOM Series]
  
Documentation:
+
Usage:
 +
<pre>
 +
  ./ImageReadDicomWrite  [--processinformationaddress <std::string>]
 +
                          [--xml] [--echo] [--reverseImages] [--dicomPrefix
 +
                          <std::string>] [--dicomDirectory <std::string>]
 +
                          [--rescaleSlope <double>] [--rescaleInterscept
 +
                          <double>] [--seriesDescription <std::string>]
 +
                          [--seriesNumber <std::string>] [--model
 +
                          <std::string>] [--manufacturer <std::string>]
 +
                          [--modality <std::string>] [--studyDescription
 +
                          <std::string>] [--studyComments <std::string>]
 +
                          [--studyDate <std::string>] [--studyID
 +
                          <std::string>] [--patientComments <std::string>]
 +
                          [--patientID <std::string>] [--patientName
 +
                          <std::string>] [--] [--version] [-h]
 +
                          <std::string>
 +
 
 +
 
 +
Where:
 +
 
 +
  --processinformationaddress <std::string>
 +
    Address of a structure to store process information (progress, abort,
 +
    etc.). (default: 0)
 +
 
 +
  --xml
 +
    Produce xml description of command line arguments (default: 0)
 +
 
 +
  --echo
 +
    Echo the command line arguments (default: 0)
 +
 
 +
  --reverseImages
 +
    Reverse the slices. (default: 0)
 +
 
 +
  --dicomPrefix <std::string>
 +
    The prefix of the DICOM filename. (default: IMG)
 +
 
 +
  --dicomDirectory <std::string>
 +
    The directory to contain the DICOM series. (default: ./)
 +
 
 +
  --rescaleSlope <double>
 +
    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).
 +
    (default: 1)
 +
 
 +
  --rescaleInterscept <double>
 +
    Rescale interscept [0028-1052]. Converts pixel values on disk to pixel
 +
    values in memory. (Pixel value in memory) = (Pixel value on disk) *
 +
    rescaleSlope + rescaleInterscept.  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).
 +
    (default: 0)
 +
 
 +
  --seriesDescription <std::string>
 +
    Series description [0008-103E] (default: None)
 +
 
 +
  --seriesNumber <std::string>
 +
    The series number [0020-0011] (default: 123456)
 +
 
 +
  --model <std::string>
 +
    model [0008-1090] (default: None)
 +
 
 +
  --manufacturer <std::string>
 +
    Manufacturer [0008-0070] (default: GE Medical Systems)
 +
 
 +
  --modality <std::string>
 +
    Modality [0008-0060] (default: CT)
 +
 
 +
  --studyDescription <std::string>
 +
    Study description[0008-1030] (default: None)
 +
 
 +
  --studyComments <std::string>
 +
    Study comments[0032-4000] (default: None)
 +
 
 +
  --studyDate <std::string>
 +
    The date of the study [0008-0020] (default: 20060101)
 +
 
 +
  --studyID <std::string>
 +
    The study ID [0020-0010] (default: 123456)
 +
 
 +
  --patientComments <std::string>
 +
    Patient comments [0010-4000] (default: None)
 +
 
 +
  --patientID <std::string>
 +
    The patient ID [0010-0020] (default: 123456)
 +
 
 +
  --patientName <std::string>
 +
    The name of the patient [0010-0010] (default: Anonymous)
 +
 
 +
  --,  --ignore_rest
 +
    Ignores the rest of the labeled arguments following this flag.
 +
 
 +
  --version
 +
    Displays version information and exits.
 +
 
 +
  -h,  --help
 +
    Displays usage information and exits.
 +
 
 +
  <std::string>
 +
    (required)  Input volume to be resampled
 +
 
 +
 
 +
  Description: Create a DICOM Series
 +
 
 +
  Author(s): Bill Lorensen
 +
 
 +
  Acknowledgements: This command module was derived from Insight/Examples
 +
  (copyright) Insight Software Consortium
 +
</pre>
  
 
== More Information ==  
 
== More Information ==  

Revision as of 17:15, 7 February 2009

Home < Modules:CreateaDicomSeries-Documentation-3.4

Return to Slicer 3.4 Documentation

Module Name

Creat a DICOM Series

Caption 1
Caption 2
Caption 3

General Information

Module Type & Category

Type: CLI

Category: Base or (Filtering, Registration, etc.)

Authors, Collaborators & Contact

  • Author: Bill Lorensen
  • Contact: bill.lorensen at gmail.com

Module Description

Overview of what the module does goes here.

Usage

Examples, Use Cases & Tutorials

  • Note use cases for which this module is especially appropriate, and/or link to examples.
  • Link to examples of the module's use
  • Link to any existing tutorials

Quick Tour of Features and Use

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

  • Input panel:
  • Parameters panel:
  • Output panel:
  • Viewing panel:

Development

Dependencies

Other modules or packages that are required for this module's use.

Known bugs

Follow this link to the Slicer3 bug tracker.


Usability issues

Follow this link to the Slicer3 bug tracker. Please select the usability issue category when browsing or contributing.

Source code & documentation

Source Code: Create a DICOM Series

Usage:

   ./ImageReadDicomWrite  [--processinformationaddress <std::string>]
                          [--xml] [--echo] [--reverseImages] [--dicomPrefix
                          <std::string>] [--dicomDirectory <std::string>]
                          [--rescaleSlope <double>] [--rescaleInterscept
                          <double>] [--seriesDescription <std::string>]
                          [--seriesNumber <std::string>] [--model
                          <std::string>] [--manufacturer <std::string>]
                          [--modality <std::string>] [--studyDescription
                          <std::string>] [--studyComments <std::string>]
                          [--studyDate <std::string>] [--studyID
                          <std::string>] [--patientComments <std::string>]
                          [--patientID <std::string>] [--patientName
                          <std::string>] [--] [--version] [-h]
                          <std::string>


 Where: 

   --processinformationaddress <std::string>
     Address of a structure to store process information (progress, abort,
     etc.). (default: 0)

   --xml
     Produce xml description of command line arguments (default: 0)

   --echo
     Echo the command line arguments (default: 0)

   --reverseImages
     Reverse the slices. (default: 0)

   --dicomPrefix <std::string>
     The prefix of the DICOM filename. (default: IMG)

   --dicomDirectory <std::string>
     The directory to contain the DICOM series. (default: ./)

   --rescaleSlope <double>
     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).
     (default: 1)

   --rescaleInterscept <double>
     Rescale interscept [0028-1052]. Converts pixel values on disk to pixel
     values in memory. (Pixel value in memory) = (Pixel value on disk) *
     rescaleSlope + rescaleInterscept.  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).
     (default: 0)

   --seriesDescription <std::string>
     Series description [0008-103E] (default: None)

   --seriesNumber <std::string>
     The series number [0020-0011] (default: 123456)

   --model <std::string>
     model [0008-1090] (default: None)

   --manufacturer <std::string>
     Manufacturer [0008-0070] (default: GE Medical Systems)

   --modality <std::string>
     Modality [0008-0060] (default: CT)

   --studyDescription <std::string>
     Study description[0008-1030] (default: None)

   --studyComments <std::string>
     Study comments[0032-4000] (default: None)

   --studyDate <std::string>
     The date of the study [0008-0020] (default: 20060101)

   --studyID <std::string>
     The study ID [0020-0010] (default: 123456)

   --patientComments <std::string>
     Patient comments [0010-4000] (default: None)

   --patientID <std::string>
     The patient ID [0010-0020] (default: 123456)

   --patientName <std::string>
     The name of the patient [0010-0010] (default: Anonymous)

   --,  --ignore_rest
     Ignores the rest of the labeled arguments following this flag.

   --version
     Displays version information and exits.

   -h,  --help
     Displays usage information and exits.

   <std::string>
     (required)  Input volume to be resampled


   Description: Create a DICOM Series

   Author(s): Bill Lorensen

   Acknowledgements: This command module was derived from Insight/Examples
   (copyright) Insight Software Consortium

More Information

Acknowledgment

This work is part of 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. Information on the National Centers for Biomedical Computing can be obtained from National Centers for Biomedical Computing.

References