X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=852bdcb5eefad77a1146dcf3807131eb3365054b;hb=fbd2698cb0545343abc2d8aefe92bab1f5b3eaa3;hp=e81582467fbcde9b13961db83c98fe6d1663e24f;hpb=0ad9dae4659b21bfd5c834c1af724eab4dcdf4f6;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index e8158246..852bdcb5 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/23 10:12:33 $ - Version: $Revision: 1.97 $ + Date: $Date: 2005/07/07 16:37:41 $ + Version: $Revision: 1.114 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -22,19 +22,22 @@ #include "gdcmVR.h" #include "gdcmDict.h" #include "gdcmElementSet.h" +#include "gdcmException.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 { class ValEntry; class BinEntry; class SeqEntry; class Dict; -class RLEFramesInfo; -class JPEGFragmentsInfo; //----------------------------------------------------------------------------- /** @@ -43,88 +46,72 @@ class JPEGFragmentsInfo; class GDCM_EXPORT Document : public ElementSet { public: -// Informations contained in the gdcm::Document - virtual bool IsReadable(); - FileType GetFileType(); - std::string GetTransferSyntax(); - /// returns RLEFramesInfo - RLEFramesInfo *GetRLEInfo() { return RLEInfo; } - /// returns JPEGFragmentsInfo - JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; } +typedef std::list ListElements; -// Dictionaries - virtual void PrintPubDict (std::ostream &os = std::cout); - virtual void PrintShaDict (std::ostream &os = std::cout); +// Loading + 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 + 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 ) 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 + 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); - -public: // 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; } + 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); - - 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 ); - virtual void LoadEntryBinArea(uint16_t group, uint16_t elem); virtual void LoadEntryBinArea(BinEntry *entry); void LoadDocEntrySafe(DocEntry *entry); - /*TagDocEntryHT *BuildFlatHashTable();*/ - - /// Return the Transfer Syntax as a string - std::string GetTransferSyntaxName(); + +// Ordering of Documents + bool operator<(Document &document); - bool IsDicomV3(); - bool IsPapyrus(); +/** + * \brief Sets the LoadMode as a boolean string. + * NO_SEQ, NO_SHADOW, NO_SHADOWSEQ + ... (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 @@ -135,11 +122,9 @@ protected: Document( std::string const &filename ); virtual ~Document(); - void ReadAndSkipEncapsulatedBasicOffsetTable(); - void ComputeRLEInfo(); - void ComputeJPEGFragmentInfo(); - // Entry - + uint16_t ReadInt16() throw ( FormatError ); + uint32_t ReadInt32() throw ( FormatError ); + void SkipBytes(uint32_t); int ComputeGroup0002Length( FileType filetype ); // Variables @@ -174,26 +159,33 @@ 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; + /// List of elements to Anonymize + ListElements AnonymizeList; - /// Store the RLE frames info obtained during parsing of pixels. - RLEFramesInfo *RLEInfo; + /// \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; + + /// 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 - /// Store the JPEG fragments info obtained during parsing of pixels. - JPEGFragmentsInfo *JPEGInfo; + bool IsDocumentModified; private: // Methods + void Initialize(); + bool DoTheLoadingDocumentJob(); // 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 FindDocEntryLength (DocEntry *e) throw ( FormatError ); @@ -204,39 +196,25 @@ private: std::string GetDocEntryValue (DocEntry *entry); std::string GetDocEntryUnvalue(DocEntry *entry); - 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(); -// uint32_t GenerateFreeTagKeyInGroup(uint16_t group); -// void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT, -// DocEntrySet *set ); - void HandleBrokenEndian (uint16_t &group, uint16_t &elem); void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem); // Variables /// Public dictionary used to parse this header Dict *RefPubDict; - /// \brief Optional "shadow dictionary" (private elements) used to parse /// this header Dict *RefShaDict; @@ -247,12 +225,9 @@ private: /// 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; - -private: +// uint32_t GenerateFreeTagKeyInGroup(uint16_t group); +// void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT, +// DocEntrySet *set ); };