]> Creatis software - gdcm.git/blobdiff - Doc/Website/CommandLine.html
Fix bug on SplitOnly
[gdcm.git] / Doc / Website / CommandLine.html
index dceb88f46ac23676fce4b27381d21d62ca392fc4..d18639ed3c454b60b651e2424097b7b3d9d0c497 100644 (file)
 <BODY>
 <H2>Command Line Utilities :</H2>
 <UL>
-   <LI> PrintFile
+   <LI> <b>PrintFile</b>
+        <font size=-1>
    <pre>
-   Display the header of any kind of ACR-NEMA/PAPYRUS/DICOM File
-   usage: PrintFile filein=fileName [level=n] [noshadow] [noseq] [debug]
+   Displays the header of any kind of ACR-NEMA/PAPYRUS/DICOM File
+   usage: PrintFile filein=fileName [level=n] 
+                    [ { [noshadowseq] | [noshadow][noseq] } ] [debug] [usage]
           level = 0,1,2 : depending on the amount of details user wants to see
-          noshadow : user doesn't want to load Private groups (odd number)
-          noseq    : user doesn't want to load Sequences
-          debug    : user wants to run the program in 'debug mode'
+          noshadowseq: user doesn't want to load Private Sequences
+          noshadow   : user doesn't want to load Private groups (odd number)
+          noseq      : user doesn't want to load Sequences
+          debug      : user wants to run the program in 'debug mode'
+          usage      : user wants to display usage
    </pre>
+   </font>
 
-   <LI> Anonymize
+   <LI> <b>Anonymize</b>
+        <font size=-1>
    <pre>
-   Anonymize a full gdcm-readable Dicom image
+   Anonymizes a full gdcm-readable Dicom image
           Warning : probably segfaults if pixels are not gdcm readable.
                     Use AnonymizeNoLoad instead.
-   usage: Anonymize filein=inputFileName fileout=anonymizedFileName [debug]
+   usage: Anonymize filein=inputFileName fileout=anonymizedFileName [debug][usage]
           debug    : user wants to run the program in 'debug mode'
-   </pre>
+          usage    : user wants to display usage
+  </pre>
+   </font>
 
-   <LI> AnonymizeNoLoad
+   <LI> <b>AnonymizeNoLoad</b>
+        <font size=-1>
    <pre> 
-   Anonymize a gdcm-readable Dicom image even if pixels aren't gdcm readable
-          Warning : the file is overwritten; to preserve file integrity,
-                    use a copy.
-   usage: AnonymizeNoLoad filein=inputFileName fileout=outputFileName [debug]
-          debug    : user wants to run the program in 'debug mode'
+   Anonymizes a gdcm-readable Dicom image even if pixels aren't gdcm readable
+         Warning : the image is overwritten;
+                   to preserve its integrity, use a copy.
+   usage: AnonymizeNoLoad {filein=inputFileName|dirin=inputDirectoryName}
+                          [rubout=listOfPrivateElementsToRubOut]
+                          [ { [noshadowseq] | [noshadow][noseq] } ] [debug]
+          inputFileName : Name of the (single) file user wants to anonymize
+          inputDirectoryName : user wants to anonymize *all* the files
+                               within the (single Patient!) directory
+          listOfElementsToRubOut : group1-elem1,g2-e2,... (in hexa)
+                                   of extra Elements to rub out
+          noshadowseq: user doesn't want to load Private Sequences
+          noshadow   : user doesn't want to load Private groups (odd number)
+          noseq      : user doesn't want to load Sequences
+          debug      : user wants to run the program in 'debug mode'
+          usage      : user wants to display usage
    </pre>
+   </font>
 
-   <LI> ReWrite
+   <LI> <b>ReWrite</b>
+        <font size=-1>
    <pre>
-   Re write a full gdcm-readable Dicom image (compressed Pixels are expanded)
+   Reads and rewrites a full gdcm-readable Dicom image (compressed Pixels are expanded)
                    (usefull when the file is not very straight).                  
    usage: ReWrite filein=inputFileName fileout=anonymizedFileName
-                   [mode=write mode] [noshadow] [noseq][debug]
-          mode = a (ACR), x (Explicit VR Dicom), r (RAW : only pixels)
-          noshadow : user doesn't want to load Private groups (odd number)
-          noseq    : user doesn't want to load Sequences
-          debug    : user wants to run the program in 'debug mode' 
+                  [mode=write mode] [rgb]
+                  [ { [noshadowseq] | [noshadow][noseq] } ] [debug] [usage]
+          write mode = a (ACR), x (Explicit VR Dicom), r (RAW : only pixels)
+          rgb        : user wants to transform LUT (if any) into RGB 
+          noshadowseq: user doesn't want to load Private Sequences
+          noshadow   : user doesn't want to load Private groups (odd number)
+          noseq      : user doesn't want to load Sequences
+          debug      : user wants to run the program in 'debug mode'
+          usage      : user wants to display usage
    </pre>
