X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmHeader.h;h=13a5d39817ccc3cdc4d03975c684b3d3c93b2d22;hb=9649936f884197f6f6260aae051d33729bce07d5;hp=fa33ebc8d039e96605688aedf330fcac8b02088b;hpb=b6c826571b5f85de9256b0973df29e916c40d243;p=gdcm.git diff --git a/src/gdcmHeader.h b/src/gdcmHeader.h index fa33ebc8..13a5d398 100644 --- a/src/gdcmHeader.h +++ b/src/gdcmHeader.h @@ -1,171 +1,186 @@ -// gdcmHeader.h +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmHeader.h,v $ + Language: C++ + Date: $Date: 2004/10/28 03:10:58 $ + Version: $Revision: 1.92 $ + + 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.html 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 "gdcmException.h" -#include "gdcmDictSet.h" -#include "gdcmElValue.h" -#include "gdcmElValSet.h" - -typedef string VRKey; -typedef string VRAtr; -typedef 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. - static VRHT *dicom_vr; - - /// Global dictionary container - gdcmDictSet* Dicts; - /// 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. - ElValSet PubElVals; - /// ELement VALueS parsed with the SHAdow dictionary. - ElValSet ShaElVals; - /// Refering underlying filename. - string filename; - FILE * fp; - - // 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); - 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); - - bool IsJPEGLossless(void); - +#include "gdcmDocument.h" + +namespace gdcm +{ +//----------------------------------------------------------------------------- +/** + * \brief + * The purpose of an instance of Header 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 Header 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 Header + * instances. + * \note The Header::Set*Tag* family members cannot be defined as + * protected due to Swig limitations for as Has_a dependency between + * File and Header. + */ + +//----------------------------------------------------------------------------- +// 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 Header : public Document +{ protected: - // FIXME: is this enum still necessary ?? - 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 ? + /// \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 Header::Header + 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 Header::Header + uint16_t GrPixel; + 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); - - string GetPubElValByName(string TagName); - string GetPubElValByNumber(guint16 group, guint16 element); - 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); - - // TODO Swig string* GetShaTagNames(); - string GetShaElValByName(string TagName); - string GetShaElValByNumber(guint16 group, guint16 element); - string GetShaElValRepByName(string TagName); - string GetShaElValRepByNumber(guint16 group, guint16 element); - - 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); + Header(); + Header( std::string const & filename ); + + ~Header(); + + // Standard values and informations contained in the header + bool IsReadable(); + + // Some heuristic based accessors, end user intended + int GetBitsStored(); + int GetBitsAllocated(); + int GetSamplesPerPixel(); + int GetPlanarConfiguration(); + int GetPixelSize(); + int GetHighBitPosition(); + bool IsSignedPixelData(); + bool IsMonochrome(); + bool IsPaletteColor(); + bool IsYBRFull(); + + 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(); + + // Useful for rescaling graylevel: + float GetRescaleIntercept(); + float GetRescaleSlope(); + + int GetNumberOfScalarComponents(); + int GetNumberOfScalarComponentsRaw(); + + int GetImageNumber(); + ModalityType GetModality(); + + float GetXOrigin(); + float GetYOrigin(); + float GetZOrigin(); + + bool HasLUT(); + int GetLUTNbits(); + + std::string GetTransfertSyntaxName(); + + /// Accessor to \ref Header::GrPixel + uint16_t GetGrPixel() { return GrPixel; } - int gdcmHeader::SetPubElValLengthByNumber(guint32 lgr, guint16 group, - guint16 element); + /// Accessor to \ref Header::NumPixel + uint16_t GetNumPixel() { return NumPixel; } + + /// Read (used in File) + void SetImageDataSize(size_t expectedSize); + + void Write(std::ofstream* fp, FileType filetype); + +protected: + bool AnonymizeHeader(); + void GetImageOrientationPatient( float iop[6] ); - ElValSet GetPubElVals() { return(PubElVals); } +private: + friend class SerieHeader; }; +} // end namespace gdcm +//----------------------------------------------------------------------------- #endif