1 /*=========================================================================
4 Module: $RCSfile: gdcmDocument.h,v $
6 Date: $Date: 2005/07/17 04:28:55 $
7 Version: $Revision: 1.117 $
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 GDCMDOCUMENT_H
20 #define GDCMDOCUMENT_H
24 #include "gdcmElementSet.h"
25 #include "gdcmException.h"
31 #define NO_SEQ 0x00000001 // Don't load odd groups
32 #define NO_SHADOW 0x00000002 // Don't load Sequences
33 #define NO_SHADOWSEQ 0x00000004 // Don't load Sequences if they belong to odd group
34 // (*exclusive* from NO_SEQ and NO_SHADOW)
42 //-----------------------------------------------------------------------------
44 * \brief Derived by both gdcm::File and gdcm::DicomDir
46 class GDCM_EXPORT Document : public ElementSet
50 typedef std::list<Element> ListElements;
53 //Deprecated : use SetFileName() + Load()
54 virtual bool Load( std::string const &filename );
60 bool SetShaDict(Dict *dict);
61 bool SetShaDict(DictKey const &dictName);
63 // Informations contained in the gdcm::Document
64 virtual bool IsReadable();
67 FileType GetFileType();
68 std::string GetTransferSyntax();
69 /// Return the Transfer Syntax as a string
70 std::string GetTransferSyntaxName();
73 /// 'Swap code' accessor (see \ref SwapCode )
74 int GetSwapCode() { return SwapCode; }
75 // System access (meaning endian related !?)
76 uint16_t SwapShort(uint16_t);
77 uint32_t SwapLong(uint32_t);
78 /// \brief Unswaps back the bytes of 2-bytes long integer
79 /// so they agree with the processor order.
80 uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
81 /// \brief Unswaps back the bytes of 4-byte long integer
82 /// so they agree with the processor order.
83 uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
86 /// Accessor to \ref Filename
87 const std::string &GetFileName() const { return Filename; }
88 /// Accessor to \ref Filename
89 virtual void SetFileName(std::string const &fileName)
90 { if (Filename != fileName)
91 Filename = fileName, IsDocumentModified = true; }
93 std::ifstream *OpenFile();
95 void WriteContent( std::ofstream *fp, FileType type );
98 virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
99 virtual void LoadEntryBinArea(BinEntry *entry);
101 void LoadDocEntrySafe(DocEntry *entry);
103 // Ordering of Documents
104 bool operator<(Document &document);
107 * \brief Sets the LoadMode as a boolean string.
108 * NO_SEQ, NO_SHADOW, NO_SHADOWSEQ
109 ... (nothing more, right now)
110 * WARNING : before using NO_SHADOW, be sure *all* your files
111 * contain accurate values in the 0x0000 element (if any)
112 * of *each* Shadow Group. The parser will fail if the size is wrong !
113 * @param mode Load mode to be used
115 void SetLoadMode (int mode) { if (LoadMode != mode)
116 LoadMode = mode, IsDocumentModified = true; }
120 // Constructor and destructor are protected to forbid end user
121 // to instanciate from this class Document (only gdcm::File and
122 // gdcm::DicomDir are meaningfull).
124 Document( std::string const &filename );
127 uint16_t ReadInt16() throw ( FormatError );
128 uint32_t ReadInt32() throw ( FormatError );
129 void SkipBytes(uint32_t);
130 int ComputeGroup0002Length( FileType filetype );
133 /// Refering underlying filename.
134 std::string Filename;
136 /// \brief Swap code gives an information on the byte order of a
137 /// supposed to be an int32, as it's read on disc
138 /// (depending on the image Transfer Syntax *and* on the processor endianess)
139 /// as opposed as it should in memory to be dealt as an int32.
141 /// - a 'Little Endian' image, read with a little endian processor
142 /// will have a SwapCode= 1234 (the order is OK; nothing to do)
143 /// - a 'Little Endian' image, read with a big endian procesor
144 /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
146 /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
147 /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes
150 ///\brief whether we already parsed group 0002 (Meta Elements)
151 bool Group0002Parsed;
153 ///\brief whether file has a DCM Preamble
156 /// File Pointer, opened during Document parsing.
159 /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
162 /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
163 static const unsigned int HEADER_LENGTH_TO_READ;
164 /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
166 static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
168 /// List of elements to Anonymize
169 ListElements AnonymizeList;
171 /// \brief Bit string integer (each one considered as a boolean)
172 /// Bit 0 : Skip Sequences, if possible
173 /// Bit 1 : Skip Shadow Groups if possible
174 /// Probabely, some more to add
177 /// \brief Whether the gdcm::Document is already parsed/loaded :
178 /// False from the creation of the gdcm::Document untill
179 /// gdcm::Document:Load()
180 bool IsDocumentAlreadyLoaded; // FIXME : probabely useless now
182 /// Whether the gdcm::Document was modified since the last Load()
183 bool IsDocumentModified;
188 bool DoTheLoadingDocumentJob();
190 void ParseDES(DocEntrySet *set, long offset, long l_max, bool delim_mode);
191 void ParseSQ (SeqEntry *seq, long offset, long l_max, bool delim_mode);
193 void LoadDocEntry (DocEntry *e);
194 void FindDocEntryLength (DocEntry *e) throw ( FormatError );
195 uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
196 std::string FindDocEntryVR();
197 bool CheckDocEntryVR (VRKey k);
199 std::string GetDocEntryValue (DocEntry *entry);
200 std::string GetDocEntryUnvalue(DocEntry *entry);
202 void SkipDocEntry (DocEntry *entry);
203 void SkipToNextDocEntry (DocEntry *entry);
205 void FixDocEntryFoundLength(DocEntry *entry, uint32_t l);
206 bool IsDocEntryAnInteger (DocEntry *entry);
209 void SwitchByteSwapCode();
210 void SetMaxSizeLoadEntry(long);
212 // DocEntry related utilities
213 DocEntry *ReadNextDocEntry();
215 void HandleBrokenEndian (uint16_t &group, uint16_t &elem);
216 void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
219 /// Public dictionary used to parse this header
221 /// \brief Optional "shadow dictionary" (private elements) used to parse
225 /// \brief Size threshold above which an element value will NOT be loaded
226 /// in memory (to avoid loading the image/volume itself). By default,
227 /// this upper bound is fixed to 1024 bytes (which might look reasonable
228 /// when one considers the definition of the various VR contents).
229 uint32_t MaxSizeLoadEntry;
231 // uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
232 // void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
233 // DocEntrySet *set );
237 } // end namespace gdcm
239 //-----------------------------------------------------------------------------