src/gdcmDocument.h

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