X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.h;h=d164af6a55497bedd792c2c64d74901d613cbbdc;hb=45445e6cca75418b05b42dffd8a313237f112539;hp=c5354856ad626e8ac6548639e15ddf731efd6c89;hpb=7dc5d2730be40a107d58bacdcb26e2f4514e5234;p=gdcm.git diff --git a/src/gdcmDocument.h b/src/gdcmDocument.h index c5354856..d164af6a 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/06/25 17:48:45 $ - Version: $Revision: 1.16 $ + Date: $Date: 2005/06/03 09:05:15 $ + Version: $Revision: 1.112 $ 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,255 +19,212 @@ #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 "gdcmException.h" #include #include +#include -//----------------------------------------------------------------------------- -typedef std::string VRKey; -typedef std::string VRAtr; -typedef std::map VRHT; // Value Representation Hash Table +#define NO_SEQ 0x0000001 +#define NO_SHADOW 0x00000002 + +namespace gdcm +{ +class ValEntry; +class BinEntry; +class SeqEntry; +class Dict; //----------------------------------------------------------------------------- /** - * \brief Derived by both gdcmHeader and gdcmDicomDir + * \brief Derived by both gdcm::File and gdcm::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; - - /// \brief Optional "shadow dictionary" (private elements) used to parse - /// this header - gdcmDict *RefShaDict; - - /// \brief Equals =1 if user wants to skip shadow groups while parsing - /// (to save space) - int IgnoreShadow; +public: - /// \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; +typedef std::list ListElements; + +// Loading + virtual bool Load( std::string const &filename ); + +// Dictionaries + Dict *GetPubDict(); + Dict *GetShaDict(); + bool SetShaDict(Dict *dict); + 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); + 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);} - /// \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; +// 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 void LoadEntryBinArea(uint16_t group, uint16_t elem); + virtual void LoadEntryBinArea(BinEntry *entry); + + void LoadDocEntrySafe(DocEntry *entry); + +// Ordering of Documents + bool operator<(Document &document); + +/** + * \brief Sets the LoadMode as a boolean string. + * NO_SEQ, NO_SHADOW, ... (nothing more, right now) + * WARNING : before using NO_SHADOW, be sure *all* your files + * contain accurate values in the 0x0000 element (if any) + * of *each* Shadow Group. The parser will fail if the size is wrong ! + * @param mode Load mode to be used + */ + void SetLoadMode (int mode) { LoadMode = mode; } protected: +// Methods + // Constructor and destructor are protected to forbid end user + // to instanciate from this class Document (only gdcm::File and + // gdcm::DicomDir are meaningfull). + Document(); + Document( std::string const &filename ); + virtual ~Document(); + + 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. - int sw; - - /// File Pointer, opened during Header parsing. - FILE *fp; + /// \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; + + ///\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 - /// \ref gdcmDocEntry.cxx. See also - /// \ref gdcmDocument::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; + /// List of elements to Anonymize + ListElements AnonymizeList; - /// \brief Amount of printed details for each Header Entry (Dicom Element): - /// 0 : stands for the least detail level. - int printLevel; + /// \brief Bit string integer (each one considered as a boolean) + /// Bit 0 : Skip Sequences, if possible + /// Bit 1 : Skip Shadow Groups if possible + /// Some more to add + int LoadMode; -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(void); - gdcmDict *GetShaDict(void); - bool SetShaDict(gdcmDict *dict); - bool SetShaDict(DictKey dictName); - -// 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) - FILE *OpenFile(bool exception_on_error = false) throw(gdcmFileError); - bool CloseFile(void); - -// Write (used in gdcmFile, gdcmDicomDir) - - void Write(FILE * fp,FileType type); // New stuff, with recursive exploration - - 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); - - 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 - guint32 UnswapLong(guint32); // 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(std::string const & inFilename, - bool exception_on_error = false, - bool enable_sequences = false, - bool ignore_shadow = false); - virtual ~gdcmDocument(void); - - void gdcmDocument::Parse7FE0 (void); - // Entry - int CheckIfEntryExistByNumber(guint16 Group, guint16 Elem ); // int ! -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 bool SetEntryVoidAreaByNumber(void *a, guint16 Group, guint16 Elem); - - virtual void UpdateShaEntries(); - - // 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); - - void LoadDocEntrySafe(gdcmDocEntry *); + /// Whether the gdcm::Document is already parsed/loaded + /// - False from the creation of the gdcm::Document untill + /// gdcm::Document:Load() + bool IsDocumentAlreadyLoaded; private: - // 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); +// Methods + void Initialize(); - std::string GetDocEntryValue (gdcmDocEntry *); - std::string GetDocEntryUnvalue(gdcmDocEntry *); + // 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 SkipDocEntry (gdcmDocEntry *); - void SkipToNextDocEntry (gdcmDocEntry *); + void LoadDocEntry (DocEntry *e); + void FindDocEntryLength (DocEntry *e) throw ( FormatError ); + uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected ); + std::string FindDocEntryVR(); + bool CheckDocEntryVR (VRKey k); - void FixDocEntryFoundLength(gdcmDocEntry *, guint32); - bool IsDocEntryAnInteger (gdcmDocEntry *); + std::string GetDocEntryValue (DocEntry *entry); + std::string GetDocEntryUnvalue(DocEntry *entry); - guint32 FindDocEntryLengthOB(); + void SkipDocEntry (DocEntry *entry); + void SkipToNextDocEntry (DocEntry *entry); - guint16 ReadInt16(); - guint32 ReadInt32(); - void SkipBytes(guint32); - guint32 ReadTagLength(guint16, guint16); - guint32 ReadItemTagLength(); - guint32 ReadSequenceDelimiterTagLength(); + 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 - gdcmDocEntry *ReadNextDocEntry (); - - - guint32 GenerateFreeTagKeyInGroup(guint16 group); - -public: -// Accessors: - /// Accessor to \ref printLevel - inline void SetPrintLevel(int level) { printLevel = level; } - - /// Accessor to \ref filename - inline std::string &GetFileName() { return Filename; } + DocEntry *ReadNextDocEntry(); - /// Accessor to \ref filename - inline void SetFileName(const char* fileName) { Filename = fileName; } + void HandleBrokenEndian (uint16_t &group, uint16_t &elem); + void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem); - /// Accessor to \ref gdcmElementSet::tagHT - inline TagDocEntryHT &GetEntry() { return tagHT; }; +// Variables + /// Public dictionary used to parse this header + Dict *RefPubDict; + /// \brief Optional "shadow dictionary" (private elements) used to parse + /// this header + Dict *RefShaDict; - /// 'Swap code' accessor (see \ref sw ) - inline int GetSwapCode() { return sw; } + /// \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; - /// File pointer - inline FILE * GetFP() { return fp; } - - bool operator<(gdcmDocument &document); +// uint32_t GenerateFreeTagKeyInGroup(uint16_t group); +// void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT, +// DocEntrySet *set ); }; +} // end namespace gdcm + //----------------------------------------------------------------------------- #endif