X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=e7233eb029fff390ccb7fe075d98c43e2b01e406;hb=327dfe7647e3720b0f3125f9b19397cb9afc0ed3;hp=b3129904415ebf245f9f041b740a2d4d487934f7;hpb=1bae8d2ba47d1b9cc8acfb7b5ab82026e48275dd;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index b3129904..e7233eb0 100644 --- a/src/gdcmDocument.h +++ b/src/gdcmDocument.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocument.h,v $ Language: C++ - Date: $Date: 2004/11/25 15:46:11 $ - Version: $Revision: 1.64 $ + Date: $Date: 2005/01/06 20:03:27 $ + Version: $Revision: 1.75 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -19,27 +19,22 @@ #ifndef GDCMDOCUMENT_H #define GDCMDOCUMENT_H -#include "gdcmCommon.h" #include "gdcmVR.h" -#include "gdcmTS.h" -#include "gdcmException.h" -#include "gdcmDictSet.h" -#include "gdcmDocEntry.h" -#include "gdcmRLEFramesInfo.h" -#include "gdcmJPEGFragmentsInfo.h" -#include "gdcmDocEntrySet.h" +#include "gdcmDict.h" #include "gdcmElementSet.h" -class ValEntry; -class BinEntry; -class SeqEntry; - #include #include #include namespace gdcm { +class ValEntry; +class BinEntry; +class SeqEntry; +class Dict; +class RLEFramesInfo; +class JPEGFragmentsInfo; enum TransferSyntaxType { ImplicitVRLittleEndian = 0, @@ -60,161 +55,110 @@ enum TransferSyntaxType { UnknownTS }; -static const char *TransferSyntaxStrings[] = { - // Implicit VR Little Endian - "1.2.840.10008.1.2", - // Implicit VR Little Endian DLX G.E? - "1.2.840.113619.5.2", - // Explicit VR Little Endian - "1.2.840.10008.1.2.1", - // Deflated Explicit VR Little Endian - "1.2.840.10008.1.2.1.99", - // Explicit VR Big Endian - "1.2.840.10008.1.2.2", - // JPEG Baseline (Process 1) - "1.2.840.10008.1.2.4.50", - // JPEG Extended (Process 2 & 4) - "1.2.840.10008.1.2.4.51", - // JPEG Extended (Process 3 & 5) - "1.2.840.10008.1.2.4.52", - // JPEG Spectral Selection, Non-Hierarchical (Process 6 & 8) - "1.2.840.10008.1.2.4.53", - // JPEG Full Progression, Non-Hierarchical (Process 10 & 12) - "1.2.840.10008.1.2.4.55", - // JPEG Lossless, Non-Hierarchical (Process 14) - "1.2.840.10008.1.2.4.57", - // JPEG Lossless, Hierarchical, First-Order Prediction (Process 14, [Selection Value 1]) - "1.2.840.10008.1.2.4.70", - // JPEG 2000 Lossless - "1.2.840.10008.1.2.4.90", - // JPEG 2000 - "1.2.840.10008.1.2.4.91", - // RLE Lossless - "1.2.840.10008.1.2.5", - // Unknown - "Unknown Transfer Syntax" -}; - //----------------------------------------------------------------------------- /** * \brief Derived by both Header and DicomDir */ class GDCM_EXPORT Document : public ElementSet { -friend class File; -private: - /// Public dictionary used to parse this header - Dict* RefPubDict; - - /// \brief Optional "shadow dictionary" (private elements) used to parse - /// this header - Dict* RefShaDict; - - /// \brief Size threshold above which an element value will NOT be loaded - /// in memory (to avoid loading the image/volume itself). By default, - /// 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; - -protected: - /// Refering underlying filename. - std::string Filename; - - /// \brief SWap code (e.g. Big Endian, Little Endian, Bad Big Endian, - /// Bad Little Endian) according to the processor Endianity and - /// what is written on disc. - int SwapCode; - - /// File Pointer, opened during Header parsing. - std::ifstream* Fp; - - /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown - FileType Filetype; - - /// 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; +public: +// Informations contained in the parser + virtual bool IsReadable(); + FileType GetFileType(); - /// \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; + TransferSyntaxType GetTransferSyntax(); - /// Store the RLE frames info obtained during parsing of pixels. - RLEFramesInfo* RLEInfo; + bool IsJPEGLossless(); + bool IsJPEG2000(); + bool IsJPEG(); + bool IsEncapsulate(); + bool IsDicomV3(); - /// Store the JPEG fragments info obtained during parsing of pixels. - JPEGFragmentsInfo* JPEGInfo; + RLEFramesInfo *GetRLEInfo() { return RLEInfo; } + JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; } - /// \brief Amount of printed details for each Header Entry (Dicom Element): - /// 0 : stands for the least detail level. - int PrintLevel; - -public: -// the 2 following will be merged +// Dictionnaries virtual void PrintPubDict (std::ostream &os = std::cout); virtual void PrintShaDict (std::ostream &os = std::cout); -// Dictionnaries Dict* GetPubDict(); Dict* GetShaDict(); bool SetShaDict(Dict* dict); - bool SetShaDict(DictKey const & dictName); + bool SetShaDict(DictKey const &dictName); -// Informations contained in the parser - virtual bool IsReadable(); - TransferSyntaxType GetTransferSyntax(); - bool IsJPEGLossless(); - bool IsJPEG2000(); - bool IsJPEG(); - bool IsEncapsulate(); - bool IsDicomV3(); +// 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); - FileType GetFileType(); +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; } - std::ifstream * OpenFile(); + std::ifstream *OpenFile(); bool CloseFile(); + void WriteContent( std::ofstream *fp, FileType type ); - void WriteContent( std::ofstream* fp, FileType type ); +// Content entries + virtual bool SetEntryByName (std::string const &content, + TagName const &tagName ); + virtual bool SetEntryByNumber(std::string const &content, + uint16_t group, uint16_t element); + virtual bool SetEntryByNumber(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 *GetEntryBinAreaByNumber(uint16_t group, uint16_t elem); + + virtual std::string GetEntryByName (TagName const &tagName); + virtual std::string GetEntryVRByName (TagName const &tagName); + virtual std::string GetEntryByNumber (uint16_t group, uint16_t elem); + virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t elem); + virtual int GetEntryLengthByNumber(uint16_t group, uint16_t elem); + + DocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element); + DocEntry *GetDocEntryByName (TagName const &tagName); + ValEntry *GetValEntryByNumber(uint16_t group, uint16_t element); + BinEntry *GetBinEntryByNumber(uint16_t group, uint16_t element); - ValEntry* ReplaceOrCreateByNumber(std::string const & value, + ValEntry *ReplaceOrCreateByNumber(std::string const &value, uint16_t group, uint16_t elem, - TagName const & vr = "unkn"); - - BinEntry* ReplaceOrCreateByNumber(uint8_t* binArea, int lgth, + TagName const &vr = GDCM_UNKNOWN); + BinEntry *ReplaceOrCreateByNumber(uint8_t* binArea, int lgth, uint16_t group, uint16_t elem, - TagName const & vr = "unkn"); + TagName const &vr = GDCM_UNKNOWN); + SeqEntry *ReplaceOrCreateByNumber(uint16_t group, uint16_t elem); - SeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem); - - bool ReplaceIfExistByNumber ( std::string const & value, + bool ReplaceIfExistByNumber ( std::string const &value, uint16_t group, uint16_t elem ); virtual void LoadEntryBinArea(uint16_t group, uint16_t elem); - virtual void LoadEntryBinArea(BinEntry* entry); + virtual void LoadEntryBinArea(BinEntry *entry); + + void LoadDocEntrySafe(DocEntry *entry); + TagDocEntryHT *BuildFlatHashTable(); - // 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 +// Divers + static std::string GetTransferSyntaxValue(TransferSyntaxType type); protected: +// Methods // Constructor and destructor are protected to forbid end user // to instanciate from this class Document (only Header and // DicomDir are meaningfull). Document(); - Document( std::string const & filename ); + Document( std::string const &filename ); virtual ~Document(); void ReadAndSkipEncapsulatedBasicOffsetTable(); @@ -222,59 +166,64 @@ protected: void ComputeJPEGFragmentInfo(); // Entry bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem ); -public: - virtual std::string GetEntryByName (TagName const & tagName); - virtual std::string GetEntryVRByName (TagName const & tagName); - virtual std::string GetEntryByNumber (uint16_t group, uint16_t elem); - virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t elem); - virtual int GetEntryLengthByNumber(uint16_t group, uint16_t elem); -//protected: - virtual bool SetEntryByName ( std::string const & content, - TagName const & tagName ); - virtual bool SetEntryByNumber(std::string const & content, - uint16_t group, uint16_t element); - virtual bool SetEntryByNumber(uint8_t* content, int lgth, - uint16_t group, uint16_t element); - virtual bool SetEntryLengthByNumber(uint32_t length, - uint16_t group, uint16_t element); - virtual size_t GetEntryOffsetByNumber(uint16_t group, uint16_t elem); - virtual void* GetEntryBinAreaByNumber(uint16_t group, uint16_t elem); - virtual bool SetEntryBinAreaByNumber(uint8_t* a, uint16_t group, - uint16_t elem); + int ComputeGroup0002Length( FileType filetype ); + +// Variables + /// Refering underlying filename. + std::string Filename; + + /// \brief SWap code (e.g. Big Endian, Little Endian, Bad Big Endian, + /// Bad Little Endian) according to the processor Endianity and + /// what is written on disc. + int SwapCode; + + /// File Pointer, opened during Header parsing. + std::ifstream *Fp; + + /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown + FileType Filetype; + + /// After opening the file, we read HEADER_LENGTH_TO_READ bytes. + static const unsigned int HEADER_LENGTH_TO_READ; - virtual void UpdateShaEntries(); + /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE + /// are NOT loaded. + static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE; - // Header entry - DocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element); - DocEntry* GetDocEntryByName (TagName const & tagName); + /// \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; - ValEntry* GetValEntryByNumber(uint16_t group, uint16_t element); - //BinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); - RLEFramesInfo* GetRLEInfo() { return RLEInfo; } - JPEGFragmentsInfo* GetJPEGInfo() { return JPEGInfo; } + /// Store the RLE frames info obtained during parsing of pixels. + RLEFramesInfo *RLEInfo; - void LoadDocEntrySafe(DocEntry* entry); - TagDocEntryHT* BuildFlatHashTable(); + /// Store the JPEG fragments info obtained during parsing of pixels. + JPEGFragmentsInfo *JPEGInfo; private: +// Methods // 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 LoadDocEntry (DocEntry *); - void FindDocEntryLength(DocEntry *) throw ( FormatError ); - void FindDocEntryVR (DocEntry *); - bool CheckDocEntryVR (DocEntry *, VRKey); + void LoadDocEntry (DocEntry *e); + void FindDocEntryLength (DocEntry *e) throw ( FormatError ); + std::string FindDocEntryVR(); + bool CheckDocEntryVR (VRKey k); + + std::string GetDocEntryValue (DocEntry *e); + std::string GetDocEntryUnvalue(DocEntry *e); - std::string GetDocEntryValue (DocEntry *); - std::string GetDocEntryUnvalue(DocEntry *); - void SkipDocEntry (DocEntry *); - void SkipToNextDocEntry (DocEntry *); + void SkipDocEntry (DocEntry *e); + void SkipToNextDocEntry (long offset,long readLgth); - void FixDocEntryFoundLength(DocEntry *, uint32_t); - bool IsDocEntryAnInteger (DocEntry *); + void FixDocEntryFoundLength(DocEntry *e, uint32_t l); + bool IsDocEntryAnInteger (DocEntry *e); uint32_t FindDocEntryLengthOB() throw( FormatUnexpected ); @@ -291,29 +240,35 @@ private: void SetMaxSizePrintEntry(long); // DocEntry related utilities - DocEntry* ReadNextDocEntry(); + DocEntry *ReadNextDocEntry(); uint32_t GenerateFreeTagKeyInGroup(uint16_t group); - void BuildFlatHashTableRecurse( TagDocEntryHT& builtHT, + void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT, DocEntrySet* set ); void HandleBrokenEndian(uint16_t group, uint16_t elem); -public: -// Accessors: - /// Accessor to \ref PrintLevel - void SetPrintLevel(int level) { PrintLevel = level; } - - /// Accessor to \ref Filename - const std::string &GetFileName() const { return Filename; } - /// Accessor to \ref Filename - void SetFileName(std::string const & fileName) { Filename = fileName; } +// Variables + /// Public dictionary used to parse this header + Dict *RefPubDict; + + /// \brief Optional "shadow dictionary" (private elements) used to parse + /// this header + Dict *RefShaDict; - /// 'Swap code' accessor (see \ref SwapCode ) - int GetSwapCode() { return SwapCode; } + /// \brief Size threshold above which an element value will NOT be loaded + /// in memory (to avoid loading the image/volume itself). By default, + /// 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; - bool operator<(Document &document); + /// \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; }; } // end namespace gdcm