]> Creatis software - gdcm.git/blob - Doc/Website/CommandLine.html
c1abf7a1318a7458e08f525aa47b32dac54594eb
[gdcm.git] / 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    <pre>
12    Displays the header of any kind of ACR-NEMA/PAPYRUS/DICOM File
13    usage: PrintFile filein=fileName [level=n] 
14                     [ { [noshadowseq] | [noshadow][noseq] } ] [debug] [usage]
15           level = 0,1,2 : depending on the amount of details user wants to see
16           noshadowseq: user doesn't want to load Private Sequences
17           noshadow   : user doesn't want to load Private groups (odd number)
18           noseq      : user doesn't want to load Sequences
19           debug      : user wants to run the program in 'debug mode'
20           usage      : user wants to display usage
21    </pre>
22
23    <LI> <b>Anonymize</b>
24    <pre>
25    Anonymizes a full gdcm-readable Dicom image
26           Warning : probably segfaults if pixels are not gdcm readable.
27                     Use AnonymizeNoLoad instead.
28    usage: Anonymize filein=inputFileName fileout=anonymizedFileName [debug][usage]
29           debug    : user wants to run the program in 'debug mode'
30           usage    : user wants to display usage
31   </pre>
32
33    <LI> <b>AnonymizeNoLoad</b>
34    <pre> 
35    Anonymizes a gdcm-readable Dicom image even if pixels aren't gdcm readable
36          Warning : Warning : the image is overwritten;
37                    to preserve its integrity, use a copy.
38    usage: AnonymizeNoLoad {filein=inputFileName|dirin=inputDirectoryName}
39                           [rubout=listOfPrivateElementsToRubOut]
40                           [ { [noshadowseq] | [noshadow][noseq] } ] [debug]
41           inputFileName : Name of the (single) file user wants to anonymize
42           inputDirectoryName : user wants to anonymize *all* the files
43                                within the (single Patient!) directory
44           listOfElementsToRubOut : group1-elem1,g2-e2,... (in hexa)
45                                    of extra Elements to rub out
46           noshadowseq: user doesn't want to load Private Sequences
47           noshadow   : user doesn't want to load Private groups (odd number)
48           noseq      : user doesn't want to load Sequences
49           debug      : user wants to run the program in 'debug mode'
50           usage      : user wants to display usage
51    </pre>
52
53    <LI> <b>ReWrite</b>
54    <pre>
55    Re writes a full gdcm-readable Dicom image (compressed Pixels are expanded)
56                    (usefull when the file is not very straight).                  
57    usage: ReWrite filein=inputFileName fileout=anonymizedFileName
58                   [mode=write mode] [rgb]
59                   [ { [noshadowseq] | [noshadow][noseq] } ] [debug] [usage]
60           write mode = a (ACR), x (Explicit VR Dicom), r (RAW : only pixels)
61           rgb        : user wants to transform LUT (if any) into RGB 
62           noshadowseq: user doesn't want to load Private Sequences
63           noshadow   : user doesn't want to load Private groups (odd number)
64           noseq      : user doesn't want to load Sequences
65           debug      : user wants to run the program in 'debug mode'
66           usage      : user wants to display usage
67    </pre>
68
69    <LI> <b>PrintDicomDir</b>
70    <pre>
71    Displays the tree-like structure of a DICOMDIR File
72    usage: PrintDicomDir filein=fileName [detail=n] [level=n] [debug] [usage]
73           detail = 1 : Patients, 2 : Studies, 3 : Series, 4 : Images
74                    5 : Full Content
75           level = 0,1,2 : depending on user (what he wants to see, when detail=5)
76           debug    : user wants to run the program in 'debug mode'
77           usage    : user wants to display usage
78    </pre>
79
80    <LI> <b>MakeDicomDir</b>
81    <pre>
82    Explores recursively the given directory, makes the relevant DICOMDIR
83           and writes it as 'NewDICOMDIR'
84    usage: MakeDicomDir dirname=rootDirectoryName 
85                       [ { [noshadowseq] | [noshadow][noseq] } ] [debug] [usage]
86           noshadowseq: user doesn't want to load Private Sequence
87           noshadow   : user doesn't want to load Private groups (odd number)
88           noseq      : user doesn't want to load Sequences
89           debug      : user wants to run the program in 'debug mode'
90           usage      : user wants to display usage
91    </pre>
92
93    <LI> <b>AnonymizeDicomDir</b>
94    <pre>
95    Anonymizes a gdcm-readable DICOMDIR even when some 'Objects'
96           are not yet taken into account
97           Warning : the DICOMDIR is overwritten; 
98                     to preserve its integrity, use a copy.
99    usage: AnonymizeDicomDir filein=dicomDirName [debug] [usage] [usage]
100           debug    : user wants to run the program in 'debug mode'
101           usage    : user wants to display usage
102    </pre>
103
104 </UL>
105 </BODY>
106 </HTML>
107