Doc/Website/CommandLine.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML>
   3 <HEAD>
   4    <META http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   5    <TITLE>Command Line Utilities</TITLE>
   6 </HEAD>
   7 <BODY>
   8 <H2>Command Line Utilities :</H2>
   9 <UL>
  10    <LI> <b>PrintFile</b>
  11         <font size=-1>
  12    <pre>
  13    Displays the header of any kind of ACR-NEMA/PAPYRUS/DICOM File
  14    usage: PrintFile filein=fileName [level=n]
  15                     [ { [noshadowseq] | [noshadow][noseq] } ] [debug] [usage]
  16           level = 0,1,2 : depending on the amount of details user wants to see
  17           noshadowseq: user doesn't want to load Private Sequences
  18           noshadow   : user doesn't want to load Private groups (odd number)
  19           noseq      : user doesn't want to load Sequences
  20           debug      : user wants to run the program in 'debug mode'
  21           usage      : user wants to display usage
  22    </pre>
  23    </font>
  24
  25    <LI> <b>Anonymize</b>
  26         <font size=-1>
  27    <pre>
  28    Anonymizes a full gdcm-readable Dicom image
  29           Warning : probably segfaults if pixels are not gdcm readable.
  30                     Use AnonymizeNoLoad instead.
  31    usage: Anonymize filein=inputFileName fileout=anonymizedFileName [debug][usage]
  32           debug    : user wants to run the program in 'debug mode'
  33           usage    : user wants to display usage
  34   </pre>
  35    </font>
  36
  37    <LI> <b>AnonymizeNoLoad</b>
  38         <font size=-1>
  39    <pre>
  40    Anonymizes a gdcm-readable Dicom image even if pixels aren't gdcm readable
  41          Warning : the image is overwritten;
  42                    to preserve its integrity, use a copy.
  43    usage: AnonymizeNoLoad {filein=inputFileName|dirin=inputDirectoryName}
  44                           [rubout=listOfPrivateElementsToRubOut]
  45                           [ { [noshadowseq] | [noshadow][noseq] } ] [debug]
  46           inputFileName : Name of the (single) file user wants to anonymize
  47           inputDirectoryName : user wants to anonymize *all* the files
  48                                within the (single Patient!) directory
  49           listOfElementsToRubOut : group1-elem1,g2-e2,... (in hexa)
  50                                    of extra Elements to rub out
  51           noshadowseq: user doesn't want to load Private Sequences
  52           noshadow   : user doesn't want to load Private groups (odd number)
  53           noseq      : user doesn't want to load Sequences
  54           debug      : user wants to run the program in 'debug mode'
  55           usage      : user wants to display usage
  56    </pre>
  57    </font>
  58
  59    <LI> <b>ReWrite</b>
  60         <font size=-1>
  61    <pre>
  62    Reads and rewrites a full gdcm-readable Dicom image (compressed Pixels are expanded)
  63                    (usefull when the file is not very straight).
  64    usage: ReWrite filein=inputFileName fileout=anonymizedFileName
  65                   [mode=write mode] [rgb]
  66                   [ { [noshadowseq] | [noshadow][noseq] } ] [debug] [usage]
  67           write mode = a (ACR), x (Explicit VR Dicom), r (RAW : only pixels)
  68           rgb        : user wants to transform LUT (if any) into RGB
  69           noshadowseq: user doesn't want to load Private Sequences
  70           noshadow   : user doesn't want to load Private groups (odd number)
  71           noseq      : user doesn't want to load Sequences
  72           debug      : user wants to run the program in 'debug mode'
  73           usage      : user wants to display usage
  74    </pre>
  75    </font>
  76
  77    <LI> <b>PrintDicomDir</b>
  78         <font size=-1>
  79    <pre>
  80    Displays the tree-like structure of a DICOMDIR File
  81    usage: PrintDicomDir filein=fileName [detail=n] [level=n] [debug] [usage]
  82           detail = 1 : Patients, 2 : Studies, 3 : Series, 4 : Images
  83                    5 : Full Content
  84           level = 0,1,2 : depending on user (what he wants to see, when detail=5)
  85           debug    : user wants to run the program in 'debug mode'
  86           usage    : user wants to display usage
  87    </pre>
  88    </font>
  89
  90    <LI> <b>MakeDicomDir</b>
  91         <font size=-1>
  92         <pre>
  93    Explores recursively the given directory, makes the relevant DICOMDIR
  94           and writes it as 'NewDICOMDIR'
  95    usage: MakeDicomDir dirname=rootDirectoryName
  96                       [ { [noshadowseq] | [noshadow][noseq] } ] [debug] [usage]
  97           noshadowseq: user doesn't want to load Private Sequence
  98           noshadow   : user doesn't want to load Private groups (odd number)
  99           noseq      : user doesn't want to load Sequences
 100           debug      : user wants to run the program in 'debug mode'
 101           usage      : user wants to display usage
 102    </pre>
 103    </font>
 104
 105    <LI> <b>AnonymizeDicomDir</b>
 106         <font size=-1>
 107    <pre>
 108    Anonymizes a gdcm-readable DICOMDIR even when some 'Objects'
 109           are not yet taken into account
 110           Warning : the DICOMDIR is overwritten;
 111                     to preserve its integrity, use a copy.
 112    usage: AnonymizeDicomDir filein=dicomDirName [debug] [usage] [usage]
 113           debug    : user wants to run the program in 'debug mode'
 114           usage    : user wants to display usage
 115    </pre>
 116    </font>
 117
 118    <LI> <b>PatchHeader</b>
 119    <font size=-1>
 120    <pre>
 121     Allows aware user to patch a gdcm-parsable image header, without
 122          loading image.
 123          Warning : the image(s) is/are overwritten
 124                    to preserve image(s) integrity, use a copy.
 125          WARNING : *NO CHECK* is performed on the new values.
 126                    Use only if you are sure the original values are wrong
 127                    *and* your values are right...
 128    usage: PatchHeader {filein=inputFileName|dirin=inputDirectoryName}
 129                [ { [size=] | [rows=][columns=] } ] [planes=]
 130                [bitsallocated=] [bitsstored=]
 131                [highbit=] [samplesperpixel=]
 132                [pixelrepresentation=] [samplesperpixel=]
 133                [ { [noshadowseq] | [noshadow][noseq] } ] [debug]
 134
 135        inputFileName : Name of the (single) file user wants to modify
 136        inputDirectoryName : user wants to modify *all* the files
 137                             within the directory
 138        newsize         : new size, to overwrite old (wrong) one
 139           or
 140        rows            : new Rows number,    to overwrite old (wrong) one
 141        columns         : new Columns number, to overwrite old (wrong) one
 142        planes          : new Planes number,  ...
 143        bitsallocated   : new Bits Allocated number,  ...
 144        bitsstored      : new Bits Stored number,  ...
 145        highbit         : new High Bit number,  ...
 146        samplesperpixel : new Samples Per Pixel, ...
 147        pixelrepresentation : new Pixel Representation, ...
 148
 149        noshadowseq: user doesn't want to load Private Sequences
 150        noshadow   : user doesn't want to load Private groups (odd number)
 151        noseq      : user doesn't want to load Sequences
 152        debug      : user wants to run the program in 'debug mode'
 153        usage      : user wants to display usage
 154    </pre>
 155    </font>
 156 </UL>
 157 </BODY>
 158 </HTML>
 159