]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.h
ENH: minor cleanup patch, use TagName instead of std:string for clarification. Don...
[gdcm.git] / src / gdcmDocument.h
index fdbe8ba89c79901e8639e2856fe95beaaaf81821..7d44ebb776538c50ef672dd96c9a58815138bbb1 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2004/09/03 04:16:29 $
-  Version:   $Revision: 1.33 $
+  Date:      $Date: 2004/10/24 03:33:41 $
+  Version:   $Revision: 1.55 $
  
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
-  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  
      This software is distributed WITHOUT ANY WARRANTY; without even
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 #include "gdcmException.h"
 #include "gdcmDictSet.h"
 #include "gdcmDocEntry.h"
-
-class gdcmValEntry;
-class gdcmBinEntry;
-class gdcmSeqEntry;
-
+#include "gdcmRLEFramesInfo.h"
+#include "gdcmJPEGFragmentsInfo.h"
 #include "gdcmDocEntrySet.h"
 #include "gdcmElementSet.h"
 
+class ValEntry;
+class BinEntry;
+class SeqEntry;
+
 #include <map>
 #include <list>
+#include <fstream>
+
+namespace gdcm 
+{
+
+enum TransferSyntaxType {
+  ImplicitVRLittleEndian = 0,
+  ExplicitVRLittleEndian,
+  DeflatedExplicitVRLittleEndian,
+  ExplicitVRBigEndian,
+  JPEGBaselineProcess1,
+  JPEGExtendedProcess2_4,
+  JPEGExtendedProcess3_5,
+  JPEGSpectralSelectionProcess6_8,
+  JPEGFullProgressionProcess10_12,
+  JPEGLosslessProcess14,
+  JPEGLosslessProcess14_1,
+  JPEG2000Lossless,
+  JPEG2000,
+  RLELossless,
+  UnknownTS
+};
 
 //-----------------------------------------------------------------------------
 /**
- * \brief Derived by both gdcmHeader and gdcmDicomDir
+ * \brief Derived by both Header and DicomDir
  */
-class GDCM_EXPORT gdcmDocument : public gdcmElementSet
+class GDCM_EXPORT Document : public ElementSet
 {
-friend class gdcmFile;
+friend class File;
 private:
    /// Public dictionary used to parse this header
-   gdcmDict *RefPubDict;
+   Dict* RefPubDict;
    
    /// \brief Optional "shadow dictionary" (private elements) used to parse
    /// this header
-   gdcmDict *RefShaDict;
-   
-   /// \brief Equals =1 if user wants to skip shadow groups while parsing
-   /// (to save space)
-   int IgnoreShadow;
+   Dict* RefShaDict;
 
    /// \brief Size threshold above which an element value will NOT be loaded
    /// in memory (to avoid loading the image/volume itself). By default,
@@ -76,7 +95,7 @@ protected:
    int SwapCode;
 
    /// File Pointer, opened during Header parsing.
-   FILE *Fp;
+   std::ifstream* Fp;
 
    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
    FileType Filetype;  
@@ -91,12 +110,15 @@ protected:
    /// \brief Elements whose value is longer than  MAX_SIZE_PRINT_ELEMENT_VALUE
    /// are NOT printed.
    /// \todo Currently not used since collides with #define in
-   ///       \ref gdcmDocEntry.cxx. See also
-   ///       \ref gdcmDocument::SetMaxSizePrintEntry()
+   ///       class DocEntry . See also
+   ///       method ref Document::SetMaxSizePrintEntry()
    static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
 
-   /// Will be set 1 if user asks to 'go inside' the 'sequences' (VR = "SQ")
-   int EnableSequences;
+   /// Store the RLE frames info obtained during parsing of pixels.
+   RLEFramesInfo* RLEInfo;
+
+   /// Store the JPEG fragments info obtained during parsing of pixels.
+   JPEGFragmentsInfo* JPEGInfo;
 
    /// \brief Amount of printed details for each Header Entry (Dicom Element):
    /// 0 : stands for the least detail level.
@@ -108,64 +130,62 @@ public:
    virtual void PrintShaDict (std::ostream &os = std::cout);
 
 // Dictionnaries
-   gdcmDict *GetPubDict();
-   gdcmDict *GetShaDict();
-   bool SetShaDict(gdcmDict *dict);
+   Dict* GetPubDict();
+   Dict* GetShaDict();
+   bool SetShaDict(Dict* dict);
    bool SetShaDict(DictKey const & dictName);
 
 // Informations contained in the parser
    virtual bool IsReadable();
-   bool IsGivenTransferSyntax(std::string const & syntaxToCheck);
-   bool IsImplicitVRLittleEndianTransferSyntax();
-   bool IsExplicitVRLittleEndianTransferSyntax();
-   bool IsDeflatedExplicitVRLittleEndianTransferSyntax();
-   bool IsExplicitVRBigEndianTransferSyntax();
-   bool IsJPEGBaseLineProcess1TransferSyntax();
-   bool IsJPEGExtendedProcess2_4TransferSyntax();
-   bool IsJPEGExtendedProcess3_5TransferSyntax();
-   bool IsJPEGSpectralSelectionProcess6_8TransferSyntax();
-   bool IsRLELossLessTransferSyntax();
+   TransferSyntaxType GetTransferSyntax();
    bool IsJPEGLossless();
    bool IsJPEG2000();
+   bool IsJPEG();
+   bool IsEncapsulate();
    bool IsDicomV3();
 
    FileType GetFileType();
 
-   FILE* OpenFile();
+   std::ifstream * OpenFile();
    bool CloseFile();
 
-   void Write(FILE* fp, FileType type);
+   void Write( std::ofstream* fp, FileType type );
+
+   ValEntry* ReplaceOrCreateByNumber(std::string const & value,
+                                     uint16_t group, uint16_t elem,
+                                     std::string const & vr = "unkn");
+   
+   BinEntry* ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
+                                     uint16_t group, uint16_t elem,
+                                     std::string const & vr = "unkn");
 
-   gdcmValEntry* ReplaceOrCreateByNumber(std::string const & value,
-                                         uint16_t group, uint16_t elem);
+   SeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
 
-   gdcmBinEntry* ReplaceOrCreateByNumber(void *voidArea, int lgth,
-                                         uint16_t group, uint16_t elem);
-   gdcmSeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
    bool ReplaceIfExistByNumber ( std::string const & value,
-                                 uint16_t group,
-                                 uint16_t elem );
+                                 uint16_t group, uint16_t elem );
    
