Program: gdcm
Module: $RCSfile: gdcmDocument.h,v $
Language: C++
- Date: $Date: 2004/06/18 12:26:54 $
- Version: $Revision: 1.11 $
+ Date: $Date: 2004/10/24 03:33:41 $
+ Version: $Revision: 1.55 $
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
#include "gdcmException.h"
#include "gdcmDictSet.h"
#include "gdcmDocEntry.h"
-
-class gdcmValEntry;
-class gdcmBinEntry;
-class gdcmSeqEntry;
-
+#include "gdcmRLEFramesInfo.h"
+#include "gdcmJPEGFragmentsInfo.h"
#include "gdcmDocEntrySet.h"
#include "gdcmElementSet.h"
+class ValEntry;
+class BinEntry;
+class SeqEntry;
+
#include <map>
#include <list>
+#include <fstream>
-//-----------------------------------------------------------------------------
-typedef std::string VRKey;
-typedef std::string VRAtr;
-typedef std::map<VRKey, VRAtr> VRHT; // Value Representation Hash Table
+namespace gdcm
+{
+
+enum TransferSyntaxType {
+ ImplicitVRLittleEndian = 0,
+ ExplicitVRLittleEndian,
+ DeflatedExplicitVRLittleEndian,
+ ExplicitVRBigEndian,
+ JPEGBaselineProcess1,
+ JPEGExtendedProcess2_4,
+ JPEGExtendedProcess3_5,
+ JPEGSpectralSelectionProcess6_8,
+ JPEGFullProgressionProcess10_12,
+ JPEGLosslessProcess14,
+ JPEGLosslessProcess14_1,
+ JPEG2000Lossless,
+ JPEG2000,
+ RLELossless,
+ UnknownTS
+};
//-----------------------------------------------------------------------------
/**
- * \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;
+friend class File;
private:
/// Public dictionary used to parse this header
- gdcmDict *RefPubDict;
+ Dict* 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;
+ 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).
- guint32 MaxSizeLoadEntry;
+ 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.
- guint32 MaxSizePrintEntry;
+ uint32_t MaxSizePrintEntry;
protected:
/// Refering underlying filename.
- std::string 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;
+ int SwapCode;
/// File Pointer, opened during Header parsing.
- FILE *fp;
+ std::ifstream* Fp;
/// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
- FileType filetype;
+ 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_PRINT_ELEMENT_VALUE
/// are NOT printed.
/// \todo Currently not used since collides with #define in
- /// \ref gdcmDocEntry.cxx. See also
- /// \ref gdcmDocument::SetMaxSizePrintEntry()
+ /// class DocEntry . See also
+ /// method ref Document::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;
+ /// Store the RLE frames info obtained during parsing of pixels.
+ RLEFramesInfo* RLEInfo;
+
+ /// Store the JPEG fragments info obtained during parsing of pixels.
+ JPEGFragmentsInfo* JPEGInfo;
/// \brief Amount of printed details for each Header Entry (Dicom Element):
/// 0 : stands for the least detail level.
- int printLevel;
+ int PrintLevel;
public:
// the 2 following will be merged
virtual void PrintShaDict (std::ostream &os = std::cout);
// Dictionnaries
- gdcmDict *GetPubDict(void);
- gdcmDict *GetShaDict(void);
- bool SetShaDict(gdcmDict *dict);
- bool SetShaDict(DictKey dictName);
+ Dict* GetPubDict();
+ Dict* GetShaDict();
+ bool SetShaDict(Dict* dict);
+ bool SetShaDict(DictKey const & 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)
- virtual bool Write(FILE *, FileType);
- virtual void WriteEntryTagVRLength(gdcmDocEntry *tag,
- FILE *_fp, FileType type);
- virtual void WriteEntryValue(gdcmDocEntry *tag,FILE *_fp,FileType type);
- virtual bool WriteEntry(gdcmDocEntry *tag,FILE *_fp,FileType type);
- virtual bool WriteEntries(FILE *_fp,FileType type);
-
- 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 bool IsReadable();
+ TransferSyntaxType GetTransferSyntax();
+ bool IsJPEGLossless();
+ bool IsJPEG2000();
+ bool IsJPEG();
+ bool IsEncapsulate();
+ bool IsDicomV3();
+
+ FileType GetFileType();
+
+ std::ifstream * OpenFile();
+ bool CloseFile();
+
+ void Write( std::ofstream* fp, FileType type );
+
+ ValEntry* ReplaceOrCreateByNumber(std::string const & value,
+ uint16_t group, uint16_t elem,
+ std::string const & vr = "unkn");
- virtual void *LoadEntryVoidArea (guint16 Group, guint16 Element);
- void LoadVLEntry (gdcmDocEntry *entry);
+ BinEntry* ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
+ uint16_t group, uint16_t elem,
+ std::string const & vr = "unkn");
+
+ 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);
-// 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
+ // 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
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(const char *inFilename,
- bool exception_on_error = false,
- bool enable_sequences = false,
- bool ignore_shadow = false);
- virtual ~gdcmDocument(void);
+ // to instanciate from this class Document (only Header and
+ // DicomDir are meaningfull).
+ Document();
+ Document( std::string const & filename );
+ virtual ~Document();
- void gdcmDocument::Parse7FE0 (void);
-// Entry
- int CheckIfEntryExistByNumber(guint16 Group, guint16 Elem ); // int !
+ void ReadAndSkipEncapsulatedBasicOffsetTable();
+ void ComputeRLEInfo();
+ void ComputeJPEGFragmentInfo();
+ // Entry
+ bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem );
public:
- virtual std::string GetEntryByName (std::string tagName);
- virtual std::string GetEntryVRByName (std::string 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(void);
-
-// 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 *);
+ 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
+ DocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element);
+ DocEntry* GetDocEntryByName (std::string const & tagName);
+
+ ValEntry* GetValEntryByNumber(uint16_t group, uint16_t element);
+ //BinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element);
+ RLEFramesInfo* GetRLEInfo() { return RLEInfo; }
+ JPEGFragmentsInfo* GetJPEGInfo() { return JPEGInfo; }
+
+ void LoadDocEntrySafe(DocEntry* entry);
+ TagDocEntryHT* BuildFlatHashTable();
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);
+ // 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);
- std::string GetDocEntryValue (gdcmDocEntry *);
- std::string GetDocEntryUnvalue(gdcmDocEntry *);
+ std::string GetDocEntryValue (DocEntry *);
+ std::string GetDocEntryUnvalue(DocEntry *);
- void SkipDocEntry (gdcmDocEntry *);
- void SkipToNextDocEntry (gdcmDocEntry *);
+ void SkipDocEntry (DocEntry *);
+ void SkipToNextDocEntry (DocEntry *);
- void FixDocEntryFoundLength(gdcmDocEntry *, guint32);
- bool IsDocEntryAnInteger (gdcmDocEntry *);
+ void FixDocEntryFoundLength(DocEntry *, uint32_t);
+ bool IsDocEntryAnInteger (DocEntry *);
- guint32 FindDocEntryLengthOB(void);
+ uint32_t FindDocEntryLengthOB() throw( FormatUnexpected );
- guint16 ReadInt16(void);
- guint32 ReadInt32(void);
- void SkipBytes(guint32);
- guint32 ReadTagLength(guint16, guint16);
- guint32 ReadItemTagLength(void);
- guint32 ReadSequenceDelimiterTagLength(void);
+ 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);
- bool CheckSwap(void);
- void SwitchSwapToBigEndian(void);
+ void Initialise();
+ bool CheckSwap();
+ void SwitchSwapToBigEndian();
void SetMaxSizeLoadEntry(long);
void SetMaxSizePrintEntry(long);
- // DictEntry related utilities
-
- gdcmDictEntry *GetDictEntryByName (std::string Name);
- gdcmDictEntry *GetDictEntryByNumber(guint16, guint16);
- gdcmDictEntry *NewVirtualDictEntry(guint16 group,
- guint16 element,
- std::string vr = "unkn",
- std::string fourth = "unkn",
- std::string name = "unkn");
// DocEntry related utilities
- gdcmDocEntry *ReadNextDocEntry (void);
- gdcmDocEntry *NewDocEntryByNumber(guint16 group,
- guint16 element);
- gdcmDocEntry *NewDocEntryByName (std::string Name);
+ DocEntry* ReadNextDocEntry();
+
+ uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
+ void BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
+ DocEntrySet* set );
- gdcmValEntry *NewValEntryByNumber(guint16 group,
- guint16 element);
- gdcmBinEntry *NewBinEntryByNumber(guint16 group,
- guint16 element);
- guint32 GenerateFreeTagKeyInGroup(guint16 group);
public:
// Accessors:
- /// Accessor to \ref printLevel
- void SetPrintLevel(int level) { printLevel = level; };
-
- /// Accessor to \ref filename
- inline std::string GetFileName(void) {return filename;}
+ /// Accessor to \ref PrintLevel
+ void SetPrintLevel(int level) { PrintLevel = level; }
- /// Accessor to \ref filename
- inline void SetFileName(char* fileName) {filename = fileName;}
+ /// Accessor to \ref Filename
+ const std::string &GetFileName() { return Filename; }
- /// Accessor to \ref gdcmElementSet::tagHT
- inline TagDocEntryHT &GetEntry(void) { return tagHT; };
+ /// Accessor to \ref Filename
+ void SetFileName(std::string const & fileName) { Filename = fileName; }
- /// 'Swap code' accessor (see \ref sw )
- inline int GetSwapCode(void) { return sw; }
+ /// 'Swap code' accessor (see \ref SwapCode )
+ int GetSwapCode() { return SwapCode; }
/// File pointer
- inline FILE * GetFP(void) { return fp; }
+ std::ifstream * GetFP() { return Fp; }
- bool operator<(gdcmDocument &document);
+ bool operator<(Document &document);
};
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff