]> Creatis software - gdcm.git/commitdiff
* src/gdcmHeader.cxx :
authorfrog <frog>
Tue, 29 Oct 2002 17:37:08 +0000 (17:37 +0000)
committerfrog <frog>
Tue, 29 Oct 2002 17:37:08 +0000 (17:37 +0000)
        - Parsing of header is now separated from loading of element values
          (see gdcmHeader::LoadElements).
        - general clean up of hopefully all file access (creation of
          ReadInt16 and ReadInt32)   --- Frog

ChangeLog
src/gdcmElValSet.cxx
src/gdcmHeader.cxx
src/gdcmUtil.h
src/gdcmlib.h

index 1260378734a9f1140d40af4ab783f3b1425931b1..b75631af15708cf67f434cbb7c88858d8ab01a66 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2002-10-29 Eric Boix <Eric.Boix@creatis.insa-lyon.fr>
+      * src/gdcmHeader.cxx :
+        - Parsing of header is now separated from loading of element values
+          (see gdcmHeader::LoadElements).
+        - general clean up of hopefully all file access (creation of
+          ReadInt16 and ReadInt32)
+
 2002-10-22 Eric Boix <Eric.Boix@creatis.insa-lyon.fr>
       * src/gdcmHeader.cxx :
         - RecupLgr renamed to FindLength and cut off with new IsAnInteger
index 9101d26f97ab2541b25bdf4a44110a7620d27318..85ea5fc5aa024e3c0441197ba0d9d3792af6d7aa 100644 (file)
@@ -1,6 +1,10 @@
 #include "gdcmlib.h"
 #include "gdcmUtil.h"
 
+TagElValueHT & ElValSet::GetTagHt(void) {
+       return tagHt;
+}
+
 void ElValSet::Add(ElValue * newElValue) {
        tagHt[newElValue->GetKey()]   = newElValue;
        NameHt[newElValue->GetName()] = newElValue;
@@ -28,6 +32,16 @@ void ElValSet::PrintByName(ostream & os) {
        }
 }
 
