src/gdcmDocument.h

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