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

From Slicer Wiki
Jump to: navigation, search
Line 58: Line 58:
  
 
Source Code: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/OrientImage.cxx?view=annotate OrientImage.cxx]
 
Source Code: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/OrientImage.cxx?view=annotate OrientImage.cxx]
 +
 
XML Description: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/OrientImage.xml?view=co Orient orientImage.xml]
 
XML Description: [http://www.na-mic.org/ViewVC/index.cgi/trunk/Applications/CLI/OrientImage.xml?view=co Orient orientImage.xml]
  
 
Usage:
 
Usage:
 
<pre>
 
<pre>
  ./OrientImage  [--processinformationaddress <std::string>] [--xml]
+
./OrientImage  [--processinformationaddress <std::string>] [--xml]
                  [--echo] [-o <Axial|Coronal|Sagittal|RIP|LIP|RSP|LSP|RIA
+
              [--echo] [-o <Axial|Coronal|Sagittal|RIP|LIP|RSP|LSP|RIA
                  |LIA|RSA|LSA|IRP|ILP|SRP|SLP|IRA|ILA|SRA|SLA|RPI|LPI|RAI
+
              |LIA|RSA|LSA|IRP|ILP|SRP|SLP|IRA|ILA|SRA|SLA|RPI|LPI|RAI
                  |LAI|RPS|LPS|RAS|LAS|PRI|PLI|ARI|ALI|PRS|PLS|ARS|ALS|IPR
+
              |LAI|RPS|LPS|RAS|LAS|PRI|PLI|ARI|ALI|PRS|PLS|ARS|ALS|IPR
                  |SPR|IAR|SAR|IPL|SPL|IAL|SAL|PIR|PSR|AIR|ASR|PIL|PSL|AIL
+
              |SPR|IAR|SAR|IPL|SPL|IAL|SAL|PIR|PSR|AIR|ASR|PIL|PSL|AIL
                  |ASL>] [--] [--version] [-h] <std::string> <std::string>
+
              |ASL>] [--] [--version] [-h] <std::string> <std::string>
  
  
 
Where:  
 
Where:  
  
  --processinformationaddress <std::string>
+
--processinformationaddress <std::string>
    Address of a structure to store process information (progress, abort,
+
  Address of a structure to store process information (progress, abort,
    etc.). (default: 0)
+
  etc.). (default: 0)
  
  --xml
+
--xml
    Produce xml description of command line arguments (default: 0)
+
  Produce xml description of command line arguments (default: 0)
  
  --echo
+
--echo
    Echo the command line arguments (default: 0)
+
  Echo the command line arguments (default: 0)
  
  -o <Axial|Coronal|Sagittal|RIP|LIP|RSP|LSP|RIA|LIA|RSA|LSA|IRP|ILP|SRP
+
-o <Axial|Coronal|Sagittal|RIP|LIP|RSP|LSP|RIA|LIA|RSA|LSA|IRP|ILP|SRP
      |SLP|IRA|ILA|SRA|SLA|RPI|LPI|RAI|LAI|RPS|LPS|RAS|LAS|PRI|PLI|ARI|ALI
+
  |SLP|IRA|ILA|SRA|SLA|RPI|LPI|RAI|LAI|RPS|LPS|RAS|LAS|PRI|PLI|ARI|ALI
      |PRS|PLS|ARS|ALS|IPR|SPR|IAR|SAR|IPL|SPL|IAL|SAL|PIR|PSR|AIR|ASR|PIL
+
  |PRS|PLS|ARS|ALS|IPR|SPR|IAR|SAR|IPL|SPL|IAL|SAL|PIR|PSR|AIR|ASR|PIL
      |PSL|AIL|ASL>,  --orientation <Axial|Coronal|Sagittal|RIP|LIP|RSP|LSP
+
  |PSL|AIL|ASL>,  --orientation <Axial|Coronal|Sagittal|RIP|LIP|RSP|LSP
      |RIA|LIA|RSA|LSA|IRP|ILP|SRP|SLP|IRA|ILA|SRA|SLA|RPI|LPI|RAI|LAI|RPS
+
  |RIA|LIA|RSA|LSA|IRP|ILP|SRP|SLP|IRA|ILA|SRA|SLA|RPI|LPI|RAI|LAI|RPS
      |LPS|RAS|LAS|PRI|PLI|ARI|ALI|PRS|PLS|ARS|ALS|IPR|SPR|IAR|SAR|IPL|SPL
+
  |LPS|RAS|LAS|PRI|PLI|ARI|ALI|PRS|PLS|ARS|ALS|IPR|SPR|IAR|SAR|IPL|SPL
      |IAL|SAL|PIR|PSR|AIR|ASR|PIL|PSL|AIL|ASL>
+
  |IAL|SAL|PIR|PSR|AIR|ASR|PIL|PSL|AIL|ASL>
    Orientation choices (default: LPS)
+
  Orientation choices (default: LPS)
  
  --,  --ignore_rest
+
--,  --ignore_rest
    Ignores the rest of the labeled arguments following this flag.
+
  Ignores the rest of the labeled arguments following this flag.
  
  --version
+
--version
    Displays version information and exits.
+
  Displays version information and exits.
  
  -h,  --help
+
-h,  --help
    Displays usage information and exits.
+
  Displays usage information and exits.
  
  <std::string>
+
<std::string>
    (required)  Input volume 1
+
  (required)  Input volume 1
  
  <std::string>
+
<std::string>
    (required)  The oriented volume
+
  (required)  The oriented volume
  
  
  Description: Orients an output volume. Rearranges the slices in a volume
+
Description: Orients an output volume. Rearranges the slices in a volume
  accoording to the selected orientation. The resulting volume will cover
+
accoording to the selected orientation. The resulting volume will cover
  the original volume.
+
the original volume.
  
  Author(s): Bill Lorensen
+
Author(s): Bill Lorensen
  
  Acknowledgements: This work is part of the National Alliance for Medical
+
Acknowledgements: This work is part of the National Alliance for Medical
  Image Computing (NAMIC), funded by the National Institutes of Health
+
Image Computing (NAMIC), funded by the National Institutes of Health
  through the NIH Roadmap for Medical Research, Grant U54 EB005149.
+
through the NIH Roadmap for Medical Research, Grant U54 EB005149.
 
</pre>
 
</pre>
  

Revision as of 17:20, 7 February 2009

Home < Modules:OrientImages-Documentation-3.4

Return to Slicer 3.4 Documentation

Module Name

Orient Images

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: OrientImage.cxx

XML Description: Orient orientImage.xml

Usage:

./OrientImage  [--processinformationaddress <std::string>] [--xml]
               [--echo] [-o <Axial|Coronal|Sagittal|RIP|LIP|RSP|LSP|RIA
               |LIA|RSA|LSA|IRP|ILP|SRP|SLP|IRA|ILA|SRA|SLA|RPI|LPI|RAI
               |LAI|RPS|LPS|RAS|LAS|PRI|PLI|ARI|ALI|PRS|PLS|ARS|ALS|IPR
               |SPR|IAR|SAR|IPL|SPL|IAL|SAL|PIR|PSR|AIR|ASR|PIL|PSL|AIL
               |ASL>] [--] [--version] [-h] <std::string> <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)