+ElValue* ElValSet::GetElement(guint32 group, guint32 element) {
+       TagKey key = gdcmDictEntry::TranslateToKey(group, element);
+       if ( ! tagHt.count(key))
+               return (ElValue*)0;
+       if (tagHt.count(key) > 1)
+               dbg.Verbose(0, "ElValSet::GetElValue",
+                           "multiple entries for this key (FIXME) !");
+       return tagHt.find(key)->second;
+}
+
 string ElValSet::GetElValue(guint32 group, guint32 element) {
        TagKey key = gdcmDictEntry::TranslateToKey(group, element);
        if ( ! tagHt.count(key))
index dc6bbf41a7ee6ca995746d9a3baad681f57b3ca1..49a4945f5391f102fff3df818606d308435bfc5e 100644 (file)
@@ -15,6 +15,17 @@ extern "C" {
 
 #define HEADER_LENGHT_TO_READ 256 // on ne lit plus que le debut
 
+namespace Error {
+       struct FileReadError {
+               FileReadError(FILE* fp, const char* Mesg) {
+                       if (feof(fp))
+                               dbg.Verbose(1, "EOF encountered :", Mesg);
+                       if (ferror(fp))
+                               dbg.Verbose(1, "Error on reading :", Mesg);
+               }
+       };
+}
+
 //FIXME: this looks dirty to me...
 #define str2num(str, typeNum) *((typeNum *)(str))
 
@@ -24,8 +35,6 @@ gdcmDictSet* gdcmHeader::Dicts = new gdcmDictSet();
 void gdcmHeader::Initialise(void) {
        if (!gdcmHeader::dicom_vr)
                InitVRDict();
-       PixelPosition = (size_t)0;
-       PixelsTrouves = false;
        RefPubDict = gdcmHeader::Dicts->GetDefaultPublicDict();
        RefShaDict = (gdcmDict*)0;
 }
@@ -35,11 +44,11 @@ gdcmHeader::gdcmHeader (char* InFilename) {
        Initialise();
        fp=fopen(InFilename,"rw");
        dbg.Error(!fp, "gdcmHeader::gdcmHeader cannot open file", InFilename);
-       BuildHeader();
-       fclose(fp);
+       ParseHeader();
 }
 
 gdcmHeader::~gdcmHeader (void) {
+       fclose(fp);
        return;
 }
 
@@ -256,7 +265,7 @@ void gdcmHeader::CheckSwap()
  * @return               longueur retenue pour le champ 
  */
 
-void gdcmHeader::FindVR( ElValue *pleCourant) {
+void gdcmHeader::FindVR( ElValue *ElVal) {
        char VR[3];
        int lgrLue;
        long PositionOnEntry = ftell(fp);
@@ -279,22 +288,21 @@ void gdcmHeader::FindVR( ElValue *pleCourant) {
        // first extraction by calling proper method.
        VRAtr FoundVR = dicom_vr->find(string(VR))->first;
        if ( ! FoundVR.empty()) {
-               pleCourant->SetVR(FoundVR);
+               ElVal->SetVR(FoundVR);
                return; 
        }
        
        // We thought this was explicit VR, but we end up with an
        // implicit VR tag. Let's backtrack.
-       pleCourant->SetVR("Implicit");
+       ElVal->SetVR("Implicit");
        fseek(fp, PositionOnEntry, SEEK_SET);
 }
 
-void gdcmHeader::FindLength( ElValue *pleCourant) {
-       int lgrLue;
-       guint32 l_gr;
-       unsigned short int l_gr_2;
+void gdcmHeader::FindLength( ElValue * ElVal) {
+       guint32 length32;
+       guint16 length16;
        
-       string vr = pleCourant->GetVR();
+       string vr = ElVal->GetVR();
        
        if ( (filetype == ExplicitVR) && (vr != "Implicit") ) {
                if (   ( vr == "OB" ) || ( vr == "OW" )
@@ -303,35 +311,32 @@ void gdcmHeader::FindLength( ElValue *pleCourant) {
                        // The following two bytes are reserved, so we skip them,
                        // and we proceed on reading the length on 4 bytes.
                        fseek(fp, 2L,SEEK_CUR);
-                       lgrLue=fread (&l_gr, (size_t)4,(size_t)1, fp);
-                       l_gr = SwapLong((guint32)l_gr);
+                       length32 = ReadInt32();
                        
                } else {
                        // Length is encoded on 2 bytes.
-                       lgrLue=fread (&l_gr_2, (size_t)2,(size_t)1, fp);
-                       
-                       l_gr_2 = SwapShort((unsigned short)l_gr_2);
-                       
-                       if ( l_gr_2 == 0xffff) {
-                               l_gr = 0;
+                       length16 = ReadInt16();
+                        
+                       if ( length16 == 0xffff) {
+                               length32 = 0;
                        } else {
-                               l_gr = l_gr_2;
+                               length32 = length16;
                        }
                }
        } else {
                // Either implicit VR or an explicit VR that (at least for this
                // element) lied a little bit. Length is on 4 bytes.
-               lgrLue=fread (&l_gr, (size_t)4,(size_t)1, fp);
-               l_gr= SwapLong((long)l_gr);
+               length32 = ReadInt32();
        }
-
+       
        // Traitement des curiosites sur la longueur
-       if ( l_gr == 0xffffffff)
-               l_gr=0; 
+       if ( length32 == 0xffffffff)
+               length32=0;
        
-       pleCourant->SetLength(l_gr);
+       ElVal->SetLength(length32);
 }
 
+
 /**
  * \ingroup gdcmHeader
  * \brief   remet les octets dans un ordre compatible avec celui du processeur
@@ -368,116 +373,133 @@ guint32 gdcmHeader::SwapLong(guint32 a) {
 
  * @return  longueur retenue pour le champ 
  */
-short int gdcmHeader::SwapShort(short int a) {
+guint16 gdcmHeader::SwapShort(guint16 a) {
        if ( (sw==4321)  || (sw==2143) )
                a =(((a<<8) & 0x0ff00) | ((a>>8)&0x00ff));
        return (a);
 }
 
-/**
- * \ingroup       gdcmHeader
- * \brief         lit le dicom_element suivant.
- *                     (le fichier doit deja avoir ete ouvert,
- *                      _IdAcrCheckSwap(ID_DCM_HDR *e) avoir ete appele)
- * @param e      ID_DCM_HDR  dans lequel effectuer la recherche.
- * @param sw           code swap.
- * @return             En cas de succes, 1 
- *                     0 en cas d'echec.
- */
+void gdcmHeader::SkipElementValue(ElValue * ElVal) {
+       //FIXME don't dump the returned value
+       (void)fseek(fp, (long)ElVal->GetLength(), SEEK_CUR);
+}
 
-ElValue * gdcmHeader::ReadNextElement(void) {
-       guint16 g;
-       guint16 n;
-       guint32 l;
-       size_t lgrLue;
-       ElValue * nouvDcmElem;
-       
-       // ------------------------- Lecture Num group : g
-       lgrLue=fread (&g, (size_t)2,(size_t)1, fp);
+void gdcmHeader::LoadElementValue(ElValue * ElVal) {
+       size_t item_read;
+       guint16 group  = ElVal->GetGroup();
+       guint16 elem   = ElVal->GetElement();
+       string  vr     = ElVal->GetVR();
+       guint32 length = ElVal->GetLength();
+       fseek(fp, (long)ElVal->GetOffset(), SEEK_SET);
        
-       if (feof(fp))  {
-               dbg.Verbose(1, "ReadNextElement: EOF encountered");
-               return (NULL);
+       // Sequences not treated yet !
+       if( vr == "SQ" ) {
+               SkipElementValue(ElVal);
+               ElVal->SetLength(0);
+               return;
        }
-       if (ferror(fp)){
-               dbg.Verbose(1, "ReadNextElement: failed to read NumGr");
-               return (NULL);
+       // A sequence "contains" a set of tags (called items). It looks like
+       // the last tag of a sequence (the one that terminates the sequence)
+       // has a group of 0xfffe (with a dummy length).
+       if( group == 0xfffe) {
+               SkipElementValue(ElVal);
+               ElVal->SetLength(0);
+               return;
        }
        
-       if (sw) g= SwapShort(((short)g));
-       
-       // ------------------------- Lecture Num Elem : n
-       lgrLue=fread (&n, (size_t)2,(size_t)1, fp);
+       if ( IsAnInteger(group, elem, vr, length) ) {
+               guint32 NewInt;
+               if( length == 2 ) {
+                       NewInt = ReadInt16();
+               } else if( length == 4 ) {
+                       NewInt = ReadInt32();
+               } else
+                       dbg.Error(true, "LoadElementValue: Inconsistency when reading Int.");
+               
+               //FIXME: make the following an util fonction
+               ostringstream s;
+               s << NewInt;
+               ElVal->SetValue(s.str());
+               return;
+       }
        
-       if (feof(fp))  {
-               dbg.Verbose(1, "ReadNextElement: EOF encountered");
-               return (NULL);
+       // FIXME The exact size should be length if we move to strings or whatever
+       char* NewValue = (char*)g_malloc(length+1);
+       if( !NewValue) {
+               dbg.Verbose(1, "LoadElementValue: Failed to allocate NewValue");
+               return;
        }
-       if (ferror(fp)){
-               dbg.Verbose(1, "ReadNextElement: failed to read NumElem");
-               return (NULL);
+       NewValue[length]= 0;
+       
+       // FIXME les elements trop long (seuil a fixer a la main) ne devraient
+       // pas etre charge's !!!! Voir TODO.
+       item_read = fread(NewValue, (size_t)length, (size_t)1, fp);
+       if ( item_read != 1 ) {
+               g_free(NewValue);
+               Error::FileReadError(fp, "gdcmHeader::LoadElementValue");
+               ElVal->SetValue("gdcm::UnRead");
+               return;
        }
+       ElVal->SetValue(NewValue);
+}
+
+
+guint16 gdcmHeader::ReadInt16(void) {
+       guint16 g;
+       size_t item_read;
+       item_read = fread (&g, (size_t)2,(size_t)1, fp);
+       if ( item_read != 1 )
+               throw Error::FileReadError(fp, "gdcmHeader::ReadInt16");
+       g = SwapShort(g);
+       return g;
+}
+
+guint32 gdcmHeader::ReadInt32(void) {
+       guint32 g;
+       size_t item_read;
+       item_read = fread (&g, (size_t)4,(size_t)1, fp);
+       if ( item_read != 1 )
+               throw Error::FileReadError(fp, "gdcmHeader::ReadInt32");
+       g = SwapLong(g);
+       return g;
+}
+
+/**
+ * \ingroup gdcmHeader
+ * \brief   Read the next tag without loading it's value
+ * @return  On succes the newly created ElValue, NULL on failure.      
+ */
+
+ElValue * gdcmHeader::ReadNextElement(void) {
+       guint16 g;
+       guint16 n;
+       ElValue * NewElVal;
        
-       if(sw) n= SwapShort(((short)n));
+       try {
+               g = ReadInt16();
+               n = ReadInt16();
+       }
+       catch ( Error::FileReadError ) {
+               // We reached the EOF (or an error occured) and header parsing
+               // has to be considered as finished.
+               return (ElValue *)0;
+       }
 
        // Find out if the tag we encountered is in the dictionaries:
        gdcmDictEntry * NewTag = IsInDicts(g, n);
        if (!NewTag)
                NewTag = new gdcmDictEntry(g, n, "Unknown", "Unknown", "Unkown");
 
-       nouvDcmElem = new ElValue(NewTag);
-       if (!nouvDcmElem) {
+       NewElVal = new ElValue(NewTag);
+       if (!NewElVal) {
                dbg.Verbose(1, "ReadNextElement: failed to allocate ElValue");
-               return(NULL);
+               return (ElValue*)0;
        }
 
-       FindVR(nouvDcmElem);
-       FindLength(nouvDcmElem);
-       nouvDcmElem->SetOffset(ftell(fp));
-       l = nouvDcmElem->GetLength();
-
-       //FIXMEif(!memcmp( VR,"SQ",(size_t)2 )) { // ca annonce une SEQUENCE d'items ?!
-       //FIXME l_gr=0;                         // on lira donc les items de la sequence 
-       //FIXME}
-       //FIXMEreturn(l_gr);
-
-   // Une sequence contient un ensemble de group element repetes n fois
-       // et g=fffe indique la fin (contient une longueur bidon).
-       if(g==0xfffe) l=0;  // pour sauter les indicateurs de 'SQ'
-       
-       
-       // ------------------------- Lecture Valeur element 
-       
-       // FIXME The exact size should be l if we move to strings or whatever
-       // CLEAN ME NEWValue used to be nouvDcmElem->valeurElem
-       char* NewValue = (char*)g_malloc(l+1);
-       if(NewValue) {
-               NewValue[l]= 0;
-       } else {
-               return (NULL);
-       }
-       
-       // FIXME les elements trop long (seuil a fixer a la main) ne devraient
-       // pas etre charge's !!!! Voir TODO.
-       lgrLue=fread (NewValue, (size_t)l,(size_t)1, fp);
-       
-       if ( IsAnInteger(g, n, NewTag->GetVR(), l) ) {
-               // CLEANME THe following is really UGLY ! 
-               if( l == 4 ) {
-                       *(guint32 *) NewValue = SwapLong  ((*(guint32 *) NewValue)); 
-               } else {
-                       if( l == 2 )
-                               *(guint16 *) NewValue = SwapShort ((*(guint16 *)NewValue));
-               }
-               //FIXME: don't we have to distinguish guin16 and guint32
-               //FIXME: make the following an util fonction
-               ostringstream s;
-               s << *(guint32 *) NewValue;
-               nouvDcmElem->value = s.str();
-               g_free(NewValue);
-       } else
-               nouvDcmElem->value = NewValue;
-       return nouvDcmElem;
+       FindVR(NewElVal);
+       FindLength(NewElVal);
+       NewElVal->SetOffset(ftell(fp));
+       return NewElVal;
 }
 
 bool gdcmHeader::IsAnInteger(guint16 group, guint16 element,
@@ -517,78 +539,35 @@ bool gdcmHeader::IsAnInteger(guint16 group, guint16 element,
 
 /**
  * \ingroup gdcmHeader
- * \brief   If we encountered the offset of the pixels in the file
- *          (Pixel Data) then keep the info aside.
+ * \brief   Recover the offset (from the beginning of the file) of the pixels.
  */
-void gdcmHeader::SetAsidePixelData(ElValue* elem) {
-       // They are two cases :
-       // * the pixel data (i.e. the image or the volume) is pointed by it's
-       //   default official tag (0x7fe0,0x0010),
-       // * the writer of this file decided to put the image "address" (i.e the
-       //   offset from the begining of the file) at a different tag.
-       //   Then the "Pixel Data" offset might be found by indirection through
-       //   the "Image Location" tag (0x0028,  0x0200). In other terms the Image
-       //   Location tag contains the group where the "Pixel Data" offset is and
-       //   inside this group the element is conventionally at element 0x0010
-       //   (when the norm is respected).
-       // 
-       // Hence getting our hands on the Pixel Data is a two stage process:
-       //  1/ * find if the "Pixel Data" tag exists.
-       //     * if it does not exist, look for the "Pixel Location" tag.
-       //  2/ look at the proper tag ("Pixel Data" or "Pixel Location" when
-       //     it exists) what the offset is.
-       cout << "aaaaaaaaaaaaaaaaaaaaa";
-       // PubElVals.PrintByName(cout);
-       ostringstream val;
-       val << hex << GetPubElValByName("Image Location");
-       cout << GetPubElValByName("Image Location") << endl;
-       cout <<hex << GetPubElValByName("Image Location") << dec << endl;
-       cout << "aaaa" << hex << val << dec << endl;
-       if (val)
-               //grPixel  = val.hex().str();
-               grPixel = 0;
-       else
-               grPixel  = 0x7FE0;
-       return;
-
-       guint16 g;
-       guint16 n;
-       g = elem->GetGroup();
-       n = elem->GetElement();
-       if (!grPixelTrouve) {   // on n a pas encore trouve les pixels
-               if (g > 0x0028) {
-                       if (n > 0x0200 || g == 0x7FE0 ) {  // on a depasse (28,200)
-                               grPixel  = 0x7FE0;
-                               numPixel = 0x0010;
-                               grPixelTrouve = true;
-                       }
-               } else {         // on est sur (28,200)
-                       if (g == 0x0028) {
-                               if (n == 0x0200) {
-                                       grPixelTrouve = 1;
-                                       char* NewValue = (char*)g_malloc(elem->GetLength()+1);
-                                       // FIXME: not very elegant conversion
-                                       for(int i=0;i<4;i++)
-                                               *((char*)(&grPixel)+i) = *(NewValue+i); 
-                                       elem->SetValue(NewValue);
-                                       
-                                       if (grPixel != 0x7FE0)   // Vieux pb Philips
-                                               numPixel = 0x1010;    // encore utile ??
-                                       else
-                                               numPixel = 0x0010;
-                               }
-                       }
-               }
-       } else {     // on vient de trouver les pixels
-               if (g == grPixel) {
-                       if (n == numPixel) {
-                               PixelPosition = elem->Offset; 
-                               PixelsTrouves = true;
-                               dbg.Verbose(0, "gdcmHeader::SetAsidePixelData:",
-                                           "Pixel data found");
-                       }
-               }
+size_t gdcmHeader::GetPixelOffset(void) {
+       // If this file complies with the norm we should encounter the
+       // "Image Location" tag (0x0028,  0x0200). This tag contains the
+       // the group that contains the pixel data (hence the "Pixel Data"
+       // is found by indirection through the "Image Location").
+       // Inside the group pointed by "Image Location" the searched element
+       // is conventionally the element 0x0010 (when the norm is respected).
+       //    When the "Image Location" is absent we default to group 0x7fe0.
+       guint16 grPixel;
+       guint16 numPixel;
+       string ImageLocation = GetPubElValByName("Image Location");
+       if ( ImageLocation == "UNFOUND" ) {
+               grPixel = 0x7FE0;
+       } else {
+               grPixel = (guint16) atoi( ImageLocation.c_str() );
        }
+       if (grPixel != 0x7fe0)
+               // FIXME is this still necessary ?
+               // Now, this looks like an old dirty fix for Philips imager
+               numPixel = 0x1010;
+       else
+               numPixel = 0x0010;
+       ElValue* PixelElement = PubElVals.GetElement(grPixel, numPixel);
+       if (PixelElement)
+               return PixelElement->GetOffset();
+       else
+               return 0;
 }
 
 gdcmDictEntry * gdcmHeader::IsInDicts(guint32 group, guint32 element) {
@@ -619,21 +598,30 @@ string gdcmHeader::GetPubElValByName(string TagName) {
 }
 
 /**
- * \ingroup       gdcmHeader
- * \brief         renvoie un pointeur sur le ID_DCM_HDR correspondant au fichier
- * @param filename      Nom du fichier ACR / LibIDO / DICOM
- * @return       le ID_DCM_HDR 
+ * \ingroup gdcmHeader
+ * \brief   Parses the header of the file but does NOT load element values.
  */
-void gdcmHeader::BuildHeader(void) {
+void gdcmHeader::ParseHeader(void) {
        ElValue * newElValue = (ElValue *)0;
        
        rewind(fp);
        CheckSwap();
        while ( (newElValue = ReadNextElement()) ) {
+               SkipElementValue(newElValue);
                PubElVals.Add(newElValue);
        }
-       SetAsidePixelData((ElValue*)0);
+}
+
+/**
+ * \ingroup gdcmHeader
+ * \brief   Loads the element values of all the elements present in the
+ *          public tag based hash table.
+ */
+void gdcmHeader::LoadElements(void) {
+       rewind(fp);    
+       TagElValueHT ht = PubElVals.GetTagHt();
+       for (TagElValueHT::iterator tag = ht.begin(); tag != ht.end(); ++tag)
+               LoadElementValue(tag->second);
 }
 
 void gdcmHeader::PrintPubElVal(ostream & os) {
index bfa1373da89bd9d05199e03d76f2cb9cfcc83898..d06e8cdeac839da0f96be9e4f3a1f677cbb016c1 100644 (file)
@@ -5,7 +5,7 @@ private:
 public:
        gdcmDebug(int);
        void Verbose(int, const char*, const char* ="");
-       void Error(bool, const char*, const char*);
+       void Error(bool, const char*,  const char* ="");
        void Error(const char*, const char* ="", const char* ="");
        void Assert(int, bool, const char*, const char*);
 };
index 7c16dba9a8cf3442fe7c5f9f7a56a2da2e921e35..512c86e4f39e78ccd524c81196d307bdf36c5565 100644 (file)
@@ -157,8 +157,10 @@ public:
        void Add(ElValue*);
        void Print(ostream &);
        void PrintByName(ostream &);
+       ElValue* GetElement(guint32 group, guint32 element);
        string GetElValue(guint32 group, guint32 element);
        string GetElValue(string);
+       TagElValueHT & GetTagHt(void);
 };
 
 // The various entries of the explicit value representation (VR) shall
@@ -199,21 +201,23 @@ private:
        // outside of the elements:
        guint16 grPixel;
        guint16 numPixel;
-       bool PixelsTrouves;
-       bool grPixelTrouve;
-       size_t PixelPosition;
        int sw;
 
+       guint16 ReadInt16(void);
+       guint32 ReadInt32(void);
+       guint16 SwapShort(guint16);
+       guint32 SwapLong(guint32);
        void Initialise(void);
        void CheckSwap(void);
        void FindLength(ElValue *);
        void FindVR(ElValue *);
-       guint32 SwapLong(guint32);
-       short int SwapShort(short int);
+       void LoadElementValue(ElValue *);
+       void SkipElementValue(ElValue *);
        void InitVRDict(void);
+       bool IsAnInteger(guint16, guint16, string, guint32);
        ElValue * ReadNextElement(void);
        gdcmDictEntry * IsInDicts(guint32, guint32);
-       void SetAsidePixelData(ElValue*);
+       size_t GetPixelOffset(void);
 protected:
        enum FileType {
                Unknown = 0,
@@ -229,8 +233,8 @@ protected:
 /////           See below for an example of how anonymize might be implemented.
        int anonymize(ostream&);
 public:
-       bool IsAnInteger(guint16, guint16, string, guint32);
-       virtual void BuildHeader(void);
+       void LoadElements(void);
+       virtual void ParseHeader(void);
        gdcmHeader(char* filename);
        virtual ~gdcmHeader();