X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=4a5873f0495153b5091a008050edc837e6b14577;hb=26d4556cd9769bba7d3df71ed994cd1a5efa0016;hp=7fc5c14386861a606e7f8f283cdfd2c21e9d901e;hpb=0b36f4932e894a1dde4a80e614755816b4b29218;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index 7fc5c143..4a5873f0 100644 --- a/src/gdcmDocument.h +++ b/src/gdcmDocument.h @@ -1,41 +1,53 @@ -// gdcmDocument.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDocument.h,v $ + Language: C++ + Date: $Date: 2004/06/24 18:03:14 $ + Version: $Revision: 1.15 $ + + Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de + l'Image). All rights reserved. See Doc/License.txt or + http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ + #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 -#include +class gdcmValEntry; +class gdcmBinEntry; +class gdcmSeqEntry; +#include "gdcmDocEntrySet.h" +#include "gdcmElementSet.h" +#include +#include //----------------------------------------------------------------------------- typedef std::string VRKey; typedef std::string VRAtr; typedef std::map VRHT; // Value Representation Hash Table -typedef std::multimap TagDocEntryHT; -typedef std::pair PairHT; -typedef std::pair IterHT; -/// for linking together the Elements -typedef std::list ListTag; - -typedef std::string GroupKey; -typedef std::map GroupHT; - //----------------------------------------------------------------------------- /** - * \brief used by both gdcmHeader and gdcmDicomDir + * \brief Derived by both gdcmHeader and gdcmDicomDir */ class GDCM_EXPORT gdcmDocument : public gdcmElementSet { +friend class gdcmFile; private: /// Public dictionary used to parse this header gdcmDict *RefPubDict; @@ -43,13 +55,10 @@ private: /// \brief Optional "shadow dictionary" (private elements) used to parse /// this header gdcmDict *RefShaDict; - - /// Equals 1 if a gdcmDocEntry was added post parsing - int wasUpdated; /// \brief Equals =1 if user wants to skip shadow groups while parsing /// (to save space) - int ignoreShadow; + int IgnoreShadow; /// \brief Size threshold above which an element value will NOT be loaded /// in memory (to avoid loading the image/volume itself). By default, @@ -60,11 +69,11 @@ private: /// \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. - guint32 MaxSizePrintEntry; + guint32 MaxSizePrintEntry; protected: /// Refering underlying filename. - std::string 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 @@ -75,7 +84,7 @@ protected: FILE *fp; /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown - FileType filetype; + FileType Filetype; /// After opening the file, we read HEADER_LENGTH_TO_READ bytes. static const unsigned int HEADER_LENGTH_TO_READ; @@ -86,14 +95,11 @@ protected: /// \brief Elements whose value is longer than MAX_SIZE_PRINT_ELEMENT_VALUE /// are NOT printed. + /// \todo Currently not used since collides with #define in + /// \ref gdcmDocEntry.cxx. See also + /// \ref gdcmDocument::SetMaxSizePrintEntry() static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE; - /// Hash Table (multimap), to provide fast access - TagDocEntryHT tagHT; - - /// Chained list, to keep the 'spacial' ordering - ListTag listEntries; - /// Will be set 1 if user asks to 'go inside' the 'sequences' (VR = "SQ") int enableSequences; @@ -102,15 +108,7 @@ protected: int printLevel; public: - - -// Print - /// Canonical Printing method (see also gdcmDocument::SetPrintLevel) - virtual void Print (std::ostream &os = std::cout) - {PrintEntry(os);}; - virtual void PrintEntry (std::ostream &os = std::cout); - - // the 2 following will be merged +// the 2 following will be merged virtual void PrintPubDict (std::ostream &os = std::cout); virtual void PrintShaDict (std::ostream &os = std::cout); @@ -122,10 +120,20 @@ public: // Informations contained in the parser virtual bool IsReadable(void); + bool IsGivenTransferSyntax(const std::string & SyntaxToCheck); bool IsImplicitVRLittleEndianTransferSyntax(void); bool IsExplicitVRLittleEndianTransferSyntax(void); bool IsDeflatedExplicitVRLittleEndianTransferSyntax(void); bool IsExplicitVRBigEndianTransferSyntax(void); + bool IsJPEGBaseLineProcess1TransferSyntax(void); + bool IsJPEGExtendedProcess2_4TransferSyntax(void); + bool IsJPEGExtendedProcess3_5TransferSyntax(void); + bool IsJPEGSpectralSelectionProcess6_8TransferSyntax(void); + bool IsRLELossLessTransferSyntax(void); + bool IsJPEGLossless(void); + bool IsJPEG2000(void); + bool IsDicomV3(void); + FileType GetFileType(void); // Read (used in gdcmFile, gdcmDicomDir) @@ -133,19 +141,20 @@ public: bool CloseFile(void); // Write (used in gdcmFile, gdcmDicomDir) - virtual bool Write(FILE *, FileType); - virtual void WriteEntryTagVRLength(gdcmDocEntry *tag, - FILE *_fp, FileType type); - virtual void WriteEntryValue(gdcmDocEntry *tag,FILE *_fp,FileType type); - virtual bool WriteEntry(gdcmDocEntry *tag,FILE *_fp,FileType type); - virtual bool WriteEntries(FILE *_fp,FileType type); - void WriteEntriesDeprecated(FILE *_fp,FileType type); // JPR - - gdcmDocEntry * ReplaceOrCreateByNumber(std::string Value, + + virtual bool WriteF(FileType type); // New stuff, with recursive exploration + + gdcmValEntry * ReplaceOrCreateByNumber(std::string Value, guint16 Group, guint16 Elem); - bool ReplaceIfExistByNumber (char *Value, guint16 Group, guint16 Elem); -// System access + gdcmBinEntry * ReplaceOrCreateByNumber(void *voidArea, int lgth, + guint16 Group, guint16 Elem); + bool ReplaceIfExistByNumber (char *Value, guint16 Group, guint16 Elem); + + virtual void *LoadEntryVoidArea (guint16 Group, guint16 Element); + virtual void *LoadEntryVoidArea (gdcmBinEntry*); + + // System access guint16 SwapShort(guint16); // needed by gdcmFile guint32 SwapLong(guint32); // needed by gdcmFile guint16 UnswapShort(guint16); // needed by gdcmFile @@ -156,50 +165,50 @@ protected: // to instanciate from this class gdcmDocument (only gdcmHeader and // gdcmDicomDir are meaningfull). gdcmDocument(bool exception_on_error = false); - gdcmDocument(const char *inFilename, - bool exception_on_error = false, - bool enable_sequences = false, - bool ignore_shadow = false); + gdcmDocument(std::string const & inFilename, + bool exception_on_error = false, + bool enable_sequences = false, + bool ignore_shadow = false); virtual ~gdcmDocument(void); -// Entry + + void gdcmDocument::Parse7FE0 (void); + // Entry int CheckIfEntryExistByNumber(guint16 Group, guint16 Elem ); // int ! - virtual std::string GetEntryByName (std::string tagName); - virtual std::string GetEntryVRByName (std::string tagName); +public: + virtual std::string GetEntryByName (TagName tagName); + virtual std::string GetEntryVRByName (TagName tagName); virtual std::string GetEntryByNumber (guint16 group, guint16 element); virtual std::string GetEntryVRByNumber(guint16 group, guint16 element); virtual int GetEntryLengthByNumber(guint16 group, guint16 element); - +protected: virtual bool SetEntryByName (std::string content, std::string tagName); virtual bool SetEntryByNumber(std::string content, guint16 group, guint16 element); + virtual bool SetEntryByNumber(void *content, int lgth, + guint16 group, guint16 element); virtual bool SetEntryLengthByNumber(guint32 length, guint16 group, guint16 element); virtual size_t GetEntryOffsetByNumber (guint16 Group, guint16 Elem); virtual void *GetEntryVoidAreaByNumber(guint16 Group, guint16 Elem); - virtual void *LoadEntryVoidArea (guint16 Group, guint16 Element); virtual bool SetEntryVoidAreaByNumber(void *a, guint16 Group, guint16 Elem); - virtual void UpdateShaEntries(void); + virtual void UpdateShaEntries(); -// Header entry + // Header entry gdcmDocEntry *GetDocEntryByNumber (guint16 group, guint16 element); gdcmDocEntry *GetDocEntryByName (std::string Name); - IterHT GetDocEntrySameNumber(guint16 group, guint16 element); -// IterHT GetDocEntrySameName (std::string Name); - void LoadDocEntrySafe(gdcmDocEntry *); + gdcmValEntry *GetValEntryByNumber (guint16 group, guint16 element); + gdcmBinEntry *GetBinEntryByNumber (guint16 group, guint16 element); - void UpdateGroupLength(bool SkipSequence = false, - FileType type = ImplicitVR); + void LoadDocEntrySafe(gdcmDocEntry *); - void AddDocEntry (gdcmDocEntry *); - - private: // Read - bool LoadDocEntries(bool exception_on_error = false) throw(gdcmFormatError); - + long ParseDES(gdcmDocEntrySet *set, long offset, long l_max,bool delim_mode); + long ParseSQ(gdcmSeqEntry *seq, long offset, long l_max, bool delim_mode); + void LoadDocEntry (gdcmDocEntry *); void FindDocEntryLength(gdcmDocEntry *); void FindDocEntryVR (gdcmDocEntry *); @@ -209,63 +218,55 @@ private: std::string GetDocEntryUnvalue(gdcmDocEntry *); void SkipDocEntry (gdcmDocEntry *); + void SkipToNextDocEntry (gdcmDocEntry *); + void FixDocEntryFoundLength(gdcmDocEntry *, guint32); bool IsDocEntryAnInteger (gdcmDocEntry *); - guint32 FindDocEntryLengthOB(void); + guint32 FindDocEntryLengthOB(); - guint16 ReadInt16(void); - guint32 ReadInt32(void); + guint16 ReadInt16(); + guint32 ReadInt32(); void SkipBytes(guint32); + guint32 ReadTagLength(guint16, guint16); + guint32 ReadItemTagLength(); + guint32 ReadSequenceDelimiterTagLength(); - void Initialise(void); - bool CheckSwap(void); - void SwitchSwapToBigEndian(void); + void Initialise(); + bool CheckSwap(); + void SwitchSwapToBigEndian(); void SetMaxSizeLoadEntry(long); void SetMaxSizePrintEntry(long); - // DictEntry related utilities - gdcmDictEntry *GetDictEntryByName (std::string Name); - gdcmDictEntry *GetDictEntryByNumber(guint16, guint16); - gdcmDictEntry *NewVirtualDictEntry(guint16 group, - guint16 element, - std::string vr = "unkn", - std::string fourth = "unkn", - std::string name = "unkn"); - //gdcmDictEntry *NewVirtualDictEntry(gdcmDocEntry *); // never defined - + // DocEntry related utilities - - gdcmDocEntry *ReadNextDocEntry (void); - gdcmDocEntry *NewDocEntryByNumber(guint16 group, - guint16 element); - gdcmDocEntry *NewDocEntryByName (std::string Name); - - // Deprecated (Not used) --> commented out - //gdcmDocEntry *NewManualDocEntryToPubDict(std::string NewTagName, - // std::string VR); - + gdcmDocEntry *ReadNextDocEntry (); + + guint32 GenerateFreeTagKeyInGroup(guint16 group); public: // Accessors: /// Accessor to \ref printLevel - void SetPrintLevel(int level) { printLevel = level; }; + inline void SetPrintLevel(int level) { printLevel = level; } /// Accessor to \ref filename - inline std::string GetFileName(void) {return filename;} + inline std::string &GetFileName() { return Filename; } /// Accessor to \ref filename - inline void SetFileName(char* fileName) {filename = fileName;} - - /// Accessor to \ref gdcmDocument::tagHT - inline TagDocEntryHT &GetEntry(void) { return tagHT; }; + inline void SetFileName(const char* fileName) { Filename = fileName; } - /// Accessor to \ref gdcmDocument::listEntries - inline ListTag &GetListEntry(void) { return listEntries; }; + /// Accessor to \ref gdcmElementSet::tagHT + inline TagDocEntryHT &GetEntry() { return tagHT; }; /// 'Swap code' accessor (see \ref sw ) - inline int GetSwapCode(void) { return sw; } + inline int GetSwapCode() { return sw; } + + /// File pointer + inline FILE * GetFP() { return fp; } + + bool operator<(gdcmDocument &document); + }; //-----------------------------------------------------------------------------