-o <Axial|Coronal|Sagittal|RIP|LIP|RSP|LSP|RIA|LIA|RSA|LSA|IRP|ILP|SRP
   |SLP|IRA|ILA|SRA|SLA|RPI|LPI|RAI|LAI|RPS|LPS|RAS|LAS|PRI|PLI|ARI|ALI
   |PRS|PLS|ARS|ALS|IPR|SPR|IAR|SAR|IPL|SPL|IAL|SAL|PIR|PSR|AIR|ASR|PIL
   |PSL|AIL|ASL>,  --orientation <Axial|Coronal|Sagittal|RIP|LIP|RSP|LSP
   |RIA|LIA|RSA|LSA|IRP|ILP|SRP|SLP|IRA|ILA|SRA|SLA|RPI|LPI|RAI|LAI|RPS
   |LPS|RAS|LAS|PRI|PLI|ARI|ALI|PRS|PLS|ARS|ALS|IPR|SPR|IAR|SAR|IPL|SPL
   |IAL|SAL|PIR|PSR|AIR|ASR|PIL|PSL|AIL|ASL>
  Orientation choices (default: LPS)

--,  --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 1

<std::string>
  (required)  The oriented volume


Description: Orients an output volume. Rearranges the slices in a volume
accoording to the selected orientation. The resulting volume will cover
the original volume.

Author(s): Bill Lorensen

Acknowledgements: 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.

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