X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=6b3a7bbc23f2d468027785e71429948a9d0a7a56;hb=74e3bc05fade5a18f193e7d1122c74756c0e689e;hp=657fe8c250d662aa1fe653f769d058912a3231a3;hpb=4672e071f29ed17f7258b27e40d47642abfbb53f;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index 657fe8c2..6b3a7bbc 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/10/13 14:15:29 $ - Version: $Revision: 1.51 $ + Date: $Date: 2005/01/06 15:36:48 $ + Version: $Revision: 1.73 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -19,25 +19,41 @@ #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, + ImplicitVRLittleEndianDLXGE, + ExplicitVRLittleEndian, + DeflatedExplicitVRLittleEndian, + ExplicitVRBigEndian, + JPEGBaselineProcess1, + JPEGExtendedProcess2_4, + JPEGExtendedProcess3_5, + JPEGSpectralSelectionProcess6_8, + JPEGFullProgressionProcess10_12, + JPEGLosslessProcess14, + JPEGLosslessProcess14_1, + JPEG2000Lossless, + JPEG2000, + RLELossless, + UnknownTS +}; //----------------------------------------------------------------------------- /** @@ -45,125 +61,99 @@ namespace gdcm */ 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. - FILE *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); + Dict* GetPubDict(); + Dict* GetShaDict(); + bool SetShaDict(Dict* 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 IsRLELossLessTransferSyntax(); - bool IsJPEGBaseLineProcess1TransferSyntax(); - bool IsJPEGExtendedProcess2_4TransferSyntax(); - bool IsJPEGExtendedProcess3_5TransferSyntax(); - bool IsJPEGSpectralSelectionProcess6_8TransferSyntax(); - bool IsJPEGLossless(); - bool IsJPEG2000(); - bool IsJPEGTransferSyntax(); - bool IsEncapsulateTransferSyntax(); - 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; } - FILE* OpenFile(); + std::ifstream* OpenFile(); bool CloseFile(); + void WriteContent( std::ofstream* fp, FileType type ); - void Write(FILE* 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, - uint16_t group, uint16_t elem, - std::string const & VR ="unkn"); - + uint16_t group, uint16_t elem, + TagName const & vr = GDCM_UNKNOWN); BinEntry* ReplaceOrCreateByNumber(uint8_t* binArea, int lgth, - uint16_t group, uint16_t elem, - std::string const & VR="unkn"); - + 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 ); + uint16_t group, uint16_t elem ); - virtual void* LoadEntryBinArea(uint16_t group, uint16_t elem); - virtual void* LoadEntryBinArea(BinEntry* entry); + virtual void LoadEntryBinArea(uint16_t group, uint16_t elem); + 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). @@ -176,48 +166,54 @@ 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, - std::string 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 ); - virtual void UpdateShaEntries(); +// Variables + /// Refering underlying filename. + std::string Filename; - // Header entry - DocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element); - DocEntry* GetDocEntryByName (std::string const & tagName); + /// \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; - ValEntry* GetValEntryByNumber(uint16_t group, uint16_t element); - //BinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); + /// File Pointer, opened during Header parsing. + std::ifstream* Fp; - void LoadDocEntrySafe(DocEntry* entry); - TagDocEntryHT* BuildFlatHashTable(); + /// 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; + + /// \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; + + /// Store the RLE frames info obtained during parsing of pixels. + RLEFramesInfo* RLEInfo; + + /// 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 *); + void FindDocEntryLength (DocEntry *) throw ( FormatError ); + std::string FindDocEntryVR(); + bool CheckDocEntryVR (VRKey); std::string GetDocEntryValue (DocEntry *); std::string GetDocEntryUnvalue(DocEntry *); @@ -249,26 +245,29 @@ private: 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() { return Filename; } - - /// 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<(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; + + /// \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