1 /*=========================================================================
4 Module: $RCSfile: gdcmDocument.h,v $
6 Date: $Date: 2005/01/11 22:46:22 $
7 Version: $Revision: 1.82 $
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"
37 class JPEGFragmentsInfo;
39 //-----------------------------------------------------------------------------
41 * \brief Derived by both Header and DicomDir
43 class GDCM_EXPORT Document : public ElementSet
46 // Informations contained in the parser
47 virtual bool IsReadable();
48 FileType GetFileType();
50 std::string GetTransferSyntax();
54 RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
55 JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
58 virtual void PrintPubDict (std::ostream &os = std::cout);
59 virtual void PrintShaDict (std::ostream &os = std::cout);
63 bool SetShaDict(Dict* dict);
64 bool SetShaDict(DictKey const &dictName);
67 /// 'Swap code' accessor (see \ref SwapCode )
68 int GetSwapCode() { return SwapCode; }
69 // System access (meaning endian related !?)
70 uint16_t SwapShort(uint16_t); // needed by File
71 uint32_t SwapLong(uint32_t); // needed by File
72 uint16_t UnswapShort(uint16_t); // needed by File
73 uint32_t UnswapLong(uint32_t); // needed by File
75 // Ordering of Documents
76 bool operator<(Document &document);
80 /// Accessor to \ref Filename
81 const std::string &GetFileName() const { return Filename; }
82 /// Accessor to \ref Filename
83 void SetFileName(std::string const &fileName) { Filename = fileName; }
85 std::ifstream *OpenFile();
87 void WriteContent( std::ofstream *fp, FileType type );
91 virtual bool SetEntry(std::string const &content,
92 uint16_t group, uint16_t element);
93 virtual bool SetEntry(uint8_t *content, int lgth,
94 uint16_t group, uint16_t element);
95 virtual bool SetEntry(std::string const &content, ValEntry *entry);
96 virtual bool SetEntry(uint8_t *content, int lgth, BinEntry *entry);
98 virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);
100 virtual std::string GetEntry (uint16_t group, uint16_t elem);
101 virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
102 virtual int GetEntryLength(uint16_t group, uint16_t elem);
104 DocEntry *GetDocEntry(uint16_t group, uint16_t element);
105 ValEntry *GetValEntry(uint16_t group, uint16_t element);
106 BinEntry *GetBinEntry(uint16_t group, uint16_t element);
108 ValEntry *ReplaceOrCreate(std::string const &value,
109 uint16_t group, uint16_t elem,
110 TagName const &vr = GDCM_UNKNOWN);
111 BinEntry *ReplaceOrCreate(uint8_t* binArea, int lgth,
112 uint16_t group, uint16_t elem,
113 TagName const &vr = GDCM_UNKNOWN);
114 SeqEntry *ReplaceOrCreate(uint16_t group, uint16_t elem);
116 bool ReplaceIfExist(std::string const &value,
117 uint16_t group, uint16_t elem );
119 virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
120 virtual void LoadEntryBinArea(BinEntry *entry);
122 void LoadDocEntrySafe(DocEntry *entry);
123 TagDocEntryHT *BuildFlatHashTable();
127 // Constructor and destructor are protected to forbid end user
128 // to instanciate from this class Document (only Header and
129 // DicomDir are meaningfull).
131 Document( std::string const &filename );
134 void ReadAndSkipEncapsulatedBasicOffsetTable();
135 void ComputeRLEInfo();
136 void ComputeJPEGFragmentInfo();
138 bool CheckIfEntryExist(uint16_t group, uint16_t elem );
140 int ComputeGroup0002Length( FileType filetype );
143 /// Refering underlying filename.
144 std::string Filename;
146 /// \brief SWap code (e.g. Big Endian, Little Endian, Bad Big Endian,
147 /// Bad Little Endian) according to the processor Endianity and
148 /// what is written on disc.
151 ///\brief whether we already parsed group 0002
152 bool Group0002Parsed;
154 ///\brief whether file has a DCM Preamble
157 /// File Pointer, opened during Header parsing.
160 /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
163 /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
164 static const unsigned int HEADER_LENGTH_TO_READ;
166 /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
168 static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
170 /// \brief Elements whose value is longer than MAX_SIZE_PRINT_ELEMENT_VALUE
172 /// \todo Currently not used since collides with #define in
173 /// class DocEntry . See also
174 /// method ref Document::SetMaxSizePrintEntry()
175 static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
177 /// Store the RLE frames info obtained during parsing of pixels.
178 RLEFramesInfo *RLEInfo;
180 /// Store the JPEG fragments info obtained during parsing of pixels.
181 JPEGFragmentsInfo *JPEGInfo;
186 void ParseDES(DocEntrySet *set,long offset, long l_max, bool delim_mode);
187 void ParseSQ (SeqEntry *seq, long offset, long l_max, bool delim_mode);
189 void LoadDocEntry (DocEntry *e);
190 void FindDocEntryLength (DocEntry *e) throw ( FormatError );
191 uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
192 std::string FindDocEntryVR();
193 bool CheckDocEntryVR (VRKey k);
195 std::string GetDocEntryValue (DocEntry *entry);
196 std::string GetDocEntryUnvalue(DocEntry *entry);
199 void SkipDocEntry (DocEntry *entry);
200 void SkipToNextDocEntry (DocEntry *entry);
202 void FixDocEntryFoundLength(DocEntry *entry,uint32_t l);
203 bool IsDocEntryAnInteger (DocEntry *entry);
205 uint16_t ReadInt16() throw ( FormatError );
206 uint32_t ReadInt32() throw ( FormatError );
207 void SkipBytes(uint32_t);
208 bool ReadTag(uint16_t, uint16_t);
209 uint32_t ReadTagLength(uint16_t, uint16_t);
213 void SwitchByteSwapCode();
214 void SetMaxSizeLoadEntry(long);
215 void SetMaxSizePrintEntry(long);
217 // DocEntry related utilities
218 DocEntry *ReadNextDocEntry();
220 uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
221 void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
224 void HandleBrokenEndian(uint16_t &group, uint16_t &elem);
225 void HandleOutOfGroup0002(uint16_t group);
228 /// Public dictionary used to parse this header
231 /// \brief Optional "shadow dictionary" (private elements) used to parse
235 /// \brief Size threshold above which an element value will NOT be loaded
236 /// in memory (to avoid loading the image/volume itself). By default,
237 /// this upper bound is fixed to 1024 bytes (which might look reasonable
238 /// when one considers the definition of the various VR contents).
239 uint32_t MaxSizeLoadEntry;
241 /// \brief Size threshold above which an element value will NOT be *printed*
242 /// in order no to polute the screen output. By default, this upper bound
243 /// is fixed to 64 bytes.
244 uint32_t MaxSizePrintEntry;
249 } // end namespace gdcm
251 //-----------------------------------------------------------------------------