X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmHeader.h;h=8c56bdd042384a8229ab3c85044aadb161288eea;hb=327dfe7647e3720b0f3125f9b19397cb9afc0ed3;hp=3d8564140d646e4667f2b6484dabee3427d903b1;hpb=cab33b4e50f532b0222121fca7daf9bdaf94eb7e;p=gdcm.git diff --git a/src/gdcmHeader.h b/src/gdcmHeader.h index 3d856414..8c56bdd0 100644 --- a/src/gdcmHeader.h +++ b/src/gdcmHeader.h @@ -1,161 +1,190 @@ -// gdcmHeader.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmHeader.h,v $ + Language: C++ + Date: $Date: 2005/01/06 20:03:28 $ + Version: $Revision: 1.97 $ + + 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 "gdcmCommon.h" -#include "gdcmParser.h" +#include "gdcmDocument.h" +namespace gdcm +{ //----------------------------------------------------------------------------- /** * \brief - * The purpose of an instance of gdcmHeader is to act as a container of + * 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 gdcmHeader is to classify a set of + * 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 gdcmHeader + * be managed within a dictionary which is shared by all Header * instances. - * \note The gdcmHeader::Set*Tag* family members cannot be defined as + * \note The Header::Set*Tag* family members cannot be defined as * protected due to Swig limitations for as Has_a dependency between - * gdcmFile and gdcmHeader. + * File and Header. */ -class GDCM_EXPORT gdcmHeader : public gdcmParser + +//----------------------------------------------------------------------------- +// 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: - /// In some cases (e.g. for some ACR-NEMA images) the Header Entry Element + /// \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 - guint16 NumPixel; - /// In some cases (e.g. for some ACR-NEMA images) the header entry for + /// \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 gdcmHeader::gdcmHeader - guint16 GrPixel; - /// Some DICOM files may contain several images (e.g. a icon, followd by - /// the image itself. Hence the tag (GrPixel,NumPixel) might appear - /// several times. countGrPixel is the number of occurences of the - /// tag of pixels (i.e. (GrPixel,NumPixel)) contained in the header. - /// TODO : will be dealt with SQ tree-like stucture - int countGrPixel; + /// \ref Header::Header + uint16_t GrPixel; + public: - gdcmHeader(bool exception_on_error = false); - gdcmHeader(const char *filename, - bool exception_on_error = false, - bool enable_sequences = false, - bool skip_shadow = false); + Header(); + Header( std::string const &filename ); - virtual ~gdcmHeader(); + ~Header(); // Standard values and informations contained in the header - virtual bool IsReadable(void); - bool IsJPEGBaseLineProcess1TransferSyntax(void); - bool IsJPEGExtendedProcess2_4TransferSyntax(void); - bool IsJPEGExtendedProcess3_5TransferSyntax(void); - bool IsJPEGSpectralSelectionProcess6_8TransferSyntax(void); - bool IsRLELossLessTransferSyntax(void); - bool IsJPEGLossless(void); - bool IsJPEG2000(void); - bool IsDicomV3(void); + bool IsReadable(); // Some heuristic based accessors, end user intended - // (to be moved 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); - - 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* 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); - - /// Accessor to \ref gdcmHeader::GrPixel - guint16 GetGrPixel(void) {return GrPixel;} - - /// Accessor to \ref gdcmHeader::NumPixel - guint16 GetNumPixel(void) {return NumPixel;} - -// Entry - -// These functions are necessary for Python because -// there are protected in the parent class - - 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 int GetEntryLengthByNumber(guint16 group, guint16 element) - { return(gdcmParser::GetEntryLengthByNumber(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); - - bool operator<(gdcmHeader &header); - - bool WriteEntry(gdcmHeaderEntry *tag,FILE *_fp,FileType type); - - - virtual void PrintEntryNoSQ (std::ostream &os = std::cout); - virtual void PrintEntryNiceSQ(std::ostream &os = std::cout); + 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(); + + /// Return the Transfer Syntax as a string + std::string GetTransfertSyntaxName(); + + /// Accessor to \ref Header::GrPixel + uint16_t GetGrPixel() { return GrPixel; } + /// Accessor to \ref Header::NumPixel + uint16_t GetNumPixel() { return NumPixel; } + + bool Write(std::string fileName, FileType filetype); + + /// Initialize DICOM header when none + void InitializeDefaultHeader(); + protected: - //CLEANME int write(std::ostream&); - //CLEANME int anonymize(std::ostream&);//FIXME: anonymize should be a friend - bool anonymizeHeader(void); -private: + /// Replace patient's specific information by 'anonymous' + bool AnonymizeHeader(); + /// Helper function needed to organize DICOM files based on + /// their x,y,z position + void GetImageOrientationPatient( float iop[6] ); + +private: + friend class SerieHeader; }; +} // end namespace gdcm //----------------------------------------------------------------------------- #endif