X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmHeader.h;h=7c486e83ff73f4f51cde6eddf92467db5742a200;hb=27c61aa23c3f02def28d44dca855e54d9adb25a1;hp=cf1918e6c0e300058725943656b0d929f76fe5f1;hpb=b158878c883def8179e3eccc27fcea5bb6035a4c;p=gdcm.git diff --git a/src/gdcmHeader.h b/src/gdcmHeader.h index cf1918e6..7c486e83 100644 --- a/src/gdcmHeader.h +++ b/src/gdcmHeader.h @@ -1,126 +1,45 @@ -// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.h,v 1.35 2003/07/23 08:43:03 jpr Exp $ - +// gdcmHeader.h +//----------------------------------------------------------------------------- #ifndef GDCMHEADER_H #define GDCMHEADER_H -#include #include "gdcmCommon.h" -#include "gdcmVR.h" -#include "gdcmTS.h" -#include "gdcmException.h" -#include "gdcmDictSet.h" -#include "gdcmElValue.h" -#include "gdcmElValSet.h" - -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); -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 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: - FILE * fp; - FileType filetype; - - gdcmElValue * GetElValueByNumber(guint16 group, guint16 element); - int CheckIfExistByNumber(guint16 Group, guint16 Elem ); - - 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 ? +#include "gdcmParser.h" + +//----------------------------------------------------------------------------- +/* + * \defgroup gdcmHeader + * \brief + * 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. Accessing 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 : public gdcmParser +{ public: - bool IsReadable(void); - bool IsImplicitVRLittleEndianTransferSyntax(void); - bool IsExplicitVRLittleEndianTransferSyntax(void); - bool IsDeflatedExplicitVRLittleEndianTransferSyntax(void); - bool IsExplicitVRBigEndianTransferSyntax(void); + gdcmHeader(bool exception_on_error = false); + gdcmHeader(const char *filename, + bool exception_on_error = false, + bool enable_sequences = false, + bool skip_shadow = false); + + virtual ~gdcmHeader(); + +// Standard values and informations contained in the header + virtual bool IsReadable(void); bool IsJPEGBaseLineProcess1TransferSyntax(void); bool IsJPEGExtendedProcess2_4TransferSyntax(void); bool IsJPEGExtendedProcess3_5TransferSyntax(void); @@ -129,91 +48,71 @@ public: bool IsJPEGLossless(void); bool IsJPEG2000(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(); - - std::string GetFileName(void) {return filename;} - - 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); - - size_t GetPubElValOffsetByNumber(guint16 Group, guint16 Elem); - void * GetPubElValVoidAreaByNumber(guint16 Group, guint16 Elem); - void * LoadElementVoidArea(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 ReplaceIfExistByNumber ( char * Value, guint16 Group, guint16 Elem); - - int Write(FILE *, FileType); - - // Some heuristic based accessors, end user intended - - int GetXSize(void); + // 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 GetSamplesPerPixel(void); - + int GetBitsAllocated(void); + int GetSamplesPerPixel(void); int GetPlanarConfiguration(void); - int GetPixelSize(void); + int GetPixelSize(void); std::string GetPixelType(void); + size_t GetPixelOffset(void); + size_t GetPixelAreaLength(void); + + 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. - float GetXSpacing(void); - float GetYSpacing(void); - float GetZSpacing(void); - - float GetXImagePosition(void); - float GetYImagePosition(void); - float GetZImagePosition(void); + // OK : we still have *ONE* HeaderEntrySet, + // with both Public and Shadow Elements + // parsed against THE Public Dictionary and A (single) Shadow Dictionary - string GetTransferSyntaxName(void); - int GetLUTLength(void); - int GetLUTNbits(void); - void * GetLUTRed(void); - void * GetLUTGreen(void); - void * GetLUTBlue(void); - void * GetLUTRGB(void); - + // TODO Swig int SetShaDict(std::string filename); + // TODO Swig int SetPubDict(std::string filename); + +// Entry + + inline virtual std::string GetEntryByNumber (guint16 group, guint16 element) + { return(gdcmParser::GetEntryByNumber(group,element)); } + inline virtual std::string GetEntryVRByNumber(guint16 group, guint16 element) + { return(gdcmParser::GetEntryVRByNumber(group,element)); } + + inline virtual std::string GetEntryByName (std::string tagName) + { return(gdcmParser::GetEntryByName(tagName)); } + inline virtual std::string GetEntryVRByName (std::string tagName) + { return(gdcmParser::GetEntryVRByName(tagName)); } + + inline virtual bool SetEntryByNumber(std::string content,guint16 group, guint16 element) + { return(gdcmParser::SetEntryByNumber(content,group,element)); } + inline virtual bool SetEntryByName(std::string content,std::string tagName) + { return(gdcmParser::SetEntryByName(content,tagName)); } + + inline virtual bool SetEntryLengthByNumber(guint32 l,guint16 group, guint16 element) + { return(gdcmParser::SetEntryLengthByNumber(l,group,element)); } + + inline virtual void UpdateShaEntries(void) + { gdcmParser::UpdateShaEntries(); } + +// Read (used in gdcmFile) + void SetImageDataSize(size_t ExpectedSize); + +protected: + int write(std::ostream&); + int anonymize(std::ostream&); // FIXME : anonymize should be a friend ? + +private: }; +//----------------------------------------------------------------------------- #endif