]> Creatis software - gdcm.git/blobdiff - src/gdcmHeader.cxx
Upgrade of Dicom Dictionary to be 2003 compliant (400 entries added)
[gdcm.git] / src / gdcmHeader.cxx
index 06186911e0e01d2595173583733db241d81b4456..b92ba73707ebc92c146bf93a7cbd741433676721 100644 (file)
@@ -1,4 +1,5 @@
-// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.cxx,v 1.70 2003/06/20 14:17:47 jpr Exp $
+
+// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.cxx,v 1.78 2003/07/03 14:38:16 jpr Exp $
 
 #include <stdio.h>
 #include <cerrno>
@@ -26,10 +27,8 @@ using namespace std;
 /**
  * \ingroup gdcmHeader
  * \brief   
- * @param  none   
- * @return  
  */
- void gdcmHeader::Initialise(void) {
+void gdcmHeader::Initialise(void) {
    dicom_vr = gdcmGlobal::GetVR();
    dicom_ts = gdcmGlobal::GetTS();
    Dicts =    gdcmGlobal::GetDicts();
@@ -40,27 +39,26 @@ using namespace std;
 /**
  * \ingroup gdcmHeader
  * \brief   
- * @param     
- * @return  
- */
- gdcmHeader::gdcmHeader(const char *InFilename, bool exception_on_error) {
-  SetMaxSizeLoadElementValue(_MaxSizeLoadElementValue_);
-  filename = InFilename;
-  Initialise();
-  if ( !OpenFile(exception_on_error))
-     return;
-  ParseHeader();
-  LoadElements();
-  CloseFile();
+ * @param   InFilename
+ * @param   exception_on_error
+ */
+gdcmHeader::gdcmHeader(const char *InFilename, bool exception_on_error) {
+   SetMaxSizeLoadElementValue(_MaxSizeLoadElementValue_);
+   filename = InFilename;
+   Initialise();
+   if ( !OpenFile(exception_on_error))
+      return;
+   ParseHeader();
+   LoadElements();
+   CloseFile();
 }
 
 /**
  * \ingroup gdcmHeader
  * \brief   
- * @param     
- * @return  
+ * @param   exception_on_error
  */
- gdcmHeader::gdcmHeader(bool exception_on_error) {
+gdcmHeader::gdcmHeader(bool exception_on_error) {
   SetMaxSizeLoadElementValue(_MaxSizeLoadElementValue_);
   Initialise();
 }
@@ -68,7 +66,7 @@ using namespace std;
 /**
  * \ingroup gdcmHeader
  * \brief   
- * @param     
+ * @param   exception_on_error
  * @return  
  */
  bool gdcmHeader::OpenFile(bool exception_on_error)
@@ -87,10 +85,9 @@ using namespace std;
 /**
  * \ingroup gdcmHeader
  * \brief   
- * @param     
  * @return  
  */
- bool gdcmHeader::CloseFile(void) {
+bool gdcmHeader::CloseFile(void) {
   int closed = fclose(fp);
   fp = (FILE *)0;
   if (! closed)
@@ -100,11 +97,9 @@ using namespace std;
 
 /**
  * \ingroup gdcmHeader
- * \brief   
- * @param     
- * @return  
+ * \brief   Canonical destructor.
  */
- gdcmHeader::~gdcmHeader (void) {
+gdcmHeader::~gdcmHeader (void) {
    dicom_vr =   (gdcmVR*)0; 
    Dicts    =   (gdcmDictSet*)0;
    RefPubDict = (gdcmDict*)0;
@@ -198,9 +193,9 @@ void gdcmHeader::CheckSwap()
       // Use gdcmHeader::dicom_vr to test all the possibilities
       // instead of just checking for UL, OB and UI !?
       if(  (memcmp(entCur, "UL", (size_t)2) == 0) ||
-         (memcmp(entCur, "OB", (size_t)2) == 0) ||
-         (memcmp(entCur, "UI", (size_t)2) == 0) )
-       {
+          (memcmp(entCur, "OB", (size_t)2) == 0) ||
+          (memcmp(entCur, "UI", (size_t)2) == 0) )   
+      {
          filetype = ExplicitVR;
          dbg.Verbose(1, "gdcmHeader::CheckSwap:",
                      "explicit Value Representation");
@@ -209,7 +204,6 @@ void gdcmHeader::CheckSwap()
          dbg.Verbose(1, "gdcmHeader::CheckSwap:",
                      "not an explicit Value Representation");
       }
-
       if (net2host) {
          sw = 4321;
          dbg.Verbose(1, "gdcmHeader::CheckSwap:",
@@ -281,10 +275,8 @@ void gdcmHeader::CheckSwap()
 /**
  * \ingroup gdcmHeader
  * \brief   
- * @param     
- * @return  
  */
- void gdcmHeader::SwitchSwapToBigEndian(void) {
+void gdcmHeader::SwitchSwapToBigEndian(void) {
    dbg.Verbose(1, "gdcmHeader::SwitchSwapToBigEndian",
                   "Switching to BigEndian mode.");
    if ( sw == 0    ) {
@@ -306,6 +298,7 @@ void gdcmHeader::CheckSwap()
 /**
  * \ingroup   gdcmHeader
  * \brief     Find the value representation of the current tag.
+ * @param ElVal
  */
 void gdcmHeader::FindVR( gdcmElValue *ElVal) {
    if (filetype != ExplicitVR)
@@ -390,7 +383,7 @@ void gdcmHeader::FindVR( gdcmElValue *ElVal) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   Determines if the Transfer Syntax was allready encountered
+ * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a ImplicitVRLittleEndian one.
  *
  * @return  True when ImplicitVRLittleEndian found. False in all other cases.
@@ -408,7 +401,7 @@ bool gdcmHeader::IsImplicitVRLittleEndianTransferSyntax(void) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   Determines if the Transfer Syntax was allready encountered
+ * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a ExplicitVRLittleEndian one.
  *
  * @return  True when ExplicitVRLittleEndian found. False in all other cases.
@@ -426,7 +419,7 @@ bool gdcmHeader::IsExplicitVRLittleEndianTransferSyntax(void) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   Determines if the Transfer Syntax was allready encountered
+ * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a DeflatedExplicitVRLittleEndian one.
  *
  * @return  True when DeflatedExplicitVRLittleEndian found. False in all other cases.
@@ -444,7 +437,7 @@ bool gdcmHeader::IsDeflatedExplicitVRLittleEndianTransferSyntax(void) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   Determines if the Transfer Syntax was allready encountered
+ * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a Explicit VR Big Endian one.
  *
  * @return  True when big endian found. False in all other cases.
@@ -462,7 +455,7 @@ bool gdcmHeader::IsExplicitVRBigEndianTransferSyntax(void) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   Determines if the Transfer Syntax was allready encountered
+ * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a JPEGBaseLineProcess1 one.
  *
  * @return  True when JPEGBaseLineProcess1found. False in all other cases.
@@ -499,7 +492,7 @@ bool gdcmHeader::IsJPEGLossless(void) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   Determines if the Transfer Syntax was allready encountered
+ * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a JPEGExtendedProcess2-4 one.
  *
  * @return  True when JPEGExtendedProcess2-4 found. False in all other cases.
@@ -517,7 +510,7 @@ bool gdcmHeader::IsJPEGExtendedProcess2_4TransferSyntax(void) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   Determines if the Transfer Syntax was allready encountered
+ * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a JPEGExtendeProcess3-5 one.
  *
  * @return  True when JPEGExtendedProcess3-5 found. False in all other cases.
@@ -535,7 +528,7 @@ bool gdcmHeader::IsJPEGExtendedProcess3_5TransferSyntax(void) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   Determines if the Transfer Syntax was allready encountered
+ * \brief   Determines if the Transfer Syntax was already encountered
  *          and if it corresponds to a JPEGSpectralSelectionProcess6-8 one.
  *
  * @return  True when JPEGSpectralSelectionProcess6-8 found. False in all
@@ -595,31 +588,26 @@ void gdcmHeader::FixFoundLength(gdcmElValue * ElVal, guint32 FoundLength) {
       g = ReadInt16();
       n = ReadInt16();
       
- if (DEBUG) printf ("dans FindLengthOB (%04x,%04x)\n",g,n);
- long l = ftell(fp);
- if (DEBUG) printf("en  %d o(%o) x(%x)\n",l,l,l); 
+      long l = ftell(fp);
 
       if (errno == 1)
          return 0;
       TotalLength += 4;  // We even have to decount the group and element 
      
-      if ( g != 0xfffe           && g!=0xb00c ) /*for bogus headerJPR */ {
+      if ( g != 0xfffe           && g!=0xb00c ) /*for bogus header */ {
          char msg[100]; // for sprintf. Sorry
          sprintf(msg,"wrong group (%04x) for an item sequence (%04x,%04x)\n",g, g,n);
          dbg.Verbose(1, "gdcmHeader::FindLengthOB: ",msg); 
          long l = ftell(fp);
-         if (DEBUG) printf("en  %d o(%o) x(%x)\n",l,l,l); 
          errno = 1;
          return 0;
       }
-      if ( n == 0xe0dd       || ( g==0xb00c && n==0x0eb6 ) ) /* for bogus header JPR */ 
+      if ( n == 0xe0dd       || ( g==0xb00c && n==0x0eb6 ) ) /* for bogus header  */ 
          FoundSequenceDelimiter = true;
       else if ( n != 0xe000 ){
          char msg[100];  // for sprintf. Sorry
          sprintf(msg,"wrong element (%04x) for an item sequence (%04x,%04x)\n",n, g,n);
         dbg.Verbose(1, "gdcmHeader::FindLengthOB: ",msg);
-         if (DEBUG) printf("wrong element (%04x) for an item sequence (%04x,%04x)\n",n, g,n);   
          errno = 1;
          return 0;
       }
@@ -627,7 +615,6 @@ void gdcmHeader::FixFoundLength(gdcmElValue * ElVal, guint32 FoundLength) {
       TotalLength += ItemLength + 4;  // We add 4 bytes since we just read
                                       // the ItemLength with ReadInt32
                                       
-      if (DEBUG) printf("TotalLength %d\n",TotalLength);
       SkipBytes(ItemLength);
    }
    fseek(fp, PositionOnEntry, SEEK_SET);
@@ -642,13 +629,12 @@ void gdcmHeader::FixFoundLength(gdcmElValue * ElVal, guint32 FoundLength) {
  */
  void gdcmHeader::FindLength (gdcmElValue * ElVal) {
    guint16 element = ElVal->GetElement();
-   guint16 group = ElVal->GetGroup(); // JPR a virer
+   guint16 group   = ElVal->GetGroup();
    string  vr      = ElVal->GetVR();
    guint16 length16;
-   if( (element == 0x0010) && (group == 0x7fe0) ) {// JPR
-      dbg.SetDebug(1);
-      dbg.Verbose(2, "gdcmHeader::FindLength: ", // JPR
+   if( (element == 0x0010) && (group == 0x7fe0) ) {
+      dbg.SetDebug(0);
+      dbg.Verbose(2, "gdcmHeader::FindLength: ",
                      "on est sur 7fe0 0010");
    }   
    
@@ -694,7 +680,7 @@ void gdcmHeader::FixFoundLength(gdcmElValue * ElVal, guint32 FoundLength) {
       // We shall use this second strategy. In order to make sure that we
       // can interpret the presence of an apparently big endian encoded
       // length of a "Group Length" without committing a big mistake, we
-      // add an additional check: we look in the allready parsed elements
+      // add an additional check: we look in the already parsed elements
       // for the presence of a "Transfer Syntax" whose value has to be "big
       // endian encoding". When this is the case, chances are we have got our
       // hands on a big endian encoded file: we switch the swap code to
@@ -879,8 +865,7 @@ void gdcmHeader::LoadElementValue(gdcmElValue * ElVal) {
    // four bytes properly i.e. as an integer as opposed to a string.
        
        // pour les elements de Value Multiplicity > 1
-       // on aura en fait une serie d'entiers
-       
+       // on aura en fait une serie d'entiers  
        // on devrait pouvoir faire + compact (?)
                
    if ( IsAnInteger(ElVal) ) {
@@ -959,11 +944,11 @@ guint16 gdcmHeader::ReadInt16(void) {
    size_t item_read;
    item_read = fread (&g, (size_t)2,(size_t)1, fp);
    if ( item_read != 1 ) {
-      dbg.Verbose(1, "gdcmHeader::ReadInt16", " Failed to read :");
-      if(feof(fp)) 
-         dbg.Verbose(1, "gdcmHeader::ReadInt16", " End of File encountered");
-     if(ferror(fp)) 
-         dbg.Verbose(1, "gdcmHeader::ReadInt16", " File Error");
+      // dbg.Verbose(0, "gdcmHeader::ReadInt16", " Failed to read :");
+      // if(feof(fp)) 
+      //    dbg.Verbose(0, "gdcmHeader::ReadInt16", " End of File encountered");
+      if(ferror(fp)) 
+         dbg.Verbose(0, "gdcmHeader::ReadInt16", " File Error");
       errno = 1;
       return 0;
    }
@@ -982,13 +967,12 @@ guint32 gdcmHeader::ReadInt32(void) {
    guint32 g;
    size_t item_read;
    item_read = fread (&g, (size_t)4,(size_t)1, fp);
-   if ( item_read != 1 ) {
-   
-      dbg.Verbose(1, "gdcmHeader::ReadInt32", " Failed to read :");
-      if(feof(fp)) 
-         dbg.Verbose(1, "gdcmHeader::ReadInt32", " End of File encountered");
+   if ( item_read != 1 ) { 
+      //dbg.Verbose(0, "gdcmHeader::ReadInt32", " Failed to read :");
+      //if(feof(fp)) 
+      //   dbg.Verbose(0, "gdcmHeader::ReadInt32", " End of File encountered");
      if(ferror(fp)) 
-         dbg.Verbose(1, "gdcmHeader::ReadInt32", " File Error");   
+         dbg.Verbose(0, "gdcmHeader::ReadInt32", " File Error");   
       errno = 1;
       return 0;
    }
@@ -1040,30 +1024,54 @@ gdcmElValue* gdcmHeader::NewElValueByNumber(guint16 Group, guint16 Elem) {
 /**
  * \ingroup gdcmHeader
  * \brief   TODO
- * @param   
+ * @param   Value
+ * @param   Group
+ * @param   Elem
  */
 int gdcmHeader::ReplaceOrCreateByNumber(string Value, guint16 Group, guint16 Elem ) {
 
-       gdcmElValue* nvElValue=NewElValueByNumber(Group, Elem);
-       PubElValSet.Add(nvElValue);     
-       PubElValSet.SetElValueByNumber(Value, Group, Elem);
-       return(1);
+       // TODO : FIXME JPRx
+       // curieux, non ?
+       // on (je) cree une Elvalue ne contenant pas de valeur
+       // on l'ajoute au ElValSet
+       // on affecte une valeur a cette ElValue a l'interieur du ElValSet
+       // --> devrait pouvoir etre fait + simplement ???
+       
+   gdcmElValue* nvElValue=NewElValueByNumber(Group, Elem);
+   PubElValSet.Add(nvElValue); 
+   PubElValSet.SetElValueByNumber(Value, Group, Elem);
+   return(1);
 }   
 
 
 /**
  * \ingroup gdcmHeader
  * \brief   TODO
- * @param   
+ * @param   Value
+ * @param   Group
+ * @param   Elem 
  */
 int gdcmHeader::ReplaceOrCreateByNumber(char* Value, guint16 Group, guint16 Elem ) {
 
-       gdcmElValue* nvElValue=NewElValueByNumber(Group, Elem);
-       PubElValSet.Add(nvElValue);
-       string v = Value;       
-       PubElValSet.SetElValueByNumber(v, Group, Elem);
-       return(1);
-}   
+   gdcmElValue* nvElValue=NewElValueByNumber(Group, Elem);
+   PubElValSet.Add(nvElValue);
+   string v = Value;   
+   PubElValSet.SetElValueByNumber(v, Group, Elem);
+   return(1);
+}  
+
+/**
+ * \ingroup gdcmHeader
+ * \brief   TODO
+ * @param   Group
+ * @param   Elem  
+ */
+int gdcmHeader::CheckIfExistByNumber(guint16 Group, guint16 Elem ) {
+   return (PubElValSet.CheckIfExistByNumber(Group, Elem));
+ }
 /**
  * \ingroup gdcmHeader
  * \brief   Build a new Element Value from all the low level arguments. 
@@ -1101,7 +1109,7 @@ gdcmElValue * gdcmHeader::ReadNextElement(void) {
    
    if ( (g==0x7fe0) && (n==0x0010) ) 
        if (DEBUG) 
-               printf("in gdcmHeader::ReadNextElement try to read 7fe0 0010 \n");
+          printf("in gdcmHeader::ReadNextElement try to read 7fe0 0010 \n");
    
    if (errno == 1)
       // We reached the EOF (or an error occured) and header parsing
@@ -1118,8 +1126,8 @@ gdcmElValue * gdcmHeader::ReadNextElement(void) {
    }
    NewElVal->SetOffset(ftell(fp));  
    if ( (g==0x7fe0) && (n==0x0010) ) 
-       if (DEBUG) 
-               printf("sortie de gdcmHeader::ReadNextElement 7fe0 0010 \n");
+      if (DEBUG) 
+         printf("sortie de gdcmHeader::ReadNextElement 7fe0 0010 \n");
    return NewElVal;
 }
 
@@ -1522,10 +1530,10 @@ int gdcmHeader::SetShaElValByNumber(string content,
  * \brief   Accesses an existing gdcmElValue in the ShaElValSet of this instance
  *          through tag name and modifies it's content with the given value.
  * @param   content new value to substitute with
- * @param   TagName name of the tag to be modified
+ * @param   ShadowTagName name of the tag to be modified
  */
-int gdcmHeader::SetShaElValByName(string content, string TagName) {
-   return (  ShaElValSet.SetElValueByName (content, TagName) );
+int gdcmHeader::SetShaElValByName(string content, string ShadowTagName) {
+   return (  ShaElValSet.SetElValueByName (content, ShadowTagName) );
 }
 
 /**
@@ -1543,19 +1551,108 @@ void gdcmHeader::ParseHeader(bool exception_on_error) throw(gdcmFormatError) {
    }
 }
 
+/**
+ * \ingroup gdcmHeader
+ * \brief  This predicate, based on hopefully reasonnable heuristics,
+ *         decides whether or not the current gdcmHeader was properly parsed
+ *         and contains the mandatory information for being considered as
+ *         a well formed and usable image.
+ * @return true when gdcmHeader is the one of a reasonable Dicom file,
+ *         false otherwise. 
+ */
+bool gdcmHeader::IsReadable(void) {
+   if (   GetElValByName("Image Dimensions") != "gdcm::Unfound"
+      && atoi(GetElValByName("Image Dimensions").c_str()) > 4 ) {
+      return false;
+   }
+   if ( GetElValByName("Bits Allocated")       == "gdcm::Unfound" )
+      return false;
+   if ( GetElValByName("Bits Stored")          == "gdcm::Unfound" )
+      return false;
+   if ( GetElValByName("High Bit")             == "gdcm::Unfound" )
+      return false;
+   if ( GetElValByName("Pixel Representation") == "gdcm::Unfound" )
+      return false;
+   return true;
+}
+
+/**
+ * \ingroup gdcmHeader
+ * \brief   Small utility function that creates a new manually crafted
+ *          (as opposed as read from the file) gdcmElValue with user
+ *          specified name and adds it to the public tag hash table.
+ * \note    A fake TagKey is generated so the PubDict can keep it's coherence.
+ * @param   NewTagName The name to be given to this new tag.
+ * @param   VR The Value Representation to be given to this new tag.
+ * @ return The newly hand crafted Element Value.
+ */
+gdcmElValue* gdcmHeader::NewManualElValToPubDict(string NewTagName, string VR) {
+   gdcmElValue* NewElVal = (gdcmElValue*)0;
+   guint32 StuffGroup = 0xffff;   // Group to be stuffed with additional info
+   guint32 FreeElem = 0;
+   gdcmDictEntry* NewEntry = (gdcmDictEntry*)0;
+
+   FreeElem = PubElValSet.GenerateFreeTagKeyInGroup(StuffGroup);
+   if (FreeElem == UINT32_MAX) {
+      dbg.Verbose(1, "gdcmHeader::NewManualElValToPubDict",
+                     "Group 0xffff in Public Dict is full");
+      return (gdcmElValue*)0;
+   }
+   NewEntry = new gdcmDictEntry(StuffGroup, FreeElem,
+                                VR, "GDCM", NewTagName);
+   NewElVal = new gdcmElValue(NewEntry);
+   PubElValSet.Add(NewElVal);
+   return NewElVal;
+}
+
+/**
+ * \ingroup gdcmHeader
+ * \brief   Loads the element values of all the elements present in the
+ *          public tag based hash table.
+ */
+void gdcmHeader::LoadElements(void) {
+   rewind(fp);   
+   TagElValueHT ht = PubElValSet.GetTagHt();
+   for (TagElValueHT::iterator tag = ht.begin(); tag != ht.end(); ++tag) {
+      LoadElementValue(tag->second);
+   }
+}
+
+/**
+  * \ingroup gdcmHeader
+  * \brief
+  * @return
+  */ 
+void gdcmHeader::PrintPubElVal(std::ostream & os) {
+   PubElValSet.Print(os);
+}
+
+/**
+  * \ingroup gdcmHeader
+  * \brief
+  * @return
+  */  
+void gdcmHeader::PrintPubDict(std::ostream & os) {
+   RefPubDict->Print(os);
+}
+
+/**
+  * \ingroup gdcmHeader
+  * \brief
+  * @return
+  */ 
+int gdcmHeader::Write(FILE * fp, FileType type) {
+   return PubElValSet.Write(fp, type);
+}
 
 //
-// TODO : JPR
-// des que les element values sont chargees, stocker, 
-// en une seule fois, dans des entiers 
-// NX, NY, NZ, Bits allocated, Bits Stored, High Bit, Samples Per Pixel
-// (TODO : preciser les autres)
-// et refaire ceux des accesseurs qui renvoient les entiers correspondants
+// =============================================================================
+//   Accesors with euristics
+//==============================================================================
 //
-// --> peut etre dangereux ?
-// si l'utilisateur modifie 'manuellement' l'un des paramètres
-// l'entier de sera pas modifié ...
-// (pb de la mise à jour en cas de redondance :-(
+
+// TODO : move to an other file.
+
 
 /**
  * \ingroup gdcmHeader
@@ -1616,7 +1713,6 @@ int gdcmHeader::GetZSize(void) {
    return 1;
 }
 
-
 /**
  * \ingroup gdcmHeader
  * \brief   Retrieve the number of Bits Stored
@@ -1645,6 +1741,25 @@ int gdcmHeader::GetSamplesPerPixel(void) {
       return 1; // Well, it's supposed to be mandatory ...
    return atoi(StrSize.c_str());
 }
+
+
+/* ================ COMMENT OUT after unfreeze
+**
+ * \ingroup gdcmHeader
+ * \brief   Retrieve the Planar Configuration for RGB images
+ *          (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane)
+ * 
+ * @return  The encountered Planar Configuration, 0 by default.
+ *
+int gdcmHeader::GetPlanarConfiguration(void) { 
+   string StrSize = GetPubElValByNumber(0x0028,0x0006);
+   if (StrSize == "gdcm::Unfound")
+      return 0;
+   return atoi(StrSize.c_str());
+}
+
+ ======================================= */
+
 /**
  * \ingroup gdcmHeader
  * \brief   Return the size (in bytes) of a single pixel of data.
@@ -1700,113 +1815,18 @@ string gdcmHeader::GetPixelType(void) {
    return( BitsAlloc + Signed);
 }
 
-
-/**
- * \ingroup gdcmHeader
- * \brief  This predicate, based on hopefully reasonnable heuristics,
- *         decides whether or not the current gdcmHeader was properly parsed
- *         and contains the mandatory information for being considered as
- *         a well formed and usable image.
- * @return true when gdcmHeader is the one of a reasonable Dicom file,
- *         false otherwise. 
- */
-bool gdcmHeader::IsReadable(void) {
-   if (   GetElValByName("Image Dimensions") != "gdcm::Unfound"
-      && atoi(GetElValByName("Image Dimensions").c_str()) > 4 ) {
-      return false;
-   }
-   if ( GetElValByName("Bits Allocated") == "gdcm::Unfound" )
-      return false;
-   if ( GetElValByName("Bits Stored") == "gdcm::Unfound" )
-      return false;
-   if ( GetElValByName("High Bit") == "gdcm::Unfound" )
-      return false;
-   if ( GetElValByName("Pixel Representation") == "gdcm::Unfound" )
-      return false;
-   return true;
-}
-
-/**
- * \ingroup gdcmHeader
- * \brief   Small utility function that creates a new manually crafted
- *          (as opposed as read from the file) gdcmElValue with user
- *          specified name and adds it to the public tag hash table.
- * \note    A fake TagKey is generated so the PubDict can keep it's coherence.
- * @param   NewTagName The name to be given to this new tag.
- * @param   VR The Value Representation to be given to this new tag.
- * @ return The newly hand crafted Element Value.
- */
-gdcmElValue* gdcmHeader::NewManualElValToPubDict(string NewTagName, string VR) {
-   gdcmElValue* NewElVal = (gdcmElValue*)0;
-   guint32 StuffGroup = 0xffff;   // Group to be stuffed with additional info
-   guint32 FreeElem = 0;
-   gdcmDictEntry* NewEntry = (gdcmDictEntry*)0;
-
-   FreeElem = PubElValSet.GenerateFreeTagKeyInGroup(StuffGroup);
-   if (FreeElem == UINT32_MAX) {
-      dbg.Verbose(1, "gdcmHeader::NewManualElValToPubDict",
-                     "Group 0xffff in Public Dict is full");
-      return (gdcmElValue*)0;
-   }
-   NewEntry = new gdcmDictEntry(StuffGroup, FreeElem,
-                                VR, "GDCM", NewTagName);
-   NewElVal = new gdcmElValue(NewEntry);
-   PubElValSet.Add(NewElVal);
-   return NewElVal;
-}
-
-/**
- * \ingroup gdcmHeader
- * \brief   Loads the element values of all the elements present in the
- *          public tag based hash table.
- */
-void gdcmHeader::LoadElements(void) {
-   rewind(fp);   
-   TagElValueHT ht = PubElValSet.GetTagHt();
-   for (TagElValueHT::iterator tag = ht.begin(); tag != ht.end(); ++tag) {
-      LoadElementValue(tag->second);
-   }
-}
-
-/**
-  * \ingroup gdcmHeader
-  * \brief
-  * @return
-  */ 
-void gdcmHeader::PrintPubElVal(std::ostream & os) {
-   PubElValSet.Print(os);
-}
-
-/**
-  * \ingroup gdcmHeader
-  * \brief
-  * @return
-  */  
-void gdcmHeader::PrintPubDict(std::ostream & os) {
-   RefPubDict->Print(os);
-}
-
-/**
-  * \ingroup gdcmHeader
-  * \brief
-  * @return
-  */
-  
-int gdcmHeader::Write(FILE * fp, FileType type) {
-   return PubElValSet.Write(fp, type);
-}
-
 /**
   * \ingroup gdcmHeader
-  * \brief
-  * @return
+  * \brief gets the info from 0028,0030 : Pixel Spacing
+  * \           else 1.
+  * @return X dimension of a pixel
   */
 float gdcmHeader::GetXSpacing(void) {
     float xspacing, yspacing;
     string StrSpacing = GetPubElValByNumber(0x0028,0x0030);
 
     if (StrSpacing == "gdcm::Unfound") {
-       dbg.Verbose(0, "gdcmHeader::GetXSpacing: unfound Pixel Spacing");
+       dbg.Verbose(0, "gdcmHeader::GetXSpacing: unfound Pixel Spacing (0028,0030)");
        return 1.;
      }
    if( sscanf( StrSpacing.c_str(), "%f\\%f", &xspacing, &yspacing) != 2)
@@ -1817,23 +1837,21 @@ float gdcmHeader::GetXSpacing(void) {
 
 /**
   * \ingroup gdcmHeader
-  * \brief
-  * @return
+  * \brief gets the info from 0028,0030 : Pixel Spacing
+  * \           else 1.
+  * @return Y dimension of a pixel
   */
 float gdcmHeader::GetYSpacing(void) {
    float xspacing, yspacing;
    string StrSpacing = GetPubElValByNumber(0x0028,0x0030);
   
    if (StrSpacing == "gdcm::Unfound") {
-      dbg.Verbose(0, "gdcmHeader::GetYSpacing: unfound Pixel Spacing");
+      dbg.Verbose(0, "gdcmHeader::GetYSpacing: unfound Pixel Spacing (0028,0030)");
       return 1.;
     }
-
   if( sscanf( StrSpacing.c_str(), "%f\\%f", &xspacing, &yspacing) != 2)
     return 0.;
-
-  if (yspacing == 0.)
-  {
+  if (yspacing == 0.) {
     dbg.Verbose(0, "gdcmHeader::GetYSpacing: gdcmData/CT-MONO2-8-abdo.dcm problem");
     // seems to be a bug in the header ...
     sscanf( StrSpacing.c_str(), "%f\\0\\%f", &xspacing, &yspacing);
@@ -1843,9 +1861,11 @@ float gdcmHeader::GetYSpacing(void) {
 
 
 /**
-  * \ingroup gdcmHeader
-  * \brief
-  * @return
+  *\ingroup gdcmHeader
+  *\brief gets the info from 0018,0088 : Space Between Slices
+  *\               else from 0018,0050 : Slice Thickness
+  *\               else 1.
+  * @return Z dimension of a voxel-to be
   */
 float gdcmHeader::GetZSpacing(void) {
    // TODO : translate into English
@@ -1867,6 +1887,10 @@ float gdcmHeader::GetZSpacing(void) {
       if (StrSliceThickness == "gdcm::Unfound")
          return 1.;
       else
+         // if no 'Spacing Between Slices' is found, 
+         // we assume slices join together
+         // (no overlapping, no interslice gap)
+         // if they don't, we're fucked up
          return atof(StrSliceThickness.c_str());  
    } else {
       return atof(StrSpacingBSlices.c_str());
@@ -1874,118 +1898,114 @@ float gdcmHeader::GetZSpacing(void) {
 }
 
 //
-//  Image Position Patient :
-// If not found (AVR-NEMA), we consider Slice Location (20,1041)
-// or Location (20,50) as the Z coordinate, 
-// 0. for all the coordinates if Slice Location not found
+// Image Position Patient                              (0020,0032):
+// If not found (ACR_NEMA) we try Image Position       (0020,0030)
+// If not found (ACR-NEMA), we consider Slice Location (0020,1041)
+//                                   or Location       (0020,0050) 
+// as the Z coordinate, 
+// 0. for all the coordinates if nothing is found
+
 // TODO : find a way to inform the caller nothing was found
 // TODO : How to tell the caller a wrong number of values was found?
+
 /**
   * \ingroup gdcmHeader
-  * \brief
-  * @return
+  * \brief gets the info from 0020,0032 : Image Position Patient
+  *\                else from 0020,0030 : Image Position (RET)
+  *\                else 0.
+  * @return up-left image corner position
   */
 float gdcmHeader::GetXImagePosition(void) {
-    float xImPos, yImPos, zImPos;
-    // 0020,0032 : Image Position Patient
-    // 0020,1041 : Slice Location
+    float xImPos, yImPos, zImPos;  
     string StrImPos = GetPubElValByNumber(0x0020,0x0032);
 
     if (StrImPos == "gdcm::Unfound") {
-       dbg.Verbose(0, "gdcmHeader::GetXImagePosition: unfound Image Position Patient");
-       string StrSliceLoc = GetPubElValByNumber(0x0020,0x1041);
-       if (StrSliceLoc == "gdcm::Unfound") {
-          dbg.Verbose(0, "gdcmHeader::GetXImagePosition: unfound Slice Location");
-          // How to tell the caller nothing was found?
-       }   
+       dbg.Verbose(0, "gdcmHeader::GetXImagePosition: unfound Image Position Patient (0020,0032)");
+       StrImPos = GetPubElValByNumber(0x0020,0x0030); // For ACR-NEMA images
+       if (StrImPos == "gdcm::Unfound") {
+          dbg.Verbose(0, "gdcmHeader::GetXImagePosition: unfound Image Position (RET) (0020,0030)");
+          // How to tell the caller nothing was found ?
+       }  
        return 0.;
      }
    if( sscanf( StrImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3)
-     // How to tell the caller a wrong number of values was found?
      return 0.;
-   //else
    return xImPos;
 }
 
 /**
   * \ingroup gdcmHeader
-  * \brief
-  * @return
+  * \brief gets the info from 0020,0032 : Image Position Patient
+  * \               else from 0020,0030 : Image Position (RET)
+  * \               else 0.
+  * @return up-left image corner position
   */
 float gdcmHeader::GetYImagePosition(void) {
     float xImPos, yImPos, zImPos;
-    // 0020,0032 : Image Position Patient
-    // 0020,1041 : Slice Location
-    // 0020,0050 : Location
     string StrImPos = GetPubElValByNumber(0x0020,0x0032);
 
     if (StrImPos == "gdcm::Unfound") {
-       dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Image Position Patient");
-       string StrSliceLoc = GetPubElValByNumber(0x0020,0x1041);
-       if (StrSliceLoc == "gdcm::Unfound") {
-          dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Slice Location");
-          // How to tell the caller nothing was found?
-          string StrLocation = GetPubElValByNumber(0x0020,0x0050);
-          if (StrSliceLoc == "gdcm::Unfound") {
-             dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Slice Location");          
-          }                    
-       }   
+       dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Image Position Patient (0020,0032)");
+       StrImPos = GetPubElValByNumber(0x0020,0x0030); // For ACR-NEMA images
+       if (StrImPos == "gdcm::Unfound") {
+          dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Image Position (RET) (0020,0030)");
+       }  
        return 0.;
      }
    if( sscanf( StrImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3)
-     // How to tell the caller a wrong number of values was found?
      return 0.;
-    //else
    return yImPos;
 }
 
 /**
   * \ingroup gdcmHeader
-  * \brief
-  * @return
+  * \brief gets the info from 0020,0032 : Image Position Patient
+  * \               else from 0020,0030 : Image Position (RET)
+  * \               else from 0020,1041 : Slice Location
+  * \               else from 0020,0050 : Location
+  * \               else 0.
+  * @return up-left image corner position
   */
 float gdcmHeader::GetZImagePosition(void) {
-   float xImPos, yImPos, zImPos;
-    // 0020,0032 : Image Position Patient
-    // 0020,1041 : Slice Location
-    // 0020,0050 : Location
-   
-   // TODO : How to tell the caller nothing was found?
-   // TODO : How to tell the caller a wrong number of values was found?
-  
+   float xImPos, yImPos, zImPos; 
    string StrImPos = GetPubElValByNumber(0x0020,0x0032);
    if (StrImPos != "gdcm::Unfound") {
       if( sscanf( StrImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3) {
-         dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Image Position Patient");
+         dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Image Position Patient (0020,0032)");
          return 0.;  // bug in the element 0x0020,0x0032
       } else {
          return zImPos;
       }    
-   }
-   dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Image Position Patient");
-        
-   string StrSliceLocation = GetPubElValByNumber(0x0020,0x1041);
+   }  
+   StrImPos = GetPubElValByNumber(0x0020,0x0030); // For ACR-NEMA images
+   if (StrImPos != "gdcm::Unfound") {
+      if( sscanf( StrImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3) {
+         dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Image Position (RET) (0020,0030)");
+         return 0.;  // bug in the element 0x0020,0x0032
+      } else {
+         return zImPos;
+      }    
+   }                
+   string StrSliceLocation = GetPubElValByNumber(0x0020,0x1041);// for *very* old ACR-NEMA images
    if (StrSliceLocation != "gdcm::Unfound") {
       if( sscanf( StrSliceLocation.c_str(), "%f", &zImPos) !=1) {
-         dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Slice Location");
+         dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Slice Location (0020,1041)");
          return 0.;  // bug in the element 0x0020,0x1041
       } else {
          return zImPos;
       }
    }   
-   dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Slice Location");
-
+   dbg.Verbose(0, "gdcmHeader::GetZImagePosition: unfound Slice Location (0020,1041)");
    string StrLocation = GetPubElValByNumber(0x0020,0x0050);
    if (StrLocation != "gdcm::Unfound") {
       if( sscanf( StrLocation.c_str(), "%f", &zImPos) !=1) {
-         dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Location");
+         dbg.Verbose(0, "gdcmHeader::GetZImagePosition: wrong Location (0020,0050)");
          return 0.;  // bug in the element 0x0020,0x0050
       } else {
          return zImPos;
       }
    }
-   dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Slice Location");
-   
+   dbg.Verbose(0, "gdcmHeader::GetYImagePosition: unfound Location (0020,0050)");  
    return 0.; // Hopeless
 }