src/gdcmHeader.h

   1 // gdcmHeader.h
   2
   3 #ifndef GDCMHEADER_H
   4 #define GDCMHEADER_H
   5
   6 #include <map>
   7 #include "gdcmCommon.h"
   8 #include "gdcmException.h"
   9 #include "gdcmDictSet.h"
  10 #include "gdcmElValue.h"
  11 #include "gdcmElValSet.h"
  12
  13 typedef string VRKey;
  14 typedef string VRAtr;
  15 typedef map<VRKey, VRAtr> VRHT;    // Value Representation Hash Table
  16
  17 /// The purpose of an instance of gdcmHeader is to act as a container of
  18 /// all the DICOM elements and their corresponding values (and
  19 /// additionaly the corresponding DICOM dictionary entry) of the header
  20 /// of a DICOM file.
  21 ///
  22 /// The typical usage of instances of class gdcmHeader is to classify a set of
  23 /// dicom files according to header information e.g. to create a file hierarchy
  24 /// reflecting the Patient/Study/Serie informations, or extracting a given
  25 /// SerieId. Accesing the content (image[s] or volume[s]) is beyond the
  26 /// functionality of this class and belongs to gdmcFile.
  27 /// \note  The various entries of the explicit value representation (VR) shall
  28 ///        be managed within a dictionary which is shared by all gdcmHeader
  29 ///        instances.
  30 /// \note  The gdcmHeader::Set*Tag* family members cannot be defined as
  31 ///        protected due to Swig limitations for as Has_a dependency between
  32 ///        gdcmFile and gdcmHeader.
  33
  34 class GDCM_EXPORT gdcmHeader {
  35    void SkipBytes(guint32);
  36 private:
  37    /// Pointer to the Value Representation Hash Table which contains all
  38    /// the VR of the DICOM version3 public dictionary.
  39    static VRHT *dicom_vr;
  40
  41    /// Global dictionary container
  42    gdcmDictSet* Dicts;
  43    /// Public dictionary used to parse this header
  44    gdcmDict* RefPubDict;
  45    /// Optional "shadow dictionary" (private elements) used to parse this
  46    /// header
  47    gdcmDict* RefShaDict;
  48
  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.
  54    string filename;
  55
  56    // FIXME sw should be an enum e.g.
  57    //enum EndianType {
  58       //LittleEndian,
  59       //BadLittleEndian,
  60       //BigEndian,
  61       //BadBigEndian};
  62    /// Swap code e.g. little, big, bad-big, bad-little endian). Warning:
  63    /// this code is not fixed during header parsing.
  64    int sw;
  65
  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;
  71
  72    guint16 ReadInt16(void);
  73    guint32 ReadInt32(void);
  74    guint16 SwapShort(guint16);
  75    guint32 SwapLong(guint32);
  76    guint32 FindLengthOB(void);
  77    void Initialise(void);
  78    void CheckSwap(void);
  79    void InitVRDict(void);
  80    void SwitchSwapToBigEndian(void);
  81    // CLEAN ME: NewManualElValToPubDict is NOT called any more.
  82    gdcmElValue*  NewManualElValToPubDict(string NewTagName, string VR);
  83    void SetMaxSizeLoadElementValue(long);
  84
  85    gdcmDictEntry * GetDictEntryByNumber(guint16, guint16);
  86    gdcmDictEntry * GetDictEntryByName(string name);
  87
  88    // ElValue related utilities
  89    gdcmElValue * ReadNextElement(void);
  90    gdcmElValue * NewElValueByNumber(guint16 group, guint16 element);
  91    gdcmElValue * NewElValueByName(string name);
  92    void FindLength(gdcmElValue *);
  93    void FindVR(gdcmElValue *);
  94    void LoadElementValue(gdcmElValue *);
  95    void LoadElementValueSafe(gdcmElValue *);
  96    void SkipElementValue(gdcmElValue *);
  97    void FixFoundLength(gdcmElValue*, guint32);
  98    bool IsAnInteger(gdcmElValue *);
  99    void LoadElements(void);
 100
 101 protected:
 102    FILE * fp;
 103    FileType filetype;
 104    bool OpenFile(bool exception_on_error = false)
 105      throw(gdcmFileError);
 106    bool CloseFile(void);
 107    int write(ostream&);
 108    int anonymize(ostream&);  // FIXME : anonymize should be a friend ?
 109 public:
 110    bool IsReadable(void);
 111    bool IsImplicitVRLittleEndianTransferSyntax(void);
 112    bool IsExplicitVRLittleEndianTransferSyntax(void);
 113    bool IsDeflatedExplicitVRLittleEndianTransferSyntax(void);
 114    bool IsExplicitVRBigEndianTransferSyntax(void);
 115    bool IsJPEGBaseLineProcess1TransferSyntax(void);
 116    bool IsJPEGExtendedProcess2_4TransferSyntax(void);
 117    bool IsJPEGExtendedProcess3_5TransferSyntax(void);
 118    bool IsJPEGSpectralSelectionProcess6_8TransferSyntax(void);
 119    bool IsJPEGLossless(void);
 120    bool IsDicomV3(void);
 121
 122    virtual void ParseHeader(bool exception_on_error = false)
 123      throw(gdcmFormatError);
 124    gdcmHeader(const char *filename, bool exception_on_error = false);
 125    virtual ~gdcmHeader();
 126
 127    size_t GetPixelOffset(void);
 128    int    GetSwapCode(void) { return sw; }
 129
 130    // TODO Swig int SetPubDict(string filename);
 131    // When some proprietary shadow groups are disclosed, we can set up
 132    // an additional specific dictionary to access extra information.
 133    // TODO Swig int SetShaDict(string filename);
 134
 135    string GetPubElValByName(string TagName);
 136    string GetPubElValByNumber(guint16 group, guint16 element);
 137    string GetPubElValRepByName(string TagName);
 138    string GetPubElValRepByNumber(guint16 group, guint16 element);
 139
 140    TagElValueHT & GetPubElVal(void) { return PubElValSet.GetTagHt(); };
 141    void   PrintPubElVal(ostream & os = cout);
 142    void   PrintPubDict (ostream & os = cout);
 143
 144    // TODO Swig string* GetShaTagNames();
 145    string GetShaElValByName(string TagName);
 146    string GetShaElValByNumber(guint16 group, guint16 element);
 147    string GetShaElValRepByName(string TagName);
 148    string GetShaElValRepByNumber(guint16 group, guint16 element);
 149
 150    string GetElValByName(string TagName);
 151    string GetElValByNumber(guint16 group, guint16 element);
 152    string GetElValRepByName(string TagName);
 153    string GetElValRepByNumber(guint16 group, guint16 element);
 154
 155    int SetPubElValByName(string content, string TagName);
 156    int SetPubElValByNumber(string content, guint16 group, guint16 element);
 157    int SetShaElValByName(string content, string ShadowTagName);
 158    int SetShaElValByNumber(string content, guint16 group, guint16 element);
 159
 160    int SetPubElValLengthByNumber(guint32 lgr, guint16 group, guint16 element);
 161    int ReplaceOrCreateByNumber(string Value, guint16 Group, guint16 Elem);
 162    int GetXSize(void);
 163    int GetYSize(void);
 164    int GetZSize(void);
 165    string GetPixelType(void);
 166    int Write(FILE *, FileType);
 167
 168 };
 169
 170 #endif