+   </font>
 
-   <LI> PrintDicomDir
+   <LI> <b>PrintDicomDir</b>
+        <font size=-1>
    <pre>
-   Display the tree-like structure of a DICOMDIR File
-   usage: PrintDicomDir filein=fileName [detail=n] [level=n] [debug]
+   Displays the tree-like structure of a DICOMDIR File
+   usage: PrintDicomDir filein=fileName [detail=n] [level=n] [debug] [usage]
           detail = 1 : Patients, 2 : Studies, 3 : Series, 4 : Images
                    5 : Full Content
           level = 0,1,2 : depending on user (what he wants to see, when detail=5)
-           debug    : user wants to run the program in 'debug mode'
+          debug    : user wants to run the program in 'debug mode'
+          usage    : user wants to display usage
    </pre>
+   </font>
 
-   <LI> MakeDicomDir
-   <pre>
+   <LI> <b>MakeDicomDir</b>
+        <font size=-1>
+        <pre>
    Explores recursively the given directory, makes the relevant DICOMDIR
           and writes it as 'NewDICOMDIR'
-   usage: MakeDicomDir dirname=rootDirectoryName [noshadow] [noseq] [debug]
-          noshadow : user doesn't want to load Private groups (odd number)
-          noseq    : user doesn't want to load Sequences
-          debug    : user wants to run the program in 'debug mode'
+   usage: MakeDicomDir dirname=rootDirectoryName 
+                      [ { [noshadowseq] | [noshadow][noseq] } ] [debug] [usage]
+          noshadowseq: user doesn't want to load Private Sequence
+          noshadow   : user doesn't want to load Private groups (odd number)
+          noseq      : user doesn't want to load Sequences
+          debug      : user wants to run the program in 'debug mode'
+          usage      : user wants to display usage
    </pre>
+   </font>
 
-   <LI> AnonymizeDicomDir
+   <LI> <b>AnonymizeDicomDir</b>
+        <font size=-1>
    <pre>
-   Anonymize a gdcm-readable DICOMDIR even when some 'Objects'
+   Anonymizes a gdcm-readable DICOMDIR even when some 'Objects'
           are not yet taken into account
-          Warning : the DICOMDIR is overwritten
-   usage: AnonymizeDicomDir filein=dicomDirName [debug]
+          Warning : the DICOMDIR is overwritten; 
+                    to preserve its integrity, use a copy.
+   usage: AnonymizeDicomDir filein=dicomDirName [debug] [usage] [usage]
           debug    : user wants to run the program in 'debug mode'
+          usage    : user wants to display usage
    </pre>
+   </font>
 
+   <LI> <b>PatchHeader</b>
+   <font size=-1>
+   <pre>
+    Allows aware user to patch a gdcm-parsable image header, without 
+         loading image.
+         Warning : the image(s) is/are overwritten
+                   to preserve image(s) integrity, use a copy.
+         WARNING : *NO CHECK* is performed on the new values.
+                   Use only if you are sure the original values are wrong
+                   *and* your values are right...
+   usage: PatchHeader {filein=inputFileName|dirin=inputDirectoryName}
+               [ { [size=] | [rows=][columns=] } ] [planes=]
+               [bitsallocated=] [bitsstored=]
+               [highbit=] [samplesperpixel=]
+               [pixelrepresentation=] [samplesperpixel=]
+               [ { [noshadowseq] | [noshadow][noseq] } ] [debug]
+                                                                           
+       inputFileName : Name of the (single) file user wants to modify
+       inputDirectoryName : user wants to modify *all* the files
+                            within the directory
+       newsize         : new size, to overwrite old (wrong) one
+          or
+       rows            : new Rows number,    to overwrite old (wrong) one
+       columns         : new Columns number, to overwrite old (wrong) one
+       planes          : new Planes number,  ...
+       bitsallocated   : new Bits Allocated number,  ...
+       bitsstored      : new Bits Stored number,  ...
+       highbit         : new High Bit number,  ...
+       samplesperpixel : new Samples Per Pixel, ...
+       pixelrepresentation : new Pixel Representation, ...
+                                                                           
+       noshadowseq: user doesn't want to load Private Sequences
+       noshadow   : user doesn't want to load Private groups (odd number)
+       noseq      : user doesn't want to load Sequences
+       debug      : user wants to run the program in 'debug mode'
+       usage      : user wants to display usage
+   </pre>
+   </font>
 </UL>
 </BODY>
 </HTML>