]> Creatis software - gdcm.git/blobdiff - src/gdcmElValSet.cxx
Adding :
[gdcm.git] / src / gdcmElValSet.cxx
index 7e15c037bf33cf07cbbff3fa2b79a43cd7d4bf9d..db65110c41e5fc6839227524b0794e84d7248394 100644 (file)
@@ -3,6 +3,7 @@
 #include <sstream>
 #include "gdcmUtil.h"
 #include "gdcmElValSet.h"
+#include "gdcmTS.h"
 using namespace std;
 
 gdcmElValSet::~gdcmElValSet() {
@@ -22,101 +23,192 @@ TagElValueHT & gdcmElValSet::GetTagHt(void) {
        return tagHt;
 }
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 void gdcmElValSet::Add(gdcmElValue * newElValue) {
        tagHt [newElValue->GetKey()]  = newElValue;
        NameHt[newElValue->GetName()] = newElValue;
 }
 
-void gdcmElValSet::Print(ostream & os) {
-       for (TagElValueHT::iterator tag = tagHt.begin();
-                 tag != tagHt.end();
-                 ++tag){
-               os << tag->first << ": ";
-               os << "[" << tag->second->GetValue() << "]";
-               os << "[" << tag->second->GetName()  << "]";
-               os << "[" << tag->second->GetVR()    << "]"; 
-               os << " lgr : " << tag->second->GetLength();
-               os << endl;
-       }
+
+/**
+ * \ingroup gdcmElValSet
+ * \brief   Checks if a given Dicom element exists
+ * \        within a ElValSet
+ * @param     
+ * @return  
+ */
+int gdcmElValSet::CheckIfExistByNumber(guint16 Group, guint16 Elem ) {
+       string key = TranslateToKey(Group, Elem );
+       return (tagHt.count(key));
+}
+
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
+ void gdcmElValSet::Print(ostream & os) {
+
+   size_t o;
+   short int g, e;
+   TSKey v;
+   char * d;
+   string d2;
+   gdcmTS * ts = gdcmGlobal::GetTS();
+   
+   for (TagElValueHT::iterator tag = tagHt.begin();
+          tag != tagHt.end();
+          ++tag){
+      g = tag->second->GetGroup();
+      e = tag->second->GetElement();
+      v = tag->second->GetValue();
+      o = tag->second->GetOffset();
+      d = _CreateCleanString(v); // TODO : trouver qq chose moins goret
+      d2=d;
+                
+      os << tag->first << ": ";
+      //os << "[" << v << "]";
+      os << "[" << d2 << "]";
+      os << "[" << tag->second->GetName()  << "]";
+      os << "[" << tag->second->GetVR()    << "]"; 
+      
+      if ( (g == 0x0002) && (e == 0x0010) ) {     
+         os << " [" << ts->GetValue(v) << "]";   
+      }
+      
+      // liberer 'd' ici ?
+      
+      os << " lgr : " << tag->second->GetLength();
+      os << ", Offset : " << o;
+      os << " x(" << hex << o << dec << ") ";
+      os << endl;
+   }
 } 
 
-void gdcmElValSet::PrintByName(ostream & os) {
-       for (TagElValueNameHT::iterator tag = NameHt.begin();
-                 tag != NameHt.end();
-                 ++tag){
-               os << tag->first << ": ";
-               os << "[" << tag->second->GetValue() << "]";
-               os << "[" << tag->second->GetKey()   << "]";
-               os << "[" << tag->second->GetVR()    << "]" << endl;
-       }
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
+ void gdcmElValSet::PrintByName(ostream & os) {
+   for (TagElValueNameHT::iterator tag = NameHt.begin();
+          tag != NameHt.end();
+          ++tag){
+      os << tag->first << ": ";
+      os << "[" << tag->second->GetValue() << "]";
+      os << "[" << tag->second->GetKey()   << "]";
+      os << "[" << tag->second->GetVR()    << "]" << endl;
+   }
 }
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 gdcmElValue* gdcmElValSet::GetElementByNumber(guint16 group, guint16 element) {
-       TagKey key = gdcmDictEntry::TranslateToKey(group, element);
-       if ( ! tagHt.count(key))
-               return (gdcmElValue*)0;
-       return tagHt.find(key)->second;
+   TagKey key = gdcmDictEntry::TranslateToKey(group, element);
+   if ( ! tagHt.count(key))
+      return (gdcmElValue*)0;
+   return tagHt.find(key)->second;
 }
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 gdcmElValue* gdcmElValSet::GetElementByName(string TagName) {
    if ( ! NameHt.count(TagName))
       return (gdcmElValue*)0;
    return NameHt.find(TagName)->second;
 }
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 string gdcmElValSet::GetElValueByNumber(guint16 group, guint16 element) {
-       TagKey key = gdcmDictEntry::TranslateToKey(group, element);
-       if ( ! tagHt.count(key))
-               return "gdcm::Unfound";
-       return tagHt.find(key)->second->GetValue();
+   TagKey key = gdcmDictEntry::TranslateToKey(group, element);
+   if ( ! tagHt.count(key))
+      return "gdcm::Unfound";
+   return tagHt.find(key)->second->GetValue();
 }
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 string gdcmElValSet::GetElValueByName(string TagName) {
-       if ( ! NameHt.count(TagName))
-               return "gdcm::Unfound";
-       return NameHt.find(TagName)->second->GetValue();
+   if ( ! NameHt.count(TagName))
+      return "gdcm::Unfound";
+   return NameHt.find(TagName)->second->GetValue();
 }
 
-
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 int gdcmElValSet::SetElValueByNumber(string content,
                                      guint16 group, guint16 element) {
-       TagKey key = gdcmDictEntry::TranslateToKey(group, element);
-       if ( ! tagHt.count(key))
-               return 0;
-       tagHt[key]->SetValue(content);  
-       string vr = tagHt[key]->GetVR();
-       guint32 lgr;
-
-       if( (vr == "US") || (vr == "SS") ) 
-          lgr = 2;
-       else if( (vr == "UL") || (vr == "SL") )
-          lgr = 4;
-       else
-          lgr = content.length();         
-       tagHt[key]->SetLength(lgr); 
-       return 1;
+   TagKey key = gdcmDictEntry::TranslateToKey(group, element);
+   if ( ! tagHt.count(key))
+      return 0;
+   tagHt[key]->SetValue(content);      
+   string vr = tagHt[key]->GetVR();
+   guint32 lgr;
+
+   if( (vr == "US") || (vr == "SS") ) 
+      lgr = 2;
+   else if( (vr == "UL") || (vr == "SL") )
+      lgr = 4;
+   else
+      lgr = content.length();     
+   tagHt[key]->SetLength(lgr); 
+   return 1;
 }
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 int gdcmElValSet::SetElValueByName(string content, string TagName) {
-       if ( ! NameHt.count(TagName))
-               return 0;
-       NameHt[TagName]->SetValue(content);
-       string vr = NameHt[TagName]->GetVR();
-       guint32 lgr;
-
-       if( (vr == "US") || (vr == "SS") ) 
-          lgr = 2;
-       else if( (vr == "UL") || (vr == "SL") )
-          lgr = 4;        
-       else 
-          lgr = content.length();
+   if ( ! NameHt.count(TagName))
+      return 0;
+   NameHt[TagName]->SetValue(content);
+   string vr = NameHt[TagName]->GetVR();
+   guint32 lgr;
+
+   if( (vr == "US") || (vr == "SS") ) 
+      lgr = 2;
+   else if( (vr == "UL") || (vr == "SL") )
+      lgr = 4;    
+   else 
+      lgr = content.length();
           
 // TODO : WARNING: le cas de l'element des pixels (7fe0,0010) n'est pas traite
 // par SetElValueByName
 // il faudra utiliser SetElValueByNumber
           
-       NameHt[TagName]->SetLength(lgr);
-       return 1;               
+   NameHt[TagName]->SetLength(lgr);
+   return 1;           
 }
 
 /**
@@ -135,25 +227,45 @@ guint32 gdcmElValSet::GenerateFreeTagKeyInGroup(guint16 group) {
    return UINT32_MAX;
 }
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 int gdcmElValSet::SetElValueLengthByNumber(guint32 length,
                                            guint16 group, guint16 element) {
-       TagKey key = gdcmDictEntry::TranslateToKey(group, element);
-       if ( ! tagHt.count(key))
-               return 0;
-       tagHt[key]->SetLength(length);   
-       return 1 ;              
+   TagKey key = gdcmDictEntry::TranslateToKey(group, element);
+   if ( ! tagHt.count(key))
+      return 0;
+   tagHt[key]->SetLength(length);       
+   return 1 ;          
 }
 
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 int gdcmElValSet::SetElValueLengthByName(guint32 length, string TagName) {
-       if ( ! NameHt.count(TagName))
-               return 0;
-       NameHt.find(TagName)->second->SetLength(length);         
-       return 1 ;              
+   if ( ! NameHt.count(TagName))
+      return 0;
+   NameHt.find(TagName)->second->SetLength(length);     
+   return 1 ;          
 }
 
 
+// re-computes the length of a ACR-NEMA/Dicom group
+// from a DcmHeader
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 void gdcmElValSet::UpdateGroupLength(bool SkipSequence, FileType type) {
    guint16 gr, el;
    string vr;
@@ -161,12 +273,18 @@ void gdcmElValSet::UpdateGroupLength(bool SkipSequence, FileType type) {
    gdcmElValue *elem;
    char trash[10];
    string str_trash;
+   
    GroupKey key;
-   GroupHT groupHt;
+   GroupHT groupHt;  // to hold the length of each group
    TagKey tk;
+   // remember :
+   // typedef std::map<GroupKey, int> GroupHT;
+   
    gdcmElValue *elemZ;
+  
+   // for each Tag in the DCM Header
    
-   for (TagElValueHT::iterator tag2 = tagHt.begin();
+   for (TagElValueHT::iterator tag2 = tagHt.begin(); 
         tag2 != tagHt.end();
         ++tag2){
 
@@ -176,9 +294,13 @@ void gdcmElValSet::UpdateGroupLength(bool SkipSequence, FileType type) {
       vr = elem->GetVR(); 
                  
       sprintf(trash, "%04x", gr);
-      key = trash;
-                  
+      key = trash;             // generate 'group tag'
+      
+      // if the caller decided not to take SEQUENCEs into account 
+      // e.g : he wants to write an ACR-NEMA File 
+                
       if (SkipSequence && vr == "SQ") continue;
+      
          // pas SEQUENCE en ACR-NEMA
          // WARNING : pb CERTAIN
          //           si on est descendu 'a l'interieur' des SQ 
@@ -186,45 +308,44 @@ void gdcmElValSet::UpdateGroupLength(bool SkipSequence, FileType type) {
          // --> la descente a l'interieur' des SQ 
          // devra etre faite avec une liste chainee, pas avec une HTable...
              
-      if ( groupHt.count(key) == 0) { 
-         if (el ==0x0000) {
-            groupHt[key] = 0;
+      if ( groupHt.count(key) == 0) { // we just read the first elem of a given group
+         if (el == 0x0000) {         // the first elem is 0x0000
+            groupHt[key] = 0;        // initialize group length 
          } else {
-            groupHt[key] =2 + 2 + 4 + elem->GetLength();
+            groupHt[key] = 2 + 2 + 4 + elem->GetLength(); // non 0x0000 first group elem
          } 
-      } else {       
-         if (type = ExplicitVR) {
+      } else {   // any elem but the first    
+         if (type == ExplicitVR) {
             if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") ) {
-               groupHt[key] +=  4;
+               groupHt[key] +=  4; // explicit VR AND OB, OW, SQ : 4 more bytes
             }
          }
          groupHt[key] += 2 + 2 + 4 + elem->GetLength(); 
       } 
    }
   
-     if(0)
+     if(1) // unnormalized way to see what happened
      for (GroupHT::iterator g = groupHt.begin();
         g != groupHt.end();
         ++g){        
         printf("groupKey %s : %d\n",g->first.c_str(),g->second);
      }
        
-  
    unsigned short int gr_bid;
   
-   for (GroupHT::iterator g = groupHt.begin();
+   for (GroupHT::iterator g = groupHt.begin(); // for each group we found
         g != groupHt.end();
         ++g){ 
       // FIXME: g++ -Wall -Wstrict-prototypes reports on following line:
       //        warning: unsigned int format, different type arg
       sscanf(g->first.c_str(),"%x",&gr_bid);
-      tk = g->first + "|0000";
+      tk = g->first + "|0000";                 // generate the element full tag
                      
-      if ( tagHt.count(tk) == 0) { 
+      if ( tagHt.count(tk) == 0) {             // if element 0x0000 not found
          gdcmDictEntry * tagZ = new gdcmDictEntry(gr_bid, 0x0000, "UL");       
          elemZ = new gdcmElValue(tagZ);
          elemZ->SetLength(4);
-         Add(elemZ);
+         Add(elemZ);                           // create it
       } else {
          elemZ=GetElementByNumber(gr_bid, 0x0000);
       }     
@@ -234,6 +355,12 @@ void gdcmElValSet::UpdateGroupLength(bool SkipSequence, FileType type) {
    }   
 }
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 void gdcmElValSet::WriteElements(FileType type, FILE * _fp) {
    guint16 gr, el;
    guint32 lgr;
@@ -261,7 +388,7 @@ void gdcmElValSet::WriteElements(FileType type, FILE * _fp) {
 
       if ( type == ACR ) { 
          if (gr < 0x0008) continue;
-         if (gr %2)   continue;
+         // if (gr %2)   continue; // pour voir
          if (vr == "SQ" ) continue;
       } 
 
@@ -313,6 +440,12 @@ void gdcmElValSet::WriteElements(FileType type, FILE * _fp) {
    }
 }
 
+/**
+ * \ingroup gdcmElValSet
+ * \brief   
+ * @param     
+ * @return  
+ */
 int gdcmElValSet::Write(FILE * _fp, FileType type) {
 
    if (type == ImplicitVR) {
@@ -324,15 +457,13 @@ int gdcmElValSet::Write(FILE * _fp, FileType type) {
       //      Dans le cas suivant on doit pader manuellement avec un 0
       
       SetElValueLengthByNumber(18, 0x0002, 0x0010);
-   }
-   
+   }  
        // Question :
        // Comment pourrait-on savoir si le DcmHeader vient d'un fichier DicomV3 ou non ,
        // (FileType est un champ de gdcmHeader ...)
        // WARNING : Si on veut ecrire du DICOM V3 a partir d'un DcmHeader ACR-NEMA
        // no way
        
-       
    if (type == ExplicitVR) {
       string explicitVRTransfertSyntax = "1.2.840.10008.1.2.1";
       SetElValueByNumber(explicitVRTransfertSyntax, 0x0002, 0x0010);
@@ -346,6 +477,5 @@ int gdcmElValSet::Write(FILE * _fp, FileType type) {
       UpdateGroupLength(true,ACR);
 
    WriteElements(type, _fp);
-
    return(1);
 }