]> Creatis software - gdcm.git/blob - Doc/Website/CommandLine.html
Add an entry "Command Line Utilities" on the side bar.
[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> PrintFile
11    <pre>
12    Display the header of any kind of ACR-NEMA/PAPYRUS/DICOM File
13    usage: PrintFile filein=fileName [level=n] [noshadow] [noseq] [debug]
14           level = 0,1,2 : depending on the amount of details user wants to see
15           noshadow : user doesn't want to load Private groups (odd number)
16           noseq    : user doesn't want to load Sequences
17           debug    : user wants to run the program in 'debug mode'
18     </pre>
19    <LI> Anonymize
20    <pre>
21    Anonymize a full gdcm-readable Dicom image
22           Warning : probably segfaults if pixels are not gdcm readable.
23                     Use AnonymizeNoLoad instead.
24    usage: Anonymize filein=inputFileName fileout=anonymizedFileName [debug]
25           debug    : user wants to run the program in 'debug mode'
26    <pre>
27    <LI> AnonymizeNoLoad
28    <pre> 
29    Anonymize a gdcm-readable Dicom image even if pixels aren't gdcm readable
30           Warning : the file is overwritten; to preserve file integrity,
31                     use a copy.
32    usage: AnonymizeNoLoad filein=inputFileName fileout=outputFileName [debug]
33           debug    : user wants to run the program in 'debug mode'
34    </pre>
35    <LI> ReWrite
36    <pre>
37    Re write a full gdcm-readable Dicom image (compressed Pixels are expanded)
38      (usefull when the file is not very straight).                  
39     usage: ReWrite filein=inputFileName fileout=anonymizedFileName
40                    [mode=write mode] [noshadow] [noseq][debug]
41            mode = a (ACR), x (Explicit VR Dicom), r (RAW : only pixels)
42            noshadow : user doesn't want to load Private groups (odd number)
43            noseq    : user doesn't want to load Sequences
44            debug    : user wants to run the program in 'debug mode' 
45    </pre>
46    <LI> PrintDicomDir
47    <pre>
48    Display the tree-like structure of a DICOMDIR File
49    usage: PrintDicomDir filein=fileName [detail=n] [level=n] [debug]
50           detail = 1 : Patients, 2 : Studies, 3 : Series, 4 : Images
51                    5 : Full Content
52           level = 0,1,2 : depending on user (what he wants to see, when detail=5)
53           debug    : user wants to run the program in 'debug mode'
54    </pre>
55    <LI> MakeDicomDir
56    <pre>
57    Explores recursively the given directory, makes the relevant DICOMDIR
58           and writes it as 'NewDICOMDIR'
59    usage: MakeDicomDir dirname=rootDirectoryName [noshadow] [noseq] [debug]
60            noshadow : user doesn't want to load Private groups (odd number)
61            noseq    : user doesn't want to load Sequences
62            debug    : user wants to run the program in 'debug mode'
63    </pre>
64    <LI> AnonymizeDicomDir
65    <pre>
66    Anonymize a gdcm-readable DICOMDIR even when some 'Objects'
67            are not yet taken into account
68            Warning : the DICOMDIR is overwritten
69    usage: AnonymizeDicomDir filein=dicomDirName [debug]
70           debug    : user wants to run the program in 'debug mode'
71    </pre>
72 </UL>
73 </BODY>
74 </HTML>
75