Program: gdcm
Module: $RCSfile: gdcmDocument.h,v $
Language: C++
- Date: $Date: 2004/07/16 15:18:05 $
- Version: $Revision: 1.22 $
+ Date: $Date: 2005/01/20 16:17:00 $
+ Version: $Revision: 1.95 $
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
#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 <map>
#include <list>
+#include <fstream>
+
+namespace gdcm
+{
+class ValEntry;
+class BinEntry;
+class SeqEntry;
+class Dict;
+class RLEFramesInfo;
+class JPEGFragmentsInfo;
//-----------------------------------------------------------------------------
/**
- * \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;
-
- /// \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:
+// Informations contained in the parser
+ virtual bool IsReadable();
+ FileType GetFileType();
- /// \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;
+ std::string GetTransferSyntax();
+
+ RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
+ JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
-protected:
- /// Refering underlying filename.
- std::string Filename;
+// Dictionaries
+ virtual void PrintPubDict (std::ostream &os = std::cout);
+ virtual void PrintShaDict (std::ostream &os = std::cout);
- /// \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;
+ 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 Document
+ uint32_t SwapLong(uint32_t); // needed by Document
+ uint16_t UnswapShort(uint16_t); // needed by Document
+ uint32_t UnswapLong(uint32_t); // needed by Document
+
+// Ordering of Documents
+ bool operator<(Document &document);
- /// File Pointer, opened during Header parsing.
- FILE *fp;
+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; }
- /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
- FileType Filetype;
+ std::ifstream *OpenFile();
+ bool CloseFile();
+ void WriteContent( std::ofstream *fp, FileType type );
- /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
- static const unsigned int HEADER_LENGTH_TO_READ;
+// Content entries
- /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
- /// are NOT loaded.
- static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
+// Oops ! Python is gonna cry :
+// 4 methods with same name and different parameters ...
+// Only C++ is aware!
- /// \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;
+ virtual bool SetEntry(std::string const &content,
+ uint16_t group, uint16_t elem);
+ virtual bool SetEntry(uint8_t *content, int lgth,
+ uint16_t group, uint16_t elem);
+ virtual bool SetEntry(std::string const &content, ValEntry *entry);
+ virtual bool SetEntry(uint8_t *content, int lgth, BinEntry *entry);
- /// Will be set 1 if user asks to 'go inside' the 'sequences' (VR = "SQ")
- int enableSequences;
+ virtual void *GetEntryBinArea(uint16_t group, uint16_t elem);
- /// \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);
+ virtual std::string GetEntry (uint16_t group, uint16_t elem);
+ virtual std::string GetEntryVR(uint16_t group, uint16_t elem);
+ virtual int GetEntryLength(uint16_t group, uint16_t elem);
-// Dictionnaries
- gdcmDict *GetPubDict();
- gdcmDict *GetShaDict();
- bool SetShaDict(gdcmDict *dict);
- bool SetShaDict(DictKey dictName);
+ ValEntry *ReplaceOrCreate(std::string const &value,
+ uint16_t group, uint16_t elem,
+ TagName const &vr = GDCM_UNKNOWN);
+ BinEntry *ReplaceOrCreate(uint8_t* binArea, int lgth,
+ uint16_t group, uint16_t elem,
+ TagName const &vr = GDCM_UNKNOWN);
+ SeqEntry *ReplaceOrCreate(uint16_t group, uint16_t elem);
-// Informations contained in the parser
- virtual bool IsReadable();
- bool IsGivenTransferSyntax(const std::string & 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();
+ bool ReplaceIfExist(std::string const &value,
+ uint16_t group, uint16_t elem );
- FILE* OpenFile(bool exception_on_error = false) throw(gdcmFileError);
- bool CloseFile();
+ bool CheckIfEntryExist(uint16_t group, uint16_t elem );
+
+ virtual void LoadEntryBinArea(uint16_t group, uint16_t elem);
+ virtual void LoadEntryBinArea(BinEntry *entry);
- void Write(FILE* fp, FileType type);
+ void LoadDocEntrySafe(DocEntry *entry);
+ /*TagDocEntryHT *BuildFlatHashTable();*/
- gdcmValEntry* ReplaceOrCreateByNumber(std::string value,
- uint16_t group, uint16_t elem);
+ /// Return the Transfer Syntax as a string
+ std::string GetTransferSyntaxName();
- gdcmBinEntry* ReplaceOrCreateByNumber(void *voidArea, int lgth,
- uint16_t group, uint16_t elem);
- bool ReplaceIfExistByNumber (const char* value, uint16_t group, uint16_t elem);
-
- virtual void* LoadEntryVoidArea(uint16_t Group, uint16_t Element);
- virtual void* LoadEntryVoidArea(gdcmBinEntry*);
-
- // System access
- 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
+ bool IsDicomV3();
protected:
+// Methods
// 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();
+ // to instanciate from this class Document (only Header and
+ // DicomDir are meaningfull).
+ Document();
+ Document( std::string const &filename );
+ virtual ~Document();
- void gdcmDocument::Parse7FE0 ();
+ void ReadAndSkipEncapsulatedBasicOffsetTable();
+ void ComputeRLEInfo();
+ void ComputeJPEGFragmentInfo();
// Entry
- int CheckIfEntryExistByNumber(uint16_t Group, uint16_t Elem ); // int !
-public:
- virtual std::string GetEntryByName (TagName tagName);
- virtual std::string GetEntryVRByName (TagName tagName);
- virtual std::string GetEntryByNumber (uint16_t group, uint16_t element);
- virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t element);
- virtual int GetEntryLengthByNumber(uint16_t group, uint16_t element);
-protected:
- virtual bool SetEntryByName (std::string content, std::string tagName);
- virtual bool SetEntryByNumber(std::string 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);
+ int ComputeGroup0002Length( FileType filetype );
+
+// Variables
+ /// Refering underlying filename.
+ std::string Filename;
- virtual void UpdateShaEntries();
+ /// \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
+ bool Group0002Parsed;
+
+ ///\brief whether file has a DCM Preamble
+ bool HasDCMPreamble;
+
+ /// File Pointer, opened during Header 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;
- // Header entry
- gdcmDocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element);
- gdcmDocEntry* GetDocEntryByName (std::string Name);
+ /// \brief Elements whose value is longer than MAX_SIZE_PRINT_ELEMENT_VALUE
+ /// are NOT printed.
+ static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
- gdcmValEntry* GetValEntryByNumber(uint16_t group, uint16_t element);
- gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element);
+ /// Store the RLE frames info obtained during parsing of pixels.
+ RLEFramesInfo *RLEInfo;
- void LoadDocEntrySafe(gdcmDocEntry*);
+ /// 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 *);
- 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);
- std::string GetDocEntryValue (gdcmDocEntry *);
- std::string GetDocEntryUnvalue(gdcmDocEntry *);
+ void LoadDocEntry (DocEntry *e);
+ void FindDocEntryLength (DocEntry *e) throw ( FormatError );
+ uint32_t FindDocEntryLengthOBOrOW() throw( FormatUnexpected );
+ std::string FindDocEntryVR();
+ bool CheckDocEntryVR (VRKey k);
- void SkipDocEntry (gdcmDocEntry *);
- void SkipToNextDocEntry (gdcmDocEntry *);
+ std::string GetDocEntryValue (DocEntry *entry);
+ std::string GetDocEntryUnvalue(DocEntry *entry);
- void FixDocEntryFoundLength(gdcmDocEntry *, uint32_t);
- bool IsDocEntryAnInteger (gdcmDocEntry *);
- uint32_t FindDocEntryLengthOB();
+ void SkipDocEntry (DocEntry *entry);
+ void SkipToNextDocEntry (DocEntry *entry);
- uint16_t ReadInt16();
- uint32_t ReadInt32();
+ void FixDocEntryFoundLength(DocEntry *entry,uint32_t l);
+ bool IsDocEntryAnInteger (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 Initialise();
+ void Initialize();
bool CheckSwap();
- void SwitchSwapToBigEndian();
+ void SwitchByteSwapCode();
void SetMaxSizeLoadEntry(long);
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; }
+ void HandleBrokenEndian(uint16_t &group, uint16_t &elem);
+ void HandleOutOfGroup0002(uint16_t &group, uint16_t &elem);
- /// Accessor to \ref Filename
- const std::string &GetFileName() { return Filename; }
-
- /// Accessor to \ref Filename
- void SetFileName(std::string const & fileName) { Filename = fileName; }
-
- /// Accessor to \ref gdcmElementSet::tagHT
- TagDocEntryHT &GetEntry() { return tagHT; };
-
- /// 'Swap code' accessor (see \ref sw )
- int GetSwapCode() { return sw; }
+// 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 FileHelper;
};
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff