1 /*=========================================================================
4 Module: $RCSfile: gdcmDocument.h,v $
6 Date: $Date: 2005/10/19 12:01:51 $
7 Version: $Revision: 1.126 $
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"
36 //-----------------------------------------------------------------------------
38 * \brief Derived by both gdcm::File and gdcm::DicomDir
40 class GDCM_EXPORT Document : public ElementSet
44 typedef std::list<DicomElement> ListElements;
47 //Deprecated : use SetFileName() + Load()
48 virtual bool Load( std::string const &filename );
54 bool SetShaDict(Dict *dict);
55 bool SetShaDict(DictKey const &dictName);
57 // Informations contained in the gdcm::Document
58 virtual bool IsReadable();
61 FileType GetFileType();
62 std::string GetTransferSyntax();
63 /// Return the Transfer Syntax as a string
64 std::string GetTransferSyntaxName();
67 /// 'Swap code' accessor (see \ref SwapCode )
68 int GetSwapCode() { return SwapCode; }
69 // System access (meaning endian related !?)
70 uint16_t SwapShort(uint16_t);
71 uint32_t SwapLong(uint32_t);
72 /// \brief Unswaps back the bytes of 2-bytes long integer
73 /// so they agree with the processor order.
74 uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
75 /// \brief Unswaps back the bytes of 4-byte long integer
76 /// so they agree with the processor order.
77 uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
80 /// Accessor to \ref Filename
81 const std::string &GetFileName() const { return Filename; }
82 /// Accessor to \ref Filename
83 virtual void SetFileName(std::string const &fileName)
84 { if (Filename != fileName)
85 Filename = fileName, IsDocumentModified = true; }
87 std::ifstream *OpenFile();
89 void WriteContent( std::ofstream *fp, FileType type );
92 virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
93 virtual void LoadEntryBinArea(DataEntry *entry);
95 void LoadDocEntrySafe(DocEntry *entry);
96 void AddForceLoadElement(uint16_t group, uint16_t elem);
98 // Ordering of Documents
99 bool operator<(Document &document);
102 * \brief Sets the LoadMode as a boolean string.
103 * LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ
104 ... (nothing more, right now)
105 * WARNING : before using NO_SHADOW, be sure *all* your files
106 * contain accurate values in the 0x0000 element (if any)
107 * of *each* Shadow Group. The parser will fail if the size is wrong !
108 * @param mode Load mode to be used
110 void SetLoadMode (int mode) { if (LoadMode != mode)
111 LoadMode=mode, IsDocumentModified = true; }
115 // Constructor and destructor are protected to forbid end user
116 // to instanciate from this class Document (only gdcm::File and
117 // gdcm::DicomDir are meaningfull).
121 uint16_t ReadInt16() throw ( FormatError );
122 uint32_t ReadInt32() throw ( FormatError );
123 void SkipBytes(uint32_t);
124 int ComputeGroup0002Length( );
127 /// Refering underlying filename.
128 std::string Filename;
130 /// \brief Swap code gives an information on the byte order of a
131 /// supposed to be an int32, as it's read on disc
132 /// (depending on the image Transfer Syntax *and* on the processor endianess)
133 /// as opposed as it should in memory to be dealt as an int32.
135 /// - a 'Little Endian' image, read with a little endian processor
136 /// will have a SwapCode= 1234 (the order is OK; nothing to do)
137 /// - a 'Little Endian' image, read with a big endian procesor
138 /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
140 /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
141 /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes
144 ///\brief whether we already parsed group 0002 (Meta Elements)
145 bool Group0002Parsed;
147 ///\brief whether file has a DCM Preamble
150 /// File Pointer, opened during Document parsing.
153 /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
156 /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
157 static const unsigned int HEADER_LENGTH_TO_READ;
158 /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
160 static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
162 /// User supplied list of elements to Anonymize
163 ListElements UserAnonymizeList;
165 /// User supplied list of elements to force Load
166 ListElements UserForceLoadList;
168 /// \brief Bit string integer (each one considered as a boolean)
169 /// Bit 0 : Skip Sequences, if possible
170 /// Bit 1 : Skip Shadow Groups if possible
171 /// Probabely, some more to add
174 /// \brief Whether the gdcm::Document is already parsed/loaded :
175 /// False from the creation of the gdcm::Document untill
176 /// gdcm::Document:Load()
177 bool IsDocumentAlreadyLoaded; // FIXME : probabely useless now
179 /// Whether the gdcm::Document was modified since the last Load()
180 bool IsDocumentModified;
185 bool DoTheLoadingDocumentJob();
187 void ParseDES(DocEntrySet *set, long offset, long l_max, bool delim_mode);
188 void ParseSQ (SeqEntry *seq, long offset, long l_max, bool delim_mode);
190 void LoadDocEntry (DocEntry *e, bool forceLoad = false);
191 void FindDocEntryLength (DocEntry *e) throw ( FormatError );
192 uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
193 VRKey FindDocEntryVR();
194 bool CheckDocEntryVR (const VRKey &k);
196 void SkipDocEntry (DocEntry *entry);
197 void SkipToNextDocEntry (DocEntry *entry);
199 void FixDocEntryFoundLength(DocEntry *entry, uint32_t l);
200 bool IsDocEntryAnInteger (DocEntry *entry);
203 void SwitchByteSwapCode();
204 void SetMaxSizeLoadEntry(long);
206 // DocEntry related utilities
207 DocEntry *ReadNextDocEntry();
209 void HandleBrokenEndian (uint16_t &group, uint16_t &elem);
210 void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
211 DocEntry *Backtrack(DocEntry *docEntry);
214 /// Public dictionary used to parse this header
216 /// \brief Optional "shadow dictionary" (private elements) used to parse
220 /// \brief Size threshold above which an element value will NOT be loaded
221 /// in memory (to avoid loading the image/volume itself). By default,
222 /// this upper bound is fixed to 1024 bytes (which might look reasonable
223 /// when one considers the definition of the various VR contents).
224 uint32_t MaxSizeLoadEntry;
226 // uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
227 // void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
228 // DocEntrySet *set );
232 } // end namespace gdcm
234 //-----------------------------------------------------------------------------