2 //-----------------------------------------------------------------------------
6 #include "gdcmCommon.h"
7 #include "gdcmParser.h"
9 //-----------------------------------------------------------------------------
11 * \defgroup gdcmHeader
13 * The purpose of an instance of gdcmHeader is to act as a container of
14 * all the DICOM elements and their corresponding values (and
15 * additionaly the corresponding DICOM dictionary entry) of the header
18 * The typical usage of instances of class gdcmHeader is to classify a set of
19 * dicom files according to header information e.g. to create a file hierarchy
20 * reflecting the Patient/Study/Serie informations, or extracting a given
21 * SerieId. Accessing the content (image[s] or volume[s]) is beyond the
22 * functionality of this class and belongs to gdmcFile.
23 * \note The various entries of the explicit value representation (VR) shall
24 * be managed within a dictionary which is shared by all gdcmHeader
26 * \note The gdcmHeader::Set*Tag* family members cannot be defined as
27 * protected due to Swig limitations for as Has_a dependency between
28 * gdcmFile and gdcmHeader.
30 class GDCM_EXPORT gdcmHeader : public gdcmParser
33 gdcmHeader(bool exception_on_error = false);
34 gdcmHeader(const char *filename,
35 bool exception_on_error = false,
36 bool enable_sequences = false,
37 bool skip_shadow = false);
39 virtual ~gdcmHeader();
41 // Standard values and informations contained in the header
42 virtual bool IsReadable(void);
43 bool IsJPEGBaseLineProcess1TransferSyntax(void);
44 bool IsJPEGExtendedProcess2_4TransferSyntax(void);
45 bool IsJPEGExtendedProcess3_5TransferSyntax(void);
46 bool IsJPEGSpectralSelectionProcess6_8TransferSyntax(void);
47 bool IsRLELossLessTransferSyntax(void);
48 bool IsJPEGLossless(void);
49 bool IsJPEG2000(void);
52 // Some heuristic based accessors, end user intended
53 // (to be move to gdcmHeaderHelper?)
57 int GetBitsStored(void);
58 int GetBitsAllocated(void);
59 int GetSamplesPerPixel(void);
60 int GetPlanarConfiguration(void);
62 int GetPixelSize(void);
63 std::string GetPixelType(void);
64 size_t GetPixelOffset(void);
65 size_t GetPixelAreaLength(void);
68 int GetLUTNbits(void);
69 unsigned char * GetLUTRGBA(void);
71 std::string GetTransfertSyntaxName(void);
73 // When some proprietary shadow groups are disclosed, we can set up
74 // an additional specific dictionary to access extra information.
76 // OK : we still have *ONE* HeaderEntrySet,
77 // with both Public and Shadow Elements
78 // parsed against THE Public Dictionary and A (single) Shadow Dictionary
80 // TODO Swig int SetShaDict(std::string filename);
81 // TODO Swig int SetPubDict(std::string filename);
85 inline virtual std::string GetEntryByNumber (guint16 group, guint16 element)
86 { return(gdcmParser::GetEntryByNumber(group,element)); }
87 inline virtual std::string GetEntryVRByNumber(guint16 group, guint16 element)
88 { return(gdcmParser::GetEntryVRByNumber(group,element)); }
90 inline virtual std::string GetEntryByName (std::string tagName)
91 { return(gdcmParser::GetEntryByName(tagName)); }
92 inline virtual std::string GetEntryVRByName (std::string tagName)
93 { return(gdcmParser::GetEntryVRByName(tagName)); }
95 inline virtual bool SetEntryByNumber(std::string content,guint16 group, guint16 element)
96 { return(gdcmParser::SetEntryByNumber(content,group,element)); }
97 inline virtual bool SetEntryByName(std::string content,std::string tagName)
98 { return(gdcmParser::SetEntryByName(content,tagName)); }
100 inline virtual bool SetEntryLengthByNumber(guint32 l,guint16 group, guint16 element)
101 { return(gdcmParser::SetEntryLengthByNumber(l,group,element)); }
103 inline virtual void UpdateShaEntries(void)
104 { gdcmParser::UpdateShaEntries(); }
106 // Read (used in gdcmFile)
107 void SetImageDataSize(size_t ExpectedSize);
109 bool operator<(gdcmHeader &header);
112 int write(std::ostream&);
113 int anonymize(std::ostream&); // FIXME : anonymize should be a friend ?
119 //-----------------------------------------------------------------------------