X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=3f5e3df0b9aa56061af5777187169b3baffdc1b0;hb=96775cd7d34ec152fbf1430634bb338f524ee212;hp=c51a7d5dab32f4d24dc6373571b2bfe79de7af3f;hpb=1ce6ae86daabc8b64c9309acce4ecf137ee79f07;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index c51a7d5d..3f5e3df0 100644 --- a/src/gdcmDocument.h +++ b/src/gdcmDocument.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocument.h,v $ Language: C++ - Date: $Date: 2005/01/31 12:19:34 $ - Version: $Revision: 1.103 $ + Date: $Date: 2006/02/07 12:37:19 $ + Version: $Revision: 1.138 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -23,6 +23,8 @@ #include "gdcmDict.h" #include "gdcmElementSet.h" #include "gdcmException.h" +#include "gdcmDebug.h" // for LEGACY +#include "gdcmCommandManager.h" #include #include @@ -30,8 +32,6 @@ namespace gdcm { -class ValEntry; -class BinEntry; class SeqEntry; class Dict; @@ -41,18 +41,25 @@ class Dict; */ class GDCM_EXPORT Document : public ElementSet { + gdcmTypeMacro(Document); + public: + typedef std::list ListElements; -// Dictionaries - virtual void PrintPubDict (std::ostream &os = std::cout); - virtual void PrintShaDict (std::ostream &os = std::cout); +// Loading + //Deprecated : use SetFileName() + Load() + //GDCM_LEGACY( virtual bool Load( std::string const &filename ) ); + //virtual bool Load( std::string const &filename ); + virtual bool Load( ); - Dict* GetPubDict(); - Dict* GetShaDict(); - bool SetShaDict(Dict* dict); +// Dictionaries + Dict *GetPubDict(); + Dict *GetShaDict(); + bool SetShaDict(Dict *dict); bool SetShaDict(DictKey const &dictName); // Informations contained in the gdcm::Document + bool IsParsable(); virtual bool IsReadable(); bool IsDicomV3(); bool IsPapyrus(); @@ -64,35 +71,40 @@ public: // Swap code /// 'Swap code' accessor (see \ref SwapCode ) int GetSwapCode() { return SwapCode; } - // System access (meaning endian related !?) - uint16_t SwapShort(uint16_t); - uint32_t SwapLong(uint32_t); - /// \brief Unswaps back the bytes of 2-bytes long integer - /// so they agree with the processor order. - uint16_t UnswapShort(uint16_t a) { return SwapShort(a);} - /// \brief Unswaps back the bytes of 4-byte long integer - /// so they agree with the processor order. - uint32_t UnswapLong(uint32_t a) { return SwapLong(a);} -// Ordering of Documents - bool operator<(Document &document); - // File I/O /// Accessor to \ref Filename const std::string &GetFileName() const { return Filename; } /// Accessor to \ref Filename - void SetFileName(std::string const &fileName) { Filename = fileName; } + virtual void SetFileName(std::string const &fileName) + { if (Filename != fileName) + Filename = fileName, IsDocumentModified = true; } std::ifstream *OpenFile(); bool CloseFile(); void WriteContent( std::ofstream *fp, FileType type ); // Content entries - virtual void LoadEntryBinArea(uint16_t group, uint16_t elem); - virtual void LoadEntryBinArea(BinEntry *entry); + virtual void LoadEntryBinArea(DataEntry *entry); void LoadDocEntrySafe(DocEntry *entry); + void AddForceLoadElement(uint16_t group, uint16_t elem); + +// Ordering of Documents + bool operator<(Document &document); + +/** + * \brief Sets the LoadMode as a boolean string. + * LD_NOSEQ, LD_NOSHADOW, LD_NOSHADOWSEQ + ... (nothing more, right now) + * WARNING : before using NO_SHADOW, be sure *all* your files + * contain accurate values in the 0x0000 element (if any) + * of *each* Shadow Group. The parser will fail if the size is wrong ! + * @param mode Load mode to be used + */ + void SetLoadMode (int mode) { if (LoadMode != mode) + LoadMode=mode, IsDocumentModified = true; } protected: // Methods @@ -100,13 +112,18 @@ protected: // to instanciate from this class Document (only gdcm::File and // gdcm::DicomDir are meaningfull). Document(); - Document( std::string const &filename ); virtual ~Document(); - + + virtual void CallStartMethod(); + virtual void CallProgressMethod(); + virtual void CallEndMethod(); + uint16_t ReadInt16() throw ( FormatError ); uint32_t ReadInt32() throw ( FormatError ); - void SkipBytes(uint32_t); - int ComputeGroup0002Length( FileType filetype ); + + /// \brief skips bytes inside the source file + void SkipBytes(uint32_t nBytes) { Fp->seekg((long)nBytes, std::ios::cur);} + int ComputeGroup0002Length( ); // Variables /// Refering underlying filename. @@ -143,44 +160,76 @@ protected: /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE /// are NOT loaded. static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE; - /// \brief Elements whose value is longer than MAX_SIZE_PRINT_ELEMENT_VALUE - /// are NOT printed. - static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE; + + /// User supplied list of elements to Anonymize + ListElements UserAnonymizeList; + + /// User supplied list of elements to force Load + ListElements UserForceLoadList; + + /// \brief Bit string integer (each one considered as a boolean) + /// Bit 0 : Skip Sequences, if possible + /// Bit 1 : Skip Shadow Groups if possible + /// Probabely, some more to add + int LoadMode; + + /// \brief Whether the gdcm::Document is already parsed/loaded : + /// False from the creation of the gdcm::Document untill + /// gdcm::Document:Load() + bool IsDocumentAlreadyLoaded; // FIXME : probabely useless now + + /// Whether the gdcm::Document was modified since the last Load() + bool IsDocumentModified; private: // Methods + void Initialize(); + bool DoTheLoadingDocumentJob(); + + // System access (meaning endian related !?) + uint16_t SwapShort(uint16_t); + uint32_t SwapLong(uint32_t); + double SwapDouble(double); + /// \brief Unswaps back the bytes of 2-bytes long integer + /// so they agree with the processor order. + uint16_t UnswapShort(uint16_t a) { return SwapShort(a);} + /// \brief Unswaps back the bytes of 4-byte long integer + /// so they agree with the processor order. + uint32_t UnswapLong(uint32_t a) { return SwapLong(a);} + // Read - 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 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 *e); + void LoadDocEntry (DocEntry *e, bool forceLoad = false); void FindDocEntryLength (DocEntry *e) throw ( FormatError ); uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected ); - std::string FindDocEntryVR(); - bool CheckDocEntryVR (VRKey k); - - std::string GetDocEntryValue (DocEntry *entry); - std::string GetDocEntryUnvalue(DocEntry *entry); + VRKey FindDocEntryVR(); + bool CheckDocEntryVR (const VRKey &k); void SkipDocEntry (DocEntry *entry); void SkipToNextDocEntry (DocEntry *entry); - void FixDocEntryFoundLength(DocEntry *entry,uint32_t l); + void FixDocEntryFoundLength(DocEntry *entry, uint32_t l); bool IsDocEntryAnInteger (DocEntry *entry); - void Initialize(); bool CheckSwap(); void SwitchByteSwapCode(); void SetMaxSizeLoadEntry(long); - void SetMaxSizePrintEntry(long); // DocEntry related utilities DocEntry *ReadNextDocEntry(); void HandleBrokenEndian (uint16_t &group, uint16_t &elem); void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem); + DocEntry *Backtrack(DocEntry *docEntry); // Variables +protected: + /// value of the ??? for any progress bar + float Progress; + mutable bool Abort; + /// Public dictionary used to parse this header Dict *RefPubDict; /// \brief Optional "shadow dictionary" (private elements) used to parse @@ -192,15 +241,16 @@ private: /// this upper bound is fixed to 1024 bytes (which might look reasonable /// when one considers the definition of the various VR contents). uint32_t MaxSizeLoadEntry; - - /// \brief Size threshold above which an element value will NOT be *printed* - /// in order no to polute the screen output. By default, this upper bound - /// is fixed to 64 bytes. - uint32_t MaxSizePrintEntry; + /// \brief to allow any inner method to know current tag Group number + uint16_t CurrentGroup; + /// \brief to allow any inner method to know current tag Element number + uint16_t CurrentElem; + // uint32_t GenerateFreeTagKeyInGroup(uint16_t group); // void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT, -// DocEntrySet *set ); +// DocEntrySet *set ); + }; } // end namespace gdcm