-   virtual void* LoadEntryVoidArea(uint16_t group, uint16_t elem);
-   virtual void* LoadEntryVoidArea(gdcmBinEntry* entry);
+   virtual void* LoadEntryBinArea(uint16_t group, uint16_t elem);
+   virtual void* LoadEntryBinArea(BinEntry* entry);
       
    // System access (meaning endian related !?)
-   uint16_t SwapShort(uint16_t);   // needed by gdcmFile
-   uint32_t SwapLong(uint32_t);    // needed by gdcmFile
-   uint16_t UnswapShort(uint16_t); // needed by gdcmFile
-   uint32_t UnswapLong(uint32_t);  // needed by gdcmFile
+   uint16_t SwapShort(uint16_t);   // needed by File
+   uint32_t SwapLong(uint32_t);    // needed by File
+   uint16_t UnswapShort(uint16_t); // needed by File
+   uint32_t UnswapLong(uint32_t);  // needed by File
 
 protected:
    // Constructor and destructor are protected to forbid end user 
-   // to instanciate from this class gdcmDocument (only gdcmHeader and
-   // gdcmDicomDir are meaningfull).
-   gdcmDocument();
-   gdcmDocument( std::string const & filename );
-   virtual ~gdcmDocument();
+   // to instanciate from this class Document (only Header and
+   // DicomDir are meaningfull).
+   Document();
+   Document( std::string const & filename );
+   virtual ~Document();
    
-   void Parse7FE0 ();   
+   void ReadAndSkipEncapsulatedBasicOffsetTable();
+   void ComputeRLEInfo();
+   void ComputeJPEGFragmentInfo();
    // Entry
-   int CheckIfEntryExistByNumber(uint16_t group, uint16_t elem ); // int !
+   bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem );
 public:
    virtual std::string GetEntryByName    (TagName const & tagName);
    virtual std::string GetEntryVRByName  (TagName const & tagName);
@@ -177,50 +197,53 @@ public:
                                  std::string const & tagName);
    virtual bool SetEntryByNumber(std::string const & content,
                                  uint16_t group, uint16_t element);
