]> Creatis software - gdcm.git/blobdiff - src/gdcmDocument.cxx
Doxygenation
[gdcm.git] / src / gdcmDocument.cxx
index 2a91d1c2134570f346508425820150313c0256ed..2cc0770d6e963f9346f3203a73f7655345b64b24 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmDocument.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/12/06 11:37:38 $
-  Version:   $Revision: 1.147 $
+  Date:      $Date: 2005/01/06 14:49:16 $
+  Version:   $Revision: 1.156 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -182,8 +182,6 @@ Document::Document( std::string const & filename ) : ElementSet(-1)
          SetEntryByNumber(rows   , 0x0028, 0x0011);
    }
    // ----------------- End of ACR-LibIDO kludge ------------------ 
-
-   PrintLevel = 1;  // 'Medium' print level by default
 }
 
 /**
@@ -198,7 +196,6 @@ Document::Document() : ElementSet(-1)
    Initialise();
    SwapCode = 0;
    Filetype = ExplicitVR;
-   PrintLevel = 1;  // 'Medium' print level by default
 }
 
 /**
@@ -222,6 +219,7 @@ Document::~Document ()
   */  
 void Document::PrintPubDict(std::ostream & os)
 {
+   RefPubDict->SetPrintLevel(PrintLevel);
    RefPubDict->Print(os);
 }
 
@@ -231,6 +229,7 @@ void Document::PrintPubDict(std::ostream & os)
   */
 void Document::PrintShaDict(std::ostream & os)
 {
+   RefShaDict->SetPrintLevel(PrintLevel);
    RefShaDict->Print(os);
 }
 
@@ -442,7 +441,12 @@ std::ifstream* Document::OpenFile()
    }
  
    uint16_t zero;
