src/gdcmDocument.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocument.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/17 16:52:21 $
   7   Version:   $Revision: 1.88 $
   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    bool CheckIfEntryExist(uint16_t group, uint16_t elem );
 120
 121    virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
 122    virtual void LoadEntryBinArea(BinEntry *entry);
 123
 124    void LoadDocEntrySafe(DocEntry *entry);
 125    /*TagDocEntryHT *BuildFlatHashTable();*/
 126
 127    /// Return the Transfer Syntax as a string
 128    std::string GetTransferSyntaxName();
 129
 130 protected:
 131 // Methods
 132    // Constructor and destructor are protected to forbid end user
 133    // to instanciate from this class Document (only Header and
 134    // DicomDir are meaningfull).
 135    Document();
 136    Document( std::string const &filename );
 137    virtual ~Document();
 138
 139    void ReadAndSkipEncapsulatedBasicOffsetTable();
 140    void ComputeRLEInfo();
 141    void ComputeJPEGFragmentInfo();
 142    // Entry
 143
 144    int ComputeGroup0002Length( FileType filetype );
 145
 146 // Variables
 147    /// Refering underlying filename.
 148    std::string Filename;
 149
 150    /// \brief Swap code gives an information on the byte order of a
 151    ///  supposed to be an int32, as it's read on disc
 152    /// (depending on the image Transfer Syntax *and* on the processor endianess)
 153    /// as opposed as it should in memory to be dealt as an int32.
 154    /// For instance :
 155    /// - a 'Little Endian' image, read with a little endian processor
 156    /// will have a SwapCode= 1234 (the order is OK; nothing to do)
 157    /// - a 'Little Endian' image, read with a big endian procesor
 158    /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be
 159    /// swapped)
 160    /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
 161    /// the well knowed 'Bad Big Endian' and 'Bad Little Endian' codes
 162    int SwapCode;
 163
 164    ///\brief whether we already parsed group 0002
 165    bool Group0002Parsed;
 166
 167    ///\brief whether file has a DCM Preamble
 168    bool HasDCMPreamble;
 169
 170    /// File Pointer, opened during Header parsing.
 171    std::ifstream *Fp;
 172
 173    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
 174    FileType Filetype;
 175
 176    /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
 177    static const unsigned int HEADER_LENGTH_TO_READ;
 178
 179    /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
 180    /// are NOT loaded.
 181    static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
 182
 183    /// \brief Elements whose value is longer than  MAX_SIZE_PRINT_ELEMENT_VALUE
 184    /// are NOT printed.
 185    /// \todo Currently not used since collides with #define in
 186    ///       class DocEntry . See also
 187    ///       method ref Document::SetMaxSizePrintEntry()
 188    static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
 189
 190    /// Store the RLE frames info obtained during parsing of pixels.
 191    RLEFramesInfo *RLEInfo;
 192
 193    /// Store the JPEG fragments info obtained during parsing of pixels.
 194    JPEGFragmentsInfo *JPEGInfo;
 195
 196 private:
 197 // Methods
 198    // Read
 199    void ParseDES(DocEntrySet *set,long offset, long l_max, bool delim_mode);
 200    void ParseSQ (SeqEntry *seq,   long offset, long l_max, bool delim_mode);
 201
 202    void LoadDocEntry         (DocEntry *e);
 203    void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
 204    uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
 205    std::string FindDocEntryVR();
 206    bool CheckDocEntryVR      (VRKey k);
 207
 208    std::string GetDocEntryValue  (DocEntry *entry);
 209    std::string GetDocEntryUnvalue(DocEntry *entry);
 210
 211
 212    void SkipDocEntry          (DocEntry *entry);
 213    void SkipToNextDocEntry    (DocEntry *entry);
 214
 215    void FixDocEntryFoundLength(DocEntry *entry,uint32_t l);
 216    bool IsDocEntryAnInteger   (DocEntry *entry);
 217
 218    uint16_t ReadInt16() throw ( FormatError );
 219    uint32_t ReadInt32() throw ( FormatError );
 220    void     SkipBytes(uint32_t);
 221    bool     ReadTag(uint16_t, uint16_t);
 222    uint32_t ReadTagLength(uint16_t, uint16_t);
 223
 224    void Initialise();
 225    bool CheckSwap();
 226    void SwitchByteSwapCode();
 227    void SetMaxSizeLoadEntry(long);
 228    void SetMaxSizePrintEntry(long);
 229
 230    // DocEntry related utilities
 231    DocEntry *ReadNextDocEntry();
 232
 233    uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
 234 /*   void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
 235                                    DocEntrySet* set );*/
 236
 237    void HandleBrokenEndian(uint16_t &group, uint16_t &elem);
 238    void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
 239
 240 // Variables
 241    /// Public dictionary used to parse this header
 242    Dict *RefPubDict;
 243
 244    /// \brief Optional "shadow dictionary" (private elements) used to parse
 245    /// this header
 246    Dict *RefShaDict;
 247
 248    /// \brief Size threshold above which an element value will NOT be loaded
 249    /// in memory (to avoid loading the image/volume itself). By default,
 250    /// this upper bound is fixed to 1024 bytes (which might look reasonable
 251    /// when one considers the definition of the various VR contents).
 252    uint32_t MaxSizeLoadEntry;
 253
 254    /// \brief Size threshold above which an element value will NOT be *printed*
 255    /// in order no to polute the screen output. By default, this upper bound
 256    /// is fixed to 64 bytes.
 257    uint32_t MaxSizePrintEntry;
 258
 259 private:
 260    friend class File;
 261 };
 262 } // end namespace gdcm
 263
 264 //-----------------------------------------------------------------------------
 265 #endif