]> Creatis software - gdcm.git/blobdiff - src/gdcmElementSet.cxx
Fix mistypings
[gdcm.git] / src / gdcmElementSet.cxx
index f419aed920cb10b58b2738a4ccf1c2dee929d59e..31f74ae64890537f8d0d688992a557e32a3364ad 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmElementSet.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/01/24 16:10:52 $
-  Version:   $Revision: 1.49 $
+  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
 
 #include "gdcmElementSet.h"
 #include "gdcmDebug.h"
-#include "gdcmValEntry.h"
-#include "gdcmBinEntry.h"
 #include "gdcmSeqEntry.h"
+#include "gdcmDataEntry.h"
 
-namespace gdcm 
+namespace GDCM_NAME_SPACE 
 {
-
 //-----------------------------------------------------------------------------
 // Constructor / Destructor
 /**
  * \brief   Constructor for a given ElementSet
  */
-//BOZ depthLevel is not usefull anymore
-ElementSet::ElementSet(int depthLevel) 
-              : DocEntrySet()
+ElementSet::ElementSet() 
+          : DocEntrySet()
 {
-  (void)depthLevel;
 }
 
 /**
@@ -42,39 +38,7 @@ ElementSet::ElementSet(int depthLevel)
  */
 ElementSet::~ElementSet() 
 {
-   for(TagDocEntryHT::iterator cc = TagHT.begin();cc != TagHT.end(); ++cc)
-   {
-      if ( cc->second )
-      {
-         delete cc->second;
-      }
-   }
-   TagHT.clear();
-}
-
-//-----------------------------------------------------------------------------
-// Print
-/**
-  * \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 & )
-{
-   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;
-   }
+   ClearEntry();
 }
 
 //-----------------------------------------------------------------------------
@@ -83,144 +47,55 @@ void ElementSet::Print(std::ostream &os, std::string const & )
   * \brief   Writes the Header Entries (Dicom Elements)
   *          from the H Table
   * @param fp ofstream to write to  
-  * @param filetype filetype
+  * @param filetype    ExplicitVR/ImplicitVR/ACR/ACR_LIBIDO/JPEG/JPEG2000/...
   */ 
-void ElementSet::WriteContent(std::ofstream *fp, FileType filetype)
+void ElementSet::WriteContent(std::ofstream *fp, FileType filetype, bool dummy, bool dummy2)
 {
+   bool insideMetaElements     = false;
+   bool yetOutsideMetaElements = false;
+   (void)dummy2;(void)dummy;
+   
    for (TagDocEntryHT::const_iterator i = TagHT.begin(); 
                                      i != TagHT.end(); 
                                     ++i)
    {
-      i->second->WriteContent(fp, filetype);
+        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  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);
-   if ( !TagHT.count(key))
-   {
-      return NULL;
-   }
-   return TagHT.find(key)->second;
-}
-
-/**
- * \brief  Same as \ref Document::GetDocEntry except it only
- *         returns a result when the corresponding entry is of type
- *         ValEntry.
- * @param   group  Group number of the searched Dicom Element 
- * @param   elem Element number of the searched Dicom Element  
- * @return When present, the corresponding ValEntry. 
- */
-ValEntry *ElementSet::GetValEntry(uint16_t group, uint16_t elem)
-{
-   DocEntry *currentEntry = GetDocEntry(group, elem);
-   if ( !currentEntry )
-   {
-      return 0;
-   }
-   if ( ValEntry *entry = dynamic_cast<ValEntry*>(currentEntry) )
-   {
-      return entry;
-   }
-   gdcmVerboseMacro( "Unfound ValEntry.");
-
-   return 0;
-}
-
-/**
- * \brief  Same as \ref Document::GetDocEntry except it only
- *         returns a result when the corresponding entry is of type
- *         BinEntry.
- * @param   group  Group number of the searched Dicom Element 
- * @param   elem Element number of the searched Dicom Element  
- * @return When present, the corresponding BinEntry. 
- */
-BinEntry *ElementSet::GetBinEntry(uint16_t group, uint16_t elem)
-{
-   DocEntry *currentEntry = GetDocEntry(group, elem);
-   if ( !currentEntry )
-   {
-      return 0;
-   }
-   if ( BinEntry *entry = dynamic_cast<BinEntry*>(currentEntry) )
-   {
-      return entry;
-   }
-   gdcmVerboseMacro( "Unfound BinEntry.");
-
-   return 0;
-}
-
-/**
- * \brief  Same as \ref Document::GetDocEntry except it only
- *         returns a result when the corresponding entry is of type
- *         SeqEntry.
- * @param   group  Group number of the searched Dicom Element 
- * @param   elem Element number of the searched Dicom Element  
- * @return When present, the corresponding SeqEntry. 
- */
-SeqEntry *ElementSet::GetSeqEntry(uint16_t group, uint16_t elem)
-{
-   DocEntry *currentEntry = GetDocEntry(group, elem);
-   if ( !currentEntry )
-   {
-      return 0;
-   }
-   if ( SeqEntry *entry = dynamic_cast<SeqEntry*>(currentEntry) )
-   {
-      return entry;
-   }
-   gdcmVerboseMacro( "Unfound SeqEntry.");
-
-   return 0;
-}
-
-
-//-----------------------------------------------------------------------------
-// Protected
-
-/**
- * \brief   Checks if a given Dicom Element exists within the H table
- * @param   group   Group number of the searched Dicom Element 
- * @param   elem  Element number of the searched Dicom Element 
- * @return true is found
- */
-bool ElementSet::CheckIfEntryExist(uint16_t group, uint16_t elem )
-{
-   const std::string &key = DictEntry::TranslateToKey(group, elem );
-   return TagHT.count(key) != 0;
-}
-
-/**
- * \brief   Get the (std::string representable) value of the Dicom entry
- * @param   group  Group number of the searched tag.
- * @param   elem Element number of the searched tag.
- * @return  Corresponding element value when it exists,
- *          and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
- */
-std::string ElementSet::GetEntryValue(uint16_t group, uint16_t elem)
-{
-   TagKey key = DictEntry::TranslateToKey(group, elem);
-   if ( !TagHT.count(key))
-   {
-      return GDCM_UNFOUND;
-   }
-
-   return ((ValEntry *)TagHT.find(key)->second)->GetValue();
-}
-
-
-//-----------------------------------------------------------------------------
-// Private
-
 /**
  * \brief   add a new Dicom Element pointer to the H Table
  * @param   newEntry entry to add
@@ -229,14 +104,15 @@ bool ElementSet::AddEntry(DocEntry *newEntry)
 {
    const TagKey &key = newEntry->GetKey();
 
-   if( TagHT.count(key) == 1 )
+   if ( TagHT.count(key) == 1 )
    {
-      gdcmVerboseMacro( "Key already present: " << key.c_str());
+      gdcmWarningMacro( "Key already present: " << key );
       return false;
    }
    else
    {
       TagHT.insert(TagDocEntryHT::value_type(newEntry->GetKey(), newEntry));
+      newEntry->Register();
       return true;
    }
 }
@@ -248,38 +124,35 @@ bool ElementSet::AddEntry(DocEntry *newEntry)
 bool ElementSet::RemoveEntry( DocEntry *entryToRemove)
 {
    const TagKey &key = entryToRemove->GetKey();
-   if( TagHT.count(key) == 1 )
+   if ( TagHT.count(key) == 1 )
    {
       TagHT.erase(key);
-      //gdcmVerboseMacro( "One element erased.");
-      delete entryToRemove;
+      entryToRemove->Unregister();
       return true;
    }
 
-   gdcmVerboseMacro( "Key not present");
+   gdcmWarningMacro( "Key not present : " << key);
    return false ;
 }
 
 /**
- * \brief   Clear the hash table from given entry BUT keep the entry.
- * @param   entryToRemove Entry to remove.
+ * \brief   delete all entries in the ElementSet
  */
-bool ElementSet::RemoveEntryNoDestroy(DocEntry *entryToRemove)
+void ElementSet::ClearEntry()
 {
-   const TagKey &key = entryToRemove->GetKey();
-   if( TagHT.count(key) == 1 )
+   for(TagDocEntryHT::iterator cc = TagHT.begin();cc != TagHT.end(); ++cc)
    {
-      TagHT.erase(key);
-      //gdcmVerboseMacro( "One element erased.");
-      return true;
+      if ( cc->second )
+      {
+         cc->second->Unregister();
+      }
    }
-
-   gdcmVerboseMacro( "Key not present");
-   return false ;
+   TagHT.clear();
 }
 
 /**
- * \brief   Get the first entry while visiting the DocEntrySet
+ * \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()
@@ -291,7 +164,8 @@ DocEntry *ElementSet::GetFirstEntry()
 }
 
 /**
- * \brief   Get the next entry while visiting the Hash table (TagHT)
+ * \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
  */
@@ -305,34 +179,128 @@ DocEntry *ElementSet::GetNextEntry()
    return NULL;
 }
 
