2 //-----------------------------------------------------------------------------
6 #include "gdcmCommon.h"
9 #include "gdcmException.h"
10 #include "gdcmDictSet.h"
11 #include "gdcmHeaderEntry.h"
14 #include <list> // for linking together *all* the Dicom Elements
16 //-----------------------------------------------------------------------------
17 typedef std::string VRKey;
18 typedef std::string VRAtr;
19 typedef std::map<VRKey, VRAtr> VRHT; // Value Representation Hash Table
21 typedef std::multimap<TagKey, gdcmHeaderEntry *> TagHeaderEntryHT;
22 typedef std::pair<TagKey, gdcmHeaderEntry *> PairHT;
23 typedef std::pair<TagHeaderEntryHT::iterator,TagHeaderEntryHT::iterator> IterHT;
25 typedef std::list<gdcmHeaderEntry *> ListTag; // for linking together the Elements
27 typedef std::string GroupKey;
28 typedef std::map<GroupKey, int> GroupHT;
30 //-----------------------------------------------------------------------------
32 * \defgroup gdcmHeader
35 class GDCM_EXPORT gdcmParser
38 gdcmParser(bool exception_on_error = false);
39 gdcmParser(const char *filename,
40 bool exception_on_error = false,
41 bool enable_sequences = false);
42 virtual ~gdcmParser(void);
47 * \brief Sets the print level for the Dicom Header
48 * \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy
50 void SetPrintLevel(int level) { printLevel = level; };
51 virtual void PrintPubEntry(std::ostream &os = std::cout);
52 virtual void PrintPubDict (std::ostream &os = std::cout);
53 virtual void PrintShaDict (std::ostream &os = std::cout);
56 inline std::string GetFileName(void) {return filename;}
59 gdcmDict *GetPubDict(void);
60 gdcmDict *GetShaDict(void);
61 bool SetShaDict(gdcmDict *dict);
62 bool SetShaDict(DictKey dictName);
64 // Informations contained in the parser
65 bool IsReadable(void);
66 bool IsImplicitVRLittleEndianTransferSyntax(void);
67 bool IsExplicitVRLittleEndianTransferSyntax(void);
68 bool IsDeflatedExplicitVRLittleEndianTransferSyntax(void);
69 bool IsExplicitVRBigEndianTransferSyntax(void);
70 FileType GetFileType(void);
75 * \brief returns a ref to the Dicom Header H table (multimap)
76 * return the Dicom Header H table
78 inline TagHeaderEntryHT &GetEntry(void) { return tagHT; };
82 * \brief returns a ref to the Dicom Header chained list
83 * return the Dicom Header chained list
85 inline ListTag &GetListEntry(void) { return listEntries; };
87 // Read (used in gdcmFile)
88 FILE *OpenFile(bool exception_on_error = false) throw(gdcmFileError);
91 // Write (used in gdcmFile)
92 virtual bool Write(FILE *, FileType);
94 bool ReplaceOrCreateByNumber(std::string Value, guint16 Group, guint16 Elem);
95 bool ReplaceOrCreateByNumber( char *Value, guint16 Group, guint16 Elem);
96 bool ReplaceIfExistByNumber ( char *Value, guint16 Group, guint16 Elem);
99 inline int GetSwapCode(void) { return sw; }
100 guint16 SwapShort(guint16); // needed by gdcmFile
101 guint32 SwapLong(guint32); // for JPEG Files
105 int CheckIfEntryExistByNumber(guint16 Group, guint16 Elem ); // int !
106 virtual std::string GetEntryByName (std::string tagName);
107 virtual std::string GetEntryVRByName (std::string tagName);
108 virtual std::string GetEntryByNumber (guint16 group, guint16 element);
109 virtual std::string GetEntryVRByNumber(guint16 group, guint16 element);
111 virtual bool SetEntryByName (std::string content, std::string tagName);
112 virtual bool SetEntryByNumber(std::string content, guint16 group, guint16 element);
113 virtual bool SetEntryLengthByNumber(guint32 l, guint16 group, guint16 element);
115 virtual size_t GetEntryOffsetByNumber (guint16 Group, guint16 Elem);
116 virtual void *GetEntryVoidAreaByNumber(guint16 Group, guint16 Elem);
117 virtual void *LoadEntryVoidArea (guint16 Group, guint16 Element);
118 virtual bool SetEntryVoidAreaByNumber(void *a, guint16 Group, guint16 Elem);
120 virtual void UpdateShaEntries(void);
123 gdcmHeaderEntry *GetHeaderEntryByName (std::string Name);
124 gdcmHeaderEntry *GetHeaderEntryByNumber(guint16 group, guint16 element);
126 void LoadHeaderEntrySafe (gdcmHeaderEntry *);
128 void UpdateGroupLength(bool SkipSequence = false, FileType type = ImplicitVR);
129 void WriteEntries(FileType type, FILE *);
133 FileType filetype; // ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
135 static const unsigned int HEADER_LENGTH_TO_READ;
136 static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
140 void Parse(bool exception_on_error = false) throw(gdcmFormatError);
142 void LoadHeaderEntries (void);
143 void LoadHeaderEntry (gdcmHeaderEntry *);
144 void AddHeaderEntry (gdcmHeaderEntry *);
145 void FindHeaderEntryLength(gdcmHeaderEntry *);
146 void FindHeaderEntryVR (gdcmHeaderEntry *);
147 bool CheckHeaderEntryVR (gdcmHeaderEntry *, VRKey);
149 void SkipHeaderEntry (gdcmHeaderEntry *);
150 void FixHeaderEntryFoundLength(gdcmHeaderEntry *, guint32);
151 bool IsHeaderEntryAnInteger (gdcmHeaderEntry *);
153 guint32 FindHeaderEntryLengthOB(void);
155 guint16 ReadInt16(void);
156 guint32 ReadInt32(void);
157 void SkipBytes(guint32);
159 void Initialise(void);
160 void CheckSwap(void);
161 void SwitchSwapToBigEndian(void);
162 void SetMaxSizeLoadEntry(long);
165 gdcmDictEntry *GetDictEntryByName (std::string Name);
166 gdcmDictEntry *GetDictEntryByNumber(guint16, guint16);
168 // HeaderEntry related utilities
169 gdcmHeaderEntry *ReadNextHeaderEntry (void);
170 gdcmHeaderEntry *NewHeaderEntryByNumber(guint16 group, guint16 element);
171 gdcmHeaderEntry *NewHeaderEntryByName (std::string Name);
172 gdcmDictEntry *NewVirtualDictEntry(guint16 group, guint16 element,
173 std::string vr = "Unknown",
174 std::string fourth = "Unknown",
175 std::string name = "Unknown");
177 // Deprecated (Not used)
178 gdcmHeaderEntry *NewManualHeaderEntryToPubDict(std::string NewTagName,
180 guint32 GenerateFreeTagKeyInGroup(guint16 group);
182 // Refering underlying filename.
183 std::string filename;
185 // Public dictionary used to parse this header
186 gdcmDict *RefPubDict;
187 // Optional "shadow dictionary" (private elements) used to parse this header
188 gdcmDict *RefShaDict;
190 TagHeaderEntryHT tagHT; // H Table (multimap), to provide fast access
191 ListTag listEntries; // chained list, to keep the 'spacial' ordering
194 // true if a gdcmHeaderEntry was added post parsing
197 // Swap code e.g. little, big, bad-big, bad-little endian). Warning:
198 // this code is not fixed during header parsing.
201 // Size treshold above which an element value will NOT be loaded in
202 // memory (to avoid loading the image/volume itself). By default,
203 // this upper bound is fixed to 1024 bytes (which might look reasonable
204 // when one considers the definition of the various VR contents).
205 guint32 MaxSizeLoadEntry;
211 //-----------------------------------------------------------------------------