Doxygenation

[gdcm.git] / src / gdcmHeader.h

diff --git a/src/gdcmHeader.h b/src/gdcmHeader.h
index 13a5d39817ccc3cdc4d03975c684b3d3c93b2d22..8c56bdd042384a8229ab3c85044aadb161288eea 100644 (file)
--- a/src/gdcmHeader.h
+++ b/src/gdcmHeader.h
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmHeader.h,v $
   Language:  C++
-  Date:      $Date: 2004/10/28 03:10:58 $
-  Version:   $Revision: 1.92 $
+  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
@@ -19,7 +19,6 @@
 #ifndef GDCMHEADER_H
 #define GDCMHEADER_H
 
-#include "gdcmCommon.h"
 #include "gdcmDocument.h"
 
 namespace gdcm 
@@ -111,7 +110,7 @@ protected:
 
 public:
    Header();
-   Header( std::string const & filename );
+   Header( std::string const &filename );
  
    ~Header();
 
@@ -160,6 +159,7 @@ public:
    bool   HasLUT();
    int    GetLUTNbits();
 
+   /// Return the Transfer Syntax as a string
    std::string GetTransfertSyntaxName();
 
    /// Accessor to \ref Header::GrPixel
@@ -168,13 +168,17 @@ public:
    /// Accessor to \ref Header::NumPixel
    uint16_t GetNumPixel() { return NumPixel; }
 
-   /// Read (used in File)
-   void SetImageDataSize(size_t expectedSize);
+   bool Write(std::string fileName, FileType filetype);
 
-   void Write(std::ofstream* fp, FileType filetype);
+   /// Initialize DICOM header when none
+   void InitializeDefaultHeader();
  
 protected:
+   /// 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: