1 /*=========================================================================
4 Module: $RCSfile: gdcmDocument.h,v $
6 Date: $Date: 2005/01/25 15:44:24 $
7 Version: $Revision: 1.101 $
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"
38 class JPEGFragmentsInfo;
40 //-----------------------------------------------------------------------------
42 * \brief Derived by both gdcm::File and gdcm::DicomDir
44 class GDCM_EXPORT Document : public ElementSet
47 // Informations contained in the gdcm::Document
48 virtual bool IsReadable();
49 FileType GetFileType();
51 std::string GetTransferSyntax();
52 /// returns RLEFramesInfo
53 RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
54 /// returns JPEGFragmentsInfo
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 Document
71 uint32_t SwapLong(uint32_t); // needed by Document
72 uint16_t UnswapShort(uint16_t); // needed by Document
73 uint32_t UnswapLong(uint32_t); // needed by Document
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 void LoadEntryBinArea(uint16_t group, uint16_t elem);
92 virtual void LoadEntryBinArea(BinEntry *entry);
94 void LoadDocEntrySafe(DocEntry *entry);
96 /// Return the Transfer Syntax as a string
97 std::string GetTransferSyntaxName();
104 // Constructor and destructor are protected to forbid end user
105 // to instanciate from this class Document (only gdcm::File and
106 // gdcm::DicomDir are meaningfull).
108 Document( std::string const &filename );
111 void ReadAndSkipEncapsulatedBasicOffsetTable();
112 void ComputeRLEInfo();
113 void ComputeJPEGFragmentInfo();
116 int ComputeGroup0002Length( FileType filetype );
119 /// Refering underlying filename.
120 std::string Filename;
122 /// \brief Swap code gives an information on the byte order of a
123 /// supposed to be an int32, as it's read on disc
124 /// (depending on the image Transfer Syntax *and* on the processor endianess)
125 /// as opposed as it should in memory to be dealt as an int32.
127 /// - a 'Little Endian' image, read with a little endian processor
128 /// will have a SwapCode= 1234 (the order is OK; nothing to do)
129 /// - a 'Little Endian' image, read with a big endian procesor
130 /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
132 /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
133 /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes
136 ///\brief whether we already parsed group 0002 (Meta Elements)
137 bool Group0002Parsed;
139 ///\brief whether file has a DCM Preamble
142 /// File Pointer, opened during Document parsing.
145 /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
148 /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
149 static const unsigned int HEADER_LENGTH_TO_READ;
151 /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
153 static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
155 /// \brief Elements whose value is longer than MAX_SIZE_PRINT_ELEMENT_VALUE
157 static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
159 /// Store the RLE frames info obtained during parsing of pixels.
160 RLEFramesInfo *RLEInfo;
162 /// Store the JPEG fragments info obtained during parsing of pixels.
163 JPEGFragmentsInfo *JPEGInfo;
168 void ParseDES(DocEntrySet *set,long offset, long l_max, bool delim_mode);
169 void ParseSQ (SeqEntry *seq, long offset, long l_max, bool delim_mode);
171 void LoadDocEntry (DocEntry *e);
172 void FindDocEntryLength (DocEntry *e) throw ( FormatError );
173 uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
174 std::string FindDocEntryVR();
175 bool CheckDocEntryVR (VRKey k);
177 std::string GetDocEntryValue (DocEntry *entry);
178 std::string GetDocEntryUnvalue(DocEntry *entry);
181 void SkipDocEntry (DocEntry *entry);
182 void SkipToNextDocEntry (DocEntry *entry);
184 void FixDocEntryFoundLength(DocEntry *entry,uint32_t l);
185 bool IsDocEntryAnInteger (DocEntry *entry);
187 uint16_t ReadInt16() throw ( FormatError );
188 uint32_t ReadInt32() throw ( FormatError );
189 void SkipBytes(uint32_t);
190 bool ReadTag(uint16_t, uint16_t);
191 uint32_t ReadTagLength(uint16_t, uint16_t);
195 void SwitchByteSwapCode();
196 void SetMaxSizeLoadEntry(long);
197 void SetMaxSizePrintEntry(long);
199 // DocEntry related utilities
200 DocEntry *ReadNextDocEntry();
202 // uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
203 // void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
204 // DocEntrySet *set );
206 void HandleBrokenEndian (uint16_t &group, uint16_t &elem);
207 void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
210 /// Public dictionary used to parse this header
213 /// \brief Optional "shadow dictionary" (private elements) used to parse
217 /// \brief Size threshold above which an element value will NOT be loaded
218 /// in memory (to avoid loading the image/volume itself). By default,
219 /// this upper bound is fixed to 1024 bytes (which might look reasonable
220 /// when one considers the definition of the various VR contents).
221 uint32_t MaxSizeLoadEntry;
223 /// \brief Size threshold above which an element value will NOT be *printed*
224 /// in order no to polute the screen output. By default, this upper bound
225 /// is fixed to 64 bytes.
226 uint32_t MaxSizePrintEntry;
232 } // end namespace gdcm
234 //-----------------------------------------------------------------------------