]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.cxx
avoid Doxygen Warnings
[gdcm.git] / src / gdcmDocument.cxx
index 8534ae6d7d6c4c34da777367aa83a539f1a78e92..fcef258b7771c7ca60703d6146ec91daa6b591ac 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2006/10/19 10:30:45 $
-  Version:   $Revision: 1.354 $
+  Date:      $Date: 2007/09/18 15:56:41 $
+  Version:   $Revision: 1.370 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -37,7 +37,7 @@
    #include <mem.h> // for memset
 #endif 
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
 //-----------------------------------------------------------------------------
 
@@ -50,7 +50,7 @@ const unsigned int Document::MAX_SIZE_LOAD_ELEMENT_VALUE = 0xfff; // 4096
 
 /**
  * \brief This default constructor neither loads nor parses the file. 
- *        You should then invoke \ref Document::Load.
+ *        You should then invoke Document::Load.
  *         
  */
 Document::Document() 
@@ -70,6 +70,8 @@ Document::Document()
    LoadMode = LD_ALL; // default : load everything, later
    
    SetFileName("");
+   changeFromUN=false;
+   UnexpectedEOF=false;
 }
 
 /**
@@ -244,7 +246,7 @@ bool Document::DoTheLoadingDocumentJob(  )
 
    // Force Loading some more elements if user asked to.
 
-   gdcm::DocEntry *d;
+   GDCM_NAME_SPACE::DocEntry *d;
    for (ListElements::iterator it = UserForceLoadList.begin();  
                                it != UserForceLoadList.end();
                              ++it)
@@ -580,9 +582,10 @@ double Document::SwapDouble(double a)
 //
 // -----------------File I/O ---------------
 /**
- * \brief  Tries to open the file \ref Document::Filename and
- *         checks the preamble when existing.
- * @return The FILE pointer on success. 
+ * \brief  Tries to open the file Document::Filename and
+ *         checks the preamble when existing,
+ *         or if the file starts with an ACR-NEMA look-like element.
+ * @return The FILE pointer on success, 0 on failure. 
  */
 std::ifstream *Document::OpenFile()
 {
@@ -634,6 +637,7 @@ std::ifstream *Document::OpenFile()
       CloseFile();
       return 0;
    }
+   
    if ( memcmp(dicm, "DICM", 4) == 0 )
    {
       HasDCMPreamble = true;
@@ -717,8 +721,10 @@ void Document::WriteContent(std::ofstream *fp, FileType filetype)
     * --> was too much tricky / we were [in a hurry / too lazy]
     * --> We don't write the element 0x0000 (group length)
     */
-
-   ElementSet::WriteContent(fp, filetype); // This one is recursive
+ // This one is recursive
+ // false : outside MetaElements
+ // false : outside Sequence
+   ElementSet::WriteContent(fp, filetype, false, false);
 }
 
 // -----------------------------------------
@@ -847,7 +853,7 @@ void Document::LoadEntryBinArea(DataEntry *entry)
 //}
 
 /**
- * \brief   Compares two documents, according to \ref DicomDir rules
+ * \brief   Compares two documents, according to DicomDir rules
  * \warning Does NOT work with ACR-NEMA files
  * \todo    Find a trick to solve the pb (use RET fields ?)
  * @param   document to compare with current one
@@ -916,7 +922,7 @@ bool Document::operator<(Document &document)
 
 /**
  * \brief Reads a given length of bytes
- *       (in order to avoid to many CPU time consuming fread-s)
+ *       (in order to avoid to many CPU time-consuming fread-s)
  * @param l length to read 
  */
 void Document::ReadBegBuffer(size_t l)
@@ -1280,11 +1286,11 @@ void Document::ParseDES(DocEntrySet *set, long offset,
                                << " at offset 0x(" << std::hex
                                << newDocEntry->GetOffset() << ")");
 
-            ParseSQ( newSeqEntry, 
-                     newDocEntry->GetOffset(),
-                     l, delim_mode_intern);
+            bool res = ParseSQ( newSeqEntry, 
+                         newDocEntry->GetOffset(),
+                         l, delim_mode_intern);
 
-            gdcmDebugMacro( "Exit from ParseSQ, delim " << delim_mode_intern);
+            gdcmDebugMacro( "Exit from ParseSQ, delim " << delim_mode_intern << " -->return : " << res);
          }
          if ( !set->AddEntry( newSeqEntry ) )
          {
@@ -1316,15 +1322,18 @@ void Document::ParseDES(DocEntrySet *set, long offset,
          newDocEntry->Delete();
       }
       first = false;
+      
+      if (UnexpectedEOF) // some terminator was missing
+         break;
    }                               // end While
    gdcmDebugMacro( "Exit from ParseDES, delim-mode " << delim_mode );
 }
 
 /**
  * \brief   Parses a Sequence ( SeqEntry after SeqEntry)
- * @return  parsed length for this level
+ * @return  false if expected fff0,e000 not found
  */ 
