1 /*=========================================================================
4 Module: $RCSfile: gdcmDocument.h,v $
6 Date: $Date: 2004/10/06 21:30:02 $
7 Version: $Revision: 1.47 $
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
22 #include "gdcmCommon.h"
25 #include "gdcmException.h"
26 #include "gdcmDictSet.h"
27 #include "gdcmDocEntry.h"
28 #include "gdcmRLEFramesInfo.h"
34 #include "gdcmDocEntrySet.h"
35 #include "gdcmElementSet.h"
40 //-----------------------------------------------------------------------------
42 * \brief Derived by both gdcmHeader and gdcmDicomDir
44 class GDCM_EXPORT gdcmDocument : public gdcmElementSet
46 friend class gdcmFile;
48 /// Public dictionary used to parse this header
51 /// \brief Optional "shadow dictionary" (private elements) used to parse
55 /// \brief Size threshold above which an element value will NOT be loaded
56 /// in memory (to avoid loading the image/volume itself). By default,
57 /// this upper bound is fixed to 1024 bytes (which might look reasonable
58 /// when one considers the definition of the various VR contents).
59 uint32_t MaxSizeLoadEntry;
61 /// \brief Size threshold above which an element value will NOT be *printed*
62 /// in order no to polute the screen output. By default, this upper bound
63 /// is fixed to 64 bytes.
64 uint32_t MaxSizePrintEntry;
67 /// Refering underlying filename.
70 /// \brief SWap code (e.g. Big Endian, Little Endian, Bad Big Endian,
71 /// Bad Little Endian) according to the processor Endianity and
72 /// what is written on disc.
75 /// File Pointer, opened during Header parsing.
78 /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
81 /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
82 static const unsigned int HEADER_LENGTH_TO_READ;
84 /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
86 static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
88 /// \brief Elements whose value is longer than MAX_SIZE_PRINT_ELEMENT_VALUE
90 /// \todo Currently not used since collides with #define in
91 /// \ref gdcmDocEntry.cxx. See also
92 /// \ref gdcmDocument::SetMaxSizePrintEntry()
93 static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
95 /// Store the RLE frames info obtained during parsing of pixels.
96 gdcmRLEFramesInfo RLEInfo;
98 /// \brief Amount of printed details for each Header Entry (Dicom Element):
99 /// 0 : stands for the least detail level.
103 // the 2 following will be merged
104 virtual void PrintPubDict (std::ostream &os = std::cout);
105 virtual void PrintShaDict (std::ostream &os = std::cout);
108 gdcmDict *GetPubDict();
109 gdcmDict *GetShaDict();
110 bool SetShaDict(gdcmDict *dict);
111 bool SetShaDict(DictKey const & dictName);
113 // Informations contained in the parser
114 virtual bool IsReadable();
115 bool IsGivenTransferSyntax(std::string const & syntaxToCheck);
116 bool IsImplicitVRLittleEndianTransferSyntax();
117 bool IsExplicitVRLittleEndianTransferSyntax();
118 bool IsDeflatedExplicitVRLittleEndianTransferSyntax();
119 bool IsExplicitVRBigEndianTransferSyntax();
120 bool IsJPEGBaseLineProcess1TransferSyntax();
121 bool IsJPEGExtendedProcess2_4TransferSyntax();
122 bool IsJPEGExtendedProcess3_5TransferSyntax();
123 bool IsJPEGSpectralSelectionProcess6_8TransferSyntax();
124 bool IsRLELossLessTransferSyntax();
125 bool IsJPEGLossless();
127 bool IsEncapsulateTransferSyntax();
130 FileType GetFileType();
135 void Write(FILE* fp, FileType type);
137 gdcmValEntry* ReplaceOrCreateByNumber(std::string const & value,
138 uint16_t group, uint16_t elem,
139 std::string const & VR ="unkn");
141 gdcmBinEntry* ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
142 uint16_t group, uint16_t elem,
143 std::string const & VR="unkn");
145 gdcmSeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
147 bool ReplaceIfExistByNumber ( std::string const & value,
151 virtual void* LoadEntryBinArea(uint16_t group, uint16_t elem);
152 virtual void* LoadEntryBinArea(gdcmBinEntry* entry);
154 // System access (meaning endian related !?)
155 uint16_t SwapShort(uint16_t); // needed by gdcmFile
156 uint32_t SwapLong(uint32_t); // needed by gdcmFile
157 uint16_t UnswapShort(uint16_t); // needed by gdcmFile
158 uint32_t UnswapLong(uint32_t); // needed by gdcmFile
161 // Constructor and destructor are protected to forbid end user
162 // to instanciate from this class gdcmDocument (only gdcmHeader and
163 // gdcmDicomDir are meaningfull).
165 gdcmDocument( std::string const & filename );
166 virtual ~gdcmDocument();
168 void ComputeRLEInfo();
170 bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem );
172 virtual std::string GetEntryByName (TagName const & tagName);
173 virtual std::string GetEntryVRByName (TagName const & tagName);
174 virtual std::string GetEntryByNumber (uint16_t group, uint16_t elem);
175 virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t elem);
176 virtual int GetEntryLengthByNumber(uint16_t group, uint16_t elem);
178 virtual bool SetEntryByName (std::string const & content,
179 std::string const & tagName);
180 virtual bool SetEntryByNumber(std::string const & content,
181 uint16_t group, uint16_t element);
182 virtual bool SetEntryByNumber(uint8_t* content, int lgth,
183 uint16_t group, uint16_t element);
184 virtual bool SetEntryLengthByNumber(uint32_t length,
185 uint16_t group, uint16_t element);
187 virtual size_t GetEntryOffsetByNumber (uint16_t group, uint16_t elem);
188 virtual void* GetEntryBinAreaByNumber(uint16_t group, uint16_t elem);
189 virtual bool SetEntryBinAreaByNumber(uint8_t* a, uint16_t group,
192 virtual void UpdateShaEntries();
195 gdcmDocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element);
196 gdcmDocEntry* GetDocEntryByName (std::string const & tagName);
198 gdcmValEntry* GetValEntryByNumber(uint16_t group, uint16_t element);
199 //gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element);
201 void LoadDocEntrySafe(gdcmDocEntry* entry);
202 TagDocEntryHT* BuildFlatHashTable();
206 void ParseDES(gdcmDocEntrySet *set,long offset, long l_max, bool delim_mode);
207 void ParseSQ (gdcmSeqEntry *seq, long offset, long l_max, bool delim_mode);
209 void LoadDocEntry (gdcmDocEntry *);
210 void FindDocEntryLength(gdcmDocEntry *) throw ( gdcmFormatError );
211 void FindDocEntryVR (gdcmDocEntry *);
212 bool CheckDocEntryVR (gdcmDocEntry *, gdcmVRKey);
214 std::string GetDocEntryValue (gdcmDocEntry *);
215 std::string GetDocEntryUnvalue(gdcmDocEntry *);
217 void SkipDocEntry (gdcmDocEntry *);
218 void SkipToNextDocEntry (gdcmDocEntry *);
220 void FixDocEntryFoundLength(gdcmDocEntry *, uint32_t);
221 bool IsDocEntryAnInteger (gdcmDocEntry *);
223 uint32_t FindDocEntryLengthOB() throw( gdcmFormatUnexpected );
225 uint16_t ReadInt16() throw ( gdcmFormatError );
226 uint32_t ReadInt32() throw ( gdcmFormatError );
227 void SkipBytes(uint32_t);
228 bool ReadTag(uint16_t, uint16_t);
229 uint32_t ReadTagLength(uint16_t, uint16_t);
233 void SwitchSwapToBigEndian();
234 void SetMaxSizeLoadEntry(long);
235 void SetMaxSizePrintEntry(long);
237 // DocEntry related utilities
238 gdcmDocEntry* ReadNextDocEntry();
240 uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
241 void BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
242 gdcmDocEntrySet* set );
247 /// Accessor to \ref PrintLevel
248 void SetPrintLevel(int level) { PrintLevel = level; }
250 /// Accessor to \ref Filename
251 const std::string &GetFileName() { return Filename; }
253 /// Accessor to \ref Filename
254 void SetFileName(std::string const & fileName) { Filename = fileName; }
256 /// 'Swap code' accessor (see \ref SwapCode )
257 int GetSwapCode() { return SwapCode; }
260 FILE * GetFP() { return Fp; }
262 bool operator<(gdcmDocument &document);
266 //-----------------------------------------------------------------------------