X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=c44e1c9bb323d1bd8f8c46e6fa50957b57cb0fa4;hb=e40fc77cef3155aab87305ce2f8f14d1acbf158f;hp=e20601012c78b855e119d6028d097c76d021ed5e;hpb=36205426d2bbb33e6e08793130f6b6485a500372;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index e2060101..c44e1c9b 100644 --- a/src/gdcmDocument.h +++ b/src/gdcmDocument.h @@ -1,5 +1,21 @@ -// gdcmDocument.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDocument.h,v $ + Language: C++ + Date: $Date: 2004/07/02 13:55:27 $ + Version: $Revision: 1.21 $ + + 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 @@ -20,11 +36,6 @@ class gdcmSeqEntry; #include #include -//----------------------------------------------------------------------------- -typedef std::string VRKey; -typedef std::string VRAtr; -typedef std::map VRHT; // Value Representation Hash Table - //----------------------------------------------------------------------------- /** * \brief Derived by both gdcmHeader and gdcmDicomDir @@ -42,22 +53,22 @@ private: /// \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, /// this upper bound is fixed to 1024 bytes (which might look reasonable /// when one considers the definition of the various VR contents). - guint32 MaxSizeLoadEntry; + 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. - guint32 MaxSizePrintEntry; + uint32_t 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 @@ -68,7 +79,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; @@ -97,110 +108,104 @@ public: virtual void PrintShaDict (std::ostream &os = std::cout); // Dictionnaries - gdcmDict *GetPubDict(void); - gdcmDict *GetShaDict(void); + gdcmDict *GetPubDict(); + gdcmDict *GetShaDict(); bool SetShaDict(gdcmDict *dict); bool SetShaDict(DictKey dictName); // Informations contained in the parser - virtual bool IsReadable(void); + virtual bool IsReadable(); 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) - FILE *OpenFile(bool exception_on_error = false) throw(gdcmFileError); - 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); - - gdcmValEntry * ReplaceOrCreateByNumber(std::string Value, - guint16 Group, guint16 Elem); - - gdcmBinEntry * ReplaceOrCreateByNumber(void *voidArea, int lgth, - guint16 Group, guint16 Elem); - bool ReplaceIfExistByNumber (char *Value, guint16 Group, guint16 Elem); + bool IsImplicitVRLittleEndianTransferSyntax(); + bool IsExplicitVRLittleEndianTransferSyntax(); + bool IsDeflatedExplicitVRLittleEndianTransferSyntax(); + bool IsExplicitVRBigEndianTransferSyntax(); + bool IsJPEGBaseLineProcess1TransferSyntax(); + bool IsJPEGExtendedProcess2_4TransferSyntax(); + bool IsJPEGExtendedProcess3_5TransferSyntax(); + bool IsJPEGSpectralSelectionProcess6_8TransferSyntax(); + bool IsRLELossLessTransferSyntax(); + bool IsJPEGLossless(); + bool IsJPEG2000(); + bool IsDicomV3(); + + FileType GetFileType(); + + FILE* OpenFile(bool exception_on_error = false) throw(gdcmFileError); + bool CloseFile(); + + void Write(FILE* fp,FileType type); + + gdcmValEntry* ReplaceOrCreateByNumber(std::string Value, + uint16_t Group, uint16_t Elem); + + gdcmBinEntry* ReplaceOrCreateByNumber(void *voidArea, int lgth, + uint16_t Group, uint16_t Elem); + bool ReplaceIfExistByNumber (char* Value, uint16_t Group, uint16_t Elem); - virtual void *LoadEntryVoidArea (guint16 Group, guint16 Element); - void LoadVLEntry (gdcmDocEntry *entry); + virtual void* LoadEntryVoidArea(uint16_t Group, uint16_t 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 - guint32 UnswapLong(guint32); // needed by gdcmFile + // System access + uint16_t SwapShort(uint16_t); // needed by gdcmFile + uint32_t SwapLong(uint32_t); // needed by gdcmFile + uint16_t UnswapShort(uint16_t); // needed by gdcmFile + uint32_t UnswapLong(uint32_t); // needed by gdcmFile protected: // Constructor and destructor are protected to forbid end user // to instanciate from this class gdcmDocument (only gdcmHeader and // gdcmDicomDir are meaningfull). gdcmDocument(bool exception_on_error = false); - gdcmDocument(const char *inFilename, + gdcmDocument(std::string const & inFilename, bool exception_on_error = false, bool enable_sequences = false, bool ignore_shadow = false); - virtual ~gdcmDocument(void); + virtual ~gdcmDocument(); - void gdcmDocument::Parse7FE0 (void); -// Entry - int CheckIfEntryExistByNumber(guint16 Group, guint16 Elem ); // int ! + void gdcmDocument::Parse7FE0 (); + // Entry + int CheckIfEntryExistByNumber(uint16_t Group, uint16_t Elem ); // int ! public: - virtual std::string GetEntryByName (std::string tagName); - virtual std::string GetEntryVRByName (std::string tagName); - virtual std::string GetEntryByNumber (guint16 group, guint16 element); - virtual std::string GetEntryVRByNumber(guint16 group, guint16 element); - virtual int GetEntryLengthByNumber(guint16 group, guint16 element); + virtual std::string GetEntryByName (TagName tagName); + virtual std::string GetEntryVRByName (TagName tagName); + virtual std::string GetEntryByNumber (uint16_t group, uint16_t element); + virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t element); + virtual int GetEntryLengthByNumber(uint16_t group, uint16_t element); protected: virtual bool SetEntryByName (std::string content, std::string tagName); virtual bool SetEntryByNumber(std::string content, - guint16 group, guint16 element); + uint16_t group, uint16_t element); virtual bool SetEntryByNumber(void *content, int lgth, - guint16 group, guint16 element); - virtual bool SetEntryLengthByNumber(guint32 length, - guint16 group, guint16 element); + 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* GetEntryVoidAreaByNumber(uint16_t Group, uint16_t Elem); + virtual bool SetEntryVoidAreaByNumber(void* a, uint16_t Group, + uint16_t Elem); - virtual size_t GetEntryOffsetByNumber (guint16 Group, guint16 Elem); - virtual void *GetEntryVoidAreaByNumber(guint16 Group, guint16 Elem); - virtual bool SetEntryVoidAreaByNumber(void *a, guint16 Group, guint16 Elem); + virtual void UpdateShaEntries(); - virtual void UpdateShaEntries(void); + // Header entry + gdcmDocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element); + gdcmDocEntry* GetDocEntryByName (std::string Name); -// Header entry - gdcmDocEntry *GetDocEntryByNumber (guint16 group, guint16 element); - gdcmDocEntry *GetDocEntryByName (std::string Name); - - gdcmValEntry *GetValEntryByNumber (guint16 group, guint16 element); - gdcmBinEntry *GetBinEntryByNumber (guint16 group, guint16 element); + gdcmValEntry* GetValEntryByNumber(uint16_t group, uint16_t element); + gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); - void LoadDocEntrySafe(gdcmDocEntry *); + void LoadDocEntrySafe(gdcmDocEntry*); private: -// Read + // Read 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 *); - bool CheckDocEntryVR (gdcmDocEntry *, VRKey); + bool CheckDocEntryVR (gdcmDocEntry *, gdcmVRKey); std::string GetDocEntryValue (gdcmDocEntry *); std::string GetDocEntryUnvalue(gdcmDocEntry *); @@ -208,64 +213,47 @@ private: void SkipDocEntry (gdcmDocEntry *); void SkipToNextDocEntry (gdcmDocEntry *); - void FixDocEntryFoundLength(gdcmDocEntry *, guint32); + void FixDocEntryFoundLength(gdcmDocEntry *, uint32_t); bool IsDocEntryAnInteger (gdcmDocEntry *); - guint32 FindDocEntryLengthOB(void); + uint32_t FindDocEntryLengthOB(); - guint16 ReadInt16(void); - guint32 ReadInt32(void); - void SkipBytes(guint32); - guint32 ReadTagLength(guint16, guint16); - guint32 ReadItemTagLength(void); - guint32 ReadSequenceDelimiterTagLength(void); + uint16_t ReadInt16(); + uint32_t ReadInt32(); + void SkipBytes(uint32_t); + bool ReadTag(uint16_t, uint16_t); + uint32_t ReadTagLength(uint16_t, uint16_t); - 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"); // DocEntry related utilities - gdcmDocEntry *ReadNextDocEntry (void); - gdcmDocEntry *NewDocEntryByNumber(guint16 group, - guint16 element); - gdcmDocEntry *NewDocEntryByName (std::string Name); + gdcmDocEntry* ReadNextDocEntry(); - gdcmValEntry *NewValEntryByNumber(guint16 group, - guint16 element); - gdcmBinEntry *NewBinEntryByNumber(guint16 group, - guint16 element); - guint32 GenerateFreeTagKeyInGroup(guint16 group); + uint32_t GenerateFreeTagKeyInGroup(uint16_t group); public: // Accessors: /// Accessor to \ref printLevel - void SetPrintLevel(int level) { printLevel = level; }; + void SetPrintLevel(int level) { printLevel = level; } - /// Accessor to \ref filename - inline std::string GetFileName(void) {return filename;} + /// Accessor to \ref Filename + std::string &GetFileName() { return Filename; } - /// Accessor to \ref filename - inline void SetFileName(char* fileName) {filename = fileName;} + /// Accessor to \ref Filename + void SetFileName(const char* fileName) { Filename = fileName; } /// Accessor to \ref gdcmElementSet::tagHT - inline TagDocEntryHT &GetEntry(void) { return tagHT; }; + TagDocEntryHT &GetEntry() { return tagHT; }; /// 'Swap code' accessor (see \ref sw ) - inline int GetSwapCode(void) { return sw; } + int GetSwapCode() { return sw; } /// File pointer - inline FILE * GetFP(void) { return fp; } + FILE * GetFP() { return fp; } bool operator<(gdcmDocument &document);