X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=727d049d1780ecfe3f6f9608c2a04a5b383ce3fd;hb=5b89bede4607999aeb8d5b45311e7ee82f9471ef;hp=6b3a7bbc23f2d468027785e71429948a9d0a7a56;hpb=4beda181275414e5cba990113f8d16424b2c09e6;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index 6b3a7bbc..727d049d 100644 --- a/src/gdcmDocument.h +++ b/src/gdcmDocument.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmDocument.h,v $ Language: C++ - Date: $Date: 2005/01/06 15:36:48 $ - Version: $Revision: 1.73 $ + Date: $Date: 2005/02/02 16:18:48 $ + Version: $Revision: 1.104 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -22,6 +22,7 @@ #include "gdcmVR.h" #include "gdcmDict.h" #include "gdcmElementSet.h" +#include "gdcmException.h" #include #include @@ -33,227 +34,155 @@ 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 Header and DicomDir + * \brief Derived by both gdcm::File and gdcm::DicomDir */ class GDCM_EXPORT Document : public ElementSet { 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); +// Dictionaries Dict* GetPubDict(); Dict* GetShaDict(); bool SetShaDict(Dict* dict); - bool SetShaDict(DictKey const & dictName); + bool SetShaDict(DictKey const &dictName); + +// Informations contained in the gdcm::Document + virtual bool IsReadable(); + bool IsDicomV3(); + bool IsPapyrus(); + FileType GetFileType(); + std::string GetTransferSyntax(); + /// Return the Transfer Syntax as a string + std::string GetTransferSyntaxName(); // 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 + uint16_t SwapShort(uint16_t); + uint32_t SwapLong(uint32_t); + /// \brief Unswaps back the bytes of 2-bytes long integer + /// so they agree with the processor order. + uint16_t UnswapShort(uint16_t a) { return SwapShort(a);} + /// \brief Unswaps back the bytes of 4-byte long integer + /// so they agree with the processor order. + uint32_t UnswapLong(uint32_t a) { return SwapLong(a);} -// Ordering of Documents - bool operator<(Document &document); - -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; } + 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, - 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 ); - virtual void LoadEntryBinArea(uint16_t group, uint16_t elem); - virtual void LoadEntryBinArea(BinEntry* entry); + virtual void LoadEntryBinArea(BinEntry *entry); + + void LoadDocEntrySafe(DocEntry *entry); - void LoadDocEntrySafe(DocEntry* entry); - TagDocEntryHT* BuildFlatHashTable(); - -// Divers - static std::string GetTransferSyntaxValue(TransferSyntaxType type); +// Ordering of Documents + bool operator<(Document &document); protected: // Methods // Constructor and destructor are protected to forbid end user - // to instanciate from this class Document (only Header and - // DicomDir are meaningfull). + // to instanciate from this class Document (only gdcm::File and + // gdcm::DicomDir are meaningfull). Document(); - Document( std::string const & filename ); + Document( std::string const &filename ); virtual ~Document(); - void ReadAndSkipEncapsulatedBasicOffsetTable(); - void ComputeRLEInfo(); - void ComputeJPEGFragmentInfo(); - // Entry - bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem ); - + uint16_t ReadInt16() throw ( FormatError ); + uint32_t ReadInt32() throw ( FormatError ); + void SkipBytes(uint32_t); 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. + /// \brief Swap code gives an information on the byte order of a + /// supposed to be an int32, as it's read on disc + /// (depending on the image Transfer Syntax *and* on the processor endianess) + /// as opposed as it should in memory to be dealt as an int32. + /// For instance : + /// - a 'Little Endian' image, read with a little endian processor + /// will have a SwapCode= 1234 (the order is OK; nothing to do) + /// - a 'Little Endian' image, read with a big endian procesor + /// will have a SwapCode= 4321 (the order is wrong; int32 an int16 must be + /// swapped) + /// note : values 2143, 4321, 3412 remain for the ACR-NEMA time, and + /// the well known 'Bad Big Endian' and 'Bad Little Endian' codes int SwapCode; - /// File Pointer, opened during Header parsing. - std::ifstream* Fp; + ///\brief whether we already parsed group 0002 (Meta Elements) + bool Group0002Parsed; + + ///\brief whether file has a DCM Preamble + bool HasDCMPreamble; + + /// File Pointer, opened during Document 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; - /// \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 + void Initialize(); + // 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 LoadDocEntry (DocEntry *e); + void FindDocEntryLength (DocEntry *e) throw ( FormatError ); + uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected ); std::string FindDocEntryVR(); - bool CheckDocEntryVR (VRKey); - - std::string GetDocEntryValue (DocEntry *); - std::string GetDocEntryUnvalue(DocEntry *); - - void SkipDocEntry (DocEntry *); - void SkipToNextDocEntry (DocEntry *); + bool CheckDocEntryVR (VRKey k); - void FixDocEntryFoundLength(DocEntry *, uint32_t); - bool IsDocEntryAnInteger (DocEntry *); + std::string GetDocEntryValue (DocEntry *entry); + std::string GetDocEntryUnvalue(DocEntry *entry); - uint32_t FindDocEntryLengthOB() throw( FormatUnexpected ); + void SkipDocEntry (DocEntry *entry); + void SkipToNextDocEntry (DocEntry *entry); - 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); + void FixDocEntryFoundLength(DocEntry *entry,uint32_t l); + bool IsDocEntryAnInteger (DocEntry *entry); - void Initialise(); bool CheckSwap(); - void SwitchSwapToBigEndian(); + void SwitchByteSwapCode(); void SetMaxSizeLoadEntry(long); void SetMaxSizePrintEntry(long); // DocEntry related utilities - DocEntry* ReadNextDocEntry(); - - uint32_t GenerateFreeTagKeyInGroup(uint16_t group); - void BuildFlatHashTableRecurse( TagDocEntryHT& builtHT, - DocEntrySet* set ); + DocEntry *ReadNextDocEntry(); - void HandleBrokenEndian(uint16_t group, uint16_t elem); + void HandleBrokenEndian (uint16_t &group, uint16_t &elem); + void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem); // Variables /// Public dictionary used to parse this header - Dict* RefPubDict; - + Dict *RefPubDict; /// \brief Optional "shadow dictionary" (private elements) used to parse /// this header - Dict* RefShaDict; + 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, @@ -266,9 +195,11 @@ private: /// is fixed to 64 bytes. uint32_t MaxSizePrintEntry; -private: - friend class File; +// uint32_t GenerateFreeTagKeyInGroup(uint16_t group); +// void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT, +// DocEntrySet *set ); }; + } // end namespace gdcm //-----------------------------------------------------------------------------