src/gdcmDocument.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocument.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/20 11:37:37 $
   7   Version:   $Revision: 1.94 $
   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    RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
  53    JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
  54
  55 // Dictionaries
  56    virtual void PrintPubDict (std::ostream &os = std::cout);
  57    virtual void PrintShaDict (std::ostream &os = std::cout);
  58
  59    Dict* GetPubDict();
  60    Dict* GetShaDict();
  61    bool SetShaDict(Dict* dict);
  62    bool SetShaDict(DictKey const &dictName);
  63
  64 // Swap code
  65    /// 'Swap code' accessor (see \ref SwapCode )
  66    int GetSwapCode() { return SwapCode; }
  67    // System access (meaning endian related !?)
  68    uint16_t SwapShort(uint16_t);   // needed by File
  69    uint32_t SwapLong(uint32_t);    // needed by File
  70    uint16_t UnswapShort(uint16_t); // needed by File
  71    uint32_t UnswapLong(uint32_t);  // needed by File
  72
  73 // Ordering of Documents
  74    bool operator<(Document &document);
  75
  76 public:
  77 // File I/O
  78    /// Accessor to \ref Filename
  79    const std::string &GetFileName() const { return Filename; }
  80    /// Accessor to \ref Filename
  81    void SetFileName(std::string const &fileName) { Filename = fileName; }
  82
  83    std::ifstream *OpenFile();
  84    bool CloseFile();
  85    void WriteContent( std::ofstream *fp, FileType type );
  86
  87 // Content entries
  88
  89 // Oops ! Python is gonna cry :
  90 // 4 methods with same name and different parameters ...
  91 // Only C++ is aware!
  92
  93    virtual bool SetEntry(std::string const &content,
  94                          uint16_t group, uint16_t elem);
  95    virtual bool SetEntry(uint8_t *content, int lgth,
  96                          uint16_t group, uint16_t elem);
  97    virtual bool SetEntry(std::string const &content, ValEntry *entry);
  98    virtual bool SetEntry(uint8_t *content, int lgth, BinEntry *entry);
  99
 100    virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);
 101
 102    virtual std::string GetEntry  (uint16_t group, uint16_t elem);
 103    virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
 104    virtual int GetEntryLength(uint16_t group, uint16_t elem);
 105
 106    ValEntry *ReplaceOrCreate(std::string const &value,
 107                              uint16_t group, uint16_t elem,
 108                              TagName const &vr = GDCM_UNKNOWN);
 109    BinEntry *ReplaceOrCreate(uint8_t* binArea, int lgth,
 110                              uint16_t group, uint16_t elem,
 111                              TagName const &vr = GDCM_UNKNOWN);
 112    SeqEntry *ReplaceOrCreate(uint16_t group, uint16_t elem);
 113
 114    bool ReplaceIfExist(std::string const &value,
 115                        uint16_t group, uint16_t elem );
 116
 117    bool CheckIfEntryExist(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    bool IsDicomV3();
 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 known '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    static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
 186
 187    /// Store the RLE frames info obtained during parsing of pixels.
 188    RLEFramesInfo *RLEInfo;
 189
 190    /// Store the JPEG fragments info obtained during parsing of pixels.
 191    JPEGFragmentsInfo *JPEGInfo;
 192
 193 private:
 194 // Methods
 195    // Read
 196    void ParseDES(DocEntrySet *set,long offset, long l_max, bool delim_mode);
 197    void ParseSQ (SeqEntry *seq,   long offset, long l_max, bool delim_mode);
 198
 199    void LoadDocEntry         (DocEntry *e);
 200    void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
 201    uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
 202    std::string FindDocEntryVR();
 203    bool CheckDocEntryVR      (VRKey k);
 204
 205    std::string GetDocEntryValue  (DocEntry *entry);
 206    std::string GetDocEntryUnvalue(DocEntry *entry);
 207
 208
 209    void SkipDocEntry          (DocEntry *entry);
 210    void SkipToNextDocEntry    (DocEntry *entry);
 211
 212    void FixDocEntryFoundLength(DocEntry *entry,uint32_t l);
 213    bool IsDocEntryAnInteger   (DocEntry *entry);
 214
 215    uint16_t ReadInt16() throw ( FormatError );
 216    uint32_t ReadInt32() throw ( FormatError );
 217    void     SkipBytes(uint32_t);
 218    bool     ReadTag(uint16_t, uint16_t);
 219    uint32_t ReadTagLength(uint16_t, uint16_t);
 220
 221    void Initialize();
 222    bool CheckSwap();
 223    void SwitchByteSwapCode();
 224    void SetMaxSizeLoadEntry(long);
 225    void SetMaxSizePrintEntry(long);
 226
 227    // DocEntry related utilities
 228    DocEntry *ReadNextDocEntry();
 229
 230    uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
 231 /*   void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
 232                                    DocEntrySet* set );*/
 233
 234    void HandleBrokenEndian(uint16_t &group, uint16_t &elem);
 235    void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
 236
 237 // Variables
 238    /// Public dictionary used to parse this header
 239    Dict *RefPubDict;
 240
 241    /// \brief Optional "shadow dictionary" (private elements) used to parse
 242    /// this header
 243    Dict *RefShaDict;
 244
 245    /// \brief Size threshold above which an element value will NOT be loaded
 246    /// in memory (to avoid loading the image/volume itself). By default,
 247    /// this upper bound is fixed to 1024 bytes (which might look reasonable
 248    /// when one considers the definition of the various VR contents).
 249    uint32_t MaxSizeLoadEntry;
 250
 251    /// \brief Size threshold above which an element value will NOT be *printed*
 252    /// in order no to polute the screen output. By default, this upper bound
 253    /// is fixed to 64 bytes.
 254    uint32_t MaxSizePrintEntry;
 255
 256 private:
 257    friend class File;
 258 };
 259 } // end namespace gdcm
 260
 261 //-----------------------------------------------------------------------------
 262 #endif