X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmHeader.h;h=9110e023bba15dbfbd8e40c790827691022701c1;hb=e6671b4378ba33a2cdf7c711e4e45250af74dbbc;hp=33abf811398f7ed07c4417bf5c358d81488c226d;hpb=d8f5a9bf53d6a80049195d46d1355aa5afa19157;p=gdcm.git diff --git a/src/gdcmHeader.h b/src/gdcmHeader.h index 33abf811..9110e023 100644 --- a/src/gdcmHeader.h +++ b/src/gdcmHeader.h @@ -1,202 +1,181 @@ -// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.h,v 1.34 2003/07/07 10:26:14 regrain Exp $ +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmHeader.h,v $ + Language: C++ + Date: $Date: 2004/07/31 23:30:04 $ + Version: $Revision: 1.85 $ + + Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de + l'Image). All rights reserved. See Doc/License.txt or + http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ #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); - +#include "gdcmDocument.h" +//----------------------------------------------------------------------------- +/** + * \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. + */ + +//----------------------------------------------------------------------------- +// Dicom Part 3.3 Compliant +enum ModalityType { + Unknow, + AU, // Voice Audio + AS, // Angioscopy + BI, // Biomagnetic Imaging + CF, // Cinefluorography + CP, // Culposcopy + CR, // Computed Radiography + CS, // Cystoscopy + CT, // Computed Tomography + DD, // Duplex Dopler + DF, // Digital Fluoroscopy + DG, // Diaphanography + DM, // Digital Microscopy + DS, // Digital Substraction Angiography + DX, // Digital Radiography + ECG, // Echocardiography + EPS, // Basic Cardiac EP + ES, // Endoscopy + FA, // Fluorescein Angiography + FS, // Fundoscopy + HC, // Hard Copy + HD, // Hemodynamic + LP, // Laparoscopy + LS, // Laser Surface Scan + MA, // Magnetic Resonance Angiography + MR, // Magnetic Resonance + NM, // Nuclear Medicine + OT, // Other + PT, // Positron Emission Tomography + RF, // Radio Fluoroscopy + RG, // Radiographic Imaging + RTDOSE, // Radiotherapy Dose + RTIMAGE, // Radiotherapy Image + RTPLAN, // Radiotherapy Plan + RTSTRUCT, // Radiotherapy Structure Set + SM, // Microscopic Imaging + ST, // Single-photon Emission Computed Tomography + TG, // Thermography + US, // Ultrasound + VF, // Videofluorography + XA, // X-Ray Angiography + XC // Photographic Imaging +}; +//----------------------------------------------------------------------------- + +class GDCM_EXPORT gdcmHeader : public gdcmDocument +{ 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 ? + /// \brief In some cases (e.g. for some ACR-NEMA images) the Header Entry Element + /// Number of the 'Pixel Element' is *not* found at 0x0010. In order to + /// make things easier the parser shall store the proper value in + /// NumPixel to provide a unique access facility. See also the constructor + /// \ref gdcmHeader::gdcmHeader + uint16_t NumPixel; + /// \brief In some cases (e.g. for some ACR-NEMA images) the header entry for + /// the group of pixels is *not* found at 0x7fe0. In order to + /// make things easier the parser shall store the proper value in + /// GrPixel to provide a unique access facility. See also the constructor + /// \ref gdcmHeader::gdcmHeader + uint16_t GrPixel; + public: - 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); + gdcmHeader(bool exception_on_error = false); + gdcmHeader(std::string const & filename, + 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); - - 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); - -/* ================ COMMENT OUT after unfreeze - int GetPlanarConfiguration(void); - ======================================= */ + // Standard values and informations contained in the header + virtual bool IsReadable(); - 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); + // Some heuristic based accessors, end user intended + int GetBitsStored(); + int GetBitsAllocated(); + int GetSamplesPerPixel(); + int GetPlanarConfiguration(); + int GetPixelSize(); + + std::string GetPixelType(); + size_t GetPixelOffset(); + size_t GetPixelAreaLength(); + + //Some image informations needed for third package imaging library + int GetXSize(); + int GetYSize(); + int GetZSize(); + + float GetXSpacing(); + float GetYSpacing(); + float GetZSpacing(); + //void GetSpacing(float &x, float &y, float &z); + + // Useful for rescaling graylevel: + float GetRescaleIntercept(); + float GetRescaleSlope(); + + int GetNumberOfScalarComponents(); + int GetNumberOfScalarComponentsRaw(); + + int GetImageNumber(); + ModalityType GetModality(); + + float GetXOrigin(); + float GetYOrigin(); + float GetZOrigin(); + //void GetOrigin(float &x, float &y, float &z); + + bool HasLUT(); + int GetLUTNbits(); + unsigned char * GetLUTRGBA(); + + std::string GetTransfertSyntaxName(); + + /// Accessor to \ref gdcmHeader::GrPixel + uint16_t GetGrPixel() { return GrPixel; } - int Write(FILE *, FileType); + /// Accessor to \ref gdcmHeader::NumPixel + uint16_t GetNumPixel() { return NumPixel; } + + /// Read (used in gdcmFile) + void SetImageDataSize(size_t expectedSize); + + void Write(FILE* fp, FileType filetype); + +protected: + bool AnonymizeHeader(); + void GetImageOrientationPatient( float iop[6] ); + +private: + friend class gdcmSerieHeader; }; +//----------------------------------------------------------------------------- #endif