src/gdcmDocument.h

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