#define GDCMPARSER_H
#include "gdcmCommon.h"
+
#include "gdcmVR.h"
#include "gdcmTS.h"
#include "gdcmException.h"
#include "gdcmHeaderEntry.h"
#include <map>
-#include <list> // for linking together *all* the Dicom Elements
+#include <list>
+
+
//-----------------------------------------------------------------------------
typedef std::string VRKey;
typedef std::multimap<TagKey, gdcmHeaderEntry *> TagHeaderEntryHT;
typedef std::pair<TagKey, gdcmHeaderEntry *> PairHT;
typedef std::pair<TagHeaderEntryHT::iterator,TagHeaderEntryHT::iterator> IterHT;
-
-typedef std::list<gdcmHeaderEntry *> ListTag; // for linking together the Elements
+/// for linking together the Elements
+typedef std::list<gdcmHeaderEntry *> ListTag;
typedef std::string GroupKey;
typedef std::map<GroupKey, int> GroupHT;
//-----------------------------------------------------------------------------
-/*
- * \defgroup gdcmParser
+/**
* \brief used by both gdcmHeader and gdcmDicomDir
*/
class GDCM_EXPORT gdcmParser
{
+private:
+ /// Public dictionary used to parse this header
+ gdcmDict *RefPubDict;
+
+ /// \brief Optional "shadow dictionary" (private elements) used to parse
+ /// this header
+ gdcmDict *RefShaDict;
+
+ /// Equals 1 if a gdcmHeaderEntry was added post parsing
+ int wasUpdated;
+
+ /// \brief Equals =1 if user wants to skip shadow groups while parsing
+ /// (to save space)
+ 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;
+
+ /// \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;
+
+protected:
+ /// 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;
+
+ /// 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 gdcmHeaderEntry.cxx. See also
+ /// \ref gdcmParser::SetMaxSizePrintEntry()
+ static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
+
+ /// Hash Table (multimap), to provide fast access
+ TagHeaderEntryHT 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;
+
+ /// \brief Amount of printed details for each Header Entry (Dicom Element):
+ /// 0 : stands for the least detail level.
+ int printLevel;
+
public:
- gdcmParser(bool exception_on_error = false);
- gdcmParser(const char *filename,
- bool exception_on_error = false,
- bool enable_sequences = false,
- bool ignore_shadow = false);
- virtual ~gdcmParser(void);
+
// Print
- /**
- * \ingroup gdcmParser
- * \brief Sets the print level for the Dicom Header
- * \note 0 for Light Print; 1 for 'medium' Print, 2 for Heavy
- */
- void SetPrintLevel(int level) { printLevel = level; };
- virtual void PrintEntry (std::ostream &os = std::cout);
+ /// Canonical Printing method (see also gdcmParser::SetPrintLevel)
+ virtual void Print (std::ostream &os = std::cout)
+ {PrintEntry(os);};
+ virtual void PrintEntry (std::ostream &os = std::cout);
+
+ // the 2 following will be merged
virtual void PrintPubDict (std::ostream &os = std::cout);
virtual void PrintShaDict (std::ostream &os = std::cout);
-// Standard values
- inline std::string GetFileName(void) {return filename;}
-
// Dictionnaries
gdcmDict *GetPubDict(void);
gdcmDict *GetShaDict(void);
bool IsExplicitVRBigEndianTransferSyntax(void);
FileType GetFileType(void);
-// Entries
- /**
- * \ingroup gdcmHeader
- * \brief returns a ref to the Dicom Header H table (multimap)
- * return the Dicom Header H table
- */
- inline TagHeaderEntryHT &GetEntry(void) { return tagHT; };
-
- /**
- * \ingroup gdcmHeader
- * \brief returns a ref to the Dicom Header chained list
- * return the Dicom Header chained list
- */
- inline ListTag &GetListEntry(void) { return listEntries; };
-
-// Read (used in gdcmFile)
+// Read (used in gdcmFile, gdcmDicomDir)
FILE *OpenFile(bool exception_on_error = false) throw(gdcmFileError);
bool CloseFile(void);
-// Write (used in gdcmFile)
+// Write (used in gdcmFile, gdcmDicomDir)
virtual bool Write(FILE *, FileType);
+ virtual void WriteEntryTagVRLength(gdcmHeaderEntry *tag,
+ FILE *_fp, FileType type);
+ virtual void WriteEntryValue(gdcmHeaderEntry *tag,FILE *_fp,FileType type);
+ virtual bool WriteEntry(gdcmHeaderEntry *tag,FILE *_fp,FileType type);
+ virtual bool WriteEntries(FILE *_fp,FileType type);
+ void WriteEntriesDeprecated(FILE *_fp,FileType type); // JPR
- bool ReplaceOrCreateByNumber(std::string Value, guint16 Group, guint16 Elem);
- bool ReplaceOrCreateByNumber( char *Value, guint16 Group, guint16 Elem);
- bool ReplaceIfExistByNumber ( char *Value, guint16 Group, guint16 Elem);
+ gdcmHeaderEntry * ReplaceOrCreateByNumber(std::string Value,
+ guint16 Group, guint16 Elem);
+ bool ReplaceIfExistByNumber (char *Value, guint16 Group, guint16 Elem);
// System access
- inline int GetSwapCode(void) { return sw; }
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 gdcmParser (only gdcmHeader and
+ // gdcmDicomDir are meaningfull).
+ gdcmParser(bool exception_on_error = false);
+ gdcmParser(const char *inFilename,
+ bool exception_on_error = false,
+ bool enable_sequences = false,
+ bool ignore_shadow = false);
+ virtual ~gdcmParser(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);
virtual bool SetEntryByName (std::string content, std::string tagName);
- virtual bool SetEntryByNumber(std::string content, guint16 group, guint16 element);
- virtual bool SetEntryLengthByNumber(guint32 l, guint16 group, guint16 element);
+ virtual bool SetEntryByNumber(std::string content,
+ 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);
void LoadHeaderEntrySafe(gdcmHeaderEntry *);
- void UpdateGroupLength(bool SkipSequence = false, FileType type = ImplicitVR);
- void WriteEntries(FileType type, FILE *);
-
-// Variables
- FILE *fp;
- FileType filetype; // ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
+ void UpdateGroupLength(bool SkipSequence = false,
+ FileType type = ImplicitVR);
- static const unsigned int HEADER_LENGTH_TO_READ;
- static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
- static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
-
-protected:
- int enableSequences;
- int printLevel;
-
- TagHeaderEntryHT tagHT; // H Table (multimap), to provide fast access
- ListTag listEntries; // chained list, to keep the 'spacial' ordering
+ void AddHeaderEntry (gdcmHeaderEntry *);
+
private:
// Read
- void Parse(bool exception_on_error = false) throw(gdcmFormatError);
+ bool LoadHeaderEntries(bool exception_on_error = false) throw(gdcmFormatError);
- void LoadHeaderEntries (void);
void LoadHeaderEntry (gdcmHeaderEntry *);
- void AddHeaderEntry (gdcmHeaderEntry *);
void FindHeaderEntryLength(gdcmHeaderEntry *);
void FindHeaderEntryVR (gdcmHeaderEntry *);
bool CheckHeaderEntryVR (gdcmHeaderEntry *, VRKey);
void SkipBytes(guint32);
void Initialise(void);
- void CheckSwap(void);
+ bool CheckSwap(void);
void SwitchSwapToBigEndian(void);
void SetMaxSizeLoadEntry(long);
void SetMaxSizePrintEntry(long);
gdcmDictEntry *GetDictEntryByNumber(guint16, guint16);
gdcmDictEntry *NewVirtualDictEntry(guint16 group,
guint16 element,
- std::string vr = "Unknown",
- std::string fourth = "Unknown",
- std::string name = "Unknown");
- gdcmDictEntry *NewVirtualDictEntry(gdcmHeaderEntry *);
+ std::string vr = "unkn",
+ std::string fourth = "unkn",
+ std::string name = "unkn");
+ //gdcmDictEntry *NewVirtualDictEntry(gdcmHeaderEntry *); // never defined
// HeaderEntry related utilities
+
gdcmHeaderEntry *ReadNextHeaderEntry (void);
gdcmHeaderEntry *NewHeaderEntryByNumber(guint16 group,
guint16 element);
gdcmHeaderEntry *NewHeaderEntryByName (std::string Name);
-
-
- // Deprecated (Not used)
- gdcmHeaderEntry *NewManualHeaderEntryToPubDict(std::string NewTagName,
- std::string VR);
+
+ // Deprecated (Not used) --> commented out
+ //gdcmHeaderEntry *NewManualHeaderEntryToPubDict(std::string NewTagName,
+ // std::string VR);
+
guint32 GenerateFreeTagKeyInGroup(guint16 group);
- // Refering underlying filename.
- std::string filename;
+public:
+// Accessors:
+ /// Accessor to \ref printLevel
+ void SetPrintLevel(int level) { printLevel = level; };
- // Public dictionary used to parse this header
- gdcmDict *RefPubDict;
- // Optional "shadow dictionary" (private elements) used to parse this header
- gdcmDict *RefShaDict;
+ /// Accessor to \ref filename
+ inline std::string GetFileName(void) {return filename;}
- // = 1 if a gdcmHeaderEntry was added post parsing
- int wasUpdated;
-
- // =1 if user wants to skip shadow groups while parsing (to save space)
- int ignoreShadow;
+ /// Accessor to \ref filename
+ inline void SetFileName(char* fileName) {filename = fileName;}
- // Swap code e.g. little, big, bad-big, bad-little endian). Warning:
- // this code is not fixed during header parsing.
- int sw;
+ /// Accessor to \ref gdcmParser::tagHT
+ inline TagHeaderEntryHT &GetEntry(void) { return tagHT; };
- // Size treshold 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;
- // Size treshold 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;
+ /// Accessor to \ref gdcmParser::listEntries
+ inline ListTag &GetListEntry(void) { return listEntries; };
+ /// 'Swap code' accessor (see \ref sw )
+ inline int GetSwapCode(void) { return sw; }
};
//-----------------------------------------------------------------------------
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff