-// gdcmDocument.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmDocument.h,v $
+ Language: C++
+ Date: $Date: 2004/07/31 23:30:04 $
+ Version: $Revision: 1.27 $
+
+ 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.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even
+ the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ PURPOSE. See the above copyright notices for more information.
+
+=========================================================================*/
+
#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 "gdcmElementSet.h"
#include <map>
#include <list>
-
-
-//-----------------------------------------------------------------------------
-typedef std::string VRKey;
-typedef std::string VRAtr;
-typedef std::map<VRKey, VRAtr> VRHT; // Value Representation Hash Table
-
-typedef std::map<TagKey, gdcmDocEntry *> TagDocEntryHT;
-typedef std::pair<TagKey, gdcmDocEntry *> PairHT;
-typedef std::pair<TagDocEntryHT::iterator,TagDocEntryHT::iterator> IterHT;
-/// for linking together the Elements
-typedef std::list<gdcmDocEntry *> ListTag;
-
-typedef std::string GroupKey;
-typedef std::map<GroupKey, int> GroupHT;
-
//-----------------------------------------------------------------------------
/**
- * \brief used by both gdcmHeader and gdcmDicomDir
+ * \brief Derived by both gdcmHeader and gdcmDicomDir
*/
class GDCM_EXPORT gdcmDocument : public gdcmElementSet
{
+friend class gdcmFile;
private:
/// Public dictionary used to parse this header
gdcmDict *RefPubDict;
/// \brief Equals =1 if user wants to skip shadow groups while parsing
/// (to save space)
- int ignoreShadow;
+ int IgnoreShadow;
/// \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;
+ FILE *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;
/// \ref gdcmDocument::SetMaxSizePrintEntry()
static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
- /// Hash Table (multimap), to provide fast access
- TagDocEntryHT tagHT;
-
- /// Chained list, to keep the 'spacial' ordering
- ListTag listEntries;
-
/// Will be set 1 if user asks to 'go inside' the 'sequences' (VR = "SQ")
- int enableSequences;
+ int EnableSequences;
/// \brief Amount of printed details for each Header Entry (Dicom Element):
/// 0 : stands for the least detail level.
- int printLevel;
+ int PrintLevel;
public:
-
-
-// Print
- // Canonical Printing method (see also gdcmDocument::SetPrintLevel)
- // virtual void Print (std::ostream &os = std::cout);
- // {PrintEntry(os);};
-
- // no more Print method for gdcmDocument (inherits from gdcmElementSet
- // virtual void PrintEntry (std::ostream &os = std::cout)
- // { return Print(os);};
-
- // the 2 following will be merged
+// 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);
+ gdcmDict *GetPubDict();
+ gdcmDict *GetShaDict();
bool SetShaDict(gdcmDict *dict);
bool SetShaDict(DictKey dictName);
// Informations contained in the parser
- virtual bool IsReadable(void);
- bool IsImplicitVRLittleEndianTransferSyntax(void);
- bool IsExplicitVRLittleEndianTransferSyntax(void);
- bool IsDeflatedExplicitVRLittleEndianTransferSyntax(void);
- bool IsExplicitVRBigEndianTransferSyntax(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);
- void WriteEntriesDeprecated(FILE *_fp,FileType type); // JPR
-
- gdcmDocEntry * ReplaceOrCreateByNumber(std::string Value,
- guint16 Group, guint16 Elem);
- bool ReplaceIfExistByNumber (char *Value, guint16 Group, guint16 Elem);
+ 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();
+
+ FileType GetFileType();
+
+ FILE* OpenFile(bool exception_on_error = false) throw(gdcmFileError);
+ bool CloseFile();
+
+ void Write(FILE* fp, FileType type);
+
+ gdcmValEntry* ReplaceOrCreateByNumber(std::string const & value,
+ uint16_t group, uint16_t elem);
+
+ gdcmBinEntry* ReplaceOrCreateByNumber(void *voidArea, int lgth,
+ uint16_t group, uint16_t elem);
+ bool ReplaceIfExistByNumber (std::string const & value, uint16_t group, uint16_t elem);
- virtual void *LoadEntryVoidArea (guint16 Group, guint16 Element);
- void LoadVLEntry (gdcmDocEntry *entry);
+ virtual void* LoadEntryVoidArea(uint16_t group, uint16_t elem);
+ virtual void* LoadEntryVoidArea(gdcmBinEntry* 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
+ 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
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);
-// Entry
- int CheckIfEntryExistByNumber(guint16 Group, guint16 Elem ); // int !
- 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);
-
+ gdcmDocument(std::string const & filename,
+ bool exception_on_error = false);
+ virtual ~gdcmDocument();
+
+ void Parse7FE0 ();
+ // Entry
+ int CheckIfEntryExistByNumber(uint16_t group, uint16_t elem ); // int !
+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 content, std::string tagName);
virtual bool SetEntryByNumber(std::string content,
- guint16 group, guint16 element);
- virtual bool SetEntryLengthByNumber(guint32 length,
- guint16 group, guint16 element);
+ 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 (guint16 Group, guint16 Elem);
- virtual void *GetEntryVoidAreaByNumber(guint16 Group, guint16 Elem);
- virtual bool SetEntryVoidAreaByNumber(void *a, guint16 Group, guint16 Elem);
+ 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);
- virtual void UpdateShaEntries(void);
+ virtual void UpdateShaEntries();
-// Header entry
- gdcmDocEntry *GetDocEntryByNumber (guint16 group, guint16 element);
- gdcmDocEntry *GetDocEntryByName (std::string Name);
- IterHT GetDocEntrySameNumber(guint16 group, guint16 element);
-// IterHT GetDocEntrySameName (std::string Name);
+ // Header entry
+ gdcmDocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element);
+ gdcmDocEntry* GetDocEntryByName (std::string const & tagName);
- void LoadDocEntrySafe(gdcmDocEntry *);
+ gdcmValEntry* GetValEntryByNumber(uint16_t group, uint16_t element);
+ gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element);
- // Probabely useless
- //void UpdateGroupLength(bool SkipSequence = false,
- // FileType type = ImplicitVR);
+ void LoadDocEntrySafe(gdcmDocEntry* entry);
- //void AddDocEntry (gdcmDocEntry *);
-
-
private:
// Read
- //bool LoadHeaderEntries(bool exception_on_error = false) throw(gdcmFormatError);
- // remplacé par ParseDES.
- // What about exception_on_error ?
-
- long ParseDES(gdcmDocEntrySet *set, long offset, long l_max, bool delim_mode);
- long ParseSQ(gdcmDocEntrySet *set, long offset, long l_max, bool delim_mode);
-
+ 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);
+ bool CheckDocEntryVR (gdcmDocEntry *, gdcmVRKey);
std::string GetDocEntryValue (gdcmDocEntry *);
std::string GetDocEntryUnvalue(gdcmDocEntry *);
void SkipDocEntry (gdcmDocEntry *);
void SkipToNextDocEntry (gdcmDocEntry *);
- void FixDocEntryFoundLength(gdcmDocEntry *, guint32);
+ void FixDocEntryFoundLength(gdcmDocEntry *, uint32_t);
bool IsDocEntryAnInteger (gdcmDocEntry *);
- guint32 FindDocEntryLengthOB(void);
+ uint32_t FindDocEntryLengthOB();
- guint16 ReadInt16(void);
- guint32 ReadInt32(void);
- void SkipBytes(guint32);
+ uint16_t ReadInt16();
+ uint32_t ReadInt32();
+ 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");
- //gdcmDictEntry *NewVirtualDictEntry(gdcmDocEntry *); // never defined
-
// DocEntry related utilities
-
- gdcmDocEntry *ReadNextDocEntry (void);
- gdcmDocEntry *NewDocEntryByNumber(guint16 group,
- guint16 element);
- gdcmDocEntry *NewDocEntryByName (std::string Name);
-
- // Deprecated (Not used) --> commented out
- //gdcmDocEntry *NewManualDocEntryToPubDict(std::string NewTagName,
- // std::string VR);
-
- guint32 GenerateFreeTagKeyInGroup(guint16 group);
+ gdcmDocEntry* ReadNextDocEntry();
+
+ uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
public:
// Accessors:
/// Accessor to \ref printLevel
- void SetPrintLevel(int level) { printLevel = level; };
-
- /// Accessor to \ref filename
- inline std::string GetFileName(void) {return filename;}
+ 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 gdcmDocument::tagHT
- inline TagDocEntryHT &GetEntry(void) { return tagHT; };
-
- /// Accessor to \ref gdcmDocument::listEntries
- inline ListTag &GetListEntry(void) { return listEntries; };
+ /// Accessor to \ref Filename
+ void SetFileName(std::string const & fileName) { Filename = fileName; }
/// 'Swap code' accessor (see \ref sw )
- inline int GetSwapCode(void) { return sw; }
+ int GetSwapCode() { return SwapCode; }
/// File pointer
- inline FILE * GetFP(void) { return fp; }
+ FILE * GetFP() { return Fp; }
+
+ bool operator<(gdcmDocument &document);
};