-void Document::ParseSQ( SeqEntry *seqEntry,
+bool Document::ParseSQ( SeqEntry *seqEntry,
                         long offset, long l_max, bool delim_mode)
 {
    int SQItemNumber = 0;
@@ -1337,9 +1346,11 @@ void Document::ParseSQ( SeqEntry *seqEntry,
       DocEntry *newDocEntry = ReadNextDocEntry();
 
       if ( !newDocEntry )
-      {
+      { 
+         // The most frequent is when a SQ terminator is missing (?!?)
          gdcmWarningMacro("in ParseSQ : should never get here!");
-         break;
+         UnexpectedEOF = true;
+         return false;
       }
       if ( delim_mode )
       {
@@ -1387,6 +1398,7 @@ void Document::ParseSQ( SeqEntry *seqEntry,
          break;
       }
    }
+   return true;
 }
 
 /**
@@ -1500,12 +1512,22 @@ void Document::FindDocEntryLength( DocEntry *entry )
 {
    const VRKey &vr  = entry->GetVR();
    uint16_t length16;       
-   
    if ( Filetype == ExplicitVR && !entry->IsImplicitVR() ) 
    {
+   
+   // WARNING :
+   //
+   // For some images, length of UN elements is coded on 2 bytes (instead of 4)
+   // There are *not* readable !
+   // You can make a quick and dirty patch, commenting out 
+   //| vr == "UN"
+   // in the following line.
+   // (the 'straight' images will no longer be readable ...)
+   
       if ( vr == "OB" || vr == "OW" || vr == "SQ" || vr == "UT" 
-                                                           || vr == "UN" )
+                                                          || vr == "UN" || changeFromUN == true)
       {
+         changeFromUN = false;
          // The following reserved two bytes (see PS 3.5-2003, section
          // "7.1.2 Data element structure with explicit vr", p 27) must be
          // skipped before proceeding on reading the length on 4 bytes.
@@ -1547,11 +1569,9 @@ void Document::FindDocEntryLength( DocEntry *entry )
          FixDocEntryFoundLength(entry, length32); 
          return;
       }
-
       // Length is encoded on 2 bytes.
       //length16 = ReadInt16();
       length16 = GetInt16();
-
       // 0xffff means that we deal with 'No Length' Sequence 
       //        or 'No Length' SQItem
       if ( length16 == 0xffff) 
@@ -1851,7 +1871,7 @@ bool Document::IsDocEntryAnInteger(DocEntry *entry)
 
    // When we have some semantics on the element we just read, and if we
    // a priori know we are dealing with an integer, then we shall be
-   // able to swap it's element value properly.
+   // able to swap its element value properly.
    if ( elem == 0 )  // This is the group length of the group
    {  
       if ( length == 4 )
@@ -1927,7 +1947,7 @@ bool Document::CheckSwap()
       // i.e. a total of  136 bytes.
       entCur = deb + 136;
      
-      // group 0x0002 *is always* Explicit VR Sometimes ,
+      // group 0x0002 *is always* Explicit VR Sometimes,
       // even if elem 0002,0010 (Transfer Syntax) tells us the file is
       // *Implicit* VR  (see former 'gdcmData/icone.dcm')
       
@@ -1950,6 +1970,8 @@ bool Document::CheckSwap()
                         << "Looks like a bugged Header!");
       }
       
+      // Here, we assume that the file IS kosher Dicom !
+      // (The meta elements - group 0x0002 - ARE little endian !)
       if ( net2host )
       {
          SwapCode = 4321;
@@ -2058,8 +2080,7 @@ bool Document::CheckSwap()
          s16 = *((uint16_t *)(deb));
  
          gdcmDebugMacro("not a DicomV3 nor a 'clean' ACR/NEMA;"
-                     << " (->despaired wild guesses !)"); 
-      
+                     << " (->despaired wild guesses !)");       
          switch ( s16 )
          {
             case 0x0001 :
@@ -2087,9 +2108,47 @@ bool Document::CheckSwap()
                Filetype = ACR;
                return true;
             default :
-               gdcmWarningMacro("ACR/NEMA unfound swap info (Hopeless !)");
-               Filetype = Unknown;
-               return false;
+    
+               s16 = *((uint16_t *)(deb));
+               if (s16 != 0x0000)
+                   return false;
+               s16 = *((uint16_t *)(deb+2));
+
+               Fp->seekg ( 0L, std::ios::beg); // Once per Document
+               CurrentOffsetPosition = 0;
+               switch(s16)  // try an other trick!
+                            // -> to be able to decode 0029|1010 DataElement
+                            // -> and be not less cleaver than dcmdump ;-)
+               {
+                  case 0x0004 :
+                     SwapCode = 1234; 
+                     break;
+                  case 0x0400 :
+                     SwapCode = 3412;
+                     break;      
+                  default:
+                     gdcmWarningMacro("ACR/NEMA unfound swap info (Hopeless !)");
+                     Filetype = Unknown;
+                     return false;
+               }
+               // Check if next 2 bytes are a VR
+               // Probabely something more time-consuming exists with std::string
+               const char VRvalues[] = "AEASATCSDADTFLFDISLOLTPNSHSLSSSTTMUIULUSUTOBOWOFATUNSQRT";
+               int nbVal = 28;
+               const char *pt = VRvalues;
+               for (int i=0;i<nbVal;i++)
+               {
+                  if(*(deb+4) == *pt++) {
+                    if(*(deb+5) == *pt++) {
+                       Filetype = ExplicitVR;
+                       return true;
+                    }
+                    else {
+                       pt++;
+                    }
+              }
+              Filetype = ImplicitVR;
+              return true;       
          }
    }
 }
@@ -2160,9 +2219,10 @@ DocEntry *Document::ReadNextDocEntry()
       return 0;
    }
    
+   changeFromUN = false;
    CurrentGroup = GetInt16();
    CurrentElem  = GetInt16();
-   
+      
    // In 'true DICOM' files Group 0002 is always little endian
    if ( HasDCMPreamble )
    {
@@ -2187,18 +2247,26 @@ DocEntry *Document::ReadNextDocEntry()
          realVR = "UL";
       }
 
-      // Commented out in order not to generate 'Shadow Groups' where some 
+      // Was commented out in order not to generate 'Shadow Groups' where some 
       // Data Elements are Explicit VR and some other ones Implicit VR
-      // (Stupid MatLab DICOM Reader couldn't read gdcm-written images)
-      /*
-      else if (CurrentGroup%2 == 1 &&  
-                               (CurrentElem >= 0x0010 && CurrentElem <=0x00ff ))
-      {  
-      // DICOM PS 3-5 7.8.1 a) states that those 
-      // (gggg-0010->00FF where gggg is odd) attributes have to be LO
-         realVR = "LO";
+      // -> Better we fix the problem at Write time
+     
+      else if (CurrentGroup%2 == 1 )
+      { 
+         if (CurrentElem >= 0x0010 && CurrentElem <=0x00ff )
+            // DICOM PS 3-5 7.8.1 a) states that :
+            // Private Creator Data Elements numbered (gggg,0010-00FF) (gggg is odd)
+            // attributes have to be LO (Long String) and the VM shall be equal to 1
+            realVR = "LO";
+    
+            // Seems not to be true
+            // Still in gdcmtk, David Clunnie disagrees, Marco Eichelberg says it's OK ...
+            // We let it for a while? 
+            //(We should check length==4, for more security, but we don't have it yet !)
+         else if ( CurrentElem == 0x0001)
+            realVR = "UL"; // Private Group Length To End      
       }
-      */
+      
       else
       {
          DictEntry *dictEntry = GetDictEntry(CurrentGroup,CurrentElem);//only when ImplicitVR
@@ -2210,6 +2278,26 @@ DocEntry *Document::ReadNextDocEntry()
       }
    }
 
+   // if UN found, let's check the dictionary, and trust it!
+   // (maybe a private dictionary exists?)    
+   else if (vr == "UN")
+   {
+      DictEntry *dictEntry = GetDictEntry(CurrentGroup,CurrentElem);
+      if ( dictEntry )
+      {
+         realVR = dictEntry->GetVR(); 
+         dictEntry->Unregister(); // GetDictEntry registered it
+
+         // for VR = "UN", length is always stored on 4 bytes.
+         changeFromUN=true;
+         /// \todo : fixme If inside a supposed to be UN DataElement (but SQ according to a private dictionnary)
+         ///         there is some more supposed to be UN DataElements, it will probabely fail.
+         ///         --> find a -non time consuming- trick to store changeFromUN info at DataElement level,
+         ///         not at the Document level.
+      }   
+   }
+
+
    DocEntry *newEntry;
    //if ( Global::GetVR()->IsVROfSequence(realVR) )
    if (realVR == "SQ")
@@ -2353,9 +2441,13 @@ void Document::HandleOutOfGroup0002(uint16_t &group, uint16_t &elem)
       //
       // --> Probabely normal, since we considered we never have 
       // to trust manufacturers.
-      // (we find very often 'Implicit VR' tag, 
+      // (we often find 'Implicit VR' tag, 
       // even when Transfer Syntax tells us it's Explicit ...
       
+       // NEVER trust the meta elements!
+       // (see what ezDICOM does ...)
+             
+      /*
       if ( s ==  TS::ExplicitVRBigEndian )
       {
          gdcmDebugMacro("Transfer Syntax Name = [" 
@@ -2364,7 +2456,20 @@ void Document::HandleOutOfGroup0002(uint16_t &group, uint16_t &elem)
          group = SwapShort(group);
          elem  = SwapShort(elem);
       }
-
+      */
+    //-- Broken ACR  may start with a Shadow Group --
+    // worse : some ACR-NEMA like files start 00028 group ?!? 
+    if ( !( (group >= 0x0001 && group <= 0x0008) || group == 0x0028 ) )
+    {
+       // We trust what we see.
+       SwitchByteSwapCode();
+       group = SwapShort(group);
+       elem  = SwapShort(elem); 
+       // not what we where told (by meta elements) !
+       gdcmDebugMacro("Transfer Syntax Name = ["       
+                       << GetTransferSyntaxName() << "]" );         
+    }
+      
       /// \todo  find a trick to warn user and stop processing
             
       if ( s == TS::DeflatedExplicitVRLittleEndian)