src/gdcmDocument.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocument.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/14 11:28:30 $
   7   Version:   $Revision: 1.87 $
   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
  26 #include <map>
  27 #include <list>
  28 #include <fstream>
  29
  30 namespace gdcm
  31 {
  32 class ValEntry;
  33 class BinEntry;
  34 class SeqEntry;
  35 class Dict;
  36 class RLEFramesInfo;
  37 class JPEGFragmentsInfo;
  38
  39 //-----------------------------------------------------------------------------
  40 /**
  41  * \brief Derived by both Header and DicomDir
  42  */
  43 class GDCM_EXPORT Document : public ElementSet
  44 {
  45 public:
  46 // Informations contained in the parser
  47    virtual bool IsReadable();
  48    FileType GetFileType();
  49
  50    std::string GetTransferSyntax();
  51
  52    bool IsDicomV3();
  53
  54    RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
  55    JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
  56
  57 // Dictionnaries
  58    virtual void PrintPubDict (std::ostream &os = std::cout);
  59    virtual void PrintShaDict (std::ostream &os = std::cout);
  60
  61    Dict* GetPubDict();
  62    Dict* GetShaDict();
  63    bool SetShaDict(Dict* dict);
  64    bool SetShaDict(DictKey const &dictName);
  65
  66 // Swap code
  67    /// 'Swap code' accessor (see \ref SwapCode )
  68    int GetSwapCode() { return SwapCode; }
  69    // System access (meaning endian related !?)
  70    uint16_t SwapShort(uint16_t);   // needed by File
  71    uint32_t SwapLong(uint32_t);    // needed by File
  72    uint16_t UnswapShort(uint16_t); // needed by File
  73    uint32_t UnswapLong(uint32_t);  // needed by File
  74
  75 // Ordering of Documents
  76    bool operator<(Document &document);
  77
  78 public:
  79 // File I/O
  80    /// Accessor to \ref Filename
  81    const std::string &GetFileName() const { return Filename; }
  82    /// Accessor to \ref Filename
  83    void SetFileName(std::string const &fileName) { Filename = fileName; }
  84
  85    std::ifstream *OpenFile();
  86    bool CloseFile();
  87    void WriteContent( std::ofstream *fp, FileType type );
  88
  89 // Content entries
  90
  91    virtual bool SetEntry(std::string const &content,
  92                          uint16_t group, uint16_t element);
  93    virtual bool SetEntry(uint8_t *content, int lgth,
  94                          uint16_t group, uint16_t element);
  95    virtual bool SetEntry(std::string const &content, ValEntry *entry);
  96    virtual bool SetEntry(uint8_t *content, int lgth, BinEntry *entry);
  97
  98    virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);
  99
 100    virtual std::string GetEntry  (uint16_t group, uint16_t elem);
 101    virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
 102    virtual int GetEntryLength(uint16_t group, uint16_t elem);
 103
 104    DocEntry *GetDocEntry(uint16_t group, uint16_t element);
 105    ValEntry *GetValEntry(uint16_t group, uint16_t element);
 106    BinEntry *GetBinEntry(uint16_t group, uint16_t element);
 107
 108    ValEntry *ReplaceOrCreate(std::string const &value,
 109                              uint16_t group, uint16_t elem,
 110                              TagName const &vr = GDCM_UNKNOWN);
 111    BinEntry *ReplaceOrCreate(uint8_t* binArea, int lgth,
 112                              uint16_t group, uint16_t elem,
 113                              TagName const &vr = GDCM_UNKNOWN);
 114    SeqEntry *ReplaceOrCreate(uint16_t group, uint16_t elem);
 115
 116    bool ReplaceIfExist(std::string const &value,
 117                        uint16_t group, uint16_t elem );
 118
 119    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
 120    virtual void LoadEntryBinArea(BinEntry *entry);
 121
 122    void LoadDocEntrySafe(DocEntry *entry);
 123    /*TagDocEntryHT *BuildFlatHashTable();*/
 124
 125    /// Return the Transfer Syntax as a string
 126    std::string GetTransferSyntaxName();
 127
 128 protected:
 129 // Methods
 130    // Constructor and destructor are protected to forbid end user
 131    // to instanciate from this class Document (only Header and
 132    // DicomDir are meaningfull).
 133    Document();
 134    Document( std::string const &filename );
 135    virtual ~Document();
 136
 137    void ReadAndSkipEncapsulatedBasicOffsetTable();
 138    void ComputeRLEInfo();
 139    void ComputeJPEGFragmentInfo();
 140    // Entry
 141    bool CheckIfEntryExist(uint16_t group, uint16_t elem );
 142
 143    int ComputeGroup0002Length( FileType filetype );
 144
 145 // Variables
 146    /// Refering underlying filename.
 147    std::string Filename;
 148
 149    /// \brief Swap code gives an information on the byte order of a
 150    ///  supposed to be an int32, as it's read on disc
 151    /// (depending on the image Transfer Syntax *and* on the processor endianess)
 152    /// as opposed as it should in memory to be dealt as an int32.
 153    /// For instance :
 154    /// - a 'Little Endian' image, read with a little endian processor
 155    /// will have a SwapCode= 1234 (the order is OK; nothing to do)
 156    /// - a 'Little Endian' image, read with a big endian procesor
 157    /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
 158    /// swapped)
 159    /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
 160    /// the well knowed 'Bad Big Endian' and 'Bad Little Endian' codes
 161    int SwapCode;
 162
 163    ///\brief whether we already parsed group 0002
 164    bool Group0002Parsed;
 165
 166    ///\brief whether file has a DCM Preamble
 167    bool HasDCMPreamble;
 168
 169    /// File Pointer, opened during Header parsing.
 170    std::ifstream *Fp;
 171
 172    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
 173    FileType Filetype;
 174
 175    /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
 176    static const unsigned int HEADER_LENGTH_TO_READ;
 177
 178    /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
 179    /// are NOT loaded.
 180    static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
 181
 182    /// \brief Elements whose value is longer than  MAX_SIZE_PRINT_ELEMENT_VALUE
 183    /// are NOT printed.
 184    /// \todo Currently not used since collides with #define in
 185    ///       class DocEntry . See also
 186    ///       method ref Document::SetMaxSizePrintEntry()
 187    static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
 188
 189    /// Store the RLE frames info obtained during parsing of pixels.
 190    RLEFramesInfo *RLEInfo;
 191
 192    /// Store the JPEG fragments info obtained during parsing of pixels.
 193    JPEGFragmentsInfo *JPEGInfo;
 194
 195 private:
 196 // Methods
 197    // Read
 198    void ParseDES(DocEntrySet *set,long offset, long l_max, bool delim_mode);
 199    void ParseSQ (SeqEntry *seq,   long offset, long l_max, bool delim_mode);
 200
 201    void LoadDocEntry         (DocEntry *e);
 202    void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
 203    uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
 204    std::string FindDocEntryVR();
 205    bool CheckDocEntryVR      (VRKey k);
 206
 207    std::string GetDocEntryValue  (DocEntry *entry);
 208    std::string GetDocEntryUnvalue(DocEntry *entry);
 209
 210
 211    void SkipDocEntry          (DocEntry *entry);
 212    void SkipToNextDocEntry    (DocEntry *entry);
 213
 214    void FixDocEntryFoundLength(DocEntry *entry,uint32_t l);
 215    bool IsDocEntryAnInteger   (DocEntry *entry);
 216
 217    uint16_t ReadInt16() throw ( FormatError );
 218    uint32_t ReadInt32() throw ( FormatError );
 219    void     SkipBytes(uint32_t);
 220    bool     ReadTag(uint16_t, uint16_t);
 221    uint32_t ReadTagLength(uint16_t, uint16_t);
 222
 223    void Initialise();
 224    bool CheckSwap();
 225    void SwitchByteSwapCode();
 226    void SetMaxSizeLoadEntry(long);
 227    void SetMaxSizePrintEntry(long);
 228
 229    // DocEntry related utilities
 230    DocEntry *ReadNextDocEntry();
 231
 232    uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
 233 /*   void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
 234                                    DocEntrySet* set );*/
 235
 236    void HandleBrokenEndian(uint16_t &group, uint16_t &elem);
 237    void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
 238
 239 // Variables
 240    /// Public dictionary used to parse this header
 241    Dict *RefPubDict;
 242
 243    /// \brief Optional "shadow dictionary" (private elements) used to parse
 244    /// this header
 245    Dict *RefShaDict;
 246
 247    /// \brief Size threshold above which an element value will NOT be loaded
 248    /// in memory (to avoid loading the image/volume itself). By default,
 249    /// this upper bound is fixed to 1024 bytes (which might look reasonable
 250    /// when one considers the definition of the various VR contents).
 251    uint32_t MaxSizeLoadEntry;
 252
 253    /// \brief Size threshold above which an element value will NOT be *printed*
 254    /// in order no to polute the screen output. By default, this upper bound
 255    /// is fixed to 64 bytes.
 256    uint32_t MaxSizePrintEntry;
 257
 258 private:
 259    friend class File;
 260 };
 261 } // end namespace gdcm
 262
 263 //-----------------------------------------------------------------------------
 264 #endif