]> Creatis software - gdcm.git/blobdiff - src/gdcmHeader.h
ENH: Minor patch, mostly cosmetic clean up
[gdcm.git] / src / gdcmHeader.h
index a2cece0a3ab1de669679b7222290e4d725e37e68..9110e023bba15dbfbd8e40c790827691022701c1 100644 (file)
@@ -1,11 +1,26 @@
-// gdcmHeader.h
-//-----------------------------------------------------------------------------
+/*=========================================================================
+                                                                                
+  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 "gdcmCommon.h"
-#include "gdcmParser.h"
-
+#include "gdcmDocument.h"
 //-----------------------------------------------------------------------------
 /**
  * \brief
  *        protected due to Swig limitations for as Has_a dependency between
  *        gdcmFile and gdcmHeader.
  */
-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 gdcmHeader : public gdcmDocument
 {
 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
+   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.
-   int countGrPixel;
+   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);
+   gdcmHeader(std::string const & filename, 
+              bool  exception_on_error = 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);
-   bool IsJPEGSpectralSelectionProcess6_8TransferSyntax(void); 
-   bool IsRLELossLessTransferSyntax(void); 
-   bool IsJPEGLossless(void); 
-   bool IsJPEG2000(void); 
-   bool IsDicomV3(void); 
+   virtual 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);
-   
+   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
-   guint16 GetGrPixel(void)  {return GrPixel;}
+   uint16_t GetGrPixel()  { return GrPixel; }
    
    /// Accessor to \ref gdcmHeader::NumPixel
-   guint16 GetNumPixel(void) {return NumPixel;}
-
-// 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 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(); }
+   uint16_t GetNumPixel() { return NumPixel; }
 
    /// Read (used in gdcmFile)
-   void SetImageDataSize(size_t ExpectedSize);
-
-   bool operator<(gdcmHeader &header);
-
-   bool WriteEntry(gdcmHeaderEntry *tag,FILE *_fp,FileType type);
-
+   void SetImageDataSize(size_t expectedSize);
 
+   void Write(FILE* fp, FileType filetype);
 protected:
-   //CLEANME int write(std::ostream&);   
-   //CLEANME int anonymize(std::ostream&);//FIXME: anonymize should be a friend
-   bool anonymizeHeader(void);
-private:
+   bool AnonymizeHeader();
+   void GetImageOrientationPatient( float iop[6] );
 
+private:
+  friend class gdcmSerieHeader;
 };
 
 //-----------------------------------------------------------------------------