src/gdcmDocument.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocument.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/03/22 11:23:51 $
   7   Version:   $Revision: 1.107 $
   8
   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.
  12
  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.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMDOCUMENT_H
  20 #define GDCMDOCUMENT_H
  21
  22 #include "gdcmVR.h"
  23 #include "gdcmDict.h"
  24 #include "gdcmElementSet.h"
  25 #include "gdcmException.h"
  26
  27 #include <map>
  28 #include <list>
  29 #include <fstream>
  30
  31 #define NO_SEQ    0x0000001
  32 #define NO_SHADOW 0x00000002
  33
  34 namespace gdcm
  35 {
  36 class ValEntry;
  37 class BinEntry;
  38 class SeqEntry;
  39 class Dict;
  40
  41 //-----------------------------------------------------------------------------
  42 /**
  43  * \brief Derived by both gdcm::File and gdcm::DicomDir
  44  */
  45 class GDCM_EXPORT Document : public ElementSet
  46 {
  47 public:
  48
  49 typedef std::list<Element> ListElements;
  50
  51 // Loading
  52 void Load( std::string const &filename );
  53
  54 // Dictionaries
  55    Dict *GetPubDict();
  56    Dict *GetShaDict();
  57    bool SetShaDict(Dict *dict);
  58    bool SetShaDict(DictKey const &dictName);
  59
  60 // Informations contained in the gdcm::Document
  61    virtual bool IsReadable();
  62    bool IsDicomV3();
  63    bool IsPapyrus();
  64    FileType GetFileType();
  65    std::string GetTransferSyntax();
  66    /// Return the Transfer Syntax as a string
  67    std::string GetTransferSyntaxName();
  68
  69 // Swap code
  70    /// 'Swap code' accessor (see \ref SwapCode )
  71    int GetSwapCode() { return SwapCode; }
  72    // System access (meaning endian related !?)
  73    uint16_t SwapShort(uint16_t);
  74    uint32_t SwapLong(uint32_t);
  75    /// \brief  Unswaps back the bytes of 2-bytes long integer
  76    ///         so they agree with the processor order.
  77    uint16_t UnswapShort(uint16_t a) { return SwapShort(a);}
  78    /// \brief  Unswaps back the bytes of 4-byte long integer
  79    ///         so they agree with the processor order.
  80    uint32_t UnswapLong(uint32_t a) { return SwapLong(a);}
  81
  82 // File I/O
  83    /// Accessor to \ref Filename
  84    const std::string &GetFileName() const { return Filename; }
  85    /// Accessor to \ref Filename
  86    void SetFileName(std::string const &fileName) { Filename = fileName; }
  87
  88    std::ifstream *OpenFile();
  89    bool CloseFile();
  90    void WriteContent( std::ofstream *fp, FileType type );
  91
  92 // Content entries
  93    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
  94    virtual void LoadEntryBinArea(BinEntry *entry);
  95
  96    void LoadDocEntrySafe(DocEntry *entry);
  97
  98 // Ordering of Documents
  99    bool operator<(Document &document);
 100
 101    /// \brief Sets the LoadMode as a boolean string
 102    /// NO_SEQ, NO_SHADOW, ... (nothing more, right now)
 103    void SetLoadMode (int mode) { LoadMode = mode; }
 104
 105 protected:
 106 // Methods
 107    // Constructor and destructor are protected to forbid end user
 108    // to instanciate from this class Document (only gdcm::File and
 109    // gdcm::DicomDir are meaningfull).
 110    Document();
 111    Document( std::string const &filename );
 112    virtual ~Document();
 113
 114    uint16_t ReadInt16() throw ( FormatError );
 115    uint32_t ReadInt32() throw ( FormatError );
 116    void     SkipBytes(uint32_t);
 117    int ComputeGroup0002Length( FileType filetype );
 118
 119 // Variables
 120    /// Refering underlying filename.
 121    std::string Filename;
 122
 123    /// \brief Swap code gives an information on the byte order of a
 124    ///  supposed to be an int32, as it's read on disc
 125    /// (depending on the image Transfer Syntax *and* on the processor endianess)
 126    /// as opposed as it should in memory to be dealt as an int32.
 127    /// For instance :
 128    /// - a 'Little Endian' image, read with a little endian processor
 129    /// will have a SwapCode= 1234 (the order is OK; nothing to do)
 130    /// - a 'Little Endian' image, read with a big endian procesor
 131    /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
 132    /// swapped)
 133    /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
 134    /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes
 135    int SwapCode;
 136
 137    ///\brief whether we already parsed group 0002 (Meta Elements)
 138    bool Group0002Parsed;
 139
 140    ///\brief whether file has a DCM Preamble
 141    bool HasDCMPreamble;
 142
 143    /// File Pointer, opened during Document parsing.
 144    std::ifstream *Fp;
 145
 146    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
 147    FileType Filetype;
 148
 149    /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
 150    static const unsigned int HEADER_LENGTH_TO_READ;
 151    /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
 152    /// are NOT loaded.
 153    static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
 154
 155    /// List of element to Anonymize
 156    ListElements AnonymizeList;
 157
 158 private:
 159 // Methods
 160    void Initialize();
 161
 162    // Read
 163    void ParseDES(DocEntrySet *set, long offset, long l_max, bool delim_mode);
 164    void ParseSQ (SeqEntry *seq,    long offset, long l_max, bool delim_mode);
 165
 166    void LoadDocEntry         (DocEntry *e);
 167    void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
 168    uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
 169    std::string FindDocEntryVR();
 170    bool CheckDocEntryVR      (VRKey k);
 171
 172    std::string GetDocEntryValue  (DocEntry *entry);
 173    std::string GetDocEntryUnvalue(DocEntry *entry);
 174
 175    void SkipDocEntry          (DocEntry *entry);
 176    void SkipToNextDocEntry    (DocEntry *entry);
 177
 178    void FixDocEntryFoundLength(DocEntry *entry, uint32_t l);
 179    bool IsDocEntryAnInteger   (DocEntry *entry);
 180
 181    bool CheckSwap();
 182    void SwitchByteSwapCode();
 183    void SetMaxSizeLoadEntry(long);
 184
 185    // DocEntry related utilities
 186    DocEntry *ReadNextDocEntry();
 187
 188    void HandleBrokenEndian  (uint16_t &group, uint16_t &elem);
 189    void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
 190
 191 // Variables
 192    /// Public dictionary used to parse this header
 193    Dict *RefPubDict;
 194    /// \brief Optional "shadow dictionary" (private elements) used to parse
 195    /// this header
 196    Dict *RefShaDict;
 197
 198    /// \brief Size threshold above which an element value will NOT be loaded
 199    /// in memory (to avoid loading the image/volume itself). By default,
 200    /// this upper bound is fixed to 1024 bytes (which might look reasonable
 201    /// when one considers the definition of the various VR contents).
 202    uint32_t MaxSizeLoadEntry;
 203
 204 //  uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
 205 //  void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
 206 //                                  DocEntrySet *set );
 207
 208    /// \brief Bit string integer (each one considered as a boolean)
 209    ///        Bit 0 : Skip Sequences,    if possible
 210    ///        Bit 1 : Skip Shadow Groups if possible
 211    ///        Some more to add
 212    int LoadMode;
 213 };
 214
 215 } // end namespace gdcm
 216
 217 //-----------------------------------------------------------------------------
 218 #endif