src/gdcmDocument.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocument.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/12 10:47:44 $
   7   Version:   $Revision: 1.84 $
   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, a 'Little Endian' image, read with a little endian procesor
 154    /// will have a SwapCode= 1234 (the order is OK; nothing to do)
 155    /// a 'Little Endian' image, read with a big endian procesor
 156    /// will have a SwapCode= 2143 (the order is wrong; int32 an int16 must be
 157    /// swapped)
 158    /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and
 159    /// the well knowed 'Bad Big Endian' and 'Bad Little Endian' codes
 160    int SwapCode;
 161
 162    ///\brief whether we already parsed group 0002
 163    bool Group0002Parsed;
 164
 165    ///\brief whether file has a DCM Preamble
 166    bool HasDCMPreamble;
 167
 168    /// File Pointer, opened during Header parsing.
 169    std::ifstream *Fp;
 170
 171    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
 172    FileType Filetype;
 173
 174    /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
 175    static const unsigned int HEADER_LENGTH_TO_READ;
 176
 177    /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
 178    /// are NOT loaded.
 179    static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
 180
 181    /// \brief Elements whose value is longer than  MAX_SIZE_PRINT_ELEMENT_VALUE
 182    /// are NOT printed.
 183    /// \todo Currently not used since collides with #define in
 184    ///       class DocEntry . See also
 185    ///       method ref Document::SetMaxSizePrintEntry()
 186    static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
 187
 188    /// Store the RLE frames info obtained during parsing of pixels.
 189    RLEFramesInfo *RLEInfo;
 190
 191    /// Store the JPEG fragments info obtained during parsing of pixels.
 192    JPEGFragmentsInfo *JPEGInfo;
 193
 194 private:
 195 // Methods
 196    // Read
 197    void ParseDES(DocEntrySet *set,long offset, long l_max, bool delim_mode);
 198    void ParseSQ (SeqEntry *seq,   long offset, long l_max, bool delim_mode);
 199
 200    void LoadDocEntry         (DocEntry *e);
 201    void FindDocEntryLength   (DocEntry *e) throw ( FormatError );
 202    uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
 203    std::string FindDocEntryVR();
 204    bool CheckDocEntryVR      (VRKey k);
 205
 206    std::string GetDocEntryValue  (DocEntry *entry);
 207    std::string GetDocEntryUnvalue(DocEntry *entry);
 208
 209
 210    void SkipDocEntry          (DocEntry *entry);
 211    void SkipToNextDocEntry    (DocEntry *entry);
 212
 213    void FixDocEntryFoundLength(DocEntry *entry,uint32_t l);
 214    bool IsDocEntryAnInteger   (DocEntry *entry);
 215
 216    uint16_t ReadInt16() throw ( FormatError );
 217    uint32_t ReadInt32() throw ( FormatError );
 218    void     SkipBytes(uint32_t);
 219    bool     ReadTag(uint16_t, uint16_t);
 220    uint32_t ReadTagLength(uint16_t, uint16_t);
 221
 222    void Initialise();
 223    bool CheckSwap();
 224    void SwitchByteSwapCode();
 225    void SetMaxSizeLoadEntry(long);
 226    void SetMaxSizePrintEntry(long);
 227
 228    // DocEntry related utilities
 229    DocEntry *ReadNextDocEntry();
 230
 231    uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
 232    void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
 233                                    DocEntrySet* set );
 234
 235    void HandleBrokenEndian(uint16_t &group, uint16_t &elem);
 236    void HandleOutOfGroup0002(uint16_t group);
 237
 238 // Variables
 239    /// Public dictionary used to parse this header
 240    Dict *RefPubDict;
 241
 242    /// \brief Optional "shadow dictionary" (private elements) used to parse
 243    /// this header
 244    Dict *RefShaDict;
 245
 246    /// \brief Size threshold above which an element value will NOT be loaded
 247    /// in memory (to avoid loading the image/volume itself). By default,
 248    /// this upper bound is fixed to 1024 bytes (which might look reasonable
 249    /// when one considers the definition of the various VR contents).
 250    uint32_t MaxSizeLoadEntry;
 251
 252    /// \brief Size threshold above which an element value will NOT be *printed*
 253    /// in order no to polute the screen output. By default, this upper bound
 254    /// is fixed to 64 bytes.
 255    uint32_t MaxSizePrintEntry;
 256
 257 private:
 258    friend class File;
 259 };
 260 } // end namespace gdcm
 261
 262 //-----------------------------------------------------------------------------
 263 #endif