Program: gdcm
Module: $RCSfile: gdcmDocument.h,v $
Language: C++
- Date: $Date: 2004/10/06 09:58:08 $
- Version: $Revision: 1.45 $
+ Date: $Date: 2005/06/02 13:42:18 $
+ Version: $Revision: 1.111 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#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"
-
-class gdcmValEntry;
-class gdcmBinEntry;
-class gdcmSeqEntry;
-
-#include "gdcmDocEntrySet.h"
+#include "gdcmDict.h"
#include "gdcmElementSet.h"
+#include "gdcmException.h"
#include <map>
#include <list>
+#include <fstream>
+
+#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;
+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).
- 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;
+typedef std::list<Element> ListElements;
-protected:
- /// Refering underlying filename.
- std::string Filename;
+// Loading
+ virtual bool Load( std::string const &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;
+// Dictionaries
+ Dict *GetPubDict();
+ Dict *GetShaDict();
+ bool SetShaDict(Dict *dict);
+ bool SetShaDict(DictKey const &dictName);
- /// File Pointer, opened during Header parsing.
- FILE *Fp;
+// 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();
- /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
- FileType Filetype;
+// 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);}
+
+// 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; }
- /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
- static const unsigned int HEADER_LENGTH_TO_READ;
+ std::ifstream *OpenFile();
+ bool CloseFile();
+ void WriteContent( std::ofstream *fp, FileType type );
- /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
- /// are NOT loaded.
- static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
+// Content entries
+ virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
+ virtual void LoadEntryBinArea(BinEntry *entry);
- /// \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;
+ void LoadDocEntrySafe(DocEntry *entry);
+
+// Ordering of Documents
+ bool operator<(Document &document);
- /// Store the RLE frames info obtained during parsing of pixels.
- gdcmRLEFramesInfo RLEInfo;
+/**
+ * \brief \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
+ * of each Shadow Group. The paser will fail if the size is wrong !
+ * @param mode Load mode to be used
+ */
+ void SetLoadMode (int mode) { LoadMode = mode; }
- /// \brief Amount of printed details for each Header Entry (Dicom Element):
- /// 0 : stands for the least detail level.
- int PrintLevel;
+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();
-public:
-// the 2 following will be merged
- virtual void PrintPubDict (std::ostream &os = std::cout);
- virtual void PrintShaDict (std::ostream &os = std::cout);
+ uint16_t ReadInt16() throw ( FormatError );
+ uint32_t ReadInt32() throw ( FormatError );
+ void SkipBytes(uint32_t);
+ int ComputeGroup0002Length( FileType filetype );
-// Dictionnaries
- gdcmDict *GetPubDict();
- gdcmDict *GetShaDict();
- bool SetShaDict(gdcmDict *dict);
- bool SetShaDict(DictKey const & dictName);
+// Variables
+ /// Refering underlying filename.
+ std::string Filename;
-// 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();
+ /// \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;
- FileType GetFileType();
+ ///\brief whether we already parsed group 0002 (Meta Elements)
+ bool Group0002Parsed;
- FILE* OpenFile();
- bool CloseFile();
+ ///\brief whether file has a DCM Preamble
+ bool HasDCMPreamble;
- void Write(FILE* fp, FileType type);
+ /// File Pointer, opened during Document parsing.
+ std::ifstream *Fp;
- gdcmValEntry* ReplaceOrCreateByNumber(std::string const & value,
- uint16_t group, uint16_t elem,
- std::string const & VR ="unkn");
-
- gdcmBinEntry* ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
- uint16_t group, uint16_t elem,
- std::string const & VR="unkn");
+ /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
+ FileType Filetype;
- gdcmSeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
+ /// 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;
- bool ReplaceIfExistByNumber ( std::string const & value,
- uint16_t group,
- uint16_t elem );
-
- virtual void* LoadEntryBinArea(uint16_t group, uint16_t elem);
- virtual void* LoadEntryBinArea(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
+ /// List of elements to Anonymize
+ ListElements AnonymizeList;
-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();
+ /// \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;
- 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(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);
-
- virtual void UpdateShaEntries();
-
- // 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);
- TagDocEntryHT* BuildFlatHashTable();
+ /// 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 *) throw ( gdcmFormatError );
- void FindDocEntryVR (gdcmDocEntry *);
- bool CheckDocEntryVR (gdcmDocEntry *, gdcmVRKey);
+// 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 *, uint32_t);
- bool IsDocEntryAnInteger (gdcmDocEntry *);
+ std::string GetDocEntryValue (DocEntry *entry);
+ std::string GetDocEntryUnvalue(DocEntry *entry);
- uint32_t FindDocEntryLengthOB() throw( gdcmFormatUnexpected );
+ void SkipDocEntry (DocEntry *entry);
+ void SkipToNextDocEntry (DocEntry *entry);
- uint16_t ReadInt16() throw ( gdcmFormatError );
- uint32_t ReadInt32() throw ( gdcmFormatError );
- 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
- gdcmDocEntry* ReadNextDocEntry();
-
- uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
- void BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
- gdcmDocEntrySet* set );
+ DocEntry *ReadNextDocEntry();
+ void HandleBrokenEndian (uint16_t &group, uint16_t &elem);
+ void HandleOutOfGroup0002(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; }
+// 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 SwapCode )
- int GetSwapCode() { return SwapCode; }
+ /// \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
- FILE * GetFP() { return Fp; }
-
- bool operator<(gdcmDocument &document);
+// uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
+// void BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
+// DocEntrySet *set );
};
+} // end namespace gdcm
+
//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff