X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=31a030cee597607cd01b573da91645edfece10f5;hb=add6c88b334e9cf4ddb0ae1849f1380f9844f99c;hp=d032a38859e42591cb6dad1aec99268f7939b050;hpb=7c8b232fb62e92da08750b81d3126651f60b8f3f;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index d032a388..31a030ce 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/07/17 04:28:55 $ - Version: $Revision: 1.117 $ + Date: $Date: 2007/10/08 15:20:17 $ + Version: $Revision: 1.148 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -16,26 +16,22 @@ =========================================================================*/ -#ifndef GDCMDOCUMENT_H -#define GDCMDOCUMENT_H +#ifndef _GDCMDOCUMENT_H_ +#define _GDCMDOCUMENT_H_ #include "gdcmVR.h" #include "gdcmDict.h" #include "gdcmElementSet.h" #include "gdcmException.h" +#include "gdcmDebug.h" // for LEGACY +#include "gdcmCommandManager.h" #include #include #include -#define NO_SEQ 0x00000001 // Don't load odd groups -#define NO_SHADOW 0x00000002 // Don't load Sequences -#define NO_SHADOWSEQ 0x00000004 // Don't load Sequences if they belong to odd group - // (*exclusive* from NO_SEQ and NO_SHADOW) -namespace gdcm +namespace GDCM_NAME_SPACE { -class ValEntry; -class BinEntry; class SeqEntry; class Dict; @@ -45,13 +41,16 @@ class Dict; */ class GDCM_EXPORT Document : public ElementSet { -public: + gdcmTypeMacro(Document); -typedef std::list ListElements; +public: + typedef std::list ListElements; // Loading //Deprecated : use SetFileName() + Load() - virtual bool Load( std::string const &filename ); +//#ifndef GDCM_LEGACY_REMOVE +// virtual bool Load( std::string const &filename ); +//#endif virtual bool Load( ); // Dictionaries @@ -61,6 +60,7 @@ typedef std::list ListElements; bool SetShaDict(DictKey const &dictName); // Informations contained in the gdcm::Document + bool IsParsable(); virtual bool IsReadable(); bool IsDicomV3(); bool IsPapyrus(); @@ -70,42 +70,34 @@ typedef std::list ListElements; std::string GetTransferSyntaxName(); // Swap code - /// 'Swap code' accessor (see \ref SwapCode ) + /// 'Swap code' accessor (see 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);} // File I/O - /// Accessor to \ref Filename + /// Accessor to Filename const std::string &GetFileName() const { return Filename; } - /// Accessor to \ref Filename + /// Accessor to 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 ); + void WriteContent( std::ofstream *fp, FileType type, bool insideMetaElements, bool insideSequence ); -// Content entries +// Data 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 SetMaxSizeLoadEntry(long); + void AddForceLoadElement(uint16_t group, uint16_t elem); // Ordering of Documents bool operator<(Document &document); /** * \brief Sets the LoadMode as a boolean string. - * NO_SEQ, NO_SHADOW, NO_SHADOWSEQ + * 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) @@ -113,7 +105,7 @@ typedef std::list ListElements; * @param mode Load mode to be used */ void SetLoadMode (int mode) { if (LoadMode != mode) - LoadMode = mode, IsDocumentModified = true; } + LoadMode=mode, IsDocumentModified = true; } protected: // Methods @@ -121,13 +113,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. @@ -165,8 +162,11 @@ protected: /// are NOT loaded. static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE; - /// List of elements to Anonymize - ListElements AnonymizeList; + /// 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 @@ -186,18 +186,28 @@ private: // Methods void Initialize(); bool DoTheLoadingDocumentJob(); + + // System access (meaning endian related !?) + void ReadBegBuffer(size_t l) throw ( FormatError ); + 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); + bool 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); @@ -207,15 +217,23 @@ private: bool CheckSwap(); void SwitchByteSwapCode(); - void SetMaxSizeLoadEntry(long); // DocEntry related utilities DocEntry *ReadNextDocEntry(); - + uint16_t GetInt16(); + uint32_t GetInt32(); + 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 @@ -227,11 +245,27 @@ 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 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 ); +private: + /// \brief buffer to avoid some freads + char BegBuffer[8]; + char *PtrBegBuffer; + /// \brief to avoid time consuming ftellg + size_t CurrentOffsetPosition; + /// \brief to indicate if last supposed to be UN DataElement is not + /// (according to a private Dicom dictionary) + bool changeFromUN; + /// \brief whether an unexpected EOF was encountered + bool UnexpectedEOF; }; } // end namespace gdcm