X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmParser.h;h=4cd3311e1dcd786ea76cce72b28a04b247f0a41f;hb=7e26a215ebdc5467ec4354a926222058dfaf9344;hp=8767a1d4b99e13fe0880b971bbbd796508af533f;hpb=55d77e0913ff360d639af1841c70d14dc8687584;p=gdcm.git diff --git a/src/gdcmParser.h b/src/gdcmParser.h index 8767a1d4..4cd3311e 100644 --- a/src/gdcmParser.h +++ b/src/gdcmParser.h @@ -11,7 +11,7 @@ #include "gdcmHeaderEntry.h" #include -#include // for linking together *all* the Dicom Elements +#include //----------------------------------------------------------------------------- typedef std::string VRKey; @@ -21,54 +21,97 @@ typedef std::map VRHT; // Value Representation Hash Table typedef std::multimap TagHeaderEntryHT; typedef std::pair PairHT; typedef std::pair IterHT; - -typedef std::list ListTag; // for linking together the Elements +/// for linking together the Elements +typedef std::list ListTag; typedef std::string GroupKey; typedef std::map GroupHT; //----------------------------------------------------------------------------- -/* - * \defgroup gdcmParser +/** * \brief used by both gdcmHeader and gdcmDicomDir */ class GDCM_EXPORT gdcmParser { +private: + /// Public dictionary used to parse this header + gdcmDict *RefPubDict; + + /// Optional "shadow dictionary" (private elements) used to parse + /// this header + gdcmDict *RefShaDict; + + /// Equals 1 if a gdcmHeaderEntry was added post parsing + int wasUpdated; + + /// Equals =1 if user wants to skip shadow groups while parsing + /// (to save space) + int ignoreShadow; + + /// 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; + + /// 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; + + /// 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; + + /// Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE + /// are NOT loaded. + static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE; + + /// Elements whose value is longer than MAX_SIZE_PRINT_ELEMENT_VALUE + /// are NOT printed. + 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; + + /// 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 *inFilename, - 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; }; - /** - * \ingroup gdcmParser - * \brief canonical Printer - * \sa SetPrintLevel - */ + /// 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); + virtual void PrintEntry (std::ostream &os = std::cout); + virtual void PrintEntryNoSQ (std::ostream &os = std::cout); + virtual void PrintEntryNiceSQ(std::ostream &os = std::cout); + virtual void PrintPubDict (std::ostream &os = std::cout); virtual void PrintShaDict (std::ostream &os = std::cout); -// Standard values - /** - * \ingroup gdcmParser - * \brief Gets the external File Name - */ - inline std::string GetFileName(void) - {return filename;} - // Dictionnaries gdcmDict *GetPubDict(void); gdcmDict *GetShaDict(void); @@ -83,49 +126,39 @@ public: 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, 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(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 - /** - * \ingroup gdcmHeader - * \brief returns the 'swap code' - * (Big Endian, Little Endian, - * Bad Big Endian, Bad Little Endian) - * according to the processor Endianity and what's written on disc - * return - */ - 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); @@ -135,8 +168,10 @@ protected: 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 length, 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); @@ -153,64 +188,11 @@ protected: void LoadHeaderEntrySafe(gdcmHeaderEntry *); - void UpdateGroupLength(bool SkipSequence = false, FileType type = ImplicitVR); - void WriteEntry(gdcmHeaderEntry *tag,FILE *_fp,FileType type); - void WriteEntries(FILE *_fp,FileType type); - void WriteEntriesDeprecated(FILE *_fp,FileType type); // JPR + void UpdateGroupLength(bool SkipSequence = false, + FileType type = ImplicitVR); void AddHeaderEntry (gdcmHeaderEntry *); - -// Variables - /** - * \brief File Pointer, open during Header parsing - */ - FILE *fp; - /** - * \brief ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown - */ - FileType filetype; - - 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: - /** - * \brief H Table (multimap), to provide fast access - */ - TagHeaderEntryHT tagHT; - /** - * \brief chained list, to keep the 'spacial' ordering - */ - ListTag listEntries; - /** - * \brief 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 : the least - */ - int printLevel; - /** - * \brief For some ACR-NEMA images, it's *not* 7fe0 ... - */ - guint16 GrPixel; - - /** - * \brief For some ACR-NEMA images, it's *not* 0010 ... - */ - guint16 NumPixel; - /** - * \brief some files may contain icons; GrPixel,NumPixel appears several times - * Let's remember how many times! - */ - int countGrPixel; - /** - * \brief = true when the 'pixel Element' is reached during writting process - */ - bool itsTimeToWritePixels; private: // Read @@ -257,59 +239,32 @@ private: gdcmHeaderEntry *NewHeaderEntryByNumber(guint16 group, guint16 element); gdcmHeaderEntry *NewHeaderEntryByName (std::string Name); - - + // Deprecated (Not used) --> commented out //gdcmHeaderEntry *NewManualHeaderEntryToPubDict(std::string NewTagName, - // std::string VR); + // std::string VR); guint32 GenerateFreeTagKeyInGroup(guint16 group); - /** - * \brief Refering underlying filename. - */ - std::string filename; +public: +// Accessors: + /// Accessor to \ref printLevel + void SetPrintLevel(int level) { printLevel = level; }; - /** - * \brief Public dictionary used to parse this header - */ - gdcmDict *RefPubDict; - - /** - * \brief Optional "shadow dictionary" (private elements) used to parse this header - */ - gdcmDict *RefShaDict; + /// Accessor to \ref filename + inline std::string GetFileName(void) {return filename;} - /** - * \brief = 1 if a gdcmHeaderEntry was added post parsing - */ - int wasUpdated; - - /** - * \brief =1 if user wants to skip shadow groups while parsing (to save space) - */ - int ignoreShadow; - - /** - * \brief Swap code e.g. little, big, bad-big, bad-little endian). - * \warning : this code is not fixed during header parsing. - */ - int sw; - /** - * \brief 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; - - /** - * \brief 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 filename + inline void SetFileName(char* fileName) {filename = fileName;} + + /// Accessor to \ref gdcmParser::tagHT + inline TagHeaderEntryHT &GetEntry(void) { return tagHT; }; + + /// Accessor to \ref gdcmParser::listEntries + inline ListTag &GetListEntry(void) { return listEntries; }; + + /// 'Swap code' accessor (see \ref sw ) + inline int GetSwapCode(void) { return sw; } }; //-----------------------------------------------------------------------------