X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=ab2782a532b178ec3a3bdb4354b352fed0ecccb8;hb=6278320cc85da00d2d56ffbf07806e84966892c3;hp=6ebc79c9fb5041e30ebca1054c4655f49b5cfd73;hpb=c094e185dd6404df031524ccae8e1b51e3b84871;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index 6ebc79c9..ab2782a5 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/21 11:40:55 $ - Version: $Revision: 1.96 $ + Date: $Date: 2008/09/15 15:49:22 $ + Version: $Revision: 1.154 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -16,132 +16,115 @@ =========================================================================*/ -#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 -namespace gdcm +namespace GDCM_NAME_SPACE { -class ValEntry; -class BinEntry; class SeqEntry; class Dict; -class RLEFramesInfo; -class JPEGFragmentsInfo; //----------------------------------------------------------------------------- /** - * \brief Derived by both gdcm::File and gdcm::DicomDir + * \brief Derived by both GDCM_NAME_SPACE::File and GDCM_NAME_SPACE::DicomDir */ class GDCM_EXPORT Document : public ElementSet { + gdcmTypeMacro(Document); + public: -// Informations contained in the gdcm::Document - virtual bool IsReadable(); - FileType GetFileType(); + typedef std::list ListElements; - std::string GetTransferSyntax(); - - RLEFramesInfo *GetRLEInfo() { return RLEInfo; } - JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; } +// Loading + //Deprecated : use SetFileName() + Load() +//#ifndef GDCM_LEGACY_REMOVE +// virtual bool Load( std::string const &filename ); +//#endif + virtual bool Load( ); // Dictionaries - virtual void PrintPubDict (std::ostream &os = std::cout); - virtual void PrintShaDict (std::ostream &os = std::cout); - - Dict* GetPubDict(); - Dict* GetShaDict(); - bool SetShaDict(Dict* dict); + Dict *GetPubDict(); + Dict *GetShaDict(); + bool SetShaDict(Dict *dict); bool SetShaDict(DictKey const &dictName); +// Informations contained in the GDCM_NAME_SPACE::Document + bool IsParsable(); + virtual bool IsReadable(); + bool IsDicomV3(); + bool IsPapyrus(); + FileType GetFileType(); + std::string GetTransferSyntax(); + /// Return the Transfer Syntax as a string + 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); // needed by Document - uint32_t SwapLong(uint32_t); // needed by Document - uint16_t UnswapShort(uint16_t); // needed by Document - uint32_t UnswapLong(uint32_t); // needed by Document -// Ordering of Documents - bool operator<(Document &document); - -public: // File I/O - /// Accessor to \ref Filename + /// Accessor to Filename const std::string &GetFileName() const { return Filename; } - /// Accessor to \ref Filename - void SetFileName(std::string const &fileName) { Filename = 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 ); - -// Content entries - -// Oops ! Python is gonna cry : -// 4 methods with same name and different parameters ... -// Only C++ is aware! - - virtual bool SetEntry(std::string const &content, - uint16_t group, uint16_t elem); - virtual bool SetEntry(uint8_t *content, int lgth, - uint16_t group, uint16_t elem); - virtual bool SetEntry(std::string const &content, ValEntry *entry); - virtual bool SetEntry(uint8_t *content, int lgth, BinEntry *entry); - - virtual void *GetEntryBinArea(uint16_t group, uint16_t elem); + void WriteContent( std::ofstream *fp, FileType type, bool insideMetaElements, bool insideSequence ); - virtual std::string GetEntry (uint16_t group, uint16_t elem); - virtual std::string GetEntryVR(uint16_t group, uint16_t elem); - virtual int GetEntryLength(uint16_t group, uint16_t elem); - - ValEntry *ReplaceOrCreate(std::string const &value, - uint16_t group, uint16_t elem, - TagName const &vr = GDCM_UNKNOWN); - BinEntry *ReplaceOrCreate(uint8_t* binArea, int lgth, - uint16_t group, uint16_t elem, - TagName const &vr = GDCM_UNKNOWN); - SeqEntry *ReplaceOrCreate(uint16_t group, uint16_t elem); - - bool ReplaceIfExist(std::string const &value, - uint16_t group, uint16_t elem ); - - bool CheckIfEntryExist(uint16_t group, uint16_t elem ); - +// 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); - /*TagDocEntryHT *BuildFlatHashTable();*/ + void SetMaxSizeLoadEntry(long); + void AddForceLoadElement(uint16_t group, uint16_t elem); - /// Return the Transfer Syntax as a string - std::string GetTransferSyntaxName(); +// Ordering of Documents + bool operator<(Document &document); - bool IsDicomV3(); +/** + * \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 - // Constructor and destructor are protected to forbid end user - // to instanciate from this class Document (only gdcm::File and - // gdcm::DicomDir are meaningfull). + // Constructor and destructor are protected to forbid end user + // to instanciate from this class Document (only GDCM_NAME_SPACE::File and + // GDCM_NAME_SPACE::DicomDir are meaningfull). Document(); - Document( std::string const &filename ); virtual ~Document(); - - void ReadAndSkipEncapsulatedBasicOffsetTable(); - void ComputeRLEInfo(); - void ComputeJPEGFragmentInfo(); - // Entry - int ComputeGroup0002Length( FileType filetype ); + virtual void CallStartMethod(); + virtual void CallProgressMethod(); + virtual void CallEndMethod(); + + uint16_t ReadInt16() throw ( FormatError ); + uint32_t ReadInt32() throw ( FormatError ); + + /// \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. @@ -175,69 +158,83 @@ protected: /// After opening the file, we read HEADER_LENGTH_TO_READ bytes. static const unsigned int HEADER_LENGTH_TO_READ; - /// \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; - /// Store the RLE frames info obtained during parsing of pixels. - RLEFramesInfo *RLEInfo; + /// User supplied list of elements to force Load + ListElements UserForceLoadList; - /// Store the JPEG fragments info obtained during parsing of pixels. - JPEGFragmentsInfo *JPEGInfo; + /// \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_NAME_SPACE::Document is already parsed/loaded : + /// False from the creation of the GDCM_NAME_SPACE::Document untill + /// GDCM_NAME_SPACE::Document:Load() + bool IsDocumentAlreadyLoaded; // FIXME : probabely useless now + + /// Whether the GDCM_NAME_SPACE::Document was modified since the last Load() + bool IsDocumentModified; 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); + void ParseDES(DocEntrySet *set, 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); - void FixDocEntryFoundLength(DocEntry *entry,uint32_t l); + void FixDocEntryFoundLength(DocEntry *entry, uint32_t l); bool IsDocEntryAnInteger (DocEntry *entry); - 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); - - void Initialize(); bool CheckSwap(); void SwitchByteSwapCode(); - void SetMaxSizeLoadEntry(long); - void SetMaxSizePrintEntry(long); // DocEntry related utilities DocEntry *ReadNextDocEntry(); + uint16_t GetInt16(); + uint32_t GetInt32(); - uint32_t GenerateFreeTagKeyInGroup(uint16_t group); -/* void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT, - DocEntrySet* set );*/ - - void HandleBrokenEndian(uint16_t &group, uint16_t &elem); + void HandleBrokenEndian (uint16_t &group, uint16_t &elem); void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem); + DocEntry *Backtrack(DocEntry *docEntry, DocEntrySet *set); // 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 /// this header Dict *RefShaDict; @@ -247,15 +244,31 @@ 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 ); private: - friend class FileHelper; + /// \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; + /// \brief to avoid infinite loop when illegal UN stands for OB + size_t OffsetOfPreviousParseDES; }; + } // end namespace gdcm //-----------------------------------------------------------------------------