-   virtual bool SetEntryByNumber(void *content, int lgth,
+   virtual bool SetEntryByNumber(uint8_t* content, int lgth,
                                  uint16_t group, uint16_t element);
    virtual bool SetEntryLengthByNumber(uint32_t length,
                                        uint16_t group, uint16_t element);
 
-   virtual size_t GetEntryOffsetByNumber(uint16_t group, uint16_t elem);
-   virtual void* GetEntryVoidAreaByNumber(uint16_t group, uint16_t elem);   
-   virtual bool  SetEntryVoidAreaByNumber(void* a, uint16_t group,
+   virtual size_t GetEntryOffsetByNumber (uint16_t group, uint16_t elem);
+   virtual void* GetEntryBinAreaByNumber(uint16_t group, uint16_t elem);   
+   virtual bool  SetEntryBinAreaByNumber(uint8_t* a, uint16_t group,
                                                    uint16_t elem);
 
    virtual void UpdateShaEntries();
 
    // Header entry
-   gdcmDocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element); 
-   gdcmDocEntry* GetDocEntryByName  (std::string const & tagName);
+   DocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element); 
+   DocEntry* GetDocEntryByName  (std::string const & tagName);
 
-   gdcmValEntry* GetValEntryByNumber(uint16_t group, uint16_t element); 
-   gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); 
+   ValEntry* GetValEntryByNumber(uint16_t group, uint16_t element); 
+   //BinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); 
+   RLEFramesInfo* GetRLEInfo() { return RLEInfo; }
+   JPEGFragmentsInfo* GetJPEGInfo() { return JPEGInfo; }
 
-   void LoadDocEntrySafe(gdcmDocEntry* entry);
+   void LoadDocEntrySafe(DocEntry* entry);
+   TagDocEntryHT* BuildFlatHashTable();
 
 private:
    // Read
-   long ParseDES(gdcmDocEntrySet *set,long offset, long l_max, bool delim_mode);
-   long ParseSQ (gdcmSeqEntry *seq,   long offset, long l_max, bool delim_mode); 
-   
-   void LoadDocEntry      (gdcmDocEntry *);
-   void FindDocEntryLength(gdcmDocEntry *) throw ( gdcmFormatError );
-   void FindDocEntryVR    (gdcmDocEntry *);
-   bool CheckDocEntryVR   (gdcmDocEntry *, gdcmVRKey);
+   void ParseDES(DocEntrySet *set,long offset, long l_max, bool delim_mode);
+   void ParseSQ (SeqEntry *seq,   long offset, long l_max, bool delim_mode);
+
+   void LoadDocEntry      (DocEntry *);
+   void FindDocEntryLength(DocEntry *) throw ( FormatError );
+   void FindDocEntryVR    (DocEntry *);
+   bool CheckDocEntryVR   (DocEntry *, VRKey);
 
-   std::string GetDocEntryValue  (gdcmDocEntry *);
-   std::string GetDocEntryUnvalue(gdcmDocEntry *);
+   std::string GetDocEntryValue  (DocEntry *);
+   std::string GetDocEntryUnvalue(DocEntry *);
 
-   void SkipDocEntry          (gdcmDocEntry *);
-   void SkipToNextDocEntry    (gdcmDocEntry *);
+   void SkipDocEntry          (DocEntry *);
+   void SkipToNextDocEntry    (DocEntry *);
 
-   void FixDocEntryFoundLength(gdcmDocEntry *, uint32_t);
-   bool IsDocEntryAnInteger   (gdcmDocEntry *);
+   void FixDocEntryFoundLength(DocEntry *, uint32_t);
+   bool IsDocEntryAnInteger   (DocEntry *);
 
-   uint32_t FindDocEntryLengthOB() throw( gdcmFormatUnexpected );
+   uint32_t FindDocEntryLengthOB() throw( FormatUnexpected );
 
-   uint16_t ReadInt16() throw ( gdcmFormatError );
-   uint32_t ReadInt32() throw ( gdcmFormatError );
+   uint16_t ReadInt16() throw ( FormatError );
+   uint32_t ReadInt32() throw ( FormatError );
    void     SkipBytes(uint32_t);
    bool     ReadTag(uint16_t, uint16_t);
    uint32_t ReadTagLength(uint16_t, uint16_t);
@@ -232,9 +255,12 @@ private:
    void SetMaxSizePrintEntry(long);
 
    // DocEntry related utilities
-   gdcmDocEntry* ReadNextDocEntry();
+   DocEntry* ReadNextDocEntry();
 
    uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
+   void BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
+                                   DocEntrySet* set );
+
 
 public:
 // Accessors:
@@ -251,11 +277,12 @@ public:
    int GetSwapCode() { return SwapCode; }
    
    /// File pointer
-   FILE * GetFP() { return Fp; }
+   std::ifstream * GetFP() { return Fp; }
 
-   bool operator<(gdcmDocument &document);
+   bool operator<(Document &document);
 
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif