1 // $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.h,v 1.26 2003/05/28 19:36:21 frog Exp $
7 #include "gdcmCommon.h"
9 #include "gdcmException.h"
10 #include "gdcmDictSet.h"
11 #include "gdcmElValue.h"
12 #include "gdcmElValSet.h"
14 typedef std::string VRKey;
15 typedef std::string VRAtr;
16 typedef std::map<VRKey, VRAtr> VRHT; // Value Representation Hash Table
18 /// The purpose of an instance of gdcmHeader is to act as a container of
19 /// all the DICOM elements and their corresponding values (and
20 /// additionaly the corresponding DICOM dictionary entry) of the header
23 /// The typical usage of instances of class gdcmHeader is to classify a set of
24 /// dicom files according to header information e.g. to create a file hierarchy
25 /// reflecting the Patient/Study/Serie informations, or extracting a given
26 /// SerieId. Accesing the content (image[s] or volume[s]) is beyond the
27 /// functionality of this class and belongs to gdmcFile.
28 /// \note The various entries of the explicit value representation (VR) shall
29 /// be managed within a dictionary which is shared by all gdcmHeader
31 /// \note The gdcmHeader::Set*Tag* family members cannot be defined as
32 /// protected due to Swig limitations for as Has_a dependency between
33 /// gdcmFile and gdcmHeader.
35 class GDCM_EXPORT gdcmHeader {
36 void SkipBytes(guint32);
38 /// Pointer to the Value Representation Hash Table which contains all
39 /// the VR of the DICOM version3 public dictionary.
40 gdcmVR *dicom_vr; // Not a class member for thread-safety reasons
41 /// Pointer to global dictionary container
42 gdcmDictSet* Dicts; // Not a class member for thread-safety reasons
43 /// Public dictionary used to parse this header
45 /// Optional "shadow dictionary" (private elements) used to parse this
49 /// ELement VALueS parsed with the PUBlic dictionary.
50 gdcmElValSet PubElValSet;
51 /// ELement VALueS parsed with the SHAdow dictionary.
52 gdcmElValSet ShaElValSet;
53 /// Refering underlying filename.
56 // FIXME sw should be an enum e.g.
62 /// Swap code e.g. little, big, bad-big, bad-little endian). Warning:
63 /// this code is not fixed during header parsing.
66 /// Size treshold above which an element value will NOT be loaded in
67 /// memory (to avoid loading the image/volume itself). By default,
68 /// this upper bound is fixed to 1024 bytes (which might look reasonable
69 /// when one considers the definition of the various VR contents).
70 guint32 MaxSizeLoadElementValue;
72 guint16 ReadInt16(void);
73 guint32 ReadInt32(void);
74 guint32 FindLengthOB(void);
75 void Initialise(void);
77 void SwitchSwapToBigEndian(void);
78 // CLEAN ME: NewManualElValToPubDict is NOT called any more.
79 gdcmElValue* NewManualElValToPubDict(std::string NewTagName,
81 void SetMaxSizeLoadElementValue(long);
83 gdcmDictEntry * GetDictEntryByNumber(guint16, guint16);
84 gdcmDictEntry * GetDictEntryByName(std::string Name);
86 // ElValue related utilities
87 gdcmElValue * ReadNextElement(void);
88 gdcmElValue * NewElValueByNumber(guint16 group, guint16 element);
89 gdcmElValue * NewElValueByName(std::string Name);
91 void FindLength(gdcmElValue *);
92 void FindVR(gdcmElValue *);
93 void LoadElementValue(gdcmElValue *);
94 void LoadElementValueSafe(gdcmElValue *);
95 void SkipElementValue(gdcmElValue *);
96 void FixFoundLength(gdcmElValue*, guint32);
97 bool IsAnInteger(gdcmElValue *);
98 void LoadElements(void);
104 gdcmElValue * GetElValueByNumber(guint16 group, guint16 element);
106 guint16 SwapShort(guint16); // needed by gdcmFile
107 guint32 SwapLong(guint32); // for JPEG Files :-(
108 bool OpenFile(bool exception_on_error = false)
109 throw(gdcmFileError);
110 bool CloseFile(void);
111 int write(std::ostream&);
112 int anonymize(std::ostream&); // FIXME : anonymize should be a friend ?
114 bool IsReadable(void);
115 bool IsImplicitVRLittleEndianTransferSyntax(void);
116 bool IsExplicitVRLittleEndianTransferSyntax(void);
117 bool IsDeflatedExplicitVRLittleEndianTransferSyntax(void);
118 bool IsExplicitVRBigEndianTransferSyntax(void);
119 bool IsJPEGBaseLineProcess1TransferSyntax(void);
120 bool IsJPEGExtendedProcess2_4TransferSyntax(void);
121 bool IsJPEGExtendedProcess3_5TransferSyntax(void);
122 bool IsJPEGSpectralSelectionProcess6_8TransferSyntax(void);
123 bool IsJPEGLossless(void);
124 bool IsDicomV3(void);
126 virtual void ParseHeader(bool exception_on_error = false)
127 throw(gdcmFormatError);
128 gdcmHeader(const char *filename, bool exception_on_error = false);
129 virtual ~gdcmHeader();
131 size_t GetPixelOffset(void);
132 int GetSwapCode(void) { return sw; }
134 // TODO Swig int SetPubDict(std::string filename);
135 // When some proprietary shadow groups are disclosed, we can set up
136 // an additional specific dictionary to access extra information.
137 // TODO Swig int SetShaDict(std::string filename);
139 std::string GetPubElValByName(std::string TagName);
140 std::string GetPubElValByNumber(guint16 group, guint16 element);
141 std::string GetPubElValRepByName(std::string TagName);
142 std::string GetPubElValRepByNumber(guint16 group, guint16 element);
144 TagElValueHT & GetPubElVal(void) { return PubElValSet.GetTagHt(); };
145 void PrintPubElVal(std::ostream & os = std::cout);
146 void PrintPubDict (std::ostream & os = std::cout);
148 // TODO Swig std::string* GetShaTagNames();
149 std::string GetShaElValByName(std::string TagName);
150 std::string GetShaElValByNumber(guint16 group, guint16 element);
151 std::string GetShaElValRepByName(std::string TagName);
152 std::string GetShaElValRepByNumber(guint16 group, guint16 element);
154 std::string GetElValByName(std::string TagName);
155 std::string GetElValByNumber(guint16 group, guint16 element);
156 std::string GetElValRepByName(std::string TagName);
157 std::string GetElValRepByNumber(guint16 group, guint16 element);
159 int SetPubElValByName(std::string content, std::string TagName);
160 int SetPubElValByNumber(std::string content, guint16 group, guint16 element);
161 int SetShaElValByName(std::string content, std::string TagName);
162 int SetShaElValByNumber(std::string content, guint16 group, guint16 element);
164 int SetPubElValLengthByNumber(guint32 lgr, guint16 group, guint16 element);
165 int ReplaceOrCreateByNumber(std::string Value, guint16 Group, guint16 Elem);
169 int GetPixelSize(void);
170 std::string GetPixelType(void);
171 int Write(FILE *, FileType);