]> Creatis software - gdcm.git/blobdiff - src/gdcmElementSet.cxx
Fix mistypings
[gdcm.git] / src / gdcmElementSet.cxx
index 50e40f35769cc1c58b3c615d0a75f3b5daf06832..31f74ae64890537f8d0d688992a557e32a3364ad 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2004/06/23 13:02:36 $
-  Version:   $Revision: 1.13 $
+  Date:      $Date: 2008/05/19 09:25:42 $
+  Version:   $Revision: 1.80 $
                                                                                 
   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.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
                                                                                 
      This software is distributed WITHOUT ANY WARRANTY; without even
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 
 #include "gdcmElementSet.h"
 #include "gdcmDebug.h"
-#include "gdcmValEntry.h"
-#include "gdcmBinEntry.h"
 #include "gdcmSeqEntry.h"
+#include "gdcmDataEntry.h"
 
+namespace GDCM_NAME_SPACE 
+{
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
- * \ingroup gdcmElementSet
- * \brief   Constructor from a given gdcmElementSet
+ * \brief   Constructor for a given ElementSet
  */
-gdcmElementSet::gdcmElementSet(int depthLevel) 
-              : gdcmDocEntrySet(depthLevel) {
+ElementSet::ElementSet() 
+          : DocEntrySet()
+{
 }
 
 /**
- * \ingroup gdcmElementSet
  * \brief   Canonical destructor.
  */
-gdcmElementSet::~gdcmElementSet() 
+ElementSet::~ElementSet() 
 {
-  gdcmDocEntry* EntryToDelete;  
-  for(TagDocEntryHT::iterator cc = tagHT.begin();cc != tagHT.end();++cc)
-   {
-      EntryToDelete = cc->second;
-      if ( EntryToDelete )
-         delete EntryToDelete;
-   }
-   tagHT.clear();
+   ClearEntry();
 }
 
-
 //-----------------------------------------------------------------------------
 // Public
-
-
-//-----------------------------------------------------------------------------
-// Print
 /**
-  * \brief   Prints the Header Entries (Dicom Elements)
+  * \brief   Writes the Header Entries (Dicom Elements)
   *          from the H Table
-  * @return
+  * @param fp ofstream to write to  
+  * @param filetype    ExplicitVR/ImplicitVR/ACR/ACR_LIBIDO/JPEG/JPEG2000/...
   */ 
-void gdcmElementSet::Print(std::ostream & os)
+void ElementSet::WriteContent(std::ofstream *fp, FileType filetype, bool dummy, bool dummy2)
 {
-   gdcmDocEntry* Entry;
-   for (TagDocEntryHT::iterator i = tagHT.begin(); i != tagHT.end(); ++i)  
+   bool insideMetaElements     = false;
+   bool yetOutsideMetaElements = false;
+   (void)dummy2;(void)dummy;
+   
+   for (TagDocEntryHT::const_iterator i = TagHT.begin(); 
+                                     i != TagHT.end(); 
+                                    ++i)
    {
-      Entry = i->second;
-      Entry->Print(os);   
-      bool PrintEndLine = true;
-      if ( gdcmSeqEntry* SeqEntry = dynamic_cast<gdcmSeqEntry*>(Entry) )
-         PrintEndLine = false;
-      if (PrintEndLine)
-         os << std::endl;
+        int group = (i->second)->GetGroup();
+       
+       if (yetOutsideMetaElements==false && group == 0x0002)
+          insideMetaElements = true;
+    
+       if (insideMetaElements == true && group != 0x0002)
+       {
+          yetOutsideMetaElements = true;
+          insideMetaElements     = false;
+       }
+   
+       // depending on the gdcm::Document type 
+       // (gdcm::File; gdcm::DicomDir, (more to come ?)
+       // some groups *cannot* be present.
+       // We hereby protect gdcm for writting stupid things
+       // if they were found in the original document. 
+       if ( !MayIWrite( group ) )
+          continue;
+  
+      // Skip 'Group Length' element, since it may be wrong.
+      //       except for Group 0x0002
+      // ( keep it as well for Group 0x0008 of ACR Files, 
+      //  since some ACR readers *need* it )
+      
+       if ( (i->second)->GetElement() != 0x0000 
+           || 
+            (  (i->second)->GetGroup() == 0x0002 
+             ||( (filetype == ACR || filetype == ACR_LIBIDO ) && (i->second)->GetGroup() == 0x0008 ) )
+        )
+       {           
+             // There are DocEntries, written recursively
+             // false : we are outside any Sequence
+             i->second->WriteContent(fp, filetype, insideMetaElements, false );
+       }             
    } 
 }
 
 /**
-  * \brief   Writes the Header Entries (Dicom Elements)
-  *          from the H Table
-  * @return
-  */ 
-void gdcmElementSet::Write(FILE *fp, FileType filetype)
+ * \brief   add a new Dicom Element pointer to the H Table
+ * @param   newEntry entry to add
+ */
+bool ElementSet::AddEntry(DocEntry *newEntry)
 {
+   const TagKey &key = newEntry->GetKey();
 
-   for (TagDocEntryHT::iterator i = tagHT.begin(); i != tagHT.end(); ++i)  
+   if ( TagHT.count(key) == 1 )
    {
-      i->second->Write(fp, filetype);
-   } 
+      gdcmWarningMacro( "Key already present: " << key );
+      return false;
+   }
+   else
+   {
+      TagHT.insert(TagDocEntryHT::value_type(newEntry->GetKey(), newEntry));
+      newEntry->Register();
+      return true;
+   }
 }
-//-----------------------------------------------------------------------------
-// Protected
 
-//-----------------------------------------------------------------------------
+/**
+ * \brief   Clear the hash table from given entry AND delete the entry.
+ * @param   entryToRemove Entry to remove AND delete.
+ */
+bool ElementSet::RemoveEntry( DocEntry *entryToRemove)
+{
+   const TagKey &key = entryToRemove->GetKey();
+   if ( TagHT.count(key) == 1 )
+   {
+      TagHT.erase(key);
+      entryToRemove->Unregister();
+      return true;
+   }
 
-//-----------------------------------------------------------------------------
-// Private
+   gdcmWarningMacro( "Key not present : " << key);
+   return false ;
+}
 
 /**
- * \brief   add a new Dicom Element pointer to the H Table
- * @param   NewEntry entry to add
+ * \brief   delete all entries in the ElementSet
  */
-bool gdcmElementSet::AddEntry( gdcmDocEntry *NewEntry) {
-   TagKey key;
-   key = NewEntry->GetKey();
+void ElementSet::ClearEntry()
+{
+   for(TagDocEntryHT::iterator cc = TagHT.begin();cc != TagHT.end(); ++cc)
+   {
+      if ( cc->second )
+      {
+         cc->second->Unregister();
+      }
+   }
+   TagHT.clear();
+}
+
+/**
+ * \brief   Get the first entry while visiting *the* 'zero level' DocEntrySet
+ *              (DocEntries out of any Sequence)
+ * \return  The first DocEntry if found, otherwhise NULL
+ */
+DocEntry *ElementSet::GetFirstEntry()
+{
+   ItTagHT = TagHT.begin();
+   if (ItTagHT != TagHT.end())
+      return  ItTagHT->second;
+   return NULL;
+}
 
-   if(tagHT.count(key) == 1)
+/**
+ * \brief   Get the next entry while visiting *the* 'zero level' DocEntrySet
+ *              (DocEntries out of any Sequence) 
+ * \note : meaningfull only if GetFirstEntry already called 
+ * \return  The next DocEntry if found, otherwhise NULL
+ */
+DocEntry *ElementSet::GetNextEntry()
+{
+   gdcmAssertMacro (ItTagHT != TagHT.end());
+
+   ++ItTagHT;
+   if (ItTagHT != TagHT.end())
+      return  ItTagHT->second;
+   return NULL;
+}
+
+/**
+ * \brief  retrieves a Dicom Element using (group, element)
+ * @param   group  Group number of the searched Dicom Element 
+ * @param   elem Element number of the searched Dicom Element 
+ * @return  
+ */
+DocEntry *ElementSet::GetDocEntry(uint16_t group, uint16_t elem) 
+{
+   TagKey key = DictEntry::TranslateToKey(group, elem);
+   TagDocEntryHT::iterator it = TagHT.find(key);
+
+   if ( it!=TagHT.end() )
+      return it->second;
+   return NULL;
+}
+
+/**
+ * \brief Copies all the attributes from an other DocEntrySet 
+ * @param set entry to copy from
+ * @remarks The contained DocEntries a not copied, only referenced
+ */
+void ElementSet::Copy(DocEntrySet *set)
+{
+   // Remove all previous entries
+   ClearEntry();
+
+   DocEntrySet::Copy(set);
+
+   ElementSet *eltSet = dynamic_cast<ElementSet *>(set);
+   if( eltSet )
    {
-      dbg.Verbose(1, "gdcmElementSet::AddEntry key already present: ",
-                  key.c_str());
-      return(false);
-   } 
-   else 
+      TagHT = eltSet->TagHT;
+      for(ItTagHT = TagHT.begin();ItTagHT != TagHT.end();++ItTagHT)
+      {
+         (ItTagHT->second)->Register();
+      }
+   }
+}
+
+/**
+ * \brief Checks whether *all* the DataEntries of the group have all
+ *        the same type for VR (ImplicitVR or ExplicitVR) 
+ * @param group group number to be checked
+ * @return 1:ImplicitVR 2:ExplicitVR -1:NotCoherent 
+ */
+int ElementSet::IsVRCoherent( uint16_t group )
+{
+   uint16_t currentGroup;
+   int codeVR = -1;
+   int currentCodeVR;
+   for(TagDocEntryHT::iterator cc = TagHT.begin();cc != TagHT.end(); ++cc)
    {
-      tagHT[NewEntry->GetKey()] = NewEntry;
-      return(true);
+      currentGroup = cc->second->GetGroup();
+
+      if ( currentGroup < group )
+         continue;   
+      if ( currentGroup > group )
+         break;
+      // currentGroup == group
+      if (codeVR == -1)
+      {
+         if (cc->second->IsImplicitVR() )
+            codeVR = 1;
+         else 
+            codeVR = 2;
+         continue;
+      }
+      else
+      {
+         if (cc->second->IsImplicitVR() )
+            currentCodeVR = 1; //Implicit
+         else 
+            currentCodeVR = 2; // Explicit  
+  
+         if ( currentCodeVR == codeVR )
+           continue;
+         else
+            return -1;    // -1 : not coherent 
+      }
    }   
+   return codeVR;
 }
 
+
+//-----------------------------------------------------------------------------
+// Protected
+
+//-----------------------------------------------------------------------------
+// Private
+
+//-----------------------------------------------------------------------------
+// Print
 /**
- * \brief   Clear the hash table from given entry.
- * @param   EntryToRemove Entry to remove.
- */
-bool gdcmElementSet::RemoveEntry( gdcmDocEntry *EntryToRemove)
+  * \brief   Prints the Header Entries (Dicom Elements) from the H Table
+  * @param os ostream to write to  
+  * @param indent Indentation string to be prepended during printing
+  */ 
+void ElementSet::Print(std::ostream &os, std::string const & )
 {
-   TagKey key = EntryToRemove->GetKey();
-   if(tagHT.count(key) == 1)
+   // Let's change the 'warning value' for Pixel Data,
+   // to avoid human reader to be confused by 'gdcm::NotLoaded'.   
+   DataEntry *pixelElement = GetDataEntry(0x7fe0,0x0010);
+   if ( pixelElement != 0 )
    {
-      tagHT.erase(key);
-      dbg.Verbose(0, "gdcmElementSet::RemoveEntry: one element erased.");
-      return true;
+      pixelElement->SetFlag( DataEntry::FLAG_PIXELDATA );
    }
 
-   dbg.Verbose(0, "gdcmElementSet::RemoveEntry: key not present: ");
-   return(false);
+   for( TagDocEntryHT::const_iterator i = TagHT.begin(); i != TagHT.end(); ++i)
+   {
+      DocEntry *entry = i->second;
+
+      entry->SetPrintLevel(PrintLevel);
+      entry->Print(os);   
+
+      if ( dynamic_cast<SeqEntry*>(entry) )
+      {
+         // Avoid the newline for a sequence:
+         continue;
+      }
+      os << std::endl;
+   }
 }
+
+//-----------------------------------------------------------------------------
+} // end namespace gdcm