1 /*=========================================================================
4 Module: $RCSfile: gdcmDicomDir.h,v $
6 Date: $Date: 2005/07/07 16:37:41 $
7 Version: $Revision: 1.61 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
19 #ifndef GDCMDICOMDIR_H
20 #define GDCMDICOMDIR_H
22 #include "gdcmDocument.h"
29 //-----------------------------------------------------------------------------
30 class DicomDirPatient;
32 class DicomDirElement;
38 typedef std::list<DicomDirPatient *> ListDicomDirPatient;
39 typedef std::vector<Document *> VectDocument;
41 //-----------------------------------------------------------------------------
43 * \brief DicomDir defines an object representing a DICOMDIR in memory
44 * as a tree-like structure DicomDirPatient
49 class GDCM_EXPORT DicomDir: public Document
52 typedef void Method(void*);
54 DicomDir( std::string const &filename, bool parseDir = false );
59 bool Load( std::string const &filename );
61 void Print(std::ostream &os = std::cout, std::string const &indent = "" );
63 void SetParseDir(bool parseDir) { ParseDir = parseDir; };
64 // Informations contained in the parser
65 virtual bool IsReadable();
68 DicomDirMeta *NewMeta();
69 /// Returns a pointer to the DicomDirMeta for this DICOMDIR.
70 DicomDirMeta *GetMeta() { return MetaElems; };
73 DicomDirPatient *NewPatient();
76 DicomDirPatient *GetFirstPatient();
77 DicomDirPatient *GetNextPatient();
80 void ParseDirectory();
82 // Note: the DicomDir:: namespace prefix is needed by Swig in the
83 // following method declarations. Refer to gdcmPython/gdcm.i
84 // for the reasons of this unnecessary notation at C++ level.
85 void SetStartMethod( DicomDir::Method *method,
87 DicomDir::Method *argDelete = NULL );
88 void SetProgressMethod( DicomDir::Method *method,
90 DicomDir::Method *argDelete = NULL );
91 void SetEndMethod( DicomDir::Method *method,
93 DicomDir::Method *argDelete = NULL );
94 void SetStartMethodArgDelete ( DicomDir::Method *m );
95 void SetProgressMethodArgDelete( DicomDir::Method *m );
96 void SetEndMethodArgDelete ( DicomDir::Method *m );
98 /// GetProgress GetProgress
99 float GetProgress() { return Progress; };
100 /// AbortProgress AbortProgress
101 void AbortProgress() { Abort = true; };
102 /// IsAborted IsAborted
103 bool IsAborted() { return Abort; };
106 bool WriteDicomDir(std::string const &fileName);
108 bool AnonymizeDicomDir();
110 /// Types of the DicomDirObject within the DicomDir
115 GDCM_DICOMDIR_PATIENT,
122 void CreateDicomDirChainedList(std::string const &path);
123 void CallStartMethod();
124 void CallProgressMethod();
125 void CallEndMethod();
129 void CreateDicomDir();
130 bool DoTheLoadingJob();
131 bool AddPatientToEnd(DicomDirPatient *dd);
132 bool AddStudyToEnd (DicomDirStudy *dd);
133 bool AddSerieToEnd (DicomDirSerie *dd);
134 bool AddImageToEnd (DicomDirImage *dd);
136 void SetElements(std::string const &path, VectDocument const &list);
137 void SetElement (std::string const &path, DicomDirType type,
139 void MoveSQItem(DocEntrySet *dst, DocEntrySet *src);
141 static bool HeaderLessThan(Document *header1, Document *header2);
145 /// Pointer on *the* DicomDirObject 'DicomDirMeta Elements'
146 DicomDirMeta *MetaElems;
148 /// Chained list of DicomDirPatient (to be exploited hierarchicaly)
149 ListDicomDirPatient Patients;
150 ListDicomDirPatient::iterator ItPatient;
152 /// pointer to the initialisation method for any progress bar
154 /// pointer to the incrementation method for any progress bar
155 Method *ProgressMethod;
156 /// pointer to the termination method for any progress bar
158 /// pointer to the ??? method for any progress bar
159 Method *StartMethodArgDelete;
160 /// pointer to the ??? method for any progress bar
161 Method* ProgressMethodArgDelete;
162 /// pointer to the ??? method for any progress bar
163 Method *EndMethodArgDelete;
164 /// pointer to the ??? for any progress bar
166 /// pointer to the ??? for any progress bar
168 /// pointer to the ??? for any progress bar
170 /// value of the ??? for any progress bar
172 /// value of the ??? for any progress bar
176 } // end namespace gdcm
177 //-----------------------------------------------------------------------------