X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=55666c1166d65de0dfe7047ac15102ba489a76bb;hb=90a9bbac732dafa2cb32a92f6a7a5462f57f3c27;hp=a504c596c88b2841eccbf47ef2d11dc7bbdf5dd4;hpb=831b4cec23815614ee2ceddff957e852d7a36fe9;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index a504c596..55666c11 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/17 16:52:21 $ - Version: $Revision: 1.88 $ + Date: $Date: 2005/11/21 12:25:41 $ + Version: $Revision: 1.133 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -22,6 +22,8 @@ #include "gdcmVR.h" #include "gdcmDict.h" #include "gdcmElementSet.h" +#include "gdcmException.h" +#include "gdcmDebug.h" // for LEGACY #include #include @@ -29,119 +31,91 @@ namespace gdcm { -class ValEntry; -class BinEntry; class SeqEntry; class Dict; -class RLEFramesInfo; -class JPEGFragmentsInfo; //----------------------------------------------------------------------------- /** - * \brief Derived by both Header and DicomDir + * \brief Derived by both gdcm::File and gdcm::DicomDir */ class GDCM_EXPORT Document : public ElementSet { -public: -// Informations contained in the parser - virtual bool IsReadable(); - FileType GetFileType(); - - std::string GetTransferSyntax(); - - bool IsDicomV3(); + gdcmTypeMacro(Document); - RLEFramesInfo *GetRLEInfo() { return RLEInfo; } - JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; } +public: + typedef std::list ListElements; -// Dictionnaries - 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( ); - 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(); + 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 File - uint32_t SwapLong(uint32_t); // needed by File - uint16_t UnswapShort(uint16_t); // needed by File - uint32_t UnswapLong(uint32_t); // needed by File -// 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; } + 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 bool SetEntry(std::string const &content, - uint16_t group, uint16_t element); - virtual bool SetEntry(uint8_t *content, int lgth, - uint16_t group, uint16_t element); - 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 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); - - DocEntry *GetDocEntry(uint16_t group, uint16_t element); - ValEntry *GetValEntry(uint16_t group, uint16_t element); - BinEntry *GetBinEntry(uint16_t group, uint16_t element); - - 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 ); - 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 AddForceLoadElement(uint16_t group, uint16_t elem); + +// Ordering of Documents + bool operator<(Document &document); - /// Return the Transfer Syntax as a string - std::string GetTransferSyntaxName(); +/** + * \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 Header and - // DicomDir are meaningfull). + // to instanciate from this class Document (only gdcm::File and + // gdcm::DicomDir are meaningfull). Document(); - Document( std::string const &filename ); virtual ~Document(); - void ReadAndSkipEncapsulatedBasicOffsetTable(); - void ComputeRLEInfo(); - void ComputeJPEGFragmentInfo(); - // Entry - - int ComputeGroup0002Length( FileType filetype ); + uint16_t ReadInt16() throw ( FormatError ); + uint32_t ReadInt32() throw ( FormatError ); + void SkipBytes(uint32_t); + int ComputeGroup0002Length( ); // Variables /// Refering underlying filename. @@ -158,16 +132,16 @@ protected: /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be /// swapped) /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and - /// the well knowed 'Bad Big Endian' and 'Bad Little Endian' codes + /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes int SwapCode; - ///\brief whether we already parsed group 0002 + ///\brief whether we already parsed group 0002 (Meta Elements) bool Group0002Parsed; ///\brief whether file has a DCM Preamble bool HasDCMPreamble; - /// File Pointer, opened during Header parsing. + /// File Pointer, opened during Document parsing. std::ifstream *Fp; /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown @@ -175,72 +149,76 @@ 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. - /// \todo Currently not used since collides with #define in - /// class DocEntry . See also - /// method ref Document::SetMaxSizePrintEntry() - 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; - /// 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; + + /// \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 - /// Store the JPEG fragments info obtained during parsing of pixels. - JPEGFragmentsInfo *JPEGInfo; + /// 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); - 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 Initialise(); 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 HandleBrokenEndian (uint16_t &group, uint16_t &elem); void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem); + DocEntry *Backtrack(DocEntry *docEntry); // Variables /// Public dictionary used to parse this header Dict *RefPubDict; - /// \brief Optional "shadow dictionary" (private elements) used to parse /// this header Dict *RefShaDict; @@ -250,15 +228,18 @@ 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; -private: - friend class File; + /// \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 ); + }; + } // end namespace gdcm //-----------------------------------------------------------------------------