-
 /**
- * \brief   Get the larst entry while visiting the DocEntrySet
- * \return  The last DocEntry if found, otherwhise 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::GetLastEntry()
+DocEntry *ElementSet::GetDocEntry(uint16_t group, uint16_t elem) 
 {
-   ItTagHT = TagHT.end();
-   if ( ItTagHT != TagHT.begin() )
-      return  ItTagHT->second;
+   TagKey key = DictEntry::TranslateToKey(group, elem);
+   TagDocEntryHT::iterator it = TagHT.find(key);
+
+   if ( it!=TagHT.end() )
+      return it->second;
    return NULL;
 }
 
 /**
- * \brief   Get the previous entry while visiting the Hash table (TagHT)
- * \note : meaningfull only if GetFirstEntry already called 
- * \return  The previous DocEntry if found, otherwhise 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
  */
-DocEntry *ElementSet::GetPreviousEntry()
+void ElementSet::Copy(DocEntrySet *set)
 {
-   gdcmAssertMacro (ItTagHT != TagHT.begin());
+   // Remove all previous entries
+   ClearEntry();
 
-   --ItTagHT;
-   if (ItTagHT != TagHT.begin())
-      return  ItTagHT->second;
-   return NULL;
+   DocEntrySet::Copy(set);
+
+   ElementSet *eltSet = dynamic_cast<ElementSet *>(set);
+   if( eltSet )
+   {
+      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)
+   {
+      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   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 & )
+{
+   // 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 )
+   {
+      pixelElement->SetFlag( DataEntry::FLAG_PIXELDATA );
+   }
+
+   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