X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=bacbe5cf278ef919a829082f3d312ceb3271231b;hb=03acf3c119c6657129b8aeae8cb2205e481a105b;hp=0ddfb468f8203c49f0e692f79a3cbd01a32f1c37;hpb=332835b05f78803ae6d2e92cf95c25548a229532;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index 0ddfb468..bacbe5cf 100644 --- a/src/gdcmDocument.h +++ b/src/gdcmDocument.h @@ -3,12 +3,12 @@ Program: gdcm Module: $RCSfile: gdcmDocument.h,v $ Language: C++ - Date: $Date: 2004/09/03 15:11:35 $ - Version: $Revision: 1.35 $ + Date: $Date: 2005/01/07 08:46:18 $ + Version: $Revision: 1.76 $ 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. + http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR @@ -19,50 +19,153 @@ #ifndef GDCMDOCUMENT_H #define GDCMDOCUMENT_H -#include "gdcmCommon.h" #include "gdcmVR.h" -#include "gdcmTS.h" -#include "gdcmException.h" -#include "gdcmDictSet.h" -#include "gdcmDocEntry.h" - -class gdcmValEntry; -class gdcmBinEntry; -class gdcmSeqEntry; - -#include "gdcmDocEntrySet.h" +#include "gdcmDict.h" #include "gdcmElementSet.h" #include #include +#include + +namespace gdcm +{ +class ValEntry; +class BinEntry; +class SeqEntry; +class Dict; +class RLEFramesInfo; +class JPEGFragmentsInfo; + +enum TransferSyntaxType { + ImplicitVRLittleEndian = 0, + ImplicitVRLittleEndianDLXGE, + ExplicitVRLittleEndian, + DeflatedExplicitVRLittleEndian, + ExplicitVRBigEndian, + JPEGBaselineProcess1, + JPEGExtendedProcess2_4, + JPEGExtendedProcess3_5, + JPEGSpectralSelectionProcess6_8, + JPEGFullProgressionProcess10_12, + JPEGLosslessProcess14, + JPEGLosslessProcess14_1, + JPEG2000Lossless, + JPEG2000, + RLELossless, + UnknownTS +}; //----------------------------------------------------------------------------- /** - * \brief Derived by both gdcmHeader and gdcmDicomDir + * \brief Derived by both Header and DicomDir */ -class GDCM_EXPORT gdcmDocument : public gdcmElementSet +class GDCM_EXPORT Document : public ElementSet { -friend class gdcmFile; -private: - /// Public dictionary used to parse this header - gdcmDict *RefPubDict; +public: +// Informations contained in the parser + virtual bool IsReadable(); + FileType GetFileType(); + + TransferSyntaxType GetTransferSyntax(); + + bool IsJPEGLossless(); + bool IsJPEG2000(); + bool IsJPEG(); + bool IsEncapsulate(); + bool IsDicomV3(); + + RLEFramesInfo *GetRLEInfo() { return RLEInfo; } + JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; } + +// Dictionnaries + virtual void PrintPubDict (std::ostream &os = std::cout); + virtual void PrintShaDict (std::ostream &os = std::cout); + + Dict* GetPubDict(); + Dict* GetShaDict(); + bool SetShaDict(Dict* dict); + bool SetShaDict(DictKey const &dictName); + +// 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 - /// \brief Optional "shadow dictionary" (private elements) used to parse - /// this header - gdcmDict *RefShaDict; +// Ordering of Documents + bool operator<(Document &document); - /// \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; +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(); + bool CloseFile(); + void WriteContent( std::ofstream *fp, FileType type ); + +// Content entries + + 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 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); + ValEntry *GetValEntryByNumber(uint16_t group, uint16_t element); + BinEntry *GetBinEntryByNumber(uint16_t group, uint16_t element); + + ValEntry *ReplaceOrCreateByNumber(std::string const &value, + uint16_t group, uint16_t elem, + TagName const &vr = GDCM_UNKNOWN); + BinEntry *ReplaceOrCreateByNumber(uint8_t* binArea, int lgth, + uint16_t group, uint16_t elem, + TagName const &vr = GDCM_UNKNOWN); + SeqEntry *ReplaceOrCreateByNumber(uint16_t group, uint16_t elem); + + bool ReplaceIfExistByNumber ( std::string const &value, + uint16_t group, uint16_t elem ); - /// \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; + virtual void LoadEntryBinArea(uint16_t group, uint16_t elem); + virtual void LoadEntryBinArea(BinEntry *entry); + + void LoadDocEntrySafe(DocEntry *entry); + TagDocEntryHT *BuildFlatHashTable(); + +// 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 ); + virtual ~Document(); + + void ReadAndSkipEncapsulatedBasicOffsetTable(); + void ComputeRLEInfo(); + void ComputeJPEGFragmentInfo(); + // Entry + bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem ); + + int ComputeGroup0002Length( FileType filetype ); + +// Variables /// Refering underlying filename. std::string Filename; @@ -72,7 +175,7 @@ protected: int SwapCode; /// File Pointer, opened during Header parsing. - FILE *Fp; + std::ifstream *Fp; /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown FileType Filetype; @@ -87,136 +190,41 @@ 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() + /// class DocEntry . See also + /// method ref Document::SetMaxSizePrintEntry() static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE; - /// Will be set 1 if user asks to 'go inside' the 'sequences' (VR = "SQ") - int EnableSequences; - - /// \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 - virtual void PrintPubDict (std::ostream &os = std::cout); - virtual void PrintShaDict (std::ostream &os = std::cout); - -// Dictionnaries - gdcmDict *GetPubDict(); - gdcmDict *GetShaDict(); - bool SetShaDict(gdcmDict *dict); - bool SetShaDict(DictKey const & dictName); - -// Informations contained in the parser - virtual bool IsReadable(); - bool IsGivenTransferSyntax(std::string const & syntaxToCheck); - 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 CloseFile(); - - void Write(FILE* fp, FileType type); - - gdcmValEntry* ReplaceOrCreateByNumber(std::string const & value, - uint16_t group, uint16_t elem); - - gdcmBinEntry* ReplaceOrCreateByNumber(void *voidArea, int lgth, - uint16_t group, uint16_t elem); - gdcmSeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem); - bool ReplaceIfExistByNumber ( std::string const & value, - uint16_t group, - uint16_t elem ); - - virtual void* LoadEntryVoidArea(uint16_t group, uint16_t elem); - virtual void* LoadEntryVoidArea(gdcmBinEntry* entry); - - // System access (meaning endian related !?) - 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(); - gdcmDocument( std::string const & filename ); - virtual ~gdcmDocument(); - - void Parse7FE0 (); - // 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, - std::string const & tagName); - virtual bool SetEntryByNumber(std::string const & content, - uint16_t group, uint16_t element); - virtual bool SetEntryByNumber(void *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* GetEntryVoidAreaByNumber(uint16_t group, uint16_t elem); - virtual bool SetEntryVoidAreaByNumber(void* a, uint16_t group, - uint16_t elem); - - virtual void UpdateShaEntries(); + /// Store the RLE frames info obtained during parsing of pixels. + RLEFramesInfo *RLEInfo; - // Header entry - gdcmDocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element); - gdcmDocEntry* GetDocEntryByName (std::string const & tagName); - - gdcmValEntry* GetValEntryByNumber(uint16_t group, uint16_t element); - gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); - - void LoadDocEntrySafe(gdcmDocEntry* entry); + /// Store the JPEG fragments info obtained during parsing of pixels. + JPEGFragmentsInfo *JPEGInfo; private: +// Methods // 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 *) throw ( gdcmFormatError ); - void FindDocEntryVR (gdcmDocEntry *); - bool CheckDocEntryVR (gdcmDocEntry *, gdcmVRKey); + 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 ); + std::string FindDocEntryVR(); + bool CheckDocEntryVR (VRKey k); - std::string GetDocEntryValue (gdcmDocEntry *); - std::string GetDocEntryUnvalue(gdcmDocEntry *); + std::string GetDocEntryValue (DocEntry *e); + std::string GetDocEntryUnvalue(DocEntry *e); - void SkipDocEntry (gdcmDocEntry *); - void SkipToNextDocEntry (gdcmDocEntry *); - void FixDocEntryFoundLength(gdcmDocEntry *, uint32_t); - bool IsDocEntryAnInteger (gdcmDocEntry *); + void SkipDocEntry (DocEntry *e); + void SkipToNextDocEntry (long offset,long readLgth); - uint32_t FindDocEntryLengthOB() throw( gdcmFormatUnexpected ); + void FixDocEntryFoundLength(DocEntry *e, uint32_t l); + bool IsDocEntryAnInteger (DocEntry *e); - uint16_t ReadInt16() throw ( gdcmFormatError ); - uint32_t ReadInt32() throw ( gdcmFormatError ); + uint32_t FindDocEntryLengthOB() throw( FormatUnexpected ); + + 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); @@ -228,30 +236,37 @@ private: void SetMaxSizePrintEntry(long); // DocEntry related utilities - gdcmDocEntry* ReadNextDocEntry(); + DocEntry *ReadNextDocEntry(); uint32_t GenerateFreeTagKeyInGroup(uint16_t group); + void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT, + DocEntrySet* set ); -public: -// Accessors: - /// Accessor to \ref PrintLevel - void SetPrintLevel(int level) { PrintLevel = level; } - - /// Accessor to \ref Filename - const std::string &GetFileName() { return Filename; } + void HandleBrokenEndian(uint16_t group, uint16_t elem); - /// Accessor to \ref Filename - void SetFileName(std::string const & fileName) { Filename = fileName; } - - /// 'Swap code' accessor (see \ref SwapCode ) - int GetSwapCode() { return SwapCode; } +// Variables + /// Public dictionary used to parse this header + Dict *RefPubDict; - /// File pointer - FILE * GetFP() { return Fp; } + /// \brief Optional "shadow dictionary" (private elements) used to parse + /// this header + Dict *RefShaDict; - bool operator<(gdcmDocument &document); + /// \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; +private: + friend class File; }; +} // end namespace gdcm //----------------------------------------------------------------------------- #endif