]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.h
ENH: Move the old setup.py to its new home
[gdcm.git] / src / gdcmDocument.h
index 12563947d9007b08f2a55556dd7f8b022a53b002..86e86b26ee7ef01d9be70933075d405e1bcfba6a 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.h,v $
   Language:  C++
-  Date:      $Date: 2004/07/30 16:09:27 $
-  Version:   $Revision: 1.25 $
+  Date:      $Date: 2004/10/09 03:36:57 $
+  Version:   $Revision: 1.48 $
  
   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"
+#include "gdcmRLEFramesInfo.h"
+#include "gdcmDocEntrySet.h"
+#include "gdcmElementSet.h"
 
 class gdcmValEntry;
 class gdcmBinEntry;
 class gdcmSeqEntry;
 
-#include "gdcmDocEntrySet.h"
-#include "gdcmElementSet.h"
-
 #include <map>
 #include <list>
 
@@ -50,10 +50,6 @@ private:
    /// \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;
 
    /// \brief Size threshold above which an element value will NOT be loaded
    /// in memory (to avoid loading the image/volume itself). By default,
@@ -95,8 +91,8 @@ protected:
    ///       \ref gdcmDocument::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.
+   gdcmRLEFramesInfo RLEInfo;
 
    /// \brief Amount of printed details for each Header Entry (Dicom Element):
    /// 0 : stands for the least detail level.
@@ -111,11 +107,11 @@ public:
    gdcmDict *GetPubDict();
    gdcmDict *GetShaDict();
    bool SetShaDict(gdcmDict *dict);
-   bool SetShaDict(DictKey dictName);
+   bool SetShaDict(DictKey const & dictName);
 
 // Informations contained in the parser
    virtual bool IsReadable();
-   bool IsGivenTransferSyntax(std::string const & SyntaxToCheck);
+   bool IsGivenTransferSyntax(std::string const & syntaxToCheck);
    bool IsImplicitVRLittleEndianTransferSyntax();
    bool IsExplicitVRLittleEndianTransferSyntax();
    bool IsDeflatedExplicitVRLittleEndianTransferSyntax();
@@ -127,26 +123,34 @@ public:
    bool IsRLELossLessTransferSyntax();
    bool IsJPEGLossless();
    bool IsJPEG2000();
+   bool IsEncapsulateTransferSyntax();
    bool IsDicomV3();
 
    FileType GetFileType();
 
-   FILE* OpenFile(bool exception_on_error = false) throw(gdcmFileError);
+   FILE* OpenFile();
    bool CloseFile();
 
    void Write(FILE* fp, FileType type);
 
-   gdcmValEntry* ReplaceOrCreateByNumber(std::string value,
-                                         uint16_t group, uint16_t elem);
+   gdcmValEntry* ReplaceOrCreateByNumber(std::string const & value,
+                                         uint16_t group, uint16_t elem,
+                                         std::string const & VR ="unkn");
+   
+   gdcmBinEntry* ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
+                                         uint16_t group, uint16_t elem,
+                                         std::string const & VR="unkn");
+
+   gdcmSeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
 
-   gdcmBinEntry* ReplaceOrCreateByNumber(void *voidArea, int lgth,
-                                         uint16_t group, uint16_t elem);
-   bool ReplaceIfExistByNumber (const char* value, uint16_t group, uint16_t elem);
+   bool ReplaceIfExistByNumber ( std::string const & value,
+                                 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(gdcmBinEntry* entry);
       
-   // System access
+   // 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
@@ -156,32 +160,32 @@ protected:
    // Constructor and destructor are protected to forbid end user 
    // to instanciate from this class gdcmDocument (only gdcmHeader and
    // gdcmDicomDir are meaningfull).
-   gdcmDocument(bool exception_on_error  = false);
-   gdcmDocument(std::string const & filename, 
-                bool  exception_on_error = false);
+   gdcmDocument();
+   gdcmDocument( std::string const & filename );
    virtual ~gdcmDocument();
    
-   void gdcmDocument::Parse7FE0 ();   
+   void ComputeRLEInfo();
    // Entry
-   int CheckIfEntryExistByNumber(uint16_t group, uint16_t elem ); // int !
+   bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem );
 public:
-   virtual std::string GetEntryByName    (TagName tagName);
-   virtual std::string GetEntryVRByName  (TagName tagName);
+   virtual std::string GetEntryByName    (TagName const & tagName);
+   virtual std::string GetEntryVRByName  (TagName const & tagName);
    virtual std::string GetEntryByNumber  (uint16_t group, uint16_t elem);
    virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t elem);
    virtual int     GetEntryLengthByNumber(uint16_t group, uint16_t elem);
-protected:
-   virtual bool SetEntryByName  (std::string content, std::string tagName);
-   virtual bool SetEntryByNumber(std::string content,
+//protected:
+   virtual bool SetEntryByName  (std::string const & content, 
+                                 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();
@@ -191,17 +195,18 @@ protected:
    gdcmDocEntry* GetDocEntryByName  (std::string const & tagName);
 
    gdcmValEntry* GetValEntryByNumber(uint16_t group, uint16_t element); 
-   gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); 
+   //gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); 
 
    void LoadDocEntrySafe(gdcmDocEntry* 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 ParseDES(gdcmDocEntrySet *set,long offset, long l_max, bool delim_mode);
+   void ParseSQ (gdcmSeqEntry *seq,   long offset, long l_max, bool delim_mode);
+
    void LoadDocEntry      (gdcmDocEntry *);
-   void FindDocEntryLength(gdcmDocEntry *);
+   void FindDocEntryLength(gdcmDocEntry *) throw ( gdcmFormatError );
    void FindDocEntryVR    (gdcmDocEntry *);
    bool CheckDocEntryVR   (gdcmDocEntry *, gdcmVRKey);
 
@@ -214,10 +219,10 @@ private:
    void FixDocEntryFoundLength(gdcmDocEntry *, uint32_t);
    bool IsDocEntryAnInteger   (gdcmDocEntry *);
 
-   uint32_t FindDocEntryLengthOB();
+   uint32_t FindDocEntryLengthOB() throw( gdcmFormatUnexpected );
 
-   uint16_t ReadInt16();
-   uint32_t ReadInt32();
+   uint16_t ReadInt16() throw ( gdcmFormatError );
+   uint32_t ReadInt32() throw ( gdcmFormatError );
    void     SkipBytes(uint32_t);
    bool     ReadTag(uint16_t, uint16_t);
    uint32_t ReadTagLength(uint16_t, uint16_t);
@@ -232,10 +237,13 @@ private:
    gdcmDocEntry* ReadNextDocEntry();
 
    uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
+   void BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
+                                   gdcmDocEntrySet* set );
+
 
 public:
 // Accessors:
-   /// Accessor to \ref printLevel
+   /// Accessor to \ref PrintLevel
    void SetPrintLevel(int level) { PrintLevel = level; }
 
    /// Accessor to \ref Filename
@@ -244,7 +252,7 @@ public:
    /// Accessor to \ref Filename
    void SetFileName(std::string const & fileName) { Filename = fileName; }
 
-   /// 'Swap code' accessor (see \ref sw )
+   /// 'Swap code' accessor (see \ref SwapCode )
    int GetSwapCode() { return SwapCode; }
    
    /// File pointer