X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmHeader.h;h=2ad78057816677f7b428910537e2bded92137654;hb=c9cba2121fd1226c229ae97686ee2f2d8b158647;hp=0f1c8f32e4b0d6a94310cc1bf7e8f36681fd981d;hpb=565a47ec4e037897aaf770aeccc5d67d7ad7b478;p=gdcm.git diff --git a/src/gdcmHeader.h b/src/gdcmHeader.h index 0f1c8f32..2ad78057 100644 --- a/src/gdcmHeader.h +++ b/src/gdcmHeader.h @@ -1,169 +1,193 @@ -// gdcmHeader.h +// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.h,v 1.28 2003/06/20 14:17:47 jpr Exp $ #ifndef GDCMHEADER_H #define GDCMHEADER_H #include #include "gdcmCommon.h" +#include "gdcmUtil.h" #include "gdcmException.h" #include "gdcmDictSet.h" #include "gdcmElValue.h" #include "gdcmElValSet.h" -//////////////////////////////////////////////////////////////////////////// -// The purpous of an instance of gdcmHeader is to act as a container of -// all the elements and their corresponding values (and additionaly the -// corresponding DICOM dictionary entry) of the header of a DICOM file. -// -// The typical usage of instances of class gdcmHeader is to classify a set of -// dicom files according to header information e.g. to create a file hierarchy -// reflecting the Patient/Study/Serie informations, or extracting a given -// SerieId. Accesing the content (image[s] or volume[s]) is beyond the -// functionality of this class and belong to gdmcFile (see below). -// Notes: -// * the various entries of the explicit value representation (VR) shall -// be managed within a dictionary which is shared by all gdcmHeader instances -// * the gdcmHeader::Set*Tag* family members cannot be defined as protected -// (Swig limitations for as Has_a dependency between gdcmFile and gdcmHeader) - -typedef string VRKey; -typedef string VRAtr; -typedef map VRHT; // Value Representation Hash Table +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 +/// additionaly the corresponding DICOM dictionary entry) of the header +/// of a DICOM file. +/// +/// The typical usage of instances of class gdcmHeader is to classify a set of +/// dicom files according to header information e.g. to create a file hierarchy +/// reflecting the Patient/Study/Serie informations, or extracting a given +/// SerieId. Accesing the content (image[s] or volume[s]) is beyond the +/// functionality of this class and belongs to gdmcFile. +/// \note The various entries of the explicit value representation (VR) shall +/// be managed within a dictionary which is shared by all gdcmHeader +/// instances. +/// \note The gdcmHeader::Set*Tag* family members cannot be defined as +/// protected due to Swig limitations for as Has_a dependency between +/// gdcmFile and gdcmHeader. class GDCM_EXPORT gdcmHeader { - void SkipBytes(guint32); + void SkipBytes(guint32); private: - static VRHT *dicom_vr; - // Dictionaries of data elements: - - gdcmDictSet* Dicts; // global dictionary container - gdcmDict* RefPubDict; // public dictionary - gdcmDict* RefShaDict; // shadow dictionary (optional) - // Parsed element values: - ElValSet PubElVals; // parsed with Public Dictionary - ElValSet ShaElVals; // parsed with Shadow Dictionary - string filename; // refering underlying file - FILE * fp; - guint16 grPixel; - guint16 numPixel; - // Ne faudrait-il pas une indication sur la presence ou non - // du 'groupe des pixels' dans l'entete? - // (voir pb du DICOMDIR) - - // Swap code (little, big, bad-big, bad-little endian): this code is not fixed - // during parsing.FIXME sw should be an enum e.g. - //enum EndianType { - //LittleEndian, - //BadLittleEndian, - //BigEndian, - //BadBigEndian}; - int sw; - - // Only the elements whose size is below this bound will be loaded. - // By default, this upper bound is limited to 1024 (which looks reasonable - // when one considers the definition of the various VR contents). - guint32 MaxSizeLoadElementValue; - - guint16 ReadInt16(void); - guint32 ReadInt32(void); - guint16 SwapShort(guint16); - guint32 SwapLong(guint32); - guint32 FindLengthOB(void); - void Initialise(void); - void CheckSwap(void); - void InitVRDict(void); - void SwitchSwapToBigEndian(void); - void AddAndDefaultElements(void); - void SetMaxSizeLoadElementValue(long); - - gdcmDictEntry * GetDictEntryByKey(guint16, guint16); - gdcmDictEntry * GetDictEntryByName(string name); - - // ElValue related utilities - ElValue * ReadNextElement(void); - ElValue * NewElValueByKey(guint16 group, guint16 element); - ElValue * NewElValueByName(string name); - void FindLength(ElValue *); - void FindVR(ElValue *); - void LoadElementValue(ElValue *); - void LoadElementValueSafe(ElValue *); - void SkipElementValue(ElValue *); - void FixFoundLength(ElValue*, guint32); - bool IsAnInteger(ElValue *); - - 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); - + /// 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 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; + /// 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 + + /// ELement VALueS parsed with the PUBlic dictionary. + gdcmElValSet PubElValSet; + /// ELement VALueS parsed with the SHAdow dictionary. + gdcmElValSet ShaElValSet; + /// Refering underlying filename. + std::string filename; + + // 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); + + 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); + protected: - enum FileType { - Unknown = 0, - TrueDicom, - ExplicitVR, - ImplicitVR, - ACR, - ACR_LIBIDO}; // CLEANME - FileType filetype; - int write(ostream&); - int anonymize(ostream&); // FIXME : anonymize should be a friend ? + FILE * fp; + FileType filetype; + + gdcmElValue * GetElValueByNumber(guint16 group, guint16 element); + + guint16 SwapShort(guint16); // needed by gdcmFile + guint32 SwapLong(guint32); // for JPEG Files :-( + bool OpenFile(bool exception_on_error = false) + throw(gdcmFileError); + bool CloseFile(void); + int write(std::ostream&); + int anonymize(std::ostream&); // FIXME : anonymize should be a friend ? public: - void LoadElements(void); - virtual void ParseHeader(bool exception_on_error = false) - throw(gdcmFormatError); - gdcmHeader(const char *filename, bool exception_on_error = false) - throw(gdcmFileError); - virtual ~gdcmHeader(); - - size_t GetPixelOffset(void); - void GetPixels(size_t, void *); - int GetSwapCode(void) { return sw; } - - // TODO Swig int SetPubDict(string filename); - // When some proprietary shadow groups are disclosed, we can set up - // an additional specific dictionary to access extra information. - // TODO Swig int SetShaDict(string filename); - - // Get the element values themselves: - string GetPubElValByName(string TagName); - string GetPubElValByNumber(guint16 group, guint16 element); - - // Getting the element value representation (VR) might be needed by caller - // to convert the string typed content to caller's native type - // (think of C/C++ vs Python). - - string GetPubElValRepByName(string TagName); - string GetPubElValRepByNumber(guint16 group, guint16 element); - - TagElValueHT & GetPubElVal(void) { return PubElVals.GetTagHt(); }; - void PrintPubElVal(ostream & os = cout); - void PrintPubDict(ostream & os = cout); - - // Same thing with the shadow : - // TODO Swig string* GetShaTagNames(); - string GetShaElValByName(string TagName); - string GetShaElValByNumber(guint16 group, guint16 element); - string GetShaElValRepByName(string TagName); - string GetShaElValRepByNumber(guint16 group, guint16 element); - - // Wrappers of the above (public is privileged over shadow) to avoid - // bugging the caller with knowing if ElVal is from the public or shadow - // dictionary. - string GetElValByName(string TagName); - string GetElValByNumber(guint16 group, guint16 element); - string GetElValRepByName(string TagName); - string GetElValRepByNumber(guint16 group, guint16 element); - - int SetPubElValByName(string content, string TagName); - int SetPubElValByNumber(string content, guint16 group, guint16 element); - int SetShaElValByName(string content, string ShadowTagName); - int SetShaElValByNumber(string content, guint16 group, guint16 element); - - ElValSet GetPubElVals() { return(PubElVals); } + bool IsReadable(void); + 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 IsJPEGLossless(void); + bool IsDicomV3(void); + + virtual void ParseHeader(bool exception_on_error = false) + throw(gdcmFormatError); + gdcmHeader(const char *filename, bool exception_on_error = false); + gdcmHeader( bool exception_on_error = false); + virtual ~gdcmHeader(); + + size_t GetPixelOffset(void); + int GetSwapCode(void) { return sw; } + + // TODO Swig int SetPubDict(std::string filename); + // When some proprietary shadow groups are disclosed, we can set up + // an additional specific dictionary to access extra information. + // TODO Swig int SetShaDict(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); + + TagElValueHT & GetPubElVal(void) { return PubElValSet.GetTagHt(); }; + void PrintPubElVal(std::ostream & os = std::cout); + void PrintPubDict (std::ostream & os = std::cout); + + // TODO Swig std::string* GetShaTagNames(); + std::string GetShaElValByName (std::string TagName); + std::string GetShaElValRepByName (std::string TagName); + std::string GetShaElValByNumber (guint16 group, guint16 element); + std::string GetShaElValRepByNumber(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); + + int SetPubElValByName (std::string content, std::string TagName); + int SetShaElValByName (std::string content, std::string ShadowTagName); + int SetPubElValByNumber(std::string content, guint16 group, guint16 element); + + int SetShaElValByNumber(std::string content, guint16 group, guint16 element); + + int SetPubElValLengthByNumber(guint32 lgr, guint16 group, guint16 element); + + int ReplaceOrCreateByNumber(std::string Value, guint16 Group, guint16 Elem); + int ReplaceOrCreateByNumber(char * Value, guint16 Group, guint16 Elem); + + int GetXSize(void); + int GetYSize(void); + int GetZSize(void); + int GetBitsStored(void); + int GetSamplesPerPixel(void); + int GetPixelSize(void); + std::string GetPixelType(void); + + float GetXSpacing(void); + float GetYSpacing(void); + float GetZSpacing(void); + + float GetXImagePosition(void); + float GetYImagePosition(void); + float GetZImagePosition(void); + + int Write(FILE *, FileType); }; #endif