X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmHeader.h;h=58cd9a200b199c8135dfb089e990fd2924ab3418;hb=2908e8e550cb43a54f081c41a94e143f5a9b573e;hp=dff360a72725ae6cc816838dec53d07f5011d7b2;hpb=5a6910a313a526514242a21b868c7186fca14168;p=gdcm.git diff --git a/src/gdcmHeader.h b/src/gdcmHeader.h index dff360a7..58cd9a20 100644 --- a/src/gdcmHeader.h +++ b/src/gdcmHeader.h @@ -1,5 +1,5 @@ -// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.h,v 1.47 2004/01/13 11:32:30 jpr Exp $ - +// gdcmHeader.h +//----------------------------------------------------------------------------- #ifndef GDCMHEADER_H #define GDCMHEADER_H @@ -8,14 +8,16 @@ #include "gdcmTS.h" #include "gdcmException.h" #include "gdcmDictSet.h" -#include "gdcmElValue.h" -#include "gdcmElValSet.h" +#include "gdcmHeaderEntry.h" +#include "gdcmHeaderEntrySet.h" #include +//----------------------------------------------------------------------------- typedef std::string VRKey; typedef std::string VRAtr; typedef std::map VRHT; // Value Representation Hash Table +//----------------------------------------------------------------------------- /* * The purpose of an instance of gdcmHeader is to act as a container of * all the DICOM elements and their corresponding values (and @@ -35,96 +37,16 @@ typedef std::map VRHT; // Value Representation Hash Table * gdcmFile and gdcmHeader. */ class GDCM_EXPORT gdcmHeader { -private: - /// Pointer to the Value Representation Hash Table which contains all - /// the VR of the DICOM version3 public dictionary. - gdcmVR *dicom_vr; // Not a class member for thread-safety reasons - - /// Pointer to the Transfert Syntax Hash Table which contains all - /// the TS of the DICOM version3 public dictionary. - gdcmTS *dicom_ts; // Not a class member for thread-safety reasons - - /// Pointer to global dictionary container - gdcmDictSet *Dicts; // Not a class member for thread-safety reasons - - /// Public dictionary used to parse this header - gdcmDict *RefPubDict; - - /// Optional "shadow dictionary" (private elements) used to parse this - /// header - gdcmDict *RefShaDict; - - /// ELement VALueS parsed with the PUBlic dictionary. - gdcmElValSet PubElValSet; - - /// Refering underlying filename. - std::string filename; - - int enableSequences; - - // FIXME sw should be an enum e.g. - //enum EndianType { - //LittleEndian, - //BadLittleEndian, - //BigEndian, - //BadBigEndian}; - /// Swap code e.g. little, big, bad-big, bad-little endian). Warning: - /// this code is not fixed during header parsing. - int sw; - - /// 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 MaxSizeLoadElementValue; - - guint16 ReadInt16(void); - guint32 ReadInt32(void); - guint32 FindLengthOB(void); - void Initialise(void); - void CheckSwap(void); - void SwitchSwapToBigEndian(void); - // CLEAN ME: NewManualElValToPubDict is NOT called any more. - gdcmElValue *NewManualElValToPubDict(std::string NewTagName, - std::string VR); - void SetMaxSizeLoadElementValue(long); - - gdcmDictEntry *GetDictEntryByNumber(guint16, guint16); - gdcmDictEntry *GetDictEntryByName (std::string Name); - - // ElValue related utilities - gdcmElValue *ReadNextElement(void); - gdcmElValue *NewElValueByNumber(guint16 group, guint16 element); - gdcmElValue *NewElValueByName (std::string Name); - - gdcmElValue* GetElementByName (std::string Name); - // moved from gdcmElValSet - - void FindLength (gdcmElValue *); - void FindVR (gdcmElValue *); - void LoadElementValue (gdcmElValue *); - void LoadElementValueSafe(gdcmElValue *); - void SkipElementValue (gdcmElValue *); - void FixFoundLength (gdcmElValue *, guint32); - bool IsAnInteger (gdcmElValue *); - void LoadElements(void); - void SkipBytes(guint32); - -protected: - FILE * fp; - FileType filetype; // ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown - - gdcmElValue * GetElValueByNumber(guint16 group, guint16 element); - bool CheckIfExistByNumber(guint16 Group, guint16 Elem ); - - int write(std::ostream&); - int anonymize(std::ostream&); // FIXME : anonymize should be a friend ? - public: - FILE *OpenFile(bool exception_on_error = false) - throw(gdcmFileError); - bool CloseFile(void); - FileType GetFileType(void); + gdcmHeader(bool exception_on_error = false); + gdcmHeader(const char *filename, + bool exception_on_error = false, + bool enable_sequences = false); + + virtual ~gdcmHeader(); + +// Standard values and informations contained in the header + inline std::string GetFileName(void) {return filename;} bool IsReadable(void); bool IsImplicitVRLittleEndianTransferSyntax(void); @@ -139,92 +61,185 @@ public: bool IsJPEGLossless(void); bool IsJPEG2000(void); bool IsDicomV3(void); - - virtual void ParseHeader(bool exception_on_error = false) - throw(gdcmFormatError); - - gdcmHeader(bool exception_on_error = false); - gdcmHeader(const char *filename, - bool exception_on_error = false, - bool enable_sequences = false); - - virtual ~gdcmHeader(); + FileType GetFileType(void); - inline std::string GetFileName(void) {return filename;} - + // Some heuristic based accessors, end user intended + // (to be move to gdcmHeaderHelper?) + int GetXSize(void); + int GetYSize(void); + int GetZSize(void); + int GetBitsStored(void); + int GetBitsAllocated(void); + int GetSamplesPerPixel(void); + int GetPlanarConfiguration(void); + + int GetPixelSize(void); + std::string GetPixelType(void); size_t GetPixelOffset(void); size_t GetPixelAreaLength(void); - inline int GetSwapCode(void) { return sw; } - + bool HasLUT(void); + int GetLUTNbits(void); + unsigned char * GetLUTRGBA(void); + + std::string GetTransfertSyntaxName(void); + // When some proprietary shadow groups are disclosed, we can set up // an additional specific dictionary to access extra information. - // OK : we still have *ONE* ElValSet, + // OK : we still have *ONE* HeaderEntrySet, // with both Public and Shadow Elements // parsed against THE Public Dictionary and A (single) Shadow Dictionary // TODO Swig int SetShaDict(std::string filename); // TODO Swig int SetPubDict(std::string filename); - std::string GetPubElValByName (std::string tagName); - std::string GetPubElValRepByName (std::string tagName); - std::string GetPubElValByNumber (guint16 group, guint16 element); - std::string GetPubElValRepByNumber(guint16 group, guint16 element); +// Public element value + std::string GetPubEntryByName (std::string tagName); + std::string GetPubEntryVRByName (std::string tagName); + std::string GetPubEntryByNumber (guint16 group, guint16 element); + std::string GetPubEntryVRByNumber(guint16 group, guint16 element); - size_t GetPubElValOffsetByNumber (guint16 Group, guint16 Elem); - void * GetPubElValVoidAreaByNumber(guint16 Group, guint16 Elem); - void * LoadElementVoidArea (guint16 Group, guint16 Element); - - inline ListTag & GetListElem(void) { return PubElValSet.GetListElem();}; - inline TagElValueHT & GetPubElVal(void) { return PubElValSet.GetTagHt(); }; - - void PrintPubElVal(std::ostream & os = std::cout); - void PrintPubDict (std::ostream & os = std::cout); - - bool SetPubElValByName (std::string content, std::string tagName); - bool SetPubElValByNumber(std::string content, guint16 group, guint16 element); - bool SetPubElValLengthByNumber(guint32 lgr, guint16 group, guint16 element); - - std::string GetElValByName (std::string tagName); - std::string GetElValRepByName (std::string tagName); - std::string GetElValByNumber (guint16 group, guint16 element); - std::string GetElValRepByNumber(guint16 group, guint16 element); - - bool SetElValueByName(std::string content,std::string tagName); - // moved from ElValSet - + bool SetPubEntryByName (std::string content, std::string tagName); + bool SetPubEntryByNumber(std::string content, guint16 group, guint16 element); + bool SetPubEntryLengthByNumber(guint32 lgr, guint16 group, guint16 element); + + inline ListTag & GetPubListEntry(void) { return PubEntrySet.GetListEntry();}; + inline TagHeaderEntryHT & GetPubEntry(void) { return PubEntrySet.GetTagHT(); }; + + void PrintPubEntry(std::ostream & os = std::cout); + void PrintPubDict (std::ostream & os = std::cout); + +// Element value + std::string GetEntryByName (std::string tagName); + std::string GetEntryVRByName (std::string tagName); + std::string GetEntryByNumber (guint16 group, guint16 element); + std::string GetEntryVRByNumber(guint16 group, guint16 element); + + bool SetEntryByName(std::string content,std::string tagName); +// bool SetEntryByNumber(std::string content,guint16 group, guint16 element); + +// inline ListTag & GetListEntry(void) { return PubHeaderEntrySet.GetListElem();}; +// inline TagHeaderEntryHT & GetListEntry(void) { return PubHeaderEntrySet.GetTagHt(); }; + +// Read (used in gdcmFile) + FILE *OpenFile(bool exception_on_error = false) throw(gdcmFileError); + bool CloseFile(void); + virtual void ParseHeader(bool exception_on_error = false) throw(gdcmFormatError); + +// Write (used in gdcmFile) + bool Write(FILE *, FileType); + void SetImageDataSize(size_t ExpectedSize); + 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); - - bool Write(FILE *, FileType); - - // Some heuristic based accessors, end user intended - // (to be move to gdcmHeaderHelper?) - - int GetXSize(void); - int GetYSize(void); - int GetZSize(void); - int GetBitsStored(void); - int GetBitsAllocated(void); - int GetSamplesPerPixel(void); - int GetPlanarConfiguration(void); - int GetPixelSize(void); - - std::string GetPixelType(void); - - std::string GetTransferSyntaxName(void); - bool HasLUT(void); - int GetLUTNbits(void); - unsigned char * GetLUTRGBA(void); - - // voir gdcmFile::SetImageData ?!? - void SetImageDataSize (size_t ExpectedSize); // System access + inline int GetSwapCode(void) { return sw; } guint16 SwapShort(guint16); // needed by gdcmFile guint32 SwapLong(guint32); // for JPEG Files + +protected: + bool CheckIfExistByNumber(guint16 Group, guint16 Elem ); + + gdcmHeaderEntry *GetHeaderEntryByName (std::string Name); + gdcmHeaderEntry *GetHeaderEntryByNumber(guint16 group, guint16 element); + + int write(std::ostream&); + int anonymize(std::ostream&); // FIXME : anonymize should be a friend ? + + size_t GetPubEntryOffsetByNumber (guint16 Group, guint16 Elem); + void * GetPubEntryVoidAreaByNumber(guint16 Group, guint16 Elem); + void * LoadEntryVoidArea (guint16 Group, guint16 Element); + + +// Variables + FILE * fp; + FileType filetype; // ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown + +private: + // Read + void LoadHeaderEntries (void); + void LoadHeaderEntry (gdcmHeaderEntry *); + void LoadHeaderEntrySafe (gdcmHeaderEntry *); + void FindHeaderEntryLength(gdcmHeaderEntry *); + void FindHeaderEntryVR (gdcmHeaderEntry *); + + void SkipHeaderEntry (gdcmHeaderEntry *); + void FixHeaderEntryFoundLength(gdcmHeaderEntry *, guint32); + bool IsHeaderEntryAnInteger (gdcmHeaderEntry *); + + guint32 FindHeaderEntryLengthOB(void); + + guint16 ReadInt16(void); + guint32 ReadInt32(void); + void SkipBytes(guint32); + + void Initialise(void); + void CheckSwap(void); + void SwitchSwapToBigEndian(void); + void SetMaxSizeLoadElementValue(long); + + // Dict + gdcmDictEntry *GetDictEntryByName (std::string Name); + gdcmDictEntry *GetDictEntryByNumber(guint16, guint16); + + // 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); + +// Variables + // Pointer to the Value Representation Hash Table which contains all + // the VR of the DICOM version3 public dictionary. + gdcmVR *dicom_vr; // Not a class member for thread-safety reasons + + // Pointer to the Transfert Syntax Hash Table which contains all + // the TS of the DICOM version3 public dictionary. + gdcmTS *dicom_ts; // Not a class member for thread-safety reasons + + // Pointer to global dictionary container + gdcmDictSet *Dicts; // Not a class member for thread-safety reasons + + // Public dictionary used to parse this header + gdcmDict *RefPubDict; + + // Optional "shadow dictionary" (private elements) used to parse this + // header + gdcmDict *RefShaDict; + + /// ELement VALueS parsed with the PUBlic dictionary. + gdcmHeaderEntrySet PubEntrySet; + + // Refering underlying filename. + std::string filename; + + int enableSequences; + + // FIXME sw should be an enum e.g. + //enum EndianType { + //LittleEndian, + //BadLittleEndian, + //BigEndian, + //BadBigEndian}; + // Swap code e.g. little, big, bad-big, bad-little endian). Warning: + // this code is not fixed during header parsing. + int sw; + + // 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 MaxSizeLoadElementValue; + + static const unsigned int HEADER_LENGTH_TO_READ; + static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE; }; +//----------------------------------------------------------------------------- #endif