-   Fp->read((char*)&zero,  (size_t)2 );
+   Fp->read((char*)&zero, (size_t)2);
+   if( Fp->eof() )
+   {
+      CloseFile();
+      return 0;
+   }
  
    //ACR -- or DICOM with no Preamble; may start with a Shadow Group --
    if( 
@@ -458,6 +462,11 @@ std::ifstream* Document::OpenFile()
    Fp->seekg(126L, std::ios::cur);
    char dicm[4];
    Fp->read(dicm,  (size_t)4);
+   if( Fp->eof() )
+   {
+      CloseFile();
+      return 0;
+   }
    if( memcmp(dicm, "DICM", 4) == 0 )
    {
       return Fp;
@@ -526,7 +535,7 @@ void Document::WriteContent(std::ofstream* fp, FileType filetype)
 }
 
 /**
- * \brief   Modifies the value of a given Header Entry (Dicom Element)
+ * \brief   Modifies the value of a given Doc Entry (Dicom Element)
  *          when it exists. Create it with the given value when unexistant.
  * @param   value (string) Value to be set
  * @param   group   Group number of the Entry 
@@ -618,6 +627,7 @@ ValEntry* Document::ReplaceOrCreateByNumber(
  * @param   binArea (binary) value to be set
  * @param   Group   Group number of the Entry 
  * @param   Elem  Element number of the Entry
+ * @param   vr  V(alue) R(epresentation) of the Entry -if private Entry-
  * \return  pointer to the modified/created Header Entry (NULL when creation
  *          failed).
  */
@@ -829,7 +839,6 @@ std::string Document::GetEntryVRByName(TagName const& tagName)
 std::string Document::GetEntryByNumber(uint16_t group, uint16_t element)
 {
    TagKey key = DictEntry::TranslateToKey(group, element);
-   /// \todo use map methods, instead of multimap JPR
    if ( !TagHT.count(key))
    {
       return GDCM_UNFOUND;
@@ -909,9 +918,6 @@ bool Document::SetEntryByName( std::string const & content,
 bool Document::SetEntryByNumber(std::string const& content, 
                                 uint16_t group, uint16_t element) 
 {
-   int c;
-   int l;
-
    ValEntry* valEntry = GetValEntryByNumber(group, element);
    if (!valEntry )
    {
@@ -920,29 +926,7 @@ bool Document::SetEntryByNumber(std::string const& content,
       return false;
    }
    // Non even content must be padded with a space (020H)...
-   std::string finalContent = Util::DicomString( content.c_str() );
-   assert( !(finalContent.size() % 2) );
-   valEntry->SetValue(finalContent);
-
-   // Integers have a special treatement for their length:
-   l = finalContent.length();
-   if ( l != 0) // To avoid to be cheated by 'zero length' integers
-   {   
-      VRKey vr = valEntry->GetVR();
-      if( vr == "US" || vr == "SS" )
-      {
-         // for multivaluated items
-         c = Util::CountSubstring(content, "\\") + 1;
-         l = c*2;
-      }
-      else if( vr == "UL" || vr == "SL" )
-      {
-         // for multivaluated items
-         c = Util::CountSubstring(content, "\\") + 1;
-         l = c*4;;
-      }
-   }
-   valEntry->SetLength(l);
+   valEntry->SetValue(content);
    return true;
 } 
 
@@ -980,53 +964,6 @@ bool Document::SetEntryByNumber(uint8_t*content, int lgth,
    return true;
 } 
 
-/**
- * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
- *          in the PubDocEntrySet of this instance
- *          through it's (group, element) and modifies it's length with
- *          the given value.
- * \warning Use with extreme caution.
- * @param l new length to substitute with
- * @param group     group number of the Entry to modify
- * @param element element number of the Entry to modify
- * @return  true on success, false otherwise.
- */
-/*bool Document::SetEntryLengthByNumber(uint32_t l, 
-                                      uint16_t group, uint16_t element) 
-{
-   /// \todo use map methods, instead of multimap JPR
-   TagKey key = DictEntry::TranslateToKey(group, element);
-   if ( !TagHT.count(key) )
-   {
-      return false;
-   }
-   if ( l % 2 )
-   {
-      l++; // length must be even
-   }
-   ( ((TagHT.equal_range(key)).first)->second )->SetLength(l); 
-
-   return true ;
-}*/
-
-/**
- * \brief   Gets (from Header) the offset  of a 'non string' element value 
- *          (LoadElementValues has already be executed)
- * @param group   group number of the Entry 
- * @param elem  element number of the Entry
- * @return File Offset of the Element Value 
- */
-/*size_t Document::GetEntryOffsetByNumber(uint16_t group, uint16_t elem) 
-{
-   DocEntry* entry = GetDocEntryByNumber(group, elem);
-   if (!entry) 
-   {
-      dbg.Verbose(1, "Document::GetDocEntryByNumber: no entry present.");
-      return 0;
-   }
-   return entry->GetOffset();
-}*/
-
 /**
  * \brief   Gets (from Header) a 'non string' element value 
  *          (LoadElementValues has already be executed)  
@@ -1134,54 +1071,6 @@ void Document::LoadEntryBinArea(BinEntry* element)
    return false;
 }*/
 
-/**
- * \brief   Update the entries with the shadow dictionary. 
- *          Only non even entries are analyzed       
- */
-void Document::UpdateShaEntries()
-{
-   //DictEntry *entry;
-   std::string vr;
-   
-   /// \todo TODO : still any use to explore recursively the whole structure?
-/*
-   for(ListTag::iterator it=listEntries.begin();
-       it!=listEntries.end();
-       ++it)
-   {
-      // Odd group => from public dictionary
-      if((*it)->GetGroup()%2==0)
-         continue;
-
-      // Peer group => search the corresponding dict entry
-      if(RefShaDict)
-         entry=RefShaDict->GetDictEntryByNumber((*it)->GetGroup(),(*it)->GetElement());
-      else
-         entry=NULL;
-
-      if((*it)->IsImplicitVR())
-         vr="Implicit";
-      else
-         vr=(*it)->GetVR();
-
-      (*it)->SetValue(GetDocEntryUnvalue(*it));  // to go on compiling
-      if(entry){
-         // Set the new entry and the new value
-         (*it)->SetDictEntry(entry);
-         CheckDocEntryVR(*it,vr);
-
-         (*it)->SetValue(GetDocEntryValue(*it));    // to go on compiling
-      }
-      else
-      {
-         // Remove precedent value transformation
-         (*it)->SetDictEntry(NewVirtualDictEntry((*it)->GetGroup(),(*it)->GetElement(),vr));
-      }
-   }
-*/   
-}
-
 /**
  * \brief   Searches within the Header Entries for a Dicom Element of
  *          a given tag.
@@ -1882,14 +1771,10 @@ void Document::FindDocEntryLength( DocEntry *entry )
  * \brief     Find the Value Representation of the current Dicom Element.
  * @param     entry
  */
-void Document::FindDocEntryVR( DocEntry *entry )
+std::string Document::FindDocEntryVR()
 {
    if ( Filetype != ExplicitVR )
-   {
-      return;
-   }
-
-   char vr[3];
+      return(GDCM_UNKNOWN);
 
    long positionOnEntry = Fp->tellg();
    // Warning: we believe this is explicit VR (Value Representation) because
@@ -1899,25 +1784,17 @@ void Document::FindDocEntryVR( DocEntry *entry )
    // within an explicit VR file. Hence we make sure the present tag
    // is in explicit VR and try to fix things if it happens not to be
    // the case.
-   vr[0] = 0x00;
-   vr[1] = 0x00;
+
+   char vr[3];
    Fp->read (vr, (size_t)2);
    vr[2] = 0;
 
-   if( !CheckDocEntryVR(entry, vr) )
+   if( !CheckDocEntryVR(vr) )
    {
       Fp->seekg(positionOnEntry, std::ios::beg);
-      // When this element is known in the dictionary we shall use, e.g. for
-      // the semantics (see the usage of IsAnInteger), the VR proposed by the
-      // dictionary entry. Still we have to flag the element as implicit since
-      // we know now our assumption on expliciteness is not furfilled.
-      // avoid  .
-      if ( entry->IsVRUnknown() )
-      {
-         entry->SetVR("Implicit");
-      }
-      entry->SetImplicitVR();
+      return(GDCM_UNKNOWN);
    }
+   return(vr);
 }
 
 /**
@@ -1929,76 +1806,13 @@ void Document::FindDocEntryVR( DocEntry *entry )
  * @return    false if the VR is incorrect of if the VR isn't referenced
  *            otherwise, it returns true
 */
-bool Document::CheckDocEntryVR(DocEntry *entry, VRKey vr)
+bool Document::CheckDocEntryVR(VRKey vr)
 {
-   std::string msg;
-   bool realExplicit = true;
-
-   // Assume we are reading a falsely explicit VR file i.e. we reached
-   // a tag where we expect reading a VR but are in fact we read the
-   // first to bytes of the length. Then we will interogate (through find)
-   // the dicom_vr dictionary with oddities like "\004\0" which crashes
-   // both GCC and VC++ implementations of the STL map. Hence when the
-   // expected VR read happens to be non-ascii characters we consider
-   // we hit falsely explicit VR tag.
-
-   if ( !isalpha((unsigned char)vr[0]) && !isalpha((unsigned char)vr[1]) )
-   {
-      realExplicit = false;
-   }
-
    // CLEANME searching the dicom_vr at each occurence is expensive.
    // PostPone this test in an optional integrity check at the end
    // of parsing or only in debug mode.
-   if ( realExplicit && !Global::GetVR()->Count(vr) )
-   {
-      realExplicit = false;
-   }
-
-   if ( !realExplicit ) 
-   {
-      // We thought this was explicit VR, but we end up with an
-      // implicit VR tag. Let's backtrack.   
-      msg = Util::Format("Falsely explicit vr file (%04x,%04x)\n", 
-                    entry->GetGroup(), entry->GetElement());
-      dbg.Verbose(1, "Document::FindVR: ", msg.c_str());
-
-      if( entry->GetGroup() % 2 && entry->GetElement() == 0x0000)
-      {
-         // Group length is UL !
-         DictEntry* newEntry = NewVirtualDictEntry(
-                                   entry->GetGroup(), entry->GetElement(),
-                                   "UL", "FIXME", "Group Length");
-         entry->SetDictEntry( newEntry );
-      }
+   if ( !Global::GetVR()->IsValidVR(vr) )
       return false;
-   }
-
-   if ( entry->IsVRUnknown() )
-   {
-      // When not a dictionary entry, we can safely overwrite the VR.
-      if( entry->GetElement() == 0x0000 )
-      {
-         // Group length is UL !
-         entry->SetVR("UL");
-      }
-      else
-      {
-         entry->SetVR(vr);
-      }
-   }
-   else if ( entry->GetVR() != vr ) 
-   {
-      // The VR present in the file and the dictionary disagree. We assume
-      // the file writer knew best and use the VR of the file. Since it would
-      // be unwise to overwrite the VR of a dictionary (since it would
-      // compromise it's next user), we need to clone the actual DictEntry
-      // and change the VR for the read one.
-      DictEntry* newEntry = NewVirtualDictEntry(
-                                entry->GetGroup(), entry->GetElement(),
-                                vr, "FIXME", entry->GetName());
-      entry->SetDictEntry(newEntry);
-   }
 
    return true; 
 }
@@ -2279,8 +2093,7 @@ bool Document::IsDocEntryAnInteger(DocEntry *entry)
    if ( vr == "UL" || vr == "US" || vr == "SL" || vr == "SS" )
    {
       return true;
-   }
-   
+   }   
    return false;
 }
 
@@ -2704,7 +2517,6 @@ void Document::HandleBrokenEndian(uint16_t group, uint16_t elem)
      reversedEndian--;
      SwitchSwapToBigEndian();
    }
-
 }
 
 /**
@@ -2733,8 +2545,22 @@ DocEntry* Document::ReadNextDocEntry()
    }
 
    HandleBrokenEndian(group, elem);
-   DocEntry *newEntry = NewDocEntryByNumber(group, elem);
-   FindDocEntryVR(newEntry);
+   std::string vr=FindDocEntryVR();
+
+   DocEntry *newEntry = NewDocEntryByNumber(group, elem, vr);
+   if( vr == GDCM_UNKNOWN )
+   {
+      if( Filetype == ExplicitVR )
+      {
+         // We thought this was explicit VR, but we end up with an
+         // implicit VR tag. Let's backtrack.   
+         std::string msg;
+         msg = Util::Format("Falsely explicit vr file (%04x,%04x)\n", 
+                       newEntry->GetGroup(), newEntry->GetElement());
+         dbg.Verbose(1, "Document::FindVR: ", msg.c_str());
+      }
+      newEntry->SetImplicitVR();
+   }
 
    try
    {
@@ -3194,6 +3020,52 @@ bool Document::operator<(Document &document)
    return false;
 }
 
+
+/**
+ * \brief   Re-computes the length of a ACR-NEMA/Dicom group from a DcmHeader
+ * @param filetype Type of the File to be written 
+ */
+int Document::ComputeGroup0002Length( FileType filetype ) 
+{
+   uint16_t gr, el;
+   std::string vr;
+   
+   int groupLength = 0;
+   bool found0002 = false;   
+  
+   // for each zero-level Tag in the DCM Header
+   DocEntry *entry;
+
+   Initialize();
+   entry = GetNextEntry();
+   while(entry)
+   {
+      gr = entry->GetGroup();
+
+      if (gr == 0x0002)
+      {
+         found0002 = true;
+
+         el = entry->GetElement();
+         vr = entry->GetVR();            
+         if (filetype == ExplicitVR) 
+         {
+            if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") ) 
+            {
+               groupLength +=  4; // explicit VR AND OB, OW, SQ : 4 more bytes
+            }
+         }
+         groupLength += 2 + 2 + 4 + entry->GetLength();   
+      }
+      else if (found0002 )
+         break;
+
+      entry = GetNextEntry();
+   }
+   return groupLength; 
+}
+
 } // end namespace gdcm
 
 //-----------------------------------------------------------------------------